1perf-ftrace(1)
2==============
3
4NAME
5----
6perf-ftrace - simple wrapper for kernel's ftrace functionality
7
8
9SYNOPSIS
10--------
11[verse]
12'perf ftrace' <command>
13
14DESCRIPTION
15-----------
16The 'perf ftrace' command is a simple wrapper of kernel's ftrace
17functionality.  It only supports single thread tracing currently and
18just reads trace_pipe in text and then write it to stdout.
19
20The following options apply to perf ftrace.
21
22OPTIONS
23-------
24
25-t::
26--tracer=::
27	Tracer to use when neither -G nor -F option is not
28	specified: function_graph or function.
29
30-v::
31--verbose=::
32        Verbosity level.
33
34-F::
35--funcs::
36        List all available functions to trace.
37
38-p::
39--pid=::
40	Trace on existing process id (comma separated list).
41
42--tid=::
43	Trace on existing thread id (comma separated list).
44
45-D::
46--delay::
47	Time (ms) to wait before starting tracing after program start.
48
49-a::
50--all-cpus::
51	Force system-wide collection.  Scripts run without a <command>
52	normally use -a by default, while scripts run with a <command>
53	normally don't - this option allows the latter to be run in
54	system-wide mode.
55
56-C::
57--cpu=::
58	Only trace for the list of CPUs provided.  Multiple CPUs can
59	be provided as a comma separated list with no space like: 0,1.
60	Ranges of CPUs are specified with -: 0-2.
61	Default is to trace on all online CPUs.
62
63-m::
64--buffer-size::
65	Set the size of per-cpu tracing buffer, <size> is expected to
66	be a number with appended unit character - B/K/M/G.
67
68--inherit::
69	Trace children processes spawned by our target.
70
71-T::
72--trace-funcs=::
73	Select function tracer and set function filter on the given
74	function (or a glob pattern). Multiple functions can be given
75	by using this option more than once. The function argument also
76	can be a glob pattern. It will be passed to 'set_ftrace_filter'
77	in tracefs.
78
79-N::
80--notrace-funcs=::
81	Select function tracer and do not trace functions given by the
82	argument.  Like -T option, this can be used more than once to
83	specify multiple functions (or glob patterns).  It will be
84	passed to 'set_ftrace_notrace' in tracefs.
85
86--func-opts::
87	List of options allowed to set:
88	  call-graph - Display kernel stack trace for function tracer.
89	  irq-info   - Display irq context info for function tracer.
90
91-G::
92--graph-funcs=::
93	Select function_graph tracer and set graph filter on the given
94	function (or a glob pattern). This is useful to trace for
95	functions executed from the given function. This can be used more
96	than once to specify multiple functions. It will be passed to
97	'set_graph_function' in tracefs.
98
99-g::
100--nograph-funcs=::
101	Select function_graph tracer and set graph notrace filter on the
102	given function (or a glob pattern). Like -G option, this is useful
103	for the function_graph tracer only and disables tracing for function
104	executed from the given function. This can be used more than once to
105	specify multiple functions. It will be passed to 'set_graph_notrace'
106	in tracefs.
107
108--graph-opts::
109	List of options allowed to set:
110	  nosleep-time - Measure on-CPU time only for function_graph tracer.
111	  noirqs       - Ignore functions that happen inside interrupt.
112	  verbose      - Show process names, PIDs, timestamps, etc.
113	  thresh=<n>   - Setup trace duration threshold in microseconds.
114	  depth=<n>    - Set max depth for function graph tracer to follow.
115
116SEE ALSO
117--------
118linkperf:perf-record[1], linkperf:perf-trace[1]
119