These changes are the raw update to linux-4.4.6-rt14. Kernel sources

[kvmfornfv.git] / kernel / tools / perf / Documentation / perf-top.txt

diff --git a/kernel/tools/perf/Documentation/perf-top.txt b/kernel/tools/perf/Documentation/perf-top.txt
index 3265b10..556cec0 100644 (file)
--- a/kernel/tools/perf/Documentation/perf-top.txt
+++ b/kernel/tools/perf/Documentation/perf-top.txt
@@ -160,15 +160,16 @@ Default is to monitor all CPUS.
 -g::
        Enables call-graph (stack chain/backtrace) recording.
 
---call-graph::
+--call-graph [mode,type,min[,limit],order[,key][,branch]]::
        Setup and enable call-graph (stack chain/backtrace) recording,
-       implies -g.
+       implies -g.  See `--call-graph` section in perf-record and
+       perf-report man pages for details.
 
 --children::
        Accumulate callchain of children to parent entry so that then can
        show up in the output.  The output will have a new "Children" column
        and will be sorted on the data.  It requires -g/--call-graph option
-       enabled.
+       enabled.  See the `overhead calculation' section for more details.
 
 --max-stack::
        Set the stack depth limit when parsing the callchain, anything
@@ -201,6 +202,33 @@ Default is to monitor all CPUS.
        Force each column width to the provided list, for large terminal
        readability.  0 means no limit (default behavior).
 
+--proc-map-timeout::
+       When processing pre-existing threads /proc/XXX/mmap, it may take
+       a long time, because the file may be huge. A time out is needed
+       in such cases.
+       This option sets the time out limit. The default value is 500 ms.
+
+
+-b::
+--branch-any::
+       Enable taken branch stack sampling. Any type of taken branch may be sampled.
+       This is a shortcut for --branch-filter any. See --branch-filter for more infos.
+
+-j::
+--branch-filter::
+       Enable taken branch stack sampling. Each sample captures a series of consecutive
+       taken branches. The number of branches captured with each sample depends on the
+       underlying hardware, the type of branches of interest, and the executed code.
+       It is possible to select the types of branches captured by enabling filters.
+       For a full list of modifiers please see the perf record manpage.
+
+       The option requires at least one branch type among any, any_call, any_ret, ind_call, cond.
+       The privilege levels may be omitted, in which case, the privilege levels of the associated
+       event are applied to the branch filter. Both kernel (k) and hypervisor (hv) privilege
+       levels are subject to permissions.  When sampling on multiple events, branch stack sampling
+       is enabled for all the sampling events. The sampled branch type is the same for all events.
+       The various filters must be specified as a comma separated list: --branch-filter any_ret,u,k
+       Note that this feature may not be available on all processors.
 
 INTERACTIVE PROMPTING KEYS
 --------------------------
@@ -234,6 +262,7 @@ INTERACTIVE PROMPTING KEYS
 
 Pressing any unmapped key displays a menu, and prompts for input.
 
+include::callchain-overhead-calculation.txt[]
 
 SEE ALSO
 --------