1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org>
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)
292 size_t new_size = slen + 1;
295 new_size += LINE_GROWTH - 1;
297 *lineptr = xrealloc(*lineptr, new_size);
301 (*lineptr)[slen] = c;
306 static ssize_t compat_getline(char **lineptr, size_t *n, FILE *stream)
308 char *line = *lineptr;
312 int c = getc(stream);
316 if (add_byte(c, &line, slen, n) < 0)
321 if (add_byte('\0', &line, slen, n) < 0)
328 if (add_byte(c, &line, slen, n) < 0)
340 int conf_read_simple(const char *name, int def)
344 size_t line_asize = 0;
348 const char *warn_unknown, *werror, *sym_name;
350 warn_unknown = getenv("KCONFIG_WARN_UNKNOWN_SYMBOLS");
351 werror = getenv("KCONFIG_WERROR");
353 in = zconf_fopen(name);
357 name = conf_get_configname();
358 in = zconf_fopen(name);
361 conf_set_changed(true);
363 env = getenv("KCONFIG_DEFCONFIG_LIST");
370 while (isspace(*env))
377 while (*p && !isspace(*p))
380 is_last = (*p == '\0');
384 in = zconf_fopen(env);
386 conf_message("using defaults found in %s",
401 conf_filename = name;
405 def_flags = SYMBOL_DEF << def;
406 for_all_symbols(i, sym) {
407 sym->flags |= SYMBOL_CHANGED;
408 sym->flags &= ~(def_flags|SYMBOL_VALID);
409 if (sym_is_choice(sym))
410 sym->flags |= def_flags;
415 if (sym->def[def].val)
416 free(sym->def[def].val);
419 sym->def[def].val = NULL;
420 sym->def[def].tri = no;
424 while (compat_getline(&line, &line_asize, in) != -1) {
426 if (line[0] == '#') {
430 if (memcmp(p, CONFIG_, strlen(CONFIG_)))
432 sym_name = p + strlen(CONFIG_);
433 p = strchr(sym_name, ' ');
437 if (strncmp(p, "is not set", 10))
441 } else if (memcmp(line, CONFIG_, strlen(CONFIG_)) == 0) {
442 sym_name = line + strlen(CONFIG_);
443 p = strchr(sym_name, '=');
448 p2 = strchr(p, '\n');
455 if (line[0] != '\r' && line[0] != '\n')
456 conf_warning("unexpected data: %.*s",
457 (int)strcspn(line, "\r\n"), line);
462 sym = sym_find(sym_name);
464 if (def == S_DEF_AUTO) {
466 * Reading from include/config/auto.conf.
467 * If CONFIG_FOO previously existed in auto.conf
468 * but it is missing now, include/config/FOO
471 conf_touch_dep(sym_name);
474 conf_warning("unknown symbol: %s", sym_name);
476 conf_set_changed(true);
481 if (sym->flags & def_flags)
482 conf_warning("override: reassigning to symbol %s", sym->name);
484 if (conf_set_sym_val(sym, def, def_flags, val))
487 if (sym && sym_is_choice_value(sym)) {
488 struct symbol *cs = prop_get_symbol(sym_get_choice_prop(sym));
489 switch (sym->def[def].tri) {
493 if (cs->def[def].tri == yes) {
494 conf_warning("%s creates inconsistent choice state", sym->name);
495 cs->flags &= ~def_flags;
499 if (cs->def[def].tri != no)
500 conf_warning("override: %s changes choice state", sym->name);
501 cs->def[def].val = sym;
504 cs->def[def].tri = EXPR_OR(cs->def[def].tri, sym->def[def].tri);
510 if (conf_warnings && werror)
516 int conf_read(const char *name)
519 int conf_unsaved = 0;
522 conf_set_changed(false);
524 if (conf_read_simple(name, S_DEF_USER)) {
525 sym_calc_value(modules_sym);
529 sym_calc_value(modules_sym);
531 for_all_symbols(i, sym) {
533 if (sym_is_choice(sym) || (sym->flags & SYMBOL_NO_WRITE))
535 if (sym_has_value(sym) && (sym->flags & SYMBOL_WRITE)) {
536 /* check that calculated value agrees with saved value */
540 if (sym->def[S_DEF_USER].tri == sym_get_tristate_value(sym))
544 if (!strcmp(sym->curr.val, sym->def[S_DEF_USER].val))
548 } else if (!sym_has_value(sym) && !(sym->flags & SYMBOL_WRITE))
549 /* no previous value and not saved */
552 /* maybe print value in verbose mode... */
555 for_all_symbols(i, sym) {
556 if (sym_has_value(sym) && !sym_is_choice_value(sym)) {
557 /* Reset values of generates values, so they'll appear
558 * as new, if they should become visible, but that
559 * doesn't quite work if the Kconfig and the saved
560 * configuration disagree.
562 if (sym->visible == no && !conf_unsaved)
563 sym->flags &= ~SYMBOL_DEF_USER;
568 /* Reset a string value if it's out of range */
569 if (sym_string_within_range(sym, sym->def[S_DEF_USER].val))
571 sym->flags &= ~SYMBOL_VALID;
580 if (conf_warnings || conf_unsaved)
581 conf_set_changed(true);
586 struct comment_style {
587 const char *decoration;
592 static const struct comment_style comment_style_pound = {
598 static const struct comment_style comment_style_c = {
604 static void conf_write_heading(FILE *fp, const struct comment_style *cs)
609 fprintf(fp, "%s\n", cs->prefix);
611 fprintf(fp, "%s Automatically generated file; DO NOT EDIT.\n",
614 fprintf(fp, "%s %s\n", cs->decoration, rootmenu.prompt->text);
616 fprintf(fp, "%s\n", cs->postfix);
619 /* The returned pointer must be freed on the caller side */
620 static char *escape_string_value(const char *in)
626 len = strlen(in) + strlen("\"\"") + 1;
630 p += strcspn(p, "\"\\");
646 len = strcspn(p, "\"\\");
647 strncat(out, p, len);
654 strncat(out, p++, 1);
662 enum output_n { OUTPUT_N, OUTPUT_N_AS_UNSET, OUTPUT_N_NONE };
664 static void __print_symbol(FILE *fp, struct symbol *sym, enum output_n output_n,
668 char *escaped = NULL;
670 if (sym->type == S_UNKNOWN)
673 val = sym_get_string_value(sym);
675 if ((sym->type == S_BOOLEAN || sym->type == S_TRISTATE) &&
676 output_n != OUTPUT_N && *val == 'n') {
677 if (output_n == OUTPUT_N_AS_UNSET)
678 fprintf(fp, "# %s%s is not set\n", CONFIG_, sym->name);
682 if (sym->type == S_STRING && escape_string) {
683 escaped = escape_string_value(val);
687 fprintf(fp, "%s%s=%s\n", CONFIG_, sym->name, val);
692 static void print_symbol_for_dotconfig(FILE *fp, struct symbol *sym)
694 __print_symbol(fp, sym, OUTPUT_N_AS_UNSET, true);
697 static void print_symbol_for_autoconf(FILE *fp, struct symbol *sym)
699 __print_symbol(fp, sym, OUTPUT_N_NONE, false);
702 void print_symbol_for_listconfig(struct symbol *sym)
704 __print_symbol(stdout, sym, OUTPUT_N, true);
707 static void print_symbol_for_c(FILE *fp, struct symbol *sym)
710 const char *sym_suffix = "";
711 const char *val_prefix = "";
712 char *escaped = NULL;
714 if (sym->type == S_UNKNOWN)
717 val = sym_get_string_value(sym);
726 sym_suffix = "_MODULE";
733 if (val[0] != '0' || (val[1] != 'x' && val[1] != 'X'))
737 escaped = escape_string_value(val);
743 fprintf(fp, "#define %s%s%s %s%s\n", CONFIG_, sym->name, sym_suffix,
749 static void print_symbol_for_rustccfg(FILE *fp, struct symbol *sym)
752 const char *val_prefix = "";
753 char *val_prefixed = NULL;
754 size_t val_prefixed_len;
755 char *escaped = NULL;
757 if (sym->type == S_UNKNOWN)
760 val = sym_get_string_value(sym);
766 * We do not care about disabled ones, i.e. no need for
767 * what otherwise are "comments" in other printers.
773 * To have similar functionality to the C macro `IS_ENABLED()`
774 * we provide an empty `--cfg CONFIG_X` here in both `y`
777 * Then, the common `fprintf()` below will also give us
778 * a `--cfg CONFIG_X="y"` or `--cfg CONFIG_X="m"`, which can
779 * be used as the equivalent of `IS_BUILTIN()`/`IS_MODULE()`.
781 fprintf(fp, "--cfg=%s%s\n", CONFIG_, sym->name);
784 if (val[0] != '0' || (val[1] != 'x' && val[1] != 'X'))
791 if (strlen(val_prefix) > 0) {
792 val_prefixed_len = strlen(val) + strlen(val_prefix) + 1;
793 val_prefixed = xmalloc(val_prefixed_len);
794 snprintf(val_prefixed, val_prefixed_len, "%s%s", val_prefix, val);
798 /* All values get escaped: the `--cfg` option only takes strings */
799 escaped = escape_string_value(val);
802 fprintf(fp, "--cfg=%s%s=%s\n", CONFIG_, sym->name, val);
809 * Write out a minimal config.
810 * All values that has default values are skipped as this is redundant.
812 int conf_write_defconfig(const char *filename)
818 out = fopen(filename, "w");
822 sym_clear_all_valid();
824 /* Traverse all menus to find all relevant symbols */
825 menu = rootmenu.list;
831 if (!menu_is_visible(menu))
833 } else if (!sym_is_choice(sym)) {
835 if (!(sym->flags & SYMBOL_WRITE))
837 sym->flags &= ~SYMBOL_WRITE;
838 /* If we cannot change the symbol - skip */
839 if (!sym_is_changeable(sym))
841 /* If symbol equals to default value - skip */
842 if (strcmp(sym_get_string_value(sym), sym_get_string_default(sym)) == 0)
846 * If symbol is a choice value and equals to the
847 * default for a choice - skip.
848 * But only if value is bool and equal to "y" and
849 * choice is not "optional".
850 * (If choice is "optional" then all values can be "n")
852 if (sym_is_choice_value(sym)) {
856 cs = prop_get_symbol(sym_get_choice_prop(sym));
857 ds = sym_choice_default(cs);
858 if (!sym_is_optional(cs) && sym == ds) {
859 if ((sym->type == S_BOOLEAN) &&
860 sym_get_tristate_value(sym) == yes)
864 print_symbol_for_dotconfig(out, sym);
867 if (menu->list != NULL) {
870 else if (menu->next != NULL) {
873 while ((menu = menu->parent)) {
874 if (menu->next != NULL) {
885 int conf_write(const char *name)
891 char tmpname[PATH_MAX + 1], oldname[PATH_MAX + 1];
894 bool need_newline = false;
897 name = conf_get_configname();
900 fprintf(stderr, "config name is empty\n");
905 fprintf(stderr, "%s: Is a directory\n", name);
909 if (make_parent_dir(name))
912 env = getenv("KCONFIG_OVERWRITECONFIG");
915 out = fopen(name, "w");
917 snprintf(tmpname, sizeof(tmpname), "%s.%d.tmp",
918 name, (int)getpid());
919 out = fopen(tmpname, "w");
924 conf_write_heading(out, &comment_style_pound);
926 if (!conf_get_changed())
927 sym_clear_all_valid();
929 menu = rootmenu.list;
933 if (!menu_is_visible(menu))
935 str = menu_get_prompt(menu);
940 need_newline = false;
941 } else if (!(sym->flags & SYMBOL_CHOICE) &&
942 !(sym->flags & SYMBOL_WRITTEN)) {
944 if (!(sym->flags & SYMBOL_WRITE))
948 need_newline = false;
950 sym->flags |= SYMBOL_WRITTEN;
951 print_symbol_for_dotconfig(out, sym);
961 if (!menu->sym && menu_is_visible(menu) && menu != &rootmenu &&
962 menu->prompt->type == P_MENU) {
963 fprintf(out, "# end of %s\n", menu_get_prompt(menu));
977 for_all_symbols(i, sym)
978 sym->flags &= ~SYMBOL_WRITTEN;
981 if (is_same(name, tmpname)) {
982 conf_message("No change to %s", name);
984 conf_set_changed(false);
988 snprintf(oldname, sizeof(oldname), "%s.old", name);
989 rename(name, oldname);
990 if (rename(tmpname, name))
994 conf_message("configuration written to %s", name);
996 conf_set_changed(false);
1001 /* write a dependency file as used by kbuild to track dependencies */
1002 static int conf_write_autoconf_cmd(const char *autoconf_name)
1004 char name[PATH_MAX], tmp[PATH_MAX];
1009 ret = snprintf(name, sizeof(name), "%s.cmd", autoconf_name);
1010 if (ret >= sizeof(name)) /* check truncation */
1013 if (make_parent_dir(name))
1016 ret = snprintf(tmp, sizeof(tmp), "%s.cmd.tmp", autoconf_name);
1017 if (ret >= sizeof(tmp)) /* check truncation */
1020 out = fopen(tmp, "w");
1026 fprintf(out, "deps_config := \\\n");
1027 for (file = file_list; file; file = file->next)
1028 fprintf(out, "\t%s \\\n", file->name);
1030 fprintf(out, "\n%s: $(deps_config)\n\n", autoconf_name);
1032 env_write_dep(out, autoconf_name);
1034 fprintf(out, "\n$(deps_config): ;\n");
1037 ret = ferror(out); /* error check for all fprintf() calls */
1042 if (rename(tmp, name)) {
1050 static int conf_touch_deps(void)
1052 const char *name, *tmp;
1056 name = conf_get_autoconfig_name();
1057 tmp = strrchr(name, '/');
1058 depfile_prefix_len = tmp ? tmp - name + 1 : 0;
1059 if (depfile_prefix_len + 1 > sizeof(depfile_path))
1062 strncpy(depfile_path, name, depfile_prefix_len);
1063 depfile_path[depfile_prefix_len] = 0;
1065 conf_read_simple(name, S_DEF_AUTO);
1066 sym_calc_value(modules_sym);
1068 for_all_symbols(i, sym) {
1069 sym_calc_value(sym);
1070 if ((sym->flags & SYMBOL_NO_WRITE) || !sym->name)
1072 if (sym->flags & SYMBOL_WRITE) {
1073 if (sym->flags & SYMBOL_DEF_AUTO) {
1075 * symbol has old and new value,
1076 * so compare them...
1078 switch (sym->type) {
1081 if (sym_get_tristate_value(sym) ==
1082 sym->def[S_DEF_AUTO].tri)
1088 if (!strcmp(sym_get_string_value(sym),
1089 sym->def[S_DEF_AUTO].val))
1097 * If there is no old value, only 'no' (unset)
1098 * is allowed as new value.
1100 switch (sym->type) {
1103 if (sym_get_tristate_value(sym) == no)
1110 } else if (!(sym->flags & SYMBOL_DEF_AUTO))
1111 /* There is neither an old nor a new value. */
1114 * There is an old value, but no new value ('no' (unset)
1115 * isn't saved in auto.conf, so the old value is always
1116 * different from 'no').
1119 res = conf_touch_dep(sym->name);
1127 static int __conf_write_autoconf(const char *filename,
1128 void (*print_symbol)(FILE *, struct symbol *),
1129 const struct comment_style *comment_style)
1136 if (make_parent_dir(filename))
1139 ret = snprintf(tmp, sizeof(tmp), "%s.tmp", filename);
1140 if (ret >= sizeof(tmp)) /* check truncation */
1143 file = fopen(tmp, "w");
1149 conf_write_heading(file, comment_style);
1151 for_all_symbols(i, sym)
1152 if ((sym->flags & SYMBOL_WRITE) && sym->name)
1153 print_symbol(file, sym);
1156 /* check possible errors in conf_write_heading() and print_symbol() */
1162 if (rename(tmp, filename)) {
1170 int conf_write_autoconf(int overwrite)
1173 const char *autoconf_name = conf_get_autoconfig_name();
1176 if (!overwrite && is_present(autoconf_name))
1179 ret = conf_write_autoconf_cmd(autoconf_name);
1183 if (conf_touch_deps())
1186 for_all_symbols(i, sym)
1187 sym_calc_value(sym);
1189 ret = __conf_write_autoconf(conf_get_autoheader_name(),
1195 ret = __conf_write_autoconf(conf_get_rustccfg_name(),
1196 print_symbol_for_rustccfg,
1202 * Create include/config/auto.conf. This must be the last step because
1203 * Kbuild has a dependency on auto.conf and this marks the successful
1204 * completion of the previous steps.
1206 ret = __conf_write_autoconf(conf_get_autoconfig_name(),
1207 print_symbol_for_autoconf,
1208 &comment_style_pound);
1215 static bool conf_changed;
1216 static void (*conf_changed_callback)(void);
1218 void conf_set_changed(bool val)
1220 bool changed = conf_changed != val;
1224 if (conf_changed_callback && changed)
1225 conf_changed_callback();
1228 bool conf_get_changed(void)
1230 return conf_changed;
1233 void conf_set_changed_callback(void (*fn)(void))
1235 conf_changed_callback = fn;
1238 void set_all_choice_values(struct symbol *csym)
1240 struct property *prop;
1244 prop = sym_get_choice_prop(csym);
1247 * Set all non-assinged choice values to no
1249 expr_list_for_each_sym(prop->expr, e, sym) {
1250 if (!sym_has_value(sym))
1251 sym->def[S_DEF_USER].tri = no;
1253 csym->flags |= SYMBOL_DEF_USER;
1254 /* clear VALID to get value calculated */
1255 csym->flags &= ~(SYMBOL_VALID | SYMBOL_NEED_SET_CHOICE_VALUES);