NAME¶

pfm_initialize - initialize performance monitoring library

SYNOPSIS¶

#include <perfmon/pfmlib.h>

int pfm_initialize(void);

DESCRIPTION¶

This is the first function that a program using the library must call otherwise the library will not function at all. This function probes the host PMU and initialize the internal state of the library. In the case of a multi-threaded application, this function needs to be called only once, most likely by the initial thread.

RETURN¶

The function returns whether or not it was successful, i.e., the host PMU has been correctly identified and is supported. A return value of PFMLIB_SUCCESS indicates success, otherwise the value is an error code.

ERRORS¶

PFMLIB_ERR_NOTSUPP

the host PMU is not supported.

AUTHOR¶

Stephane Eranian <eranian@hpl.hp.com>