From patchwork Sun Jul 28 17:34:45 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Masahiro Yamada X-Patchwork-Id: 11063011 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id C0F2014E5 for ; Sun, 28 Jul 2019 17:35:38 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id A7EF71FF7F for ; Sun, 28 Jul 2019 17:35:38 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 9A6E9205A8; Sun, 28 Jul 2019 17:35:38 +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.9 required=2.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI 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 12D681FF7F for ; Sun, 28 Jul 2019 17:35:38 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726080AbfG1Rfh (ORCPT ); Sun, 28 Jul 2019 13:35:37 -0400 Received: from conuserg-07.nifty.com ([210.131.2.74]:60666 "EHLO conuserg-07.nifty.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726046AbfG1Rfh (ORCPT ); Sun, 28 Jul 2019 13:35:37 -0400 Received: from grover.flets-west.jp (softbank126026094249.bbtec.net [126.26.94.249]) (authenticated) by conuserg-07.nifty.com with ESMTP id x6SHYoZH026150; Mon, 29 Jul 2019 02:34:51 +0900 DKIM-Filter: OpenDKIM Filter v2.10.3 conuserg-07.nifty.com x6SHYoZH026150 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=nifty.com; s=dec2015msa; t=1564335291; bh=iG031DUvivyDj4/eRwi67WX79/aUiFl95rYeNucb6+g=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=eFmlKTvqurETKdUjDROj/ki74BFxx3sdW/DnBcIPvnTD2AA2UEBB7S1ocoFsd2Q9+ uX0suAIK3rfIxLfzkw9+NAKKswjhn8jxh8GYm2tC+kp0IqJWdGZhoK1hlKMHbMMPyo +cl07RdYP/vkpcinJINvpOaUjwMbZAyBjG+SYvHyKZn8QpTT/kKLX8EnQVpRrSWP+b z86D7pX0C70dFFgzWpNvlPhqVvauJWnWRygE8g0UqDNEeFZGQtIg+KVYlju0enl2IB RNkMVtd3dC/UR4zuYPdakPnwN0g27f+6EHcWvdJeOd3qWYOxKfr/8aMO6m5aXKoVh8 vo0tc5PCGSgNw== X-Nifty-SrcIP: [126.26.94.249] From: Masahiro Yamada To: linux-kbuild@vger.kernel.org Cc: Arnd Bergmann , linux-kernel@vger.kernel.org, Sam Ravnborg , Masahiro Yamada Subject: [PATCH 2/2] kbuild: detect missing header include guard Date: Mon, 29 Jul 2019 02:34:45 +0900 Message-Id: <20190728173445.10954-2-yamada.masahiro@socionext.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20190728173445.10954-1-yamada.masahiro@socionext.com> References: <20190728173445.10954-1-yamada.masahiro@socionext.com> Sender: linux-kbuild-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kbuild@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Our convention is to surround the whole of the header content with an include guard. This avoids the same header being parsed over again in case it is included multiple times. The include guard is missing in several places, or broken due to the mismatch between #ifndef and #define. The recently added header-test-y syntax allows the comprehensive sanity checks of headers. This commit adds another check; if include guard is missing, the header will fail to build due to redefinition of something. Some headers must be excluded from the test-coverage for now. I will let them in after they are fixed. Signed-off-by: Masahiro Yamada Reviewed-by: Sam Ravnborg --- scripts/Makefile.build | 3 ++- usr/include/Makefile | 6 ++++++ 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/scripts/Makefile.build b/scripts/Makefile.build index 0d434d0afc0b..b024b108055b 100644 --- a/scripts/Makefile.build +++ b/scripts/Makefile.build @@ -294,8 +294,9 @@ $(obj)/%.lst: $(src)/%.c FORCE # header test (header-test-y, header-test-m target) # --------------------------------------------------------------------------- +# include the header twice to catch missing header include guard. quiet_cmd_cc_s_h = CC $@ - cmd_cc_s_h = $(CC) $(c_flags) -S -o $@ -x c /dev/null -include $< + cmd_cc_s_h = $(CC) $(c_flags) -S -o $@ -x c /dev/null -include $< -include $< $(obj)/%.h.s: $(src)/%.h FORCE $(call if_changed_dep,cc_s_h) diff --git a/usr/include/Makefile b/usr/include/Makefile index 1fb6abe29b2f..ee945819c9d8 100644 --- a/usr/include/Makefile +++ b/usr/include/Makefile @@ -28,8 +28,11 @@ header-test- += linux/android/binder.h header-test- += linux/android/binderfs.h header-test-$(CONFIG_CPU_BIG_ENDIAN) += linux/byteorder/big_endian.h header-test-$(CONFIG_CPU_LITTLE_ENDIAN) += linux/byteorder/little_endian.h +header-test- += linux/chio.h # missing include guard +header-test- += linux/cryptouser.h # missing include guard header-test- += linux/coda.h header-test- += linux/coda_psdev.h +header-test- += linux/coff.h # missing include guard header-test- += linux/elfcore.h header-test- += linux/errqueue.h header-test- += linux/fsmap.h @@ -38,6 +41,7 @@ header-test- += linux/ivtv.h header-test- += linux/jffs2.h header-test- += linux/kexec.h header-test- += linux/matroxfb.h +header-test- += linux/netfilter/xt_connlabel.h # missing include guard header-test- += linux/netfilter_bridge/ebtables.h header-test- += linux/netfilter_ipv4/ipt_LOG.h header-test- += linux/netfilter_ipv6/ip6t_LOG.h @@ -45,7 +49,9 @@ header-test- += linux/nfc.h header-test- += linux/omap3isp.h header-test- += linux/omapfb.h header-test- += linux/patchkey.h +header-test- += linux/pg.h # missing include guard header-test- += linux/phonet.h +header-test- += linux/ppdev.h # missing include guard header-test- += linux/reiserfs_xattr.h header-test- += linux/scc.h header-test- += linux/sctp.h