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/stat.h" /* perf_stat__set_big_num */
20 #include "util/evsel.h" /* evsel__hw_names, evsel__use_bpf_counters */
21 #include "util/srcline.h" /* addr2line_timeout_ms */
25 #include <sys/types.h>
29 #include <linux/string.h>
30 #include <linux/zalloc.h>
31 #include <linux/ctype.h>
35 #define DEBUG_CACHE_DIR ".debug"
38 char buildid_dir
[MAXPATHLEN
]; /* root dir for buildid, binary cache */
40 static FILE *config_file
;
41 static const char *config_file_name
;
42 static int config_linenr
;
43 static int config_file_eof
;
44 static struct perf_config_set
*config_set
;
46 const char *config_exclusive_filename
;
48 static int get_next_char(void)
54 if ((f
= config_file
) != NULL
) {
57 /* DOS like systems */
74 static char *parse_value(void)
76 static char value
[1024];
77 int quote
= 0, comment
= 0, space
= 0;
81 int c
= get_next_char();
83 if (len
>= sizeof(value
) - 1)
93 if (isspace(c
) && !quote
) {
98 if (c
== ';' || c
== '#') {
122 /* Some characters escape as themselves */
125 /* Reject unknown escape sequences */
140 static inline int iskeychar(int c
)
142 return isalnum(c
) || c
== '-' || c
== '_';
145 static int get_value(config_fn_t fn
, void *data
, char *name
, unsigned int len
)
150 /* Get the full name */
162 while (c
== ' ' || c
== '\t')
169 value
= parse_value();
173 return fn(name
, value
, data
);
176 static int get_extended_base_var(char *name
, int baselen
, int c
)
182 } while (isspace(c
));
184 /* We require the format to be '[base "extension"]' */
187 name
[baselen
++] = '.';
190 int ch
= get_next_char();
197 ch
= get_next_char();
201 name
[baselen
++] = ch
;
202 if (baselen
> MAXNAME
/ 2)
207 if (get_next_char() != ']')
212 static int get_base_var(char *name
)
217 int c
= get_next_char();
223 return get_extended_base_var(name
, baselen
, c
);
224 if (!iskeychar(c
) && c
!= '.')
226 if (baselen
> MAXNAME
/ 2)
228 name
[baselen
++] = tolower(c
);
232 static int perf_parse_file(config_fn_t fn
, void *data
)
236 static char var
[MAXNAME
];
238 /* U+FEFF Byte Order Mark in UTF8 */
239 static const unsigned char *utf8_bom
= (unsigned char *) "\xef\xbb\xbf";
240 const unsigned char *bomptr
= utf8_bom
;
243 int line
, c
= get_next_char();
245 if (bomptr
&& *bomptr
) {
246 /* We are at the file beginning; skip UTF8-encoded BOM
247 * if present. Sane editors won't put this in on their
248 * own, but e.g. Windows Notepad will do it happily. */
249 if ((unsigned char) c
== *bomptr
) {
253 /* Do not tolerate partial BOM. */
254 if (bomptr
!= utf8_bom
)
256 /* No BOM at file beginning. Cool. */
266 if (comment
|| isspace(c
))
268 if (c
== '#' || c
== ';') {
273 baselen
= get_base_var(var
);
276 var
[baselen
++] = '.';
282 var
[baselen
] = tolower(c
);
285 * The get_value function might or might not reach the '\n',
286 * so saving the current line number for error reporting.
288 line
= config_linenr
;
289 if (get_value(fn
, data
, var
, baselen
+1) < 0) {
290 config_linenr
= line
;
294 pr_err("bad config file line %d in %s\n", config_linenr
, config_file_name
);
298 static int parse_unit_factor(const char *end
, unsigned long *val
)
302 else if (!strcasecmp(end
, "k")) {
306 else if (!strcasecmp(end
, "m")) {
310 else if (!strcasecmp(end
, "g")) {
311 *val
*= 1024 * 1024 * 1024;
317 static int perf_parse_llong(const char *value
, long long *ret
)
319 if (value
&& *value
) {
321 long long val
= strtoll(value
, &end
, 0);
322 unsigned long factor
= 1;
324 if (!parse_unit_factor(end
, &factor
))
332 static int perf_parse_long(const char *value
, long *ret
)
334 if (value
&& *value
) {
336 long val
= strtol(value
, &end
, 0);
337 unsigned long factor
= 1;
338 if (!parse_unit_factor(end
, &factor
))
346 static void bad_config(const char *name
)
348 if (config_file_name
)
349 pr_warning("bad config value for '%s' in %s, ignoring...\n", name
, config_file_name
);
351 pr_warning("bad config value for '%s', ignoring...\n", name
);
354 int perf_config_u64(u64
*dest
, const char *name
, const char *value
)
358 if (!perf_parse_llong(value
, &ret
)) {
367 int perf_config_int(int *dest
, const char *name
, const char *value
)
370 if (!perf_parse_long(value
, &ret
)) {
378 int perf_config_u8(u8
*dest
, const char *name
, const char *value
)
382 if (!perf_parse_long(value
, &ret
)) {
390 static int perf_config_bool_or_int(const char *name
, const char *value
, int *is_bool
)
399 if (!strcasecmp(value
, "true") || !strcasecmp(value
, "yes") || !strcasecmp(value
, "on"))
401 if (!strcasecmp(value
, "false") || !strcasecmp(value
, "no") || !strcasecmp(value
, "off"))
404 return perf_config_int(&ret
, name
, value
) < 0 ? -1 : ret
;
407 int perf_config_bool(const char *name
, const char *value
)
410 return !!perf_config_bool_or_int(name
, value
, &discard
);
413 static const char *perf_config_dirname(const char *name
, const char *value
)
420 static int perf_buildid_config(const char *var
, const char *value
)
422 /* same dir for all commands */
423 if (!strcmp(var
, "buildid.dir")) {
424 const char *dir
= perf_config_dirname(var
, value
);
427 pr_err("Invalid buildid directory!\n");
430 strncpy(buildid_dir
, dir
, MAXPATHLEN
-1);
431 buildid_dir
[MAXPATHLEN
-1] = '\0';
437 static int perf_default_core_config(const char *var
, const char *value
)
439 if (!strcmp(var
, "core.proc-map-timeout"))
440 proc_map_timeout
= strtoul(value
, NULL
, 10);
442 if (!strcmp(var
, "core.addr2line-timeout"))
443 addr2line_timeout_ms
= strtoul(value
, NULL
, 10);
445 /* Add other config variables here. */
449 static int perf_ui_config(const char *var
, const char *value
)
451 /* Add other config variables here. */
452 if (!strcmp(var
, "ui.show-headers"))
453 symbol_conf
.show_hist_headers
= perf_config_bool(var
, value
);
458 static int perf_stat_config(const char *var
, const char *value
)
460 if (!strcmp(var
, "stat.big-num"))
461 perf_stat__set_big_num(perf_config_bool(var
, value
));
463 if (!strcmp(var
, "stat.no-csv-summary"))
464 perf_stat__set_no_csv_summary(perf_config_bool(var
, value
));
466 if (!strcmp(var
, "stat.bpf-counter-events"))
467 evsel__bpf_counter_events
= strdup(value
);
469 /* Add other config variables here. */
473 int perf_default_config(const char *var
, const char *value
,
474 void *dummy __maybe_unused
)
476 if (strstarts(var
, "core."))
477 return perf_default_core_config(var
, value
);
479 if (strstarts(var
, "hist."))
480 return perf_hist_config(var
, value
);
482 if (strstarts(var
, "ui."))
483 return perf_ui_config(var
, value
);
485 if (strstarts(var
, "call-graph."))
486 return perf_callchain_config(var
, value
);
488 if (strstarts(var
, "buildid."))
489 return perf_buildid_config(var
, value
);
491 if (strstarts(var
, "stat."))
492 return perf_stat_config(var
, value
);
494 /* Add other config variables here. */
498 static int perf_config_from_file(config_fn_t fn
, const char *filename
, void *data
)
501 FILE *f
= fopen(filename
, "r");
506 config_file_name
= filename
;
509 ret
= perf_parse_file(fn
, data
);
511 config_file_name
= NULL
;
516 const char *perf_etc_perfconfig(void)
518 static const char *system_wide
;
520 system_wide
= system_path(ETC_PERFCONFIG
);
524 static int perf_env_bool(const char *k
, int def
)
526 const char *v
= getenv(k
);
527 return v
? perf_config_bool(k
, v
) : def
;
530 int perf_config_system(void)
532 return !perf_env_bool("PERF_CONFIG_NOSYSTEM", 0);
535 int perf_config_global(void)
537 return !perf_env_bool("PERF_CONFIG_NOGLOBAL", 0);
540 static char *home_perfconfig(void)
542 const char *home
= NULL
;
547 home
= getenv("HOME");
550 * Skip reading user config if:
551 * - there is no place to read it from (HOME)
552 * - we are asked not to (PERF_CONFIG_NOGLOBAL=1)
554 if (!home
|| !*home
|| !perf_config_global())
557 config
= strdup(mkpath(path
, sizeof(path
), "%s/.perfconfig", home
));
558 if (config
== NULL
) {
559 pr_warning("Not enough memory to process %s/.perfconfig, ignoring it.\n", home
);
563 if (stat(config
, &st
) < 0)
566 if (st
.st_uid
&& (st
.st_uid
!= geteuid())) {
567 pr_warning("File %s not owned by current user or root, ignoring it.\n", config
);
579 const char *perf_home_perfconfig(void)
581 static const char *config
;
584 if (failed
|| config
)
587 config
= home_perfconfig();
594 static struct perf_config_section
*find_section(struct list_head
*sections
,
595 const char *section_name
)
597 struct perf_config_section
*section
;
599 list_for_each_entry(section
, sections
, node
)
600 if (!strcmp(section
->name
, section_name
))
606 static struct perf_config_item
*find_config_item(const char *name
,
607 struct perf_config_section
*section
)
609 struct perf_config_item
*item
;
611 list_for_each_entry(item
, §ion
->items
, node
)
612 if (!strcmp(item
->name
, name
))
618 static struct perf_config_section
*add_section(struct list_head
*sections
,
619 const char *section_name
)
621 struct perf_config_section
*section
= zalloc(sizeof(*section
));
626 INIT_LIST_HEAD(§ion
->items
);
627 section
->name
= strdup(section_name
);
628 if (!section
->name
) {
629 pr_debug("%s: strdup failed\n", __func__
);
634 list_add_tail(§ion
->node
, sections
);
638 static struct perf_config_item
*add_config_item(struct perf_config_section
*section
,
641 struct perf_config_item
*item
= zalloc(sizeof(*item
));
646 item
->name
= strdup(name
);
648 pr_debug("%s: strdup failed\n", __func__
);
653 list_add_tail(&item
->node
, §ion
->items
);
657 static int set_value(struct perf_config_item
*item
, const char *value
)
659 char *val
= strdup(value
);
669 static int collect_config(const char *var
, const char *value
,
670 void *perf_config_set
)
674 char *section_name
, *name
;
675 struct perf_config_section
*section
= NULL
;
676 struct perf_config_item
*item
= NULL
;
677 struct perf_config_set
*set
= perf_config_set
;
678 struct list_head
*sections
;
683 sections
= &set
->sections
;
684 key
= ptr
= strdup(var
);
686 pr_debug("%s: strdup failed\n", __func__
);
690 section_name
= strsep(&ptr
, ".");
692 if (name
== NULL
|| value
== NULL
)
695 section
= find_section(sections
, section_name
);
697 section
= add_section(sections
, section_name
);
702 item
= find_config_item(name
, section
);
704 item
= add_config_item(section
, name
);
709 /* perf_config_set can contain both user and system config items.
710 * So we should know where each value is from.
711 * The classification would be needed when a particular config file
712 * is overwritten by setting feature i.e. set_config().
714 if (strcmp(config_file_name
, perf_etc_perfconfig()) == 0) {
715 section
->from_system_config
= true;
716 item
->from_system_config
= true;
718 section
->from_system_config
= false;
719 item
->from_system_config
= false;
722 ret
= set_value(item
, value
);
729 int perf_config_set__collect(struct perf_config_set
*set
, const char *file_name
,
730 const char *var
, const char *value
)
732 config_file_name
= file_name
;
733 return collect_config(var
, value
, set
);
736 static int perf_config_set__init(struct perf_config_set
*set
)
740 /* Setting $PERF_CONFIG makes perf read _only_ the given config file. */
741 if (config_exclusive_filename
)
742 return perf_config_from_file(collect_config
, config_exclusive_filename
, set
);
743 if (perf_config_system() && !access(perf_etc_perfconfig(), R_OK
)) {
744 if (perf_config_from_file(collect_config
, perf_etc_perfconfig(), set
) < 0)
747 if (perf_config_global() && perf_home_perfconfig()) {
748 if (perf_config_from_file(collect_config
, perf_home_perfconfig(), set
) < 0)
756 struct perf_config_set
*perf_config_set__new(void)
758 struct perf_config_set
*set
= zalloc(sizeof(*set
));
761 INIT_LIST_HEAD(&set
->sections
);
762 perf_config_set__init(set
);
768 struct perf_config_set
*perf_config_set__load_file(const char *file
)
770 struct perf_config_set
*set
= zalloc(sizeof(*set
));
773 INIT_LIST_HEAD(&set
->sections
);
774 perf_config_from_file(collect_config
, file
, set
);
780 static int perf_config__init(void)
782 if (config_set
== NULL
)
783 config_set
= perf_config_set__new();
785 return config_set
== NULL
;
788 int perf_config_set(struct perf_config_set
*set
,
789 config_fn_t fn
, void *data
)
793 struct perf_config_section
*section
;
794 struct perf_config_item
*item
;
796 perf_config_set__for_each_entry(set
, section
, item
) {
797 char *value
= item
->value
;
800 scnprintf(key
, sizeof(key
), "%s.%s",
801 section
->name
, item
->name
);
802 ret
= fn(key
, value
, data
);
804 pr_err("Error in the given config file: wrong config key-value pair %s=%s\n",
807 * Can't be just a 'break', as perf_config_set__for_each_entry()
808 * expands to two nested for() loops.
818 int perf_config(config_fn_t fn
, void *data
)
820 if (config_set
== NULL
&& perf_config__init())
823 return perf_config_set(config_set
, fn
, data
);
826 void perf_config__exit(void)
828 perf_config_set__delete(config_set
);
832 void perf_config__refresh(void)
838 static void perf_config_item__delete(struct perf_config_item
*item
)
845 static void perf_config_section__purge(struct perf_config_section
*section
)
847 struct perf_config_item
*item
, *tmp
;
849 list_for_each_entry_safe(item
, tmp
, §ion
->items
, node
) {
850 list_del_init(&item
->node
);
851 perf_config_item__delete(item
);
855 static void perf_config_section__delete(struct perf_config_section
*section
)
857 perf_config_section__purge(section
);
858 zfree(§ion
->name
);
862 static void perf_config_set__purge(struct perf_config_set
*set
)
864 struct perf_config_section
*section
, *tmp
;
866 list_for_each_entry_safe(section
, tmp
, &set
->sections
, node
) {
867 list_del_init(§ion
->node
);
868 perf_config_section__delete(section
);
872 void perf_config_set__delete(struct perf_config_set
*set
)
877 perf_config_set__purge(set
);
882 * Call this to report error for your variable that should not
883 * get a boolean value (i.e. "[my] var" means "true").
885 int config_error_nonbool(const char *var
)
887 pr_err("Missing value for '%s'", var
);
891 void set_buildid_dir(const char *dir
)
894 scnprintf(buildid_dir
, MAXPATHLEN
, "%s", dir
);
896 /* default to $HOME/.debug */
897 if (buildid_dir
[0] == '\0') {
898 char *home
= getenv("HOME");
901 snprintf(buildid_dir
, MAXPATHLEN
, "%s/%s",
902 home
, DEBUG_CACHE_DIR
);
904 strncpy(buildid_dir
, DEBUG_CACHE_DIR
, MAXPATHLEN
-1);
906 buildid_dir
[MAXPATHLEN
-1] = '\0';
908 /* for communicating with external commands */
909 setenv("PERF_BUILDID_DIR", buildid_dir
, 1);
912 struct perf_config_scan_data
{
920 static int perf_config_scan_cb(const char *var
, const char *value
, void *data
)
922 struct perf_config_scan_data
*d
= data
;
924 if (!strcmp(var
, d
->name
))
925 d
->ret
= vsscanf(value
, d
->fmt
, d
->args
);
930 int perf_config_scan(const char *name
, const char *fmt
, ...)
932 struct perf_config_scan_data d
= {
937 va_start(d
.args
, fmt
);
938 perf_config(perf_config_scan_cb
, &d
);
944 static int perf_config_get_cb(const char *var
, const char *value
, void *data
)
946 struct perf_config_scan_data
*d
= data
;
948 if (!strcmp(var
, d
->name
))
954 const char *perf_config_get(const char *name
)
956 struct perf_config_scan_data d
= {
961 perf_config(perf_config_get_cb
, &d
);