2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
14 static FILE *config_file;
15 static const char *config_file_name;
16 static int config_linenr;
17 static int config_file_eof;
19 const char *config_exclusive_filename = NULL;
21 static int get_next_char(void)
27 if ((f = config_file) != NULL) {
30 /* DOS like systems */
47 static char *parse_value(void)
49 static char value[1024];
50 int quote = 0, comment = 0, space = 0;
54 int c = get_next_char();
56 if (len >= sizeof(value) - 1)
66 if (isspace(c) && !quote) {
71 if (c == ';' || c == '#') {
95 /* Some characters escape as themselves */
98 /* Reject unknown escape sequences */
113 static inline int iskeychar(int c)
115 return isalnum(c) || c == '-';
118 static int get_value(config_fn_t fn, void *data, char *name, unsigned int len)
123 /* Get the full name */
130 name[len++] = tolower(c);
135 while (c == ' ' || c == '\t')
142 value = parse_value();
146 return fn(name, value, data);
149 static int get_extended_base_var(char *name, int baselen, int c)
155 } while (isspace(c));
157 /* We require the format to be '[base "extension"]' */
160 name[baselen++] = '.';
163 int c = get_next_char();
174 if (baselen > MAXNAME / 2)
179 if (get_next_char() != ']')
184 static int get_base_var(char *name)
189 int c = get_next_char();
195 return get_extended_base_var(name, baselen, c);
196 if (!iskeychar(c) && c != '.')
198 if (baselen > MAXNAME / 2)
200 name[baselen++] = tolower(c);
204 static int perf_parse_file(config_fn_t fn, void *data)
208 static char var[MAXNAME];
210 /* U+FEFF Byte Order Mark in UTF8 */
211 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
212 const unsigned char *bomptr = utf8_bom;
215 int c = get_next_char();
216 if (bomptr && *bomptr) {
217 /* We are at the file beginning; skip UTF8-encoded BOM
218 * if present. Sane editors won't put this in on their
219 * own, but e.g. Windows Notepad will do it happily. */
220 if ((unsigned char) c == *bomptr) {
224 /* Do not tolerate partial BOM. */
225 if (bomptr != utf8_bom)
227 /* No BOM at file beginning. Cool. */
237 if (comment || isspace(c))
239 if (c == '#' || c == ';') {
244 baselen = get_base_var(var);
247 var[baselen++] = '.';
253 var[baselen] = tolower(c);
254 if (get_value(fn, data, var, baselen+1) < 0)
257 die("bad config file line %d in %s", config_linenr, config_file_name);
260 static int parse_unit_factor(const char *end, unsigned long *val)
264 else if (!strcasecmp(end, "k")) {
268 else if (!strcasecmp(end, "m")) {
272 else if (!strcasecmp(end, "g")) {
273 *val *= 1024 * 1024 * 1024;
279 static int perf_parse_long(const char *value, long *ret)
281 if (value && *value) {
283 long val = strtol(value, &end, 0);
284 unsigned long factor = 1;
285 if (!parse_unit_factor(end, &factor))
293 int perf_parse_ulong(const char *value, unsigned long *ret)
295 if (value && *value) {
297 unsigned long val = strtoul(value, &end, 0);
298 if (!parse_unit_factor(end, &val))
306 static void die_bad_config(const char *name)
308 if (config_file_name)
309 die("bad config value for '%s' in %s", name, config_file_name);
310 die("bad config value for '%s'", name);
313 int perf_config_int(const char *name, const char *value)
316 if (!perf_parse_long(value, &ret))
317 die_bad_config(name);
321 unsigned long perf_config_ulong(const char *name, const char *value)
324 if (!perf_parse_ulong(value, &ret))
325 die_bad_config(name);
329 int perf_config_bool_or_int(const char *name, const char *value, int *is_bool)
336 if (!strcasecmp(value, "true") || !strcasecmp(value, "yes") || !strcasecmp(value, "on"))
338 if (!strcasecmp(value, "false") || !strcasecmp(value, "no") || !strcasecmp(value, "off"))
341 return perf_config_int(name, value);
344 int perf_config_bool(const char *name, const char *value)
347 return !!perf_config_bool_or_int(name, value, &discard);
350 int perf_config_string(const char **dest, const char *var, const char *value)
353 return config_error_nonbool(var);
354 *dest = strdup(value);
358 static int perf_default_core_config(const char *var __used, const char *value __used)
360 /* Add other config variables here and to Documentation/config.txt. */
364 int perf_default_config(const char *var, const char *value, void *dummy __used)
366 if (!prefixcmp(var, "core."))
367 return perf_default_core_config(var, value);
369 /* Add other config variables here and to Documentation/config.txt. */
373 int perf_config_from_file(config_fn_t fn, const char *filename, void *data)
376 FILE *f = fopen(filename, "r");
381 config_file_name = filename;
384 ret = perf_parse_file(fn, data);
386 config_file_name = NULL;
391 const char *perf_etc_perfconfig(void)
393 static const char *system_wide;
395 system_wide = system_path(ETC_PERFCONFIG);
399 static int perf_env_bool(const char *k, int def)
401 const char *v = getenv(k);
402 return v ? perf_config_bool(k, v) : def;
405 int perf_config_system(void)
407 return !perf_env_bool("PERF_CONFIG_NOSYSTEM", 0);
410 int perf_config_global(void)
412 return !perf_env_bool("PERF_CONFIG_NOGLOBAL", 0);
415 int perf_config(config_fn_t fn, void *data)
417 int ret = 0, found = 0;
418 char *repo_config = NULL;
419 const char *home = NULL;
421 /* Setting $PERF_CONFIG makes perf read _only_ the given config file. */
422 if (config_exclusive_filename)
423 return perf_config_from_file(fn, config_exclusive_filename, data);
424 if (perf_config_system() && !access(perf_etc_perfconfig(), R_OK)) {
425 ret += perf_config_from_file(fn, perf_etc_perfconfig(),
430 home = getenv("HOME");
431 if (perf_config_global() && home) {
432 char *user_config = strdup(mkpath("%s/.perfconfig", home));
433 if (!access(user_config, R_OK)) {
434 ret += perf_config_from_file(fn, user_config, data);
440 repo_config = perf_pathdup("config");
441 if (!access(repo_config, R_OK)) {
442 ret += perf_config_from_file(fn, repo_config, data);
452 * Find all the stuff for perf_config_set() below.
455 #define MAX_MATCHES 512
461 regex_t* value_regex;
463 size_t offset[MAX_MATCHES];
464 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
468 static int matches(const char* key, const char* value)
470 return !strcmp(key, store.key) &&
471 (store.value_regex == NULL ||
472 (store.do_not_match ^
473 !regexec(store.value_regex, value, 0, NULL, 0)));
476 static int store_aux(const char* key, const char* value, void *cb __used)
481 switch (store.state) {
483 if (matches(key, value)) {
484 if (store.seen == 1 && store.multi_replace == 0) {
485 warning("%s has multiple values", key);
486 } else if (store.seen >= MAX_MATCHES) {
487 error("too many matches for %s", key);
491 store.offset[store.seen] = ftell(config_file);
497 * What we are looking for is in store.key (both
498 * section and var), and its section part is baselen
499 * long. We found key (again, both section and var).
500 * We would want to know if this key is in the same
501 * section as what we are looking for. We already
502 * know we are in the same section as what should
505 ep = strrchr(key, '.');
506 section_len = ep - key;
508 if ((section_len != store.baselen) ||
509 memcmp(key, store.key, section_len+1)) {
510 store.state = SECTION_END_SEEN;
515 * Do not increment matches: this is no match, but we
516 * just made sure we are in the desired section.
518 store.offset[store.seen] = ftell(config_file);
520 case SECTION_END_SEEN:
522 if (matches(key, value)) {
523 store.offset[store.seen] = ftell(config_file);
524 store.state = KEY_SEEN;
527 if (strrchr(key, '.') - key == store.baselen &&
528 !strncmp(key, store.key, store.baselen)) {
529 store.state = SECTION_SEEN;
530 store.offset[store.seen] = ftell(config_file);
537 static int store_write_section(int fd, const char* key)
541 struct strbuf sb = STRBUF_INIT;
543 dot = memchr(key, '.', store.baselen);
545 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
546 for (i = dot - key + 1; i < store.baselen; i++) {
547 if (key[i] == '"' || key[i] == '\\')
548 strbuf_addch(&sb, '\\');
549 strbuf_addch(&sb, key[i]);
551 strbuf_addstr(&sb, "\"]\n");
553 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
556 success = (write_in_full(fd, sb.buf, sb.len) == (ssize_t)sb.len);
562 static int store_write_pair(int fd, const char* key, const char* value)
565 int length = strlen(key + store.baselen + 1);
566 const char *quote = "";
567 struct strbuf sb = STRBUF_INIT;
570 * Check to see if the value needs to be surrounded with a dq pair.
571 * Note that problematic characters are always backslash-quoted; this
572 * check is about not losing leading or trailing SP and strings that
573 * follow beginning-of-comment characters (i.e. ';' and '#') by the
574 * configuration parser.
578 for (i = 0; value[i]; i++)
579 if (value[i] == ';' || value[i] == '#')
581 if (i && value[i - 1] == ' ')
584 strbuf_addf(&sb, "\t%.*s = %s",
585 length, key + store.baselen + 1, quote);
587 for (i = 0; value[i]; i++)
590 strbuf_addstr(&sb, "\\n");
593 strbuf_addstr(&sb, "\\t");
597 strbuf_addch(&sb, '\\');
599 strbuf_addch(&sb, value[i]);
602 strbuf_addf(&sb, "%s\n", quote);
604 success = (write_in_full(fd, sb.buf, sb.len) == (ssize_t)sb.len);
610 static ssize_t find_beginning_of_line(const char* contents, size_t size,
611 size_t offset_, int* found_bracket)
613 size_t equal_offset = size, bracket_offset = size;
617 for (offset = offset_-2; offset > 0
618 && contents[offset] != '\n'; offset--)
619 switch (contents[offset]) {
620 case '=': equal_offset = offset; break;
621 case ']': bracket_offset = offset; break;
623 if (offset > 0 && contents[offset-1] == '\\') {
627 if (bracket_offset < equal_offset) {
629 offset = bracket_offset+1;
636 int perf_config_set(const char* key, const char* value)
638 return perf_config_set_multivar(key, value, NULL, 0);
642 * If value==NULL, unset in (remove from) config,
643 * if value_regex!=NULL, disregard key/value pairs where value does not match.
644 * if multi_replace==0, nothing, or only one matching key/value is replaced,
645 * else all matching key/values (regardless how many) are removed,
646 * before the new pair is written.
648 * Returns 0 on success.
650 * This function does this:
652 * - it locks the config file by creating ".perf/config.lock"
654 * - it then parses the config using store_aux() as validator to find
655 * the position on the key/value pair to replace. If it is to be unset,
656 * it must be found exactly once.
658 * - the config file is mmap()ed and the part before the match (if any) is
659 * written to the lock file, then the changed part and the rest.
661 * - the config file is removed and the lock file rename()d to it.
664 int perf_config_set_multivar(const char* key, const char* value,
665 const char* value_regex, int multi_replace)
670 char* config_filename;
671 const char* last_dot = strrchr(key, '.');
673 if (config_exclusive_filename)
674 config_filename = strdup(config_exclusive_filename);
676 config_filename = perf_pathdup("config");
679 * Since "key" actually contains the section name and the real
680 * key name separated by a dot, we have to know where the dot is.
683 if (last_dot == NULL) {
684 error("key does not contain a section: %s", key);
688 store.baselen = last_dot - key;
690 store.multi_replace = multi_replace;
693 * Validate the key and while at it, lower case it for matching.
695 store.key = malloc(strlen(key) + 1);
697 for (i = 0; key[i]; i++) {
698 unsigned char c = key[i];
701 /* Leave the extended basename untouched.. */
702 if (!dot || i > store.baselen) {
703 if (!iskeychar(c) || (i == store.baselen+1 && !isalpha(c))) {
704 error("invalid key: %s", key);
710 } else if (c == '\n') {
711 error("invalid key (newline): %s", key);
721 * If .perf/config does not exist yet, write a minimal version.
723 in_fd = open(config_filename, O_RDONLY);
727 if ( ENOENT != errno ) {
728 error("opening %s: %s", config_filename,
730 ret = 3; /* same as "invalid config file" */
733 /* if nothing to unset, error out */
739 store.key = (char*)key;
740 if (!store_write_section(fd, key) ||
741 !store_write_pair(fd, key, value))
746 ssize_t contents_sz, copy_begin, copy_end;
749 if (value_regex == NULL)
750 store.value_regex = NULL;
752 if (value_regex[0] == '!') {
753 store.do_not_match = 1;
756 store.do_not_match = 0;
758 store.value_regex = (regex_t*)malloc(sizeof(regex_t));
759 if (regcomp(store.value_regex, value_regex,
761 error("invalid pattern: %s", value_regex);
762 free(store.value_regex);
773 * After this, store.offset will contain the *end* offset
774 * of the last match, or remain at 0 if no match was found.
775 * As a side effect, we make sure to transform only a valid
776 * existing config file.
778 if (perf_config_from_file(store_aux, config_filename, NULL)) {
779 error("invalid config file %s", config_filename);
781 if (store.value_regex != NULL) {
782 regfree(store.value_regex);
783 free(store.value_regex);
790 if (store.value_regex != NULL) {
791 regfree(store.value_regex);
792 free(store.value_regex);
795 /* if nothing to unset, or too many matches, error out */
796 if ((store.seen == 0 && value == NULL) ||
797 (store.seen > 1 && multi_replace == 0)) {
803 contents_sz = xsize_t(st.st_size);
804 contents = mmap(NULL, contents_sz, PROT_READ,
805 MAP_PRIVATE, in_fd, 0);
811 for (i = 0, copy_begin = 0; i < store.seen; i++) {
812 if (store.offset[i] == 0) {
813 store.offset[i] = copy_end = contents_sz;
814 } else if (store.state != KEY_SEEN) {
815 copy_end = store.offset[i];
817 copy_end = find_beginning_of_line(
818 contents, contents_sz,
819 store.offset[i]-2, &new_line);
821 if (copy_end > 0 && contents[copy_end-1] != '\n')
824 /* write the first part of the config */
825 if (copy_end > copy_begin) {
826 if (write_in_full(fd, contents + copy_begin,
827 copy_end - copy_begin) <
828 copy_end - copy_begin)
831 write_in_full(fd, "\n", 1) != 1)
834 copy_begin = store.offset[i];
837 /* write the pair (value == NULL means unset) */
839 if (store.state == START) {
840 if (!store_write_section(fd, key))
843 if (!store_write_pair(fd, key, value))
847 /* write the rest of the config */
848 if (copy_begin < contents_sz)
849 if (write_in_full(fd, contents + copy_begin,
850 contents_sz - copy_begin) <
851 contents_sz - copy_begin)
854 munmap(contents, contents_sz);
860 free(config_filename);
869 * Call this to report error for your variable that should not
870 * get a boolean value (i.e. "[my] var" means "true").
872 int config_error_nonbool(const char *var)
874 return error("Missing value for '%s'", var);