Blame src/libpfm4/docs/man3/libpfm_intel_snb_unc.3

Packit 577717
.TH LIBPFM 3  "August, 2012" "" "Linux Programmer's Manual"
Packit 577717
.SH NAME
Packit 577717
libpfm_intel_snb_unc - support for Intel Sandy Bridge uncore PMU
Packit 577717
.SH SYNOPSIS
Packit 577717
.nf
Packit 577717
.B #include <perfmon/pfmlib.h>
Packit 577717
.sp
Packit 577717
.B PMU name: snb_unc_cbo0, snb_unc_cbo1, snb_unc_cbo2, snb_unc_cbo3
Packit 577717
.B PMU desc: Intel Sandy Bridge C-box uncore
Packit 577717
.sp
Packit 577717
.SH DESCRIPTION
Packit 577717
The library supports the Intel Sandy Bridge client part (model 42) uncore PMU.
Packit 577717
The support is currently limited to the Coherency Box, so called C-Box for up
Packit 577717
to 4 physical cores.
Packit 577717
Packit 577717
Each physical core has an associated C-Box which it uses to communicate with
Packit 577717
the L3 cache. The C-boxes all support the same set of events. However, Core 0
Packit 577717
C-box (snb_unc_cbo0) supports an additional uncore clock ticks event: \fBUNC_CLOCKTICKS\fR.
Packit 577717
Packit 577717
Packit 577717
.SH MODIFIERS
Packit 577717
The following modifiers are supported on Intel Sandy Bridge C-Box uncore PMU:
Packit 577717
.TP
Packit 577717
.B i
Packit 577717
Invert the meaning of the event. The counter will now count cycles in which the event is \fBnot\fR
Packit 577717
occurring. This is a boolean modifier
Packit 577717
.TP
Packit 577717
.B e
Packit 577717
Enable edge detection, i.e., count only when there is a state transition from no occurrence of the event
Packit 577717
to at least one occurrence. This modifier must be combined with a counter mask modifier (m) with a value greater or equal to one.
Packit 577717
This is a boolean modifier.
Packit 577717
.TP
Packit 577717
.B c
Packit 577717
Set the counter mask value. The mask acts as a threshold. The counter will count the number of cycles
Packit 577717
in which the number of occurrences of the event is greater or equal to the threshold. This is an integer
Packit 577717
modifier with values in the range [0:255].
Packit 577717
Packit 577717
.P
Packit 577717
Both the \fBUNC_CBO_CACHE_LOOKUP\fR and \fBUNC_CBO_XSNP_RESPONSE\fR requires two umasks to be valid.
Packit 577717
For \fBUNC_CBO_CACHE_LOOKUP\fR the first umask must be one of the MESI state umasks, the second has to be one
Packit 577717
of the filters.  For \fBUNC_CBO_XSNP_RESPONSE\fR the first umask must be one of the snoop types, the second
Packit 577717
has to be one of the filters.
Packit 577717
Packit 577717
.SH AUTHORS
Packit 577717
.nf
Packit 577717
Stephane Eranian <eranian@gmail.com>
Packit 577717
.if
Packit 577717
.PP