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>
16 #include <subcmd/exec-cmd.h>
17 #include "util/hist.h" /* perf_hist_config */
18 #include "util/llvm-utils.h" /* perf_llvm_config */
20 #include <sys/types.h>
23 #include <linux/string.h>
25 #include "sane_ctype.h"
29 #define DEBUG_CACHE_DIR ".debug"
32 char buildid_dir[MAXPATHLEN]; /* root dir for buildid, binary cache */
34 static FILE *config_file;
35 static const char *config_file_name;
36 static int config_linenr;
37 static int config_file_eof;
38 static struct perf_config_set *config_set;
40 const char *config_exclusive_filename;
42 static int get_next_char(void)
48 if ((f = config_file) != NULL) {
51 /* DOS like systems */
68 static char *parse_value(void)
70 static char value[1024];
71 int quote = 0, comment = 0, space = 0;
75 int c = get_next_char();
77 if (len >= sizeof(value) - 1)
87 if (isspace(c) && !quote) {
92 if (c == ';' || c == '#') {
116 /* Some characters escape as themselves */
119 /* Reject unknown escape sequences */
134 static inline int iskeychar(int c)
136 return isalnum(c) || c == '-' || c == '_';
139 static int get_value(config_fn_t fn, void *data, char *name, unsigned int len)
144 /* Get the full name */
156 while (c == ' ' || c == '\t')
163 value = parse_value();
167 return fn(name, value, data);
170 static int get_extended_base_var(char *name, int baselen, int c)
176 } while (isspace(c));
178 /* We require the format to be '[base "extension"]' */
181 name[baselen++] = '.';
184 int ch = get_next_char();
191 ch = get_next_char();
195 name[baselen++] = ch;
196 if (baselen > MAXNAME / 2)
201 if (get_next_char() != ']')
206 static int get_base_var(char *name)
211 int c = get_next_char();
217 return get_extended_base_var(name, baselen, c);
218 if (!iskeychar(c) && c != '.')
220 if (baselen > MAXNAME / 2)
222 name[baselen++] = tolower(c);
226 static int perf_parse_file(config_fn_t fn, void *data)
230 static char var[MAXNAME];
232 /* U+FEFF Byte Order Mark in UTF8 */
233 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
234 const unsigned char *bomptr = utf8_bom;
237 int line, c = get_next_char();
239 if (bomptr && *bomptr) {
240 /* We are at the file beginning; skip UTF8-encoded BOM
241 * if present. Sane editors won't put this in on their
242 * own, but e.g. Windows Notepad will do it happily. */
243 if ((unsigned char) c == *bomptr) {
247 /* Do not tolerate partial BOM. */
248 if (bomptr != utf8_bom)
250 /* No BOM at file beginning. Cool. */
260 if (comment || isspace(c))
262 if (c == '#' || c == ';') {
267 baselen = get_base_var(var);
270 var[baselen++] = '.';
276 var[baselen] = tolower(c);
279 * The get_value function might or might not reach the '\n',
280 * so saving the current line number for error reporting.
282 line = config_linenr;
283 if (get_value(fn, data, var, baselen+1) < 0) {
284 config_linenr = line;
288 pr_err("bad config file line %d in %s\n", config_linenr, config_file_name);
292 static int parse_unit_factor(const char *end, unsigned long *val)
296 else if (!strcasecmp(end, "k")) {
300 else if (!strcasecmp(end, "m")) {
304 else if (!strcasecmp(end, "g")) {
305 *val *= 1024 * 1024 * 1024;
311 static int perf_parse_llong(const char *value, long long *ret)
313 if (value && *value) {
315 long long val = strtoll(value, &end, 0);
316 unsigned long factor = 1;
318 if (!parse_unit_factor(end, &factor))
326 static int perf_parse_long(const char *value, long *ret)
328 if (value && *value) {
330 long val = strtol(value, &end, 0);
331 unsigned long factor = 1;
332 if (!parse_unit_factor(end, &factor))
340 static void bad_config(const char *name)
342 if (config_file_name)
343 pr_warning("bad config value for '%s' in %s, ignoring...\n", name, config_file_name);
345 pr_warning("bad config value for '%s', ignoring...\n", name);
348 int perf_config_u64(u64 *dest, const char *name, const char *value)
352 if (!perf_parse_llong(value, &ret)) {
361 int perf_config_int(int *dest, const char *name, const char *value)
364 if (!perf_parse_long(value, &ret)) {
372 static int perf_config_bool_or_int(const char *name, const char *value, int *is_bool)
381 if (!strcasecmp(value, "true") || !strcasecmp(value, "yes") || !strcasecmp(value, "on"))
383 if (!strcasecmp(value, "false") || !strcasecmp(value, "no") || !strcasecmp(value, "off"))
386 return perf_config_int(&ret, name, value) < 0 ? -1 : ret;
389 int perf_config_bool(const char *name, const char *value)
392 return !!perf_config_bool_or_int(name, value, &discard);
395 static const char *perf_config_dirname(const char *name, const char *value)
402 static int perf_buildid_config(const char *var, const char *value)
404 /* same dir for all commands */
405 if (!strcmp(var, "buildid.dir")) {
406 const char *dir = perf_config_dirname(var, value);
409 pr_err("Invalid buildid directory!\n");
412 strncpy(buildid_dir, dir, MAXPATHLEN-1);
413 buildid_dir[MAXPATHLEN-1] = '\0';
419 static int perf_default_core_config(const char *var __maybe_unused,
420 const char *value __maybe_unused)
422 /* Add other config variables here. */
426 static int perf_ui_config(const char *var, const char *value)
428 /* Add other config variables here. */
429 if (!strcmp(var, "ui.show-headers"))
430 symbol_conf.show_hist_headers = perf_config_bool(var, value);
435 int perf_default_config(const char *var, const char *value,
436 void *dummy __maybe_unused)
438 if (strstarts(var, "core."))
439 return perf_default_core_config(var, value);
441 if (strstarts(var, "hist."))
442 return perf_hist_config(var, value);
444 if (strstarts(var, "ui."))
445 return perf_ui_config(var, value);
447 if (strstarts(var, "call-graph."))
448 return perf_callchain_config(var, value);
450 if (strstarts(var, "llvm."))
451 return perf_llvm_config(var, value);
453 if (strstarts(var, "buildid."))
454 return perf_buildid_config(var, value);
456 /* Add other config variables here. */
460 static int perf_config_from_file(config_fn_t fn, const char *filename, void *data)
463 FILE *f = fopen(filename, "r");
468 config_file_name = filename;
471 ret = perf_parse_file(fn, data);
473 config_file_name = NULL;
478 const char *perf_etc_perfconfig(void)
480 static const char *system_wide;
482 system_wide = system_path(ETC_PERFCONFIG);
486 static int perf_env_bool(const char *k, int def)
488 const char *v = getenv(k);
489 return v ? perf_config_bool(k, v) : def;
492 static int perf_config_system(void)
494 return !perf_env_bool("PERF_CONFIG_NOSYSTEM", 0);
497 static int perf_config_global(void)
499 return !perf_env_bool("PERF_CONFIG_NOGLOBAL", 0);
502 static struct perf_config_section *find_section(struct list_head *sections,
503 const char *section_name)
505 struct perf_config_section *section;
507 list_for_each_entry(section, sections, node)
508 if (!strcmp(section->name, section_name))
514 static struct perf_config_item *find_config_item(const char *name,
515 struct perf_config_section *section)
517 struct perf_config_item *item;
519 list_for_each_entry(item, §ion->items, node)
520 if (!strcmp(item->name, name))
526 static struct perf_config_section *add_section(struct list_head *sections,
527 const char *section_name)
529 struct perf_config_section *section = zalloc(sizeof(*section));
534 INIT_LIST_HEAD(§ion->items);
535 section->name = strdup(section_name);
536 if (!section->name) {
537 pr_debug("%s: strdup failed\n", __func__);
542 list_add_tail(§ion->node, sections);
546 static struct perf_config_item *add_config_item(struct perf_config_section *section,
549 struct perf_config_item *item = zalloc(sizeof(*item));
554 item->name = strdup(name);
556 pr_debug("%s: strdup failed\n", __func__);
561 list_add_tail(&item->node, §ion->items);
565 static int set_value(struct perf_config_item *item, const char *value)
567 char *val = strdup(value);
577 static int collect_config(const char *var, const char *value,
578 void *perf_config_set)
582 char *section_name, *name;
583 struct perf_config_section *section = NULL;
584 struct perf_config_item *item = NULL;
585 struct perf_config_set *set = perf_config_set;
586 struct list_head *sections;
591 sections = &set->sections;
592 key = ptr = strdup(var);
594 pr_debug("%s: strdup failed\n", __func__);
598 section_name = strsep(&ptr, ".");
600 if (name == NULL || value == NULL)
603 section = find_section(sections, section_name);
605 section = add_section(sections, section_name);
610 item = find_config_item(name, section);
612 item = add_config_item(section, name);
617 /* perf_config_set can contain both user and system config items.
618 * So we should know where each value is from.
619 * The classification would be needed when a particular config file
620 * is overwrited by setting feature i.e. set_config().
622 if (strcmp(config_file_name, perf_etc_perfconfig()) == 0) {
623 section->from_system_config = true;
624 item->from_system_config = true;
626 section->from_system_config = false;
627 item->from_system_config = false;
630 ret = set_value(item, value);
638 int perf_config_set__collect(struct perf_config_set *set, const char *file_name,
639 const char *var, const char *value)
641 config_file_name = file_name;
642 return collect_config(var, value, set);
645 static int perf_config_set__init(struct perf_config_set *set)
648 const char *home = NULL;
652 /* Setting $PERF_CONFIG makes perf read _only_ the given config file. */
653 if (config_exclusive_filename)
654 return perf_config_from_file(collect_config, config_exclusive_filename, set);
655 if (perf_config_system() && !access(perf_etc_perfconfig(), R_OK)) {
656 if (perf_config_from_file(collect_config, perf_etc_perfconfig(), set) < 0)
660 home = getenv("HOME");
663 * Skip reading user config if:
664 * - there is no place to read it from (HOME)
665 * - we are asked not to (PERF_CONFIG_NOGLOBAL=1)
667 if (!home || !*home || !perf_config_global())
670 user_config = strdup(mkpath("%s/.perfconfig", home));
671 if (user_config == NULL) {
672 pr_warning("Not enough memory to process %s/.perfconfig, ignoring it.", home);
676 if (stat(user_config, &st) < 0) {
684 if (st.st_uid && (st.st_uid != geteuid())) {
685 pr_warning("File %s not owned by current user or root, ignoring it.", user_config);
690 ret = perf_config_from_file(collect_config, user_config, set);
698 struct perf_config_set *perf_config_set__new(void)
700 struct perf_config_set *set = zalloc(sizeof(*set));
703 INIT_LIST_HEAD(&set->sections);
704 perf_config_set__init(set);
710 int perf_config(config_fn_t fn, void *data)
714 struct perf_config_section *section;
715 struct perf_config_item *item;
717 if (config_set == NULL)
720 perf_config_set__for_each_entry(config_set, section, item) {
721 char *value = item->value;
724 scnprintf(key, sizeof(key), "%s.%s",
725 section->name, item->name);
726 ret = fn(key, value, data);
728 pr_err("Error: wrong config key-value pair %s=%s\n",
738 void perf_config__init(void)
740 if (config_set == NULL)
741 config_set = perf_config_set__new();
744 void perf_config__exit(void)
746 perf_config_set__delete(config_set);
750 void perf_config__refresh(void)
756 static void perf_config_item__delete(struct perf_config_item *item)
763 static void perf_config_section__purge(struct perf_config_section *section)
765 struct perf_config_item *item, *tmp;
767 list_for_each_entry_safe(item, tmp, §ion->items, node) {
768 list_del_init(&item->node);
769 perf_config_item__delete(item);
773 static void perf_config_section__delete(struct perf_config_section *section)
775 perf_config_section__purge(section);
776 zfree(§ion->name);
780 static void perf_config_set__purge(struct perf_config_set *set)
782 struct perf_config_section *section, *tmp;
784 list_for_each_entry_safe(section, tmp, &set->sections, node) {
785 list_del_init(§ion->node);
786 perf_config_section__delete(section);
790 void perf_config_set__delete(struct perf_config_set *set)
795 perf_config_set__purge(set);
800 * Call this to report error for your variable that should not
801 * get a boolean value (i.e. "[my] var" means "true").
803 int config_error_nonbool(const char *var)
805 pr_err("Missing value for '%s'", var);
809 void set_buildid_dir(const char *dir)
812 scnprintf(buildid_dir, MAXPATHLEN-1, "%s", dir);
814 /* default to $HOME/.debug */
815 if (buildid_dir[0] == '\0') {
816 char *home = getenv("HOME");
819 snprintf(buildid_dir, MAXPATHLEN-1, "%s/%s",
820 home, DEBUG_CACHE_DIR);
822 strncpy(buildid_dir, DEBUG_CACHE_DIR, MAXPATHLEN-1);
824 buildid_dir[MAXPATHLEN-1] = '\0';
826 /* for communicating with external commands */
827 setenv("PERF_BUILDID_DIR", buildid_dir, 1);