linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: tip-bot for Taeung Song <tipbot@zytor.com>
To: linux-tip-commits@vger.kernel.org
Cc: namhyung@kernel.org, linux-kernel@vger.kernel.org,
	mingo@kernel.org, tglx@linutronix.de, treeze.taeung@gmail.com,
	acme@redhat.com, jolsa@kernel.org, hpa@zytor.com
Subject: [tip:perf/core] perf config: Document variables for 'call-graph' section in man page
Date: Tue, 9 Feb 2016 04:10:54 -0800	[thread overview]
Message-ID: <tip-56c94dc56f9e4c1c09fbe26ad65715caa2259438@git.kernel.org> (raw)
In-Reply-To: <1454577913-16401-3-git-send-email-treeze.taeung@gmail.com>

Commit-ID:  56c94dc56f9e4c1c09fbe26ad65715caa2259438
Gitweb:     http://git.kernel.org/tip/56c94dc56f9e4c1c09fbe26ad65715caa2259438
Author:     Taeung Song <treeze.taeung@gmail.com>
AuthorDate: Thu, 4 Feb 2016 18:25:07 +0900
Committer:  Arnaldo Carvalho de Melo <acme@redhat.com>
CommitDate: Thu, 4 Feb 2016 11:37:32 -0300

perf config: Document variables for 'call-graph' section in man page

Explain 'call-graph' section and its variables:

  'record-mode', 'dump-size', 'print-type', 'order', 'sort-key',
  'threshold' and 'print-limit'.

Signed-off-by: Taeung Song <treeze.taeung@gmail.com>
Cc: Jiri Olsa <jolsa@kernel.org>
Cc: Namhyung Kim <namhyung@kernel.org>
Link: http://lkml.kernel.org/r/1454577913-16401-3-git-send-email-treeze.taeung@gmail.com
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
---
 tools/perf/Documentation/perf-config.txt | 67 ++++++++++++++++++++++++++++++++
 1 file changed, 67 insertions(+)

diff --git a/tools/perf/Documentation/perf-config.txt b/tools/perf/Documentation/perf-config.txt
index 4278722..42310ae 100644
--- a/tools/perf/Documentation/perf-config.txt
+++ b/tools/perf/Documentation/perf-config.txt
@@ -302,6 +302,73 @@ ui.*::
 		in 'report' and 'top'. If this option is false, they are hidden.
 		This option is only applied to TUI.
 
+call-graph.*::
+	When sub-commands 'top' and 'report' work with -g/—-children
+	there're options in control of call-graph.
+
+	call-graph.record-mode::
+		The record-mode can be 'fp' (frame pointer), 'dwarf' and 'lbr'.
+		The value of 'dwarf' is effective only if perf detect needed library
+		(libunwind or a recent version of libdw).
+		'lbr' only work for cpus that support it.
+
+	call-graph.dump-size::
+		The size of stack to dump in order to do post-unwinding. Default is 8192 (byte).
+		When using dwarf into record-mode, the default size will be used if omitted.
+
+	call-graph.print-type::
+		The print-types can be graph (graph absolute), fractal (graph relative),
+		flat and folded. This option controls a way to show overhead for each callchain
+		entry. Suppose a following example.
+
+                Overhead  Symbols
+                ........  .......
+                  40.00%  foo
+                          |
+                          ---foo
+                             |
+                             |--50.00%--bar
+                             |          main
+                             |
+                              --50.00%--baz
+                                        main
+
+		This output is a 'fractal' format. The 'foo' came from 'bar' and 'baz' exactly
+		half and half so 'fractal' shows 50.00% for each
+		(meaning that it assumes 100% total overhead of 'foo').
+
+		The 'graph' uses absolute overhead value of 'foo' as total so each of
+		'bar' and 'baz' callchain will have 20.00% of overhead.
+		If 'flat' is used, single column and linear exposure of call chains.
+		'folded' mean call chains are displayed in a line, separated by semicolons.
+
+	call-graph.order::
+		This option controls print order of callchains. The default is
+		'callee' which means callee is printed at top and then followed by its
+		caller and so on. The 'caller' prints it in reverse order.
+
+		If this option is not set and report.children or top.children is
+		set to true (or the equivalent command line option is given),
+		the default value of this option is changed to 'caller' for the
+		execution of 'perf report' or 'perf top'. Other commands will
+		still default to 'callee'.
+
+	call-graph.sort-key::
+		The callchains are merged if they contain same information.
+		The sort-key option determines a way to compare the callchains.
+		A value of 'sort-key' can be 'function' or 'address'.
+		The default is 'function'.
+
+	call-graph.threshold::
+		When there're many callchains it'd print tons of lines. So perf omits
+		small callchains under a certain overhead (threshold) and this option
+		control the threshold. Default is 0.5 (%). The overhead is calculated
+		by value depends on call-graph.print-type.
+
+	call-graph.print-limit::
+		This is a maximum number of lines of callchain printed for a single
+		histogram entry. Default is 0 which means no limitation.
+
 SEE ALSO
 --------
 linkperf:perf[1]

  reply	other threads:[~2016-02-09 12:11 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-02-04  9:25 [PATCH 0/8] perf config: Document config variables in man page Taeung Song
2016-02-04  9:25 ` [PATCH 1/8] perf config: Document 'ui.show-headers' variable " Taeung Song
2016-02-09 12:10   ` [tip:perf/core] " tip-bot for Taeung Song
2016-02-04  9:25 ` [PATCH 2/8] perf config: Document variables for 'call-graph' section " Taeung Song
2016-02-09 12:10   ` tip-bot for Taeung Song [this message]
2016-02-04  9:25 ` [PATCH 3/8] perf config: Document variables for 'report' " Taeung Song
2016-02-09 12:11   ` [tip:perf/core] " tip-bot for Taeung Song
2016-02-04  9:25 ` [PATCH 4/8] perf config: Document 'top.children' variable " Taeung Song
2016-02-09 12:11   ` [tip:perf/core] " tip-bot for Taeung Song
2016-02-04  9:25 ` [PATCH 5/8] perf config: Document 'man.viewer' " Taeung Song
2016-02-09 12:12   ` [tip:perf/core] " tip-bot for Taeung Song
2016-02-04  9:25 ` [PATCH 6/8] perf config: Document 'pager.<subcommand>' variables " Taeung Song
2016-02-09 12:12   ` [tip:perf/core] " tip-bot for Taeung Song
2016-02-04  9:25 ` [PATCH 7/8] perf config: Document 'kmem.default' variable " Taeung Song
2016-02-09 12:12   ` [tip:perf/core] " tip-bot for Taeung Song
2016-02-04  9:25 ` [PATCH 8/8] perf config: Document 'record.build-id' " Taeung Song
2016-02-09 12:13   ` [tip:perf/core] " tip-bot for Taeung Song
2016-02-04 14:49 ` [PATCH 0/8] perf config: Document config variables " Arnaldo Carvalho de Melo
2016-02-05 10:41   ` Taeung Song
2016-02-05 11:03   ` Taeung Song
2016-02-05 13:04     ` Namhyung Kim
2016-02-05 13:39       ` Arnaldo Carvalho de Melo
2016-02-05 13:42         ` Taeung Song
2016-02-05 13:44         ` Namhyung Kim

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=tip-56c94dc56f9e4c1c09fbe26ad65715caa2259438@git.kernel.org \
    --to=tipbot@zytor.com \
    --cc=acme@redhat.com \
    --cc=hpa@zytor.com \
    --cc=jolsa@kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-tip-commits@vger.kernel.org \
    --cc=mingo@kernel.org \
    --cc=namhyung@kernel.org \
    --cc=tglx@linutronix.de \
    --cc=treeze.taeung@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).