'\" t
.\"     Title: perf-ftrace
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.12
.\"      Date: 2021-10-10
.\"    Manual: perf Manual
.\"    Source: perf
.\"  Language: English
.\"
.TH "PERF_5.14\-FTRACE" "1" "2021-10-10" "perf" "perf Manual"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
perf\-ftrace \- simple wrapper for kernel\(aqs ftrace functionality
.SH "SYNOPSIS"
.sp
.sp
.nf
\fIperf ftrace\fP <command>
.fi
.br
.SH "DESCRIPTION"
.sp
The \fIperf ftrace\fP command is a simple wrapper of kernel\(cqs ftrace
functionality.  It only supports single thread tracing currently and
just reads trace_pipe in text and then write it to stdout.
.sp
The following options apply to perf ftrace.
.SH "OPTIONS"
.sp
\-t, \-\-tracer=
.RS 4
Tracer to use when neither \-G nor \-F option is not
specified: function_graph or function.
.RE
.sp
\-v, \-\-verbose
.RS 4
Increase the verbosity level.
.RE
.sp
\-F, \-\-funcs
.RS 4
List available functions to trace. It accepts a pattern to
only list interested functions.
.RE
.sp
\-p, \-\-pid=
.RS 4
Trace on existing process id (comma separated list).
.RE
.sp
\-\-tid=
.RS 4
Trace on existing thread id (comma separated list).
.RE
.sp
\-D, \-\-delay
.RS 4
Time (ms) to wait before starting tracing after program start.
.RE
.sp
\-a, \-\-all\-cpus
.RS 4
Force system\-wide collection.  Scripts run without a <command>
normally use \-a by default, while scripts run with a <command>
normally don\(cqt \- this option allows the latter to be run in
system\-wide mode.
.RE
.sp
\-C, \-\-cpu=
.RS 4
Only trace for the list of CPUs provided.  Multiple CPUs can
be provided as a comma separated list with no space like: 0,1.
Ranges of CPUs are specified with \-: 0\-2.
Default is to trace on all online CPUs.
.RE
.sp
\-m, \-\-buffer\-size
.RS 4
Set the size of per\-cpu tracing buffer, <size> is expected to
be a number with appended unit character \- B/K/M/G.
.RE
.sp
\-\-inherit
.RS 4
Trace children processes spawned by our target.
.RE
.sp
\-T, \-\-trace\-funcs=
.RS 4
Select function tracer and set function filter on the given
function (or a glob pattern). Multiple functions can be given
by using this option more than once. The function argument also
can be a glob pattern. It will be passed to \fIset_ftrace_filter\fP
in tracefs.
.RE
.sp
\-N, \-\-notrace\-funcs=
.RS 4
Select function tracer and do not trace functions given by the
argument.  Like \-T option, this can be used more than once to
specify multiple functions (or glob patterns).  It will be
passed to \fIset_ftrace_notrace\fP in tracefs.
.RE
.sp
\-\-func\-opts
.RS 4
List of options allowed to set:
call\-graph \- Display kernel stack trace for function tracer.
irq\-info   \- Display irq context info for function tracer.
.RE
.sp
\-G, \-\-graph\-funcs=
.RS 4
Select function_graph tracer and set graph filter on the given
function (or a glob pattern). This is useful to trace for
functions executed from the given function. This can be used more
than once to specify multiple functions. It will be passed to
\fIset_graph_function\fP in tracefs.
.RE
.sp
\-g, \-\-nograph\-funcs=
.RS 4
Select function_graph tracer and set graph notrace filter on the
given function (or a glob pattern). Like \-G option, this is useful
for the function_graph tracer only and disables tracing for function
executed from the given function. This can be used more than once to
specify multiple functions. It will be passed to \fIset_graph_notrace\fP
in tracefs.
.RE
.sp
\-\-graph\-opts
.RS 4
List of options allowed to set:
nosleep\-time \- Measure on\-CPU time only for function_graph tracer.
noirqs       \- Ignore functions that happen inside interrupt.
verbose      \- Show process names, PIDs, timestamps, etc.
thresh=<n>   \- Setup trace duration threshold in microseconds.
depth=<n>    \- Set max depth for function graph tracer to follow.
.RE
.SH "SEE ALSO"
.sp
perf\-record(1), perf\-trace(1)