Score-P/VampirTrace perf Plugin Counter

Compilation and Installation

Prerequisites

To compile this plugin, you need:

C compiler
CMake
Score-P (or VampirTrace)
A recent Linux kernel (2.6.31+) with activated tracing and the kernel headers

Building

Create a build directory
```
 mkdir build
 cd build
```
Invoke CMake

Specify the Score-P (and/or VampirTrace) directory if it is not in the default path with -DSCOREP_DIR=<PATH> (respectivly -DVT_INC=<PATH>). The plugin will use alternatively the environment variables SCOREP_DIR (and VT_DIR), e.g.
```
 cmake .. -DSCOREP_DIR=/opt/scorep
```
or (for VampirTrace)
```
 cmake .. -DVT_DIR=/opt/vampirtrace
```
Invoke make
```
 make
```
Copy it to a location listed in LD_LIBRARY_PATH or add current path to LD_LIBRARY_PATH with
```
 export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:`pwd`
```

Usage

Score-P

To use this plugin you have to add it to the SCOREP_METRIC_PLUGINS variable, e.g.:

export SCOREP_METRIC_PLUGINS="perf_plugin"

Afterwards you can select the metrics you want to measure from the list of the available metrics using

export SCOREP_METRIC_PERF_PLUGIN="<metric name>"

See below for a list of available metrics.

VampirTrace

To add a kernel event counter to your trace, you have to specify the environment variable VT_PLUGIN_CNTR_METRIC.

VT_PLUGIN_CNTR_METRIC specifies the software events that shall be recorded when tracing an application. You can add the metrics from the list of the available metrics.

Available metrics

Name	Type
cpu-cycles or cycles	Hardware event
stalled-cycles-frontend or idle-cycles-frontend	Hardware event
stalled-cycles-backend or idle-cycles-backend	Hardware event
instructions	Hardware event
cache-references	Hardware event
cache-misses	Hardware event
branch-instructions or branches	Hardware event
branch-misses	Hardware event
bus-cycles	Hardware event
cpu-clock	Software event
task-clock	Software event
page-faults or faults	Software event
minor-faults	Software event
major-faults	Software event
context-switches or cs	Software event
cpu-migrations or migrations	Software event
alignment-faults	Software event
emulation-faults	Software event
L1-dcache-loads	Hardware cache event
L1-dcache-load-misses	Hardware cache event
L1-dcache-stores	Hardware cache event
L1-dcache-store-misses	Hardware cache event
L1-dcache-prefetches	Hardware cache event
L1-dcache-prefetch-misses	Hardware cache event
L1-icache-loads	Hardware cache event
L1-icache-load-misses	Hardware cache event
L1-icache-prefetches	Hardware cache event
L1-icache-prefetch-misses	Hardware cache event
LLC-loads	Hardware cache event
LLC-load-misses	Hardware cache event
LLC-stores	Hardware cache event
LLC-store-misses	Hardware cache event
LLC-prefetches	Hardware cache event
LLC-prefetch-misses	Hardware cache event
dTLB-loads	Hardware cache event
dTLB-load-misses	Hardware cache event
dTLB-stores	Hardware cache event
dTLB-store-misses	Hardware cache event
dTLB-prefetches	Hardware cache event
dTLB-prefetch-misses	Hardware cache event
iTLB-loads	Hardware cache event
iTLB-load-misses	Hardware cache event
branch-loads	Hardware cache event
branch-load-misses	Hardware cache event
node-loads	Hardware cache event
node-load-misses	Hardware cache event
node-stores	Hardware cache event
node-store-misses	Hardware cache event
node-prefetches	Hardware cache event
node-prefetch-misses	Hardware cache event
rNNN (see `perf list --help` on how to encode it)	Raw hardware event descriptor

E.g. for the Score-P plugin:

export SCOREP_METRIC_PERF_PLUGIN="instructions:L1-dcache-loads"

or for the VampirTrace plugin:

export VT_PLUGIN_CNTR_METRICS="perf_plugin_instructions:perf_plugin_L1-dcache-loads"

To get the full list of available perf counters, please use:

perf list

If anything fails

Check whether the plugin library can be loaded from the LD_LIBRARY_PATH.
If your kernel headers do not provide the file include/linux/perf_events.h please make sure you are using at least Linux 2.6.31.
Write a mail to the author.

Authors

Robert Schoene (robert.schoene at tu-dresden dot de)

score-p/scorep_plugin_perf