[PATCH] perf config : Adding a command 'config' with a option '--list' and a document for it.

From: Taeung
Date: Sat Mar 07 2015 - 07:30:47 EST

The perf configuration file contain many variables which can make
the perf command's action more effective and more skilful.
But looking through state of configuration is difficult and
there's no knowing what kind of other variables except variables in perfconfig.example exist.
So This patch adds a command 'config --list' and a document for it.
---
tools/perf/Build | 1 +
tools/perf/Documentation/perf-config.txt | 350 ++++++++++++++++++++++++++++
tools/perf/Documentation/perfconfig.example | 63 ++++-
tools/perf/builtin-config.c | 56 +++++
tools/perf/builtin.h | 1 +
tools/perf/command-list.txt | 1 +
tools/perf/perf.c | 1 +
7 files changed, 462 insertions(+), 11 deletions(-)
create mode 100644 tools/perf/Documentation/perf-config.txt
create mode 100644 tools/perf/builtin-config.c

diff --git a/tools/perf/Build b/tools/perf/Build
index b77370e..3c1f437 100644
--- a/tools/perf/Build
+++ b/tools/perf/Build
@@ -1,5 +1,6 @@
perf-y += builtin-bench.o
perf-y += builtin-annotate.o
+perf-y += builtin-config.o
perf-y += builtin-diff.o
perf-y += builtin-evlist.o
perf-y += builtin-help.o
diff --git a/tools/perf/Documentation/perf-config.txt b/tools/perf/Documentation/perf-config.txt
new file mode 100644
index 0000000..4777231
--- /dev/null
+++ b/tools/perf/Documentation/perf-config.txt
@@ -0,0 +1,350 @@
+perf-config(1)
+==============
+
+NAME
+----
+perf-config - Get and set variables in configuration file.
+
+SYNOPSIS
+--------
+[verse]
+'perf config' --list
+
+DESCRIPTION
+-----------
+You can manage variables in configuration file with this command.
+
+OPTIONS
+-------
+
+-l::
+--list::
+ Show all variables with key and value into each sections.
+
+CONFIGURATION FILE
+------------------
+
+The Perf configuration file contain many variables which can make
+the perf command's action more effective, more skilful.
+The '$HOME/.perfconfig' file is used to store a per-user configuration.
+The file 'etc/perfconfig' or '$(sysconfdir)/perfconfig' can be used to
+store a system-wide default configuration.
+
+The variables are divided into sections. In each sections, the variables
+can contain a key and values.
+
+Syntax
+~~~~~~
+
+Example
+~~~~~~~
+
+Given a $HOME/.perfconfig like this:
+
+#
+# This is the config file, and
+# a '#' and ';' character indicates a comment
+#
+
+[colors]
+ # Color variables
+ top = red, default
+ medium = green, default
+ normal = lightgray, default
+ selected = white, lightgray
+ code = blue, default
+ addr = magenta, default
+ root = white, blue
+
+[tui]
+ # Defaults if linked with libslang
+ report = on
+ annotate = on
+ top = on
+
+[buildid]
+ # Default, disable using /dev/null
+ dir = /root/.debug
+
+[annotate]
+ # Defaults
+ hide_src_code = false
+ use_offset = true
+ jump_arrows = true
+ show_nr_jumps = false
+
+[help]
+ # Format can be man, info, web or html
+ format = man
+ autocorrect = 0
+
+[ui]
+ show-headers= true
+
+[call-graph]
+ # fp (framepointer), dwarf
+ record-mode = fp
+ print-type = graph
+ order = caller
+ sort-key = function
+
+Variables
+~~~~~~~~~
+
+colors.*::
+ Color variables can appoint colors of the output which is printed out
+ from âreportâ, âtopâ,âannotateâ on tui.
+ Color variables is composed of foreground and background
+ and should have two values for them. If you want to set as colors
+ of your terminal, you should use âdefaultâ for color value.
+ The kind of color which can be used as below.
+ red, green, default, black, blue, white, magenta, lightgray
+
+ colors.top::
+ âtopâ means a overhead percentage which has more than 5%.
+ And values of itâs variable specify colors of percentage.
+ Basic key values are foreground-color âredâ and
+ background-color âdefaultâ.
+ colors.medium::
+ âmediumâ means a overhead percentage which has more than 0.5%.
+ Default values are âgreenâ and âdefaultâ.
+ colors.normal::
+ ânormalâ means rest of overhead percentages
+ except âtopâ, âmediumâ, âselectedâ.
+ Default values are âlightgrayâ and âdefaultâ.
+ colors.selected::
+ This appoint colors for forcussed one of the output list
+ from sub-commands (top,report,annotate).
+ Default values are âwhiteâ and âlightgrayâ.
+ colors.code::
+ Colors for a arrow and lines on jumping by assembly code
+ such as âjnsâ,âjmpâ,âjaneâ,etc. Default values are âblueâ, âdefaultâ.
+ colors.addr::
+ This appoint colors for addresses from a sub-command âannotateâ.
+ Default values are âmagentaâ, âdefaultâ.
+ colors.root::
+ Colors for headers in the output of a sub-command âtopâ.
+ Default values are âwhiteâ, âblueâ.
+
+tui.*::
+ Using sub-commands which are âtopâ and âreportâ, âannotateâ,
+ declare whether they work on TUI or not by âonâ or âoffâ.
+gtk.*::
+ Using sub-commands which are âtopâ and âreportâ, âannotateâ,
+ declare whether they work on GTK or not by âonâ or âoffâ.
+
+buildid.*::
+ buildid.dir::
+ Each executable or shared library built with each program is assigned
+ a unique identification as build-id. The option means a path where
+ build-id informations can be saved.
+ The default of this option is /root/.debug
+
+annotate.*::
+ Thereâre options which work with a âannotateâ sub-command.
+ This Options is in control of addresses, jump function, source code
+ in lines of assembly code from a specific program.
+
+ annotate.hide_src_code::
+ If a program which is analyzed has source code of itself,
+ this option let âannotateâ print a list of assembly code with the source code.
+ For example, letâs see a part of a program. Thereâre four lines.
+ If this option is âfalseâ, they can be printed
+ without source code from a program as below.
+
+ â push %rbp
+ â mov %rsp,%rbp
+ â sub $0x10,%rsp
+ â mov (%rdi),%rdx
+
+ But if this option is âtrueâ, source code of the part
+ can be also printed as below.
+
+ â struct rb_node *rb_next(const struct rb_node *node)
+ â {
+ â push %rbp
+ â mov %rsp,%rbp
+ â sub $0x10,%rsp
+ â struct rb_node *parent;
+ â
+ â if (RB_EMPTY_NODE(node))
+ â mov (%rdi),%rdx
+ â return n;
+
+ annotate.use_offset::
+ Basing on a first address of a loaded function, offset can be used.
+ Instead of using original addresses of assembly code,
+ addresses subtracted from a base address can be printed.
+ Letâs illustrate a example.
+ If a base address is 0XFFFFFFFF81624d50 as below,
+
+ ffffffff81624d50 <load0>
+
+ a address on assembly code has a specific absolute address as below
+
+ ffffffff816250b8:â mov 0x8(%r14),%rdi
+
+ but if use_offset is âtrueâ, a address subtracted from a base address is printed.
+ The default is positive.
+
+ 368:â mov 0x8(%r14),%rdi
+
+ annotate.jump_arrows::
+ Thereâre jump instruction among assembly code.
+ Depending on a boolean value of jump_arrows,
+ arrows can be printed or not which represent
+ where do the instruction jump into as below.
+
+ â âââjmp 1333
+ â â xchg %ax,%ax
+ â1330:â mov %r15,%r10
+ â1333:âââcmp %r15,%r14
+
+ If jump_arrow is âfalseâ, the arrows isnât printed as below.
+
+ â â jmp 1333
+ â xchg %ax,%ax
+ â1330: mov %r15,%r10
+ â1333: cmp %r15,%r14
+
+ annotate.show_nr_jumps::
+ Letâs see a part of assembly code.
+
+ â1382: movb $0x1,-0x270(%rbp)
+
+ If use this, the number of branches branching to that address can be printed as below.
+
+ â1 1382: movb $0x1,-0x270(%rbp)
+
+help.*::
+ help.format:: = man
+ A format of manual page can be âmanâ, âinfoâ, âwebâ or âhtmlâ.
+ âmanâ is default.
+ help.autocorrect:: = 0
+ Automatically correct and execute mistyped commands after
+ waiting for the given number of deciseconds (0.1 sec).
+ When this option is 0 if execute a mistyped sub-command instead of âtopâ,
+
+ perf: 'ttop' is not a perf-command. See 'perf --helpâ.
+
+ If this option is more than 1, the output can be such as.
+
+ WARNING: You called a perf program named 'ttop', which does not exist.
+ Continuing under the assumption that you meant 'with-kcore'
+ in 0.1 seconds automatically...
+ Usage: perf-with-kcore <perf sub-command> <perf.data directory> [<sub-command options> [ -- <workload>]]
+ <perf sub-command> can be record, script, report or inject
+ or: perf-with-kcore fix_buildid_cache_permissions
+
+hist.*::
+ hist.percentage::
+ A value of 'percentage' can be 'relative' or 'absolute'
+
+ui.*::
+ ui.show-headers::
+ Thereâre columns as header âOverheadâ, âChildrenâ, âShared Objectâ, âSymbolâ, âselfâ.
+ If this option is negative, they is hided.
+
+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) and âdwarfâ.
+ If using 'Dwarf style', it requires dump-size has a value.
+
+ call-graph.dump-size::
+ When using dwarf into record-mode this option should have a value.
+
+ call-graph.print-type::
+ The print-types can be graph (graph absolute), flat, fractal (graph relative).
+
+ call-graph.order::
+ This option means the criterion of call-graph.
+ A value of 'order' can be 'caller' or 'calleeâ.
+
+ call-graph.sort-key::
+ A value of 'sort-key' can be 'function' or 'addressâ.
+ The default is âfunctionâ.
+
+ call-graph.threshold::
+ call-graph.print-limit::
+
+report.*::
+ report.percent-limit::
+ If percent-limit is 70, the output which has percentages of
+ each overhead above 70% can be printed.
+ report.children::
+ The children means that functions called from another function.
+ If the option is positive, accumulate callchain of children and show total overhead.
+ For example, thereâre three functions like below.
+
+ void foo(void) {
+ /* do something */
+ }
+
+ void bar(void) {
+ /* do something */
+ foo();
+ }
+
+ int main(void) {
+ bar()
+ return 0;
+ }
+
+ Defaultly the output of sub-commands such as âtopâ, âreportâ and âannotateâ
+ depend on a sort of overhead into each functions as below.
+
+ Overhead Symbol
+ ........ .....................
+ 60.00% foo
+ |
+ --- foo
+ bar
+ main
+ __libc_start_main
+
+ 40.00% bar
+ |
+ --- bar
+ main
+ __libc_start_main
+
+ But if this option is positive, the sort is changed into a sort of
+ overhead into each children group of each function reciting all functions
+ from a first parent function till a last child function like below.
+ And it requires -g/--call-graph option enabled
+
+ Children Self Symbol
+ ........ ........ ....................
+ 100.00% 0.00% __libc_start_main
+ |
+ --- __libc_start_main
+
+ 100.00% 0.00% main
+ |
+ --- main
+ __libc_start_main
+
+ 100.00% 40.00% bar
+ |
+ --- bar
+ main
+ __libc_start_main
+
+ 60.00% 60.00% foo
+ |
+ --- foo
+ bar
+ main
+ __libc_start_main
+
+top.*::
+ top.children::
+ This option means same as report.children.
+ So it is positive, the output of âtopâ is rearranged by each overhead into children group.
+
+SEE ALSO
+--------
+linkperf:perf[1]
diff --git a/tools/perf/Documentation/perfconfig.example b/tools/perf/Documentation/perfconfig.example
index 767ea24..86d0e0c 100644
--- a/tools/perf/Documentation/perfconfig.example
+++ b/tools/perf/Documentation/perfconfig.example
@@ -1,29 +1,70 @@
[colors]
-
- # These were the old defaults
- top = red, lightgray
- medium = green, lightgray
- normal = black, lightgray
- selected = lightgray, magenta
- code = blue, lightgray
- addr = magenta, lightgray
+ # There are types of colors which are red,
+ # green, default, black, blue,
+ # white, magenta, lightgray
+ # The default is like below
+ top = red, default
+ medium = green, default
+ normal = lightgray, default
+ selected = white, lightgray
+ code = blue, default
+ addr = magenta, default
+ root = white, blue

[tui]
-
# Defaults if linked with libslang
report = on
annotate = on
top = on

[buildid]
-
# Default, disable using /dev/null
dir = /root/.debug

[annotate]
-
# Defaults
hide_src_code = false
use_offset = true
jump_arrows = true
show_nr_jumps = false
+
+[gtk]
+ report = off
+ annotate = off
+ #top = off
+
+[pager]
+ # That a 'cmd' is true mean to use "pager or less"
+ cmd = true
+
+[help]
+ # Format can be man, info, web or html
+ format = man
+ autocorrect = 0
+
+[hist]
+ # a value of 'percentage' can be 'relative' or 'absolute'
+ percentage = absolute
+
+[ui]
+ show-headers= true
+
+[call-graph]
+ # fp (framepointer), dwarf
+ record-mode = fp
+
+ # graph (graph absolute), flat, fractal (graph relative)
+ print-type = fractal
+
+ # caller, callee
+ order = caller
+
+ # function, address
+ sort-key = function
+
+[report]
+ percent-limit = 1
+ children = false
+
+[top]
+ children = true
diff --git a/tools/perf/builtin-config.c b/tools/perf/builtin-config.c
new file mode 100644
index 0000000..cb4e72e
--- /dev/null
+++ b/tools/perf/builtin-config.c
@@ -0,0 +1,56 @@
+/*
+ * builtin-config.c
+ *
+ * Copyright (C) 2015, Taeung Song <treeze.taeung@xxxxxxxxx>
+ *
+ */
+#include "builtin.h"
+
+#include "perf.h"
+
+#include "util/cache.h"
+#include "util/parse-options.h"
+#include "util/util.h"
+#include "util/debug.h"
+
+static struct {
+ bool list_action;
+} params;
+
+static int show_all_config(const char *key, const char *value,
+ void *cb __maybe_unused)
+{
+ if (value)
+ printf("%s=%s\n", key, value);
+ else
+ printf("%s\n", key);
+
+ return 0;
+}
+
+int cmd_config(int argc, const char **argv, const char *prefix __maybe_unused)
+{
+ int ret = 0;
+ const char * const config_usage[] = {
+ "perf config --list",
+ NULL
+ };
+ const struct option options[] = {
+ OPT_BOOLEAN('l', "list", &params.list_action, "list up current configurations"),
+ OPT_END()
+ };
+
+ argc = parse_options(argc, argv, options, config_usage,
+ PARSE_OPT_STOP_AT_NON_OPTION);
+ if (argc > 0) {
+ if (strcmp(argv[0], "-") == 0)
+ pr_warning(" Error: '-' is not supported.\n");
+
+ usage_with_options(config_usage, options);
+ }
+
+ if (params.list_action)
+ ret = perf_config(show_all_config, NULL);
+
+ return ret;
+}
diff --git a/tools/perf/builtin.h b/tools/perf/builtin.h
index 3688ad2..3f871b5 100644
--- a/tools/perf/builtin.h
+++ b/tools/perf/builtin.h
@@ -17,6 +17,7 @@ extern int cmd_annotate(int argc, const char **argv, const char *prefix);
extern int cmd_bench(int argc, const char **argv, const char *prefix);
extern int cmd_buildid_cache(int argc, const char **argv, const char *prefix);
extern int cmd_buildid_list(int argc, const char **argv, const char *prefix);
+extern int cmd_config(int argc, const char **argv, const char *prefix);
extern int cmd_diff(int argc, const char **argv, const char *prefix);
extern int cmd_evlist(int argc, const char **argv, const char *prefix);
extern int cmd_help(int argc, const char **argv, const char *prefix);
diff --git a/tools/perf/command-list.txt b/tools/perf/command-list.txt
index 00fcaf8..acc3ea7 100644
--- a/tools/perf/command-list.txt
+++ b/tools/perf/command-list.txt
@@ -9,6 +9,7 @@ perf-buildid-cache mainporcelain common
perf-buildid-list mainporcelain common
perf-data mainporcelain common
perf-diff mainporcelain common
+perf-config mainporcelain common
perf-evlist mainporcelain common
perf-inject mainporcelain common
perf-kmem mainporcelain common
diff --git a/tools/perf/perf.c b/tools/perf/perf.c
index b857fcb..604fa4a 100644
--- a/tools/perf/perf.c
+++ b/tools/perf/perf.c
@@ -37,6 +37,7 @@ struct cmd_struct {
static struct cmd_struct commands[] = {
{ "buildid-cache", cmd_buildid_cache, 0 },
{ "buildid-list", cmd_buildid_list, 0 },
+ { "config", cmd_config, 0 },
{ "diff", cmd_diff, 0 },
{ "evlist", cmd_evlist, 0 },
{ "help", cmd_help, 0 },
--
1.9.1

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/