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 const char *conf_get_rustccfg_name(void)
221 char *name = getenv("KCONFIG_RUSTCCFG");
223 return name ? name : "include/generated/rustc_cfg";
226 static int conf_set_sym_val(struct symbol *sym, int def, int def_flags, char *p)
233 sym->def[def].tri = mod;
234 sym->flags |= def_flags;
240 sym->def[def].tri = yes;
241 sym->flags |= def_flags;
245 sym->def[def].tri = no;
246 sym->flags |= def_flags;
249 if (def != S_DEF_AUTO)
250 conf_warning("symbol value '%s' invalid for %s",
254 /* No escaping for S_DEF_AUTO (include/config/auto.conf) */
255 if (def != S_DEF_AUTO) {
258 for (p2 = p; (p2 = strpbrk(p2, "\"\\")); p2++) {
263 memmove(p2, p2 + 1, strlen(p2));
266 conf_warning("invalid string found");
273 if (sym_string_valid(sym, p)) {
274 sym->def[def].val = xstrdup(p);
275 sym->flags |= def_flags;
277 if (def != S_DEF_AUTO)
278 conf_warning("symbol value '%s' invalid for %s",
289 #define LINE_GROWTH 16
290 static int add_byte(int c, char **lineptr, size_t slen, size_t *n)
293 size_t new_size = slen + 1;
295 new_size += LINE_GROWTH - 1;
297 nline = xrealloc(*lineptr, new_size);
305 (*lineptr)[slen] = c;
310 static ssize_t compat_getline(char **lineptr, size_t *n, FILE *stream)
312 char *line = *lineptr;
316 int c = getc(stream);
320 if (add_byte(c, &line, slen, n) < 0)
325 if (add_byte('\0', &line, slen, n) < 0)
332 if (add_byte(c, &line, slen, n) < 0)
344 int conf_read_simple(const char *name, int def)
348 size_t line_asize = 0;
354 in = zconf_fopen(name);
358 name = conf_get_configname();
359 in = zconf_fopen(name);
362 conf_set_changed(true);
364 env = getenv("KCONFIG_DEFCONFIG_LIST");
371 while (isspace(*env))
378 while (*p && !isspace(*p))
381 is_last = (*p == '\0');
385 in = zconf_fopen(env);
387 conf_message("using defaults found in %s",
402 conf_filename = name;
406 def_flags = SYMBOL_DEF << def;
407 for_all_symbols(i, sym) {
408 sym->flags |= SYMBOL_CHANGED;
409 sym->flags &= ~(def_flags|SYMBOL_VALID);
410 if (sym_is_choice(sym))
411 sym->flags |= def_flags;
416 if (sym->def[def].val)
417 free(sym->def[def].val);
420 sym->def[def].val = NULL;
421 sym->def[def].tri = no;
425 while (compat_getline(&line, &line_asize, in) != -1) {
428 if (line[0] == '#') {
429 if (memcmp(line + 2, CONFIG_, strlen(CONFIG_)))
431 p = strchr(line + 2 + strlen(CONFIG_), ' ');
435 if (strncmp(p, "is not set", 10))
437 if (def == S_DEF_USER) {
438 sym = sym_find(line + 2 + strlen(CONFIG_));
440 conf_set_changed(true);
444 sym = sym_lookup(line + 2 + strlen(CONFIG_), 0);
445 if (sym->type == S_UNKNOWN)
446 sym->type = S_BOOLEAN;
448 if (sym->flags & def_flags) {
449 conf_warning("override: reassigning to symbol %s", sym->name);
454 sym->def[def].tri = no;
455 sym->flags |= def_flags;
460 } else if (memcmp(line, CONFIG_, strlen(CONFIG_)) == 0) {
461 p = strchr(line + strlen(CONFIG_), '=');
465 p2 = strchr(p, '\n');
472 sym = sym_find(line + strlen(CONFIG_));
474 if (def == S_DEF_AUTO)
476 * Reading from include/config/auto.conf
477 * If CONFIG_FOO previously existed in
478 * auto.conf but it is missing now,
479 * include/config/FOO must be touched.
481 conf_touch_dep(line + strlen(CONFIG_));
483 conf_set_changed(true);
487 if (sym->flags & def_flags) {
488 conf_warning("override: reassigning to symbol %s", sym->name);
490 if (conf_set_sym_val(sym, def, def_flags, p))
493 if (line[0] != '\r' && line[0] != '\n')
494 conf_warning("unexpected data: %.*s",
495 (int)strcspn(line, "\r\n"), line);
500 if (sym && sym_is_choice_value(sym)) {
501 struct symbol *cs = prop_get_symbol(sym_get_choice_prop(sym));
502 switch (sym->def[def].tri) {
506 if (cs->def[def].tri == yes) {
507 conf_warning("%s creates inconsistent choice state", sym->name);
508 cs->flags &= ~def_flags;
512 if (cs->def[def].tri != no)
513 conf_warning("override: %s changes choice state", sym->name);
514 cs->def[def].val = sym;
517 cs->def[def].tri = EXPR_OR(cs->def[def].tri, sym->def[def].tri);
525 int conf_read(const char *name)
528 int conf_unsaved = 0;
531 conf_set_changed(false);
533 if (conf_read_simple(name, S_DEF_USER)) {
534 sym_calc_value(modules_sym);
538 sym_calc_value(modules_sym);
540 for_all_symbols(i, sym) {
542 if (sym_is_choice(sym) || (sym->flags & SYMBOL_NO_WRITE))
544 if (sym_has_value(sym) && (sym->flags & SYMBOL_WRITE)) {
545 /* check that calculated value agrees with saved value */
549 if (sym->def[S_DEF_USER].tri == sym_get_tristate_value(sym))
553 if (!strcmp(sym->curr.val, sym->def[S_DEF_USER].val))
557 } else if (!sym_has_value(sym) && !(sym->flags & SYMBOL_WRITE))
558 /* no previous value and not saved */
561 /* maybe print value in verbose mode... */
564 for_all_symbols(i, sym) {
565 if (sym_has_value(sym) && !sym_is_choice_value(sym)) {
566 /* Reset values of generates values, so they'll appear
567 * as new, if they should become visible, but that
568 * doesn't quite work if the Kconfig and the saved
569 * configuration disagree.
571 if (sym->visible == no && !conf_unsaved)
572 sym->flags &= ~SYMBOL_DEF_USER;
577 /* Reset a string value if it's out of range */
578 if (sym_string_within_range(sym, sym->def[S_DEF_USER].val))
580 sym->flags &= ~(SYMBOL_VALID|SYMBOL_DEF_USER);
589 if (conf_warnings || conf_unsaved)
590 conf_set_changed(true);
595 struct comment_style {
596 const char *decoration;
601 static const struct comment_style comment_style_pound = {
607 static const struct comment_style comment_style_c = {
613 static void conf_write_heading(FILE *fp, const struct comment_style *cs)
618 fprintf(fp, "%s\n", cs->prefix);
620 fprintf(fp, "%s Automatically generated file; DO NOT EDIT.\n",
623 fprintf(fp, "%s %s\n", cs->decoration, rootmenu.prompt->text);
625 fprintf(fp, "%s\n", cs->postfix);
628 /* The returned pointer must be freed on the caller side */
629 static char *escape_string_value(const char *in)
635 len = strlen(in) + strlen("\"\"") + 1;
639 p += strcspn(p, "\"\\");
655 len = strcspn(p, "\"\\");
656 strncat(out, p, len);
663 strncat(out, p++, 1);
671 enum output_n { OUTPUT_N, OUTPUT_N_AS_UNSET, OUTPUT_N_NONE };
673 static void __print_symbol(FILE *fp, struct symbol *sym, enum output_n output_n,
677 char *escaped = NULL;
679 if (sym->type == S_UNKNOWN)
682 val = sym_get_string_value(sym);
684 if ((sym->type == S_BOOLEAN || sym->type == S_TRISTATE) &&
685 output_n != OUTPUT_N && *val == 'n') {
686 if (output_n == OUTPUT_N_AS_UNSET)
687 fprintf(fp, "# %s%s is not set\n", CONFIG_, sym->name);
691 if (sym->type == S_STRING && escape_string) {
692 escaped = escape_string_value(val);
696 fprintf(fp, "%s%s=%s\n", CONFIG_, sym->name, val);
701 static void print_symbol_for_dotconfig(FILE *fp, struct symbol *sym)
703 __print_symbol(fp, sym, OUTPUT_N_AS_UNSET, true);
706 static void print_symbol_for_autoconf(FILE *fp, struct symbol *sym)
708 __print_symbol(fp, sym, OUTPUT_N_NONE, false);
711 void print_symbol_for_listconfig(struct symbol *sym)
713 __print_symbol(stdout, sym, OUTPUT_N, true);
716 static void print_symbol_for_c(FILE *fp, struct symbol *sym)
719 const char *sym_suffix = "";
720 const char *val_prefix = "";
721 char *escaped = NULL;
723 if (sym->type == S_UNKNOWN)
726 val = sym_get_string_value(sym);
735 sym_suffix = "_MODULE";
742 if (val[0] != '0' || (val[1] != 'x' && val[1] != 'X'))
746 escaped = escape_string_value(val);
752 fprintf(fp, "#define %s%s%s %s%s\n", CONFIG_, sym->name, sym_suffix,
758 static void print_symbol_for_rustccfg(FILE *fp, struct symbol *sym)
761 const char *val_prefix = "";
762 char *val_prefixed = NULL;
763 size_t val_prefixed_len;
764 char *escaped = NULL;
766 if (sym->type == S_UNKNOWN)
769 val = sym_get_string_value(sym);
775 * We do not care about disabled ones, i.e. no need for
776 * what otherwise are "comments" in other printers.
782 * To have similar functionality to the C macro `IS_ENABLED()`
783 * we provide an empty `--cfg CONFIG_X` here in both `y`
786 * Then, the common `fprintf()` below will also give us
787 * a `--cfg CONFIG_X="y"` or `--cfg CONFIG_X="m"`, which can
788 * be used as the equivalent of `IS_BUILTIN()`/`IS_MODULE()`.
790 fprintf(fp, "--cfg=%s%s\n", CONFIG_, sym->name);
793 if (val[0] != '0' || (val[1] != 'x' && val[1] != 'X'))
800 if (strlen(val_prefix) > 0) {
801 val_prefixed_len = strlen(val) + strlen(val_prefix) + 1;
802 val_prefixed = xmalloc(val_prefixed_len);
803 snprintf(val_prefixed, val_prefixed_len, "%s%s", val_prefix, val);
807 /* All values get escaped: the `--cfg` option only takes strings */
808 escaped = escape_string_value(val);
811 fprintf(fp, "--cfg=%s%s=%s\n", CONFIG_, sym->name, val);
818 * Write out a minimal config.
819 * All values that has default values are skipped as this is redundant.
821 int conf_write_defconfig(const char *filename)
827 out = fopen(filename, "w");
831 sym_clear_all_valid();
833 /* Traverse all menus to find all relevant symbols */
834 menu = rootmenu.list;
840 if (!menu_is_visible(menu))
842 } else if (!sym_is_choice(sym)) {
844 if (!(sym->flags & SYMBOL_WRITE))
846 sym->flags &= ~SYMBOL_WRITE;
847 /* If we cannot change the symbol - skip */
848 if (!sym_is_changeable(sym))
850 /* If symbol equals to default value - skip */
851 if (strcmp(sym_get_string_value(sym), sym_get_string_default(sym)) == 0)
855 * If symbol is a choice value and equals to the
856 * default for a choice - skip.
857 * But only if value is bool and equal to "y" and
858 * choice is not "optional".
859 * (If choice is "optional" then all values can be "n")
861 if (sym_is_choice_value(sym)) {
865 cs = prop_get_symbol(sym_get_choice_prop(sym));
866 ds = sym_choice_default(cs);
867 if (!sym_is_optional(cs) && sym == ds) {
868 if ((sym->type == S_BOOLEAN) &&
869 sym_get_tristate_value(sym) == yes)
873 print_symbol_for_dotconfig(out, sym);
876 if (menu->list != NULL) {
879 else if (menu->next != NULL) {
882 while ((menu = menu->parent)) {
883 if (menu->next != NULL) {
894 int conf_write(const char *name)
900 char tmpname[PATH_MAX + 1], oldname[PATH_MAX + 1];
903 bool need_newline = false;
906 name = conf_get_configname();
909 fprintf(stderr, "config name is empty\n");
914 fprintf(stderr, "%s: Is a directory\n", name);
918 if (make_parent_dir(name))
921 env = getenv("KCONFIG_OVERWRITECONFIG");
924 out = fopen(name, "w");
926 snprintf(tmpname, sizeof(tmpname), "%s.%d.tmp",
927 name, (int)getpid());
928 out = fopen(tmpname, "w");
933 conf_write_heading(out, &comment_style_pound);
935 if (!conf_get_changed())
936 sym_clear_all_valid();
938 menu = rootmenu.list;
942 if (!menu_is_visible(menu))
944 str = menu_get_prompt(menu);
949 need_newline = false;
950 } else if (!(sym->flags & SYMBOL_CHOICE) &&
951 !(sym->flags & SYMBOL_WRITTEN)) {
953 if (!(sym->flags & SYMBOL_WRITE))
957 need_newline = false;
959 sym->flags |= SYMBOL_WRITTEN;
960 print_symbol_for_dotconfig(out, sym);
970 if (!menu->sym && menu_is_visible(menu) && menu != &rootmenu &&
971 menu->prompt->type == P_MENU) {
972 fprintf(out, "# end of %s\n", menu_get_prompt(menu));
986 for_all_symbols(i, sym)
987 sym->flags &= ~SYMBOL_WRITTEN;
990 if (is_same(name, tmpname)) {
991 conf_message("No change to %s", name);
993 conf_set_changed(false);
997 snprintf(oldname, sizeof(oldname), "%s.old", name);
998 rename(name, oldname);
999 if (rename(tmpname, name))
1003 conf_message("configuration written to %s", name);
1005 conf_set_changed(false);
1010 /* write a dependency file as used by kbuild to track dependencies */
1011 static int conf_write_autoconf_cmd(const char *autoconf_name)
1013 char name[PATH_MAX], tmp[PATH_MAX];
1018 ret = snprintf(name, sizeof(name), "%s.cmd", autoconf_name);
1019 if (ret >= sizeof(name)) /* check truncation */
1022 if (make_parent_dir(name))
1025 ret = snprintf(tmp, sizeof(tmp), "%s.cmd.tmp", autoconf_name);
1026 if (ret >= sizeof(tmp)) /* check truncation */
1029 out = fopen(tmp, "w");
1035 fprintf(out, "deps_config := \\\n");
1036 for (file = file_list; file; file = file->next)
1037 fprintf(out, "\t%s \\\n", file->name);
1039 fprintf(out, "\n%s: $(deps_config)\n\n", autoconf_name);
1041 env_write_dep(out, autoconf_name);
1043 fprintf(out, "\n$(deps_config): ;\n");
1046 ret = ferror(out); /* error check for all fprintf() calls */
1051 if (rename(tmp, name)) {
1059 static int conf_touch_deps(void)
1061 const char *name, *tmp;
1065 name = conf_get_autoconfig_name();
1066 tmp = strrchr(name, '/');
1067 depfile_prefix_len = tmp ? tmp - name + 1 : 0;
1068 if (depfile_prefix_len + 1 > sizeof(depfile_path))
1071 strncpy(depfile_path, name, depfile_prefix_len);
1072 depfile_path[depfile_prefix_len] = 0;
1074 conf_read_simple(name, S_DEF_AUTO);
1075 sym_calc_value(modules_sym);
1077 for_all_symbols(i, sym) {
1078 sym_calc_value(sym);
1079 if ((sym->flags & SYMBOL_NO_WRITE) || !sym->name)
1081 if (sym->flags & SYMBOL_WRITE) {
1082 if (sym->flags & SYMBOL_DEF_AUTO) {
1084 * symbol has old and new value,
1085 * so compare them...
1087 switch (sym->type) {
1090 if (sym_get_tristate_value(sym) ==
1091 sym->def[S_DEF_AUTO].tri)
1097 if (!strcmp(sym_get_string_value(sym),
1098 sym->def[S_DEF_AUTO].val))
1106 * If there is no old value, only 'no' (unset)
1107 * is allowed as new value.
1109 switch (sym->type) {
1112 if (sym_get_tristate_value(sym) == no)
1119 } else if (!(sym->flags & SYMBOL_DEF_AUTO))
1120 /* There is neither an old nor a new value. */
1123 * There is an old value, but no new value ('no' (unset)
1124 * isn't saved in auto.conf, so the old value is always
1125 * different from 'no').
1128 res = conf_touch_dep(sym->name);
1136 static int __conf_write_autoconf(const char *filename,
1137 void (*print_symbol)(FILE *, struct symbol *),
1138 const struct comment_style *comment_style)
1145 if (make_parent_dir(filename))
1148 ret = snprintf(tmp, sizeof(tmp), "%s.tmp", filename);
1149 if (ret >= sizeof(tmp)) /* check truncation */
1152 file = fopen(tmp, "w");
1158 conf_write_heading(file, comment_style);
1160 for_all_symbols(i, sym)
1161 if ((sym->flags & SYMBOL_WRITE) && sym->name)
1162 print_symbol(file, sym);
1165 /* check possible errors in conf_write_heading() and print_symbol() */
1171 if (rename(tmp, filename)) {
1179 int conf_write_autoconf(int overwrite)
1182 const char *autoconf_name = conf_get_autoconfig_name();
1185 if (!overwrite && is_present(autoconf_name))
1188 ret = conf_write_autoconf_cmd(autoconf_name);
1192 if (conf_touch_deps())
1195 for_all_symbols(i, sym)
1196 sym_calc_value(sym);
1198 ret = __conf_write_autoconf(conf_get_autoheader_name(),
1204 ret = __conf_write_autoconf(conf_get_rustccfg_name(),
1205 print_symbol_for_rustccfg,
1211 * Create include/config/auto.conf. This must be the last step because
1212 * Kbuild has a dependency on auto.conf and this marks the successful
1213 * completion of the previous steps.
1215 ret = __conf_write_autoconf(conf_get_autoconfig_name(),
1216 print_symbol_for_autoconf,
1217 &comment_style_pound);
1224 static bool conf_changed;
1225 static void (*conf_changed_callback)(void);
1227 void conf_set_changed(bool val)
1229 if (conf_changed_callback && conf_changed != val)
1230 conf_changed_callback();
1235 bool conf_get_changed(void)
1237 return conf_changed;
1240 void conf_set_changed_callback(void (*fn)(void))
1242 conf_changed_callback = fn;
1245 void set_all_choice_values(struct symbol *csym)
1247 struct property *prop;
1251 prop = sym_get_choice_prop(csym);
1254 * Set all non-assinged choice values to no
1256 expr_list_for_each_sym(prop->expr, e, sym) {
1257 if (!sym_has_value(sym))
1258 sym->def[S_DEF_USER].tri = no;
1260 csym->flags |= SYMBOL_DEF_USER;
1261 /* clear VALID to get value calculated */
1262 csym->flags &= ~(SYMBOL_VALID | SYMBOL_NEED_SET_CHOICE_VALUES);