1 // SPDX-License-Identifier: GPL-2.0
5 * Helper functions for parsing config items.
6 * Originally copied from GIT source.
8 * Copyright (C) Linus Torvalds, 2005
9 * Copyright (C) Johannes Schindelin, 2005
13 #include <sys/param.h>
15 #include "callchain.h"
16 #include <subcmd/exec-cmd.h>
17 #include "util/event.h" /* proc_map_timeout */
18 #include "util/hist.h" /* perf_hist_config */
19 #include "util/llvm-utils.h" /* perf_llvm_config */
20 #include "util/stat.h" /* perf_stat__set_big_num */
21 #include "util/evsel.h" /* evsel__hw_names, evsel__use_bpf_counters */
22 #include "util/srcline.h" /* addr2line_timeout_ms */
26 #include <sys/types.h>
30 #include <linux/string.h>
31 #include <linux/zalloc.h>
32 #include <linux/ctype.h>
36 #define DEBUG_CACHE_DIR ".debug"
39 char buildid_dir[MAXPATHLEN]; /* root dir for buildid, binary cache */
41 static FILE *config_file;
42 static const char *config_file_name;
43 static int config_linenr;
44 static int config_file_eof;
45 static struct perf_config_set *config_set;
47 const char *config_exclusive_filename;
49 static int get_next_char(void)
55 if ((f = config_file) != NULL) {
58 /* DOS like systems */
75 static char *parse_value(void)
77 static char value[1024];
78 int quote = 0, comment = 0, space = 0;
82 int c = get_next_char();
84 if (len >= sizeof(value) - 1)
94 if (isspace(c) && !quote) {
99 if (c == ';' || c == '#') {
123 /* Some characters escape as themselves */
126 /* Reject unknown escape sequences */
141 static inline int iskeychar(int c)
143 return isalnum(c) || c == '-' || c == '_';
146 static int get_value(config_fn_t fn, void *data, char *name, unsigned int len)
151 /* Get the full name */
163 while (c == ' ' || c == '\t')
170 value = parse_value();
174 return fn(name, value, data);
177 static int get_extended_base_var(char *name, int baselen, int c)
183 } while (isspace(c));
185 /* We require the format to be '[base "extension"]' */
188 name[baselen++] = '.';
191 int ch = get_next_char();
198 ch = get_next_char();
202 name[baselen++] = ch;
203 if (baselen > MAXNAME / 2)
208 if (get_next_char() != ']')
213 static int get_base_var(char *name)
218 int c = get_next_char();
224 return get_extended_base_var(name, baselen, c);
225 if (!iskeychar(c) && c != '.')
227 if (baselen > MAXNAME / 2)
229 name[baselen++] = tolower(c);
233 static int perf_parse_file(config_fn_t fn, void *data)
237 static char var[MAXNAME];
239 /* U+FEFF Byte Order Mark in UTF8 */
240 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
241 const unsigned char *bomptr = utf8_bom;
244 int line, c = get_next_char();
246 if (bomptr && *bomptr) {
247 /* We are at the file beginning; skip UTF8-encoded BOM
248 * if present. Sane editors won't put this in on their
249 * own, but e.g. Windows Notepad will do it happily. */
250 if ((unsigned char) c == *bomptr) {
254 /* Do not tolerate partial BOM. */
255 if (bomptr != utf8_bom)
257 /* No BOM at file beginning. Cool. */
267 if (comment || isspace(c))
269 if (c == '#' || c == ';') {
274 baselen = get_base_var(var);
277 var[baselen++] = '.';
283 var[baselen] = tolower(c);
286 * The get_value function might or might not reach the '\n',
287 * so saving the current line number for error reporting.
289 line = config_linenr;
290 if (get_value(fn, data, var, baselen+1) < 0) {
291 config_linenr = line;
295 pr_err("bad config file line %d in %s\n", config_linenr, config_file_name);
299 static int parse_unit_factor(const char *end, unsigned long *val)
303 else if (!strcasecmp(end, "k")) {
307 else if (!strcasecmp(end, "m")) {
311 else if (!strcasecmp(end, "g")) {
312 *val *= 1024 * 1024 * 1024;
318 static int perf_parse_llong(const char *value, long long *ret)
320 if (value && *value) {
322 long long val = strtoll(value, &end, 0);
323 unsigned long factor = 1;
325 if (!parse_unit_factor(end, &factor))
333 static int perf_parse_long(const char *value, long *ret)
335 if (value && *value) {
337 long val = strtol(value, &end, 0);
338 unsigned long factor = 1;
339 if (!parse_unit_factor(end, &factor))
347 static void bad_config(const char *name)
349 if (config_file_name)
350 pr_warning("bad config value for '%s' in %s, ignoring...\n", name, config_file_name);
352 pr_warning("bad config value for '%s', ignoring...\n", name);
355 int perf_config_u64(u64 *dest, const char *name, const char *value)
359 if (!perf_parse_llong(value, &ret)) {
368 int perf_config_int(int *dest, const char *name, const char *value)
371 if (!perf_parse_long(value, &ret)) {
379 int perf_config_u8(u8 *dest, const char *name, const char *value)
383 if (!perf_parse_long(value, &ret)) {
391 static int perf_config_bool_or_int(const char *name, const char *value, int *is_bool)
400 if (!strcasecmp(value, "true") || !strcasecmp(value, "yes") || !strcasecmp(value, "on"))
402 if (!strcasecmp(value, "false") || !strcasecmp(value, "no") || !strcasecmp(value, "off"))
405 return perf_config_int(&ret, name, value) < 0 ? -1 : ret;
408 int perf_config_bool(const char *name, const char *value)
411 return !!perf_config_bool_or_int(name, value, &discard);
414 static const char *perf_config_dirname(const char *name, const char *value)
421 static int perf_buildid_config(const char *var, const char *value)
423 /* same dir for all commands */
424 if (!strcmp(var, "buildid.dir")) {
425 const char *dir = perf_config_dirname(var, value);
428 pr_err("Invalid buildid directory!\n");
431 strncpy(buildid_dir, dir, MAXPATHLEN-1);
432 buildid_dir[MAXPATHLEN-1] = '\0';
438 static int perf_default_core_config(const char *var, const char *value)
440 if (!strcmp(var, "core.proc-map-timeout"))
441 proc_map_timeout = strtoul(value, NULL, 10);
443 if (!strcmp(var, "core.addr2line-timeout"))
444 addr2line_timeout_ms = strtoul(value, NULL, 10);
446 /* Add other config variables here. */
450 static int perf_ui_config(const char *var, const char *value)
452 /* Add other config variables here. */
453 if (!strcmp(var, "ui.show-headers"))
454 symbol_conf.show_hist_headers = perf_config_bool(var, value);
459 static int perf_stat_config(const char *var, const char *value)
461 if (!strcmp(var, "stat.big-num"))
462 perf_stat__set_big_num(perf_config_bool(var, value));
464 if (!strcmp(var, "stat.no-csv-summary"))
465 perf_stat__set_no_csv_summary(perf_config_bool(var, value));
467 if (!strcmp(var, "stat.bpf-counter-events"))
468 evsel__bpf_counter_events = strdup(value);
470 /* Add other config variables here. */
474 int perf_default_config(const char *var, const char *value,
475 void *dummy __maybe_unused)
477 if (strstarts(var, "core."))
478 return perf_default_core_config(var, value);
480 if (strstarts(var, "hist."))
481 return perf_hist_config(var, value);
483 if (strstarts(var, "ui."))
484 return perf_ui_config(var, value);
486 if (strstarts(var, "call-graph."))
487 return perf_callchain_config(var, value);
489 if (strstarts(var, "llvm."))
490 return perf_llvm_config(var, value);
492 if (strstarts(var, "buildid."))
493 return perf_buildid_config(var, value);
495 if (strstarts(var, "stat."))
496 return perf_stat_config(var, value);
498 /* Add other config variables here. */
502 static int perf_config_from_file(config_fn_t fn, const char *filename, void *data)
505 FILE *f = fopen(filename, "r");
510 config_file_name = filename;
513 ret = perf_parse_file(fn, data);
515 config_file_name = NULL;
520 const char *perf_etc_perfconfig(void)
522 static const char *system_wide;
524 system_wide = system_path(ETC_PERFCONFIG);
528 static int perf_env_bool(const char *k, int def)
530 const char *v = getenv(k);
531 return v ? perf_config_bool(k, v) : def;
534 int perf_config_system(void)
536 return !perf_env_bool("PERF_CONFIG_NOSYSTEM", 0);
539 int perf_config_global(void)
541 return !perf_env_bool("PERF_CONFIG_NOGLOBAL", 0);
544 static char *home_perfconfig(void)
546 const char *home = NULL;
551 home = getenv("HOME");
554 * Skip reading user config if:
555 * - there is no place to read it from (HOME)
556 * - we are asked not to (PERF_CONFIG_NOGLOBAL=1)
558 if (!home || !*home || !perf_config_global())
561 config = strdup(mkpath(path, sizeof(path), "%s/.perfconfig", home));
562 if (config == NULL) {
563 pr_warning("Not enough memory to process %s/.perfconfig, ignoring it.\n", home);
567 if (stat(config, &st) < 0)
570 if (st.st_uid && (st.st_uid != geteuid())) {
571 pr_warning("File %s not owned by current user or root, ignoring it.\n", config);
583 const char *perf_home_perfconfig(void)
585 static const char *config;
588 if (failed || config)
591 config = home_perfconfig();
598 static struct perf_config_section *find_section(struct list_head *sections,
599 const char *section_name)
601 struct perf_config_section *section;
603 list_for_each_entry(section, sections, node)
604 if (!strcmp(section->name, section_name))
610 static struct perf_config_item *find_config_item(const char *name,
611 struct perf_config_section *section)
613 struct perf_config_item *item;
615 list_for_each_entry(item, §ion->items, node)
616 if (!strcmp(item->name, name))
622 static struct perf_config_section *add_section(struct list_head *sections,
623 const char *section_name)
625 struct perf_config_section *section = zalloc(sizeof(*section));
630 INIT_LIST_HEAD(§ion->items);
631 section->name = strdup(section_name);
632 if (!section->name) {
633 pr_debug("%s: strdup failed\n", __func__);
638 list_add_tail(§ion->node, sections);
642 static struct perf_config_item *add_config_item(struct perf_config_section *section,
645 struct perf_config_item *item = zalloc(sizeof(*item));
650 item->name = strdup(name);
652 pr_debug("%s: strdup failed\n", __func__);
657 list_add_tail(&item->node, §ion->items);
661 static int set_value(struct perf_config_item *item, const char *value)
663 char *val = strdup(value);
673 static int collect_config(const char *var, const char *value,
674 void *perf_config_set)
678 char *section_name, *name;
679 struct perf_config_section *section = NULL;
680 struct perf_config_item *item = NULL;
681 struct perf_config_set *set = perf_config_set;
682 struct list_head *sections;
687 sections = &set->sections;
688 key = ptr = strdup(var);
690 pr_debug("%s: strdup failed\n", __func__);
694 section_name = strsep(&ptr, ".");
696 if (name == NULL || value == NULL)
699 section = find_section(sections, section_name);
701 section = add_section(sections, section_name);
706 item = find_config_item(name, section);
708 item = add_config_item(section, name);
713 /* perf_config_set can contain both user and system config items.
714 * So we should know where each value is from.
715 * The classification would be needed when a particular config file
716 * is overwritten by setting feature i.e. set_config().
718 if (strcmp(config_file_name, perf_etc_perfconfig()) == 0) {
719 section->from_system_config = true;
720 item->from_system_config = true;
722 section->from_system_config = false;
723 item->from_system_config = false;
726 ret = set_value(item, value);
733 int perf_config_set__collect(struct perf_config_set *set, const char *file_name,
734 const char *var, const char *value)
736 config_file_name = file_name;
737 return collect_config(var, value, set);
740 static int perf_config_set__init(struct perf_config_set *set)
744 /* Setting $PERF_CONFIG makes perf read _only_ the given config file. */
745 if (config_exclusive_filename)
746 return perf_config_from_file(collect_config, config_exclusive_filename, set);
747 if (perf_config_system() && !access(perf_etc_perfconfig(), R_OK)) {
748 if (perf_config_from_file(collect_config, perf_etc_perfconfig(), set) < 0)
751 if (perf_config_global() && perf_home_perfconfig()) {
752 if (perf_config_from_file(collect_config, perf_home_perfconfig(), set) < 0)
760 struct perf_config_set *perf_config_set__new(void)
762 struct perf_config_set *set = zalloc(sizeof(*set));
765 INIT_LIST_HEAD(&set->sections);
766 perf_config_set__init(set);
772 struct perf_config_set *perf_config_set__load_file(const char *file)
774 struct perf_config_set *set = zalloc(sizeof(*set));
777 INIT_LIST_HEAD(&set->sections);
778 perf_config_from_file(collect_config, file, set);
784 static int perf_config__init(void)
786 if (config_set == NULL)
787 config_set = perf_config_set__new();
789 return config_set == NULL;
792 int perf_config_set(struct perf_config_set *set,
793 config_fn_t fn, void *data)
797 struct perf_config_section *section;
798 struct perf_config_item *item;
800 perf_config_set__for_each_entry(set, section, item) {
801 char *value = item->value;
804 scnprintf(key, sizeof(key), "%s.%s",
805 section->name, item->name);
806 ret = fn(key, value, data);
808 pr_err("Error in the given config file: wrong config key-value pair %s=%s\n",
811 * Can't be just a 'break', as perf_config_set__for_each_entry()
812 * expands to two nested for() loops.
822 int perf_config(config_fn_t fn, void *data)
824 if (config_set == NULL && perf_config__init())
827 return perf_config_set(config_set, fn, data);
830 void perf_config__exit(void)
832 perf_config_set__delete(config_set);
836 void perf_config__refresh(void)
842 static void perf_config_item__delete(struct perf_config_item *item)
849 static void perf_config_section__purge(struct perf_config_section *section)
851 struct perf_config_item *item, *tmp;
853 list_for_each_entry_safe(item, tmp, §ion->items, node) {
854 list_del_init(&item->node);
855 perf_config_item__delete(item);
859 static void perf_config_section__delete(struct perf_config_section *section)
861 perf_config_section__purge(section);
862 zfree(§ion->name);
866 static void perf_config_set__purge(struct perf_config_set *set)
868 struct perf_config_section *section, *tmp;
870 list_for_each_entry_safe(section, tmp, &set->sections, node) {
871 list_del_init(§ion->node);
872 perf_config_section__delete(section);
876 void perf_config_set__delete(struct perf_config_set *set)
881 perf_config_set__purge(set);
886 * Call this to report error for your variable that should not
887 * get a boolean value (i.e. "[my] var" means "true").
889 int config_error_nonbool(const char *var)
891 pr_err("Missing value for '%s'", var);
895 void set_buildid_dir(const char *dir)
898 scnprintf(buildid_dir, MAXPATHLEN, "%s", dir);
900 /* default to $HOME/.debug */
901 if (buildid_dir[0] == '\0') {
902 char *home = getenv("HOME");
905 snprintf(buildid_dir, MAXPATHLEN, "%s/%s",
906 home, DEBUG_CACHE_DIR);
908 strncpy(buildid_dir, DEBUG_CACHE_DIR, MAXPATHLEN-1);
910 buildid_dir[MAXPATHLEN-1] = '\0';
912 /* for communicating with external commands */
913 setenv("PERF_BUILDID_DIR", buildid_dir, 1);
916 struct perf_config_scan_data {
923 static int perf_config_scan_cb(const char *var, const char *value, void *data)
925 struct perf_config_scan_data *d = data;
927 if (!strcmp(var, d->name))
928 d->ret = vsscanf(value, d->fmt, d->args);
933 int perf_config_scan(const char *name, const char *fmt, ...)
935 struct perf_config_scan_data d = {
940 va_start(d.args, fmt);
941 perf_config(perf_config_scan_cb, &d);