[mirror_ubuntu-focal-kernel.git] / tools / perf / util / config.c

// SPDX-License-Identifier: GPL-2.0
/*
 * config.c
 *
 * Helper functions for parsing config items.
 * Originally copied from GIT source.
 *
 * Copyright (C) Linus Torvalds, 2005
 * Copyright (C) Johannes Schindelin, 2005
 *
 */
#include <errno.h>
#include <sys/param.h>
#include "cache.h"
#include "callchain.h"
#include <subcmd/exec-cmd.h>
#include "util/event.h"  /* proc_map_timeout */
#include "util/hist.h"  /* perf_hist_config */
#include "util/llvm-utils.h"   /* perf_llvm_config */
#include "config.h"
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
#include <linux/string.h>
#include <linux/zalloc.h>
#include <linux/ctype.h>

#define MAXNAME (256)

#define DEBUG_CACHE_DIR ".debug"


char buildid_dir[MAXPATHLEN]; /* root dir for buildid, binary cache */

static FILE *config_file;
static const char *config_file_name;
static int config_linenr;
static int config_file_eof;
static struct perf_config_set *config_set;

const char *config_exclusive_filename;

static int get_next_char(void)
{
	int c;
	FILE *f;

	c = '\n';
	if ((f = config_file) != NULL) {
		c = fgetc(f);
		if (c == '\r') {
			/* DOS like systems */
			c = fgetc(f);
			if (c != '\n') {
				ungetc(c, f);
				c = '\r';
			}
		}
		if (c == '\n')
			config_linenr++;
		if (c == EOF) {
			config_file_eof = 1;
			c = '\n';
		}
	}
	return c;
}

static char *parse_value(void)
{
	static char value[1024];
	int quote = 0, comment = 0, space = 0;
	size_t len = 0;

	for (;;) {
		int c = get_next_char();

		if (len >= sizeof(value) - 1)
			return NULL;
		if (c == '\n') {
			if (quote)
				return NULL;
			value[len] = 0;
			return value;
		}
		if (comment)
			continue;
		if (isspace(c) && !quote) {
			space = 1;
			continue;
		}
		if (!quote) {
			if (c == ';' || c == '#') {
				comment = 1;
				continue;
			}
		}
		if (space) {
			if (len)
				value[len++] = ' ';
			space = 0;
		}
		if (c == '\\') {
			c = get_next_char();
			switch (c) {
			case '\n':
				continue;
			case 't':
				c = '\t';
				break;
			case 'b':
				c = '\b';
				break;
			case 'n':
				c = '\n';
				break;
			/* Some characters escape as themselves */
			case '\\': case '"':
				break;
			/* Reject unknown escape sequences */
			default:
				return NULL;
			}
			value[len++] = c;
			continue;
		}
		if (c == '"') {
			quote = 1-quote;
			continue;
		}
		value[len++] = c;
	}
}

static inline int iskeychar(int c)
{
	return isalnum(c) || c == '-' || c == '_';
}

static int get_value(config_fn_t fn, void *data, char *name, unsigned int len)
{
	int c;
	char *value;

	/* Get the full name */
	for (;;) {
		c = get_next_char();
		if (config_file_eof)
			break;
		if (!iskeychar(c))
			break;
		name[len++] = c;
		if (len >= MAXNAME)
			return -1;
	}
	name[len] = 0;
	while (c == ' ' || c == '\t')
		c = get_next_char();

	value = NULL;
	if (c != '\n') {
		if (c != '=')
			return -1;
		value = parse_value();
		if (!value)
			return -1;
	}
	return fn(name, value, data);
}

static int get_extended_base_var(char *name, int baselen, int c)
{
	do {
		if (c == '\n')
			return -1;
		c = get_next_char();
	} while (isspace(c));

	/* We require the format to be '[base "extension"]' */
	if (c != '"')
		return -1;
	name[baselen++] = '.';

	for (;;) {
		int ch = get_next_char();

		if (ch == '\n')
			return -1;
		if (ch == '"')
			break;
		if (ch == '\\') {
			ch = get_next_char();
			if (ch == '\n')
				return -1;
		}
		name[baselen++] = ch;
		if (baselen > MAXNAME / 2)
			return -1;
	}

	/* Final ']' */
	if (get_next_char() != ']')
		return -1;
	return baselen;
}

static int get_base_var(char *name)
{
	int baselen = 0;

	for (;;) {
		int c = get_next_char();
		if (config_file_eof)
			return -1;
		if (c == ']')
			return baselen;
		if (isspace(c))
			return get_extended_base_var(name, baselen, c);
		if (!iskeychar(c) && c != '.')
			return -1;
		if (baselen > MAXNAME / 2)
			return -1;
		name[baselen++] = tolower(c);
	}
}

static int perf_parse_file(config_fn_t fn, void *data)
{
	int comment = 0;
	int baselen = 0;
	static char var[MAXNAME];

	/* U+FEFF Byte Order Mark in UTF8 */
	static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
	const unsigned char *bomptr = utf8_bom;

	for (;;) {
		int line, c = get_next_char();

		if (bomptr && *bomptr) {
			/* We are at the file beginning; skip UTF8-encoded BOM
			 * if present. Sane editors won't put this in on their
			 * own, but e.g. Windows Notepad will do it happily. */
			if ((unsigned char) c == *bomptr) {
				bomptr++;
				continue;
			} else {
				/* Do not tolerate partial BOM. */
				if (bomptr != utf8_bom)
					break;
				/* No BOM at file beginning. Cool. */
				bomptr = NULL;
			}
		}
		if (c == '\n') {
			if (config_file_eof)
				return 0;
			comment = 0;
			continue;
		}
		if (comment || isspace(c))
			continue;
		if (c == '#' || c == ';') {
			comment = 1;
			continue;
		}
		if (c == '[') {
			baselen = get_base_var(var);
			if (baselen <= 0)
				break;
			var[baselen++] = '.';
			var[baselen] = 0;
			continue;
		}
		if (!isalpha(c))
			break;
		var[baselen] = tolower(c);

		/*
		 * The get_value function might or might not reach the '\n',
		 * so saving the current line number for error reporting.
		 */
		line = config_linenr;
		if (get_value(fn, data, var, baselen+1) < 0) {
			config_linenr = line;
			break;
		}
	}
	pr_err("bad config file line %d in %s\n", config_linenr, config_file_name);
	return -1;
}

static int parse_unit_factor(const char *end, unsigned long *val)
{
	if (!*end)
		return 1;
	else if (!strcasecmp(end, "k")) {
		*val *= 1024;
		return 1;
	}
	else if (!strcasecmp(end, "m")) {
		*val *= 1024 * 1024;
		return 1;
	}
	else if (!strcasecmp(end, "g")) {
		*val *= 1024 * 1024 * 1024;
		return 1;
	}
	return 0;
}

static int perf_parse_llong(const char *value, long long *ret)
{
	if (value && *value) {
		char *end;
		long long val = strtoll(value, &end, 0);
		unsigned long factor = 1;

		if (!parse_unit_factor(end, &factor))
			return 0;
		*ret = val * factor;
		return 1;
	}
	return 0;
}

static int perf_parse_long(const char *value, long *ret)
{
	if (value && *value) {
		char *end;
		long val = strtol(value, &end, 0);
		unsigned long factor = 1;
		if (!parse_unit_factor(end, &factor))
			return 0;
		*ret = val * factor;
		return 1;
	}
	return 0;
}

static void bad_config(const char *name)
{
	if (config_file_name)
		pr_warning("bad config value for '%s' in %s, ignoring...\n", name, config_file_name);
	else
		pr_warning("bad config value for '%s', ignoring...\n", name);
}

int perf_config_u64(u64 *dest, const char *name, const char *value)
{
	long long ret = 0;

	if (!perf_parse_llong(value, &ret)) {
		bad_config(name);
		return -1;
	}

	*dest = ret;
	return 0;
}

int perf_config_int(int *dest, const char *name, const char *value)
{
	long ret = 0;
	if (!perf_parse_long(value, &ret)) {
		bad_config(name);
		return -1;
	}
	*dest = ret;
	return 0;
}

static int perf_config_bool_or_int(const char *name, const char *value, int *is_bool)
{
	int ret;

	*is_bool = 1;
	if (!value)
		return 1;
	if (!*value)
		return 0;
	if (!strcasecmp(value, "true") || !strcasecmp(value, "yes") || !strcasecmp(value, "on"))
		return 1;
	if (!strcasecmp(value, "false") || !strcasecmp(value, "no") || !strcasecmp(value, "off"))
		return 0;
	*is_bool = 0;
	return perf_config_int(&ret, name, value) < 0 ? -1 : ret;
}

int perf_config_bool(const char *name, const char *value)
{
	int discard;
	return !!perf_config_bool_or_int(name, value, &discard);
}

static const char *perf_config_dirname(const char *name, const char *value)
{
	if (!name)
		return NULL;
	return value;
}

static int perf_buildid_config(const char *var, const char *value)
{
	/* same dir for all commands */
	if (!strcmp(var, "buildid.dir")) {
		const char *dir = perf_config_dirname(var, value);

		if (!dir) {
			pr_err("Invalid buildid directory!\n");
			return -1;
		}
		strncpy(buildid_dir, dir, MAXPATHLEN-1);
		buildid_dir[MAXPATHLEN-1] = '\0';
	}

	return 0;
}

static int perf_default_core_config(const char *var __maybe_unused,
				    const char *value __maybe_unused)
{
	if (!strcmp(var, "core.proc-map-timeout"))
		proc_map_timeout = strtoul(value, NULL, 10);

	/* Add other config variables here. */
	return 0;
}

static int perf_ui_config(const char *var, const char *value)
{
	/* Add other config variables here. */
	if (!strcmp(var, "ui.show-headers"))
		symbol_conf.show_hist_headers = perf_config_bool(var, value);

	return 0;
}

int perf_default_config(const char *var, const char *value,
			void *dummy __maybe_unused)
{
	if (strstarts(var, "core."))
		return perf_default_core_config(var, value);

	if (strstarts(var, "hist."))
		return perf_hist_config(var, value);

	if (strstarts(var, "ui."))
		return perf_ui_config(var, value);

	if (strstarts(var, "call-graph."))
		return perf_callchain_config(var, value);

	if (strstarts(var, "llvm."))
		return perf_llvm_config(var, value);

	if (strstarts(var, "buildid."))
		return perf_buildid_config(var, value);

	/* Add other config variables here. */
	return 0;
}

static int perf_config_from_file(config_fn_t fn, const char *filename, void *data)
{
	int ret;
	FILE *f = fopen(filename, "r");

	ret = -1;
	if (f) {
		config_file = f;
		config_file_name = filename;
		config_linenr = 1;
		config_file_eof = 0;
		ret = perf_parse_file(fn, data);
		fclose(f);
		config_file_name = NULL;
	}
	return ret;
}

const char *perf_etc_perfconfig(void)
{
	static const char *system_wide;
	if (!system_wide)
		system_wide = system_path(ETC_PERFCONFIG);
	return system_wide;
}

static int perf_env_bool(const char *k, int def)
{
	const char *v = getenv(k);
	return v ? perf_config_bool(k, v) : def;
}

static int perf_config_system(void)
{
	return !perf_env_bool("PERF_CONFIG_NOSYSTEM", 0);
}

static int perf_config_global(void)
{
	return !perf_env_bool("PERF_CONFIG_NOGLOBAL", 0);
}

static struct perf_config_section *find_section(struct list_head *sections,
						const char *section_name)
{
	struct perf_config_section *section;

	list_for_each_entry(section, sections, node)
		if (!strcmp(section->name, section_name))
			return section;

	return NULL;
}

static struct perf_config_item *find_config_item(const char *name,
						 struct perf_config_section *section)
{
	struct perf_config_item *item;

	list_for_each_entry(item, &section->items, node)
		if (!strcmp(item->name, name))
			return item;

	return NULL;
}

static struct perf_config_section *add_section(struct list_head *sections,
					       const char *section_name)
{
	struct perf_config_section *section = zalloc(sizeof(*section));

	if (!section)
		return NULL;

	INIT_LIST_HEAD(&section->items);
	section->name = strdup(section_name);
	if (!section->name) {
		pr_debug("%s: strdup failed\n", __func__);
		free(section);
		return NULL;
	}

	list_add_tail(&section->node, sections);
	return section;
}

static struct perf_config_item *add_config_item(struct perf_config_section *section,
						const char *name)
{
	struct perf_config_item *item = zalloc(sizeof(*item));

	if (!item)
		return NULL;

	item->name = strdup(name);
	if (!item->name) {
		pr_debug("%s: strdup failed\n", __func__);
		free(item);
		return NULL;
	}

	list_add_tail(&item->node, &section->items);
	return item;
}

static int set_value(struct perf_config_item *item, const char *value)
{
	char *val = strdup(value);

	if (!val)
		return -1;

	zfree(&item->value);
	item->value = val;
	return 0;
}

static int collect_config(const char *var, const char *value,
			  void *perf_config_set)
{
	int ret = -1;
	char *ptr, *key;
	char *section_name, *name;
	struct perf_config_section *section = NULL;
	struct perf_config_item *item = NULL;
	struct perf_config_set *set = perf_config_set;
	struct list_head *sections;

	if (set == NULL)
		return -1;

	sections = &set->sections;
	key = ptr = strdup(var);
	if (!key) {
		pr_debug("%s: strdup failed\n", __func__);
		return -1;
	}

	section_name = strsep(&ptr, ".");
	name = ptr;
	if (name == NULL || value == NULL)
		goto out_free;

	section = find_section(sections, section_name);
	if (!section) {
		section = add_section(sections, section_name);
		if (!section)
			goto out_free;
	}

	item = find_config_item(name, section);
	if (!item) {
		item = add_config_item(section, name);
		if (!item)
			goto out_free;
	}

	/* perf_config_set can contain both user and system config items.
	 * So we should know where each value is from.
	 * The classification would be needed when a particular config file
	 * is overwrited by setting feature i.e. set_config().
	 */
	if (strcmp(config_file_name, perf_etc_perfconfig()) == 0) {
		section->from_system_config = true;
		item->from_system_config = true;
	} else {
		section->from_system_config = false;
		item->from_system_config = false;
	}

	ret = set_value(item, value);

out_free:
	free(key);
	return ret;
}

int perf_config_set__collect(struct perf_config_set *set, const char *file_name,
			     const char *var, const char *value)
{
	config_file_name = file_name;
	return collect_config(var, value, set);
}

static int perf_config_set__init(struct perf_config_set *set)
{
	int ret = -1;
	const char *home = NULL;
	char *user_config;
	struct stat st;

	/* Setting $PERF_CONFIG makes perf read _only_ the given config file. */
	if (config_exclusive_filename)
		return perf_config_from_file(collect_config, config_exclusive_filename, set);
	if (perf_config_system() && !access(perf_etc_perfconfig(), R_OK)) {
		if (perf_config_from_file(collect_config, perf_etc_perfconfig(), set) < 0)
			goto out;
	}

	home = getenv("HOME");

	/*
	 * Skip reading user config if:
	 *   - there is no place to read it from (HOME)
	 *   - we are asked not to (PERF_CONFIG_NOGLOBAL=1)
	 */
	if (!home || !*home || !perf_config_global())
		return 0;

	user_config = strdup(mkpath("%s/.perfconfig", home));
	if (user_config == NULL) {
		pr_warning("Not enough memory to process %s/.perfconfig, ignoring it.", home);
		goto out;
	}

	if (stat(user_config, &st) < 0) {
		if (errno == ENOENT)
			ret = 0;
		goto out_free;
	}

	ret = 0;

	if (st.st_uid && (st.st_uid != geteuid())) {
		pr_warning("File %s not owned by current user or root, ignoring it.", user_config);
		goto out_free;
	}

	if (st.st_size)
		ret = perf_config_from_file(collect_config, user_config, set);

out_free:
	free(user_config);
out:
	return ret;
}

struct perf_config_set *perf_config_set__new(void)
{
	struct perf_config_set *set = zalloc(sizeof(*set));

	if (set) {
		INIT_LIST_HEAD(&set->sections);
		perf_config_set__init(set);
	}

	return set;
}

static int perf_config__init(void)
{
	if (config_set == NULL)
		config_set = perf_config_set__new();

	return config_set == NULL;
}

int perf_config(config_fn_t fn, void *data)
{
	int ret = 0;
	char key[BUFSIZ];
	struct perf_config_section *section;
	struct perf_config_item *item;

	if (config_set == NULL && perf_config__init())
		return -1;

	perf_config_set__for_each_entry(config_set, section, item) {
		char *value = item->value;

		if (value) {
			scnprintf(key, sizeof(key), "%s.%s",
				  section->name, item->name);
			ret = fn(key, value, data);
			if (ret < 0) {
				pr_err("Error: wrong config key-value pair %s=%s\n",
				       key, value);
				/*
				 * Can't be just a 'break', as perf_config_set__for_each_entry()
				 * expands to two nested for() loops.
				 */
				goto out;
			}
		}
	}
out:
	return ret;
}

void perf_config__exit(void)
{
	perf_config_set__delete(config_set);
	config_set = NULL;
}

void perf_config__refresh(void)
{
	perf_config__exit();
	perf_config__init();
}

static void perf_config_item__delete(struct perf_config_item *item)
{
	zfree(&item->name);
	zfree(&item->value);
	free(item);
}

static void perf_config_section__purge(struct perf_config_section *section)
{
	struct perf_config_item *item, *tmp;

	list_for_each_entry_safe(item, tmp, &section->items, node) {
		list_del_init(&item->node);
		perf_config_item__delete(item);
	}
}

static void perf_config_section__delete(struct perf_config_section *section)
{
	perf_config_section__purge(section);
	zfree(&section->name);
	free(section);
}

static void perf_config_set__purge(struct perf_config_set *set)
{
	struct perf_config_section *section, *tmp;

	list_for_each_entry_safe(section, tmp, &set->sections, node) {
		list_del_init(&section->node);
		perf_config_section__delete(section);
	}
}

void perf_config_set__delete(struct perf_config_set *set)
{
	if (set == NULL)
		return;

	perf_config_set__purge(set);
	free(set);
}

/*
 * Call this to report error for your variable that should not
 * get a boolean value (i.e. "[my] var" means "true").
 */
int config_error_nonbool(const char *var)
{
	pr_err("Missing value for '%s'", var);
	return -1;
}

void set_buildid_dir(const char *dir)
{
	if (dir)
		scnprintf(buildid_dir, MAXPATHLEN, "%s", dir);

	/* default to $HOME/.debug */
	if (buildid_dir[0] == '\0') {
		char *home = getenv("HOME");

		if (home) {
			snprintf(buildid_dir, MAXPATHLEN, "%s/%s",
				 home, DEBUG_CACHE_DIR);
		} else {
			strncpy(buildid_dir, DEBUG_CACHE_DIR, MAXPATHLEN-1);
		}
		buildid_dir[MAXPATHLEN-1] = '\0';
	}
	/* for communicating with external commands */
	setenv("PERF_BUILDID_DIR", buildid_dir, 1);
}
Commit	Line	Data
b2441318	1	// SPDX-License-Identifier: GPL-2.0
07800601	2	/*
5f9273d6 NK	3	* config.c
	4	*
	5	* Helper functions for parsing config items.
	6	* Originally copied from GIT source.
07800601 IM	7	*
	8	* Copyright (C) Linus Torvalds, 2005
	9	* Copyright (C) Johannes Schindelin, 2005
	10	*
	11	*/
a43783ae	12	#include <errno.h>
391e4206	13	#include <sys/param.h>
07800601	14	#include "cache.h"
b10ba7f1	15	#include "callchain.h"
4b6ab94e	16	#include <subcmd/exec-cmd.h>
3fcb10e4	17	#include "util/event.h" /* proc_map_timeout */
0b93da17	18	#include "util/hist.h" /* perf_hist_config */
aa61fd05	19	#include "util/llvm-utils.h" /* perf_llvm_config */
20105ca1	20	#include "config.h"
7a8ef4c4 ACM	21	#include <sys/types.h>
	22	#include <sys/stat.h>
	23	#include <unistd.h>
8e99b6d4	24	#include <linux/string.h>
7f7c536f	25	#include <linux/zalloc.h>
3052ba56	26	#include <linux/ctype.h>
3d689ed6	27
07800601 IM	28	#define MAXNAME (256)
07800601 IM	29
45de34bb SE	30	#define DEBUG_CACHE_DIR ".debug"
	31
	32
	33	char buildid_dir[MAXPATHLEN]; /* root dir for buildid, binary cache */
	34
07800601 IM	35	static FILE *config_file;
	36	static const char *config_file_name;
	37	static int config_linenr;
	38	static int config_file_eof;
8a0a9c7e	39	static struct perf_config_set *config_set;
07800601	40
c7ac2417	41	const char *config_exclusive_filename;
07800601 IM	42
	43	static int get_next_char(void)
	44	{
	45	int c;
	46	FILE *f;
	47
	48	c = '\n';
	49	if ((f = config_file) != NULL) {
	50	c = fgetc(f);
	51	if (c == '\r') {
	52	/* DOS like systems */
	53	c = fgetc(f);
	54	if (c != '\n') {
	55	ungetc(c, f);
	56	c = '\r';
	57	}
	58	}
	59	if (c == '\n')
	60	config_linenr++;
	61	if (c == EOF) {
	62	config_file_eof = 1;
	63	c = '\n';
	64	}
	65	}
	66	return c;
	67	}
	68
	69	static char *parse_value(void)
	70	{
	71	static char value[1024];
f37a291c IM	72	int quote = 0, comment = 0, space = 0;
f37a291c IM	73	size_t len = 0;
07800601 IM	74
	75	for (;;) {
	76	int c = get_next_char();
f37a291c	77
07800601 IM	78	if (len >= sizeof(value) - 1)
	79	return NULL;
	80	if (c == '\n') {
	81	if (quote)
	82	return NULL;
	83	value[len] = 0;
	84	return value;
	85	}
	86	if (comment)
	87	continue;
	88	if (isspace(c) && !quote) {
	89	space = 1;
	90	continue;
	91	}
	92	if (!quote) {
	93	if (c == ';' \|\| c == '#') {
	94	comment = 1;
	95	continue;
	96	}
	97	}
	98	if (space) {
	99	if (len)
	100	value[len++] = ' ';
	101	space = 0;
	102	}
	103	if (c == '\\') {
	104	c = get_next_char();
	105	switch (c) {
	106	case '\n':
	107	continue;
	108	case 't':
	109	c = '\t';
	110	break;
	111	case 'b':
	112	c = '\b';
	113	break;
	114	case 'n':
	115	c = '\n';
	116	break;
	117	/* Some characters escape as themselves */
	118	case '\\': case '"':
	119	break;
	120	/* Reject unknown escape sequences */
	121	default:
	122	return NULL;
	123	}
	124	value[len++] = c;
	125	continue;
	126	}
	127	if (c == '"') {
	128	quote = 1-quote;
	129	continue;
	130	}
	131	value[len++] = c;
	132	}
	133	}
	134
	135	static inline int iskeychar(int c)
	136	{
8dc7c651	137	return isalnum(c) \|\| c == '-' \|\| c == '_';
07800601 IM	138	}
	139
	140	static int get_value(config_fn_t fn, void data, char name, unsigned int len)
	141	{
	142	int c;
	143	char *value;
	144
	145	/* Get the full name */
	146	for (;;) {
	147	c = get_next_char();
	148	if (config_file_eof)
	149	break;
	150	if (!iskeychar(c))
	151	break;
45de34bb	152	name[len++] = c;
07800601 IM	153	if (len >= MAXNAME)
	154	return -1;
	155	}
	156	name[len] = 0;
	157	while (c == ' ' \|\| c == '\t')
	158	c = get_next_char();
	159
	160	value = NULL;
	161	if (c != '\n') {
	162	if (c != '=')
	163	return -1;
	164	value = parse_value();
	165	if (!value)
	166	return -1;
	167	}
	168	return fn(name, value, data);
	169	}
	170
	171	static int get_extended_base_var(char *name, int baselen, int c)
	172	{
	173	do {
	174	if (c == '\n')
	175	return -1;
	176	c = get_next_char();
	177	} while (isspace(c));
	178
	179	/* We require the format to be '[base "extension"]' */
	180	if (c != '"')
	181	return -1;
	182	name[baselen++] = '.';
	183
	184	for (;;) {
83a0944f IM	185	int ch = get_next_char();
	186
	187	if (ch == '\n')
07800601	188	return -1;
83a0944f	189	if (ch == '"')
07800601	190	break;
83a0944f IM	191	if (ch == '\\') {
	192	ch = get_next_char();
	193	if (ch == '\n')
07800601 IM	194	return -1;
07800601 IM	195	}
83a0944f	196	name[baselen++] = ch;
07800601 IM	197	if (baselen > MAXNAME / 2)
	198	return -1;
	199	}
	200
	201	/* Final ']' */
	202	if (get_next_char() != ']')
	203	return -1;
	204	return baselen;
	205	}
	206
	207	static int get_base_var(char *name)
	208	{
	209	int baselen = 0;
	210
	211	for (;;) {
	212	int c = get_next_char();
	213	if (config_file_eof)
	214	return -1;
	215	if (c == ']')
	216	return baselen;
	217	if (isspace(c))
	218	return get_extended_base_var(name, baselen, c);
	219	if (!iskeychar(c) && c != '.')
	220	return -1;
	221	if (baselen > MAXNAME / 2)
	222	return -1;
	223	name[baselen++] = tolower(c);
	224	}
	225	}
	226
	227	static int perf_parse_file(config_fn_t fn, void *data)
	228	{
	229	int comment = 0;
	230	int baselen = 0;
	231	static char var[MAXNAME];
	232
	233	/* U+FEFF Byte Order Mark in UTF8 */
	234	static const unsigned char utf8_bom = (unsigned char ) "\xef\xbb\xbf";
	235	const unsigned char *bomptr = utf8_bom;
	236
	237	for (;;) {
49757c9c JO	238	int line, c = get_next_char();
49757c9c JO	239
07800601 IM	240	if (bomptr && *bomptr) {
	241	/* We are at the file beginning; skip UTF8-encoded BOM
	242	* if present. Sane editors won't put this in on their
	243	* own, but e.g. Windows Notepad will do it happily. */
	244	if ((unsigned char) c == *bomptr) {
	245	bomptr++;
	246	continue;
	247	} else {
	248	/* Do not tolerate partial BOM. */
	249	if (bomptr != utf8_bom)
	250	break;
	251	/* No BOM at file beginning. Cool. */
	252	bomptr = NULL;
	253	}
	254	}
	255	if (c == '\n') {
	256	if (config_file_eof)
	257	return 0;
	258	comment = 0;
	259	continue;
	260	}
	261	if (comment \|\| isspace(c))
	262	continue;
	263	if (c == '#' \|\| c == ';') {
	264	comment = 1;
	265	continue;
	266	}
	267	if (c == '[') {
	268	baselen = get_base_var(var);
	269	if (baselen <= 0)
	270	break;
	271	var[baselen++] = '.';
	272	var[baselen] = 0;
	273	continue;
	274	}
	275	if (!isalpha(c))
	276	break;
	277	var[baselen] = tolower(c);
49757c9c JO	278
	279	/*
	280	* The get_value function might or might not reach the '\n',
	281	* so saving the current line number for error reporting.
	282	*/
	283	line = config_linenr;
	284	if (get_value(fn, data, var, baselen+1) < 0) {
	285	config_linenr = line;
07800601	286	break;
49757c9c	287	}
07800601	288	}
78f71c99 TS	289	pr_err("bad config file line %d in %s\n", config_linenr, config_file_name);
78f71c99 TS	290	return -1;
07800601 IM	291	}
	292
	293	static int parse_unit_factor(const char end, unsigned long val)
	294	{
	295	if (!*end)
	296	return 1;
	297	else if (!strcasecmp(end, "k")) {
	298	val = 1024;
	299	return 1;
	300	}
	301	else if (!strcasecmp(end, "m")) {
	302	val = 1024 * 1024;
	303	return 1;
	304	}
	305	else if (!strcasecmp(end, "g")) {
	306	val = 1024 * 1024 * 1024;
	307	return 1;
	308	}
	309	return 0;
	310	}
	311
94c0655f JO	312	static int perf_parse_llong(const char value, long long ret)
	313	{
	314	if (value && *value) {
	315	char *end;
	316	long long val = strtoll(value, &end, 0);
	317	unsigned long factor = 1;
	318
	319	if (!parse_unit_factor(end, &factor))
	320	return 0;
	321	ret = val factor;
	322	return 1;
	323	}
	324	return 0;
	325	}
	326
07800601 IM	327	static int perf_parse_long(const char value, long ret)
	328	{
	329	if (value && *value) {
	330	char *end;
	331	long val = strtol(value, &end, 0);
	332	unsigned long factor = 1;
	333	if (!parse_unit_factor(end, &factor))
	334	return 0;
	335	ret = val factor;
	336	return 1;
	337	}
	338	return 0;
	339	}
	340
25ce4bb8	341	static void bad_config(const char *name)
07800601 IM	342	{
07800601 IM	343	if (config_file_name)
25ce4bb8 ACM	344	pr_warning("bad config value for '%s' in %s, ignoring...\n", name, config_file_name);
	345	else
	346	pr_warning("bad config value for '%s', ignoring...\n", name);
07800601 IM	347	}
07800601 IM	348
25ce4bb8	349	int perf_config_u64(u64 dest, const char name, const char *value)
94c0655f JO	350	{
	351	long long ret = 0;
	352
25ce4bb8 ACM	353	if (!perf_parse_llong(value, &ret)) {
	354	bad_config(name);
	355	return -1;
	356	}
	357
	358	*dest = ret;
	359	return 0;
94c0655f JO	360	}
94c0655f JO	361
25ce4bb8	362	int perf_config_int(int dest, const char name, const char *value)
07800601 IM	363	{
07800601 IM	364	long ret = 0;
25ce4bb8 ACM	365	if (!perf_parse_long(value, &ret)) {
	366	bad_config(name);
	367	return -1;
	368	}
	369	*dest = ret;
	370	return 0;
07800601 IM	371	}
07800601 IM	372
a41794cd	373	static int perf_config_bool_or_int(const char name, const char value, int *is_bool)
07800601	374	{
25ce4bb8 ACM	375	int ret;
25ce4bb8 ACM	376
07800601 IM	377	*is_bool = 1;
	378	if (!value)
	379	return 1;
	380	if (!*value)
	381	return 0;
	382	if (!strcasecmp(value, "true") \|\| !strcasecmp(value, "yes") \|\| !strcasecmp(value, "on"))
	383	return 1;
	384	if (!strcasecmp(value, "false") \|\| !strcasecmp(value, "no") \|\| !strcasecmp(value, "off"))
	385	return 0;
	386	*is_bool = 0;
25ce4bb8	387	return perf_config_int(&ret, name, value) < 0 ? -1 : ret;
07800601 IM	388	}
	389
	390	int perf_config_bool(const char name, const char value)
	391	{
	392	int discard;
	393	return !!perf_config_bool_or_int(name, value, &discard);
	394	}
	395
814b3f51	396	static const char perf_config_dirname(const char name, const char *value)
45de34bb SE	397	{
	398	if (!name)
	399	return NULL;
	400	return value;
	401	}
	402
9cb5987c TS	403	static int perf_buildid_config(const char var, const char value)
	404	{
	405	/* same dir for all commands */
	406	if (!strcmp(var, "buildid.dir")) {
d8e28654	407	const char *dir = perf_config_dirname(var, value);
9cb5987c	408
ecc4c561 ACM	409	if (!dir) {
ecc4c561 ACM	410	pr_err("Invalid buildid directory!\n");
9cb5987c	411	return -1;
ecc4c561	412	}
d8e28654	413	strncpy(buildid_dir, dir, MAXPATHLEN-1);
9cb5987c TS	414	buildid_dir[MAXPATHLEN-1] = '\0';
	415	}
	416
	417	return 0;
	418	}
	419
1d037ca1 IT	420	static int perf_default_core_config(const char *var __maybe_unused,
1d037ca1 IT	421	const char *value __maybe_unused)
07800601	422	{
3fcb10e4 MD	423	if (!strcmp(var, "core.proc-map-timeout"))
	424	proc_map_timeout = strtoul(value, NULL, 10);
	425
395cf969	426	/* Add other config variables here. */
07800601 IM	427	return 0;
	428	}
	429
c8302367 JO	430	static int perf_ui_config(const char var, const char value)
	431	{
	432	/* Add other config variables here. */
ecc4c561	433	if (!strcmp(var, "ui.show-headers"))
c8302367	434	symbol_conf.show_hist_headers = perf_config_bool(var, value);
ecc4c561	435
c8302367 JO	436	return 0;
	437	}
	438
1d037ca1 IT	439	int perf_default_config(const char var, const char value,
1d037ca1 IT	440	void *dummy __maybe_unused)
07800601	441	{
8e99b6d4	442	if (strstarts(var, "core."))
07800601 IM	443	return perf_default_core_config(var, value);
07800601 IM	444
8e99b6d4	445	if (strstarts(var, "hist."))
0b93da17 NK	446	return perf_hist_config(var, value);
0b93da17 NK	447
8e99b6d4	448	if (strstarts(var, "ui."))
c8302367 JO	449	return perf_ui_config(var, value);
c8302367 JO	450
8e99b6d4	451	if (strstarts(var, "call-graph."))
2b9240ca NK	452	return perf_callchain_config(var, value);
2b9240ca NK	453
8e99b6d4	454	if (strstarts(var, "llvm."))
aa61fd05 WN	455	return perf_llvm_config(var, value);
aa61fd05 WN	456
8e99b6d4	457	if (strstarts(var, "buildid."))
9cb5987c TS	458	return perf_buildid_config(var, value);
9cb5987c TS	459
395cf969	460	/* Add other config variables here. */
07800601 IM	461	return 0;
	462	}
	463
a41794cd	464	static int perf_config_from_file(config_fn_t fn, const char filename, void data)
07800601 IM	465	{
	466	int ret;
	467	FILE *f = fopen(filename, "r");
	468
	469	ret = -1;
	470	if (f) {
	471	config_file = f;
	472	config_file_name = filename;
	473	config_linenr = 1;
	474	config_file_eof = 0;
	475	ret = perf_parse_file(fn, data);
	476	fclose(f);
	477	config_file_name = NULL;
	478	}
	479	return ret;
	480	}
	481
c7ac2417	482	const char *perf_etc_perfconfig(void)
07800601 IM	483	{
	484	static const char *system_wide;
	485	if (!system_wide)
	486	system_wide = system_path(ETC_PERFCONFIG);
	487	return system_wide;
	488	}
	489
	490	static int perf_env_bool(const char *k, int def)
	491	{
	492	const char *v = getenv(k);
	493	return v ? perf_config_bool(k, v) : def;
	494	}
	495
a41794cd	496	static int perf_config_system(void)
07800601 IM	497	{
	498	return !perf_env_bool("PERF_CONFIG_NOSYSTEM", 0);
	499	}
	500
a41794cd	501	static int perf_config_global(void)
07800601 IM	502	{
	503	return !perf_env_bool("PERF_CONFIG_NOGLOBAL", 0);
	504	}
	505
20105ca1 TS	506	static struct perf_config_section find_section(struct list_head sections,
	507	const char *section_name)
	508	{
	509	struct perf_config_section *section;
	510
	511	list_for_each_entry(section, sections, node)
	512	if (!strcmp(section->name, section_name))
	513	return section;
	514
	515	return NULL;
	516	}
	517
	518	static struct perf_config_item find_config_item(const char name,
	519	struct perf_config_section *section)
	520	{
	521	struct perf_config_item *item;
	522
	523	list_for_each_entry(item, &section->items, node)
	524	if (!strcmp(item->name, name))
	525	return item;
	526
	527	return NULL;
	528	}
	529
	530	static struct perf_config_section add_section(struct list_head sections,
	531	const char *section_name)
	532	{
	533	struct perf_config_section section = zalloc(sizeof(section));
	534
	535	if (!section)
	536	return NULL;
	537
	538	INIT_LIST_HEAD(&section->items);
	539	section->name = strdup(section_name);
	540	if (!section->name) {
	541	pr_debug("%s: strdup failed\n", __func__);
	542	free(section);
	543	return NULL;
	544	}
	545
	546	list_add_tail(&section->node, sections);
	547	return section;
	548	}
	549
	550	static struct perf_config_item add_config_item(struct perf_config_section section,
	551	const char *name)
	552	{
	553	struct perf_config_item item = zalloc(sizeof(item));
	554
	555	if (!item)
	556	return NULL;
	557
	558	item->name = strdup(name);
	559	if (!item->name) {
	560	pr_debug("%s: strdup failed\n", __func__);
	561	free(item);
	562	return NULL;
	563	}
	564
	565	list_add_tail(&item->node, &section->items);
	566	return item;
	567	}
	568
	569	static int set_value(struct perf_config_item item, const char value)
570	{
571	char *val = strdup(value);
572
573	if (!val)
574	return -1;
575
576	zfree(&item->value);
577	item->value = val;
578	return 0;
579	}
580
581	static int collect_config(const char var, const char value,
582	void *perf_config_set)
583	{
584	int ret = -1;
585	char ptr, key;
586	char section_name, name;
587	struct perf_config_section *section = NULL;
588	struct perf_config_item *item = NULL;
589	struct perf_config_set *set = perf_config_set;
7db91f25	590	struct list_head *sections;
20105ca1	591
7db91f25 TS	592	if (set == NULL)
	593	return -1;
	594
	595	sections = &set->sections;
20105ca1 TS	596	key = ptr = strdup(var);
	597	if (!key) {
	598	pr_debug("%s: strdup failed\n", __func__);
	599	return -1;
	600	}
	601
	602	section_name = strsep(&ptr, ".");
	603	name = ptr;
	604	if (name == NULL \|\| value == NULL)
	605	goto out_free;
	606
	607	section = find_section(sections, section_name);
	608	if (!section) {
	609	section = add_section(sections, section_name);
	610	if (!section)
	611	goto out_free;
	612	}
	613
	614	item = find_config_item(name, section);
	615	if (!item) {
	616	item = add_config_item(section, name);
	617	if (!item)
	618	goto out_free;
	619	}
	620
08d090cf TS	621	/* perf_config_set can contain both user and system config items.
	622	* So we should know where each value is from.
	623	* The classification would be needed when a particular config file
	624	* is overwrited by setting feature i.e. set_config().
	625	*/
	626	if (strcmp(config_file_name, perf_etc_perfconfig()) == 0) {
	627	section->from_system_config = true;
	628	item->from_system_config = true;
	629	} else {
	630	section->from_system_config = false;
	631	item->from_system_config = false;
	632	}
	633
20105ca1	634	ret = set_value(item, value);
20105ca1 TS	635
	636	out_free:
	637	free(key);
54569ba4	638	return ret;
20105ca1 TS	639	}
20105ca1 TS	640
08d090cf	641	int perf_config_set__collect(struct perf_config_set set, const char file_name,
c6fc018a TS	642	const char var, const char value)
c6fc018a TS	643	{
08d090cf	644	config_file_name = file_name;
c6fc018a TS	645	return collect_config(var, value, set);
	646	}
	647
8beeb00f TS	648	static int perf_config_set__init(struct perf_config_set *set)
	649	{
	650	int ret = -1;
	651	const char *home = NULL;
3e00cbe8 JO	652	char *user_config;
3e00cbe8 JO	653	struct stat st;
8beeb00f TS	654
	655	/* Setting $PERF_CONFIG makes perf read _only_ the given config file. */
	656	if (config_exclusive_filename)
	657	return perf_config_from_file(collect_config, config_exclusive_filename, set);
	658	if (perf_config_system() && !access(perf_etc_perfconfig(), R_OK)) {
	659	if (perf_config_from_file(collect_config, perf_etc_perfconfig(), set) < 0)
	660	goto out;
	661	}
	662
	663	home = getenv("HOME");
8beeb00f	664
3e00cbe8 JO	665	/*
	666	* Skip reading user config if:
	667	* - there is no place to read it from (HOME)
	668	* - we are asked not to (PERF_CONFIG_NOGLOBAL=1)
	669	*/
	670	if (!home \|\| !*home \|\| !perf_config_global())
	671	return 0;
8beeb00f	672
3e00cbe8 JO	673	user_config = strdup(mkpath("%s/.perfconfig", home));
3e00cbe8 JO	674	if (user_config == NULL) {
4cf134e7	675	pr_warning("Not enough memory to process %s/.perfconfig, ignoring it.", home);
3e00cbe8 JO	676	goto out;
	677	}
	678
	679	if (stat(user_config, &st) < 0) {
	680	if (errno == ENOENT)
	681	ret = 0;
	682	goto out_free;
	683	}
afc45cf5	684
3e00cbe8	685	ret = 0;
8beeb00f	686
3e00cbe8	687	if (st.st_uid && (st.st_uid != geteuid())) {
4cf134e7	688	pr_warning("File %s not owned by current user or root, ignoring it.", user_config);
3e00cbe8 JO	689	goto out_free;
	690	}
	691
	692	if (st.st_size)
	693	ret = perf_config_from_file(collect_config, user_config, set);
8beeb00f	694
8beeb00f	695	out_free:
3e00cbe8	696	free(user_config);
8beeb00f TS	697	out:
	698	return ret;
	699	}
	700
20105ca1 TS	701	struct perf_config_set *perf_config_set__new(void)
	702	{
	703	struct perf_config_set set = zalloc(sizeof(set));
	704
	705	if (set) {
	706	INIT_LIST_HEAD(&set->sections);
55421b4f	707	perf_config_set__init(set);
20105ca1 TS	708	}
	709
	710	return set;
	711	}
	712
d01bd1ac ACM	713	static int perf_config__init(void)
	714	{
	715	if (config_set == NULL)
	716	config_set = perf_config_set__new();
	717
	718	return config_set == NULL;
	719	}
	720
8a0a9c7e TS	721	int perf_config(config_fn_t fn, void *data)
	722	{
	723	int ret = 0;
	724	char key[BUFSIZ];
	725	struct perf_config_section *section;
	726	struct perf_config_item *item;
	727
d01bd1ac	728	if (config_set == NULL && perf_config__init())
8a0a9c7e TS	729	return -1;
	730
	731	perf_config_set__for_each_entry(config_set, section, item) {
	732	char *value = item->value;
	733
	734	if (value) {
	735	scnprintf(key, sizeof(key), "%s.%s",
	736	section->name, item->name);
	737	ret = fn(key, value, data);
	738	if (ret < 0) {
	739	pr_err("Error: wrong config key-value pair %s=%s\n",
	740	key, value);
22d46219 ACM	741	/*
	742	* Can't be just a 'break', as perf_config_set__for_each_entry()
	743	* expands to two nested for() loops.
	744	*/
	745	goto out;
8a0a9c7e TS	746	}
	747	}
	748	}
22d46219	749	out:
8a0a9c7e TS	750	return ret;
	751	}
	752
8a0a9c7e TS	753	void perf_config__exit(void)
	754	{
	755	perf_config_set__delete(config_set);
	756	config_set = NULL;
	757	}
	758
	759	void perf_config__refresh(void)
	760	{
	761	perf_config__exit();
	762	perf_config__init();
	763	}
	764
20105ca1 TS	765	static void perf_config_item__delete(struct perf_config_item *item)
	766	{
	767	zfree(&item->name);
	768	zfree(&item->value);
	769	free(item);
	770	}
	771
	772	static void perf_config_section__purge(struct perf_config_section *section)
	773	{
	774	struct perf_config_item item, tmp;
	775
	776	list_for_each_entry_safe(item, tmp, &section->items, node) {
	777	list_del_init(&item->node);
	778	perf_config_item__delete(item);
	779	}
	780	}
	781
	782	static void perf_config_section__delete(struct perf_config_section *section)
	783	{
	784	perf_config_section__purge(section);
	785	zfree(&section->name);
	786	free(section);
	787	}
	788
	789	static void perf_config_set__purge(struct perf_config_set *set)
	790	{
	791	struct perf_config_section section, tmp;
	792
	793	list_for_each_entry_safe(section, tmp, &set->sections, node) {
	794	list_del_init(&section->node);
	795	perf_config_section__delete(section);
	796	}
	797	}
	798
	799	void perf_config_set__delete(struct perf_config_set *set)
	800	{
826424cc TS	801	if (set == NULL)
	802	return;
	803
20105ca1 TS	804	perf_config_set__purge(set);
	805	free(set);
	806	}
	807
07800601 IM	808	/*
	809	* Call this to report error for your variable that should not
	810	* get a boolean value (i.e. "[my] var" means "true").
	811	*/
	812	int config_error_nonbool(const char *var)
	813	{
62d94b00 ACM	814	pr_err("Missing value for '%s'", var);
62d94b00 ACM	815	return -1;
07800601	816	}
45de34bb	817
99ce8e9f	818	void set_buildid_dir(const char *dir)
45de34bb	819	{
99ce8e9f	820	if (dir)
75c375c0	821	scnprintf(buildid_dir, MAXPATHLEN, "%s", dir);
45de34bb	822
45de34bb SE	823	/* default to $HOME/.debug */
45de34bb SE	824	if (buildid_dir[0] == '\0') {
37194f44 TS	825	char *home = getenv("HOME");
	826
	827	if (home) {
75c375c0	828	snprintf(buildid_dir, MAXPATHLEN, "%s/%s",
37194f44	829	home, DEBUG_CACHE_DIR);
45de34bb SE	830	} else {
	831	strncpy(buildid_dir, DEBUG_CACHE_DIR, MAXPATHLEN-1);
	832	}
	833	buildid_dir[MAXPATHLEN-1] = '\0';
	834	}
	835	/* for communicating with external commands */
	836	setenv("PERF_BUILDID_DIR", buildid_dir, 1);
	837	}