pfm_initialize(3) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | RETURN | ERRORS | AUTHOR | COLOPHON

LIBPFM(3)               Linux Programmer's Manual               LIBPFM(3)

NAME         top

       pfm_initialize - initialize library

SYNOPSIS         top

       #include <perfmon/pfmlib.h>

       int pfm_initialize(void);

DESCRIPTION         top

       This is the first function that a program must call otherwise the
       library will not operate.  This function probes the underlying
       hardware looking for valid PMU event tables to activate.  Multiple
       distinct PMU tables may be activated at the same time.

       The function must be called only once. If the function is called
       more than once, it does not execute the initialization multiple
       times, it simply returns the same value as for the first call.
       This is not a reentrant function. Only one thread at a time can
       call the function

RETURN         top

       The function returns whether or not it was successful, i.e., at
       least one PMU was activated. A return value of PFMLIB_SUCCESS
       indicates success, otherwise the value is an error code.

ERRORS         top

       PFMLIB_ERR_NOTSUPP
              No PMU was activated.

AUTHOR         top

       Stephane Eranian <eranian@gmail.com>

COLOPHON         top

       This page is part of the perfmon2 (a performance monitoring
       library) project.  Information about the project can be found at
       ⟨http://perfmon2.sourceforge.net/⟩.  If you have a bug report for
       this manual page, send it to perfmon2-devel@lists.sourceforge.net.
       This page was obtained from the project's upstream Git repository
       ⟨git://git.code.sf.net/p/perfmon2/libpfm4 perfmon2-libpfm4⟩ on
       2025-02-02.  (At that time, the date of the most recent commit
       that was found in the repository was 2025-01-27.)  If you discover
       any rendering problems in this HTML version of the page, or you
       believe there is a better or more up-to-date source for the page,
       or you have corrections or improvements to the information in this
       COLOPHON (which is not part of the original manual page), send a
       mail to man-pages@man7.org

                             September, 2009                    LIBPFM(3)

Pages that refer to this page: libpfm(3)