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