Received: by 2002:a25:8b12:0:0:0:0:0 with SMTP id i18csp610357ybl; Wed, 28 Aug 2019 02:44:50 -0700 (PDT) X-Google-Smtp-Source: APXvYqwWBf289vELZyJPGcxe/0nrttTu5ygvSViLjfrx4Hv0H3tVPB7qhIzreGFDgUPSZzyr2z6v X-Received: by 2002:a63:204b:: with SMTP id r11mr2653820pgm.121.1566985490551; Wed, 28 Aug 2019 02:44:50 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1566985490; cv=none; d=google.com; s=arc-20160816; b=YzE2M8ffQRKSALrrNHwrZzDTEWre2mL08E5upC7YaBE7Uic//6T4TtUWNpA+92nkKs FnJOFTsOESS2g0/QDxUMMd8ze+o0uky3NeoErpijcV+tkPRVW9PkizISZTRL2+5o+l0K 2IWFOojQqKeEWXuuTu4HRH8Dhzj83W7hZ7Vx2EkWNzYoS0vr4r8OSGkg09KmvTbFz3zz CWJB8SDclaAxd8H91h/yKOWDSqZOaYOZZ6MiWVkZ+uLreAJUIRI07ylVsqZk2FpxWLgI CcBEeTI8OyCjMz/ABX25LA3z5SYb2RoQ/hq1JzqW14K08zKOrfHyHgHx5j3J27hFUV7y +jFg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:user-agent:in-reply-to :content-disposition:mime-version:references:message-id:subject:cc :to:from:date:dkim-signature; bh=xXQgSf2MXjif+QFfOB6sF38yaNeoWl2f9hT++XAUt20=; b=kYXHFIuZdLkdcNlaA12IleLzsfYq4/KnGcSbz589Fji0F8/IhE6a8EJyLQZSzTAOBH KtE8cSRPOFkreMA60OGuTGoitnBcPl33VS5VNwoNJ+pMzw44Tj9xGs8O10vaRY9/Y5bO XDa6bqo0+eQCxtBQfHuVyDqtDEXHOdeywwbA/dEMwGD3E8T3rve6tRC8ZxqcMLgD0yOG /2BP8uJTHu22HfTaSQn0HRSATAEUA00FmeG81nTXf3ZGx/PJWJA7bmJIPLgoY3chsG8L uU/+vJw8oOdTFVZaKMEkRd1B5e5tlgTqkQ33jqFiszXDJ4LA9yNlCKEL8yee4Xk7cS87 RWOA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@kernel.org header.s=default header.b=KSVkX0Cg; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id v63si1763622pgd.111.2019.08.28.02.44.28; Wed, 28 Aug 2019 02:44:50 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; dkim=pass header.i=@kernel.org header.s=default header.b=KSVkX0Cg; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726454AbfH1Jnh (ORCPT + 99 others); Wed, 28 Aug 2019 05:43:37 -0400 Received: from mail.kernel.org ([198.145.29.99]:57918 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726273AbfH1Jnh (ORCPT ); Wed, 28 Aug 2019 05:43:37 -0400 Received: from linux-8ccs (ip5f5adbee.dynamic.kabel-deutschland.de [95.90.219.238]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id E457F20856; Wed, 28 Aug 2019 09:43:29 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1566985415; bh=DrxpcvLPjSoef3pZxbyGqKU+s+5EBC36hX41i/pgb9Q=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=KSVkX0CgHwWNBsu2RQeu4ZP/IvBVvB40IedOwcv7ENixOzcdZU8MUeeexgPlOi5u1 mIK5Xw9TIbZC4SYcwobysGcj7+rSdjPVrg+7EaJIsy5Yk4Jcq6IaqEWIlgk5QEdGSM CIIbpoJbCMm+6cqUQDa3gr/1HchbVefrheq+7EKI= Date: Wed, 28 Aug 2019 11:43:26 +0200 From: Jessica Yu To: Matthias Maennich 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 Message-ID: <20190828094325.GA25048@linux-8ccs> References: <20190813121733.52480-1-maennich@google.com> <20190821114955.12788-1-maennich@google.com> <20190821114955.12788-5-maennich@google.com> <20190826162138.GA31739@linux-8ccs> <20190827144117.GB102829@google.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii; format=flowed Content-Disposition: inline In-Reply-To: <20190827144117.GB102829@google.com> X-OS: Linux linux-8ccs 4.12.14-lp150.12.61-default x86_64 User-Agent: Mutt/1.10.1 (2018-07-13) Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org +++ 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 >>>Signed-off-by: Martijn Coenen >>>Reviewed-by: Joel Fernandes (Google) >>>Reviewed-by: Greg Kroah-Hartman >>>Signed-off-by: Matthias Maennich >>>--- >>>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 >> >> >> >>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