perf config: Add functionalities into perf-config and document config info
v13 cover perf config: Add functionalities into perf-config and document config info
Add options (user, system, list-all, skel, verbose, remove) and getting and setting features into perf-config subcommand to more useful. And document perf config informations for each section.
Changes in v13:
- Add record.build-id config info to perf-config doc [Namhyung]
- Fill missing options info ('verbose', 'skel') on perf-config doc
Changes in v12:
- Modify perf-config documentation for each section to be more proper and correct small typing errors [Namhyung]
- Add missing config variables that are group, show_linenr and show_total_period [Namhyung]
Changes in v11:
- Add --skel option to produce an skeleton with the possible config variables [Arnaldo]
- Add exception handling to --list option when nothing configured [Arnaldo]
- Default action without option is to show an usage message [Arnaldo]
Changes in v10:
- Split perf-config.txt into several patches for each section and replace some paragraphes with better proper things [Arnaldo, Namhyung]
- Correct wrong default values for each variable [Namhyung]
- Remove the compare name function
Changes in v9:
- Add the compare name functionality treating '-' and '-' as being the same thing for usability
Changes in v8:
- Correct small typing errors in a perf-config documention
- Split the collecting configs part into a separate patch
- Use new enum and struct for default configs instead of hard-coded value [Namhyung]
Changes in v7:
- Modify explanations of syntax and options(color, gtk, tui, buildid, annotate) to be better proper descriptions [Arnaldo]
Changes in v6:
- Split a 'set' feature patch into two patch to separate normalize_value() from it
- Bug fix : 'remove' and 'set' malfunctions when without a specific file-option (If file-option isn't used, 'remove' feature had to use both user and system config file and 'set' feature had to only handle user config file.)
Changes in v5:
- Simplify the switch statement in cmd_config()
- Set a config file path with '--system' or '--user' instead of '--global' or '--system' [Namhyung]
- The patch about 'get' and 'set 'split into two patchs [Namhyung]
Changes in v4:
- If some config value is default value, notice it is '(default)' [Jirka]
- If there wasn't any perfconfig file, perf-config malfunctioned So add exception routine with '--global' and '--system' option which can select perf config file path [Jirka]
Changes in v3:
- Add a config variable 'kmem.default' with a default value [Namhyung]
Changes in v2:
- Change option name of listing all configs as '--list-all'
instead of '--all' [Namhyung]
- Correct small infelicities or typing errors in a perf-config documention [Arnaldo]
- Declaration a global variable 'static struct default_configsets' has config variables with default values instead of using a 'util/PERFCONFIG-DEFAULT' file.
- Add a function to normalize a value and check data type of it.
- Simplify parsing arguments as arguments is just divided by '=' and then in front of '.' is a section, between '.' and '=' is a name,
and behind '=' is a value.
- If run perf-config command without any option, perf-config work as '--list'.
Taeung Song (23):
perf config: Document variables for 'colors' section in man page perf config: Document variables for 'tui' and 'gtk' sections in man
page
perf config: Document 'buildid.dir' variable in man page perf config: Document variables for 'annotate' section in man page perf config: Document variables for 'help' section in man page perf config: Document 'hist.percentage' variable in man page perf config: Document 'ui.show-headers' variable in man page perf config: Document variables for 'call-graph' section in man page perf config: Document variables for 'report' section in man page perf config: Document 'top.children' variable in man page perf config: Document 'man.viewer' variable in man page perf config: Document 'pager.<subcommand>' variables in man page perf config: Document 'kmem.default' variable in man page perf config: Document 'record.build-id' variable in man page perf config: Add '--system' and '--user' options to select which
config file is used
perf config: Collect configs to handle config variables perf config: Add 'list-all' option to perf-config
perf config: Add a option 'skel' to perf-config
perf config: Add --verbose option for showing config description perf config: Add 'get' functionality
perf config: Add 'set' feature
perf config: normalize a value depending on default type of it perf config: Add a option 'remove' to perf-config
tools/perf/Documentation/perf-config.txt | 380 ++++++++++++++++- tools/perf/builtin-config.c | 709 ++++++++++++++++++++++++++++++- tools/perf/util/cache.h | 20 + tools/perf/util/config.c | 31 +- 4 files changed, 1126 insertions(+), 14 deletions(-)
Signature · 1 line
2.5.0
PATCH v13 1/23 perf config: Document variables for 'colors' section in man page
Explain 'colors' section and its variables.
'top', 'medium', 'normal', 'selected', 'code', 'addr' and 'root'.
--- tools/perf/Documentation/perf-config.txt | 46 ++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+)
tools/perf/Documentation/perf-config.txt +46 -0
@@ -98,6 +98,52 @@ Given a $HOME/.perfconfig like this: order = caller sort-key = function +Variables +~~~~~~~~~ + +colors.*:: + The variables for customizing the colors used in the output for the + 'report', 'top' and 'annotate' in the TUI. They should specify the + foreground and background colors, separated by a comma, for example: + + medium = green, lightgray + + If you want to use the color configured for you terminal, just leave it + as 'default', for example: + + medium = default, lightgray + + Available colors: + red, yellow, green, cyan, gray, black, blue, + white, default, magenta, lightgray + + colors.top:: + 'top' means a overhead percentage which is more than 5%. + And values of this variable specify percentage colors. + 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 the rest of overhead percentages + except 'top', 'medium', 'selected'. + Default values are 'lightgray' and 'default'. + colors.selected:: + This selects the colors for the current entry in a list of entries + from sub-commands (top, report, annotate). + Default values are 'black' and 'lightgray'. + colors.jump_arrows:: + Colors for jump arrows on assembly code listings + such as 'jns', 'jmp', 'jane', etc. + Default values are 'blue', 'default'. + colors.addr:: + This selects colors for addresses from 'annotate'. + Default values are 'magenta', 'default'. + colors.root:: + Colors for headers in the output of a sub-commands (top, report). + Default values are 'white', 'blue'. + SEE ALSO -------- linkperf:perf[1]
Signature · 1 line
2.5.0
tip-bot for Taeung Song
merge bot[tip:perf/core] perf config: Document variables for 'colors' section in man page
perf config: Document variables for 'colors' section in man page
Commit-ID: 89debf178708458ac62f5b53dfc97437009d02d3 Gitweb: http://git.kernel.org/tip/89debf178708458ac62f5b53dfc97437009d02d3 Author: Taeung Song <[email protected]> AuthorDate: Fri, 8 Jan 2016 20:39:31 +0900 Committer: Arnaldo Carvalho de Melo <[email protected]> CommitDate: Tue, 26 Jan 2016 11:52:46 -0300
perf config: Document variables for 'colors' section in man page
Explain 'colors' section and its variables, used for The variables for customizing the colors used in the output for the 'report', 'top' and 'annotate' in the TUI, those are:
'top', 'medium', 'normal', 'selected',
'jump_arrows', 'addr' and 'root'.
--- tools/perf/Documentation/perf-config.txt | 46 ++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+)
tools/perf/Documentation/perf-config.txt +46 -0
@@ -98,6 +98,52 @@ Given a $HOME/.perfconfig like this: order = caller sort-key = function +Variables +~~~~~~~~~ + +colors.*:: + The variables for customizing the colors used in the output for the + 'report', 'top' and 'annotate' in the TUI. They should specify the + foreground and background colors, separated by a comma, for example: + + medium = green, lightgray + + If you want to use the color configured for you terminal, just leave it + as 'default', for example: + + medium = default, lightgray + + Available colors: + red, yellow, green, cyan, gray, black, blue, + white, default, magenta, lightgray + + colors.top:: + 'top' means a overhead percentage which is more than 5%. + And values of this variable specify percentage colors. + 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 the rest of overhead percentages + except 'top', 'medium', 'selected'. + Default values are 'lightgray' and 'default'. + colors.selected:: + This selects the colors for the current entry in a list of entries + from sub-commands (top, report, annotate). + Default values are 'black' and 'lightgray'. + colors.jump_arrows:: + Colors for jump arrows on assembly code listings + such as 'jns', 'jmp', 'jane', etc. + Default values are 'blue', 'default'. + colors.addr:: + This selects colors for addresses from 'annotate'. + Default values are 'magenta', 'default'. + colors.root:: + Colors for headers in the output of a sub-commands (top, report). + Default values are 'white', 'blue'. + SEE ALSO -------- linkperf:perf[1]
PATCH v13 2/23 perf config: Document variables for 'tui' and 'gtk' sections in man page
In reply to Taeung SongExplain 'tui' and 'gtk' sections and these variables.
'top', 'report' and 'annotate'
--- tools/perf/Documentation/perf-config.txt | 9 +++++++++ 1 file changed, 9 insertions(+)
tools/perf/Documentation/perf-config.txt +9 -0
@@ -144,6 +144,15 @@ colors.*:: Colors for headers in the output of a sub-commands (top, report). Default values are 'white', 'blue'. +tui.*, gtk.*:: + Available subcommands are 'top', 'report' and 'annotate'. + These values are a boolean type, for example: + + top = true + + By setting value, TUI or GTK can be enabled or not. But it is needed + that perf detects the required library for them during build. + SEE ALSO -------- linkperf:perf[1]
Signature · 1 line
2.5.0
tip-bot for Taeung Song
merge bot[tip:perf/core] perf config: Document variables for 'tui' and ' gtk' sections in man page
perf config: Document variables for 'tui' and 'gtk' sections in man page
Commit-ID: 3fa9f40718a33d27eb2f4bd36c13318a2d58839d Gitweb: http://git.kernel.org/tip/3fa9f40718a33d27eb2f4bd36c13318a2d58839d Author: Taeung Song <[email protected]> AuthorDate: Fri, 8 Jan 2016 20:39:32 +0900 Committer: Arnaldo Carvalho de Melo <[email protected]> CommitDate: Tue, 26 Jan 2016 11:52:47 -0300
perf config: Document variables for 'tui' and 'gtk' sections in man page
Explain 'tui' and 'gtk' sections and these variables.
'top', 'report' and 'annotate'
--- tools/perf/Documentation/perf-config.txt | 10 ++++++++++ 1 file changed, 10 insertions(+)
tools/perf/Documentation/perf-config.txt +10 -0
@@ -144,6 +144,16 @@ colors.*:: Colors for headers in the output of a sub-commands (top, report). Default values are 'white', 'blue'. +tui.*, gtk.*:: + Subcommands that can be configured here are 'top', 'report' and 'annotate'. + These values are booleans, for example: + + [tui] + top = true + + will make the TUI be the default for the 'top' subcommand. Those will be + available if the required libs were detected at tool build time. + SEE ALSO -------- linkperf:perf[1]
PATCH v13 3/23 perf config: Document 'buildid.dir' variable in man page
In reply to Taeung SongExplain 'buildid.dir' variable.
--- tools/perf/Documentation/perf-config.txt | 15 +++++++++++++++ 1 file changed, 15 insertions(+)
tools/perf/Documentation/perf-config.txt +15 -0
@@ -153,6 +153,21 @@ tui.*, gtk.*:: By setting value, TUI or GTK can be enabled or not. But it is needed that perf detects the required library for them during build. +buildid.*:: + buildid.dir:: + Each executable and shared library in modern distributions comes with a + content based identifier that, if available, will be inserted in a + 'perf.data' file header to, at analysis time find what is needed to do + symbol resolution, code annotation, etc. + + The recording tools also stores a hard link or copy in a per-user + directory, $HOME/.debug/, of binaries, shared libraries, /proc/kallsyms + and /proc/kcore files to be used at analysis time. + + The buildid.dir variable can be used to either change this directory + cache location, or to disable it altogether. If you want to disable it, + set buildid.dir to /dev/null. The default is $HOME/.debug + SEE ALSO -------- linkperf:perf[1]
Signature · 1 line
2.5.0
tip-bot for Taeung Song
merge bot[tip:perf/core] perf config: Document 'buildid.dir' variable in man page
perf config: Document 'buildid.dir' variable in man page
Commit-ID: 2733525b8c1a5f9b6e55338d836b835c9c698913 Gitweb: http://git.kernel.org/tip/2733525b8c1a5f9b6e55338d836b835c9c698913 Author: Taeung Song <[email protected]> AuthorDate: Fri, 8 Jan 2016 20:39:33 +0900 Committer: Arnaldo Carvalho de Melo <[email protected]> CommitDate: Tue, 26 Jan 2016 11:52:47 -0300
perf config: Document 'buildid.dir' variable in man page
Explain 'buildid.dir' variable.
--- tools/perf/Documentation/perf-config.txt | 15 +++++++++++++++ 1 file changed, 15 insertions(+)
tools/perf/Documentation/perf-config.txt +15 -0
@@ -154,6 +154,21 @@ tui.*, gtk.*:: will make the TUI be the default for the 'top' subcommand. Those will be available if the required libs were detected at tool build time. +buildid.*:: + buildid.dir:: + Each executable and shared library in modern distributions comes with a + content based identifier that, if available, will be inserted in a + 'perf.data' file header to, at analysis time find what is needed to do + symbol resolution, code annotation, etc. + + The recording tools also stores a hard link or copy in a per-user + directory, $HOME/.debug/, of binaries, shared libraries, /proc/kallsyms + and /proc/kcore files to be used at analysis time. + + The buildid.dir variable can be used to either change this directory + cache location, or to disable it altogether. If you want to disable it, + set buildid.dir to /dev/null. The default is $HOME/.debug + SEE ALSO -------- linkperf:perf[1]
PATCH v13 4/23 perf config: Document variables for 'annotate' section in man page
In reply to Taeung SongExplain 'annotate' section and its variables.
'hide_src_code', 'use_offset', 'jump_arrows', 'show_linenr', 'show_nr_jump' and 'show_total_period'.
--- tools/perf/Documentation/perf-config.txt | 110 +++++++++++++++++++++++++++++++ 1 file changed, 110 insertions(+)
tools/perf/Documentation/perf-config.txt +110 -0
@@ -168,6 +168,116 @@ buildid.*:: cache location, or to disable it altogether. If you want to disable it, set buildid.dir to /dev/null. The default is $HOME/.debug +annotate.*:: + These options work only for TUI. + These are 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, + this option lets '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 'true', 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 'false', source code of the part + can be also printed as below. Default is 'false'. + + │ 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 an example. + If a base address is 0XFFFFFFFF81624d50 as below, + + ffffffff81624d50 <load0> + + an address on assembly code has a specific absolute address as below + + ffffffff816250b8:│ mov 0x8(%r14),%rdi + + but if use_offset is 'true', an address subtracted from a base address is printed. + Default is true. This option is only applied to TUI. + + 368:│ mov 0x8(%r14),%rdi + + annotate.jump_arrows:: + There can be 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. + Default is 'false'. + + │ ↓ jmp 1333 + │ xchg %ax,%ax + │1330: mov %r15,%r10 + │1333: cmp %r15,%r14 + + annotate.show_linenr:: + When showing source code if this option is 'true', + line numbers are printed as below. + + │1628 if (type & PERF_SAMPLE_IDENTIFIER) { + │ ↓ jne 508 + │1628 data->id = *array; + │1629 array++; + │1630 } + + However if this option is 'false', they aren't printed as below. + Default is 'false'. + + │ if (type & PERF_SAMPLE_IDENTIFIER) { + │ ↓ jne 508 + │ data->id = *array; + │ array++; + │ } + + annotate.show_nr_jumps:: + Let's see a part of assembly code. + + │1382: movb $0x1,-0x270(%rbp) + + If use this, the number of branches jumping to that address can be printed as below. + Default is 'false'. + + │1 1382: movb $0x1,-0x270(%rbp) + + annotate.show_total_period:: + To compare two records on an instruction base, with this option + provided, display total number of samples that belong to a line + in assembly code. If this option is 'true', total periods are printed + instead of percent values as below. + + 302 │ mov %eax,%eax + + But if this option is 'false', percent values for overhead are printed i.e. + Default is 'false'. + + 99.93 │ mov %eax,%eax + SEE ALSO -------- linkperf:perf[1]
Signature · 1 line
2.5.0
Arnaldo Carvalho de Melo
maintainerRe: [PATCH v13 04/23] perf config: Document variables for 'annotate' section in man page
Em Fri, Jan 08, 2016 at 08:39:34PM +0900, Taeung Song escreveu:
Quoted 17 lines
Explain 'annotate' section and its variables.
'
hide_src_code', 'use_offset', 'jump_arrows', 'show_linenr', 'show_nr_jump' and 'show_total_period'.Cc Namhyung Kim <[email protected]>Cc Jiri Olsa <[email protected]>Signed-off-by Taeung Song <[email protected]>--- tools/perf/Documentation/perf-config.txt | 110 +++++++++++++++++++++++++++++++ 1 file changed, 110 insertions(+)tools/perf/Documentation/perf-config.txt +0
-0
tools/perf/Documentation/perf-config.txt buildid.*:: · line 169
Quoted 2 lines
tools/perf/Documentation/perf-config.txt +0
-0@@ -168,6 +168,116 @@ buildid.*:: cache location, or to disable it altogether. If you want to disable it, set buildid.dir to /dev/null. The default is $HOME/.debug
I suggest you document here also the hotkeys that are available in the TUI to toggle those knobs, i.e. please go to the annotate browser and press 'h', you'll get the list of hotkeys, this way, for someone reading the man page the information will know that this can be done interactively, not just by changing a config file.
Also it would be interesting to change the annotate/top/report man page to point to this documentation.
But this can be done on top, I'm doing quick text flowing/grammar fixes and applying as much as I can from this patchkit, thanks for continuing work on it.
- Arnaldo
Quoted 115 lines
tools/perf/Documentation/perf-config.txt +110
-0+annotate.*:: + These options work only for TUI. + These are 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, + this option lets '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 'true', 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 'false', source code of the part + can be also printed as below. Default is 'false'. + + │ 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 an example. + If a base address is 0XFFFFFFFF81624d50 as below, + + ffffffff81624d50 <load0> + + an address on assembly code has a specific absolute address as below + + ffffffff816250b8:│ mov 0x8(%r14),%rdi + + but if use_offset is 'true', an address subtracted from a base address is printed. + Default is true. This option is only applied to TUI. + + 368:│ mov 0x8(%r14),%rdi + + annotate.jump_arrows:: + There can be 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. + Default is 'false'. + + │ ↓ jmp 1333 + │ xchg %ax,%ax + │1330: mov %r15,%r10 + │1333: cmp %r15,%r14 + + annotate.show_linenr:: + When showing source code if this option is 'true', + line numbers are printed as below. + + │1628 if (type & PERF_SAMPLE_IDENTIFIER) { + │ ↓ jne 508 + │1628 data->id = *array; + │1629 array++; + │1630 } + + However if this option is 'false', they aren't printed as below. + Default is 'false'. + + │ if (type & PERF_SAMPLE_IDENTIFIER) { + │ ↓ jne 508 + │ data->id = *array; + │ array++; + │ } + + annotate.show_nr_jumps:: + Let's see a part of assembly code. + + │1382: movb $0x1,-0x270(%rbp) + + If use this, the number of branches jumping to that address can be printed as below. + Default is 'false'. + + │1 1382: movb $0x1,-0x270(%rbp) + + annotate.show_total_period:: + To compare two records on an instruction base, with this option + provided, display total number of samples that belong to a line + in assembly code. If this option is 'true', total periods are printed + instead of percent values as below. + + 302 │ mov %eax,%eax + + But if this option is 'false', percent values for overhead are printed i.e. + Default is 'false'. + + 99.93 │ mov %eax,%eax + SEE ALSO -------- linkperf:perf[1]Signature · 1 line
2.5.0
Re: [PATCH v13 04/23] perf config: Document variables for 'annotate' section in man page
Hi, Arnaldo
Sorry for my tardy response.
Quoted 13 lines · Arnaldo Carvalho de Melo
Em Fri, Jan 08, 2016 at 08:39:34PM +0900, Taeung Song escreveu:
Quoted 12 lines
Explain 'annotate' section and its variables.
'
hide_src_code', 'use_offset', 'jump_arrows', 'show_linenr', 'show_nr_jump' and 'show_total_period'.Cc Namhyung Kim <[email protected]>Cc Jiri Olsa <[email protected]>Signed-off-by Taeung Song <[email protected]>--- tools/perf/Documentation/perf-config.txt | 110 +++++++++++++++++++++++++++++++ 1 file changed, 110 insertions(+)
Quoted 14 lines
tools/perf/Documentation/perf-config.txt buildid.*:: · line 169
Quoted 7 lines
tools/perf/Documentation/perf-config.txt +0
-0@@ -168,6 +168,116 @@ buildid.*:: cache location, or to disable it altogether. If you want to disable it, set buildid.dir to /dev/null. The default is $HOME/.debugI suggest you document here also the hotkeys that are available in the TUI to toggle those knobs, i.e. please go to the annotate browser and press 'h', you'll get the list of hotkeys, this way, for someone reading the man page the information will know that this can be done interactively, not just by changing a config file.
I don't know whether this patch was applied
as it is, because of my tardy response or not..
I saw this patch was included in [GIT PULL] mail.
Would you mind if I add this hotkeys information
into perf-config documentation as new patchset ?
Quoted 3 lines
Also it would be interesting to change the annotate/top/report man page to point to this documentation.
Ok, I understood that add 'linkperf:perf-config[1]' to section 'SEE ALSO' on the annotate/top/report man page.
Is it right ?
If it isn't, add a sentence such as
'Please refer to the perf-config manual.'
to the annotate/top/report documentation ?
Quoted 3 lines
But this can be done on top, I'm doing quick text flowing/grammar fixes and applying as much as I can from this patchkit, thanks for continuing work on it.
Although it is a minor contribution,
I'm so glad I could contribute. :-)
Thanks,
Taeung
tip-bot for Taeung Song
merge bot[tip:perf/core] perf config: Document variables for 'annotate' section in man page
In reply to Taeung Songperf config: Document variables for 'annotate' section in man page
Commit-ID: 3b97629d139b19cbcd15b0b3c128a4d6587d2091 Gitweb: http://git.kernel.org/tip/3b97629d139b19cbcd15b0b3c128a4d6587d2091 Author: Taeung Song <[email protected]> AuthorDate: Fri, 8 Jan 2016 20:39:34 +0900 Committer: Arnaldo Carvalho de Melo <[email protected]> CommitDate: Tue, 26 Jan 2016 11:52:48 -0300
perf config: Document variables for 'annotate' section in man page
Explain 'annotate' section and its variables.
'hide_src_code', 'use_offset', 'jump_arrows', 'show_linenr', 'show_nr_jump' and 'show_total_period'.
--- tools/perf/Documentation/perf-config.txt | 110 +++++++++++++++++++++++++++++++ 1 file changed, 110 insertions(+)
tools/perf/Documentation/perf-config.txt +110 -0
@@ -169,6 +169,116 @@ buildid.*:: cache location, or to disable it altogether. If you want to disable it, set buildid.dir to /dev/null. The default is $HOME/.debug +annotate.*:: + These options work only for TUI. + These are 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, + this option lets '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 'true', 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 'false', source code of the part + can be also printed as below. Default is 'false'. + + │ 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 an example. + If a base address is 0XFFFFFFFF81624d50 as below, + + ffffffff81624d50 <load0> + + an address on assembly code has a specific absolute address as below + + ffffffff816250b8:│ mov 0x8(%r14),%rdi + + but if use_offset is 'true', an address subtracted from a base address is printed. + Default is true. This option is only applied to TUI. + + 368:│ mov 0x8(%r14),%rdi + + annotate.jump_arrows:: + There can be 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. + Default is 'false'. + + │ ↓ jmp 1333 + │ xchg %ax,%ax + │1330: mov %r15,%r10 + │1333: cmp %r15,%r14 + + annotate.show_linenr:: + When showing source code if this option is 'true', + line numbers are printed as below. + + │1628 if (type & PERF_SAMPLE_IDENTIFIER) { + │ ↓ jne 508 + │1628 data->id = *array; + │1629 array++; + │1630 } + + However if this option is 'false', they aren't printed as below. + Default is 'false'. + + │ if (type & PERF_SAMPLE_IDENTIFIER) { + │ ↓ jne 508 + │ data->id = *array; + │ array++; + │ } + + annotate.show_nr_jumps:: + Let's see a part of assembly code. + + │1382: movb $0x1,-0x270(%rbp) + + If use this, the number of branches jumping to that address can be printed as below. + Default is 'false'. + + │1 1382: movb $0x1,-0x270(%rbp) + + annotate.show_total_period:: + To compare two records on an instruction base, with this option + provided, display total number of samples that belong to a line + in assembly code. If this option is 'true', total periods are printed + instead of percent values as below. + + 302 │ mov %eax,%eax + + But if this option is 'false', percent values for overhead are printed i.e. + Default is 'false'. + + 99.93 │ mov %eax,%eax + SEE ALSO -------- linkperf:perf[1]
PATCH v13 5/23 perf config: Document variables for 'help' section in man page
In reply to Taeung SongExplain 'help.format' variables.
--- tools/perf/Documentation/perf-config.txt | 4 ++++ 1 file changed, 4 insertions(+)
tools/perf/Documentation/perf-config.txt +4 -0
@@ -278,6 +278,10 @@ annotate.*:: 99.93 │ mov %eax,%eax +help.*:: + help.format:: + A format of manual page can be 'man' that is default. + SEE ALSO -------- linkperf:perf[1]
Signature · 1 line
2.5.0
Arnaldo Carvalho de Melo
maintainerRe: [PATCH v13 05/23] perf config: Document variables for 'help' section in man page
Em Fri, Jan 08, 2016 at 08:39:35PM +0900, Taeung Song escreveu:
Quoted 14 lines
Explain 'help.format' variables.
Cc Namhyung Kim <[email protected]>Cc Jiri Olsa <[email protected]>Signed-off-by Taeung Song <[email protected]>--- tools/perf/Documentation/perf-config.txt | 4 ++++ 1 file changed, 4 insertions(+)tools/perf/Documentation/perf-config.txt +0
-0
tools/perf/Documentation/perf-config.txt annotate.*:: · line 284
Quoted 7 lines
tools/perf/Documentation/perf-config.txt +4
-0@@ -278,6 +278,10 @@ annotate.*:: 99.93 │ mov %eax,%eax +help.*:: + help.format:: + A format of manual page can be 'man' that is default. +
Huh? If this is the case, i.e. we have something that is configurable but admits only one option, maybe we should trow this alltogether and remove the need to document it? :-)
- Arnaldo
Quoted 5 lines
tools/perf/Documentation/perf-config.txt +0
-0SEE ALSO -------- linkperf:perf[1]Signature · 1 line
2.5.0
Re: [PATCH v13 05/23] perf config: Document variables for 'help' section in man page
Quoted 18 lines · Arnaldo Carvalho de Melo
Em Fri, Jan 08, 2016 at 08:39:35PM +0900, Taeung Song escreveu:
Quoted 17 lines
Explain 'help.format' variables.
Cc Namhyung Kim <[email protected]>Cc Jiri Olsa <[email protected]>Signed-off-by Taeung Song <[email protected]>--- tools/perf/Documentation/perf-config.txt | 4 ++++ 1 file changed, 4 insertions(+)tools/perf/Documentation/perf-config.txt +0
-0@@ -278,6 +278,10 @@ annotate.*:: 99.93 │ mov %eax,%eax
Quoted 9 lines
tools/perf/Documentation/perf-config.txt annotate.*:: · line 284
Quoted 4 lines
tools/perf/Documentation/perf-config.txt +4
-0+help.*:: + help.format:: + A format of manual page can be 'man' that is default. +Huh? If this is the case, i.e. we have something that is configurable but admits only one option, maybe we should trow this alltogether and remove the need to document it? :-)
Hum.. I think so.
I tested config variables 'help.format' and 'man.viewer', again. Selecting which manual page viewer can be done by both this config variables.
So IMHO I think even if 'help.format' is removed, it hasn't problem because this functionality is duplicated. And I think it seems to be tidy that the whole 'help' section is removed or just don't document it on perf-config doc.
Would I keep working on perf-config patchkit excluding 'help' section ?
Thanks,
Taeung
PATCH v13 6/23 perf config: Document 'hist.percentage' variable in man page
In reply to Taeung SongExplain 'hist.percentage' variable.
--- tools/perf/Documentation/perf-config.txt | 17 +++++++++++++++++ 1 file changed, 17 insertions(+)
tools/perf/Documentation/perf-config.txt +17 -0
@@ -282,6 +282,23 @@ help.*:: help.format:: A format of manual page can be 'man' that is default. +hist.*:: + hist.percentage:: + This option control the way to calculate overhead of filtered entries - + that means the value of this option is effective only if there's a + filter (by comm, dso or symbol name). Suppose a following example: + + Overhead Symbols + ........ ....... + 33.33% foo + 33.33% bar + 33.33% baz + + This is an original overhead and we'll filter out the first 'foo' + entry. The value of 'relative' would increase the overhead of 'bar' + and 'baz' to 50.00% for each, while 'absolute' would show their + current overhead (33.33%). + SEE ALSO -------- linkperf:perf[1]
Signature · 1 line
2.5.0
Arnaldo Carvalho de Melo
maintainerRe: [PATCH v13 06/23] perf config: Document 'hist.percentage' variable in man page
Em Fri, Jan 08, 2016 at 08:39:36PM +0900, Taeung Song escreveu:
Quoted 23 lines
Explain 'hist.percentage' variable.
Cc Namhyung Kim <[email protected]>Cc Jiri Olsa <[email protected]>Signed-off-by Taeung Song <[email protected]>--- tools/perf/Documentation/perf-config.txt | 17 +++++++++++++++++ 1 file changed, 17 insertions(+)tools/perf/Documentation/perf-config.txt +6
-0@@ -282,6 +282,23 @@ help.*:: help.format:: A format of manual page can be 'man' that is default. +hist.*:: + hist.percentage:: + This option control the way to calculate overhead of filtered entries - + that means the value of this option is effective only if there's a + filter (by comm, dso or symbol name). Suppose a following example: +
tools/perf/Documentation/perf-config.txt help.*:: · line 300
Quoted 10 lines
tools/perf/Documentation/perf-config.txt +10
-0+ Overhead Symbols + ........ ....... + 33.33% foo + 33.33% bar + 33.33% baz + + This is an original overhead and we'll filter out the first 'foo' + entry. The value of 'relative' would increase the overhead of 'bar' + and 'baz' to 50.00% for each, while 'absolute' would show their + current overhead (33.33%).
Ditto, this one can be toggled interactively using 'F'
- Arnaldo
Re: [PATCH v13 06/23] perf config: Document 'hist.percentage' variable in man page
Quoted 28 lines · Arnaldo Carvalho de Melo
Em Fri, Jan 08, 2016 at 08:39:36PM +0900, Taeung Song escreveu:
Quoted 27 lines
Explain 'hist.percentage' variable.
Cc Namhyung Kim <[email protected]>Cc Jiri Olsa <[email protected]>Signed-off-by Taeung Song <[email protected]>--- tools/perf/Documentation/perf-config.txt | 17 +++++++++++++++++ 1 file changed, 17 insertions(+)tools/perf/Documentation/perf-config.txt +10
-0@@ -282,6 +282,23 @@ help.*:: help.format:: A format of manual page can be 'man' that is default. +hist.*:: + hist.percentage:: + This option control the way to calculate overhead of filtered entries - + that means the value of this option is effective only if there's a + filter (by comm, dso or symbol name). Suppose a following example: + + Overhead Symbols + ........ ....... + 33.33% foo + 33.33% bar
Quoted 8 lines
tools/perf/Documentation/perf-config.txt help.*:: · line 300
Quoted 6 lines
tools/perf/Documentation/perf-config.txt +6
-0+ 33.33% baz + + This is an original overhead and we'll filter out the first 'foo' + entry. The value of 'relative' would increase the overhead of 'bar' + and 'baz' to 50.00% for each, while 'absolute' would show their + current overhead (33.33%).Ditto, this one can be toggled interactively using 'F'
I got it.
As I say on previous mail,
Would I work new patchset for hotkeys information ?
Thanks,
Taeung
tip-bot for Taeung Song
merge bot[tip:perf/core] perf config: Document 'hist.percentage' variable in man page
In reply to Taeung Songperf config: Document 'hist.percentage' variable in man page
Commit-ID: 485311d97863f2810646e17c8075be2992225f98 Gitweb: http://git.kernel.org/tip/485311d97863f2810646e17c8075be2992225f98 Author: Taeung Song <[email protected]> AuthorDate: Fri, 8 Jan 2016 20:39:36 +0900 Committer: Arnaldo Carvalho de Melo <[email protected]> CommitDate: Tue, 26 Jan 2016 11:52:48 -0300
perf config: Document 'hist.percentage' variable in man page
Explain 'hist.percentage' variable.
--- tools/perf/Documentation/perf-config.txt | 17 +++++++++++++++++ 1 file changed, 17 insertions(+)
tools/perf/Documentation/perf-config.txt +17 -0
@@ -279,6 +279,23 @@ annotate.*:: 99.93 │ mov %eax,%eax +hist.*:: + hist.percentage:: + This option control the way to calculate overhead of filtered entries - + that means the value of this option is effective only if there's a + filter (by comm, dso or symbol name). Suppose a following example: + + Overhead Symbols + ........ ....... + 33.33% foo + 33.33% bar + 33.33% baz + + This is an original overhead and we'll filter out the first 'foo' + entry. The value of 'relative' would increase the overhead of 'bar' + and 'baz' to 50.00% for each, while 'absolute' would show their + current overhead (33.33%). + SEE ALSO -------- linkperf:perf[1]
PATCH v13 7/23 perf config: Document 'ui.show-headers' variable in man page
In reply to Taeung SongExplain 'ui.show-headers' variable.
--- tools/perf/Documentation/perf-config.txt | 6 ++++++ 1 file changed, 6 insertions(+)
tools/perf/Documentation/perf-config.txt +6 -0
@@ -299,6 +299,12 @@ hist.*:: and 'baz' to 50.00% for each, while 'absolute' would show their current overhead (33.33%). +ui.*:: + ui.show-headers:: + This option controls display of column headers (like 'Overhead' and 'Symbol') + in 'report' and 'top'. If this option is false, they are hidden. + This option is only applied to TUI. + SEE ALSO -------- linkperf:perf[1]
Signature · 1 line
2.5.0
PATCH v13 8/23 perf config: Document variables for 'call-graph' section in man page
In reply to Taeung SongExplain 'call-graph' section and its variables.
'record-mode', 'dump-size', 'print-type', 'order', 'sort-key', 'threshold' and 'print-limit'.
--- tools/perf/Documentation/perf-config.txt | 67 ++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+)
tools/perf/Documentation/perf-config.txt +67 -0
@@ -305,6 +305,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]
Signature · 1 line
2.5.0
PATCH v13 9/23 perf config: Document variables for 'report' section in man page
In reply to Taeung SongExplain 'report' section's variables.
'percent-limit', 'queue-size' and 'children'.
--- tools/perf/Documentation/perf-config.txt | 34 ++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+)
tools/perf/Documentation/perf-config.txt +34 -0
@@ -372,6 +372,40 @@ call-graph.*:: This is a maximum number of lines of callchain printed for a single histogram entry. Default is 0 which means no limitation. +report.*:: + report.percent-limit:: + This one is mostly same as call-graph.threshold but works for + histogram entries. Entries have overhead lower than this percentage + will not be printed. Default is 0. If percent-limit is 10, + entries which have more than 10% of overhead will be printed only. + + report.queue-size:: + This option is to setup the maximum allocation size of internal + event queue for ordering events. Default is 0, meaning no limit. + + report.children:: + The children means that functions called from another function. + If this option is true, perf report cumulates callchains of children + and show (accumulated) total overhead as well as self overhead. + Please refer to the perf-report manual. The default is true. + + report.group:: + This option is to show event group information together. + If it is 'true', event group view can be enabled by default i.e. + + # group: {ref-cycles,cycles} + # ======== + # + # Samples: 7K of event 'anon group { ref-cycles, cycles }' + # Event count (approx.): 6876107743 + # + # Overhead Command Shared Object Symbol + # ................ ....... ................. .......................... + # + 99.84% 99.76% noploop noploop [.] main + 0.07% 0.00% noploop ld-2.15.so [.] strcmp + 0.03% 0.00% noploop [kernel.kallsyms] [k] timerqueue_del + SEE ALSO -------- linkperf:perf[1]
Signature · 1 line
2.5.0
PATCH v13 10/23 perf config: Document 'top.children' variable in man page
In reply to Taeung SongExplain 'top.children' variable.
--- tools/perf/Documentation/perf-config.txt | 7 +++++++ 1 file changed, 7 insertions(+)
tools/perf/Documentation/perf-config.txt +7 -0
@@ -406,6 +406,13 @@ report.*:: 0.07% 0.00% noploop ld-2.15.so [.] strcmp 0.03% 0.00% noploop [kernel.kallsyms] [k] timerqueue_del +top.*:: + top.children:: + This option means same as report.children. So if it is true, + the output of 'top' command will have 'Children' overhead column + as well as 'Self' overhead column by default. + The default is true. + SEE ALSO -------- linkperf:perf[1]
Signature · 1 line
2.5.0
PATCH v13 11/23 perf config: Document 'man.viewer' variable in man page
In reply to Taeung SongExplain 'man.viewer' variable and how to add new man viewer tools.
--- tools/perf/Documentation/perf-config.txt | 9 +++++++++ 1 file changed, 9 insertions(+)
tools/perf/Documentation/perf-config.txt +9 -0
@@ -413,6 +413,15 @@ top.*:: as well as 'Self' overhead column by default. The default is true. +man.*:: + man.viewer:: + This option can assign a tool to view manual pages when 'help' + subcommand was invoked. Supported tools are 'man', 'woman' + (with emacs client) and 'konqueror'. Default is 'man'. + + New man viewer tool can be also added using 'man.<tool>.cmd' + or use different path using 'man.<tool>.path' config option. + SEE ALSO -------- linkperf:perf[1]
Signature · 1 line
2.5.0
PATCH v13 12/23 perf config: Document 'pager.<subcommand>' variables in man page
In reply to Taeung SongExplain 'pager.<subcommand>' variables.
--- tools/perf/Documentation/perf-config.txt | 5 +++++ 1 file changed, 5 insertions(+)
tools/perf/Documentation/perf-config.txt +5 -0
@@ -422,6 +422,11 @@ man.*:: New man viewer tool can be also added using 'man.<tool>.cmd' or use different path using 'man.<tool>.path' config option. +pager.*:: + pager.<subcommand>:: + When the subcommand is run on stdio, determine whether it uses + pager or not based on this value. Default is 'unspecified'. + SEE ALSO -------- linkperf:perf[1]
Signature · 1 line
2.5.0
PATCH v13 13/23 perf config: Document 'kmem.default' variable in man page
In reply to Taeung SongExplain 'kmem.default' variable.
--- tools/perf/Documentation/perf-config.txt | 5 +++++ 1 file changed, 5 insertions(+)
tools/perf/Documentation/perf-config.txt +5 -0
@@ -427,6 +427,11 @@ pager.*:: When the subcommand is run on stdio, determine whether it uses pager or not based on this value. Default is 'unspecified'. +kmem.*:: + kmem.default:: + This option decides which allocator is to be analyzed if neither + '--slab' nor '--page' option is used. Default is 'slab'. + SEE ALSO -------- linkperf:perf[1]
Signature · 1 line
2.5.0
PATCH v13 14/23 perf config: Document 'record.build-id' variable in man page
In reply to Taeung SongExplain 'record.build-id' variable.
--- tools/perf/Documentation/perf-config.txt | 8 ++++++++ 1 file changed, 8 insertions(+)
tools/perf/Documentation/perf-config.txt +8 -0
@@ -432,6 +432,14 @@ kmem.*:: This option decides which allocator is to be analyzed if neither '--slab' nor '--page' option is used. Default is 'slab'. +record.*:: + record.build-id:: + This option can be 'cache', 'no-cache' or 'skip'. + 'cache' is to post-process data and save/update the binaries into + the build-id cache (in ~/.debug). This is the default. + But if this option is 'no-cache', not update the build-id cache. + 'skip' mean that skip post-processing and do not update the cache. + SEE ALSO -------- linkperf:perf[1]
Signature · 1 line
2.5.0
PATCH v13 15/23 perf config: Add '--system' and '--user' options to select which config file is used
In reply to Taeung SongThe file-options '--system' means $(sysconfdir)/perfconfig and '--user' means $HOME/.perfconfig. If file-option isn't used, both system and user config file is read.
The syntax examples are like below.
perf config [<file-option>] [options]
a specific config file.
# perf config --user | --system
or
both user and system config file.
# perf config
--- tools/perf/Documentation/perf-config.txt | 14 +++++++++++++- tools/perf/builtin-config.c | 18 +++++++++++++++++- tools/perf/util/cache.h | 3 +++ tools/perf/util/config.c | 4 ++-- 4 files changed, 35 insertions(+), 4 deletions(-)
tools/perf/Documentation/perf-config.txt +13 -1
@@ -8,7 +8,7 @@ perf-config - Get and set variables in a configuration file. SYNOPSIS -------- [verse] -'perf config' -l | --list +'perf config' [<file-option>] -l | --list DESCRIPTION -----------
@@ -21,6 +21,14 @@ OPTIONS --list:: Show current config variables, name and value, for all sections. +--user:: + For writing and reading options: write to user + '$HOME/.perfconfig' file or read it. + +--system:: + For writing and reading options: write to system-wide + '$(sysconfdir)/perfconfig' or read it. + CONFIGURATION FILE ------------------
@@ -30,6 +38,10 @@ The '$HOME/.perfconfig' file is used to store a per-user configuration. The file '$(sysconfdir)/perfconfig' can be used to store a system-wide default configuration. +When reading or writing, the values are read from the system and user +configuration files by default, and options '--system' and '--user' +can be used to tell the command to read from or write to only that location. + Syntax ~~~~~~
tools/perf/builtin-config.c +17 -1
@@ -13,8 +13,10 @@#include "util/util.h" #include "util/debug.h" +static bool use_system_config, use_user_config; +static const char *const config_usage[] = { -"perf config [options]" , +"perf config [<file-option>] [options]" ,NULL };
@@ -25,6 +27,8 @@ enum actions {static struct option config_options[] = {OPT_SET_UINT ('l' ,"list" , &actions,"show current config variables" ,ACTION_LIST ), +OPT_BOOLEAN (0 ,"system" , &use_system_config,"use system config file" ), +OPT_BOOLEAN (0 ,"user" , &use_user_config,"use user config file" ),OPT_END () };
@@ -46,6 +50,18 @@ int cmd_config(int argc, const char **argv, const char *prefix __maybe_unused) argc =parse_options (argc, argv, config_options, config_usage,PARSE_OPT_STOP_AT_NON_OPTION ); +if (use_system_config && use_user_config) { +pr_err ("Error: only one config file at a time\n" ); +parse_options_usage (config_usage, config_options,"user" ,0 ); +parse_options_usage (NULL , config_options,"system" ,0 ); +return -1 ; + } + +if (use_system_config) + config_exclusive_filename =perf_etc_perfconfig (); +else if (use_user_config) + config_exclusive_filename =mkpath ("%s/.perfconfig" ,getenv ("HOME" )); +switch (actions) {case ACTION_LIST :if (argc) {
tools/perf/util/cache.h +3 -0
@@ -23,6 +23,8 @@#define PERF_TRACEFS_ENVIRONMENT "PERF_TRACEFS_DIR"#define PERF_PAGER_ENVIRONMENT "PERF_PAGER" +extern const char *config_exclusive_filename; +typedef int (*config_fn_t )(const char *,const char *,void *);extern int perf_default_config (const char *,const char *,void *);extern int perf_config (config_fn_t fn,void *);
@@ -31,6 +33,7 @@ extern u64 perf_config_u64(const char *, const char *);extern int perf_config_bool (const char *,const char *);extern int config_error_nonbool (const char *);extern const char *perf_config_dirname (const char *,const char *); +extern const char *perf_etc_perfconfig (void );char *alias_lookup (const char *alias);int split_cmdline (char *cmdline,const char ***argv);
tools/perf/util/config.c +2 -2
@@ -26,7 +26,7 @@ static const char *config_file_name;static int config_linenr;static int config_file_eof; -static const char *config_exclusive_filename; +const char *config_exclusive_filename;static int get_next_char (void ) {
@@ -434,7 +434,7 @@ static int perf_config_from_file(config_fn_t fn, const char *filename, void *datreturn ret; } -static const char *perf_etc_perfconfig (void ) +const char *perf_etc_perfconfig (void ) {static const char *system_wide;if (!system_wide)
Signature · 1 line
2.5.0
PATCH v13 16/23 perf config: Collect configs to handle config variables
In reply to Taeung SongCollecting configs into list because of two reason.
First of all, if there are same variables both user and system config file, they all will be printed when 'list' command work. But if config variables are duplicated, user config variables should only be printed because it has priority.
Lastly, list into which configs is collected will be required to keep and handle config variables and values in the near furture. For example, getting or setting functionality.
And change show_config() function.
Old show_config() worked depending on perf_config(). New show_config() work using collected configs list.
--- tools/perf/builtin-config.c | 150 ++++++++++++++++++++++++++++++++++++++++++-- tools/perf/util/cache.h | 13 ++++ 2 files changed, 158 insertions(+), 5 deletions(-)
tools/perf/builtin-config.c +145 -5
@@ -32,13 +32,148 @@ static struct option config_options[] = {OPT_END () }; -static int show_config (const char *key,const char *value, -void *cb__maybe_unused ) +static struct config_section *find_section (struct list_head *sections, +const char *section_name) { +struct config_section *section; + +list_for_each_entry (section, sections, list) +if (!strcmp (section->name, section_name)) +return section; + +return NULL ; +} + +static struct config_element *find_element (const char *name, +struct config_section *section) +{ +struct config_element *element; + +list_for_each_entry (element, §ion->element_head, list) +if (!strcmp (element->name, name)) +return element; + +return NULL ; +} + +static void find_config (struct list_head *sections, +struct config_section **section, +struct config_element **element, +const char *section_name,const char *name) +{ + *section =find_section (sections, section_name); + +if (*section !=NULL ) + *element =find_element (name, *section); +else + *element =NULL ; +} + +static struct config_section *init_section (const char *section_name) +{ +struct config_section *section; + + section =zalloc (sizeof (*section)); +if (!section) +return NULL ; + +INIT_LIST_HEAD (§ion->element_head); + section->name =strdup (section_name); +if (!section->name) { +pr_err ("%s: strdup failed\n" , __func__); +free (section); +return NULL ; + } + +return section; +} + +static int add_element (struct list_head *head, +const char *name,const char *value) +{ +struct config_element *element; + + element =zalloc (sizeof (*element)); +if (!element) +return -1 ; + + element->name =strdup (name); +if (!element->name) { +pr_err ("%s: strdup failed\n" , __func__); +free (element); +return -1 ; + }if (value) -printf ("%s=%s\n" , key, value); + element->value = (char *)value;else -printf ("%s\n" , key); + element->value =NULL ; + +list_add_tail (&element->list, head); +return 0 ; +} + +static int collect_current_config (const char *var,const char *value, +void *spec_sections) +{ +int ret =-1 ; +char *ptr, *key; +char *section_name, *name; +struct config_section *section =NULL ; +struct config_element *element =NULL ; +struct list_head *sections = (struct list_head *)spec_sections; + + key = ptr =strdup (var); +if (!key) { +pr_err ("%s: strdup failed\n" , __func__); +return -1 ; + } + + section_name =strsep (&ptr,"." ); + name = ptr; +if (name ==NULL || value ==NULL ) + goto out_err; + +find_config (sections, §ion, &element, section_name, name); + +if (!section) { + section =init_section (section_name); +if (!section) + goto out_err; +list_add_tail (§ion->list, sections); + } + + value =strdup (value); +if (!value) { +pr_err ("%s: strdup failed\n" , __func__); + goto out_err; + } + +if (!element) +add_element (§ion->element_head, name, value); +else { +free (element->value); + element->value = (char *)value; + } + + ret =0 ; +out_err: +free (key); +return ret; +} + +static int show_config (struct list_head *sections) +{ +struct config_section *section; +struct config_element *element; + +if (list_empty (sections)) +return -1 ; +list_for_each_entry (section, sections, list) { +list_for_each_entry (element, §ion->element_head, list) { +printf ("%s.%s=%s\n" , section->name, + element->name, element->value); + } + }return 0 ; }
@@ -46,6 +181,7 @@ static int show_config(const char *key, const char *value,int cmd_config (int argc,const char **argv,const char *prefix__maybe_unused ) {int ret =0 ; +struct list_head sections; argc =parse_options (argc, argv, config_options, config_usage,PARSE_OPT_STOP_AT_NON_OPTION );
@@ -57,18 +193,22 @@ int cmd_config(int argc, const char **argv, const char *prefix __maybe_unused)return -1 ; } +INIT_LIST_HEAD (§ions); +if (use_system_config) config_exclusive_filename =perf_etc_perfconfig ();else if (use_user_config) config_exclusive_filename =mkpath ("%s/.perfconfig" ,getenv ("HOME" )); +perf_config (collect_current_config, §ions); +switch (actions) {case ACTION_LIST :if (argc) {pr_err ("Error: takes no arguments\n" );parse_options_usage (config_usage, config_options,"l" ,1 ); }else { - ret =perf_config (show_config,NULL ); + ret =show_config (§ions);if (ret <0 )pr_err ("Nothing configured, " "please check your ~/.perfconfig file\n" );
tools/perf/util/cache.h +13 -0
@@ -1,6 +1,7 @@#ifndef __PERF_CACHE_H#define __PERF_CACHE_H +#include <linux/list.h> #include <stdbool.h> #include "util.h" #include "strbuf.h"
@@ -23,6 +24,18 @@#define PERF_TRACEFS_ENVIRONMENT "PERF_TRACEFS_DIR"#define PERF_PAGER_ENVIRONMENT "PERF_PAGER" +struct config_element { +char *name; +char *value; +struct list_head list; +}; + +struct config_section { +char *name; +struct list_head element_head; +struct list_head list; +}; +extern const char *config_exclusive_filename;typedef int (*config_fn_t )(const char *,const char *,void *);
Signature · 1 line
2.5.0
PATCH v13 17/23 perf config: Add 'list-all' option to perf-config
In reply to Taeung Song'list-all' option is to display both current config variables and all possible config variables with default values. The syntax examples are like below
perf config [<file-option>] [options]
display all perf config with default values.
# perf config -a | --list-all
--- tools/perf/Documentation/perf-config.txt | 6 + tools/perf/builtin-config.c | 228 ++++++++++++++++++++++++++++++- 2 files changed, 232 insertions(+), 2 deletions(-)
tools/perf/Documentation/perf-config.txt +6 -0
@@ -9,6 +9,8 @@ SYNOPSIS -------- [verse] 'perf config' [<file-option>] -l | --list +or +'perf config' [<file-option>] -a | --list-all DESCRIPTION -----------
@@ -29,6 +31,10 @@ OPTIONS For writing and reading options: write to system-wide '$(sysconfdir)/perfconfig' or read it. +-a:: +--list-all:: + Show current and all possible config variables with default values. + CONFIGURATION FILE ------------------
tools/perf/builtin-config.c +226 -2
265 lines not on this page · raw message
Signature · 1 line
2.5.0
PATCH v13 18/23 perf config: Add a option 'skel' to perf-config
In reply to Taeung SongProduce an skeleton with the possible config variables so that one could then use $EDITOR ~/.perfconfig or $(sysconfdir)/perfconfigand go on setting the knobs.
For the syntax examples,
# perf config -k | --skel
Initialize the possible config variables on config file.
# perf config --skel > ~/.perfconfig--- tools/perf/Documentation/perf-config.txt | 6 ++++++ tools/perf/builtin-config.c | 30 +++++++++++++++++++++++++++++- 2 files changed, 35 insertions(+), 1 deletion(-)
tools/perf/Documentation/perf-config.txt +6 -0
@@ -11,6 +11,8 @@ SYNOPSIS 'perf config' [<file-option>] -l | --list or 'perf config' [<file-option>] -a | --list-all +or +'perf config' [<file-option>] -k | --skel DESCRIPTION -----------
@@ -35,6 +37,10 @@ OPTIONS --list-all:: Show current and all possible config variables with default values. +-k:: +--skel:: + Produce an skeleton with the possible config variables. + CONFIGURATION FILE ------------------
tools/perf/builtin-config.c +29 -1
@@ -22,7 +22,8 @@ static const char * const config_usage[] = {enum actions {ACTION_LIST =1 , -ACTION_LIST_ALL +ACTION_LIST_ALL , +ACTION_SKEL } actions;static struct option config_options[] = {
@@ -31,6 +32,9 @@ static struct option config_options[] = {OPT_SET_UINT ('a' ,"list-all" , &actions,"show current and all possible config" " variables with default values" ,ACTION_LIST_ALL ), +OPT_SET_UINT ('k' ,"skel" , &actions, +"produce an skeleton with the possible" +" config variables" ,ACTION_SKEL ),OPT_BOOLEAN (0 ,"system" , &use_system_config,"use system config file" ),OPT_BOOLEAN (0 ,"user" , &use_user_config,"use user config file" ),OPT_END ()
@@ -282,6 +286,24 @@ static char *get_value(struct config_item *config)return value; } +static int show_skel_config (void ) +{ +char *section; + +for (int i =0 ; default_configs[i].type !=CONFIG_END ; i++) { +struct config_item *config = &default_configs[i]; +char *value =get_value (config); +if (strcmp (section, config->section) !=0 ) { + section = (char *)config->section; +printf ("\n[%s]\n" , config->section); + } +printf ("\t%s = %s\n" , config->name, value); +free (value); + } + +return 0 ; +} +static int show_all_config (struct list_head *sections) {int i;
@@ -418,6 +440,12 @@ int cmd_config(int argc, const char **argv, const char *prefix __maybe_unused)perf_config (collect_current_config, §ions);switch (actions) { +case ACTION_SKEL : +if (argc) +parse_options_usage (config_usage, config_options,"k" ,1 ); +else + ret =show_skel_config (); +break ;case ACTION_LIST_ALL :if (argc ==0 ) { ret =show_all_config (§ions);
Signature · 1 line
2.5.0
PATCH v13 19/23 perf config: Add --verbose option for showing config description
In reply to Taeung SongTo explain what each of variable options configures, this option can be used with --skel option, i.e.
print the possible config variables with comments over each of them. # perf config -k -v | --skel --verbose
--- tools/perf/Documentation/perf-config.txt | 4 + tools/perf/builtin-config.c | 170 ++++++++++++++++++++----------- 2 files changed, 114 insertions(+), 60 deletions(-)
tools/perf/Documentation/perf-config.txt +4 -0
@@ -41,6 +41,10 @@ OPTIONS --skel:: Produce an skeleton with the possible config variables. +-v:: +--verbose:: + Be more verbose. (show config description) + CONFIGURATION FILE ------------------
tools/perf/builtin-config.c +110 -60
193 lines not on this page · raw message
Signature · 1 line
2.5.0
PATCH v13 20/23 perf config: Add 'get' functionality
In reply to Taeung SongThis patch consists of functions
which can get specific config variables.
For the syntax examples,
perf config [<file-option>] [section.name ...]
display key-value pairs of specific config variables # perf config report.queue-size report.children
In addition, the functionality can work with --verbose option to show the config description, i.e.
# perf config -v report.queue-size
--- tools/perf/Documentation/perf-config.txt | 2 + tools/perf/builtin-config.c | 83 ++++++++++++++++++++++++++++++-- tools/perf/util/cache.h | 1 + 3 files changed, 82 insertions(+), 4 deletions(-)
tools/perf/Documentation/perf-config.txt +2 -0
@@ -8,6 +8,8 @@ perf-config - Get and set variables in a configuration file. SYNOPSIS -------- [verse] +'perf config' [<file-option>] [section.name ...] +or 'perf config' [<file-option>] -l | --list or 'perf config' [<file-option>] -a | --list-all
tools/perf/builtin-config.c +79 -4
119 lines not on this page · raw message
tools/perf/util/cache.h +1 -0
@@ -39,6 +39,7 @@ struct config_section {extern const char *config_exclusive_filename;typedef int (*config_fn_t )(const char *,const char *,void *); +typedef int (*configset_fn_t )(struct list_head *,const char *,const char *);extern int perf_default_config (const char *,const char *,void *);extern int perf_config (config_fn_t fn,void *);extern int perf_config_int (const char *,const char *);
Signature · 1 line
2.5.0
PATCH v13 21/23 perf config: Add 'set' feature
In reply to Taeung SongThis patch consists of functions which can set specific config variables. For the syntax examples,
perf config [<file-option>] [options] [section.name[=value] ...]
set specific config variables
# perf config report.queue-size=100M report.children=true
--- tools/perf/Documentation/perf-config.txt | 2 +- tools/perf/builtin-config.c | 127 +++++++++++++++++++++++++------ tools/perf/util/cache.h | 5 +- tools/perf/util/config.c | 27 ++++++- 4 files changed, 134 insertions(+), 27 deletions(-)
tools/perf/Documentation/perf-config.txt +1 -1
@@ -8,7 +8,7 @@ perf-config - Get and set variables in a configuration file. SYNOPSIS -------- [verse] -'perf config' [<file-option>] [section.name ...] +'perf config' [<file-option>] [section.name[=value] ...] or 'perf config' [<file-option>] -l | --list or
tools/perf/builtin-config.c +103 -24
194 lines not on this page · raw message
tools/perf/util/cache.h +4 -1
@@ -39,9 +39,12 @@ struct config_section {extern const char *config_exclusive_filename;typedef int (*config_fn_t )(const char *,const char *,void *); -typedef int (*configset_fn_t )(struct list_head *,const char *,const char *); +typedef int (*configset_fn_t )(struct list_head *,const char *, +const char *,const char *,char *); +extern int perf_configset_write_in_full (struct list_head *sections,const char *file_name);extern int perf_default_config (const char *,const char *,void *);extern int perf_config (config_fn_t fn,void *); +extern int perf_config_from_file (config_fn_t fn,const char *filename,void *data);extern int perf_config_int (const char *,const char *);extern u64 perf_config_u64 (const char *,const char *);extern int perf_config_bool (const char *,const char *);
tools/perf/util/config.c +26 -1
@@ -416,7 +416,7 @@ int perf_default_config(const char *var, const char *value,return 0 ; } -static int perf_config_from_file (config_fn_t fn,const char *filename,void *data) +int perf_config_from_file (config_fn_t fn,const char *filename,void *data) {int ret;FILE *f =fopen (filename,"r" );
@@ -506,6 +506,31 @@ out:return ret; } +int perf_configset_write_in_full (struct list_head *sections,const char *file_name) +{ +struct config_section *section; +struct config_element *element; +const char *first_line ="# this file is auto-generated." ; +FILE *fp =fopen (file_name,"w" ); + +if (!fp) +return -1 ; + +fprintf (fp,"%s\n" , first_line); +/* overwrite configvariables */ +list_for_each_entry (section, sections, list) { +fprintf (fp,"[%s]\n" , section->name); +list_for_each_entry (element, §ion->element_head, list) { +if (element->value) +fprintf (fp,"\t%s = %s\n" , + element->name, element->value); + } + } +fclose (fp); + +return 0 ; +} +/* * Call this to report error for your variable that should not * get a boolean value (i.e. "[my] var" means "true").
Signature · 1 line
2.5.0
PATCH v13 22/23 perf config: normalize a value depending on default type of it
In reply to Taeung SongWhether or not user mis-type wrong data type to set config, normalize the value. If a config user enter isn't contained in default configs, just pass as it is.
For the examples,
# perf config report.queue-size=1M # perf config report.queue-size report.queue-size=1048576
--- tools/perf/builtin-config.c | 54 ++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 49 insertions(+), 5 deletions(-)
tools/perf/builtin-config.c +49 -5
@@ -432,6 +432,54 @@ static int show_spec_config(struct list_head *sections,return -1 ; } +static char *normalize_value (const char *section_name,const char *name,const char *value) +{ +int i, ret =0 ; +char *endptr; +char key[BUFSIZ ]; +char *normalized; + +scnprintf (key,sizeof (key),"%s.%s" , section_name, name); +for (i =0 ; default_configs[i].type !=CONFIG_END ; i++) { +struct config_item *config = &default_configs[i]; + +if (!strcmp (config->section, section_name) && + !strcmp (config->name, name)) { +if (config->type ==CONFIG_TYPE_BOOL ) + ret =asprintf (&normalized,"%s" , +perf_config_bool (key, value) ?"true" :"false" ); +else if (config->type ==CONFIG_TYPE_INT || + config->type ==CONFIG_TYPE_LONG ) + ret =asprintf (&normalized,"%d" , +perf_config_int (key, value)); +else if (config->type ==CONFIG_TYPE_U64 ) + ret =asprintf (&normalized,"%" PRId64, +perf_config_u64 (key, value)); +else if (config->type ==CONFIG_TYPE_FLOAT ) + ret =asprintf (&normalized,"%f" , +strtof (value, &endptr)); +else if (config->type ==CONFIG_TYPE_DOUBLE ) + ret =asprintf (&normalized,"%f" , +strtod (value, &endptr)); +else + ret =asprintf (&normalized,"%s" , value); + +if (ret <0 ) +return NULL ; + +return normalized; + } + } + + normalized =strdup (value); +if (!normalized) { +pr_err ("%s: strdup failed\n" , __func__); +return NULL ; + } + +return normalized; +} +static int set_config (struct list_head *sections,const char *config_file_name,const char *section_name,const char *name,char *value) {
@@ -440,11 +488,7 @@ static int set_config(struct list_head *sections, const char *config_file_name,find_config (sections, §ion, &element, section_name, name);if (value !=NULL ) { - value =strdup (value); -if (!value) { -pr_err ("%s: strdup failed\n" , __func__); -return -1 ; - } + value =normalize_value (section_name, name, value);/* if there isn't existent section, add a new section */ if (!section) {
Signature · 1 line
2.5.0
PATCH v13 23/23 perf config: Add a option 'remove' to perf-config
In reply to Taeung SongA option 'remove' is to remove specific config variables. For the syntax examples,
# perf config [<file-option>] -r | --remove [section.name ...]
--- tools/perf/Documentation/perf-config.txt | 6 ++++++ tools/perf/builtin-config.c | 37 ++++++++++++++++++++++++++++++-- 2 files changed, 41 insertions(+), 2 deletions(-)
tools/perf/Documentation/perf-config.txt +6 -0
@@ -15,6 +15,8 @@ or 'perf config' [<file-option>] -a | --list-all or 'perf config' [<file-option>] -k | --skel +or +'perf config' [<file-option>] -r | --remove [section.name ...] DESCRIPTION -----------
@@ -47,6 +49,10 @@ OPTIONS --verbose:: Be more verbose. (show config description) +-r:: +--remove:: + Remove specific config variables. + CONFIGURATION FILE ------------------
tools/perf/builtin-config.c +35 -2
@@ -23,7 +23,8 @@ static const char * const config_usage[] = {enum actions {ACTION_LIST =1 ,ACTION_LIST_ALL , -ACTION_SKEL +ACTION_SKEL , +ACTION_REMOVE } actions;static struct option config_options[] = {
@@ -35,6 +36,8 @@ static struct option config_options[] = {OPT_SET_UINT ('k' ,"skel" , &actions,"produce an skeleton with the possible" " config variables" ,ACTION_SKEL ), +OPT_SET_UINT ('r' ,"remove" , &actions, +"remove specific variables: [section.name ...]" ,ACTION_REMOVE ),OPT_INCR ('v' ,"verbose" , &verbose,"Be more verbose" " (show config description)" ), OPT_BOOLEAN(0, "system", &use_system_config, "use system config file"),
@@ -487,7 +490,13 @@ static int set_config(struct list_head *sections, const char *config_file_name,struct config_element *element =NULL ;find_config (sections, §ion, &element, section_name, name); -if (value !=NULL ) { +if (!value) { +/* value == NULL means remove the variable */ +if (section && element) { +free (element->value); + element->value =NULL ; + } + }else { value =normalize_value (section_name, name, value);/* if there isn't existent section, add a new section */
@@ -638,6 +647,7 @@ int cmd_config(int argc, const char **argv, const char *prefix __maybe_unused)set_option_flag (config_options,'l' ,"list" ,PARSE_OPT_EXCLUSIVE );set_option_flag (config_options,'a' ,"list-all" ,PARSE_OPT_EXCLUSIVE ); +set_option_flag (config_options,'r' ,"remove" ,PARSE_OPT_EXCLUSIVE ); argc =parse_options (argc, argv, config_options, config_usage,PARSE_OPT_STOP_AT_NON_OPTION );
@@ -667,6 +677,29 @@ int cmd_config(int argc, const char **argv, const char *prefix __maybe_unused) }switch (actions) { +case ACTION_REMOVE : +if (argc) { +for (i =0 ; argv[i]; i++) { +if (!use_system_config && !use_user_config) { + ret =perf_configset_with_option (set_config, + &system_sections, + system_config, + argv[i],NULL ); + ret =perf_configset_with_option (set_config, + &user_sections, + user_config, + argv[i],NULL ); + }else + ret =perf_configset_with_option (set_config, sections, + config_exclusive_filename, + argv[i],NULL ); + } + }else { +pr_err ("Error: Missing arguments\n" ); +parse_options_usage (config_usage, config_options,"r" ,1 ); +return -1 ; + } +break ;case ACTION_SKEL :if (argc)parse_options_usage (config_usage, config_options,"k" ,1 );
Signature · 1 line
2.5.0