Skip to contentSkip to conversation

kconfig: remove 'const' from the return type of sym_escape_string_value()

PATCH In review Masahiro Yamada 3 participants 16 messages Oct 1, 2021 – Nov 5, 2021

Subsystems (2)
lore
Share & tools
lore
#6 lore raw

PATCH 4/10 kconfig: refactor listnewconfig code

In reply to Masahiro Yamada

We can reuse __print_symbol() helper to print symbols for listnewconfig. Only the difference is the format for "n" symbols.

This prints "CONFIG_FOO=n" instead of "# CONFIG_FOO is not set".

---

 scripts/kconfig/conf.c      | 14 ++------------
 scripts/kconfig/confdata.c  |  5 +++++
 scripts/kconfig/lkc_proto.h |  1 +
 3 files changed, 8 insertions(+), 12 deletions(-)
scripts/kconfig/conf.c +2 -12
index 310fdd408793..971da3598fe4 100644
@@ -646,18 +646,8 @@ static void check_conf(struct menu *menu)
 
 		switch (input_mode) {
 		case listnewconfig:
-			if (sym->name) {
-				const char *val = sym_get_string_value(sym);
-				char *escaped = NULL;
-
-				if (sym->type == S_STRING) {
-					escaped = sym_escape_string_value(val);
-					val = escaped;
-				}
-
-				printf("%s%s=%s\n", CONFIG_, sym->name, val);
-				free(escaped);
-			}
+			if (sym->name)
+				print_symbol_for_listconfig(sym);
 			break;
 		case helpnewconfig:
 			printf("-----\n");
scripts/kconfig/confdata.c +5 -0
index ce11e7442d12..adbb9a955c43 100644
@@ -667,6 +667,11 @@ static void print_symbol_for_autoconf(FILE *fp, struct symbol *sym)
 	__print_symbol(fp, sym, OUTPUT_N_NONE, true);
 }
 
+void print_symbol_for_listconfig(struct symbol *sym)
+{
+	__print_symbol(stdout, sym, OUTPUT_N, true);
+}
+
 static void print_symbol_for_c(FILE *fp, struct symbol *sym)
 {
 	const char *val;
scripts/kconfig/lkc_proto.h +1 -0
index e6955df49973..ec4a01bb60ce 100644
@@ -19,6 +19,7 @@ extern struct symbol * symbol_hash[SYMBOL_HASHSIZE];
 struct symbol * sym_lookup(const char *name, int flags);
 struct symbol * sym_find(const char *name);
 char *sym_escape_string_value(const char *in);
+void print_symbol_for_listconfig(struct symbol *sym);
 struct symbol ** sym_re_search(const char *pattern);
 const char * sym_type_name(enum symbol_type type);
 void sym_calc_value(struct symbol *sym);
Signature · 1 line
2.30.2
#10 lore raw

PATCH 8/10 kconfig: refactor conf_write_dep()

In reply to Masahiro Yamada

The if ... else inside the for-loop is unneeded because one empty line is placed after printing the last element of deps_config.

Currently, all errors in conf_write_dep() are ignored. Add proper error checks.

Rename it to conf_write_autoconf_cmd(), which is more intuitive.

---

 scripts/kconfig/confdata.c | 54 ++++++++++++++++++++++++++------------
 1 file changed, 37 insertions(+), 17 deletions(-)
scripts/kconfig/confdata.c +37 -17
index 6eb2c806fec0..75e45e69d660 100644
@@ -957,32 +957,50 @@ int conf_write(const char *name)
 }
 
 /* write a dependency file as used by kbuild to track dependencies */
-static int conf_write_dep(const char *name)
+static int conf_write_autoconf_cmd(const char *autoconf_name)
 {
+	char name[PATH_MAX], tmp[PATH_MAX];
 	struct file *file;
 	FILE *out;
+	int ret;
 
-	out = fopen("..config.tmp", "w");
-	if (!out)
-		return 1;
-	fprintf(out, "deps_config := \\\n");
-	for (file = file_list; file; file = file->next) {
-		if (file->next)
-			fprintf(out, "\t%s \\\n", file->name);
-		else
-			fprintf(out, "\t%s\n", file->name);
+	ret = snprintf(name, sizeof(name), "%s.cmd", autoconf_name);
+	if (ret >= sizeof(name)) /* check truncation */
+		return -1;
+
+	if (make_parent_dir(name))
+		return -1;
+
+	ret = snprintf(tmp, sizeof(tmp), "%s.cmd.tmp", autoconf_name);
+	if (ret >= sizeof(tmp)) /* check truncation */
+		return -1;
+
+	out = fopen(tmp, "w");
+	if (!out) {
+		perror("fopen");
+		return -1;
 	}
-	fprintf(out, "\n%s: \\\n"
-		     "\t$(deps_config)\n\n", conf_get_autoconfig_name());
 
-	env_write_dep(out, conf_get_autoconfig_name());
+	fprintf(out, "deps_config := \\\n");
+	for (file = file_list; file; file = file->next)
+		fprintf(out, "\t%s \\\n", file->name);
+
+	fprintf(out, "\n%s: $(deps_config)\n\n", autoconf_name);
+
+	env_write_dep(out, autoconf_name);
 
 	fprintf(out, "\n$(deps_config): ;\n");
+
+	if (ferror(out)) /* error check for all fprintf() calls */
+		return -1;
+
 	fclose(out);
 
-	if (make_parent_dir(name))
-		return 1;
-	rename("..config.tmp", name);
+	if (rename(tmp, name)) {
+		perror("rename");
+		return -1;
+	}
+
 	return 0;
 }
 
@@ -1109,7 +1127,9 @@ int conf_write_autoconf(int overwrite)
 	if (!overwrite && is_present(autoconf_name))
 		return 0;
 
-	conf_write_dep("include/config/auto.conf.cmd");
+	ret = conf_write_autoconf_cmd(autoconf_name);
+	if (ret)
+		return -1;
 
 	if (conf_touch_deps())
 		return 1;
Signature · 1 line
2.30.2
#9 lore raw

PATCH 7/10 kconfig: refactor conf_write_autoconf()

In reply to Masahiro Yamada

This function does similar for auto.conf and autoconf.h

Create __conf_write_autoconf() helper to factor out the common code.

---

 scripts/kconfig/confdata.c | 94 +++++++++++++++++++++++---------------
 1 file changed, 57 insertions(+), 37 deletions(-)
scripts/kconfig/confdata.c +57 -37
index 2c518aaa5255..6eb2c806fec0 100644
@@ -1058,13 +1058,53 @@ static int conf_touch_deps(void)
 	return 0;
 }
 
+static int __conf_write_autoconf(const char *filename,
+				 void (*print_symbol)(FILE *, struct symbol *),
+				 const struct comment_style *comment_style)
+{
+	char tmp[PATH_MAX];
+	FILE *file;
+	struct symbol *sym;
+	int ret, i;
+
+	if (make_parent_dir(filename))
+		return -1;
+
+	ret = snprintf(tmp, sizeof(tmp), "%s.tmp", filename);
+	if (ret >= sizeof(tmp)) /* check truncation */
+		return -1;
+
+	file = fopen(tmp, "w");
+	if (!file) {
+		perror("fopen");
+		return -1;
+	}
+
+	conf_write_heading(file, comment_style);
+
+	for_all_symbols(i, sym)
+		if ((sym->flags & SYMBOL_WRITE) && sym->name)
+			print_symbol(file, sym);
+
+	/* check possible errors in conf_write_heading() and print_symbol() */
+	if (ferror(file))
+		return -1;
+
+	fclose(file);
+
+	if (rename(tmp, filename)) {
+		perror("rename");
+		return -1;
+	}
+
+	return 0;
+}
+
 int conf_write_autoconf(int overwrite)
 {
 	struct symbol *sym;
-	const char *name;
 	const char *autoconf_name = conf_get_autoconfig_name();
-	FILE *out, *out_h;
-	int i;
+	int ret, i;
 
 	if (!overwrite && is_present(autoconf_name))
 		return 0;
@@ -1074,45 +1114,25 @@ int conf_write_autoconf(int overwrite)
 	if (conf_touch_deps())
 		return 1;
 
-	out = fopen(".tmpconfig", "w");
-	if (!out)
-		return 1;
-
-	out_h = fopen(".tmpconfig.h", "w");
-	if (!out_h) {
-		fclose(out);
-		return 1;
-	}
-
-	conf_write_heading(out, &comment_style_pound);
-	conf_write_heading(out_h, &comment_style_c);
-
-	for_all_symbols(i, sym) {
+	for_all_symbols(i, sym)
 		sym_calc_value(sym);
-		if (!(sym->flags & SYMBOL_WRITE) || !sym->name)
-			continue;
 
-		/* write symbols to auto.conf and autoconf.h */
-		print_symbol_for_autoconf(out, sym);
-		print_symbol_for_c(out_h, sym);
-	}
-	fclose(out);
-	fclose(out_h);
-
-	name = conf_get_autoheader_name();
-	if (make_parent_dir(name))
-		return 1;
-	if (rename(".tmpconfig.h", name))
-		return 1;
+	ret = __conf_write_autoconf(conf_get_autoheader_name(),
+				    print_symbol_for_c,
+				    &comment_style_c);
+	if (ret)
+		return ret;
 
-	if (make_parent_dir(autoconf_name))
-		return 1;
 	/*
-	 * This must be the last step, kbuild has a dependency on auto.conf
-	 * and this marks the successful completion of the previous steps.
+	 * Create include/config/auto.conf. This must be the last step because
+	 * Kbuild has a dependency on auto.conf and this marks the successful
+	 * completion of the previous steps.
 	 */
-	if (rename(".tmpconfig", autoconf_name))
-		return 1;
+	ret = __conf_write_autoconf(conf_get_autoconfig_name(),
+				    print_symbol_for_autoconf,
+				    &comment_style_pound);
+	if (ret)
+		return ret;
 
 	return 0;
 }
Signature · 1 line
2.30.2
#2 lore raw

PATCH 3/10 kconfig: refactor conf_write_symbol()

In reply to Masahiro Yamada

I do not think 'struct conf_printer' is so useful.

Add simple functions, print_symbol_for_*() to write out one symbol.

---

 scripts/kconfig/confdata.c | 136 ++++++++++++++++---------------------
 1 file changed, 57 insertions(+), 79 deletions(-)
scripts/kconfig/confdata.c +57 -79
index ed1bb8ba971b..ce11e7442d12 100644
@@ -11,6 +11,7 @@
 #include <fcntl.h>
 #include <limits.h>
 #include <stdarg.h>
+#include <stdbool.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
@@ -159,10 +160,6 @@ static int conf_touch_dep(const char *name)
 	return 0;
 }
 
-struct conf_printer {
-	void (*print_symbol)(FILE *, struct symbol *, const char *, void *);
-};
-
 static void conf_warning(const char *fmt, ...)
 	__attribute__ ((format (printf, 1, 2)));
 
@@ -629,91 +626,52 @@ static void conf_write_heading(FILE *fp, const struct comment_style *cs)
  * This printer is used when generating the resulting configuration after
  * kconfig invocation and `defconfig' files. Unset symbol might be omitted by
  * passing a non-NULL argument to the printer.
- *
  */
-static void
-kconfig_print_symbol(FILE *fp, struct symbol *sym, const char *value, void *arg)
-{
-
-	switch (sym->type) {
-	case S_BOOLEAN:
-	case S_TRISTATE:
-		if (*value == 'n') {
-			bool skip_unset = (arg != NULL);
-
-			if (!skip_unset)
-				fprintf(fp, "# %s%s is not set\n",
-				    CONFIG_, sym->name);
-			return;
-		}
-		break;
-	default:
-		break;
-	}
-
-	fprintf(fp, "%s%s=%s\n", CONFIG_, sym->name, value);
-}
+enum output_n { OUTPUT_N, OUTPUT_N_AS_UNSET, OUTPUT_N_NONE };
 
-static struct conf_printer kconfig_printer_cb =
+static void __print_symbol(FILE *fp, struct symbol *sym, enum output_n output_n,
+			   bool escape_string)
 {
-	.print_symbol = kconfig_print_symbol,
-};
+	const char *val;
+	char *escaped = NULL;
 
-/*
- * Header printer
- *
- * This printer is used when generating the `include/generated/autoconf.h' file.
- */
-static void
-header_print_symbol(FILE *fp, struct symbol *sym, const char *value, void *arg)
-{
+	if (sym->type == S_UNKNOWN)
+		return;
 
-	switch (sym->type) {
-	case S_BOOLEAN:
-	case S_TRISTATE: {
-		const char *suffix = "";
+	val = sym_get_string_value(sym);
 
-		switch (*value) {
-		case 'n':
-			break;
-		case 'm':
-			suffix = "_MODULE";
-			/* fall through */
-		default:
-			fprintf(fp, "#define %s%s%s 1\n",
-			    CONFIG_, sym->name, suffix);
-		}
-		break;
+	if ((sym->type == S_BOOLEAN || sym->type == S_TRISTATE) &&
+	    output_n != OUTPUT_N && *val == 'n') {
+		if (output_n == OUTPUT_N_AS_UNSET)
+			fprintf(fp, "# %s%s is not set\n", CONFIG_, sym->name);
+		return;
 	}
-	case S_HEX: {
-		const char *prefix = "";
 
-		if (value[0] != '0' || (value[1] != 'x' && value[1] != 'X'))
-			prefix = "0x";
-		fprintf(fp, "#define %s%s %s%s\n",
-		    CONFIG_, sym->name, prefix, value);
-		break;
-	}
-	case S_STRING:
-	case S_INT:
-		fprintf(fp, "#define %s%s %s\n",
-		    CONFIG_, sym->name, value);
-		break;
-	default:
-		break;
+	if (sym->type == S_STRING && escape_string) {
+		escaped = sym_escape_string_value(val);
+		val = escaped;
 	}
 
+	fprintf(fp, "%s%s=%s\n", CONFIG_, sym->name, val);
+
+	free(escaped);
 }
 
-static struct conf_printer header_printer_cb =
+static void print_symbol_for_dotconfig(FILE *fp, struct symbol *sym)
 {
-	.print_symbol = header_print_symbol,
-};
+	__print_symbol(fp, sym, OUTPUT_N_AS_UNSET, true);
+}
+
+static void print_symbol_for_autoconf(FILE *fp, struct symbol *sym)
+{
+	__print_symbol(fp, sym, OUTPUT_N_NONE, true);
+}
 
-static void conf_write_symbol(FILE *fp, struct symbol *sym,
-			      struct conf_printer *printer, void *printer_arg)
+static void print_symbol_for_c(FILE *fp, struct symbol *sym)
 {
 	const char *val;
+	const char *sym_suffix = "";
+	const char *val_prefix = "";
 	char *escaped = NULL;
 
 	if (sym->type == S_UNKNOWN)
@@ -721,12 +679,32 @@ static void conf_write_symbol(FILE *fp, struct symbol *sym,
 
 	val = sym_get_string_value(sym);
 
-	if (sym->type == S_STRING) {
+	switch (sym->type) {
+	case S_BOOLEAN:
+	case S_TRISTATE:
+		switch (*val) {
+		case 'n':
+			return;
+		case 'm':
+			sym_suffix = "_MODULE";
+			/* fall through */
+		default:
+			val = "1";
+		}
+		break;
+	case S_HEX:
+		if (val[0] != '0' || (val[1] != 'x' && val[1] != 'X'))
+			val_prefix = "0x";
+		break;
+	case S_STRING:
 		escaped = sym_escape_string_value(val);
 		val = escaped;
+	default:
+		break;
 	}
 
-	printer->print_symbol(fp, sym, val, printer_arg);
+	fprintf(fp, "#define %s%s%s %s%s\n", CONFIG_, sym->name, sym_suffix,
+		val_prefix, val);
 
 	free(escaped);
 }
@@ -787,7 +765,7 @@ int conf_write_defconfig(const char *filename)
 						goto next_menu;
 				}
 			}
-			conf_write_symbol(out, sym, &kconfig_printer_cb, NULL);
+			print_symbol_for_dotconfig(out, sym);
 		}
 next_menu:
 		if (menu->list != NULL) {
@@ -874,7 +852,7 @@ int conf_write(const char *name)
 				need_newline = false;
 			}
 			sym->flags |= SYMBOL_WRITTEN;
-			conf_write_symbol(out, sym, &kconfig_printer_cb, NULL);
+			print_symbol_for_dotconfig(out, sym);
 		}
 
 next:
@@ -1060,8 +1038,8 @@ int conf_write_autoconf(int overwrite)
 			continue;
 
 		/* write symbols to auto.conf and autoconf.h */
-		conf_write_symbol(out, sym, &kconfig_printer_cb, (void *)1);
-		conf_write_symbol(out_h, sym, &header_printer_cb, NULL);
+		print_symbol_for_autoconf(out, sym);
+		print_symbol_for_c(out_h, sym);
 	}
 	fclose(out);
 	fclose(out_h);
Signature · 1 line
2.30.2
#8 lore raw

PATCH 6/10 kconfig: add conf_get_autoheader_name()

In reply to Masahiro Yamada

For consistency with conf_get_autoconfig_name()

---

 scripts/kconfig/confdata.c | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)
scripts/kconfig/confdata.c +8 -3
index 78af1dd68894..2c518aaa5255 100644
@@ -223,6 +223,13 @@ static const char *conf_get_autoconfig_name(void)
 	return name ? name : "include/config/auto.conf";
 }
 
+static const char *conf_get_autoheader_name(void)
+{
+	char *name = getenv("KCONFIG_AUTOHEADER");
+
+	return name ? name : "include/generated/autoconf.h";
+}
+
 static int conf_set_sym_val(struct symbol *sym, int def, int def_flags, char *p)
 {
 	char *p2;
@@ -1092,9 +1099,7 @@ int conf_write_autoconf(int overwrite)
 	fclose(out);
 	fclose(out_h);
 
-	name = getenv("KCONFIG_AUTOHEADER");
-	if (!name)
-		name = "include/generated/autoconf.h";
+	name = conf_get_autoheader_name();
 	if (make_parent_dir(name))
 		return 1;
 	if (rename(".tmpconfig.h", name))
Signature · 1 line
2.30.2
#7 lore raw

PATCH 5/10 kconfig: move sym_escape_string_value() to confdata.c

In reply to Masahiro Yamada

Now that sym_escape_string_value() is only used in confdata.c it can be a 'static' function.

Rename it escape_string_value() because it is agnostic about (struct sym *).

---

 scripts/kconfig/confdata.c  | 47 +++++++++++++++++++++++++++++++++++--
 scripts/kconfig/lkc_proto.h |  1 -
 scripts/kconfig/symbol.c    | 44 ----------------------------------
 3 files changed, 45 insertions(+), 47 deletions(-)
scripts/kconfig/confdata.c +45 -2
index adbb9a955c43..78af1dd68894 100644
@@ -620,6 +620,49 @@ static void conf_write_heading(FILE *fp, const struct comment_style *cs)
 	fprintf(fp, "%s\n", cs->comment_block_end);
 }
 
+/* The returned pointer must be freed on the caller side */
+static char *escape_string_value(const char *in)
+{
+	const char *p;
+	char *out;
+	size_t len;
+
+	len = strlen(in) + strlen("\"\"") + 1;
+
+	p = in;
+	while (1) {
+		p += strcspn(p, "\"\\");
+
+		if (p[0] == '\0')
+			break;
+
+		len++;
+		p++;
+	}
+
+	out = xmalloc(len);
+	out[0] = '\0';
+
+	strcat(out, "\"");
+
+	p = in;
+	while (1) {
+		len = strcspn(p, "\"\\");
+		strncat(out, p, len);
+		p += len;
+
+		if (p[0] == '\0')
+			break;
+
+		strcat(out, "\\");
+		strncat(out, p++, 1);
+	}
+
+	strcat(out, "\"");
+
+	return out;
+}
+
 /*
  * Kconfig configuration printer
  *
@@ -648,7 +691,7 @@ static void __print_symbol(FILE *fp, struct symbol *sym, enum output_n output_n,
 	}
 
 	if (sym->type == S_STRING && escape_string) {
-		escaped = sym_escape_string_value(val);
+		escaped = escape_string_value(val);
 		val = escaped;
 	}
 
@@ -702,7 +745,7 @@ static void print_symbol_for_c(FILE *fp, struct symbol *sym)
 			val_prefix = "0x";
 		break;
 	case S_STRING:
-		escaped = sym_escape_string_value(val);
+		escaped = escape_string_value(val);
 		val = escaped;
 	default:
 		break;
scripts/kconfig/lkc_proto.h +0 -1
index ec4a01bb60ce..edd1e617b25c 100644
@@ -18,7 +18,6 @@ extern struct symbol * symbol_hash[SYMBOL_HASHSIZE];
 
 struct symbol * sym_lookup(const char *name, int flags);
 struct symbol * sym_find(const char *name);
-char *sym_escape_string_value(const char *in);
 void print_symbol_for_listconfig(struct symbol *sym);
 struct symbol ** sym_re_search(const char *pattern);
 const char * sym_type_name(enum symbol_type type);
scripts/kconfig/symbol.c +0 -44

50 lines not on this page · raw message

Signature · 1 line
2.30.2
#12 lore raw

PATCH 10/10 kconfig: generate include/generated/rustc_cfg

In reply to Masahiro Yamada

This patch is not intended for the mainline.

I created this patch for Stephen Rothwell to resolve the merge conflicts more easily.

The Rust tree is touching scripts/kconfig/confdata.c to generate include/generated/rustc_cfg, which would cause complicated conflicts with changes from the kbuild tree.

I re-implemented it to produce the equaivalent rustc_cfg.

I also fixed the memory leak; the original code from the Rust tree did not free the malloc'ed pointer.

Stephen:
When you resolve the conflicts in confdata.c, please take this one.

---

 scripts/kconfig/confdata.c | 42 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
scripts/kconfig/confdata.c +42 -0
index 9ece2f3b61a6..4767f3810cf4 100644
@@ -603,6 +603,9 @@ static const struct comment_style comment_style_c = {
 
 static void conf_write_heading(FILE *fp, const struct comment_style *cs)
 {
+	if (!cs) /* no heading for rustc_cfg? */
+		return;
+
 	fprintf(fp, "%s\n", cs->comment_block_begin);
 
 	fprintf(fp, "%s Automatically generated file; DO NOT EDIT.\n",
@@ -750,6 +753,39 @@ static void print_symbol_for_c(FILE *fp, struct symbol *sym)
 	free(escaped);
 }
 
+/* rustc configuration */
+static void print_symbol_for_rustc_cfg(FILE *fp, struct symbol *sym)
+{
+	const char *val;
+	char *escaped;
+
+	if (sym->type == S_UNKNOWN)
+		return;
+
+	val = sym_get_string_value(sym);
+	escaped = escape_string_value(val);
+
+	if (sym->type == S_BOOLEAN || sym->type == S_TRISTATE) {
+		if (*val == 'n')
+			return;
+
+		/*
+		 * To have similar functionality to the C macro `IS_ENABLED()`
+		 * we provide an empty `--cfg CONFIG_X` here in both `y`
+		 * and `m` cases.
+		 *
+		 * Then, the common `fprintf()` below will also give us
+		 * a `--cfg CONFIG_X="y"` or `--cfg CONFIG_X="m"`, which can
+		 * be used as the equivalent of `IS_BUILTIN()`/`IS_MODULE()`.
+		 */
+		fprintf(fp, "--cfg=%s%s\n", CONFIG_, sym->name);
+	}
+
+	fprintf(fp, "--cfg=%s%s=%s\n", CONFIG_, sym->name, escaped);
+
+	free(escaped);
+}
+
 /*
  * Write out a minimal config.
  * All values that has default values are skipped as this is redundant.
@@ -1129,6 +1165,12 @@ int conf_write_autoconf(int overwrite)
 	if (ret)
 		return ret;
 
+	ret = __conf_write_autoconf("include/generated/rustc_cfg",
+				    print_symbol_for_rustc_cfg,
+				    NULL);
+	if (ret)
+		return ret;
+
 	/*
 	 * Create include/config/auto.conf. This must be the last step because
 	 * Kbuild has a dependency on auto.conf and this marks the successful
Signature · 1 line
2.30.2
#0 lore raw

PATCH 1/10 kconfig: remove 'const' from the return type of sym_escape_string_value()

sym_escape_string_value() returns a malloc'ed memory, but as (const char *). So, it must be casted to (void *) when it is free'd. This is odd.

The return type of sym_escape_string_value() should be (char *).

I exploited that free(NULL) has no effect.

---

 scripts/kconfig/conf.c      | 15 +++++++--------
 scripts/kconfig/confdata.c  | 27 ++++++++++++++-------------
 scripts/kconfig/lkc_proto.h |  2 +-
 scripts/kconfig/symbol.c    |  3 ++-
 4 files changed, 24 insertions(+), 23 deletions(-)
scripts/kconfig/conf.c +7 -8
index 5d84b44a2a2a..310fdd408793 100644
@@ -647,17 +647,16 @@ static void check_conf(struct menu *menu)
 		switch (input_mode) {
 		case listnewconfig:
 			if (sym->name) {
-				const char *str;
+				const char *val = sym_get_string_value(sym);
+				char *escaped = NULL;
 
 				if (sym->type == S_STRING) {
-					str = sym_get_string_value(sym);
-					str = sym_escape_string_value(str);
-					printf("%s%s=%s\n", CONFIG_, sym->name, str);
-					free((void *)str);
-				} else {
-					str = sym_get_string_value(sym);
-					printf("%s%s=%s\n", CONFIG_, sym->name, str);
+					escaped = sym_escape_string_value(val);
+					val = escaped;
 				}
+
+				printf("%s%s=%s\n", CONFIG_, sym->name, val);
+				free(escaped);
 			}
 			break;
 		case helpnewconfig:
scripts/kconfig/confdata.c +14 -13
index cf72680cd769..9b2271eb43d6 100644
@@ -728,21 +728,22 @@ static struct conf_printer header_printer_cb =
 static void conf_write_symbol(FILE *fp, struct symbol *sym,
 			      struct conf_printer *printer, void *printer_arg)
 {
-	const char *str;
+	const char *val;
+	char *escaped = NULL;
 
-	switch (sym->type) {
-	case S_UNKNOWN:
-		break;
-	case S_STRING:
-		str = sym_get_string_value(sym);
-		str = sym_escape_string_value(str);
-		printer->print_symbol(fp, sym, str, printer_arg);
-		free((void *)str);
-		break;
-	default:
-		str = sym_get_string_value(sym);
-		printer->print_symbol(fp, sym, str, printer_arg);
+	if (sym->type == S_UNKNOWN)
+		return;
+
+	val = sym_get_string_value(sym);
+
+	if (sym->type == S_STRING) {
+		escaped = sym_escape_string_value(val);
+		val = escaped;
 	}
+
+	printer->print_symbol(fp, sym, val, printer_arg);
+
+	free(escaped);
 }
 
 static void
scripts/kconfig/lkc_proto.h +1 -1
index a11626bdc421..e6955df49973 100644
@@ -18,7 +18,7 @@ extern struct symbol * symbol_hash[SYMBOL_HASHSIZE];
 
 struct symbol * sym_lookup(const char *name, int flags);
 struct symbol * sym_find(const char *name);
-const char * sym_escape_string_value(const char *in);
+char *sym_escape_string_value(const char *in);
 struct symbol ** sym_re_search(const char *pattern);
 const char * sym_type_name(enum symbol_type type);
 void sym_calc_value(struct symbol *sym);
scripts/kconfig/symbol.c +2 -1
index 5844d636d38f..6bf8665a6a0f 100644
@@ -871,7 +871,8 @@ struct symbol *sym_find(const char *name)
 	return symbol;
 }
 
-const char *sym_escape_string_value(const char *in)
+/* The returned pointer must be freed on the caller side */
+char *sym_escape_string_value(const char *in)
 {
 	const char *p;
 	size_t reslen;
Signature · 1 line
2.30.2
#1 lore raw

PATCH 2/10 kconfig: refactor conf_write_heading()

All the call sites of conf_write_heading() pass NULL to the third argument, and it is not used in the function.

Also, the print_comment hooks are doing much more complex than needed.

Rewrite the code.

---

 scripts/kconfig/confdata.c | 95 +++++++++++++-------------------------
 1 file changed, 33 insertions(+), 62 deletions(-)
scripts/kconfig/confdata.c +33 -62
index 9b2271eb43d6..ed1bb8ba971b 100644
@@ -161,7 +161,6 @@ static int conf_touch_dep(const char *name)
 
 struct conf_printer {
 	void (*print_symbol)(FILE *, struct symbol *, const char *, void *);
-	void (*print_comment)(FILE *, const char *, void *);
 };
 
 static void conf_warning(const char *fmt, ...)
@@ -594,6 +593,36 @@ int conf_read(const char *name)
 	return 0;
 }
 
+struct comment_style {
+	const char *comment_line;
+	const char *comment_block_begin;
+	const char *comment_block_end;
+};
+
+static const struct comment_style comment_style_pound = {
+	.comment_line = "#",
+	.comment_block_begin = "#",
+	.comment_block_end = "#",
+};
+
+static const struct comment_style comment_style_c = {
+	.comment_line = " *",
+	.comment_block_begin = "/*",
+	.comment_block_end = " */",
+};
+
+static void conf_write_heading(FILE *fp, const struct comment_style *cs)
+{
+	fprintf(fp, "%s\n", cs->comment_block_begin);
+
+	fprintf(fp, "%s Automatically generated file; DO NOT EDIT.\n",
+		cs->comment_line);
+
+	fprintf(fp, "%s %s\n", cs->comment_line, rootmenu.prompt->text);
+
+	fprintf(fp, "%s\n", cs->comment_block_end);
+}
+
 /*
  * Kconfig configuration printer
  *
@@ -625,30 +654,9 @@ kconfig_print_symbol(FILE *fp, struct symbol *sym, const char *value, void *arg)
 	fprintf(fp, "%s%s=%s\n", CONFIG_, sym->name, value);
 }
 
-static void
-kconfig_print_comment(FILE *fp, const char *value, void *arg)
-{
-	const char *p = value;
-	size_t l;
-
-	for (;;) {
-		l = strcspn(p, "\n");
-		fprintf(fp, "#");
-		if (l) {
-			fprintf(fp, " ");
-			xfwrite(p, l, 1, fp);
-			p += l;
-		}
-		fprintf(fp, "\n");
-		if (*p++ == '\0')
-			break;
-	}
-}
-
 static struct conf_printer kconfig_printer_cb =
 {
 	.print_symbol = kconfig_print_symbol,
-	.print_comment = kconfig_print_comment,
 };
 
 /*
@@ -697,32 +705,9 @@ header_print_symbol(FILE *fp, struct symbol *sym, const char *value, void *arg)
 
 }
 
-static void
-header_print_comment(FILE *fp, const char *value, void *arg)
-{
-	const char *p = value;
-	size_t l;
-
-	fprintf(fp, "/*\n");
-	for (;;) {
-		l = strcspn(p, "\n");
-		fprintf(fp, " *");
-		if (l) {
-			fprintf(fp, " ");
-			xfwrite(p, l, 1, fp);
-			p += l;
-		}
-		fprintf(fp, "\n");
-		if (*p++ == '\0')
-			break;
-	}
-	fprintf(fp, " */\n");
-}
-
 static struct conf_printer header_printer_cb =
 {
 	.print_symbol = header_print_symbol,
-	.print_comment = header_print_comment,
 };
 
 static void conf_write_symbol(FILE *fp, struct symbol *sym,
@@ -746,20 +731,6 @@ static void conf_write_symbol(FILE *fp, struct symbol *sym,
 	free(escaped);
 }
 
-static void
-conf_write_heading(FILE *fp, struct conf_printer *printer, void *printer_arg)
-{
-	char buf[256];
-
-	snprintf(buf, sizeof(buf),
-	    "\n"
-	    "Automatically generated file; DO NOT EDIT.\n"
-	    "%s\n",
-	    rootmenu.prompt->text);
-
-	printer->print_comment(fp, buf, printer_arg);
-}
-
 /*
  * Write out a minimal config.
  * All values that has default values are skipped as this is redundant.
@@ -876,7 +847,7 @@ int conf_write(const char *name)
 	if (!out)
 		return 1;
 
-	conf_write_heading(out, &kconfig_printer_cb, NULL);
+	conf_write_heading(out, &comment_style_pound);
 
 	if (!conf_get_changed())
 		sym_clear_all_valid();
@@ -1080,8 +1051,8 @@ int conf_write_autoconf(int overwrite)
 		return 1;
 	}
 
-	conf_write_heading(out, &kconfig_printer_cb, NULL);
-	conf_write_heading(out_h, &header_printer_cb, NULL);
+	conf_write_heading(out, &comment_style_pound);
+	conf_write_heading(out_h, &comment_style_c);
 
 	for_all_symbols(i, sym) {
 		sym_calc_value(sym);
Signature · 1 line
2.30.2
#11 lore raw

PATCH 9/10 kconfig: refactor conf_touch_dep()

In reply to Masahiro Yamada

If this function fails to touch a dummy header due to missing parent directory, then it creates it and touches the file again.

This was needed because CONFIG_FOO_BAR was previously tracked by include/config/foo/bar.h. (include/config/foo/ may not exist here)

This is no longer the case since commit 0e0345b77ac4 ("kbuild: redo fake deps at include/config/*.h"); now all the fake headers are placed right under include/config/, like include/config/FOO_BAR.

Do not try to create parent directory, include/config/, which already exists.

---

 scripts/kconfig/confdata.c | 22 ++++------------------
 1 file changed, 4 insertions(+), 18 deletions(-)
scripts/kconfig/confdata.c +4 -18
index 75e45e69d660..9ece2f3b61a6 100644
@@ -130,31 +130,17 @@ static size_t depfile_prefix_len;
 /* touch depfile for symbol 'name' */
 static int conf_touch_dep(const char *name)
 {
-	int fd, ret;
-	char *d;
+	int fd;
 
 	/* check overflow: prefix + name + '\0' must fit in buffer. */
 	if (depfile_prefix_len + strlen(name) + 1 > sizeof(depfile_path))
 		return -1;
 
-	d = depfile_path + depfile_prefix_len;
-	strcpy(d, name);
+	strcpy(depfile_path + depfile_prefix_len, name);
 
-	/* Assume directory path already exists. */
 	fd = open(depfile_path, O_WRONLY | O_CREAT | O_TRUNC, 0644);
-	if (fd == -1) {
-		if (errno != ENOENT)
-			return -1;
-
-		ret = make_parent_dir(depfile_path);
-		if (ret)
-			return ret;
-
-		/* Try it again. */
-		fd = open(depfile_path, O_WRONLY | O_CREAT | O_TRUNC, 0644);
-		if (fd == -1)
-			return -1;
-	}
+	if (fd == -1)
+		return -1;
 	close(fd);
 
 	return 0;
Signature · 1 line
2.30.2
#13 lore raw

Re: [PATCH 10/10] [for next only] kconfig: generate include/generated/rustc_cfg

In reply to Masahiro Yamada
Quoted 46 lines · Masahiro Yamada

This patch is not intended for the mainline.

I created this patch for Stephen Rothwell to resolve the merge conflicts more easily.

The Rust tree is touching scripts/kconfig/confdata.c to generate include/generated/rustc_cfg, which would cause complicated conflicts with changes from the kbuild tree.

I re-implemented it to produce the equaivalent rustc_cfg.

I also fixed the memory leak; the original code from the Rust tree did not free the malloc'ed pointer.

Stephen:
When you resolve the conflicts in confdata.c, please take this one.

---

 scripts/kconfig/confdata.c | 42 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
scripts/kconfig/confdata.c +8 -0
index 9ece2f3b61a6..4767f3810cf4 100644
@@ -603,6 +603,9 @@ static const struct comment_style comment_style_c = {
 
 static void conf_write_heading(FILE *fp, const struct comment_style *cs)
 {
+	if (!cs) /* no heading for rustc_cfg? */
+		return;
+
 	fprintf(fp, "%s\n", cs->comment_block_begin);
 
 	fprintf(fp, "%s Automatically generated file; DO NOT EDIT.\n",
@@ -750,6 +753,39 @@ static void print_symbol_for_c(FILE *fp, struct symbol *sym)
 	free(escaped);
 }
 
+/* rustc configuration */
+static void print_symbol_for_rustc_cfg(FILE *fp, struct symbol *sym)
+{
+	const char *val;
+	char *escaped;

scripts/kconfig/confdata.c static void print_symbol_for_c(FILE *fp, struct symbol *sym) · line 770

Quoted 10 lines
scripts/kconfig/confdata.c +10 -0
+
+	if (sym->type == S_UNKNOWN)
+		return;
+
+	val = sym_get_string_value(sym);
+	escaped = escape_string_value(val);
+
+	if (sym->type == S_BOOLEAN || sym->type == S_TRISTATE) {
+		if (*val == 'n')
+			return;

I'd expect a "free(escaped);" here.

Quoted 37 lines
scripts/kconfig/confdata.c +24 -0
+
+		/*
+		 * To have similar functionality to the C macro `IS_ENABLED()`
+		 * we provide an empty `--cfg CONFIG_X` here in both `y`
+		 * and `m` cases.
+		 *
+		 * Then, the common `fprintf()` below will also give us
+		 * a `--cfg CONFIG_X="y"` or `--cfg CONFIG_X="m"`, which can
+		 * be used as the equivalent of `IS_BUILTIN()`/`IS_MODULE()`.
+		 */
+		fprintf(fp, "--cfg=%s%s\n", CONFIG_, sym->name);
+	}
+
+	fprintf(fp, "--cfg=%s%s=%s\n", CONFIG_, sym->name, escaped);
+
+	free(escaped);
+}
+
 /*
  * Write out a minimal config.
  * All values that has default values are skipped as this is redundant.
@@ -1129,6 +1165,12 @@ int conf_write_autoconf(int overwrite)
 	if (ret)
 		return ret;
 
+	ret = __conf_write_autoconf("include/generated/rustc_cfg",
+				    print_symbol_for_rustc_cfg,
+				    NULL);
+	if (ret)
+		return ret;
+
 	/*
 	 * Create include/config/auto.conf. This must be the last step because
 	 * Kbuild has a dependency on auto.conf and this marks the successful
Signature · 1 line
2.30.2
#14 lore raw

Re: [PATCH 10/10] [for next only] kconfig: generate include/generated/rustc_cfg

Quoted 52 lines · On Fri, Oct 1, 2021 at 8:29 PM <[email protected]> wrote:
Quoted 50 lines · Masahiro Yamada

This patch is not intended for the mainline.

I created this patch for Stephen Rothwell to resolve the merge conflicts more easily.

The Rust tree is touching scripts/kconfig/confdata.c to generate include/generated/rustc_cfg, which would cause complicated conflicts with changes from the kbuild tree.

I re-implemented it to produce the equaivalent rustc_cfg.

I also fixed the memory leak; the original code from the Rust tree did not free the malloc'ed pointer.

Stephen:
When you resolve the conflicts in confdata.c, please take this one.

---

 scripts/kconfig/confdata.c | 42 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
scripts/kconfig/confdata.c +12 -0
index 9ece2f3b61a6..4767f3810cf4 100644
@@ -603,6 +603,9 @@ static const struct comment_style comment_style_c = {
 
 static void conf_write_heading(FILE *fp, const struct comment_style *cs)
 {
+     if (!cs) /* no heading for rustc_cfg? */
+             return;
+
      fprintf(fp, "%s\n", cs->comment_block_begin);
 
      fprintf(fp, "%s Automatically generated file; DO NOT EDIT.\n",
@@ -750,6 +753,39 @@ static void print_symbol_for_c(FILE *fp, struct symbol *sym)
      free(escaped);
 }
 
+/* rustc configuration */
+static void print_symbol_for_rustc_cfg(FILE *fp, struct symbol *sym)
+{
+     const char *val;
+     char *escaped;
+
+     if (sym->type == S_UNKNOWN)
+             return;
+
Quoted 8 lines

scripts/kconfig/confdata.c static void print_symbol_for_c(FILE *fp, struct symbol *sym) · line 770

Quoted 6 lines
scripts/kconfig/confdata.c +6 -0
+     val = sym_get_string_value(sym);
+     escaped = escape_string_value(val);
+
+     if (sym->type == S_BOOLEAN || sym->type == S_TRISTATE) {
+             if (*val == 'n')
+                     return;

I'd expect a "free(escaped);" here.

Thank you for catching it.

I just sent v2.

Signature · 2 lines
Best Regards
Masahiro Yamada
#15 lore raw
In reply to Masahiro Yamada
Quoted 11 lines · Masahiro Yamada

sym_escape_string_value() returns a malloc'ed memory, but as (const char *). So, it must be casted to (void *) when it is free'd. This is odd.

The return type of sym_escape_string_value() should be (char *).

I exploited that free(NULL) has no effect.

---

All applied to linux-kbuild.

I pushed 10/10 v3 to the for-next branch.

Quoted 106 lines
 scripts/kconfig/conf.c      | 15 +++++++--------
 scripts/kconfig/confdata.c  | 27 ++++++++++++++-------------
 scripts/kconfig/lkc_proto.h |  2 +-
 scripts/kconfig/symbol.c    |  3 ++-
 4 files changed, 24 insertions(+), 23 deletions(-)
scripts/kconfig/conf.c +7 -8
index 5d84b44a2a2a..310fdd408793 100644
@@ -647,17 +647,16 @@ static void check_conf(struct menu *menu)
                switch (input_mode) {
                case listnewconfig:
                        if (sym->name) {
-                               const char *str;
+                               const char *val = sym_get_string_value(sym);
+                               char *escaped = NULL;
 
                                if (sym->type == S_STRING) {
-                                       str = sym_get_string_value(sym);
-                                       str = sym_escape_string_value(str);
-                                       printf("%s%s=%s\n", CONFIG_, sym->name, str);
-                                       free((void *)str);
-                               } else {
-                                       str = sym_get_string_value(sym);
-                                       printf("%s%s=%s\n", CONFIG_, sym->name, str);
+                                       escaped = sym_escape_string_value(val);
+                                       val = escaped;
                                }
+
+                               printf("%s%s=%s\n", CONFIG_, sym->name, val);
+                               free(escaped);
                        }
                        break;
                case helpnewconfig:
scripts/kconfig/confdata.c +14 -13
index cf72680cd769..9b2271eb43d6 100644
@@ -728,21 +728,22 @@ static struct conf_printer header_printer_cb =
 static void conf_write_symbol(FILE *fp, struct symbol *sym,
                              struct conf_printer *printer, void *printer_arg)
 {
-       const char *str;
+       const char *val;
+       char *escaped = NULL;
 
-       switch (sym->type) {
-       case S_UNKNOWN:
-               break;
-       case S_STRING:
-               str = sym_get_string_value(sym);
-               str = sym_escape_string_value(str);
-               printer->print_symbol(fp, sym, str, printer_arg);
-               free((void *)str);
-               break;
-       default:
-               str = sym_get_string_value(sym);
-               printer->print_symbol(fp, sym, str, printer_arg);
+       if (sym->type == S_UNKNOWN)
+               return;
+
+       val = sym_get_string_value(sym);
+
+       if (sym->type == S_STRING) {
+               escaped = sym_escape_string_value(val);
+               val = escaped;
        }
+
+       printer->print_symbol(fp, sym, val, printer_arg);
+
+       free(escaped);
 }
 
 static void
scripts/kconfig/lkc_proto.h +1 -1
index a11626bdc421..e6955df49973 100644
@@ -18,7 +18,7 @@ extern struct symbol * symbol_hash[SYMBOL_HASHSIZE];
 
 struct symbol * sym_lookup(const char *name, int flags);
 struct symbol * sym_find(const char *name);
-const char * sym_escape_string_value(const char *in);
+char *sym_escape_string_value(const char *in);
 struct symbol ** sym_re_search(const char *pattern);
 const char * sym_type_name(enum symbol_type type);
 void sym_calc_value(struct symbol *sym);
scripts/kconfig/symbol.c +2 -2
index 5844d636d38f..6bf8665a6a0f 100644
@@ -871,7 +871,8 @@ struct symbol *sym_find(const char *name)
        return symbol;
 }
 
-const char *sym_escape_string_value(const char *in)
+/* The returned pointer must be freed on the caller side */
+char *sym_escape_string_value(const char *in)
 {
        const char *p;
        size_t reslen;
--

2.30.2

Signature · 2 lines
Best Regards
Masahiro Yamada
#3 lore raw

Re: [PATCH 03/10] kconfig: refactor conf_write_symbol()

In reply to Masahiro Yamada
Quoted 1 line · Masahiro Yamada

+static void __print_symbol(FILE *fp, struct symbol *sym, enum output_n output_n,

Identifier that start with double underscore are reserved. The same goes for __conf_write_autoconf() in another patch.

#4 lore raw

Re: [PATCH 03/10] kconfig: refactor conf_write_symbol()

Quoted 7 lines · Boris Kolpackov
Quoted 1 line · Masahiro Yamada

+static void __print_symbol(FILE *fp, struct symbol *sym, enum output_n output_n,

Identifier that start with double underscore are reserved. The same goes for __conf_write_autoconf() in another patch.

Without this patch, there are some functions that start with double underscores.

For example,

__expr_eliminate_eq() in scripts/kconfig/expr.c __expand_string() in scripts/kconfig/preprocess.c

Are they problematic as well?

Signature · 2 lines
Best Regards
Masahiro Yamada
#5 lore raw

Re: [PATCH 03/10] kconfig: refactor conf_write_symbol()

Quoted 9 lines · Masahiro Yamada

Without this patch, there are some functions that start with double underscores.

For example,

__expr_eliminate_eq() in scripts/kconfig/expr.c __expand_string() in scripts/kconfig/preprocess.c

Are they problematic as well?

Yes, they could be potentially problematic. Identifiers that start with double underscores or with a single underscore followed by an uppercase letter are reserved for use by the C implementation (for example, as a pre-defined macro).