Blame src/libpfm4/docs/man3/pfm_initialize.3
|
Packit |
577717 |
.TH LIBPFM 3 "September, 2009" "" "Linux Programmer's Manual"
|
|
Packit |
577717 |
.SH NAME
|
|
Packit |
577717 |
pfm_initialize \- initialize 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 \fBmust\fR call otherwise
|
|
Packit |
577717 |
the library will not operate. This function probes the
|
|
Packit |
577717 |
underlying hardware looking for valid PMU event tables to activate.
|
|
Packit |
577717 |
Multiple distinct PMU tables may be activated at the same time.
|
|
Packit |
577717 |
|
|
Packit |
577717 |
The function must be called only once. If the function is called
|
|
Packit |
577717 |
more than once, it does not execute the initialization multiple times,
|
|
Packit |
577717 |
it simply returns the same value as for the first call.
|
|
Packit |
577717 |
|
|
Packit |
577717 |
.SH RETURN
|
|
Packit |
577717 |
The function returns whether or not it was successful, i.e., at least
|
|
Packit |
577717 |
one PMU was activated. A return value of \fBPFMLIB_SUCCESS\fR indicates
|
|
Packit |
577717 |
success, otherwise the value is an error code.
|
|
Packit |
577717 |
.SH ERRORS
|
|
Packit |
577717 |
.TP
|
|
Packit |
577717 |
.B PFMLIB_ERR_NOTSUPP
|
|
Packit |
577717 |
No PMU was activated.
|
|
Packit |
577717 |
.SH AUTHOR
|
|
Packit |
577717 |
Stephane Eranian <eranian@gmail.com>
|
|
Packit |
577717 |
.PP
|