This patch adds documentation for alternate group events and scaling
support for the base events in derived events.
Signed-off-by: Hemant Kumar <hemant@xxxxxxxxxxxxxxxxxx>
---
man/man5/perfevent.conf.5 | 36 +++++++++++++++++++++++++++++++-----
1 file changed, 31 insertions(+), 5 deletions(-)
diff --git a/man/man5/perfevent.conf.5 b/man/man5/perfevent.conf.5
index 5e068fa..2ac349b 100644
--- a/man/man5/perfevent.conf.5
+++ b/man/man5/perfevent.conf.5
@@ -49,20 +49,34 @@ The PMU identification string is enclosed in brackets and
one or more events are
.B ...
.RE
.PP
-For derived events, the derived perf event is enclosed in brackets along with
-:derived as a suffix. Note that the EVENT_NAME listed under derived event must
-be present as a base event in the configuration file. And, all the events under
-a particular derived perf event must have the same CPU_OPTION. The syntax is :
+For derived events, one or more groups of events can be specified where,
counters in one group can be specific to one architecture and the counters in
other group can be specific to some other architecture. Else, only one group
can be specified. EVENT_NAME_1, EVENT_NAME_2 etc. belong to group 1 and
EVENT_NAME_3, EVENT_NAME_4 belong to group 2 and so on. If any of the event in
the first group is not available, entire group will be discarded. And, the next
group will be checked. The first group with all the events available will be
activated and monitored. The derived perf event is enclosed in brackets along
with :derived as a suffix. Note that the EVENT_NAME listed under derived event
must be present as a base event in the configuration file. And, all the events
under a particular derived perf event group must have the same CPU_OPTION. ||
acts as a separator for different groups inside a single derived event. The
syntax is :
.PP
.RS
.B [event:derived]
.RE
.RS
-.B EVENT_NAME [CPU_OPTION]
+.B EVENT_NAME_1 [CPU_OPTION] [scale]
+.RE
+.RS
+.B EVENT_NAME_2 [CPU_OPTION] [scale]
+.RE
+.RS
+.B ...
+.RE
+.RS
+.B ||
+.RE
+.RS
+.B EVENT_NAME_3 [CPU_OPTION] [scale]
+.RE
+.RS
+.B EVENT_NAME_4 [CPU_OPTION] [scale]
.RE
.RS
.B ...
.RE
+.RS
+
.PP
The available event cpu options are as follows:
.TP
@@ -83,6 +97,18 @@ where N is the numerical digit of the CPU index
.PP
if the CPU option is absent then the event is programmed on all cpus.
.PP
+.B scale
+is applicable for the counters in derived events. If scale is given, the
counters will be scaled to their respective values. The options are as follows :
+.TP
+.B a float value
+Can be a simple float value, or a value in scientific notation.
+.TP
+.B perf_scale
+The scale will be taken from the kernel sysfs scale file entry for that event.
Its generally specified in
+.B /sys/bus/event_source/device/events/<event_name>.scale
+.PP
+If no scale is given, the default scale will be taken as 1.0.
+.PP
Blank lines are ignored. Lines that begin with the # sign are ignored.
.PP
Multiple, comma separated, PMUs may be specified in the PMU definition.
--
1.9.3
|