perf/Documentation/perf-ftrace.txt

1 perf-ftrace(1)
5 ----
6 perf-ftrace - simple wrapper for kernel's ftrace functionality
10 --------
15 -----------
20   single thread tracing currently and just reads trace_pipe in text and then
32 --------------
34 -p::
35 --pid=::
38 --tid=::
41 -a::
42 --all-cpus::
43 	Force system-wide collection.  Scripts run without a <command>
44 	normally use -a by default, while scripts run with a <command>
45 	normally don't - this option allows the latter to be run in
46 	system-wide mode.
48 -C::
49 --cpu=::
52 	Ranges of CPUs are specified with -: 0-2.
55 -v::
56 --verbose::
61 -------------------------------
63 -t::
64 --tracer=::
65 	Tracer to use when neither -G nor -F option is not
68 -F::
69 --funcs::
70         List available functions to trace. It accepts a pattern to
71         only list interested functions.
73 -D::
74 --delay::
77 -m::
78 --buffer-size::
79 	Set the size of per-cpu tracing buffer, <size> is expected to
80 	be a number with appended unit character - B/K/M/G.
82 --inherit::
85 -T::
86 --trace-funcs=::
88 	function (or a glob pattern). Multiple functions can be given
91 	in tracefs.
93 -N::
94 --notrace-funcs=::
95 	Select function tracer and do not trace functions given by the
96 	argument.  Like -T option, this can be used more than once to
97 	specify multiple functions (or glob patterns).  It will be
98 	passed to 'set_ftrace_notrace' in tracefs.
100 --func-opts::
103 	  - call-graph - Display kernel stack trace for function tracer.
104 	  - irq-info   - Display irq context info for function tracer.
106 -G::
107 --graph-funcs=::
110 	functions executed from the given function. This can be used more
111 	than once to specify multiple functions. It will be passed to
112 	'set_graph_function' in tracefs.
114 -g::
115 --nograph-funcs=::
117 	given function (or a glob pattern). Like -G option, this is useful
120 	specify multiple functions. It will be passed to 'set_graph_notrace'
121 	in tracefs.
123 --graph-opts::
126 	  - nosleep-time - Measure on-CPU time only for function_graph tracer.
127 	  - noirqs       - Ignore functions that happen inside interrupt.
128 	  - verbose      - Show process names, PIDs, timestamps, etc.
129 	  - thresh=<n>   - Setup trace duration threshold in microseconds.
130 	  - depth=<n>    - Set max depth for function graph tracer to follow.
131 	  - tail         - Print function name at the end.
135 ---------------------------------
137 -T::
138 --trace-funcs=::
142 -b::
143 --use-bpf::
147 -n::
148 --use-nsec::
149 	Use nano-second instead of micro-second as a base unit of the histogram.
153 ---------------------------------
155 -T::
156 --trace-funcs=::
158 	Multiple functions can be given by using this option more than once.
160 	to 'set_ftrace_filter' in tracefs.
162 -N::
163 --notrace-funcs=::
164 	Do not trace functions given by the argument.  Like -T option, this
165 	can be used more than once to specify multiple functions (or glob
166 	patterns).  It will be passed to 'set_ftrace_notrace' in tracefs.
168 -G::
169 --graph-funcs=::
171 	useful to trace for functions executed from the given function. This
172 	can be used more than once to specify multiple functions. It will be
173 	passed to 'set_graph_function' in tracefs.
175 -g::
176 --nograph-funcs=::
178 	Like -G option, this is useful for the function_graph tracer only and
180 	can be used more than once to specify multiple functions. It will be
181 	passed to 'set_graph_notrace' in tracefs.
183 -m::
184 --buffer-size::
185 	Set the size of per-cpu tracing buffer, <size> is expected to
186 	be a number with appended unit character - B/K/M/G.
188 -s::
189 --sort=::
195 --------
196 linkperf:perf-record[1], linkperf:perf-trace[1]