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

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