Received: by 2002:a05:6a10:f347:0:0:0:0 with SMTP id d7csp706675pxu; Thu, 7 Jan 2021 16:32:19 -0800 (PST) X-Google-Smtp-Source: ABdhPJy7H2ctSsTEAjNE1yt95Bp+LZQX7E33sVC4aII13bsDJjQpx9FqnLrcf73LuFdaq6Mv1Arc X-Received: by 2002:a05:6402:1a30:: with SMTP id be16mr3584346edb.124.1610065939680; Thu, 07 Jan 2021 16:32:19 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1610065939; cv=none; d=google.com; s=arc-20160816; b=nTX98FUHmu9EMBZ8RU5wcJI3Nqvuhn4b7AS2mnTMrbrE5vfz6mcC/5+OYhUhzQCMki X1ONR+5WO2IxLZU59VDFVw1WgHNL1kA/NvdKBG5JprPZZn/667kve4liEKqJeW9rLgYF 6WN5EIVwYbXbEJxKf71hq/816f3lONV4CC51ntGqTIHCoXWs/QJXkbv7gmJT1PyJmY5k vPtLRpI+p/uU9dYlm6Qxn2N2ZHMa3RHb1Ic/flpHIkefPc72882zcBruOGAjrFmAJhe/ sSECzKM4P08UUTd8O6Y3CMf41T8/yjy6EM70/utoeRxvmcjnjPdYVnbr048ZwKeev8dh PKoQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:cc:to:from:subject:mime-version:message-id:date :sender:dkim-signature; bh=Nplr4obYZhTigkVU/n6i7dQLmPyw1YDLtDm6tMWrmf4=; b=P8rvxaySKig6TOK3Uy+2iNDAeOgKbQbGWh8qR6IbIfCNY19yVVc0Y4VkHyL35wJE8t dOiO4fzGkCbl+x7lSjNOr8nANlIA6Vl+I0qWZrkXHCDCRzvB+UL5aylOSMKisAi3qx3r YzvFSqmJnw1KqDcTmquJN0+U9JWXtRGoSTxSQNTHyyeDoyv6Pplla53+8kgheXCKis6b CM7bUMy8FG4jGjklZzjeQX2wlwvnk9PljRJOx+EzmIm9v91I6yLynTr4ZC4+6BYxVdDF N/uEH8XzMmEsL2+R1ZiRvEy5x8DM+S8NqnSK8yH2A4Wgjgl97xwgm64SWSpOPetlPYye Y6Jw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@google.com header.s=20161025 header.b="ntGsm/gW"; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=google.com Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id k29si3004104edk.367.2021.01.07.16.31.55; Thu, 07 Jan 2021 16:32:19 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; dkim=pass header.i=@google.com header.s=20161025 header.b="ntGsm/gW"; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=google.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727235AbhAHAbY (ORCPT + 99 others); Thu, 7 Jan 2021 19:31:24 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:37938 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1728416AbhAHAbY (ORCPT ); Thu, 7 Jan 2021 19:31:24 -0500 Received: from mail-pj1-x1049.google.com (mail-pj1-x1049.google.com [IPv6:2607:f8b0:4864:20::1049]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 0A48EC0612F5 for ; Thu, 7 Jan 2021 16:30:44 -0800 (PST) Received: by mail-pj1-x1049.google.com with SMTP id my8so5635018pjb.3 for ; Thu, 07 Jan 2021 16:30:43 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20161025; h=sender:date:message-id:mime-version:subject:from:to:cc; bh=Nplr4obYZhTigkVU/n6i7dQLmPyw1YDLtDm6tMWrmf4=; b=ntGsm/gWCHkfPEeAqZsCZK2mP4fFyUhkcVsAn4srv7Qx5NctmZ2j8WSbHdOlOU0wXq r16GdCijP9gjIJZjdwFokfMwaYKoLQkYkUyaaG3p62sYcuu54qlefrs+HMkAQYHVodeF wuKha78FtSDE3cZdib3FOHv+0YKTrta0RUNLvhNn1ko+5lynz9lCAGTrT6enetD+3v8g A3MD2VaghoU9diqPyVSdVNzhEIdbfIRnumVMomriur3vbZ+J0XCfaQV3pldzGbq8GPtz s7ryzyt9H5mMiHgZGxKEch3ARpJat4YaVW5JYSCMv+ABoor8ndXYhgItuQI53q7rh9Vb O0IA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:date:message-id:mime-version:subject:from :to:cc; bh=Nplr4obYZhTigkVU/n6i7dQLmPyw1YDLtDm6tMWrmf4=; b=PUN8UOixURYs7xD1cbF8sirTPSeSOW7fxv6b0EDmGRGgxWNM3jiexbDDR8cyJqNZK5 YYsDPXUNmCxxm1bgaUdEiCTZ3VVfyojsHBYo0QdEiplQ+mDVwvSiLkvEckfXRX3zIDuI 9tvOrTpv51nX+CB70fl2Qo2s6+KxGEsav4Cvu88PUdPxcdibIE25LmTMKSTJ/OH5Kt1B GK02VDsBpZDDtB4rJbZ0EGD+ff4iO1mCU0ata1uk4RTVZ0YgiHIlE6fXG5hMjsR8m1sF My7/DQqNulEobxdMzxHYdTbpK1dhPnE3XVsdNt5DBGrMHokvqnoD/BYn9biXXB4e9CUl 7GbA== X-Gm-Message-State: AOAM533qB3Jl1lK7CqwNk3NwRgQMAwvCkDx4Y8N4aWwvbS8Xm7Bw2njl lSzZLhWnQA3m4nhmJ2fB6ctffLaEcuSY/USyNFw= Sender: "willmcvicker via sendgmr" X-Received: from willmcvicker.c.googlers.com ([fda3:e722:ac3:10:24:72f4:c0a8:2dd0]) (user=willmcvicker job=sendgmr) by 2002:a17:902:67:b029:dc:3cdb:6e50 with SMTP id 94-20020a1709020067b02900dc3cdb6e50mr1294263pla.61.1610065843443; Thu, 07 Jan 2021 16:30:43 -0800 (PST) Date: Fri, 8 Jan 2021 00:30:35 +0000 Message-Id: <20210108003035.1930475-1-willmcvicker@google.com> Mime-Version: 1.0 X-Mailer: git-send-email 2.29.2.729.g45daf8777d-goog Subject: [PATCH v5] modules: introduce the MODULE_SCMVERSION config From: Will McVicker To: Jessica Yu , Masahiro Yamada , Michal Marek Cc: Greg Kroah-Hartman , Christoph Hellwig , Saravana Kannan , linux-kernel@vger.kernel.org, linux-kbuild@vger.kernel.org, kernel-team@android.com, Will McVicker Content-Type: text/plain; charset="UTF-8" Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Config MODULE_SCMVERSION introduces a new module attribute -- `scmversion` -- which can be used to identify a given module's SCM version. This is very useful for developers that update their kernel independently from their kernel modules or vice-versa since the SCM version provided by UTS_RELEASE (`uname -r`) will now differ from the module's vermagic attribute. For example, we have a CI setup that tests new kernel changes on the hikey960 and db845c devices without updating their kernel modules. When these tests fail, we need to be able to identify the exact device configuration the test was using. By including MODULE_SCMVERSION, we can identify the exact kernel and modules' SCM versions for debugging the failures. Additionally, by exposing the SCM version via the sysfs node /sys/module/MODULENAME/scmversion, one can also verify the SCM versions of the modules loaded from the initramfs. Currently, modinfo can only retrieve module attributes from the module's ko on disk and not from the actual module that is loaded in RAM. You can retrieve the SCM version in two ways, 1) By using modinfo: > modinfo -F scmversion MODULENAME 2) By module sysfs node: > cat /sys/module/MODULENAME/scmversion Signed-off-by: Will McVicker --- Documentation/ABI/stable/sysfs-module | 18 ++++++++++++++++++ include/linux/module.h | 1 + init/Kconfig | 14 ++++++++++++++ kernel/module.c | 2 ++ scripts/Makefile.modpost | 22 ++++++++++++++++++++++ scripts/mod/modpost.c | 24 +++++++++++++++++++++++- 6 files changed, 80 insertions(+), 1 deletion(-) diff --git a/Documentation/ABI/stable/sysfs-module b/Documentation/ABI/stable/sysfs-module index 6272ae5fb366..a75d137e79f4 100644 --- a/Documentation/ABI/stable/sysfs-module +++ b/Documentation/ABI/stable/sysfs-module @@ -32,3 +32,21 @@ Description: Note: If the module is built into the kernel, or if the CONFIG_MODULE_UNLOAD kernel configuration value is not enabled, this file will not be present. + +What: /sys/module/MODULENAME/scmversion +Date: November 2020 +KernelVersion: 5.12 +Contact: Will McVicker +Description: This read-only file will appear if modpost was supplied with an + SCM version for the module. It can be enabled with the config + MODULE_SCMVERSION. The SCM version is retrieved by + scripts/setlocalversion, which means that the presence of this + file depends on CONFIG_LOCALVERSION_AUTO=y. When read, the SCM + version that the module was compiled with is returned. The SCM + version is returned in the following format:: + + === + Git: g[a-f0-9]\+(-dirty)\? + Mercurial: hg[a-f0-9]\+(-dirty)\? + Subversion: svn[0-9]\+ + === diff --git a/include/linux/module.h b/include/linux/module.h index 7a0bcb5b1ffc..3b1612193cf9 100644 --- a/include/linux/module.h +++ b/include/linux/module.h @@ -372,6 +372,7 @@ struct module { struct module_attribute *modinfo_attrs; const char *version; const char *srcversion; + const char *scmversion; struct kobject *holders_dir; /* Exported symbols */ diff --git a/init/Kconfig b/init/Kconfig index b77c60f8b963..3d9dac3c4e8f 100644 --- a/init/Kconfig +++ b/init/Kconfig @@ -2131,6 +2131,20 @@ config MODULE_SRCVERSION_ALL the version). With this option, such a "srcversion" field will be created for all modules. If unsure, say N. +config MODULE_SCMVERSION + bool "SCM version for modules" + depends on LOCALVERSION_AUTO + help + This enables the module attribute "scmversion" which can be used + by developers to identify the SCM version of a given module, e.g. + git sha1 or hg sha1. The SCM version can be queried by modinfo or + via the sysfs node: /sys/modules/MODULENAME/scmversion. This is + useful when the kernel or kernel modules are updated separately + since that causes the vermagic of the kernel and the module to + differ. + + If unsure, say N. + config MODULE_SIG bool "Module signature verification" select MODULE_SIG_FORMAT diff --git a/kernel/module.c b/kernel/module.c index 4bf30e4b3eaa..d0b359c7e9c9 100644 --- a/kernel/module.c +++ b/kernel/module.c @@ -837,6 +837,7 @@ static struct module_attribute modinfo_##field = { \ MODINFO_ATTR(version); MODINFO_ATTR(srcversion); +MODINFO_ATTR(scmversion); static char last_unloaded_module[MODULE_NAME_LEN+1]; @@ -1298,6 +1299,7 @@ static struct module_attribute *modinfo_attrs[] = { &module_uevent, &modinfo_version, &modinfo_srcversion, + &modinfo_scmversion, &modinfo_initstate, &modinfo_coresize, &modinfo_initsize, diff --git a/scripts/Makefile.modpost b/scripts/Makefile.modpost index f54b6ac37ac2..f1126b60adb7 100644 --- a/scripts/Makefile.modpost +++ b/scripts/Makefile.modpost @@ -66,6 +66,7 @@ ifeq ($(KBUILD_EXTMOD),) input-symdump := vmlinux.symvers output-symdump := Module.symvers +module_srcpath := $(srctree) else @@ -77,6 +78,17 @@ src := $(obj) include $(if $(wildcard $(KBUILD_EXTMOD)/Kbuild), \ $(KBUILD_EXTMOD)/Kbuild, $(KBUILD_EXTMOD)/Makefile) +# Get the external module's source path. KBUILD_EXTMOD could either be an +# absolute path or relative path from $(srctree). This makes sure that we +# aren't using a relative path from a separate working directory (O= or +# KBUILD_OUTPUT) since that may not be the actual module's SCM project path. +# So check the path relative to $(srctree) first. +ifneq ($(realpath $(srctree)/$(KBUILD_EXTMOD) 2>/dev/null),) + module_srcpath := $(srctree)/$(KBUILD_EXTMOD) +else + module_srcpath := $(KBUILD_EXTMOD) +endif + # modpost option for external modules MODPOST += -e @@ -85,6 +97,16 @@ output-symdump := $(KBUILD_EXTMOD)/Module.symvers endif +ifeq ($(CONFIG_MODULE_SCMVERSION),y) +# Get the SCM version of the module. Sed verifies setlocalversion returns +# a proper revision based on the SCM type, e.g. git, mercurial, or svn. +module_scmversion := $(shell $(srctree)/scripts/setlocalversion $(module_srcpath) | \ + sed -n 's/.*-\(\(g\|hg\)[a-fA-F0-9]\+\(-dirty\)\?\|svn[0-9]\+\).*/\1/p') +ifneq ($(module_scmversion),) +MODPOST += -v$(module_scmversion) +endif +endif + # modpost options for modules (both in-kernel and external) MODPOST += \ $(addprefix -i ,$(wildcard $(input-symdump))) \ diff --git a/scripts/mod/modpost.c b/scripts/mod/modpost.c index d6c81657d695..489b65bc37de 100644 --- a/scripts/mod/modpost.c +++ b/scripts/mod/modpost.c @@ -30,6 +30,8 @@ static int have_vmlinux = 0; static int all_versions = 0; /* If we are modposting external module set to 1 */ static int external_module = 0; +#define MODULE_SCMVERSION_SIZE 64 +static char module_scmversion[MODULE_SCMVERSION_SIZE]; /* Only warn about unresolved symbols */ static int warn_unresolved = 0; /* How a symbol is exported */ @@ -2264,6 +2266,20 @@ static void add_intree_flag(struct buffer *b, int is_intree) buf_printf(b, "\nMODULE_INFO(intree, \"Y\");\n"); } +/** + * add_scmversion() - Adds the MODULE_INFO macro for the scmversion. + * @b: Buffer to append to. + * + * This function fills in the module attribute `scmversion` for the kernel + * module. This is useful for determining a given module's SCM version on + * device via /sys/modules//scmversion and/or using the modinfo tool. + */ +static void add_scmversion(struct buffer *b) +{ + if (module_scmversion[0] != '\0') + buf_printf(b, "\nMODULE_INFO(scmversion, \"%s\");\n", module_scmversion); +} + /* Cannot check for assembler */ static void add_retpoline(struct buffer *b) { @@ -2546,7 +2562,7 @@ int main(int argc, char **argv) struct dump_list *dump_read_start = NULL; struct dump_list **dump_read_iter = &dump_read_start; - while ((opt = getopt(argc, argv, "ei:mnT:o:awENd:")) != -1) { + while ((opt = getopt(argc, argv, "ei:mnT:o:awENd:v:")) != -1) { switch (opt) { case 'e': external_module = 1; @@ -2584,6 +2600,11 @@ int main(int argc, char **argv) case 'd': missing_namespace_deps = optarg; break; + case 'v': + if (!optarg) + fatal("'-v' requires an argument defining the SCM version."); + strncpy(module_scmversion, optarg, sizeof(module_scmversion) - 1); + break; default: exit(1); } @@ -2630,6 +2651,7 @@ int main(int argc, char **argv) add_depends(&buf, mod); add_moddevtable(&buf, mod); add_srcversion(&buf, mod); + add_scmversion(&buf); sprintf(fname, "%s.mod.c", mod->name); write_if_changed(&buf, fname); -- 2.30.0.284.gd98b1dd5eaa7-goog