Blame src/libpfm-3.y/docs/man3/pfm_initialize.3
|
Packit |
577717 |
.TH LIBPFM 3 "November, 2003" "" "Linux Programmer's Manual"
|
|
Packit |
577717 |
.SH NAME
|
|
Packit |
577717 |
pfm_initialize \- initialize performance monitoring library
|
|
Packit |
577717 |
.SH SYNOPSIS
|
|
Packit |
577717 |
.nf
|
|
Packit |
577717 |
.B #include <perfmon/pfmlib.h>
|
|
Packit |
577717 |
.sp
|
|
Packit |
577717 |
.BI "int pfm_initialize(void);"
|
|
Packit |
577717 |
.sp
|
|
Packit |
577717 |
.SH DESCRIPTION
|
|
Packit |
577717 |
This is the first function that a program using the library
|
|
Packit |
577717 |
\fBmust\fR call otherwise the library will not function at all.
|
|
Packit |
577717 |
This function probes the host PMU and initialize the internal
|
|
Packit |
577717 |
state of the library. In the case of a multi-threaded application,
|
|
Packit |
577717 |
this function needs to be called only once, most likely by the initial
|
|
Packit |
577717 |
thread.
|
|
Packit |
577717 |
|
|
Packit |
577717 |
.SH RETURN
|
|
Packit |
577717 |
The function returns whether or not it was successful, i.e., the
|
|
Packit |
577717 |
host PMU has been correctly identified and is supported. A return
|
|
Packit |
577717 |
value of \fBPFMLIB_SUCCESS\fR indicates success, otherwise the value is
|
|
Packit |
577717 |
an error code.
|
|
Packit |
577717 |
.SH ERRORS
|
|
Packit |
577717 |
.TP
|
|
Packit |
577717 |
.B PFMLIB_ERR_NOTSUPP
|
|
Packit |
577717 |
the host
|
|
Packit |
577717 |
PMU is not supported.
|
|
Packit |
577717 |
.SH AUTHOR
|
|
Packit |
577717 |
Stephane Eranian <eranian@hpl.hp.com>
|
|
Packit |
577717 |
.PP
|