Eric Lee / smarc-fsl-linux-kernel

Download as
Browse Code ยป

Commit 176fcc5c5f0131504a55e1e1d35389c49a9177c2

Authored by Arnaldo Carvalho de Melo
1 parent 2c9e45f7a2

perf script: Add more documentation about the -f/--fields parameters 

Using the commit log for 2c9e45f.

Cc: David Ahern <daahern@cisco.com>
Cc: Frederic Weisbecker <fweisbec@gmail.com>
Cc: Ingo Molnar <mingo@elte.hu>
Cc: Mike Galbraith <efault@gmx.de>
Cc: Paul Mackerras <paulus@samba.org>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Stephane Eranian <eranian@google.com>
Cc: Tom Zanussi <tzanussi@gmail.com>
LKML-Reference: <new-submission>
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>

Showing 1 changed file with 50 additions and 2 deletions Side-by-side Diff

tools/perf/Documentation/perf-script.txt
Diff comments   View file @ 176fcc5
... ... @@ -113,12 +113,60 @@
113 113 Do various checks like samples ordering and lost events.
114 114  
115 115 -f::
116   ---fields
  116 +--fields::
117 117 Comma separated list of fields to print. Options are:
118 118 comm, tid, pid, time, cpu, event, trace, sym. Field
119   - list must be prepended with the type, trace, sw or hw,
  119 + list can be prepended with the type, trace, sw or hw,
120 120 to indicate to which event type the field list applies.
121 121 e.g., -f sw:comm,tid,time,sym and -f trace:time,cpu,trace
  122 +
  123 + perf script -f <fields>
  124 +
  125 + is equivalent to:
  126 +
  127 + perf script -f trace:<fields> -f sw:<fields> -f hw:<fields>
  128 +
  129 + i.e., the specified fields apply to all event types if the type string
  130 + is not given.
  131 +
  132 + The arguments are processed in the order received. A later usage can
  133 + reset a prior request. e.g.:
  134 +
  135 + -f trace: -f comm,tid,time,sym
  136 +
  137 + The first -f suppresses trace events (field list is ""), but then the
  138 + second invocation sets the fields to comm,tid,time,sym. In this case a
  139 + warning is given to the user:
  140 +
  141 + "Overriding previous field request for all events."
  142 +
  143 + Alternativey, consider the order:
  144 +
  145 + -f comm,tid,time,sym -f trace:
  146 +
  147 + The first -f sets the fields for all events and the second -f
  148 + suppresses trace events. The user is given a warning message about
  149 + the override, and the result of the above is that only S/W and H/W
  150 + events are displayed with the given fields.
  151 +
  152 + For the 'wildcard' option if a user selected field is invalid for an
  153 + event type, a message is displayed to the user that the option is
  154 + ignored for that type. For example:
  155 +
  156 + $ perf script -f comm,tid,trace
  157 + 'trace' not valid for hardware events. Ignoring.
  158 + 'trace' not valid for software events. Ignoring.
  159 +
  160 + Alternatively, if the type is given an invalid field is specified it
  161 + is an error. For example:
  162 +
  163 + perf script -v -f sw:comm,tid,trace
  164 + 'trace' not valid for software events.
  165 +
  166 + At this point usage is displayed, and perf-script exits.
  167 +
  168 + Finally, a user may not set fields to none for all event types.
  169 + i.e., -f "" is not allowed.
122 170  
123 171 -k::
124 172 --vmlinux=<file>::