Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit f9ab9c19 authored by Cody P Schafer's avatar Cody P Schafer Committed by Arnaldo Carvalho de Melo
Browse files

perf tools: Document parameterized and symbolic events 



Signed-off-by: default avatarCody P Schafer <cody@linux.vnet.ibm.com>
Signed-off-by: default avatarSukadev Bhattiprolu <sukadev@linux.vnet.ibm.com>
Acked-by: default avatarJiri Olsa <jolsa@kernel.org>
Cc: Cody P Schafer <dev@codyps.com>
Cc: Haren Myneni <hbabu@us.ibm.com>
Cc: Jiri Olsa <jolsa@redhat.com>
Cc: Michael Ellerman <mpe@ellerman.id.au>
Cc: Paul Mackerras <paulus@samba.org>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: linuxppc-dev@lists.ozlabs.org
Link: http://lkml.kernel.org/r/1420679633-28856-5-git-send-email-sukadev@linux.vnet.ibm.com


Signed-off-by: default avatarArnaldo Carvalho de Melo <acme@redhat.com>
parent 98a43e0e

tools/perf/Documentation/perf-list.txt

+13 −0
Original line number Original line Diff line number Diff line
@@ -89,6 +89,19 @@ raw encoding of 0x1A8 can be used: 
You should refer to the processor specific documentation for getting these

You should refer to the processor specific documentation for getting these

details. Some of them are referenced in the SEE ALSO section below.

details. Some of them are referenced in the SEE ALSO section below.





PARAMETERIZED EVENTS

--------------------



Some pmu events listed by 'perf-list' will be displayed with '?' in them. For

example:



  hv_gpci/dtbp_ptitc,phys_processor_idx=?/



This means that when provided as an event, a value for '?' must

also be supplied. For example:



  perf stat -C 0 -e 'hv_gpci/dtbp_ptitc,phys_processor_idx=0x2/' ...



OPTIONS

OPTIONS

-------

-------

tools/perf/Documentation/perf-record.txt

+12 −0
Original line number Original line Diff line number Diff line
@@ -33,6 +33,18 @@ OPTIONS 
        - a raw PMU event (eventsel+umask) in the form of rNNN where NNN is a

        - a raw PMU event (eventsel+umask) in the form of rNNN where NNN is a

	  hexadecimal event descriptor.

	  hexadecimal event descriptor.





	- a symbolically formed PMU event like 'pmu/param1=0x3,param2/' where

	  'param1', 'param2', etc are defined as formats for the PMU in

	  /sys/bus/event_sources/devices/<pmu>/format/*.



	- a symbolically formed event like 'pmu/config=M,config1=N,config3=K/'



          where M, N, K are numbers (in decimal, hex, octal format). Acceptable

          values for each of 'config', 'config1' and 'config2' are defined by

          corresponding entries in /sys/bus/event_sources/devices/<pmu>/format/*

          param1 and param2 are defined as formats for the PMU in:

          /sys/bus/event_sources/devices/<pmu>/format/*



        - a hardware breakpoint event in the form of '\mem:addr[:access]'

        - a hardware breakpoint event in the form of '\mem:addr[:access]'

          where addr is the address in memory you want to break in.

          where addr is the address in memory you want to break in.

          Access is the memory access type (read, write, execute) it can

          Access is the memory access type (read, write, execute) it can

tools/perf/Documentation/perf-stat.txt

+16 −4
Original line number Original line Diff line number Diff line
@@ -25,11 +25,23 @@ OPTIONS 




-e::

-e::

--event=::

--event=::

	Select the PMU event. Selection can be a symbolic event name

	Select the PMU event. Selection can be:

	(use 'perf list' to list all events) or a raw PMU



	event (eventsel+umask) in the form of rNNN where NNN is a

	- a symbolic event name (use 'perf list' to list all events)



	- a raw PMU event (eventsel+umask) in the form of rNNN where NNN is a

	  hexadecimal event descriptor.

	  hexadecimal event descriptor.





	- a symbolically formed event like 'pmu/param1=0x3,param2/' where

	  param1 and param2 are defined as formats for the PMU in

	  /sys/bus/event_sources/devices/<pmu>/format/*



	- a symbolically formed event like 'pmu/config=M,config1=N,config2=K/'

	  where M, N, K are numbers (in decimal, hex, octal format).

	  Acceptable values for each of 'config', 'config1' and 'config2'

	  parameters are defined by corresponding entries in

	  /sys/bus/event_sources/devices/<pmu>/format/*



-i::

-i::

--no-inherit::

--no-inherit::

        child tasks do not inherit counters

        child tasks do not inherit counters