From patchwork Mon Jul 16 12:21:24 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Martijn Coenen X-Patchwork-Id: 10526625 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id E80E760348 for ; Mon, 16 Jul 2018 12:21:43 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id D94C4288EA for ; Mon, 16 Jul 2018 12:21:43 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id CD5B128A80; Mon, 16 Jul 2018 12:21:43 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-7.8 required=2.0 tests=BAYES_00,DKIM_SIGNED, MAILING_LIST_MULTI, RCVD_IN_DNSWL_HI, T_DKIM_INVALID autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 44F99288EA for ; Mon, 16 Jul 2018 12:21:43 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1731269AbeGPMsw (ORCPT ); Mon, 16 Jul 2018 08:48:52 -0400 Received: from mail-ed1-f67.google.com ([209.85.208.67]:34967 "EHLO mail-ed1-f67.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1731093AbeGPMsw (ORCPT ); Mon, 16 Jul 2018 08:48:52 -0400 Received: by mail-ed1-f67.google.com with SMTP id b10-v6so29800520edi.2 for ; Mon, 16 Jul 2018 05:21:39 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=android.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=Qu+bT7PO79vqYWmK/HljxHsQAW+8guyzbN9/q2IIU2E=; b=Wx77KgRp52cggbrbkIxxAeqouIrDNtpsN15HzRltDqrJiE5APXqULFAHUF3xOKdaMO Fy8jTQgJ6im00gve/rIgN0XN7RDMHBPaYKHYUhoHp1GwxtJ/lCYGfKo1hUlDWPE3eexF 28CrNZZM1sKHUsY4AvmxOt1PqMo1Y3R2vIaMZdBKt0BWKMH41ru15VCV/b/9cMgwe809 4lQgnDN/z6GJV3t3f+pSnzcEoqDKhI+TaCpd3l3anmmT7cXnLvzGBTzBAttWKSyhfKk9 W1cukE10fSFxba6/pk0ATzTUfVpSuAoa9bXICvF+wbhhRrUy75kJC5kjNwPR1U0h/kPW m46Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=Qu+bT7PO79vqYWmK/HljxHsQAW+8guyzbN9/q2IIU2E=; b=DpCyLkCRM0RwxhyP9waoKR0RiYjyE0uUjvadG3DFxcFew4ln9P8Alh0TAeSgxapPIm ZlXtisDb1i/zEMaaLNcKc2sIJl5hS56m1GFKAbzYU4JN86c6q9AmmeUKc7lVnP0YW06e EN9NnIZwJo2BQm36ERsqQE4/5OBiLKDkRFM2wnbhHEnofueymNfrP1xF9dT200WB45rR 8OtlQ3s/uA7PECyN4w6hwgRRqUzx1LExajtSzDPFls0LXGAoHZhyScGvGXMenKLXUl3l 5GOyJfOi0c+nVgwFmn8v/n3qlz+4fQLuNSoAP5NMboC8wbikbAMThpHaqYsXEg67MICa wbng== X-Gm-Message-State: AOUpUlHyZsf4mu2l9kkfiuLkxDHQ85aAan2xL4UHEbUf1UdnR4nk/vWQ 7LTBWIOZFsfirQBKhH5AXTzxBg== X-Google-Smtp-Source: AAOMgpcZSdUIiA9zKztW4es5dig2R5tins3PQjWL4rRvGpw5dBvqjAWeoBypi1H+j1UsCVyG6/wXwg== X-Received: by 2002:aa7:c0c9:: with SMTP id j9-v6mr17324330edp.135.1531743699064; Mon, 16 Jul 2018 05:21:39 -0700 (PDT) Received: from maco.fcp3.net (a83-162-234-235.adsl.xs4all.nl. [83.162.234.235]) by smtp.gmail.com with ESMTPSA id a9-v6sm4635471edi.26.2018.07.16.05.21.37 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 16 Jul 2018 05:21:38 -0700 (PDT) From: Martijn Coenen To: linux-kernel@vger.kernel.org Cc: Martijn Coenen , Masahiro Yamada , Michal Marek , Geert Uytterhoeven , Thomas Gleixner , Ingo Molnar , "H. Peter Anvin" , x86@kernel.org, Alan Stern , Greg Kroah-Hartman , Oliver Neukum , Arnd Bergmann , Jessica Yu , Stephen Boyd , Philippe Ombredanne , Kate Stewart , Sam Ravnborg , linux-kbuild@vger.kernel.org, linux-m68k@lists.linux-m68k.org, linux-usb@vger.kernel.org, usb-storage@lists.one-eyed-alien.net, linux-scsi@vger.kernel.org, linux-arch@vger.kernel.org, maco@google.com, sspatil@google.com, malchev@google.com, joelaf@google.com Subject: [PATCH 5/6] scripts: Coccinelle script for namespace dependencies. Date: Mon, 16 Jul 2018 14:21:24 +0200 Message-Id: <20180716122125.175792-6-maco@android.com> X-Mailer: git-send-email 2.18.0.203.gfac676dfb9-goog In-Reply-To: <20180716122125.175792-1-maco@android.com> References: <20180716122125.175792-1-maco@android.com> Sender: linux-usb-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-usb@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP A script that uses the '.ns_deps' file generated by modpost to automatically add the required symbol namespace dependencies to each module. Usage: 1) Move some symbols to a namespace with EXPORT_SYMBOL_NS() 2) Run 'make' (or 'make modules'), get warnings about modules not importing that namespace 3) Run 'make nsdeps' to automatically add required import statements to said modules This makes it easer for subsystem maintainers to introduce and maintain symbol namespaces into their codebase. Signed-off-by: Martijn Coenen --- Makefile | 11 ++++++++++ scripts/Makefile.modpost | 4 +++- scripts/add_namespace.cocci | 19 +++++++++++++++++ scripts/nsdeps | 41 +++++++++++++++++++++++++++++++++++++ 4 files changed, 74 insertions(+), 1 deletion(-) create mode 100644 scripts/add_namespace.cocci create mode 100644 scripts/nsdeps diff --git a/Makefile b/Makefile index 925c55f2524f..96e62d732a3b 100644 --- a/Makefile +++ b/Makefile @@ -1391,6 +1391,9 @@ help: @echo ' headerdep - Detect inclusion cycles in headers' @echo ' coccicheck - Check with Coccinelle' @echo '' + @echo 'Tools:' + @echo ' nsdeps - Generate missing symbol namespace dependencies' + @echo '' @echo 'Kernel selftest:' @echo ' kselftest - Build and run kernel selftest (run as root)' @echo ' Build, install, and boot kernel before' @@ -1566,6 +1569,14 @@ quiet_cmd_tags = GEN $@ tags TAGS cscope gtags: FORCE $(call cmd,tags) +# Script to generate missing namespace dependencies + +PHONY += nsdeps + +nsdeps: + $(Q)$(MAKE) -f $(srctree)/scripts/Makefile.modpost nsdeps + $(Q)$(CONFIG_SHELL) $(srctree)/scripts/$@ + # Scripts to check various things for consistency # --------------------------------------------------------------------------- diff --git a/scripts/Makefile.modpost b/scripts/Makefile.modpost index df4174405feb..a9a90c3e3879 100644 --- a/scripts/Makefile.modpost +++ b/scripts/Makefile.modpost @@ -79,7 +79,8 @@ modpost = scripts/mod/modpost \ $(if $(KBUILD_EXTMOD),-o $(modulesymfile)) \ $(if $(CONFIG_DEBUG_SECTION_MISMATCH),,-S) \ $(if $(CONFIG_SECTION_MISMATCH_WARN_ONLY),,-E) \ - $(if $(KBUILD_EXTMOD)$(KBUILD_MODPOST_WARN),-w) + $(if $(KBUILD_EXTMOD)$(KBUILD_MODPOST_WARN),-w) \ + $(if $(filter nsdeps,$(MAKECMDGOALS)),-d) MODPOST_OPT=$(subst -i,-n,$(filter -i,$(MAKEFLAGS))) @@ -130,6 +131,7 @@ $(modules): %.ko :%.o %.mod.o FORCE targets += $(modules) +nsdeps: _modpost # Add FORCE to the prequisites of a target to force it to be always rebuilt. # --------------------------------------------------------------------------- diff --git a/scripts/add_namespace.cocci b/scripts/add_namespace.cocci new file mode 100644 index 000000000000..a6d33e066067 --- /dev/null +++ b/scripts/add_namespace.cocci @@ -0,0 +1,19 @@ +@has_ns_import@ +declarer name MODULE_IMPORT_NS; +identifier virtual.ns; +@@ +MODULE_IMPORT_NS(ns); + +@has_module_license@ +declarer name MODULE_LICENSE; +expression license; +@@ +MODULE_LICENSE(license); + +@do_import depends on has_module_license && !has_ns_import@ +declarer name MODULE_LICENSE; +expression license; +identifier virtual.ns; +@@ +MODULE_LICENSE(license); ++ MODULE_IMPORT_NS(ns); diff --git a/scripts/nsdeps b/scripts/nsdeps new file mode 100644 index 000000000000..5678e02626b3 --- /dev/null +++ b/scripts/nsdeps @@ -0,0 +1,41 @@ +#!/bin/bash +# SPDX-License-Identifier: GPL-2.0 +# Linux kernel symbol namespace import generator +# +# This script requires at least spatch +# version 1.0.6. +SPATCH_REQ_VERSION="1.0.6" + +DIR="$(dirname $(readlink -f $0))/.." +SPATCH="`which ${SPATCH:=spatch}`" +if [ ! -x "$SPATCH" ]; then + echo 'spatch is part of the Coccinelle project and is available at http://coccinelle.lip6.fr/' + exit 1 +fi + +SPATCH_REQ_VERSION_NUM=$(echo $SPATCH_REQ_VERSION | ${DIR}/scripts/ld-version.sh) +SPATCH_VERSION=$($SPATCH --version | head -1 | awk '{print $3}') +SPATCH_VERSION_NUM=$(echo $SPATCH_VERSION | ${DIR}/scripts/ld-version.sh) + +if [ "$SPATCH_VERSION_NUM" -lt "$SPATCH_REQ_VERSION_NUM" ] ; then + echo 'spatch needs to be version 1.06 or higher' + exit 1 +fi + +generate_deps_for_ns() { + $SPATCH --very-quiet --in-place --sp-file $srctree/scripts/add_namespace.cocci -D ns=$1 $2 +} + +generate_deps() { + local mod_file=`echo $@ | sed -e 's/\.ns_deps/\.mod/'` + local mod_name=`cat $mod_file | sed -n 1p | sed -e 's/\/[^.]*$//'` + local mod_source_files=`cat $mod_file | sed -n 2p | sed -e 's/\.o/\.c/'` + for ns in `cat $@`; do + echo "Adding namespace $ns to module $mod_name (if needed)." + generate_deps_for_ns $ns $mod_source_files + done +} + +for f in `find $srctree/.tmp_versions/ -name *.ns_deps`; do + generate_deps $f +done