From: Jessica Yu <jeyu@kernel.org>
To: Matthias Maennich <maennich@google.com>
Cc: linux-kernel@vger.kernel.org, kernel-team@android.com,
arnd@arndb.de, geert@linux-m68k.org, gregkh@linuxfoundation.org,
hpa@zytor.com, joel@joelfernandes.org,
kstewart@linuxfoundation.org, linux-arch@vger.kernel.org,
linux-kbuild@vger.kernel.org, linux-m68k@lists.linux-m68k.org,
linux-modules@vger.kernel.org, linux-scsi@vger.kernel.org,
linux-usb@vger.kernel.org, lucas.de.marchi@gmail.com,
maco@android.com, maco@google.com, michal.lkml@markovi.net,
mingo@redhat.com, oneukum@suse.com, pombredanne@nexb.com,
sam@ravnborg.org, sspatil@google.com, stern@rowland.harvard.edu,
tglx@linutronix.de, usb-storage@lists.one-eyed-alien.net,
x86@kernel.org, yamada.masahiro@socionext.com
Subject: Re: [PATCH v3 04/11] modpost: add support for symbol namespaces
Date: Wed, 28 Aug 2019 11:43:26 +0200 [thread overview]
Message-ID: <20190828094325.GA25048@linux-8ccs> (raw)
In-Reply-To: <20190827144117.GB102829@google.com>
+++ Matthias Maennich [27/08/19 15:41 +0100]:
>On Mon, Aug 26, 2019 at 06:21:38PM +0200, Jessica Yu wrote:
>>+++ Matthias Maennich [21/08/19 12:49 +0100]:
>>>Add support for symbols that are exported into namespaces. For that,
>>>extract any namespace suffix from the symbol name. In addition, emit a
>>>warning whenever a module refers to an exported symbol without
>>>explicitly importing the namespace that it is defined in. This patch
>>>consistently adds the namespace suffix to symbol names exported into
>>>Module.symvers.
>>>
>>>Example warning emitted by modpost in case of the above violation:
>>>
>>>WARNING: module ums-usbat uses symbol usb_stor_resume from namespace
>>>USB_STORAGE, but does not import it.
>>>
>>>Co-developed-by: Martijn Coenen <maco@android.com>
>>>Signed-off-by: Martijn Coenen <maco@android.com>
>>>Reviewed-by: Joel Fernandes (Google) <joel@joelfernandes.org>
>>>Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
>>>Signed-off-by: Matthias Maennich <maennich@google.com>
>>>---
>>>scripts/mod/modpost.c | 91 +++++++++++++++++++++++++++++++++++++------
>>>scripts/mod/modpost.h | 7 ++++
>>>2 files changed, 87 insertions(+), 11 deletions(-)
>>>
>>>diff --git a/scripts/mod/modpost.c b/scripts/mod/modpost.c
>>>index f277e116e0eb..538bb24ffee3 100644
>>>--- a/scripts/mod/modpost.c
>>>+++ b/scripts/mod/modpost.c
>>>@@ -164,6 +164,7 @@ struct symbol {
>>> struct module *module;
>>> unsigned int crc;
>>> int crc_valid;
>>>+ const char *namespace;
>>> unsigned int weak:1;
>>> unsigned int vmlinux:1; /* 1 if symbol is defined in vmlinux */
>>> unsigned int kernel:1; /* 1 if symbol is from kernel
>>>@@ -233,6 +234,37 @@ static struct symbol *find_symbol(const char *name)
>>> return NULL;
>>>}
>>>
>>>+static bool contains_namespace(struct namespace_list *list,
>>>+ const char *namespace)
>>>+{
>>>+ struct namespace_list *ns_entry;
>>>+
>>>+ for (ns_entry = list; ns_entry != NULL; ns_entry = ns_entry->next)
>>>+ if (strcmp(ns_entry->namespace, namespace) == 0)
>>>+ return true;
>>>+
>>>+ return false;
>>>+}
>>>+
>>>+static void add_namespace(struct namespace_list **list, const char *namespace)
>>>+{
>>>+ struct namespace_list *ns_entry;
>>>+
>>>+ if (!contains_namespace(*list, namespace)) {
>>>+ ns_entry = NOFAIL(malloc(sizeof(struct namespace_list) +
>>>+ strlen(namespace) + 1));
>>>+ strcpy(ns_entry->namespace, namespace);
>>>+ ns_entry->next = *list;
>>>+ *list = ns_entry;
>>>+ }
>>>+}
>>>+
>>>+static bool module_imports_namespace(struct module *module,
>>>+ const char *namespace)
>>>+{
>>>+ return contains_namespace(module->imported_namespaces, namespace);
>>>+}
>>>+
>>>static const struct {
>>> const char *str;
>>> enum export export;
>>>@@ -312,6 +344,22 @@ static enum export export_from_sec(struct elf_info *elf, unsigned int sec)
>>> return export_unknown;
>>>}
>>>
>>>+static const char *sym_extract_namespace(const char **symname)
>>>+{
>>>+ size_t n;
>>>+ char *dupsymname;
>>>+
>>>+ n = strcspn(*symname, ".");
>>>+ if (n < strlen(*symname) - 1) {
>>>+ dupsymname = NOFAIL(strdup(*symname));
>>>+ dupsymname[n] = '\0';
>>>+ *symname = dupsymname;
>>>+ return dupsymname + n + 1;
>>>+ }
>>>+
>>>+ return NULL;
>>>+}
>>>+
>>>/**
>>>* Add an exported symbol - it may have already been added without a
>>>* CRC, in this case just update the CRC
>>>@@ -319,16 +367,18 @@ static enum export export_from_sec(struct elf_info *elf, unsigned int sec)
>>>static struct symbol *sym_add_exported(const char *name, struct module *mod,
>>> enum export export)
>>>{
>>>- struct symbol *s = find_symbol(name);
>>>+ const char *symbol_name = name;
>>>+ const char *namespace = sym_extract_namespace(&symbol_name);
>>>+ struct symbol *s = find_symbol(symbol_name);
>>>
>>> if (!s) {
>>>- s = new_symbol(name, mod, export);
>>>+ s = new_symbol(symbol_name, mod, export);
>>>+ s->namespace = namespace;
>>> } else {
>>> if (!s->preloaded) {
>>>- warn("%s: '%s' exported twice. Previous export "
>>>- "was in %s%s\n", mod->name, name,
>>>- s->module->name,
>>>- is_vmlinux(s->module->name) ?"":".ko");
>>>+ warn("%s: '%s' exported twice. Previous export was in %s%s\n",
>>>+ mod->name, symbol_name, s->module->name,
>>>+ is_vmlinux(s->module->name) ? "" : ".ko");
>>> } else {
>>> /* In case Module.symvers was out of date */
>>> s->module = mod;
>>>@@ -1943,6 +1993,7 @@ static void read_symbols(const char *modname)
>>> const char *symname;
>>> char *version;
>>> char *license;
>>>+ char *namespace;
>>> struct module *mod;
>>> struct elf_info info = { };
>>> Elf_Sym *sym;
>>>@@ -1974,6 +2025,12 @@ static void read_symbols(const char *modname)
>>> license = get_next_modinfo(&info, "license", license);
>>> }
>>>
>>>+ namespace = get_modinfo(&info, "import_ns");
>>>+ while (namespace) {
>>>+ add_namespace(&mod->imported_namespaces, namespace);
>>>+ namespace = get_next_modinfo(&info, "import_ns", namespace);
>>>+ }
>>>+
>>> for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
>>> symname = remove_dot(info.strtab + sym->st_name);
>>>
>>>@@ -2118,6 +2175,13 @@ static int check_exports(struct module *mod)
>>> basename++;
>>> else
>>> basename = mod->name;
>>>+
>>>+ if (exp->namespace &&
>>>+ !module_imports_namespace(mod, exp->namespace)) {
>>>+ warn("module %s uses symbol %s from namespace %s, but does not import it.\n",
>>>+ basename, exp->name, exp->namespace);
>>>+ }
>>>+
>>> if (!mod->gpl_compatible)
>>> check_for_gpl_usage(exp->export, basename, exp->name);
>>> check_for_unused(exp->export, basename, exp->name);
>>>@@ -2395,16 +2459,21 @@ static void write_dump(const char *fname)
>>>{
>>> struct buffer buf = { };
>>> struct symbol *symbol;
>>>+ const char *namespace;
>>> int n;
>>>
>>> for (n = 0; n < SYMBOL_HASH_SIZE ; n++) {
>>> symbol = symbolhash[n];
>>> while (symbol) {
>>>- if (dump_sym(symbol))
>>>- buf_printf(&buf, "0x%08x\t%s\t%s\t%s\n",
>>>- symbol->crc, symbol->name,
>>>- symbol->module->name,
>>>- export_str(symbol->export));
>>>+ if (dump_sym(symbol)) {
>>>+ namespace = symbol->namespace;
>>>+ buf_printf(&buf, "0x%08x\t%s%s%s\t%s\t%s\n",
>>>+ symbol->crc, symbol->name,
>>>+ namespace ? "." : "",
>>>+ namespace ? namespace : "",
>>
>>I think it might be cleaner to just have namespace be a separate
>>field in Module.symvers, rather than appending a dot and the
>>namespace at the end of a symbol name. Maybe something like
>>
>> <crc> <symbol_name> <namespace> <module>
>>
>>For symbols without a namespace, we could just have "", with all
>>fields delimited by tabs. This is just a stylistic suggestion, what do
>>you think?
>
>I thought of something like that initially, but did not do it to not
>break users of this file. But as I am anyway breaking users by changing
>the symbol name into symbol.NS, I might as well do it as you suggested.
>Since read_dump() also knew already how to extract the namespaces from
>symbol.NS, it had already worked without a change to the reading code
>of modpost. Are there any other consumers of Module.symvers that we
>should be aware of?
Maybe we can ease any possible breakage caused by the new format by
putting the namespace column last? Then the first 4 fields crc,
symbol, module, export type will remain in the same order, with
namespace last. In-tree, I think we would need to update
scripts/export_report.pl.
kmod is likely to be affected too - Lucas, would the addition of a new
field (in the order described above) in Module.symvers break any kmod tools?
Thanks,
Jessica
next prev parent reply other threads:[~2019-08-28 9:43 UTC|newest]
Thread overview: 105+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <20180716122125.175792-1-maco@android.com>
2019-08-13 12:16 ` [PATCH v2 0/10] Symbol namespaces - RFC Matthias Maennich
2019-08-13 12:16 ` [PATCH v2 01/10] module: support reading multiple values per modinfo tag Matthias Maennich
2019-08-13 12:40 ` Greg KH
2019-08-13 12:16 ` [PATCH v2 02/10] export: explicitly align struct kernel_symbol Matthias Maennich
2019-08-13 12:41 ` Greg KH
2019-08-13 12:17 ` [PATCH v2 03/10] module: add support for symbol namespaces Matthias Maennich
2019-08-13 15:26 ` Greg KH
2019-08-13 12:17 ` [PATCH v2 04/10] modpost: " Matthias Maennich
2019-08-13 15:27 ` Greg KH
2019-08-13 12:17 ` [PATCH v2 05/10] module: add config option MODULE_ALLOW_MISSING_NAMESPACE_IMPORTS Matthias Maennich
2019-08-13 18:17 ` Greg KH
2019-08-13 20:15 ` Saravana Kannan
2019-08-14 12:54 ` Matthias Maennich
2019-08-14 17:34 ` Saravana Kannan
2019-08-13 12:17 ` [PATCH v2 06/10] export: allow definition default namespaces in Makefiles or sources Matthias Maennich
2019-08-13 18:16 ` Greg KH
2019-08-13 18:16 ` Greg KH
2019-08-13 12:17 ` [PATCH v2 07/10] modpost: add support for generating namespace dependencies Matthias Maennich
2019-08-13 18:21 ` Greg KH
2019-08-13 12:17 ` [PATCH v2 08/10] scripts: Coccinelle script for " Matthias Maennich
2019-08-13 12:31 ` Julia Lawall
2019-08-13 12:44 ` Greg KH
2019-08-14 6:36 ` [Cocci] " Himanshu Jha
2019-08-14 8:03 ` Matthias Maennich
2019-08-14 12:00 ` [v2 " Markus Elfring
2019-08-15 13:50 ` Markus Elfring
2019-08-22 9:18 ` Matthias Maennich
2019-08-22 11:00 ` Markus Elfring
2019-08-13 12:17 ` [PATCH v2 09/10] usb-storage: remove single-use define for debugging Matthias Maennich
2019-08-13 12:42 ` Greg KH
2019-08-13 13:12 ` Greg KH
2019-08-13 12:17 ` [PATCH v2 10/10] RFC: usb-storage: export symbols in USB_STORAGE namespace Matthias Maennich
2019-08-13 12:45 ` Greg KH
2019-08-13 12:47 ` Greg KH
2019-08-13 15:02 ` Matthias Maennich
[not found] ` <20190821114955.12788-1-maennich@google.com>
2019-08-21 11:49 ` [PATCH v3 01/11] module: support reading multiple values per modinfo tag Matthias Maennich
2019-08-21 11:49 ` [PATCH v3 02/11] export: explicitly align struct kernel_symbol Matthias Maennich
2019-08-21 11:49 ` [PATCH v3 03/11] module: add support for symbol namespaces Matthias Maennich
2019-08-27 15:37 ` Jessica Yu
2019-08-27 16:04 ` Matthias Maennich
2019-08-21 11:49 ` [PATCH v3 04/11] modpost: " Matthias Maennich
2019-08-26 16:21 ` Jessica Yu
2019-08-27 14:41 ` Matthias Maennich
2019-08-28 9:43 ` Jessica Yu [this message]
2019-08-28 9:55 ` Matthias Maennich
2019-08-28 10:16 ` Jessica Yu
2019-08-21 11:49 ` [PATCH v3 05/11] module: add config option MODULE_ALLOW_MISSING_NAMESPACE_IMPORTS Matthias Maennich
2019-08-21 11:49 ` [PATCH v3 06/11] export: allow definition default namespaces in Makefiles or sources Matthias Maennich
2019-08-28 10:49 ` Jessica Yu
2019-08-28 10:56 ` Matthias Maennich
2019-08-21 11:49 ` [PATCH v3 07/11] modpost: add support for generating namespace dependencies Matthias Maennich
2019-08-21 11:49 ` [PATCH v3 08/11] scripts: Coccinelle script for " Matthias Maennich
2019-08-22 6:09 ` [v3 " Markus Elfring
2019-08-29 12:13 ` [PATCH v3 " Jessica Yu
2019-08-21 11:49 ` [PATCH v3 09/11] usb-storage: remove single-use define for debugging Matthias Maennich
2019-08-21 12:37 ` Greg KH
2019-08-21 13:21 ` Thomas Gleixner
2019-08-21 13:32 ` Greg KH
2019-08-21 11:49 ` [PATCH v3 10/11] RFC: usb-storage: export symbols in USB_STORAGE namespace Matthias Maennich
2019-08-21 12:38 ` Greg KH
2019-08-21 14:36 ` Jessica Yu
2019-08-21 23:13 ` Christoph Hellwig
2019-08-22 8:32 ` Matthias Maennich
2019-09-03 15:06 ` [PATCH v4 00/12] Symbol Namespaces Matthias Maennich
2019-09-03 15:06 ` [PATCH v4 01/12] module: support reading multiple values per modinfo tag Matthias Maennich
2019-09-03 15:06 ` [PATCH v4 02/12] export: explicitly align struct kernel_symbol Matthias Maennich
2019-09-03 15:06 ` [PATCH v4 03/12] module: add support for symbol namespaces Matthias Maennich
2019-09-03 15:06 ` [PATCH v4 04/12] modpost: " Matthias Maennich
2019-09-03 15:06 ` [PATCH v4 05/12] module: add config option MODULE_ALLOW_MISSING_NAMESPACE_IMPORTS Matthias Maennich
2019-09-03 15:06 ` [PATCH v4 06/12] export: allow definition default namespaces in Makefiles or sources Matthias Maennich
2019-09-03 15:06 ` [PATCH v4 07/12] modpost: add support for generating namespace dependencies Matthias Maennich
2019-09-03 15:06 ` [PATCH v4 08/12] scripts: Coccinelle script for " Matthias Maennich
2019-09-04 9:53 ` Masahiro Yamada
2019-09-05 14:46 ` Matthias Maennich
2019-09-03 15:06 ` [PATCH v4 09/12] docs: Add documentation for Symbol Namespaces Matthias Maennich
2019-09-04 7:16 ` Greg KH
2019-09-03 15:06 ` [PATCH v4 10/12] usb-storage: remove single-use define for debugging Matthias Maennich
2019-09-03 15:06 ` [PATCH v4 11/12] RFC: usb-storage: export symbols in USB_STORAGE namespace Matthias Maennich
2019-09-03 15:06 ` [PATCH v4 12/12] RFC: watchdog: export core symbols in WATCHDOG_CORE namespace Matthias Maennich
2019-09-03 16:10 ` Guenter Roeck
2019-09-04 8:45 ` Masahiro Yamada
2019-09-04 12:12 ` Guenter Roeck
2019-09-04 16:16 ` [usb-storage] " Matthew Dharm
2019-09-05 10:41 ` Jessica Yu
2019-09-05 10:52 ` Arnd Bergmann
2019-09-05 11:16 ` Jessica Yu
2019-09-05 11:25 ` Masahiro Yamada
2019-09-05 12:00 ` Greg Kroah-Hartman
2019-09-05 11:25 ` Matthias Maennich
2019-09-04 9:37 ` [PATCH v4 00/12] Symbol Namespaces Masahiro Yamada
2019-09-06 10:32 ` [PATCH v5 00/11] " Matthias Maennich
2019-09-06 10:32 ` [PATCH v5 01/11] module: support reading multiple values per modinfo tag Matthias Maennich
2019-09-06 10:32 ` [PATCH v5 02/11] export: explicitly align struct kernel_symbol Matthias Maennich
2019-09-06 10:32 ` [PATCH v5 03/11] module: add support for symbol namespaces Matthias Maennich
2019-09-06 10:32 ` [PATCH v5 04/11] modpost: " Matthias Maennich
2019-09-06 10:32 ` [PATCH v5 05/11] module: add config option MODULE_ALLOW_MISSING_NAMESPACE_IMPORTS Matthias Maennich
2019-09-06 10:32 ` [PATCH v5 06/11] export: allow definition default namespaces in Makefiles or sources Matthias Maennich
2019-09-06 10:32 ` [PATCH v5 07/11] modpost: add support for generating namespace dependencies Matthias Maennich
2019-09-06 10:32 ` [PATCH v5 08/11] scripts: Coccinelle script for " Matthias Maennich
2019-09-06 10:32 ` [PATCH v5 09/11] docs: Add documentation for Symbol Namespaces Matthias Maennich
2019-09-06 10:32 ` [PATCH v5 10/11] usb-storage: remove single-use define for debugging Matthias Maennich
2019-09-06 12:59 ` Jessica Yu
2019-09-06 13:22 ` Greg KH
2019-09-06 10:32 ` [PATCH v5 11/11] usb-storage: export symbols in USB_STORAGE namespace Matthias Maennich
2019-09-09 8:35 ` [PATCH v5 00/11] Symbol Namespaces Jessica Yu
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=20190828094325.GA25048@linux-8ccs \
--to=jeyu@kernel.org \
--cc=arnd@arndb.de \
--cc=geert@linux-m68k.org \
--cc=gregkh@linuxfoundation.org \
--cc=hpa@zytor.com \
--cc=joel@joelfernandes.org \
--cc=kernel-team@android.com \
--cc=kstewart@linuxfoundation.org \
--cc=linux-arch@vger.kernel.org \
--cc=linux-kbuild@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-m68k@lists.linux-m68k.org \
--cc=linux-modules@vger.kernel.org \
--cc=linux-scsi@vger.kernel.org \
--cc=linux-usb@vger.kernel.org \
--cc=lucas.de.marchi@gmail.com \
--cc=maco@android.com \
--cc=maco@google.com \
--cc=maennich@google.com \
--cc=michal.lkml@markovi.net \
--cc=mingo@redhat.com \
--cc=oneukum@suse.com \
--cc=pombredanne@nexb.com \
--cc=sam@ravnborg.org \
--cc=sspatil@google.com \
--cc=stern@rowland.harvard.edu \
--cc=tglx@linutronix.de \
--cc=usb-storage@lists.one-eyed-alien.net \
--cc=x86@kernel.org \
--cc=yamada.masahiro@socionext.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: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).