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
12 #include <sys/param.h>
15 #include <subcmd/exec-cmd.h>
16 #include "util/hist.h" /* perf_hist_config */
17 #include "util/llvm-utils.h" /* perf_llvm_config */
19 #include <sys/types.h>
23 #include "sane_ctype.h"
27 #define DEBUG_CACHE_DIR ".debug"
30 char buildid_dir[MAXPATHLEN]; /* root dir for buildid, binary cache */
32 static FILE *config_file;
33 static const char *config_file_name;
34 static int config_linenr;
35 static int config_file_eof;
36 static struct perf_config_set *config_set;
38 const char *config_exclusive_filename;
40 static int get_next_char(void)
46 if ((f = config_file) != NULL) {
49 /* DOS like systems */
66 static char *parse_value(void)
68 static char value[1024];
69 int quote = 0, comment = 0, space = 0;
73 int c = get_next_char();
75 if (len >= sizeof(value) - 1)
85 if (isspace(c) && !quote) {
90 if (c == ';' || c == '#') {
114 /* Some characters escape as themselves */
117 /* Reject unknown escape sequences */
132 static inline int iskeychar(int c)
134 return isalnum(c) || c == '-' || c == '_';
137 static int get_value(config_fn_t fn, void *data, char *name, unsigned int len)
142 /* Get the full name */
154 while (c == ' ' || c == '\t')
161 value = parse_value();
165 return fn(name, value, data);
168 static int get_extended_base_var(char *name, int baselen, int c)
174 } while (isspace(c));
176 /* We require the format to be '[base "extension"]' */
179 name[baselen++] = '.';
182 int ch = get_next_char();
189 ch = get_next_char();
193 name[baselen++] = ch;
194 if (baselen > MAXNAME / 2)
199 if (get_next_char() != ']')
204 static int get_base_var(char *name)
209 int c = get_next_char();
215 return get_extended_base_var(name, baselen, c);
216 if (!iskeychar(c) && c != '.')
218 if (baselen > MAXNAME / 2)
220 name[baselen++] = tolower(c);
224 static int perf_parse_file(config_fn_t fn, void *data)
228 static char var[MAXNAME];
230 /* U+FEFF Byte Order Mark in UTF8 */
231 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
232 const unsigned char *bomptr = utf8_bom;
235 int line, c = get_next_char();
237 if (bomptr && *bomptr) {
238 /* We are at the file beginning; skip UTF8-encoded BOM
239 * if present. Sane editors won't put this in on their
240 * own, but e.g. Windows Notepad will do it happily. */
241 if ((unsigned char) c == *bomptr) {
245 /* Do not tolerate partial BOM. */
246 if (bomptr != utf8_bom)
248 /* No BOM at file beginning. Cool. */
258 if (comment || isspace(c))
260 if (c == '#' || c == ';') {
265 baselen = get_base_var(var);
268 var[baselen++] = '.';
274 var[baselen] = tolower(c);
277 * The get_value function might or might not reach the '\n',
278 * so saving the current line number for error reporting.
280 line = config_linenr;
281 if (get_value(fn, data, var, baselen+1) < 0) {
282 config_linenr = line;
286 pr_err("bad config file line %d in %s\n", config_linenr, config_file_name);
290 static int parse_unit_factor(const char *end, unsigned long *val)
294 else if (!strcasecmp(end, "k")) {
298 else if (!strcasecmp(end, "m")) {
302 else if (!strcasecmp(end, "g")) {
303 *val *= 1024 * 1024 * 1024;
309 static int perf_parse_llong(const char *value, long long *ret)
311 if (value && *value) {
313 long long val = strtoll(value, &end, 0);
314 unsigned long factor = 1;
316 if (!parse_unit_factor(end, &factor))
324 static int perf_parse_long(const char *value, long *ret)
326 if (value && *value) {
328 long val = strtol(value, &end, 0);
329 unsigned long factor = 1;
330 if (!parse_unit_factor(end, &factor))
338 static void bad_config(const char *name)
340 if (config_file_name)
341 pr_warning("bad config value for '%s' in %s, ignoring...\n", name, config_file_name);
343 pr_warning("bad config value for '%s', ignoring...\n", name);
346 int perf_config_u64(u64 *dest, const char *name, const char *value)
350 if (!perf_parse_llong(value, &ret)) {
359 int perf_config_int(int *dest, const char *name, const char *value)
362 if (!perf_parse_long(value, &ret)) {
370 static int perf_config_bool_or_int(const char *name, const char *value, int *is_bool)
379 if (!strcasecmp(value, "true") || !strcasecmp(value, "yes") || !strcasecmp(value, "on"))
381 if (!strcasecmp(value, "false") || !strcasecmp(value, "no") || !strcasecmp(value, "off"))
384 return perf_config_int(&ret, name, value) < 0 ? -1 : ret;
387 int perf_config_bool(const char *name, const char *value)
390 return !!perf_config_bool_or_int(name, value, &discard);
393 static const char *perf_config_dirname(const char *name, const char *value)
400 static int perf_buildid_config(const char *var, const char *value)
402 /* same dir for all commands */
403 if (!strcmp(var, "buildid.dir")) {
404 const char *dir = perf_config_dirname(var, value);
407 pr_err("Invalid buildid directory!\n");
410 strncpy(buildid_dir, dir, MAXPATHLEN-1);
411 buildid_dir[MAXPATHLEN-1] = '\0';
417 static int perf_default_core_config(const char *var __maybe_unused,
418 const char *value __maybe_unused)
420 /* Add other config variables here. */
424 static int perf_ui_config(const char *var, const char *value)
426 /* Add other config variables here. */
427 if (!strcmp(var, "ui.show-headers"))
428 symbol_conf.show_hist_headers = perf_config_bool(var, value);
433 int perf_default_config(const char *var, const char *value,
434 void *dummy __maybe_unused)
436 if (!prefixcmp(var, "core."))
437 return perf_default_core_config(var, value);
439 if (!prefixcmp(var, "hist."))
440 return perf_hist_config(var, value);
442 if (!prefixcmp(var, "ui."))
443 return perf_ui_config(var, value);
445 if (!prefixcmp(var, "call-graph."))
446 return perf_callchain_config(var, value);
448 if (!prefixcmp(var, "llvm."))
449 return perf_llvm_config(var, value);
451 if (!prefixcmp(var, "buildid."))
452 return perf_buildid_config(var, value);
454 /* Add other config variables here. */
458 static int perf_config_from_file(config_fn_t fn, const char *filename, void *data)
461 FILE *f = fopen(filename, "r");
466 config_file_name = filename;
469 ret = perf_parse_file(fn, data);
471 config_file_name = NULL;
476 const char *perf_etc_perfconfig(void)
478 static const char *system_wide;
480 system_wide = system_path(ETC_PERFCONFIG);
484 static int perf_env_bool(const char *k, int def)
486 const char *v = getenv(k);
487 return v ? perf_config_bool(k, v) : def;
490 static int perf_config_system(void)
492 return !perf_env_bool("PERF_CONFIG_NOSYSTEM", 0);
495 static int perf_config_global(void)
497 return !perf_env_bool("PERF_CONFIG_NOGLOBAL", 0);
500 static struct perf_config_section *find_section(struct list_head *sections,
501 const char *section_name)
503 struct perf_config_section *section;
505 list_for_each_entry(section, sections, node)
506 if (!strcmp(section->name, section_name))
512 static struct perf_config_item *find_config_item(const char *name,
513 struct perf_config_section *section)
515 struct perf_config_item *item;
517 list_for_each_entry(item, §ion->items, node)
518 if (!strcmp(item->name, name))
524 static struct perf_config_section *add_section(struct list_head *sections,
525 const char *section_name)
527 struct perf_config_section *section = zalloc(sizeof(*section));
532 INIT_LIST_HEAD(§ion->items);
533 section->name = strdup(section_name);
534 if (!section->name) {
535 pr_debug("%s: strdup failed\n", __func__);
540 list_add_tail(§ion->node, sections);
544 static struct perf_config_item *add_config_item(struct perf_config_section *section,
547 struct perf_config_item *item = zalloc(sizeof(*item));
552 item->name = strdup(name);
554 pr_debug("%s: strdup failed\n", __func__);
559 list_add_tail(&item->node, §ion->items);
563 static int set_value(struct perf_config_item *item, const char *value)
565 char *val = strdup(value);
575 static int collect_config(const char *var, const char *value,
576 void *perf_config_set)
580 char *section_name, *name;
581 struct perf_config_section *section = NULL;
582 struct perf_config_item *item = NULL;
583 struct perf_config_set *set = perf_config_set;
584 struct list_head *sections;
589 sections = &set->sections;
590 key = ptr = strdup(var);
592 pr_debug("%s: strdup failed\n", __func__);
596 section_name = strsep(&ptr, ".");
598 if (name == NULL || value == NULL)
601 section = find_section(sections, section_name);
603 section = add_section(sections, section_name);
608 item = find_config_item(name, section);
610 item = add_config_item(section, name);
615 /* perf_config_set can contain both user and system config items.
616 * So we should know where each value is from.
617 * The classification would be needed when a particular config file
618 * is overwrited by setting feature i.e. set_config().
620 if (strcmp(config_file_name, perf_etc_perfconfig()) == 0) {
621 section->from_system_config = true;
622 item->from_system_config = true;
624 section->from_system_config = false;
625 item->from_system_config = false;
628 ret = set_value(item, value);
636 int perf_config_set__collect(struct perf_config_set *set, const char *file_name,
637 const char *var, const char *value)
639 config_file_name = file_name;
640 return collect_config(var, value, set);
643 static int perf_config_set__init(struct perf_config_set *set)
646 const char *home = NULL;
650 /* Setting $PERF_CONFIG makes perf read _only_ the given config file. */
651 if (config_exclusive_filename)
652 return perf_config_from_file(collect_config, config_exclusive_filename, set);
653 if (perf_config_system() && !access(perf_etc_perfconfig(), R_OK)) {
654 if (perf_config_from_file(collect_config, perf_etc_perfconfig(), set) < 0)
658 home = getenv("HOME");
661 * Skip reading user config if:
662 * - there is no place to read it from (HOME)
663 * - we are asked not to (PERF_CONFIG_NOGLOBAL=1)
665 if (!home || !*home || !perf_config_global())
668 user_config = strdup(mkpath("%s/.perfconfig", home));
669 if (user_config == NULL) {
670 pr_warning("Not enough memory to process %s/.perfconfig, ignoring it.", home);
674 if (stat(user_config, &st) < 0) {
682 if (st.st_uid && (st.st_uid != geteuid())) {
683 pr_warning("File %s not owned by current user or root, ignoring it.", user_config);
688 ret = perf_config_from_file(collect_config, user_config, set);
696 struct perf_config_set *perf_config_set__new(void)
698 struct perf_config_set *set = zalloc(sizeof(*set));
701 INIT_LIST_HEAD(&set->sections);
702 if (perf_config_set__init(set) < 0) {
703 perf_config_set__delete(set);
711 int perf_config(config_fn_t fn, void *data)
715 struct perf_config_section *section;
716 struct perf_config_item *item;
718 if (config_set == NULL)
721 perf_config_set__for_each_entry(config_set, section, item) {
722 char *value = item->value;
725 scnprintf(key, sizeof(key), "%s.%s",
726 section->name, item->name);
727 ret = fn(key, value, data);
729 pr_err("Error: wrong config key-value pair %s=%s\n",
739 void perf_config__init(void)
741 if (config_set == NULL)
742 config_set = perf_config_set__new();
745 void perf_config__exit(void)
747 perf_config_set__delete(config_set);
751 void perf_config__refresh(void)
757 static void perf_config_item__delete(struct perf_config_item *item)
764 static void perf_config_section__purge(struct perf_config_section *section)
766 struct perf_config_item *item, *tmp;
768 list_for_each_entry_safe(item, tmp, §ion->items, node) {
769 list_del_init(&item->node);
770 perf_config_item__delete(item);
774 static void perf_config_section__delete(struct perf_config_section *section)
776 perf_config_section__purge(section);
777 zfree(§ion->name);
781 static void perf_config_set__purge(struct perf_config_set *set)
783 struct perf_config_section *section, *tmp;
785 list_for_each_entry_safe(section, tmp, &set->sections, node) {
786 list_del_init(§ion->node);
787 perf_config_section__delete(section);
791 void perf_config_set__delete(struct perf_config_set *set)
796 perf_config_set__purge(set);
801 * Call this to report error for your variable that should not
802 * get a boolean value (i.e. "[my] var" means "true").
804 int config_error_nonbool(const char *var)
806 pr_err("Missing value for '%s'", var);
810 void set_buildid_dir(const char *dir)
813 scnprintf(buildid_dir, MAXPATHLEN-1, "%s", dir);
815 /* default to $HOME/.debug */
816 if (buildid_dir[0] == '\0') {
817 char *home = getenv("HOME");
820 snprintf(buildid_dir, MAXPATHLEN-1, "%s/%s",
821 home, DEBUG_CACHE_DIR);
823 strncpy(buildid_dir, DEBUG_CACHE_DIR, MAXPATHLEN-1);
825 buildid_dir[MAXPATHLEN-1] = '\0';
827 /* for communicating with external commands */
828 setenv("PERF_BUILDID_DIR", buildid_dir, 1);