perf tools: Add 'perf-config' command
v5 cover perf tools: Add 'perf-config' command
So far, it is difficult that the state of perf configs is looked through
and there's no knowing what kind of other variables except variables in perfconfig.example. Also perf configs can't be changed without manually modifying $HOME/.perfconfig or $(sysconfdir)/perfconfig file. So I suggest this patchset of the perf-config command which can list, get, set, remove perf configs or list with default config values as below.
[PATCH v5 1/6] perf tools: Add 'perf-config' command [PATCH v5 2/6] perf config: Add '--system' and '--user' options to
select which config file to be used
[PATCH v5 3/6] perf config: Add a option 'list-all' to perf-config [PATCH v5 4/6] perf config: Add 'get' functionality [PATCH v5 5/6] perf config: Add 'set' feature
[PATCH v5 6/6] perf config: Add a option 'remove' to perf-config
Changes in v5:
- Simplify the switch statement in cmd_config()
- Set a config file path with '--system' or '--user'
instead of '--global' or '--system' as suggested by Namhyung. (PATCH v5 2/6)
- The patch about 'get' and 'set 'split into two patchs
as suggested by Namhyung. (PATCH v5 4/6, PATCH v5 5/6)
Changes in v4:
- If some config value is default value, notice it is '(default)' as suggested by Jirka. (PATCH v4 3/5)
- If there wasn't any perfconfig file, perf-config malfunctioned like Jirka pointed out. So add exception routine with '--global' and '--system' option which can select perf config file path. (PATCH v4 2/5)
Changes in v3:
- Add a config variable 'kmem.default' with a default value as suggested by Namhyung. (PATCH v3 2/5, PATCH v4 3/5)
Changes in v2:
- Change option name of listing all configs as '--list-all' instead of '--all' as suggested by Namhyung. (PATCH v2 3/4, PATCH v4 4/5)
- Correct small infelicities or typing errors in a perf-config documention as suggested by Arnaldo. (PATCH v2 1/4, PATCH v4 1/5)
- Declaration a global variable 'static struct default_configsets' has config variables with default values instead of using a 'util/PERFCONFIG-DEFAULT' file. (PATCH v2 3/4, PATCH v4 3/5)
- Add a function to normalize a value and check data type of it. (PATCH v2 2/4, PATCH v4 3/5)
- 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. (PATCH v2 2/4, PATCH v4 3/5)
- If run perf-config command without any option, perf-config work as '--list'. (PATCH v2 1/4, PATCH v4 1/5)
--- tools/perf/Build | 1 + tools/perf/Documentation/perf-config.txt | 407 ++++++++++++++++ tools/perf/Documentation/perfconfig.example | 73 ++- tools/perf/builtin-config.c | 708 ++++++++++++++++++++++++++++ tools/perf/builtin.h | 1 + tools/perf/command-list.txt | 1 + tools/perf/perf.c | 1 + tools/perf/util/cache.h | 19 + tools/perf/util/config.c | 31 +- 9 files changed, 1228 insertions(+), 14 deletions(-) create mode 100644 tools/perf/Documentation/perf-config.txt create mode 100644 tools/perf/builtin-config.c
Signature · 1 line
1.9.1
PATCH v5 1/6 perf tools: Add 'perf-config' command
The perf configuration file contains many variables which can make
the perf command's action more effective.
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 'perf-config' command with '--list' option and a document for it.
perf config [options]
display current perf config variables.
# perf config
or
# perf config -l | --list
--- tools/perf/Build | 1 + tools/perf/Documentation/perf-config.txt | 381 ++++++++++++++++++++++++++++ tools/perf/Documentation/perfconfig.example | 73 +++++- tools/perf/builtin-config.c | 61 +++++ tools/perf/builtin.h | 1 + tools/perf/command-list.txt | 1 + tools/perf/perf.c | 1 + 7 files changed, 507 insertions(+), 12 deletions(-) create mode 100644 tools/perf/Documentation/perf-config.txt create mode 100644 tools/perf/builtin-config.c
tools/perf/Build +1 -0
@@ -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
tools/perf/Documentation/perf-config.txt new file +381 -0
381 lines not on this page · raw message
tools/perf/Documentation/perfconfig.example +61 -12
90 lines not on this page · raw message
tools/perf/builtin-config.c new file +61 -0
61 lines not on this page · raw message
tools/perf/builtin.h +1 -0
@@ -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);
tools/perf/command-list.txt +1 -0
@@ -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
tools/perf/perf.c +1 -0
@@ -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 },
Signature · 1 line
1.9.1
PATCH v5 2/6 perf config: Add '--system' and '--user' options to select which config file is used
In reply to Taeung SongWhich config file is used is decided in only perf_config(). And a perf-confg command depend on perf_config() getting config file path. So add '--system' and '--user' options to select which config file to be used without perf_config(). If file-options isn't used, default config file path is $HOME/.perfconfig.
--- tools/perf/Documentation/perf-config.txt | 14 +++++++++++++- tools/perf/builtin-config.c | 23 +++++++++++++++++++++-- tools/perf/util/cache.h | 2 ++ tools/perf/util/config.c | 4 ++-- 4 files changed, 38 insertions(+), 5 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 with key and value into each 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 ------------------
@@ -33,6 +41,10 @@ store a system-wide default configuration. The variables are divided into sections. In each section, the variables can are composed of a key and value. +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 +21 -2
@@ -13,6 +13,9 @@#include "util/util.h" #include "util/debug.h" +static bool use_system_config, use_user_config; +static const char *config_file_name; +static const char *const config_usage[] = {"perf config [options]" ,NULL
@@ -23,6 +26,9 @@ enum actions { } actions;static const struct option config_options[] = { +OPT_GROUP ("Config file location" ), +OPT_BOOLEAN (0 ,"system" , &use_system_config,"use system config file" ), +OPT_BOOLEAN (0 ,"user" , &use_user_config,"use user config file" ),OPT_GROUP ("Action" ),OPT_SET_UINT ('l' ,"list" , &actions,"show current config variables" ,ACTION_LIST ),
@@ -47,15 +53,28 @@ 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" ); + goto out_err; + } + config_file_name =mkpath ("%s/.perfconfig" ,getenv ("HOME" )); +if (use_system_config || (!use_user_config && +access (config_file_name,R_OK ) ==-1 )) + config_file_name =perf_etc_perfconfig (); +switch (actions) {case ACTION_LIST :default :if (argc) {pr_err ("Error: unknown argument\n" ); -usage_with_options (config_usage, config_options); + goto out_err; }else - ret =perf_config (show_config,NULL ); + ret =perf_config_from_file (show_config, config_file_name,NULL ); }return ret; + +out_err: +usage_with_options (config_usage, config_options); +return -1 ; }
tools/perf/util/cache.h +2 -0
@@ -22,11 +22,13 @@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 *); +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 *);extern int config_error_nonbool (const char *);extern const char *perf_config_dirname (const char *,const char *); +extern const char *perf_etc_perfconfig (void );/* pager.c */ extern void setup_pager (void );
tools/perf/util/config.c +2 -2
@@ -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" );
@@ -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
1.9.1
PATCH v5 3/6 perf config: Add a option 'list-all' to perf-config
In reply to Taeung SongA option 'list-all' is to display both current config variables and all possible config variables with default values.
The syntax examples are like below
perf config [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 | 490 ++++++++++++++++++++++++++++++- tools/perf/util/cache.h | 15 + 3 files changed, 510 insertions(+), 1 deletion(-)
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 +489 -1
518 lines not on this page · raw message
tools/perf/util/cache.h +15 -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"
@@ -19,6 +20,20 @@#define PERF_DEBUGFS_ENVIRONMENT "PERF_DEBUGFS_DIR"#define PERF_TRACEFS_ENVIRONMENT "PERF_TRACEFS_DIR" +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; +}; + +struct list_head sections; +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 *);
Signature · 1 line
1.9.1
PATCH v5 4/6 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 [options] [section.name ...]
display key-value pairs of specific config variables
# perf config report.queue-size report.children
--- tools/perf/Documentation/perf-config.txt | 2 + tools/perf/builtin-config.c | 79 ++++++++++++++++++++++++++++++-- tools/perf/util/cache.h | 1 + 3 files changed, 79 insertions(+), 3 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 +76 -3
108 lines not on this page · raw message
tools/perf/util/cache.h +1 -0
@@ -34,6 +34,7 @@ struct config_section {struct list_head sections; +typedef int (*configset_fn_t )(const char *,const char *);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 *);
Signature · 1 line
1.9.1
PATCH v5 5/6 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 [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 | 55 +++++++++++++++++++++++++++++--- tools/perf/util/cache.h | 3 +- tools/perf/util/config.c | 27 ++++++++++++++++ 4 files changed, 80 insertions(+), 7 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 +50 -5
92 lines not on this page · raw message
tools/perf/util/cache.h +2 -1
@@ -34,7 +34,8 @@ struct config_section {struct list_head sections; -typedef int (*configset_fn_t )(const char *,const char *); +extern int perf_configset_write_in_full (const char *file_name); +typedef int (*configset_fn_t )(const char *,const char *,char *);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 *);
tools/perf/util/config.c +27 -0
@@ -506,6 +506,33 @@ out:return ret; } +int perf_configset_write_in_full (const char *file_name) +{ +struct config_section *section_node; +struct config_element *element_node; +const char *first_line ="# this file is auto-generated." ; +FILE *fp =fopen (file_name,"w" ); + +if (!fp) { +pr_err ("Error: %s: Can't open this file\n" , file_name); +return -1 ; + } + +fprintf (fp,"%s\n" , first_line); +/* overwrite configvariables */ +list_for_each_entry (section_node, §ions, list) { +fprintf (fp,"[%s]\n" , section_node->name); +list_for_each_entry (element_node, §ion_node->element_head, list) { +if (element_node->value) +fprintf (fp,"\t%s = %s\n" , + element_node->name, element_node->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
1.9.1
PATCH v5 6/6 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 -r | --remove [section.name ...]
--- tools/perf/Documentation/perf-config.txt | 6 ++++++ tools/perf/builtin-config.c | 26 ++++++++++++++++++++++++-- 2 files changed, 30 insertions(+), 2 deletions(-)
tools/perf/Documentation/perf-config.txt +6 -0
@@ -13,6 +13,8 @@ or 'perf config' [<file-option>] -l | --list or 'perf config' [<file-option>] -a | --list-all +or +'perf config' [<file-option>] -r | --remove [section.name ...] DESCRIPTION -----------
@@ -37,6 +39,10 @@ OPTIONS --list-all:: Show current and all possible config variables with default values. +-r:: +--remove:: + Remove specific config variables. + CONFIGURATION FILE ------------------
tools/perf/builtin-config.c +24 -2
@@ -23,7 +23,8 @@ static const char * const config_usage[] = {enum actions {ACTION_LIST =1 , -ACTION_LIST_ALL +ACTION_LIST_ALL , +ACTION_REMOVE } actions;static const struct option config_options[] = {
@@ -36,6 +37,8 @@ static const 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 ('r' ,"remove" , &actions, +"remove specific variables: [section.name ...]" ,ACTION_REMOVE ), OPT_END() };
@@ -495,7 +498,14 @@ static int set_config(const char *section_name, const char *name, char *value)struct config_element *element_node =NULL ;find_config (§ion_node, &element_node, section_name, name); -if (value !=NULL ) { +if (!value) { +/* value == NULL means remove the variable */ +if (section_node && element_node) { +if (!element_node->value) +free (element_node->value); + element_node->value =NULL ; + } + }else { value =normalize_value (section_name, name, value);/* if there isn't existent section, add a new section */
@@ -651,6 +661,18 @@ int cmd_config(int argc, const char **argv, const char *prefix __maybe_unused)perf_config_from_file (collect_current_config, config_file_name,NULL );switch (actions) { +case ACTION_REMOVE : +if (argc) { +for (i =0 ; argv[i]; i++) { + ret =perf_configset_with_option (set_config, argv[i],NULL ); +if (ret <0 ) + goto out_err; + } + }else { +pr_err ("Error: wrong number of arguments\n" ); + goto out_err; + } +break ;case ACTION_LIST_ALL :if (argc ==0 ) { ret =show_all_config ();
Signature · 1 line
1.9.1