Documentation

The documentation of this interface is composed of the following sections:

• The metric plugin template

• The metric plugin API

• Metric Definition File

• Linaro Performance Reports Integration

The metric plugin template documentation specifies which functions must be implemented to create a metric plugin library. This consists of one or more metric getter functions that return the values of a metric when called, a pair of optional initialization and cleanup functions called when a metric library shared object is loaded or unloaded, and optional routines which are called when the Linaro Forge sampler is initialized and when sampling ends.

The metric plugin API documents the functions that might be used by metric libraries. The implementation of these functions must be provided by any profiler that intends to use metric plugin libraries to obtain data.

Metric plugin libraries are installed into profilers by providing an XML metric definition file describing what metrics are provided by a metric library, and how those metrics are to be used and displayed.

Linaro Performance Reports can be extended with one or more partial report sections, where the metrics to be displayed can be defined by the user, enabling custom metrics to be part of the default .html and the .txt report files generated by Linaro Performance Reports.