From: Masahiro Yamada <masahiroy@kernel.org> To: linux-kbuild@vger.kernel.org Cc: alsa-devel@alsa-project.org, linux-kernel@vger.kernel.org, Masahiro Yamada <masahiroy@kernel.org>, Takashi Iwai <tiwai@suse.com>, linux-wireless@vger.kernel.org, Liam Girdwood <lgirdwood@gmail.com>, Mark Brown <broonie@kernel.org>, Luca Coelho <luciano.coelho@intel.com>, netdev@vger.kernel.org, Jakub Kicinski <kuba@kernel.org>, Peter Ujfalusi <peter.ujfalusi@gmail.com>, "David S. Miller" <davem@davemloft.net>, Kalle Valo <kvalo@codeaurora.org> Subject: [PATCH] kconfig: forbid symbols that end with '_MODULE' Date: Wed, 25 Aug 2021 13:16:37 +0900 [thread overview] Message-ID: <20210825041637.365171-1-masahiroy@kernel.org> (raw) Kconfig (syncconfig) generates include/generated/autoconf.h to make CONFIG options available to the pre-processor. The macros are suffixed with '_MODULE' for symbols with the value 'm'. Here is a conflict; CONFIG_FOO=m results in '#define CONFIG_FOO_MODULE 1', but CONFIG_FOO_MODULE=y also results in the same define. fixdep always assumes CONFIG_FOO_MODULE comes from CONFIG_FOO=m, so the dependency is not properly tracked for symbols that end with '_MODULE'. This commit makes Kconfig error out if it finds a symbol suffixed with '_MODULE'. This restriction does not exist if the module feature is not supported (at least from the Kconfig perspective). It detected one error: error: SND_SOC_DM365_VOICE_CODEC_MODULE: symbol name must not end with '_MODULE' Rename it to SND_SOC_DM365_VOICE_CODEC_MODULAR. Commit 147162f57515 ("ASoC: ti: fix SND_SOC_DM365_VOICE_CODEC dependencies") added it for internal use. So, this renaming has no impact on users. Remove a comment from drivers/net/wireless/intel/iwlwifi/Kconfig since this is a hard error now. Add a comment to include/linux/kconfig.h in order not to worry observant developers. Signed-off-by: Masahiro Yamada <masahiroy@kernel.org> --- drivers/net/wireless/intel/iwlwifi/Kconfig | 1 - include/linux/kconfig.h | 3 ++ scripts/kconfig/parser.y | 40 +++++++++++++++++++++- sound/soc/ti/Kconfig | 2 +- 4 files changed, 43 insertions(+), 3 deletions(-) diff --git a/drivers/net/wireless/intel/iwlwifi/Kconfig b/drivers/net/wireless/intel/iwlwifi/Kconfig index 1085afbefba8..5b238243617c 100644 --- a/drivers/net/wireless/intel/iwlwifi/Kconfig +++ b/drivers/net/wireless/intel/iwlwifi/Kconfig @@ -70,7 +70,6 @@ config IWLMVM of the devices that use this firmware is available here: https://wireless.wiki.kernel.org/en/users/drivers/iwlwifi#firmware -# don't call it _MODULE -- will confuse Kconfig/fixdep/... config IWLWIFI_OPMODE_MODULAR bool default y if IWLDVM=m diff --git a/include/linux/kconfig.h b/include/linux/kconfig.h index 20d1079e92b4..54f677e742fe 100644 --- a/include/linux/kconfig.h +++ b/include/linux/kconfig.h @@ -53,6 +53,9 @@ * IS_MODULE(CONFIG_FOO) evaluates to 1 if CONFIG_FOO is set to 'm', 0 * otherwise. CONFIG_FOO=m results in "#define CONFIG_FOO_MODULE 1" in * autoconf.h. + * CONFIG_FOO_MODULE=y would also result in "#define CONFIG_FOO_MODULE 1", + * but Kconfig forbids symbol names that end with '_MODULE', so that would + * not happen. */ #define IS_MODULE(option) __is_defined(option##_MODULE) diff --git a/scripts/kconfig/parser.y b/scripts/kconfig/parser.y index 2af7ce4e1531..b0f73f74ccd3 100644 --- a/scripts/kconfig/parser.y +++ b/scripts/kconfig/parser.y @@ -475,6 +475,37 @@ assign_val: %% +/* + * Symbols suffixed with '_MODULE' would cause a macro conflict in autoconf.h, + * and also confuse the interaction between syncconfig and fixdep. + * Error out if a symbol with the '_MODULE' suffix is found. + */ +static int sym_check_name(struct symbol *sym) +{ + static const char *suffix = "_MODULE"; + static const size_t suffix_len = strlen("_MODULE"); + char *name; + size_t len; + + name = sym->name; + + if (!name) + return 0; + + len = strlen(name); + + if (len < suffix_len) + return 0; + + if (strcmp(name + len - suffix_len, suffix)) + return 0; + + fprintf(stderr, "error: %s: symbol name must not end with '%s'\n", + name, suffix); + + return -1; +} + void conf_parse(const char *name) { struct symbol *sym; @@ -493,8 +524,15 @@ void conf_parse(const char *name) if (yynerrs) exit(1); - if (!modules_sym) + + if (modules_sym) { + for_all_symbols(i, sym) { + if (sym_check_name(sym)) + yynerrs++; + } + } else { modules_sym = sym_find( "n" ); + } if (!menu_has_prompt(&rootmenu)) { current_entry = &rootmenu; diff --git a/sound/soc/ti/Kconfig b/sound/soc/ti/Kconfig index 698d7bc84dcf..c56a5789056f 100644 --- a/sound/soc/ti/Kconfig +++ b/sound/soc/ti/Kconfig @@ -211,7 +211,7 @@ config SND_SOC_DM365_VOICE_CODEC Say Y if you want to add support for SoC On-chip voice codec endchoice -config SND_SOC_DM365_VOICE_CODEC_MODULE +config SND_SOC_DM365_VOICE_CODEC_MODULAR def_tristate y depends on SND_SOC_DM365_VOICE_CODEC && SND_SOC select MFD_DAVINCI_VOICECODEC -- 2.30.2
WARNING: multiple messages have this Message-ID (diff)
From: Masahiro Yamada <masahiroy@kernel.org> To: linux-kbuild@vger.kernel.org Cc: Masahiro Yamada <masahiroy@kernel.org>, "David S. Miller" <davem@davemloft.net>, Jakub Kicinski <kuba@kernel.org>, Jaroslav Kysela <perex@perex.cz>, Kalle Valo <kvalo@codeaurora.org>, Liam Girdwood <lgirdwood@gmail.com>, Luca Coelho <luciano.coelho@intel.com>, Mark Brown <broonie@kernel.org>, Peter Ujfalusi <peter.ujfalusi@gmail.com>, Takashi Iwai <tiwai@suse.com>, alsa-devel@alsa-project.org, linux-kernel@vger.kernel.org, linux-wireless@vger.kernel.org, netdev@vger.kernel.org Subject: [PATCH] kconfig: forbid symbols that end with '_MODULE' Date: Wed, 25 Aug 2021 13:16:37 +0900 [thread overview] Message-ID: <20210825041637.365171-1-masahiroy@kernel.org> (raw) Kconfig (syncconfig) generates include/generated/autoconf.h to make CONFIG options available to the pre-processor. The macros are suffixed with '_MODULE' for symbols with the value 'm'. Here is a conflict; CONFIG_FOO=m results in '#define CONFIG_FOO_MODULE 1', but CONFIG_FOO_MODULE=y also results in the same define. fixdep always assumes CONFIG_FOO_MODULE comes from CONFIG_FOO=m, so the dependency is not properly tracked for symbols that end with '_MODULE'. This commit makes Kconfig error out if it finds a symbol suffixed with '_MODULE'. This restriction does not exist if the module feature is not supported (at least from the Kconfig perspective). It detected one error: error: SND_SOC_DM365_VOICE_CODEC_MODULE: symbol name must not end with '_MODULE' Rename it to SND_SOC_DM365_VOICE_CODEC_MODULAR. Commit 147162f57515 ("ASoC: ti: fix SND_SOC_DM365_VOICE_CODEC dependencies") added it for internal use. So, this renaming has no impact on users. Remove a comment from drivers/net/wireless/intel/iwlwifi/Kconfig since this is a hard error now. Add a comment to include/linux/kconfig.h in order not to worry observant developers. Signed-off-by: Masahiro Yamada <masahiroy@kernel.org> --- drivers/net/wireless/intel/iwlwifi/Kconfig | 1 - include/linux/kconfig.h | 3 ++ scripts/kconfig/parser.y | 40 +++++++++++++++++++++- sound/soc/ti/Kconfig | 2 +- 4 files changed, 43 insertions(+), 3 deletions(-) diff --git a/drivers/net/wireless/intel/iwlwifi/Kconfig b/drivers/net/wireless/intel/iwlwifi/Kconfig index 1085afbefba8..5b238243617c 100644 --- a/drivers/net/wireless/intel/iwlwifi/Kconfig +++ b/drivers/net/wireless/intel/iwlwifi/Kconfig @@ -70,7 +70,6 @@ config IWLMVM of the devices that use this firmware is available here: https://wireless.wiki.kernel.org/en/users/drivers/iwlwifi#firmware -# don't call it _MODULE -- will confuse Kconfig/fixdep/... config IWLWIFI_OPMODE_MODULAR bool default y if IWLDVM=m diff --git a/include/linux/kconfig.h b/include/linux/kconfig.h index 20d1079e92b4..54f677e742fe 100644 --- a/include/linux/kconfig.h +++ b/include/linux/kconfig.h @@ -53,6 +53,9 @@ * IS_MODULE(CONFIG_FOO) evaluates to 1 if CONFIG_FOO is set to 'm', 0 * otherwise. CONFIG_FOO=m results in "#define CONFIG_FOO_MODULE 1" in * autoconf.h. + * CONFIG_FOO_MODULE=y would also result in "#define CONFIG_FOO_MODULE 1", + * but Kconfig forbids symbol names that end with '_MODULE', so that would + * not happen. */ #define IS_MODULE(option) __is_defined(option##_MODULE) diff --git a/scripts/kconfig/parser.y b/scripts/kconfig/parser.y index 2af7ce4e1531..b0f73f74ccd3 100644 --- a/scripts/kconfig/parser.y +++ b/scripts/kconfig/parser.y @@ -475,6 +475,37 @@ assign_val: %% +/* + * Symbols suffixed with '_MODULE' would cause a macro conflict in autoconf.h, + * and also confuse the interaction between syncconfig and fixdep. + * Error out if a symbol with the '_MODULE' suffix is found. + */ +static int sym_check_name(struct symbol *sym) +{ + static const char *suffix = "_MODULE"; + static const size_t suffix_len = strlen("_MODULE"); + char *name; + size_t len; + + name = sym->name; + + if (!name) + return 0; + + len = strlen(name); + + if (len < suffix_len) + return 0; + + if (strcmp(name + len - suffix_len, suffix)) + return 0; + + fprintf(stderr, "error: %s: symbol name must not end with '%s'\n", + name, suffix); + + return -1; +} + void conf_parse(const char *name) { struct symbol *sym; @@ -493,8 +524,15 @@ void conf_parse(const char *name) if (yynerrs) exit(1); - if (!modules_sym) + + if (modules_sym) { + for_all_symbols(i, sym) { + if (sym_check_name(sym)) + yynerrs++; + } + } else { modules_sym = sym_find( "n" ); + } if (!menu_has_prompt(&rootmenu)) { current_entry = &rootmenu; diff --git a/sound/soc/ti/Kconfig b/sound/soc/ti/Kconfig index 698d7bc84dcf..c56a5789056f 100644 --- a/sound/soc/ti/Kconfig +++ b/sound/soc/ti/Kconfig @@ -211,7 +211,7 @@ config SND_SOC_DM365_VOICE_CODEC Say Y if you want to add support for SoC On-chip voice codec endchoice -config SND_SOC_DM365_VOICE_CODEC_MODULE +config SND_SOC_DM365_VOICE_CODEC_MODULAR def_tristate y depends on SND_SOC_DM365_VOICE_CODEC && SND_SOC select MFD_DAVINCI_VOICECODEC -- 2.30.2
next reply other threads:[~2021-08-25 4:18 UTC|newest] Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top 2021-08-25 4:16 Masahiro Yamada [this message] 2021-08-25 4:16 ` [PATCH] kconfig: forbid symbols that end with '_MODULE' Masahiro Yamada 2021-08-25 9:52 ` Mark Brown 2021-08-25 9:52 ` Mark Brown 2021-08-25 11:59 ` Péter Ujfalusi 2021-08-25 11:59 ` Péter Ujfalusi 2021-08-26 2:28 ` Masahiro Yamada 2021-08-26 2:28 ` Masahiro Yamada 2021-09-01 7:07 ` Péter Ujfalusi 2021-09-01 7:07 ` Péter Ujfalusi 2021-08-25 15:34 ` Boris Kolpackov 2021-08-25 15:34 ` Boris Kolpackov 2021-08-26 2:24 ` Masahiro Yamada 2021-08-26 2:24 ` Masahiro Yamada 2021-08-26 12:16 ` Boris Kolpackov 2021-08-26 12:16 ` Boris Kolpackov
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=20210825041637.365171-1-masahiroy@kernel.org \ --to=masahiroy@kernel.org \ --cc=alsa-devel@alsa-project.org \ --cc=broonie@kernel.org \ --cc=davem@davemloft.net \ --cc=kuba@kernel.org \ --cc=kvalo@codeaurora.org \ --cc=lgirdwood@gmail.com \ --cc=linux-kbuild@vger.kernel.org \ --cc=linux-kernel@vger.kernel.org \ --cc=linux-wireless@vger.kernel.org \ --cc=luciano.coelho@intel.com \ --cc=netdev@vger.kernel.org \ --cc=peter.ujfalusi@gmail.com \ --cc=tiwai@suse.com \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.