Re: [PATCH v9 5/9] perf config: Add a option 'list-all' to perf-config

From: Namhyung Kim
Date: Tue Nov 03 2015 - 07:30:21 EST


On Tue, Nov 03, 2015 at 10:50:16AM +0900, Taeung Song wrote:
> A 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 [<file-option>] [options]
>
> display all perf config with default values.
> # perf config -a | --list-all
>
> Signed-off-by: Taeung Song <treeze.taeung@xxxxxxxxx>
> ---
> tools/perf/Documentation/perf-config.txt | 6 +
> tools/perf/builtin-config.c | 219 ++++++++++++++++++++++++++++++-
> 2 files changed, 223 insertions(+), 2 deletions(-)
>
> diff --git a/tools/perf/Documentation/perf-config.txt b/tools/perf/Documentation/perf-config.txt
> index 2188722..6141b1f 100644
> --- a/tools/perf/Documentation/perf-config.txt
> +++ b/tools/perf/Documentation/perf-config.txt
> @@ -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
> ------------------
>
> diff --git a/tools/perf/builtin-config.c b/tools/perf/builtin-config.c
> index d4e2899..bba93bd 100644
> --- a/tools/perf/builtin-config.c
> +++ b/tools/perf/builtin-config.c
> @@ -21,17 +21,154 @@ static const char * const config_usage[] = {
> };
>
> enum actions {
> - ACTION_LIST = 1
> + ACTION_LIST = 1,
> + ACTION_LIST_ALL
> } actions;
>
> static struct option config_options[] = {
> OPT_SET_UINT('l', "list", &actions,
> "show current config variables", ACTION_LIST),
> + OPT_SET_UINT('a', "list-all", &actions,
> + "show current and all possible config variables with default values",
> + ACTION_LIST_ALL),
> OPT_BOOLEAN(0, "system", &use_system_config, "use system config file"),
> OPT_BOOLEAN(0, "user", &use_user_config, "use user config file"),
> OPT_END()
> };
>
> +enum config_idx {
> + CONFIG_COLORS_TOP,
> + CONFIG_COLORS_MEDIUM,
> + CONFIG_COLORS_NORMAL,
> + CONFIG_COLORS_SELECTED,
> + CONFIG_COLORS_CODE,
> + CONFIG_COLORS_ADDR,
> + CONFIG_COLORS_ROOT,
> + CONFIG_TUI_REPORT,
> + CONFIG_TUI_ANNOTATE,
> + CONFIG_TUI_TOP,
> + CONFIG_BUILDID_DIR,
> + CONFIG_ANNOTATE_HIDE_SRC_CODE,
> + CONFIG_ANNOTATE_USE_OFFSET,
> + CONFIG_ANNOTATE_JUMP_ARROWS,
> + CONFIG_ANNOTATE_SHOW_NR_JUMPS,
> + CONFIG_GTK_ANNOTATE,
> + CONFIG_GTK_REPORT,
> + CONFIG_GTK_TOP,
> + CONFIG_PAGER_CMD,
> + CONFIG_PAGER_REPORT,
> + CONFIG_PAGER_ANNOTATE,
> + CONFIG_PAGER_TOP,
> + CONFIG_PAGER_DIFF,
> + CONFIG_HELP_FORMAT,
> + CONFIG_HELP_AUTOCORRECT,
> + CONFIG_HIST_PERCENTAGE,
> + CONFIG_UI_SHOW_HEADERS,
> + CONFIG_CALL_GRAPH_RECORD_MODE,
> + CONFIG_CALL_GRAPH_DUMP_SIZE,
> + CONFIG_CALL_GRAPH_PRINT_TYPE,
> + CONFIG_CALL_GRAPH_ORDER,
> + CONFIG_CALL_GRAPH_SORT_KEY,
> + CONFIG_CALL_GRAPH_THRESHOLD,
> + CONFIG_CALL_GRAPH_PRINT_LIMIT,
> + CONFIG_REPORT_CHILDREN,
> + CONFIG_REPORT_PERCENT_LIMIT,
> + CONFIG_REPORT_QUEUE_SIZE,
> + CONFIG_TOP_CHILDREN,
> + CONFIG_MAN_VIEWER,
> + CONFIG_KMEM_DEFAULT,
> +};
> +
> +enum config_type {
> + CONFIG_TYPE_BOOL,
> + CONFIG_TYPE_INT,
> + CONFIG_TYPE_LONG,
> + CONFIG_TYPE_U64,
> + CONFIG_TYPE_FLOAT,
> + CONFIG_TYPE_DOUBLE,
> + CONFIG_TYPE_STRING,
> + /* special type */
> + CONFIG_END
> +};
> +
> +struct config_item {
> + const char *section;
> + const char *name;
> + union {
> + bool b;
> + int i;
> + u32 l;
> + u64 ll;
> + float f;
> + double d;
> + const char *s;
> + } value;
> + enum config_type type;
> +};
> +
> +#define CONF_VAR(_sec, _name, _field, _val, _type) \
> + { .section = _sec, .name = _name, .value._field = _val, .type = _type }
> +
> +#define CONF_BOOL_VAR(_idx, _sec, _name, _val) \
> + [CONFIG_##_idx] = CONF_VAR(_sec, _name, b, _val, CONFIG_TYPE_BOOL)
> +#define CONF_INT_VAR(_idx, _sec, _name, _val) \
> + [CONFIG_##_idx] = CONF_VAR(_sec, _name, i, _val, CONFIG_TYPE_INT)
> +#define CONF_LONG_VAR(_idx, _sec, _name, _val) \
> + [CONFIG_##_idx] = CONF_VAR(_sec, _name, l, _val, CONFIG_TYPE_LONG)
> +#define CONF_U64_VAR(_idx, _sec, _name, _val) \
> + [CONFIG_##_idx] = CONF_VAR(_sec, _name, ll, _val, CONFIG_TYPE_U64)
> +#define CONF_FLOAT_VAR(_idx, _sec, _name, _val) \
> + [CONFIG_##_idx] = CONF_VAR(_sec, _name, f, _val, CONFIG_TYPE_FLOAT)
> +#define CONF_DOUBLE_VAR(_idx, _sec, _name, _val) \
> + [CONFIG_##_idx] = CONF_VAR(_sec, _name, d, _val, CONFIG_TYPE_DOUBLE)
> +#define CONF_STR_VAR(_idx, _sec, _name, _val) \
> + [CONFIG_##_idx] = CONF_VAR(_sec, _name, s, _val, CONFIG_TYPE_STRING)
> +#define CONF_END() { .type = CONFIG_END }
> +
> +struct config_item default_configs[] = {
> + CONF_STR_VAR(COLORS_TOP, "colors", "top", "red, default"),
> + CONF_STR_VAR(COLORS_MEDIUM, "colors", "medium", "green, default"),
> + CONF_STR_VAR(COLORS_NORMAL, "colors", "normal", "lightgray, default"),
> + CONF_STR_VAR(COLORS_SELECTED, "colors", "selected", "white, lightgray"),
> + CONF_STR_VAR(COLORS_CODE, "colors", "code", "blue, default"),
> + CONF_STR_VAR(COLORS_ADDR, "colors", "addr", "magenta, default"),
> + CONF_STR_VAR(COLORS_ROOT, "colors", "root", "white, blue"),
> + CONF_BOOL_VAR(TUI_REPORT, "tui", "report", true),
> + CONF_BOOL_VAR(TUI_ANNOTATE, "tui", "annotate", true),
> + CONF_BOOL_VAR(TUI_TOP, "tui", "top", true),
> + CONF_STR_VAR(BUILDID_DIR, "buildid", "dir", "~/.debug"),
> + CONF_BOOL_VAR(ANNOTATE_HIDE_SRC_CODE, "annotate", "hide_src_code", false),
> + CONF_BOOL_VAR(ANNOTATE_USE_OFFSET, "annotate", "use_offset", true),
> + CONF_BOOL_VAR(ANNOTATE_JUMP_ARROWS, "annotate", "jump_arrows", true),
> + CONF_BOOL_VAR(ANNOTATE_SHOW_NR_JUMPS, "annotate", "show_nr_jumps", false),
> + CONF_BOOL_VAR(GTK_ANNOTATE, "gtk", "annotate", false),
> + CONF_BOOL_VAR(GTK_REPORT, "gtk", "report", false),
> + CONF_BOOL_VAR(GTK_TOP, "gtk", "top", false),
> + CONF_BOOL_VAR(PAGER_CMD, "pager", "cmd", true),
> + CONF_BOOL_VAR(PAGER_REPORT, "pager", "report", true),
> + CONF_BOOL_VAR(PAGER_ANNOTATE, "pager", "annotate", true),
> + CONF_BOOL_VAR(PAGER_TOP, "pager", "top", true),
> + CONF_BOOL_VAR(PAGER_DIFF, "pager", "diff", true),
> + CONF_STR_VAR(HELP_FORMAT, "help", "format", "man"),
> + CONF_INT_VAR(HELP_AUTOCORRECT, "help", "autocorrect", 0),
> + CONF_STR_VAR(HIST_PERCENTAGE, "hist", "percentage", "absolute"),
> + CONF_BOOL_VAR(UI_SHOW_HEADERS, "ui", "show-headers", true),
> + CONF_STR_VAR(CALL_GRAPH_RECORD_MODE, "call-graph", "record-mode", "fp"),
> + CONF_LONG_VAR(CALL_GRAPH_DUMP_SIZE, "call-graph", "dump-size", 8192),
> + CONF_STR_VAR(CALL_GRAPH_PRINT_TYPE, "call-graph", "print-type", "fractal"),

It's changed to "graph" recently.

> + CONF_STR_VAR(CALL_GRAPH_ORDER, "call-graph", "order", "caller"),

Default is "callee" (with some exception regarding --children).

> + CONF_STR_VAR(CALL_GRAPH_SORT_KEY, "call-graph", "sort-key", "function"),
> + CONF_DOUBLE_VAR(CALL_GRAPH_THRESHOLD, "call-graph", "threshold", 0.5),
> + CONF_LONG_VAR(CALL_GRAPH_PRINT_LIMIT, "call-graph", "print-limit", 0),
> + CONF_BOOL_VAR(REPORT_CHILDREN, "report", "children", false),

I believe the default is "true".

> + CONF_FLOAT_VAR(REPORT_PERCENT_LIMIT, "report", "percent-limit", 0),
> + CONF_U64_VAR(REPORT_QUEUE_SIZE, "report", "queue-size", 0),
> + CONF_BOOL_VAR(TOP_CHILDREN, "top", "children", false),

Ditto - default is "true".


> + CONF_STR_VAR(MAN_VIEWER, "man", "viewer", "man"),
> + CONF_STR_VAR(KMEM_DEFAULT, "kmem", "default", "slab"),
> + CONF_END()
> +};
> +
> static int compare_name(const char *name1, const char *name2)
> {
> while (true) {
> @@ -133,6 +270,73 @@ static int add_element(struct list_head *head,
> return 0;
> }
>
> +static char *get_value(struct config_item *config)
> +{
> + int ret = 0;
> + char *value;
> +
> + if (config->type == CONFIG_TYPE_BOOL)
> + ret = asprintf(&value, "%s",
> + config->value.b ? "true" : "false");
> + else if (config->type == CONFIG_TYPE_INT)
> + ret = asprintf(&value, "%d", config->value.i);
> + else if (config->type == CONFIG_TYPE_LONG)
> + ret = asprintf(&value, "%u", config->value.l);
> + else if (config->type == CONFIG_TYPE_U64)
> + ret = asprintf(&value, "%"PRId64, config->value.ll);
> + else if (config->type == CONFIG_TYPE_FLOAT)
> + ret = asprintf(&value, "%f", config->value.f);
> + else if (config->type == CONFIG_TYPE_DOUBLE)
> + ret = asprintf(&value, "%f", config->value.d);
> + else
> + value = (char *)config->value.s;
> +
> + if (ret < 0)
> + return NULL;
> +
> + return value;
> +}
> +
> +static int show_all_config(struct list_head *sections)
> +{
> + int i;
> + bool has_config;
> + struct config_section *section;
> + struct config_element *element;
> +
> + for (i = 0; default_configs[i].type != CONFIG_END; i++) {
> + struct config_item *config = &default_configs[i];
> + find_config(sections, &section, &element,
> + config->section, config->name);
> +
> + if (!element)
> + printf("%s.%s=%s\n", config->section, config->name,
> + get_value(config));

You need to free the value string.


> + else
> + printf("%s.%s=%s\n", section->name,
> + element->name, element->value);
> + }
> +
> + /* Print config variables the default configsets haven't */
> + list_for_each_entry(section, sections, list) {
> + list_for_each_entry(element, &section->element_head, list) {
> + has_config = false;
> + for (i = 0; default_configs[i].type != CONFIG_END; i++) {
> + if (!strcmp(default_configs[i].section, section->name)
> + && !compare_name(default_configs[i].name, element->name)) {
> + has_config = true;
> + break;
> + }
> + }
> + if (!has_config)
> + printf("%s.%s=%s\n", section->name,
> + element->name, element->value);
> + }
> + }
> +
> + return 0;
> +}
> +
> static int collect_current_config(const char *var, const char *value,
> void *spec_sections __maybe_unused)
> {
> @@ -202,6 +406,9 @@ int cmd_config(int argc, const char **argv, const char *prefix __maybe_unused)
> int ret = 0;
> struct list_head sections;
>
> + set_option_flag(config_options, 'l', "list", PARSE_OPT_EXCLUSIVE);
> + set_option_flag(config_options, 'a', "list-all", PARSE_OPT_EXCLUSIVE);
> +
> argc = parse_options(argc, argv, config_options, config_usage,
> PARSE_OPT_STOP_AT_NON_OPTION);
>
> @@ -222,11 +429,19 @@ int cmd_config(int argc, const char **argv, const char *prefix __maybe_unused)
> perf_config(collect_current_config, &sections);
>
> switch (actions) {
> + case ACTION_LIST_ALL:
> + if (argc == 0) {
> + ret = show_all_config(&sections);
> + break;
> + }

In this case, you should add something like following, otherwise
people can be confused..

/* fall through */


Thanks,
Namhyung


> case ACTION_LIST:
> default:
> if (argc) {
> pr_err("Error: takes no arguments\n");
> - parse_options_usage(config_usage, config_options, "l", 1);
> + if (actions == ACTION_LIST_ALL)
> + parse_options_usage(config_usage, config_options, "a", 1);
> + else
> + parse_options_usage(config_usage, config_options, "l", 1);
> return -1;
> } else
> ret = show_config(&sections);
> --
> 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/