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/llvm-utils.h" /* perf_llvm_config */
20 #include "util/stat.h" /* perf_stat__set_big_num */
24 #include <sys/types.h>
28 #include <linux/string.h>
29 #include <linux/zalloc.h>
30 #include <linux/ctype.h>
34 #define DEBUG_CACHE_DIR ".debug"
37 char buildid_dir
[MAXPATHLEN
]; /* root dir for buildid, binary cache */
39 static FILE *config_file
;
40 static const char *config_file_name
;
41 static int config_linenr
;
42 static int config_file_eof
;
43 static struct perf_config_set
*config_set
;
45 const char *config_exclusive_filename
;
47 static int get_next_char(void)
53 if ((f
= config_file
) != NULL
) {
56 /* DOS like systems */
73 static char *parse_value(void)
75 static char value
[1024];
76 int quote
= 0, comment
= 0, space
= 0;
80 int c
= get_next_char();
82 if (len
>= sizeof(value
) - 1)
92 if (isspace(c
) && !quote
) {
97 if (c
== ';' || c
== '#') {
121 /* Some characters escape as themselves */
124 /* Reject unknown escape sequences */
139 static inline int iskeychar(int c
)
141 return isalnum(c
) || c
== '-' || c
== '_';
144 static int get_value(config_fn_t fn
, void *data
, char *name
, unsigned int len
)
149 /* Get the full name */
161 while (c
== ' ' || c
== '\t')
168 value
= parse_value();
172 return fn(name
, value
, data
);
175 static int get_extended_base_var(char *name
, int baselen
, int c
)
181 } while (isspace(c
));
183 /* We require the format to be '[base "extension"]' */
186 name
[baselen
++] = '.';
189 int ch
= get_next_char();
196 ch
= get_next_char();
200 name
[baselen
++] = ch
;
201 if (baselen
> MAXNAME
/ 2)
206 if (get_next_char() != ']')
211 static int get_base_var(char *name
)
216 int c
= get_next_char();
222 return get_extended_base_var(name
, baselen
, c
);
223 if (!iskeychar(c
) && c
!= '.')
225 if (baselen
> MAXNAME
/ 2)
227 name
[baselen
++] = tolower(c
);
231 static int perf_parse_file(config_fn_t fn
, void *data
)
235 static char var
[MAXNAME
];
237 /* U+FEFF Byte Order Mark in UTF8 */
238 static const unsigned char *utf8_bom
= (unsigned char *) "\xef\xbb\xbf";
239 const unsigned char *bomptr
= utf8_bom
;
242 int line
, c
= get_next_char();
244 if (bomptr
&& *bomptr
) {
245 /* We are at the file beginning; skip UTF8-encoded BOM
246 * if present. Sane editors won't put this in on their
247 * own, but e.g. Windows Notepad will do it happily. */
248 if ((unsigned char) c
== *bomptr
) {
252 /* Do not tolerate partial BOM. */
253 if (bomptr
!= utf8_bom
)
255 /* No BOM at file beginning. Cool. */
265 if (comment
|| isspace(c
))
267 if (c
== '#' || c
== ';') {
272 baselen
= get_base_var(var
);
275 var
[baselen
++] = '.';
281 var
[baselen
] = tolower(c
);
284 * The get_value function might or might not reach the '\n',
285 * so saving the current line number for error reporting.
287 line
= config_linenr
;
288 if (get_value(fn
, data
, var
, baselen
+1) < 0) {
289 config_linenr
= line
;
293 pr_err("bad config file line %d in %s\n", config_linenr
, config_file_name
);
297 static int parse_unit_factor(const char *end
, unsigned long *val
)
301 else if (!strcasecmp(end
, "k")) {
305 else if (!strcasecmp(end
, "m")) {
309 else if (!strcasecmp(end
, "g")) {
310 *val
*= 1024 * 1024 * 1024;
316 static int perf_parse_llong(const char *value
, long long *ret
)
318 if (value
&& *value
) {
320 long long val
= strtoll(value
, &end
, 0);
321 unsigned long factor
= 1;
323 if (!parse_unit_factor(end
, &factor
))
331 static int perf_parse_long(const char *value
, long *ret
)
333 if (value
&& *value
) {
335 long val
= strtol(value
, &end
, 0);
336 unsigned long factor
= 1;
337 if (!parse_unit_factor(end
, &factor
))
345 static void bad_config(const char *name
)
347 if (config_file_name
)
348 pr_warning("bad config value for '%s' in %s, ignoring...\n", name
, config_file_name
);
350 pr_warning("bad config value for '%s', ignoring...\n", name
);
353 int perf_config_u64(u64
*dest
, const char *name
, const char *value
)
357 if (!perf_parse_llong(value
, &ret
)) {
366 int perf_config_int(int *dest
, const char *name
, const char *value
)
369 if (!perf_parse_long(value
, &ret
)) {
377 int perf_config_u8(u8
*dest
, const char *name
, const char *value
)
381 if (!perf_parse_long(value
, &ret
)) {
389 static int perf_config_bool_or_int(const char *name
, const char *value
, int *is_bool
)
398 if (!strcasecmp(value
, "true") || !strcasecmp(value
, "yes") || !strcasecmp(value
, "on"))
400 if (!strcasecmp(value
, "false") || !strcasecmp(value
, "no") || !strcasecmp(value
, "off"))
403 return perf_config_int(&ret
, name
, value
) < 0 ? -1 : ret
;
406 int perf_config_bool(const char *name
, const char *value
)
409 return !!perf_config_bool_or_int(name
, value
, &discard
);
412 static const char *perf_config_dirname(const char *name
, const char *value
)
419 static int perf_buildid_config(const char *var
, const char *value
)
421 /* same dir for all commands */
422 if (!strcmp(var
, "buildid.dir")) {
423 const char *dir
= perf_config_dirname(var
, value
);
426 pr_err("Invalid buildid directory!\n");
429 strncpy(buildid_dir
, dir
, MAXPATHLEN
-1);
430 buildid_dir
[MAXPATHLEN
-1] = '\0';
436 static int perf_default_core_config(const char *var __maybe_unused
,
437 const char *value __maybe_unused
)
439 if (!strcmp(var
, "core.proc-map-timeout"))
440 proc_map_timeout
= strtoul(value
, NULL
, 10);
442 /* Add other config variables here. */
446 static int perf_ui_config(const char *var
, const char *value
)
448 /* Add other config variables here. */
449 if (!strcmp(var
, "ui.show-headers"))
450 symbol_conf
.show_hist_headers
= perf_config_bool(var
, value
);
455 static int perf_stat_config(const char *var
, const char *value
)
457 if (!strcmp(var
, "stat.big-num"))
458 perf_stat__set_big_num(perf_config_bool(var
, value
));
460 /* Add other config variables here. */
464 int perf_default_config(const char *var
, const char *value
,
465 void *dummy __maybe_unused
)
467 if (strstarts(var
, "core."))
468 return perf_default_core_config(var
, value
);
470 if (strstarts(var
, "hist."))
471 return perf_hist_config(var
, value
);
473 if (strstarts(var
, "ui."))
474 return perf_ui_config(var
, value
);
476 if (strstarts(var
, "call-graph."))
477 return perf_callchain_config(var
, value
);
479 if (strstarts(var
, "llvm."))
480 return perf_llvm_config(var
, value
);
482 if (strstarts(var
, "buildid."))
483 return perf_buildid_config(var
, value
);
485 if (strstarts(var
, "stat."))
486 return perf_stat_config(var
, value
);
488 /* Add other config variables here. */
492 int perf_config_from_file(config_fn_t fn
, const char *filename
, void *data
)
495 FILE *f
= fopen(filename
, "r");
500 config_file_name
= filename
;
503 ret
= perf_parse_file(fn
, data
);
505 config_file_name
= NULL
;
510 const char *perf_etc_perfconfig(void)
512 static const char *system_wide
;
514 system_wide
= system_path(ETC_PERFCONFIG
);
518 static int perf_env_bool(const char *k
, int def
)
520 const char *v
= getenv(k
);
521 return v
? perf_config_bool(k
, v
) : def
;
524 static int perf_config_system(void)
526 return !perf_env_bool("PERF_CONFIG_NOSYSTEM", 0);
529 static int perf_config_global(void)
531 return !perf_env_bool("PERF_CONFIG_NOGLOBAL", 0);
534 static struct perf_config_section
*find_section(struct list_head
*sections
,
535 const char *section_name
)
537 struct perf_config_section
*section
;
539 list_for_each_entry(section
, sections
, node
)
540 if (!strcmp(section
->name
, section_name
))
546 static struct perf_config_item
*find_config_item(const char *name
,
547 struct perf_config_section
*section
)
549 struct perf_config_item
*item
;
551 list_for_each_entry(item
, §ion
->items
, node
)
552 if (!strcmp(item
->name
, name
))
558 static struct perf_config_section
*add_section(struct list_head
*sections
,
559 const char *section_name
)
561 struct perf_config_section
*section
= zalloc(sizeof(*section
));
566 INIT_LIST_HEAD(§ion
->items
);
567 section
->name
= strdup(section_name
);
568 if (!section
->name
) {
569 pr_debug("%s: strdup failed\n", __func__
);
574 list_add_tail(§ion
->node
, sections
);
578 static struct perf_config_item
*add_config_item(struct perf_config_section
*section
,
581 struct perf_config_item
*item
= zalloc(sizeof(*item
));
586 item
->name
= strdup(name
);
588 pr_debug("%s: strdup failed\n", __func__
);
593 list_add_tail(&item
->node
, §ion
->items
);
597 static int set_value(struct perf_config_item
*item
, const char *value
)
599 char *val
= strdup(value
);
609 static int collect_config(const char *var
, const char *value
,
610 void *perf_config_set
)
614 char *section_name
, *name
;
615 struct perf_config_section
*section
= NULL
;
616 struct perf_config_item
*item
= NULL
;
617 struct perf_config_set
*set
= perf_config_set
;
618 struct list_head
*sections
;
623 sections
= &set
->sections
;
624 key
= ptr
= strdup(var
);
626 pr_debug("%s: strdup failed\n", __func__
);
630 section_name
= strsep(&ptr
, ".");
632 if (name
== NULL
|| value
== NULL
)
635 section
= find_section(sections
, section_name
);
637 section
= add_section(sections
, section_name
);
642 item
= find_config_item(name
, section
);
644 item
= add_config_item(section
, name
);
649 /* perf_config_set can contain both user and system config items.
650 * So we should know where each value is from.
651 * The classification would be needed when a particular config file
652 * is overwrited by setting feature i.e. set_config().
654 if (strcmp(config_file_name
, perf_etc_perfconfig()) == 0) {
655 section
->from_system_config
= true;
656 item
->from_system_config
= true;
658 section
->from_system_config
= false;
659 item
->from_system_config
= false;
662 ret
= set_value(item
, value
);
669 int perf_config_set__collect(struct perf_config_set
*set
, const char *file_name
,
670 const char *var
, const char *value
)
672 config_file_name
= file_name
;
673 return collect_config(var
, value
, set
);
676 static int perf_config_set__init(struct perf_config_set
*set
)
679 const char *home
= NULL
;
683 /* Setting $PERF_CONFIG makes perf read _only_ the given config file. */
684 if (config_exclusive_filename
)
685 return perf_config_from_file(collect_config
, config_exclusive_filename
, set
);
686 if (perf_config_system() && !access(perf_etc_perfconfig(), R_OK
)) {
687 if (perf_config_from_file(collect_config
, perf_etc_perfconfig(), set
) < 0)
691 home
= getenv("HOME");
694 * Skip reading user config if:
695 * - there is no place to read it from (HOME)
696 * - we are asked not to (PERF_CONFIG_NOGLOBAL=1)
698 if (!home
|| !*home
|| !perf_config_global())
701 user_config
= strdup(mkpath("%s/.perfconfig", home
));
702 if (user_config
== NULL
) {
703 pr_warning("Not enough memory to process %s/.perfconfig, ignoring it.", home
);
707 if (stat(user_config
, &st
) < 0) {
715 if (st
.st_uid
&& (st
.st_uid
!= geteuid())) {
716 pr_warning("File %s not owned by current user or root, ignoring it.", user_config
);
721 ret
= perf_config_from_file(collect_config
, user_config
, set
);
729 struct perf_config_set
*perf_config_set__new(void)
731 struct perf_config_set
*set
= zalloc(sizeof(*set
));
734 INIT_LIST_HEAD(&set
->sections
);
735 perf_config_set__init(set
);
741 static int perf_config__init(void)
743 if (config_set
== NULL
)
744 config_set
= perf_config_set__new();
746 return config_set
== NULL
;
749 int perf_config(config_fn_t fn
, void *data
)
753 struct perf_config_section
*section
;
754 struct perf_config_item
*item
;
756 if (config_set
== NULL
&& perf_config__init())
759 perf_config_set__for_each_entry(config_set
, section
, item
) {
760 char *value
= item
->value
;
763 scnprintf(key
, sizeof(key
), "%s.%s",
764 section
->name
, item
->name
);
765 ret
= fn(key
, value
, data
);
767 pr_err("Error: wrong config key-value pair %s=%s\n",
770 * Can't be just a 'break', as perf_config_set__for_each_entry()
771 * expands to two nested for() loops.
781 void perf_config__exit(void)
783 perf_config_set__delete(config_set
);
787 void perf_config__refresh(void)
793 static void perf_config_item__delete(struct perf_config_item
*item
)
800 static void perf_config_section__purge(struct perf_config_section
*section
)
802 struct perf_config_item
*item
, *tmp
;
804 list_for_each_entry_safe(item
, tmp
, §ion
->items
, node
) {
805 list_del_init(&item
->node
);
806 perf_config_item__delete(item
);
810 static void perf_config_section__delete(struct perf_config_section
*section
)
812 perf_config_section__purge(section
);
813 zfree(§ion
->name
);
817 static void perf_config_set__purge(struct perf_config_set
*set
)
819 struct perf_config_section
*section
, *tmp
;
821 list_for_each_entry_safe(section
, tmp
, &set
->sections
, node
) {
822 list_del_init(§ion
->node
);
823 perf_config_section__delete(section
);
827 void perf_config_set__delete(struct perf_config_set
*set
)
832 perf_config_set__purge(set
);
837 * Call this to report error for your variable that should not
838 * get a boolean value (i.e. "[my] var" means "true").
840 int config_error_nonbool(const char *var
)
842 pr_err("Missing value for '%s'", var
);
846 void set_buildid_dir(const char *dir
)
849 scnprintf(buildid_dir
, MAXPATHLEN
, "%s", dir
);
851 /* default to $HOME/.debug */
852 if (buildid_dir
[0] == '\0') {
853 char *home
= getenv("HOME");
856 snprintf(buildid_dir
, MAXPATHLEN
, "%s/%s",
857 home
, DEBUG_CACHE_DIR
);
859 strncpy(buildid_dir
, DEBUG_CACHE_DIR
, MAXPATHLEN
-1);
861 buildid_dir
[MAXPATHLEN
-1] = '\0';
863 /* for communicating with external commands */
864 setenv("PERF_BUILDID_DIR", buildid_dir
, 1);