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 bool conf_errors(void)
161 return getenv("KCONFIG_WERROR");
165 static void conf_warning(const char *fmt, ...)
169 fprintf(stderr, "%s:%d:warning: ", conf_filename, conf_lineno);
170 vfprintf(stderr, fmt, ap);
171 fprintf(stderr, "\n");
176 static void conf_default_message_callback(const char *s)
183 static void (*conf_message_callback)(const char *s) =
184 conf_default_message_callback;
185 void conf_set_message_callback(void (*fn)(const char *s))
187 conf_message_callback = fn;
190 static void conf_message(const char *fmt, ...)
195 if (!conf_message_callback)
200 vsnprintf(buf, sizeof(buf), fmt, ap);
201 conf_message_callback(buf);
205 const char *conf_get_configname(void)
207 char *name = getenv("KCONFIG_CONFIG");
209 return name ? name : ".config";
212 static const char *conf_get_autoconfig_name(void)
214 char *name = getenv("KCONFIG_AUTOCONFIG");
216 return name ? name : "include/config/auto.conf";
219 static const char *conf_get_autoheader_name(void)
221 char *name = getenv("KCONFIG_AUTOHEADER");
223 return name ? name : "include/generated/autoconf.h";
226 static const char *conf_get_rustccfg_name(void)
228 char *name = getenv("KCONFIG_RUSTCCFG");
230 return name ? name : "include/generated/rustc_cfg";
233 static int conf_set_sym_val(struct symbol *sym, int def, int def_flags, char *p)
240 sym->def[def].tri = mod;
241 sym->flags |= def_flags;
247 sym->def[def].tri = yes;
248 sym->flags |= def_flags;
252 sym->def[def].tri = no;
253 sym->flags |= def_flags;
256 if (def != S_DEF_AUTO)
257 conf_warning("symbol value '%s' invalid for %s",
261 /* No escaping for S_DEF_AUTO (include/config/auto.conf) */
262 if (def != S_DEF_AUTO) {
265 for (p2 = p; (p2 = strpbrk(p2, "\"\\")); p2++) {
270 memmove(p2, p2 + 1, strlen(p2));
273 conf_warning("invalid string found");
280 if (sym_string_valid(sym, p)) {
281 sym->def[def].val = xstrdup(p);
282 sym->flags |= def_flags;
284 if (def != S_DEF_AUTO)
285 conf_warning("symbol value '%s' invalid for %s",
296 #define LINE_GROWTH 16
297 static int add_byte(int c, char **lineptr, size_t slen, size_t *n)
299 size_t new_size = slen + 1;
302 new_size += LINE_GROWTH - 1;
304 *lineptr = xrealloc(*lineptr, new_size);
308 (*lineptr)[slen] = c;
313 static ssize_t compat_getline(char **lineptr, size_t *n, FILE *stream)
315 char *line = *lineptr;
319 int c = getc(stream);
323 if (add_byte(c, &line, slen, n) < 0)
328 if (add_byte('\0', &line, slen, n) < 0)
335 if (add_byte(c, &line, slen, n) < 0)
347 /* like getline(), but the newline character is stripped away */
348 static ssize_t getline_stripped(char **lineptr, size_t *n, FILE *stream)
352 len = compat_getline(lineptr, n, stream);
354 if (len > 0 && (*lineptr)[len - 1] == '\n') {
356 (*lineptr)[len] = '\0';
358 if (len > 0 && (*lineptr)[len - 1] == '\r') {
360 (*lineptr)[len] = '\0';
367 int conf_read_simple(const char *name, int def)
371 size_t line_asize = 0;
375 const char *warn_unknown, *sym_name;
377 warn_unknown = getenv("KCONFIG_WARN_UNKNOWN_SYMBOLS");
379 in = zconf_fopen(name);
383 name = conf_get_configname();
384 in = zconf_fopen(name);
387 conf_set_changed(true);
389 env = getenv("KCONFIG_DEFCONFIG_LIST");
396 while (isspace(*env))
403 while (*p && !isspace(*p))
406 is_last = (*p == '\0');
410 in = zconf_fopen(env);
412 conf_message("using defaults found in %s",
427 conf_filename = name;
431 def_flags = SYMBOL_DEF << def;
432 for_all_symbols(i, sym) {
433 sym->flags |= SYMBOL_CHANGED;
434 sym->flags &= ~(def_flags|SYMBOL_VALID);
435 if (sym_is_choice(sym))
436 sym->flags |= def_flags;
441 free(sym->def[def].val);
444 sym->def[def].val = NULL;
445 sym->def[def].tri = no;
449 while (getline_stripped(&line, &line_asize, in) != -1) {
452 if (!line[0]) /* blank line */
455 if (line[0] == '#') {
459 if (memcmp(p, CONFIG_, strlen(CONFIG_)))
461 sym_name = p + strlen(CONFIG_);
462 p = strchr(sym_name, ' ');
466 if (strcmp(p, "is not set"))
471 if (memcmp(line, CONFIG_, strlen(CONFIG_))) {
472 conf_warning("unexpected data: %s", line);
476 sym_name = line + strlen(CONFIG_);
477 p = strchr(sym_name, '=');
479 conf_warning("unexpected data: %s", line);
486 sym = sym_find(sym_name);
488 if (def == S_DEF_AUTO) {
490 * Reading from include/config/auto.conf.
491 * If CONFIG_FOO previously existed in auto.conf
492 * but it is missing now, include/config/FOO
495 conf_touch_dep(sym_name);
498 conf_warning("unknown symbol: %s", sym_name);
500 conf_set_changed(true);
505 if (sym->flags & def_flags)
506 conf_warning("override: reassigning to symbol %s", sym->name);
508 if (conf_set_sym_val(sym, def, def_flags, val))
511 if (sym && sym_is_choice_value(sym)) {
512 struct symbol *cs = prop_get_symbol(sym_get_choice_prop(sym));
513 switch (sym->def[def].tri) {
517 if (cs->def[def].tri == yes) {
518 conf_warning("%s creates inconsistent choice state", sym->name);
519 cs->flags &= ~def_flags;
523 if (cs->def[def].tri != no)
524 conf_warning("override: %s changes choice state", sym->name);
525 cs->def[def].val = sym;
528 cs->def[def].tri = EXPR_OR(cs->def[def].tri, sym->def[def].tri);
537 int conf_read(const char *name)
540 int conf_unsaved = 0;
543 conf_set_changed(false);
545 if (conf_read_simple(name, S_DEF_USER)) {
546 sym_calc_value(modules_sym);
550 sym_calc_value(modules_sym);
552 for_all_symbols(i, sym) {
554 if (sym_is_choice(sym) || (sym->flags & SYMBOL_NO_WRITE))
556 if (sym_has_value(sym) && (sym->flags & SYMBOL_WRITE)) {
557 /* check that calculated value agrees with saved value */
561 if (sym->def[S_DEF_USER].tri == sym_get_tristate_value(sym))
565 if (!strcmp(sym->curr.val, sym->def[S_DEF_USER].val))
569 } else if (!sym_has_value(sym) && !(sym->flags & SYMBOL_WRITE))
570 /* no previous value and not saved */
573 /* maybe print value in verbose mode... */
576 for_all_symbols(i, sym) {
577 if (sym_has_value(sym) && !sym_is_choice_value(sym)) {
578 /* Reset values of generates values, so they'll appear
579 * as new, if they should become visible, but that
580 * doesn't quite work if the Kconfig and the saved
581 * configuration disagree.
583 if (sym->visible == no && !conf_unsaved)
584 sym->flags &= ~SYMBOL_DEF_USER;
589 /* Reset a string value if it's out of range */
590 if (sym_string_within_range(sym, sym->def[S_DEF_USER].val))
592 sym->flags &= ~SYMBOL_VALID;
601 if (conf_warnings || conf_unsaved)
602 conf_set_changed(true);
607 struct comment_style {
608 const char *decoration;
613 static const struct comment_style comment_style_pound = {
619 static const struct comment_style comment_style_c = {
625 static void conf_write_heading(FILE *fp, const struct comment_style *cs)
630 fprintf(fp, "%s\n", cs->prefix);
632 fprintf(fp, "%s Automatically generated file; DO NOT EDIT.\n",
635 fprintf(fp, "%s %s\n", cs->decoration, rootmenu.prompt->text);
637 fprintf(fp, "%s\n", cs->postfix);
640 /* The returned pointer must be freed on the caller side */
641 static char *escape_string_value(const char *in)
647 len = strlen(in) + strlen("\"\"") + 1;
651 p += strcspn(p, "\"\\");
667 len = strcspn(p, "\"\\");
668 strncat(out, p, len);
675 strncat(out, p++, 1);
683 enum output_n { OUTPUT_N, OUTPUT_N_AS_UNSET, OUTPUT_N_NONE };
685 static void __print_symbol(FILE *fp, struct symbol *sym, enum output_n output_n,
689 char *escaped = NULL;
691 if (sym->type == S_UNKNOWN)
694 val = sym_get_string_value(sym);
696 if ((sym->type == S_BOOLEAN || sym->type == S_TRISTATE) &&
697 output_n != OUTPUT_N && *val == 'n') {
698 if (output_n == OUTPUT_N_AS_UNSET)
699 fprintf(fp, "# %s%s is not set\n", CONFIG_, sym->name);
703 if (sym->type == S_STRING && escape_string) {
704 escaped = escape_string_value(val);
708 fprintf(fp, "%s%s=%s\n", CONFIG_, sym->name, val);
713 static void print_symbol_for_dotconfig(FILE *fp, struct symbol *sym)
715 __print_symbol(fp, sym, OUTPUT_N_AS_UNSET, true);
718 static void print_symbol_for_autoconf(FILE *fp, struct symbol *sym)
720 __print_symbol(fp, sym, OUTPUT_N_NONE, false);
723 void print_symbol_for_listconfig(struct symbol *sym)
725 __print_symbol(stdout, sym, OUTPUT_N, true);
728 static void print_symbol_for_c(FILE *fp, struct symbol *sym)
731 const char *sym_suffix = "";
732 const char *val_prefix = "";
733 char *escaped = NULL;
735 if (sym->type == S_UNKNOWN)
738 val = sym_get_string_value(sym);
747 sym_suffix = "_MODULE";
754 if (val[0] != '0' || (val[1] != 'x' && val[1] != 'X'))
758 escaped = escape_string_value(val);
764 fprintf(fp, "#define %s%s%s %s%s\n", CONFIG_, sym->name, sym_suffix,
770 static void print_symbol_for_rustccfg(FILE *fp, struct symbol *sym)
773 const char *val_prefix = "";
774 char *val_prefixed = NULL;
775 size_t val_prefixed_len;
776 char *escaped = NULL;
778 if (sym->type == S_UNKNOWN)
781 val = sym_get_string_value(sym);
787 * We do not care about disabled ones, i.e. no need for
788 * what otherwise are "comments" in other printers.
794 * To have similar functionality to the C macro `IS_ENABLED()`
795 * we provide an empty `--cfg CONFIG_X` here in both `y`
798 * Then, the common `fprintf()` below will also give us
799 * a `--cfg CONFIG_X="y"` or `--cfg CONFIG_X="m"`, which can
800 * be used as the equivalent of `IS_BUILTIN()`/`IS_MODULE()`.
802 fprintf(fp, "--cfg=%s%s\n", CONFIG_, sym->name);
805 if (val[0] != '0' || (val[1] != 'x' && val[1] != 'X'))
812 if (strlen(val_prefix) > 0) {
813 val_prefixed_len = strlen(val) + strlen(val_prefix) + 1;
814 val_prefixed = xmalloc(val_prefixed_len);
815 snprintf(val_prefixed, val_prefixed_len, "%s%s", val_prefix, val);
819 /* All values get escaped: the `--cfg` option only takes strings */
820 escaped = escape_string_value(val);
823 fprintf(fp, "--cfg=%s%s=%s\n", CONFIG_, sym->name, val);
830 * Write out a minimal config.
831 * All values that has default values are skipped as this is redundant.
833 int conf_write_defconfig(const char *filename)
839 out = fopen(filename, "w");
843 sym_clear_all_valid();
845 /* Traverse all menus to find all relevant symbols */
846 menu = rootmenu.list;
852 if (!menu_is_visible(menu))
854 } else if (!sym_is_choice(sym)) {
856 if (!(sym->flags & SYMBOL_WRITE))
858 sym->flags &= ~SYMBOL_WRITE;
859 /* If we cannot change the symbol - skip */
860 if (!sym_is_changeable(sym))
862 /* If symbol equals to default value - skip */
863 if (strcmp(sym_get_string_value(sym), sym_get_string_default(sym)) == 0)
867 * If symbol is a choice value and equals to the
868 * default for a choice - skip.
869 * But only if value is bool and equal to "y" and
870 * choice is not "optional".
871 * (If choice is "optional" then all values can be "n")
873 if (sym_is_choice_value(sym)) {
877 cs = prop_get_symbol(sym_get_choice_prop(sym));
878 ds = sym_choice_default(cs);
879 if (!sym_is_optional(cs) && sym == ds) {
880 if ((sym->type == S_BOOLEAN) &&
881 sym_get_tristate_value(sym) == yes)
885 print_symbol_for_dotconfig(out, sym);
888 if (menu->list != NULL) {
891 else if (menu->next != NULL) {
894 while ((menu = menu->parent)) {
895 if (menu->next != NULL) {
906 int conf_write(const char *name)
912 char tmpname[PATH_MAX + 1], oldname[PATH_MAX + 1];
915 bool need_newline = false;
918 name = conf_get_configname();
921 fprintf(stderr, "config name is empty\n");
926 fprintf(stderr, "%s: Is a directory\n", name);
930 if (make_parent_dir(name))
933 env = getenv("KCONFIG_OVERWRITECONFIG");
936 out = fopen(name, "w");
938 snprintf(tmpname, sizeof(tmpname), "%s.%d.tmp",
939 name, (int)getpid());
940 out = fopen(tmpname, "w");
945 conf_write_heading(out, &comment_style_pound);
947 if (!conf_get_changed())
948 sym_clear_all_valid();
950 menu = rootmenu.list;
954 if (!menu_is_visible(menu))
956 str = menu_get_prompt(menu);
961 need_newline = false;
962 } else if (!(sym->flags & SYMBOL_CHOICE) &&
963 !(sym->flags & SYMBOL_WRITTEN)) {
965 if (!(sym->flags & SYMBOL_WRITE))
969 need_newline = false;
971 sym->flags |= SYMBOL_WRITTEN;
972 print_symbol_for_dotconfig(out, sym);
982 if (!menu->sym && menu_is_visible(menu) && menu != &rootmenu &&
983 menu->prompt->type == P_MENU) {
984 fprintf(out, "# end of %s\n", menu_get_prompt(menu));
998 for_all_symbols(i, sym)
999 sym->flags &= ~SYMBOL_WRITTEN;
1002 if (is_same(name, tmpname)) {
1003 conf_message("No change to %s", name);
1005 conf_set_changed(false);
1009 snprintf(oldname, sizeof(oldname), "%s.old", name);
1010 rename(name, oldname);
1011 if (rename(tmpname, name))
1015 conf_message("configuration written to %s", name);
1017 conf_set_changed(false);
1022 /* write a dependency file as used by kbuild to track dependencies */
1023 static int conf_write_autoconf_cmd(const char *autoconf_name)
1025 char name[PATH_MAX], tmp[PATH_MAX];
1030 ret = snprintf(name, sizeof(name), "%s.cmd", autoconf_name);
1031 if (ret >= sizeof(name)) /* check truncation */
1034 if (make_parent_dir(name))
1037 ret = snprintf(tmp, sizeof(tmp), "%s.cmd.tmp", autoconf_name);
1038 if (ret >= sizeof(tmp)) /* check truncation */
1041 out = fopen(tmp, "w");
1047 fprintf(out, "deps_config := \\\n");
1048 for (file = file_list; file; file = file->next)
1049 fprintf(out, "\t%s \\\n", file->name);
1051 fprintf(out, "\n%s: $(deps_config)\n\n", autoconf_name);
1053 env_write_dep(out, autoconf_name);
1055 fprintf(out, "\n$(deps_config): ;\n");
1058 ret = ferror(out); /* error check for all fprintf() calls */
1063 if (rename(tmp, name)) {
1071 static int conf_touch_deps(void)
1073 const char *name, *tmp;
1077 name = conf_get_autoconfig_name();
1078 tmp = strrchr(name, '/');
1079 depfile_prefix_len = tmp ? tmp - name + 1 : 0;
1080 if (depfile_prefix_len + 1 > sizeof(depfile_path))
1083 strncpy(depfile_path, name, depfile_prefix_len);
1084 depfile_path[depfile_prefix_len] = 0;
1086 conf_read_simple(name, S_DEF_AUTO);
1087 sym_calc_value(modules_sym);
1089 for_all_symbols(i, sym) {
1090 sym_calc_value(sym);
1091 if ((sym->flags & SYMBOL_NO_WRITE) || !sym->name)
1093 if (sym->flags & SYMBOL_WRITE) {
1094 if (sym->flags & SYMBOL_DEF_AUTO) {
1096 * symbol has old and new value,
1097 * so compare them...
1099 switch (sym->type) {
1102 if (sym_get_tristate_value(sym) ==
1103 sym->def[S_DEF_AUTO].tri)
1109 if (!strcmp(sym_get_string_value(sym),
1110 sym->def[S_DEF_AUTO].val))
1118 * If there is no old value, only 'no' (unset)
1119 * is allowed as new value.
1121 switch (sym->type) {
1124 if (sym_get_tristate_value(sym) == no)
1131 } else if (!(sym->flags & SYMBOL_DEF_AUTO))
1132 /* There is neither an old nor a new value. */
1135 * There is an old value, but no new value ('no' (unset)
1136 * isn't saved in auto.conf, so the old value is always
1137 * different from 'no').
1140 res = conf_touch_dep(sym->name);
1148 static int __conf_write_autoconf(const char *filename,
1149 void (*print_symbol)(FILE *, struct symbol *),
1150 const struct comment_style *comment_style)
1157 if (make_parent_dir(filename))
1160 ret = snprintf(tmp, sizeof(tmp), "%s.tmp", filename);
1161 if (ret >= sizeof(tmp)) /* check truncation */
1164 file = fopen(tmp, "w");
1170 conf_write_heading(file, comment_style);
1172 for_all_symbols(i, sym)
1173 if ((sym->flags & SYMBOL_WRITE) && sym->name)
1174 print_symbol(file, sym);
1177 /* check possible errors in conf_write_heading() and print_symbol() */
1183 if (rename(tmp, filename)) {
1191 int conf_write_autoconf(int overwrite)
1194 const char *autoconf_name = conf_get_autoconfig_name();
1197 if (!overwrite && is_present(autoconf_name))
1200 ret = conf_write_autoconf_cmd(autoconf_name);
1204 if (conf_touch_deps())
1207 for_all_symbols(i, sym)
1208 sym_calc_value(sym);
1210 ret = __conf_write_autoconf(conf_get_autoheader_name(),
1216 ret = __conf_write_autoconf(conf_get_rustccfg_name(),
1217 print_symbol_for_rustccfg,
1223 * Create include/config/auto.conf. This must be the last step because
1224 * Kbuild has a dependency on auto.conf and this marks the successful
1225 * completion of the previous steps.
1227 ret = __conf_write_autoconf(conf_get_autoconfig_name(),
1228 print_symbol_for_autoconf,
1229 &comment_style_pound);
1236 static bool conf_changed;
1237 static void (*conf_changed_callback)(void);
1239 void conf_set_changed(bool val)
1241 bool changed = conf_changed != val;
1245 if (conf_changed_callback && changed)
1246 conf_changed_callback();
1249 bool conf_get_changed(void)
1251 return conf_changed;
1254 void conf_set_changed_callback(void (*fn)(void))
1256 conf_changed_callback = fn;
1259 void set_all_choice_values(struct symbol *csym)
1261 struct property *prop;
1265 prop = sym_get_choice_prop(csym);
1268 * Set all non-assinged choice values to no
1270 expr_list_for_each_sym(prop->expr, e, sym) {
1271 if (!sym_has_value(sym))
1272 sym->def[S_DEF_USER].tri = no;
1274 csym->flags |= SYMBOL_DEF_USER;
1275 /* clear VALID to get value calculated */
1276 csym->flags &= ~(SYMBOL_VALID | SYMBOL_NEED_SET_CHOICE_VALUES);