1 // SPDX-License-Identifier: GPL-2.0
23 /* return true if 'path' exists, false otherwise */
24 static bool is_present(const char *path)
28 return !stat(path, &st);
31 /* return true if 'path' exists and it is a directory, false otherwise */
32 static bool is_dir(const char *path)
39 return S_ISDIR(st.st_mode);
42 /* return true if the given two files are the same, false otherwise */
43 static bool is_same(const char *file1, const char *file2)
50 fd1 = open(file1, O_RDONLY);
54 fd2 = open(file2, O_RDONLY);
58 ret = fstat(fd1, &st1);
61 ret = fstat(fd2, &st2);
65 if (st1.st_size != st2.st_size)
68 map1 = mmap(NULL, st1.st_size, PROT_READ, MAP_PRIVATE, fd1, 0);
69 if (map1 == MAP_FAILED)
72 map2 = mmap(NULL, st2.st_size, PROT_READ, MAP_PRIVATE, fd2, 0);
73 if (map2 == MAP_FAILED)
76 if (bcmp(map1, map2, st1.st_size))
89 * Create the parent directory of the given path.
91 * For example, if 'include/config/auto.conf' is given, create 'include/config'.
93 static int make_parent_dir(const char *path)
95 char tmp[PATH_MAX + 1];
98 strncpy(tmp, path, sizeof(tmp));
99 tmp[sizeof(tmp) - 1] = 0;
101 /* Remove the base name. Just return if nothing is left */
102 p = strrchr(tmp, '/');
107 /* Just in case it is an absolute path */
112 while ((p = strchr(p, '/'))) {
115 /* skip if the directory exists */
116 if (!is_dir(tmp) && mkdir(tmp, 0755))
127 static char depfile_path[PATH_MAX];
128 static size_t depfile_prefix_len;
130 /* touch depfile for symbol 'name' */
131 static int conf_touch_dep(const char *name)
135 /* check overflow: prefix + name + '\0' must fit in buffer. */
136 if (depfile_prefix_len + strlen(name) + 1 > sizeof(depfile_path))
139 strcpy(depfile_path + depfile_prefix_len, name);
141 fd = open(depfile_path, O_WRONLY | O_CREAT | O_TRUNC, 0644);
149 static void conf_warning(const char *fmt, ...)
150 __attribute__ ((format (printf, 1, 2)));
152 static void conf_message(const char *fmt, ...)
153 __attribute__ ((format (printf, 1, 2)));
155 static const char *conf_filename;
156 static int conf_lineno, conf_warnings;
158 static void conf_warning(const char *fmt, ...)
162 fprintf(stderr, "%s:%d:warning: ", conf_filename, conf_lineno);
163 vfprintf(stderr, fmt, ap);
164 fprintf(stderr, "\n");
169 static void conf_default_message_callback(const char *s)
176 static void (*conf_message_callback)(const char *s) =
177 conf_default_message_callback;
178 void conf_set_message_callback(void (*fn)(const char *s))
180 conf_message_callback = fn;
183 static void conf_message(const char *fmt, ...)
188 if (!conf_message_callback)
193 vsnprintf(buf, sizeof(buf), fmt, ap);
194 conf_message_callback(buf);
198 const char *conf_get_configname(void)
200 char *name = getenv("KCONFIG_CONFIG");
202 return name ? name : ".config";
205 static const char *conf_get_autoconfig_name(void)
207 char *name = getenv("KCONFIG_AUTOCONFIG");
209 return name ? name : "include/config/auto.conf";
212 static const char *conf_get_autoheader_name(void)
214 char *name = getenv("KCONFIG_AUTOHEADER");
216 return name ? name : "include/generated/autoconf.h";
219 static int conf_set_sym_val(struct symbol *sym, int def, int def_flags, char *p)
226 sym->def[def].tri = mod;
227 sym->flags |= def_flags;
233 sym->def[def].tri = yes;
234 sym->flags |= def_flags;
238 sym->def[def].tri = no;
239 sym->flags |= def_flags;
242 if (def != S_DEF_AUTO)
243 conf_warning("symbol value '%s' invalid for %s",
247 /* No escaping for S_DEF_AUTO (include/config/auto.conf) */
248 if (def != S_DEF_AUTO) {
251 for (p2 = p; (p2 = strpbrk(p2, "\"\\")); p2++) {
256 memmove(p2, p2 + 1, strlen(p2));
259 conf_warning("invalid string found");
266 if (sym_string_valid(sym, p)) {
267 sym->def[def].val = xstrdup(p);
268 sym->flags |= def_flags;
270 if (def != S_DEF_AUTO)
271 conf_warning("symbol value '%s' invalid for %s",
282 #define LINE_GROWTH 16
283 static int add_byte(int c, char **lineptr, size_t slen, size_t *n)
286 size_t new_size = slen + 1;
288 new_size += LINE_GROWTH - 1;
290 nline = xrealloc(*lineptr, new_size);
298 (*lineptr)[slen] = c;
303 static ssize_t compat_getline(char **lineptr, size_t *n, FILE *stream)
305 char *line = *lineptr;
309 int c = getc(stream);
313 if (add_byte(c, &line, slen, n) < 0)
318 if (add_byte('\0', &line, slen, n) < 0)
325 if (add_byte(c, &line, slen, n) < 0)
337 int conf_read_simple(const char *name, int def)
341 size_t line_asize = 0;
347 in = zconf_fopen(name);
351 name = conf_get_configname();
352 in = zconf_fopen(name);
355 conf_set_changed(true);
357 env = getenv("KCONFIG_DEFCONFIG_LIST");
364 while (isspace(*env))
371 while (*p && !isspace(*p))
374 is_last = (*p == '\0');
378 in = zconf_fopen(env);
380 conf_message("using defaults found in %s",
395 conf_filename = name;
399 def_flags = SYMBOL_DEF << def;
400 for_all_symbols(i, sym) {
401 sym->flags |= SYMBOL_CHANGED;
402 sym->flags &= ~(def_flags|SYMBOL_VALID);
403 if (sym_is_choice(sym))
404 sym->flags |= def_flags;
409 if (sym->def[def].val)
410 free(sym->def[def].val);
413 sym->def[def].val = NULL;
414 sym->def[def].tri = no;
418 while (compat_getline(&line, &line_asize, in) != -1) {
421 if (line[0] == '#') {
422 if (memcmp(line + 2, CONFIG_, strlen(CONFIG_)))
424 p = strchr(line + 2 + strlen(CONFIG_), ' ');
428 if (strncmp(p, "is not set", 10))
430 if (def == S_DEF_USER) {
431 sym = sym_find(line + 2 + strlen(CONFIG_));
433 conf_set_changed(true);
437 sym = sym_lookup(line + 2 + strlen(CONFIG_), 0);
438 if (sym->type == S_UNKNOWN)
439 sym->type = S_BOOLEAN;
441 if (sym->flags & def_flags) {
442 conf_warning("override: reassigning to symbol %s", sym->name);
447 sym->def[def].tri = no;
448 sym->flags |= def_flags;
453 } else if (memcmp(line, CONFIG_, strlen(CONFIG_)) == 0) {
454 p = strchr(line + strlen(CONFIG_), '=');
458 p2 = strchr(p, '\n');
465 sym = sym_find(line + strlen(CONFIG_));
467 if (def == S_DEF_AUTO)
469 * Reading from include/config/auto.conf
470 * If CONFIG_FOO previously existed in
471 * auto.conf but it is missing now,
472 * include/config/FOO must be touched.
474 conf_touch_dep(line + strlen(CONFIG_));
476 conf_set_changed(true);
480 if (sym->flags & def_flags) {
481 conf_warning("override: reassigning to symbol %s", sym->name);
483 if (conf_set_sym_val(sym, def, def_flags, p))
486 if (line[0] != '\r' && line[0] != '\n')
487 conf_warning("unexpected data: %.*s",
488 (int)strcspn(line, "\r\n"), line);
493 if (sym && sym_is_choice_value(sym)) {
494 struct symbol *cs = prop_get_symbol(sym_get_choice_prop(sym));
495 switch (sym->def[def].tri) {
499 if (cs->def[def].tri == yes) {
500 conf_warning("%s creates inconsistent choice state", sym->name);
501 cs->flags &= ~def_flags;
505 if (cs->def[def].tri != no)
506 conf_warning("override: %s changes choice state", sym->name);
507 cs->def[def].val = sym;
510 cs->def[def].tri = EXPR_OR(cs->def[def].tri, sym->def[def].tri);
518 int conf_read(const char *name)
521 int conf_unsaved = 0;
524 conf_set_changed(false);
526 if (conf_read_simple(name, S_DEF_USER)) {
527 sym_calc_value(modules_sym);
531 sym_calc_value(modules_sym);
533 for_all_symbols(i, sym) {
535 if (sym_is_choice(sym) || (sym->flags & SYMBOL_NO_WRITE))
537 if (sym_has_value(sym) && (sym->flags & SYMBOL_WRITE)) {
538 /* check that calculated value agrees with saved value */
542 if (sym->def[S_DEF_USER].tri == sym_get_tristate_value(sym))
546 if (!strcmp(sym->curr.val, sym->def[S_DEF_USER].val))
550 } else if (!sym_has_value(sym) && !(sym->flags & SYMBOL_WRITE))
551 /* no previous value and not saved */
554 /* maybe print value in verbose mode... */
557 for_all_symbols(i, sym) {
558 if (sym_has_value(sym) && !sym_is_choice_value(sym)) {
559 /* Reset values of generates values, so they'll appear
560 * as new, if they should become visible, but that
561 * doesn't quite work if the Kconfig and the saved
562 * configuration disagree.
564 if (sym->visible == no && !conf_unsaved)
565 sym->flags &= ~SYMBOL_DEF_USER;
570 /* Reset a string value if it's out of range */
571 if (sym_string_within_range(sym, sym->def[S_DEF_USER].val))
573 sym->flags &= ~(SYMBOL_VALID|SYMBOL_DEF_USER);
582 if (conf_warnings || conf_unsaved)
583 conf_set_changed(true);
588 struct comment_style {
589 const char *decoration;
594 static const struct comment_style comment_style_pound = {
600 static const struct comment_style comment_style_c = {
606 static void conf_write_heading(FILE *fp, const struct comment_style *cs)
608 fprintf(fp, "%s\n", cs->prefix);
610 fprintf(fp, "%s Automatically generated file; DO NOT EDIT.\n",
613 fprintf(fp, "%s %s\n", cs->decoration, rootmenu.prompt->text);
615 fprintf(fp, "%s\n", cs->postfix);
618 /* The returned pointer must be freed on the caller side */
619 static char *escape_string_value(const char *in)
625 len = strlen(in) + strlen("\"\"") + 1;
629 p += strcspn(p, "\"\\");
645 len = strcspn(p, "\"\\");
646 strncat(out, p, len);
653 strncat(out, p++, 1);
662 * Kconfig configuration printer
664 * This printer is used when generating the resulting configuration after
665 * kconfig invocation and `defconfig' files. Unset symbol might be omitted by
666 * passing a non-NULL argument to the printer.
668 enum output_n { OUTPUT_N, OUTPUT_N_AS_UNSET, OUTPUT_N_NONE };
670 static void __print_symbol(FILE *fp, struct symbol *sym, enum output_n output_n,
674 char *escaped = NULL;
676 if (sym->type == S_UNKNOWN)
679 val = sym_get_string_value(sym);
681 if ((sym->type == S_BOOLEAN || sym->type == S_TRISTATE) &&
682 output_n != OUTPUT_N && *val == 'n') {
683 if (output_n == OUTPUT_N_AS_UNSET)
684 fprintf(fp, "# %s%s is not set\n", CONFIG_, sym->name);
688 if (sym->type == S_STRING && escape_string) {
689 escaped = escape_string_value(val);
693 fprintf(fp, "%s%s=%s\n", CONFIG_, sym->name, val);
698 static void print_symbol_for_dotconfig(FILE *fp, struct symbol *sym)
700 __print_symbol(fp, sym, OUTPUT_N_AS_UNSET, true);
703 static void print_symbol_for_autoconf(FILE *fp, struct symbol *sym)
705 __print_symbol(fp, sym, OUTPUT_N_NONE, false);
708 void print_symbol_for_listconfig(struct symbol *sym)
710 __print_symbol(stdout, sym, OUTPUT_N, true);
713 static void print_symbol_for_c(FILE *fp, struct symbol *sym)
716 const char *sym_suffix = "";
717 const char *val_prefix = "";
718 char *escaped = NULL;
720 if (sym->type == S_UNKNOWN)
723 val = sym_get_string_value(sym);
732 sym_suffix = "_MODULE";
739 if (val[0] != '0' || (val[1] != 'x' && val[1] != 'X'))
743 escaped = escape_string_value(val);
749 fprintf(fp, "#define %s%s%s %s%s\n", CONFIG_, sym->name, sym_suffix,
756 * Write out a minimal config.
757 * All values that has default values are skipped as this is redundant.
759 int conf_write_defconfig(const char *filename)
765 out = fopen(filename, "w");
769 sym_clear_all_valid();
771 /* Traverse all menus to find all relevant symbols */
772 menu = rootmenu.list;
778 if (!menu_is_visible(menu))
780 } else if (!sym_is_choice(sym)) {
782 if (!(sym->flags & SYMBOL_WRITE))
784 sym->flags &= ~SYMBOL_WRITE;
785 /* If we cannot change the symbol - skip */
786 if (!sym_is_changeable(sym))
788 /* If symbol equals to default value - skip */
789 if (strcmp(sym_get_string_value(sym), sym_get_string_default(sym)) == 0)
793 * If symbol is a choice value and equals to the
794 * default for a choice - skip.
795 * But only if value is bool and equal to "y" and
796 * choice is not "optional".
797 * (If choice is "optional" then all values can be "n")
799 if (sym_is_choice_value(sym)) {
803 cs = prop_get_symbol(sym_get_choice_prop(sym));
804 ds = sym_choice_default(cs);
805 if (!sym_is_optional(cs) && sym == ds) {
806 if ((sym->type == S_BOOLEAN) &&
807 sym_get_tristate_value(sym) == yes)
811 print_symbol_for_dotconfig(out, sym);
814 if (menu->list != NULL) {
817 else if (menu->next != NULL) {
820 while ((menu = menu->parent)) {
821 if (menu->next != NULL) {
832 int conf_write(const char *name)
838 char tmpname[PATH_MAX + 1], oldname[PATH_MAX + 1];
841 bool need_newline = false;
844 name = conf_get_configname();
847 fprintf(stderr, "config name is empty\n");
852 fprintf(stderr, "%s: Is a directory\n", name);
856 if (make_parent_dir(name))
859 env = getenv("KCONFIG_OVERWRITECONFIG");
862 out = fopen(name, "w");
864 snprintf(tmpname, sizeof(tmpname), "%s.%d.tmp",
865 name, (int)getpid());
866 out = fopen(tmpname, "w");
871 conf_write_heading(out, &comment_style_pound);
873 if (!conf_get_changed())
874 sym_clear_all_valid();
876 menu = rootmenu.list;
880 if (!menu_is_visible(menu))
882 str = menu_get_prompt(menu);
887 need_newline = false;
888 } else if (!(sym->flags & SYMBOL_CHOICE) &&
889 !(sym->flags & SYMBOL_WRITTEN)) {
891 if (!(sym->flags & SYMBOL_WRITE))
895 need_newline = false;
897 sym->flags |= SYMBOL_WRITTEN;
898 print_symbol_for_dotconfig(out, sym);
908 else while ((menu = menu->parent)) {
909 if (!menu->sym && menu_is_visible(menu) &&
911 str = menu_get_prompt(menu);
912 fprintf(out, "# end of %s\n", str);
923 for_all_symbols(i, sym)
924 sym->flags &= ~SYMBOL_WRITTEN;
927 if (is_same(name, tmpname)) {
928 conf_message("No change to %s", name);
930 conf_set_changed(false);
934 snprintf(oldname, sizeof(oldname), "%s.old", name);
935 rename(name, oldname);
936 if (rename(tmpname, name))
940 conf_message("configuration written to %s", name);
942 conf_set_changed(false);
947 /* write a dependency file as used by kbuild to track dependencies */
948 static int conf_write_autoconf_cmd(const char *autoconf_name)
950 char name[PATH_MAX], tmp[PATH_MAX];
955 ret = snprintf(name, sizeof(name), "%s.cmd", autoconf_name);
956 if (ret >= sizeof(name)) /* check truncation */
959 if (make_parent_dir(name))
962 ret = snprintf(tmp, sizeof(tmp), "%s.cmd.tmp", autoconf_name);
963 if (ret >= sizeof(tmp)) /* check truncation */
966 out = fopen(tmp, "w");
972 fprintf(out, "deps_config := \\\n");
973 for (file = file_list; file; file = file->next)
974 fprintf(out, "\t%s \\\n", file->name);
976 fprintf(out, "\n%s: $(deps_config)\n\n", autoconf_name);
978 env_write_dep(out, autoconf_name);
980 fprintf(out, "\n$(deps_config): ;\n");
982 if (ferror(out)) /* error check for all fprintf() calls */
987 if (rename(tmp, name)) {
995 static int conf_touch_deps(void)
1001 strcpy(depfile_path, "include/config/");
1002 depfile_prefix_len = strlen(depfile_path);
1004 name = conf_get_autoconfig_name();
1005 conf_read_simple(name, S_DEF_AUTO);
1006 sym_calc_value(modules_sym);
1008 for_all_symbols(i, sym) {
1009 sym_calc_value(sym);
1010 if ((sym->flags & SYMBOL_NO_WRITE) || !sym->name)
1012 if (sym->flags & SYMBOL_WRITE) {
1013 if (sym->flags & SYMBOL_DEF_AUTO) {
1015 * symbol has old and new value,
1016 * so compare them...
1018 switch (sym->type) {
1021 if (sym_get_tristate_value(sym) ==
1022 sym->def[S_DEF_AUTO].tri)
1028 if (!strcmp(sym_get_string_value(sym),
1029 sym->def[S_DEF_AUTO].val))
1037 * If there is no old value, only 'no' (unset)
1038 * is allowed as new value.
1040 switch (sym->type) {
1043 if (sym_get_tristate_value(sym) == no)
1050 } else if (!(sym->flags & SYMBOL_DEF_AUTO))
1051 /* There is neither an old nor a new value. */
1054 * There is an old value, but no new value ('no' (unset)
1055 * isn't saved in auto.conf, so the old value is always
1056 * different from 'no').
1059 res = conf_touch_dep(sym->name);
1067 static int __conf_write_autoconf(const char *filename,
1068 void (*print_symbol)(FILE *, struct symbol *),
1069 const struct comment_style *comment_style)
1076 if (make_parent_dir(filename))
1079 ret = snprintf(tmp, sizeof(tmp), "%s.tmp", filename);
1080 if (ret >= sizeof(tmp)) /* check truncation */
1083 file = fopen(tmp, "w");
1089 conf_write_heading(file, comment_style);
1091 for_all_symbols(i, sym)
1092 if ((sym->flags & SYMBOL_WRITE) && sym->name)
1093 print_symbol(file, sym);
1095 /* check possible errors in conf_write_heading() and print_symbol() */
1101 if (rename(tmp, filename)) {
1109 int conf_write_autoconf(int overwrite)
1112 const char *autoconf_name = conf_get_autoconfig_name();
1115 if (!overwrite && is_present(autoconf_name))
1118 ret = conf_write_autoconf_cmd(autoconf_name);
1122 if (conf_touch_deps())
1125 for_all_symbols(i, sym)
1126 sym_calc_value(sym);
1128 ret = __conf_write_autoconf(conf_get_autoheader_name(),
1135 * Create include/config/auto.conf. This must be the last step because
1136 * Kbuild has a dependency on auto.conf and this marks the successful
1137 * completion of the previous steps.
1139 ret = __conf_write_autoconf(conf_get_autoconfig_name(),
1140 print_symbol_for_autoconf,
1141 &comment_style_pound);
1148 static bool conf_changed;
1149 static void (*conf_changed_callback)(void);
1151 void conf_set_changed(bool val)
1153 if (conf_changed_callback && conf_changed != val)
1154 conf_changed_callback();
1159 bool conf_get_changed(void)
1161 return conf_changed;
1164 void conf_set_changed_callback(void (*fn)(void))
1166 conf_changed_callback = fn;
1169 void set_all_choice_values(struct symbol *csym)
1171 struct property *prop;
1175 prop = sym_get_choice_prop(csym);
1178 * Set all non-assinged choice values to no
1180 expr_list_for_each_sym(prop->expr, e, sym) {
1181 if (!sym_has_value(sym))
1182 sym->def[S_DEF_USER].tri = no;
1184 csym->flags |= SYMBOL_DEF_USER;
1185 /* clear VALID to get value calculated */
1186 csym->flags &= ~(SYMBOL_VALID | SYMBOL_NEED_SET_CHOICE_VALUES);