Blame src/libpfm-3.y/docs/man3/libpfm_powerpc.3

Packit 577717
.TH LIBPFM 3  "October, 2007" "" "Linux Programmer's Manual"
Packit 577717
.SH NAME
Packit 577717
libpfm_powerpc - support for IBM PowerPC and POWER processor families
Packit 577717
.SH SYNOPSIS
Packit 577717
.nf
Packit 577717
.B #include <perfmon/pfmlib.h>
Packit 577717
.B #include <perfmon/pfmlib_powerpc.h>
Packit 577717
.sp
Packit 577717
.SH DESCRIPTION
Packit 577717
The libpfm library provides support for the IBM PowerPC and POWER processor
Packit 577717
families.  Specifically, it currently provides support for the following
Packit 577717
processors: PPC970(FX,GX), PPC970MP POWER4, POWER4+, POWER5, POWER5+, and POWER6.
Packit 577717
.sp
Packit 577717
.SH MODEL-SPECIFIC PARAMETERS
Packit 577717
At present, the model_in and model_out model-specific input and output
Packit 577717
parameters are not used by \fBpfm_dispatch_events()\fR function.  For future
Packit 577717
compatibility, NULLs must be passed for these arguments.
Packit 577717
.sp
Packit 577717
.SH COMBINING EVENTS IN A SET
Packit 577717
As with many architecture's PMU hardware design, events can not be combined
Packit 577717
together arbitrarily in the same event set, even if there are a sufficient
Packit 577717
number of counters available.  This implementation for IBM PowerPC/POWER
Packit 577717
bases the event compatibility on a set of previously-defined compatible
Packit 577717
event groups.  If the events placed in an event set are all members of one
Packit 577717
of the predefined event groups, a call to the \fBpfm_dispatch_events()\fR function will be
Packit 577717
successful.  With the current interface, there is no way to discover
Packit 577717
apriori which events are compatible, so application software that wishes to
Packit 577717
combine events must do so by trial and error, possibly using multiplexed
Packit 577717
event sets to count events that cannot otherwise be combined in the same
Packit 577717
set.
Packit 577717
.sp
Packit 577717
.SH ERRORS
Packit 577717
Refer to the description of the \fBpfm_dispatch_events()\fR function for errors.
Packit 577717
.SH SEE ALSO
Packit 577717
pfm_dispatch_events(3) and set of examples shipped with the library
Packit 577717
.SH AUTHOR
Packit 577717
Corey Ashford <cjashfor@us.ibm.com>
Packit 577717
.PP