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>
22 #include <linux/string.h>
24 #include "sane_ctype.h"
28 #define DEBUG_CACHE_DIR ".debug"
31 char buildid_dir[MAXPATHLEN]; /* root dir for buildid, binary cache */
33 static FILE *config_file;
34 static const char *config_file_name;
35 static int config_linenr;
36 static int config_file_eof;
37 static struct perf_config_set *config_set;
39 const char *config_exclusive_filename;
41 static int get_next_char(void)
47 if ((f = config_file) != NULL) {
50 /* DOS like systems */
67 static char *parse_value(void)
69 static char value[1024];
70 int quote = 0, comment = 0, space = 0;
74 int c = get_next_char();
76 if (len >= sizeof(value) - 1)
86 if (isspace(c) && !quote) {
91 if (c == ';' || c == '#') {
115 /* Some characters escape as themselves */
118 /* Reject unknown escape sequences */
133 static inline int iskeychar(int c)
135 return isalnum(c) || c == '-' || c == '_';
138 static int get_value(config_fn_t fn, void *data, char *name, unsigned int len)
143 /* Get the full name */
155 while (c == ' ' || c == '\t')
162 value = parse_value();
166 return fn(name, value, data);
169 static int get_extended_base_var(char *name, int baselen, int c)
175 } while (isspace(c));
177 /* We require the format to be '[base "extension"]' */
180 name[baselen++] = '.';
183 int ch = get_next_char();
190 ch = get_next_char();
194 name[baselen++] = ch;
195 if (baselen > MAXNAME / 2)
200 if (get_next_char() != ']')
205 static int get_base_var(char *name)
210 int c = get_next_char();
216 return get_extended_base_var(name, baselen, c);
217 if (!iskeychar(c) && c != '.')
219 if (baselen > MAXNAME / 2)
221 name[baselen++] = tolower(c);
225 static int perf_parse_file(config_fn_t fn, void *data)
229 static char var[MAXNAME];
231 /* U+FEFF Byte Order Mark in UTF8 */
232 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
233 const unsigned char *bomptr = utf8_bom;
236 int line, c = get_next_char();
238 if (bomptr && *bomptr) {
239 /* We are at the file beginning; skip UTF8-encoded BOM
240 * if present. Sane editors won't put this in on their
241 * own, but e.g. Windows Notepad will do it happily. */
242 if ((unsigned char) c == *bomptr) {
246 /* Do not tolerate partial BOM. */
247 if (bomptr != utf8_bom)
249 /* No BOM at file beginning. Cool. */
259 if (comment || isspace(c))
261 if (c == '#' || c == ';') {
266 baselen = get_base_var(var);
269 var[baselen++] = '.';
275 var[baselen] = tolower(c);
278 * The get_value function might or might not reach the '\n',
279 * so saving the current line number for error reporting.
281 line = config_linenr;
282 if (get_value(fn, data, var, baselen+1) < 0) {
283 config_linenr = line;
287 pr_err("bad config file line %d in %s\n", config_linenr, config_file_name);
291 static int parse_unit_factor(const char *end, unsigned long *val)
295 else if (!strcasecmp(end, "k")) {
299 else if (!strcasecmp(end, "m")) {
303 else if (!strcasecmp(end, "g")) {
304 *val *= 1024 * 1024 * 1024;
310 static int perf_parse_llong(const char *value, long long *ret)
312 if (value && *value) {
314 long long val = strtoll(value, &end, 0);
315 unsigned long factor = 1;
317 if (!parse_unit_factor(end, &factor))
325 static int perf_parse_long(const char *value, long *ret)
327 if (value && *value) {
329 long val = strtol(value, &end, 0);
330 unsigned long factor = 1;
331 if (!parse_unit_factor(end, &factor))
339 static void bad_config(const char *name)
341 if (config_file_name)
342 pr_warning("bad config value for '%s' in %s, ignoring...\n", name, config_file_name);
344 pr_warning("bad config value for '%s', ignoring...\n", name);
347 int perf_config_u64(u64 *dest, const char *name, const char *value)
351 if (!perf_parse_llong(value, &ret)) {
360 int perf_config_int(int *dest, const char *name, const char *value)
363 if (!perf_parse_long(value, &ret)) {
371 static int perf_config_bool_or_int(const char *name, const char *value, int *is_bool)
380 if (!strcasecmp(value, "true") || !strcasecmp(value, "yes") || !strcasecmp(value, "on"))
382 if (!strcasecmp(value, "false") || !strcasecmp(value, "no") || !strcasecmp(value, "off"))
385 return perf_config_int(&ret, name, value) < 0 ? -1 : ret;
388 int perf_config_bool(const char *name, const char *value)
391 return !!perf_config_bool_or_int(name, value, &discard);
394 static const char *perf_config_dirname(const char *name, const char *value)
401 static int perf_buildid_config(const char *var, const char *value)
403 /* same dir for all commands */
404 if (!strcmp(var, "buildid.dir")) {
405 const char *dir = perf_config_dirname(var, value);
408 pr_err("Invalid buildid directory!\n");
411 strncpy(buildid_dir, dir, MAXPATHLEN-1);
412 buildid_dir[MAXPATHLEN-1] = '\0';
418 static int perf_default_core_config(const char *var __maybe_unused,
419 const char *value __maybe_unused)
421 /* Add other config variables here. */
425 static int perf_ui_config(const char *var, const char *value)
427 /* Add other config variables here. */
428 if (!strcmp(var, "ui.show-headers"))
429 symbol_conf.show_hist_headers = perf_config_bool(var, value);
434 int perf_default_config(const char *var, const char *value,
435 void *dummy __maybe_unused)
437 if (strstarts(var, "core."))
438 return perf_default_core_config(var, value);
440 if (strstarts(var, "hist."))
441 return perf_hist_config(var, value);
443 if (strstarts(var, "ui."))
444 return perf_ui_config(var, value);
446 if (strstarts(var, "call-graph."))
447 return perf_callchain_config(var, value);
449 if (strstarts(var, "llvm."))
450 return perf_llvm_config(var, value);
452 if (strstarts(var, "buildid."))
453 return perf_buildid_config(var, value);
455 /* Add other config variables here. */
459 static int perf_config_from_file(config_fn_t fn, const char *filename, void *data)
462 FILE *f = fopen(filename, "r");
467 config_file_name = filename;
470 ret = perf_parse_file(fn, data);
472 config_file_name = NULL;
477 const char *perf_etc_perfconfig(void)
479 static const char *system_wide;
481 system_wide = system_path(ETC_PERFCONFIG);
485 static int perf_env_bool(const char *k, int def)
487 const char *v = getenv(k);
488 return v ? perf_config_bool(k, v) : def;
491 static int perf_config_system(void)
493 return !perf_env_bool("PERF_CONFIG_NOSYSTEM", 0);
496 static int perf_config_global(void)
498 return !perf_env_bool("PERF_CONFIG_NOGLOBAL", 0);
501 static struct perf_config_section *find_section(struct list_head *sections,
502 const char *section_name)
504 struct perf_config_section *section;
506 list_for_each_entry(section, sections, node)
507 if (!strcmp(section->name, section_name))
513 static struct perf_config_item *find_config_item(const char *name,
514 struct perf_config_section *section)
516 struct perf_config_item *item;
518 list_for_each_entry(item, §ion->items, node)
519 if (!strcmp(item->name, name))
525 static struct perf_config_section *add_section(struct list_head *sections,
526 const char *section_name)
528 struct perf_config_section *section = zalloc(sizeof(*section));
533 INIT_LIST_HEAD(§ion->items);
534 section->name = strdup(section_name);
535 if (!section->name) {
536 pr_debug("%s: strdup failed\n", __func__);
541 list_add_tail(§ion->node, sections);
545 static struct perf_config_item *add_config_item(struct perf_config_section *section,
548 struct perf_config_item *item = zalloc(sizeof(*item));
553 item->name = strdup(name);
555 pr_debug("%s: strdup failed\n", __func__);
560 list_add_tail(&item->node, §ion->items);
564 static int set_value(struct perf_config_item *item, const char *value)
566 char *val = strdup(value);
576 static int collect_config(const char *var, const char *value,
577 void *perf_config_set)
581 char *section_name, *name;
582 struct perf_config_section *section = NULL;
583 struct perf_config_item *item = NULL;
584 struct perf_config_set *set = perf_config_set;
585 struct list_head *sections;
590 sections = &set->sections;
591 key = ptr = strdup(var);
593 pr_debug("%s: strdup failed\n", __func__);
597 section_name = strsep(&ptr, ".");
599 if (name == NULL || value == NULL)
602 section = find_section(sections, section_name);
604 section = add_section(sections, section_name);
609 item = find_config_item(name, section);
611 item = add_config_item(section, name);
616 /* perf_config_set can contain both user and system config items.
617 * So we should know where each value is from.
618 * The classification would be needed when a particular config file
619 * is overwrited by setting feature i.e. set_config().
621 if (strcmp(config_file_name, perf_etc_perfconfig()) == 0) {
622 section->from_system_config = true;
623 item->from_system_config = true;
625 section->from_system_config = false;
626 item->from_system_config = false;
629 ret = set_value(item, value);
637 int perf_config_set__collect(struct perf_config_set *set, const char *file_name,
638 const char *var, const char *value)
640 config_file_name = file_name;
641 return collect_config(var, value, set);
644 static int perf_config_set__init(struct perf_config_set *set)
647 const char *home = NULL;
651 /* Setting $PERF_CONFIG makes perf read _only_ the given config file. */
652 if (config_exclusive_filename)
653 return perf_config_from_file(collect_config, config_exclusive_filename, set);
654 if (perf_config_system() && !access(perf_etc_perfconfig(), R_OK)) {
655 if (perf_config_from_file(collect_config, perf_etc_perfconfig(), set) < 0)
659 home = getenv("HOME");
662 * Skip reading user config if:
663 * - there is no place to read it from (HOME)
664 * - we are asked not to (PERF_CONFIG_NOGLOBAL=1)
666 if (!home || !*home || !perf_config_global())
669 user_config = strdup(mkpath("%s/.perfconfig", home));
670 if (user_config == NULL) {
671 pr_warning("Not enough memory to process %s/.perfconfig, ignoring it.", home);
675 if (stat(user_config, &st) < 0) {
683 if (st.st_uid && (st.st_uid != geteuid())) {
684 pr_warning("File %s not owned by current user or root, ignoring it.", user_config);
689 ret = perf_config_from_file(collect_config, user_config, set);
697 struct perf_config_set *perf_config_set__new(void)
699 struct perf_config_set *set = zalloc(sizeof(*set));
702 INIT_LIST_HEAD(&set->sections);
703 if (perf_config_set__init(set) < 0) {
704 perf_config_set__delete(set);
712 int perf_config(config_fn_t fn, void *data)
716 struct perf_config_section *section;
717 struct perf_config_item *item;
719 if (config_set == NULL)
722 perf_config_set__for_each_entry(config_set, section, item) {
723 char *value = item->value;
726 scnprintf(key, sizeof(key), "%s.%s",
727 section->name, item->name);
728 ret = fn(key, value, data);
730 pr_err("Error: wrong config key-value pair %s=%s\n",
740 void perf_config__init(void)
742 if (config_set == NULL)
743 config_set = perf_config_set__new();
746 void perf_config__exit(void)
748 perf_config_set__delete(config_set);
752 void perf_config__refresh(void)
758 static void perf_config_item__delete(struct perf_config_item *item)
765 static void perf_config_section__purge(struct perf_config_section *section)
767 struct perf_config_item *item, *tmp;
769 list_for_each_entry_safe(item, tmp, §ion->items, node) {
770 list_del_init(&item->node);
771 perf_config_item__delete(item);
775 static void perf_config_section__delete(struct perf_config_section *section)
777 perf_config_section__purge(section);
778 zfree(§ion->name);
782 static void perf_config_set__purge(struct perf_config_set *set)
784 struct perf_config_section *section, *tmp;
786 list_for_each_entry_safe(section, tmp, &set->sections, node) {
787 list_del_init(§ion->node);
788 perf_config_section__delete(section);
792 void perf_config_set__delete(struct perf_config_set *set)
797 perf_config_set__purge(set);
802 * Call this to report error for your variable that should not
803 * get a boolean value (i.e. "[my] var" means "true").
805 int config_error_nonbool(const char *var)
807 pr_err("Missing value for '%s'", var);
811 void set_buildid_dir(const char *dir)
814 scnprintf(buildid_dir, MAXPATHLEN-1, "%s", dir);
816 /* default to $HOME/.debug */
817 if (buildid_dir[0] == '\0') {
818 char *home = getenv("HOME");
821 snprintf(buildid_dir, MAXPATHLEN-1, "%s/%s",
822 home, DEBUG_CACHE_DIR);
824 strncpy(buildid_dir, DEBUG_CACHE_DIR, MAXPATHLEN-1);
826 buildid_dir[MAXPATHLEN-1] = '\0';
828 /* for communicating with external commands */
829 setenv("PERF_BUILDID_DIR", buildid_dir, 1);