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

Packit 577717
.TH LIBPFM 3  "June, 2017" "" "Linux Programmer's Manual"
Packit 577717
.SH NAME
Packit 577717
libpfm_intel_bdx_unc_pcu - support for Intel Broadwell Server Power Controller Unit (PCU) uncore PMU
Packit 577717
.SH SYNOPSIS
Packit 577717
.nf
Packit 577717
.B #include <perfmon/pfmlib.h>
Packit 577717
.sp
Packit 577717
.B PMU name: bdx_unc_pcu
Packit 577717
.B PMU desc: Intel Broadwell Server PCU uncore PMU
Packit 577717
.sp
Packit 577717
.SH DESCRIPTION
Packit 577717
The library supports the Intel Broadwell Server Power Controller Unit uncore PMU.
Packit 577717
This PMU model only exists on various Broadwell server models (79, 86).
Packit 577717
Packit 577717
.SH MODIFIERS
Packit 577717
The following modifiers are supported on Intel Broadwell server PCU uncore PMU:
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 to at least one occurrence. This modifier must be combined with a threshold modifier (t) with a value greater or equal to one.  This is a boolean modifier.
Packit 577717
.TP
Packit 577717
.B t
Packit 577717
Set the threshold value. When set to a non-zero value, the counter counts the number
Packit 577717
of HA cycles in which the number of occurrences of the event is greater or equal to
Packit 577717
the threshold.  This is an integer modifier with values in the range [0:15].
Packit 577717
.TP
Packit 577717
.B i
Packit 577717
Invert the meaning of the threshold or edge filter. If set, the event counts when strictly less
Packit 577717
than N occurrences occur per cycle if threshold is set to N. When invert is set, then threshold
Packit 577717
must be set to non-zero value. If set, the event counts when the event transitions from occurring
Packit 577717
to not occurring (falling edge) when edge detection is set. This is a boolean modifier
Packit 577717
.TP
Packit 577717
.B ff
Packit 577717
Enable frequency band filtering. This modifier applies only to the UNC_P_FREQ_BANDx_CYCLES events, where x is [0-3].
Packit 577717
The modifiers expects an integer in the range [0-255]. The value is interpreted as a frequency value to be
Packit 577717
multiplied by 100Mhz. Thus if the value is 32, then all cycles where the processor is running at 3.2GHz and more are
Packit 577717
counted.
Packit 577717
Packit 577717
.SH Frequency band filtering
Packit 577717
Packit 577717
There are 3 events which support frequency band filtering, namely, UNC_P_FREQ_BAND0_CYCLES, UNC_P_FREQ_BAND1_CYCLES,
Packit 577717
UNC_P_FREQ_BAND2_CYCLES, UNC_P_FREQ_BAND3_CYCLES. The frequency filter (available via the ff modifier) is stored into
Packit 577717
a PMU shared register which hold all 4 possible frequency bands, one per event. However, the library generate the
Packit 577717
encoding for each event individually because it processes events one at a time. The caller or the underlying kernel
Packit 577717
interface may have to merge the band filter settings to program the filter register properly.
Packit 577717
Packit 577717
.SH AUTHORS
Packit 577717
.nf
Packit 577717
Stephane Eranian <eranian@gmail.com>
Packit 577717
.if
Packit 577717
.PP