4 * Helper functions for parsing config items.
5 * Originally copied from GIT source.
7 * Copyright (C) Linus Torvalds, 2005
8 * Copyright (C) Johannes Schindelin, 2005
13 #include <subcmd/exec-cmd.h>
14 #include "util/hist.h" /* perf_hist_config */
15 #include "util/llvm-utils.h" /* perf_llvm_config */
20 #define DEBUG_CACHE_DIR ".debug"
23 char buildid_dir[MAXPATHLEN]; /* root dir for buildid, binary cache */
25 static FILE *config_file;
26 static const char *config_file_name;
27 static int config_linenr;
28 static int config_file_eof;
29 static struct perf_config_set *config_set;
31 const char *config_exclusive_filename;
33 static int get_next_char(void)
39 if ((f = config_file) != NULL) {
42 /* DOS like systems */
59 static char *parse_value(void)
61 static char value[1024];
62 int quote = 0, comment = 0, space = 0;
66 int c = get_next_char();
68 if (len >= sizeof(value) - 1)
78 if (isspace(c) && !quote) {
83 if (c == ';' || c == '#') {
107 /* Some characters escape as themselves */
110 /* Reject unknown escape sequences */
125 static inline int iskeychar(int c)
127 return isalnum(c) || c == '-' || c == '_';
130 static int get_value(config_fn_t fn, void *data, char *name, unsigned int len)
135 /* Get the full name */
147 while (c == ' ' || c == '\t')
154 value = parse_value();
158 return fn(name, value, data);
161 static int get_extended_base_var(char *name, int baselen, int c)
167 } while (isspace(c));
169 /* We require the format to be '[base "extension"]' */
172 name[baselen++] = '.';
175 int ch = get_next_char();
182 ch = get_next_char();
186 name[baselen++] = ch;
187 if (baselen > MAXNAME / 2)
192 if (get_next_char() != ']')
197 static int get_base_var(char *name)
202 int c = get_next_char();
208 return get_extended_base_var(name, baselen, c);
209 if (!iskeychar(c) && c != '.')
211 if (baselen > MAXNAME / 2)
213 name[baselen++] = tolower(c);
217 static int perf_parse_file(config_fn_t fn, void *data)
221 static char var[MAXNAME];
223 /* U+FEFF Byte Order Mark in UTF8 */
224 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
225 const unsigned char *bomptr = utf8_bom;
228 int line, c = get_next_char();
230 if (bomptr && *bomptr) {
231 /* We are at the file beginning; skip UTF8-encoded BOM
232 * if present. Sane editors won't put this in on their
233 * own, but e.g. Windows Notepad will do it happily. */
234 if ((unsigned char) c == *bomptr) {
238 /* Do not tolerate partial BOM. */
239 if (bomptr != utf8_bom)
241 /* No BOM at file beginning. Cool. */
251 if (comment || isspace(c))
253 if (c == '#' || c == ';') {
258 baselen = get_base_var(var);
261 var[baselen++] = '.';
267 var[baselen] = tolower(c);
270 * The get_value function might or might not reach the '\n',
271 * so saving the current line number for error reporting.
273 line = config_linenr;
274 if (get_value(fn, data, var, baselen+1) < 0) {
275 config_linenr = line;
279 pr_err("bad config file line %d in %s\n", config_linenr, config_file_name);
283 static int parse_unit_factor(const char *end, unsigned long *val)
287 else if (!strcasecmp(end, "k")) {
291 else if (!strcasecmp(end, "m")) {
295 else if (!strcasecmp(end, "g")) {
296 *val *= 1024 * 1024 * 1024;
302 static int perf_parse_llong(const char *value, long long *ret)
304 if (value && *value) {
306 long long val = strtoll(value, &end, 0);
307 unsigned long factor = 1;
309 if (!parse_unit_factor(end, &factor))
317 static int perf_parse_long(const char *value, long *ret)
319 if (value && *value) {
321 long val = strtol(value, &end, 0);
322 unsigned long factor = 1;
323 if (!parse_unit_factor(end, &factor))
331 static void die_bad_config(const char *name)
333 if (config_file_name)
334 die("bad config value for '%s' in %s", name, config_file_name);
335 die("bad config value for '%s'", name);
338 u64 perf_config_u64(const char *name, const char *value)
342 if (!perf_parse_llong(value, &ret))
343 die_bad_config(name);
347 int perf_config_int(const char *name, const char *value)
350 if (!perf_parse_long(value, &ret))
351 die_bad_config(name);
355 static int perf_config_bool_or_int(const char *name, const char *value, int *is_bool)
362 if (!strcasecmp(value, "true") || !strcasecmp(value, "yes") || !strcasecmp(value, "on"))
364 if (!strcasecmp(value, "false") || !strcasecmp(value, "no") || !strcasecmp(value, "off"))
367 return perf_config_int(name, value);
370 int perf_config_bool(const char *name, const char *value)
373 return !!perf_config_bool_or_int(name, value, &discard);
376 static const char *perf_config_dirname(const char *name, const char *value)
383 static int perf_buildid_config(const char *var, const char *value)
385 /* same dir for all commands */
386 if (!strcmp(var, "buildid.dir")) {
387 const char *dir = perf_config_dirname(var, value);
390 pr_err("Invalid buildid directory!\n");
393 strncpy(buildid_dir, dir, MAXPATHLEN-1);
394 buildid_dir[MAXPATHLEN-1] = '\0';
400 static int perf_default_core_config(const char *var __maybe_unused,
401 const char *value __maybe_unused)
403 /* Add other config variables here. */
407 static int perf_ui_config(const char *var, const char *value)
409 /* Add other config variables here. */
410 if (!strcmp(var, "ui.show-headers"))
411 symbol_conf.show_hist_headers = perf_config_bool(var, value);
416 int perf_default_config(const char *var, const char *value,
417 void *dummy __maybe_unused)
419 if (!prefixcmp(var, "core."))
420 return perf_default_core_config(var, value);
422 if (!prefixcmp(var, "hist."))
423 return perf_hist_config(var, value);
425 if (!prefixcmp(var, "ui."))
426 return perf_ui_config(var, value);
428 if (!prefixcmp(var, "call-graph."))
429 return perf_callchain_config(var, value);
431 if (!prefixcmp(var, "llvm."))
432 return perf_llvm_config(var, value);
434 if (!prefixcmp(var, "buildid."))
435 return perf_buildid_config(var, value);
437 /* Add other config variables here. */
441 static int perf_config_from_file(config_fn_t fn, const char *filename, void *data)
444 FILE *f = fopen(filename, "r");
449 config_file_name = filename;
452 ret = perf_parse_file(fn, data);
454 config_file_name = NULL;
459 const char *perf_etc_perfconfig(void)
461 static const char *system_wide;
463 system_wide = system_path(ETC_PERFCONFIG);
467 static int perf_env_bool(const char *k, int def)
469 const char *v = getenv(k);
470 return v ? perf_config_bool(k, v) : def;
473 static int perf_config_system(void)
475 return !perf_env_bool("PERF_CONFIG_NOSYSTEM", 0);
478 static int perf_config_global(void)
480 return !perf_env_bool("PERF_CONFIG_NOGLOBAL", 0);
483 static struct perf_config_section *find_section(struct list_head *sections,
484 const char *section_name)
486 struct perf_config_section *section;
488 list_for_each_entry(section, sections, node)
489 if (!strcmp(section->name, section_name))
495 static struct perf_config_item *find_config_item(const char *name,
496 struct perf_config_section *section)
498 struct perf_config_item *item;
500 list_for_each_entry(item, §ion->items, node)
501 if (!strcmp(item->name, name))
507 static struct perf_config_section *add_section(struct list_head *sections,
508 const char *section_name)
510 struct perf_config_section *section = zalloc(sizeof(*section));
515 INIT_LIST_HEAD(§ion->items);
516 section->name = strdup(section_name);
517 if (!section->name) {
518 pr_debug("%s: strdup failed\n", __func__);
523 list_add_tail(§ion->node, sections);
527 static struct perf_config_item *add_config_item(struct perf_config_section *section,
530 struct perf_config_item *item = zalloc(sizeof(*item));
535 item->name = strdup(name);
537 pr_debug("%s: strdup failed\n", __func__);
542 list_add_tail(&item->node, §ion->items);
546 static int set_value(struct perf_config_item *item, const char *value)
548 char *val = strdup(value);
558 static int collect_config(const char *var, const char *value,
559 void *perf_config_set)
563 char *section_name, *name;
564 struct perf_config_section *section = NULL;
565 struct perf_config_item *item = NULL;
566 struct perf_config_set *set = perf_config_set;
567 struct list_head *sections;
572 sections = &set->sections;
573 key = ptr = strdup(var);
575 pr_debug("%s: strdup failed\n", __func__);
579 section_name = strsep(&ptr, ".");
581 if (name == NULL || value == NULL)
584 section = find_section(sections, section_name);
586 section = add_section(sections, section_name);
591 item = find_config_item(name, section);
593 item = add_config_item(section, name);
598 /* perf_config_set can contain both user and system config items.
599 * So we should know where each value is from.
600 * The classification would be needed when a particular config file
601 * is overwrited by setting feature i.e. set_config().
603 if (strcmp(config_file_name, perf_etc_perfconfig()) == 0) {
604 section->from_system_config = true;
605 item->from_system_config = true;
607 section->from_system_config = false;
608 item->from_system_config = false;
611 ret = set_value(item, value);
619 int perf_config_set__collect(struct perf_config_set *set, const char *file_name,
620 const char *var, const char *value)
622 config_file_name = file_name;
623 return collect_config(var, value, set);
626 static int perf_config_set__init(struct perf_config_set *set)
629 const char *home = NULL;
631 /* Setting $PERF_CONFIG makes perf read _only_ the given config file. */
632 if (config_exclusive_filename)
633 return perf_config_from_file(collect_config, config_exclusive_filename, set);
634 if (perf_config_system() && !access(perf_etc_perfconfig(), R_OK)) {
635 if (perf_config_from_file(collect_config, perf_etc_perfconfig(), set) < 0)
639 home = getenv("HOME");
640 if (perf_config_global() && home) {
641 char *user_config = strdup(mkpath("%s/.perfconfig", home));
644 if (user_config == NULL) {
645 warning("Not enough memory to process %s/.perfconfig, "
646 "ignoring it.", home);
650 if (stat(user_config, &st) < 0) {
658 if (st.st_uid && (st.st_uid != geteuid())) {
659 warning("File %s not owned by current user or root, "
660 "ignoring it.", user_config);
665 ret = perf_config_from_file(collect_config, user_config, set);
673 struct perf_config_set *perf_config_set__new(void)
675 struct perf_config_set *set = zalloc(sizeof(*set));
678 INIT_LIST_HEAD(&set->sections);
679 if (perf_config_set__init(set) < 0) {
680 perf_config_set__delete(set);
688 int perf_config(config_fn_t fn, void *data)
692 struct perf_config_section *section;
693 struct perf_config_item *item;
695 if (config_set == NULL)
698 perf_config_set__for_each_entry(config_set, section, item) {
699 char *value = item->value;
702 scnprintf(key, sizeof(key), "%s.%s",
703 section->name, item->name);
704 ret = fn(key, value, data);
706 pr_err("Error: wrong config key-value pair %s=%s\n",
716 void perf_config__init(void)
718 if (config_set == NULL)
719 config_set = perf_config_set__new();
722 void perf_config__exit(void)
724 perf_config_set__delete(config_set);
728 void perf_config__refresh(void)
734 static void perf_config_item__delete(struct perf_config_item *item)
741 static void perf_config_section__purge(struct perf_config_section *section)
743 struct perf_config_item *item, *tmp;
745 list_for_each_entry_safe(item, tmp, §ion->items, node) {
746 list_del_init(&item->node);
747 perf_config_item__delete(item);
751 static void perf_config_section__delete(struct perf_config_section *section)
753 perf_config_section__purge(section);
754 zfree(§ion->name);
758 static void perf_config_set__purge(struct perf_config_set *set)
760 struct perf_config_section *section, *tmp;
762 list_for_each_entry_safe(section, tmp, &set->sections, node) {
763 list_del_init(§ion->node);
764 perf_config_section__delete(section);
768 void perf_config_set__delete(struct perf_config_set *set)
773 perf_config_set__purge(set);
778 * Call this to report error for your variable that should not
779 * get a boolean value (i.e. "[my] var" means "true").
781 int config_error_nonbool(const char *var)
783 return error("Missing value for '%s'", var);
786 void set_buildid_dir(const char *dir)
789 scnprintf(buildid_dir, MAXPATHLEN-1, "%s", dir);
791 /* default to $HOME/.debug */
792 if (buildid_dir[0] == '\0') {
793 char *home = getenv("HOME");
796 snprintf(buildid_dir, MAXPATHLEN-1, "%s/%s",
797 home, DEBUG_CACHE_DIR);
799 strncpy(buildid_dir, DEBUG_CACHE_DIR, MAXPATHLEN-1);
801 buildid_dir[MAXPATHLEN-1] = '\0';
803 /* for communicating with external commands */
804 setenv("PERF_BUILDID_DIR", buildid_dir, 1);