linux-kernel - [PATCH 1/4] Add targets to use the Coccinelle checker

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives
Hash Suite: Windows password security audit tool. GUI, reports in PDF.
[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-Id: <1273508667-5152-2-git-send-email-npalix@diku.dk>
Date:	Mon, 10 May 2010 18:24:24 +0200
From:	Nicolas Palix <npalix@...u.dk>
To:	Randy Dunlap <rdunlap@...otime.net>,
	Roland Dreier <rdreier@...co.com>,
	Joe Perches <joe@...ches.com>,
	Andrew Morton <akpm@...ux-foundation.org>,
	"David S. Miller" <davem@...emloft.net>,
	Michal Marek <mmarek@...e.cz>, Sam Ravnborg <sam@...nborg.org>,
	Julia Lawall <julia@...u.dk>,
	Gilles Muller <Gilles.Muller@...6.fr>,
	linux-kernel@...r.kernel.org, linux-kbuild@...r.kernel.org,
	cocci@...u.dk, Wolfram Sang <w.sang@...gutronix.de>
Cc:	Kernel Janitors <kernel-janitors@...r.kernel.org>,
	Nicolas Palix <npalix@...u.dk>, Julia Lawall <julia@...u.dk>
Subject: [PATCH 1/4] Add targets to use the Coccinelle checker

Four targets are added. Each one generates a different
output kind: context, patch, org, report.
Every SmPL file in 'scripts/coccinelle' is given to the spatch frontend
(located in the 'scripts' directory), and applied to the entire
source tree.

Signed-off-by: Nicolas Palix <npalix@...u.dk>
Signed-off-by: Julia Lawall <julia@...u.dk>
---
 MAINTAINERS           |   10 ++++++++++
 Makefile              |   20 ++++++++++++++++++--
 scripts/coccinelle.sh |   28 ++++++++++++++++++++++++++++
 3 files changed, 56 insertions(+), 2 deletions(-)
 create mode 100755 scripts/coccinelle.sh

diff --git a/MAINTAINERS b/MAINTAINERS
index d5b0b1b..84f527a 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1543,6 +1543,16 @@ L:	platform-driver-x86@...r.kernel.org
 S:	Supported
 F:	drivers/platform/x86/classmate-laptop.c
 
+COCCINELLE/Semantic Patches (SmPL)
+M:	Julia Lawall <julia@...u.dk>
+M:	Gilles Muller <Gilles.Muller@...6.fr>
+M:	Nicolas Palix <npalix@...u.dk>
+L:	cocci@...u.dk (moderated for non-subscribers)
+W:	http://coccinelle.lip6.fr/
+S:	Supported
+F:	scripts/coccinelle/
+F:	scripts/coccinelle.sh
+
 CODA FILE SYSTEM
 M:	Jan Harkes <jaharkes@...cmu.edu>
 M:	coda@...cmu.edu
diff --git a/Makefile b/Makefile
index 701bc65..7bf168f 100644
--- a/Makefile
+++ b/Makefile
@@ -325,6 +325,7 @@ INSTALLKERNEL  := installkernel
 DEPMOD		= /sbin/depmod
 KALLSYMS	= scripts/kallsyms
 PERL		= perl
+COCCINELLE      = spatch
 CHECK		= sparse
 
 CHECKFLAGS     := -D__linux__ -Dlinux -D__STDC__ -Dunix -D__unix__ \
@@ -411,7 +412,8 @@ endif
 no-dot-config-targets := clean mrproper distclean \
 			 cscope TAGS tags help %docs check% \
 			 include/linux/version.h headers_% \
-			 kernelrelease kernelversion
+			 kernelrelease kernelversion        \
+			 coccicheck-%
 
 config-targets := 0
 mixed-targets  := 0
@@ -1264,7 +1266,8 @@ help:
 	@echo  '  includecheck    - Check for duplicate included header files'
 	@echo  '  export_report   - List the usages of all exported symbols'
 	@echo  '  headers_check   - Sanity check on exported headers'
-	@echo  '  headerdep       - Detect inclusion cycles in headers'; \
+	@echo  '  headerdep       - Detect inclusion cycles in headers'
+	@echo  '  coccicheck-<m>  - Check with Coccinelle in <m> mode (report, context, patch, org)'; \
 	 echo  ''
 	@echo  'Kernel packaging:'
 	@$(MAKE) $(build)=$(package-dir) help
@@ -1424,6 +1427,19 @@ versioncheck:
 		-name '*.[hcS]' -type f -print | sort \
 		| xargs $(PERL) -w $(srctree)/scripts/checkversion.pl
 
+coccicheck-context coccicheck-patch coccicheck-org coccicheck-report:
+	@echo ''
+	@echo 'Please check for false positives in the output before submitting a patch.'
+	@echo 'When using "patch" mode, carefully review the patch before submitting it.'
+	@echo ''
+	@if [ "$(COCCI)" = "" ] ; then                         \
+	find $(srctree)/scripts/coccinelle/                    \
+		-name '*.cocci' -type f                        \
+		-exec $(srctree)/scripts/coccinelle.sh $(COCCINELLE) $(@:coccicheck-%=%) \{} $(srctree) \; ; \
+	else                                                                                                 \
+		$(srctree)/scripts/coccinelle.sh $(COCCINELLE) $(@:coccicheck-%=%) $(COCCI) $(srctree)     ; \
+	fi
+
 namespacecheck:
 	$(PERL) $(srctree)/scripts/namespace.pl
 
diff --git a/scripts/coccinelle.sh b/scripts/coccinelle.sh
new file mode 100755
index 0000000..0d29e93
--- /dev/null
+++ b/scripts/coccinelle.sh
@@ -0,0 +1,28 @@
+#!/bin/sh
+
+SPATCH="`which $1`"
+MODE="$2"
+COCCI="$3"
+DIR="$4"
+
+OPT=`grep "Option" $COCCI | cut -d':' -f2`
+FILE=`echo $COCCI | sed "s|$DIR/||"`
+
+if [ -x "$SPATCH" ]; then
+
+    echo "Processing `basename $COCCI` with option(s) \"$(OPT)\""
+    echo 'Message example to submit a patch:'
+    sed -e '/\/\/\//!d' -e 's|^///||' $COCCI
+
+    echo ' The semantic patch that makes this change is available'
+    echo " in $FILE."
+    echo ''
+    echo ' More information about semantic patching is available at'
+    echo ' http://coccinelle.lip6.fr/'
+    echo ''
+
+    $SPATCH -D $MODE -very_quiet -sp_file $COCCI $OPT -dir $DIR
+
+else
+    echo 'spatch is part of the Coccinelle project and is available at http://coccinelle.lip6.fr/'
+fi
-- 
1.7.0.4

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/