Arm MAP Metric Plugin Interface
Metric Plugin Interface for MAP
Quick Start

Following the instructions in this section is the quickest way to get started using custom metrics with Arm MAP and Arm Performance Reports.

  1. Open a terminal in the /custom/examples/ directory. In this directory you will find:
    • a Makefile for building the custom metrics shared library.
    • the source for the example custom metric (custom1.c).
    • report.xml, which explains to Arm Performance Reports how to access the custom metric.
    • custom1.xml, which provides metadata about this metric to Arm MAP.
  2. If a custom configuration directory for the Arm HPC tools is in use, set the ALLINEA_CONFIG_DIR environment variable to the path of the custom configuration directory.
  3. To build and install the custom metric library to the default location (or that specified by ALLINEA_CONFIG_DIR), run make followed by make install.
  4. Begin profiling an application as normal with Arm MAP. To display the custom metric upon completion of the run, use the Metrics menu (Metrics -> Preset: Custom1). An example of how this looks is given in the figure below. In addition, the .html and the .txt report files generated by Arm Performance Reports will have an additional section containing the custom metric data.
custom-metrics-scaled.png
Custom Interrupt Metric

Custom Metric Development

The development of custom metrics for use with Arm MAP requires you to read and understand:

  • the Documentation section, which highlights the common pitfalls when writing custom metrics.
  • the Metric Definition File section, which details the meta information in custom1.xml that Arm MAP requires to run and display the custom metrics.
  • the Metric Plugin Template section, which describes the functions which need to be implemented by a custom metrics library.

In addition, information on exposing custom metrics in Arm Performance Reports is provided in Arm Performance Reports Integration.