tools/perf/Documentation/perf-ftrace.txt

   1 perf-ftrace(1)
   2 ==============
   3
   4 NAME
   5 ----
   6 perf-ftrace - simple wrapper for kernel's ftrace functionality
   7
   8
   9 SYNOPSIS
  10 --------
  11 [verse]
  12 'perf ftrace' <command>
  13
  14 DESCRIPTION
  15 -----------
  16 The 'perf ftrace' command is a simple wrapper of kernel's ftrace
  17 functionality.  It only supports single thread tracing currently and
  18 just reads trace_pipe in text and then write it to stdout.
  19
  20 The following options apply to perf ftrace.
  21
  22 OPTIONS
  23 -------
  24
  25 -t::
  26 --tracer=::
  27         Tracer to use: function_graph or function.
  28
  29 -v::
  30 --verbose=::
  31         Verbosity level.
  32
  33 -p::
  34 --pid=::
  35         Trace on existing process id (comma separated list).
  36
  37 -a::
  38 --all-cpus::
  39         Force system-wide collection.  Scripts run without a <command>
  40         normally use -a by default, while scripts run with a <command>
  41         normally don't - this option allows the latter to be run in
  42         system-wide mode.
  43
  44 -C::
  45 --cpu=::
  46         Only trace for the list of CPUs provided.  Multiple CPUs can
  47         be provided as a comma separated list with no space like: 0,1.
  48         Ranges of CPUs are specified with -: 0-2.
  49         Default is to trace on all online CPUs.
  50
  51 -T::
  52 --trace-funcs=::
  53         Only trace functions given by the argument.  Multiple functions
  54         can be given by using this option more than once.  The function
  55         argument also can be a glob pattern.  It will be passed to
  56         'set_ftrace_filter' in tracefs.
  57
  58 -N::
  59 --notrace-funcs=::
  60         Do not trace functions given by the argument.  Like -T option,
  61         this can be used more than once to specify multiple functions
  62         (or glob patterns).  It will be passed to 'set_ftrace_notrace'
  63         in tracefs.
  64
  65 -G::
  66 --graph-funcs=::
  67         Set graph filter on the given function (or a glob pattern).
  68         This is useful for the function_graph tracer only and enables
  69         tracing for functions executed from the given function.
  70         This can be used more than once to specify multiple functions.
  71         It will be passed to 'set_graph_function' in tracefs.
  72
  73 -g::
  74 --nograph-funcs=::
  75         Set graph notrace filter on the given function (or a glob pattern).
  76         Like -G option, this is useful for the function_graph tracer only
  77         and disables tracing for function executed from the given function.
  78         This can be used more than once to specify multiple functions.
  79         It will be passed to 'set_graph_notrace' in tracefs.
  80
  81 -D::
  82 --graph-depth=::
  83         Set max depth for function graph tracer to follow
  84
  85 SEE ALSO
  86 --------
  87 linkperf:perf-record[1], linkperf:perf-trace[1]