Prev: schedule inside spin_lock_irqsave
Next: Device tree update for the 460ex DWC SATA<resubmission>
From: Sam Ravnborg on 6 Jun 2010 14:20
On Sun, Jun 06, 2010 at 05:15:01PM +0200, Nicolas Palix wrote:
> A 'coccicheck' target is added. It can be called with four different
> modes. Each one generates a different kind of output, i.e. context,
> patch, org, report, according to the corresponding mode to be
> activated.
>
> The new target calls the 'coccicheck' front-end in the 'scripts'
> directory with the MODE argument. Every SmPL file in the
> subdirectories of 'scripts/coccinelle' is then given to the front-end
> and applied to the entire source tree.
>
> The four modes behave as follows:
>
> 'report' generates a list in the following format:
> file:line:column-column: message
>
> 'patch' proposes a fix, when possible.
>
> 'context' highlights lines of interest and their context in a
> diff-like style. Lines of interest are indicated with '-'.
>
> 'org' generates a report in the Org mode format of Emacs.
>
> Signed-off-by: Nicolas Palix <npalix(a)diku.dk>
> Signed-off-by: Julia Lawall <julia(a)diku.dk>

Hi Nicolas.

This is almost what I had in mind - thanks.

Most importantly it no longer add all the stuff
to the top-level Makefile but defer this to a script.

If/when we decide to move all the checkers to scripts/*
we can do the last adjustments.

Acked-by: Sam Ravnborg <sam(a)ravnborg.org>

Sam
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo(a)vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
From: Nicolas Palix on 7 Jun 2010 08:40
From 3765ca033cd6ffe8a1044bc5bbcb9264de042f57 Mon Sep 17 00:00:00 2001
From: Nicolas Palix <npalix(a)diku.dk>
Date: Mon, 7 Jun 2010 14:28:41 +0200
Subject: [PATCH 1/7] Add a target to use the Coccinelle checker

A 'coccicheck' target is added. It can be called with four different
modes. Each one generates a different kind of output, i.e. context,
patch, org, report, according to the corresponding mode to be
activated.

The new target calls the 'coccicheck' front-end in the 'scripts'
directory with the MODE argument. Every SmPL file in the
subdirectories of 'scripts/coccinelle' is then given to the front-end
and applied to the entire source tree.

The four modes behave as follows:

'report' generates a list in the following format:
file:line:column-column: message

'patch' proposes a fix, when possible.

'context' highlights lines of interest and their context in a
diff-like style. Lines of interest are indicated with '-'.

'org' generates a report in the Org mode format of Emacs.

Signed-off-by: Nicolas Palix <npalix(a)diku.dk>
Signed-off-by: Julia Lawall <julia(a)diku.dk>
---

I figure out that the support for "C=1" and "C=2" was missing
in the previous patch. This new version adds it.

Sorry, for the inconvenience.


MAINTAINERS | 10 ++++++
Makefile | 10 ++++--
scripts/Makefile.help | 3 ++
scripts/coccicheck | 80 +++++++++++++++++++++++++++++++++++++++++++++++++
4 files changed, 100 insertions(+), 3 deletions(-)
create mode 100644 scripts/Makefile.help
create mode 100755 scripts/coccicheck

diff --git a/MAINTAINERS b/MAINTAINERS
index 67accd7..5b3c95e 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1569,6 +1569,16 @@ L: platform-driver-x86(a)vger.kernel.org
S: Supported
F: drivers/platform/x86/classmate-laptop.c

+COCCINELLE/Semantic Patches (SmPL)
+M: Julia Lawall <julia(a)diku.dk>
+M: Gilles Muller <Gilles.Muller(a)lip6.fr>
+M: Nicolas Palix <npalix(a)diku.dk>
+L: cocci(a)diku.dk (moderated for non-subscribers)
+W: http://coccinelle.lip6.fr/
+S: Supported
+F: scripts/coccinelle/
+F: scripts/coccicheck
+
CODA FILE SYSTEM
M: Jan Harkes <jaharkes(a)cs.cmu.edu>
M: coda(a)cs.cmu.edu
diff --git a/Makefile b/Makefile
index 654c31a..09d9d08 100644
--- a/Makefile
+++ b/Makefile
@@ -412,7 +412,7 @@ endif
# of make so .config is not included in this case either (for *config).

no-dot-config-targets := clean mrproper distclean \
- cscope TAGS tags help %docs check% \
+ cscope TAGS tags help %docs check% coccicheck \
include/linux/version.h headers_% \
kernelrelease kernelversion

@@ -1279,8 +1279,9 @@ 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 ''
+ @echo ' headerdep - Detect inclusion cycles in headers'
+ @$(MAKE) -f $(srctree)/scripts/Makefile.help checker-help
+ @echo ''
@echo 'Kernel packaging:'
@$(MAKE) $(build)=$(package-dir) help
@echo ''
@@ -1439,6 +1440,9 @@ versioncheck:
-name '*.[hcS]' -type f -print | sort \
| xargs $(PERL) -w $(srctree)/scripts/checkversion.pl

+coccicheck:
+ $(Q)$(CONFIG_SHELL) $(srctree)/scripts/$@
+
namespacecheck:
$(PERL) $(srctree)/scripts/namespace.pl

diff --git a/scripts/Makefile.help b/scripts/Makefile.help
new file mode 100644
index 0000000..d03608f
--- /dev/null
+++ b/scripts/Makefile.help
@@ -0,0 +1,3 @@
+
+checker-help:
+ @echo ' coccicheck - Check with Coccinelle.'
diff --git a/scripts/coccicheck b/scripts/coccicheck
new file mode 100755
index 0000000..0d83b6f
--- /dev/null
+++ b/scripts/coccicheck
@@ -0,0 +1,80 @@
+#!/bin/sh
+
+SPATCH="`which ${SPATCH:=spatch}`"
+
+if [ "$C" = "1" -o "$C" = "2" ]; then
+ ONLINE=1
+
+# This requires Coccinelle >= 0.2.3
+# FLAGS="-ignore_unknown_options -very_quiet"
+# OPTIONS=$*
+
+# Workaround for Coccinelle < 0.2.3
+ FLAGS="-I $srctree/include -very_quiet"
+ shift $(( $# - 1 ))
+ OPTIONS=$1
+else
+ ONLINE=0
+ FLAGS="-very_quiet"
+fi
+
+if [ ! -x "$SPATCH" ]; then
+ echo 'spatch is part of the Coccinelle project and is available at http://coccinelle.lip6.fr/'
+ exit 1
+fi
+
+if [ "$MODE" = "" ] ; then
+ if [ "$ONLINE" = "0" ] ; then
+ echo 'You have not explicitly specify the mode to use. Fallback to "report".'
+ echo 'You can specify the mode with "make coccicheck MODE=<mode>"'
+ echo 'Available modes are: report, patch, context, org'
+ fi
+ MODE="report"
+fi
+
+if [ "$ONLINE" = "0" ] ; then
+ 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 ''
+fi
+
+coccinelle () {
+ COCCI="$1"
+
+ OPT=`grep "Option" $COCCI | cut -d':' -f2`
+
+# The option '-parse_cocci' can be used to syntaxically check the SmPL files.
+#
+# $SPATCH -D $MODE $FLAGS -parse_cocci $COCCI $OPT > /dev/null
+
+ if [ "$ONLINE" = "0" ] ; then
+
+ FILE=`echo $COCCI | sed "s|$DIR/||"`
+
+ 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 $FLAGS -sp_file $COCCI $OPT -dir $srctree || exit 1
+ else
+ $SPATCH -D $MODE $FLAGS -sp_file $COCCI $OPT $OPTIONS || exit 1
+ fi
+
+}
+
+if [ "$COCCI" = "" ] ; then
+ for f in `find $srctree/scripts/coccinelle/ -name '*.cocci' -type f | sort`; do
+ coccinelle $f
+ done
+else
+ coccinelle $COCCI
+fi
--
1.7.0.4

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo(a)vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
From: Kulikov Vasiliy on 30 Jun 2010 15:00
Hi,

On Sun, Jun 06, 2010 at 17:15 +0200, Nicolas Palix wrote:
> + 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

Here I've got output:

/usr/lib/coccinelle/spatch: unknown option `-very_quiet'.
Usage: spatch -sp_file <SP> <infile> [-o <outfile>] [-iso_file <iso>] [options]
Options are:
[...]


I use ubuntu Lucid 10.04 as said in Documentation/coccinelle.txt.

$ LANG=C apt-cache policy coccinelle
[...]
Installed: 0.2.0.deb-1ubuntu2
[...]


If I delete -very_quiet then It runs OK, but output is not ommited:

init_defs_builtins: /usr/share/coccinelle/standard.h
HANDLING: /home/vasya/dev/linux-next/security/min_addr.c
HANDLING: /home/vasya/dev/linux-next/security/keys/proc.c
HANDLING: /home/vasya/dev/linux-next/security/keys/keyring.c
HANDLING: /home/vasya/dev/linux-next/security/keys/gc.c
HANDLING: /home/vasya/dev/linux-next/security/keys/process_keys.c
HANDLING: /home/vasya/dev/linux-next/security/keys/request_key_auth.c
[...]


> +if [ "$COCCI" = "" ] ; then
> + for f in `find $srctree/scripts/coccinelle/ -name '*.cocci' -type f | sort`; do
> + coccinelle $f $srctree;
> + done
> +else
> + coccinelle $COCCI $srctree
> +fi

I think it is more usefull to use $M instead of $srctree to run simple
'make coccicheck'.
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo(a)vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
From: Nicolas Palix on 30 Jun 2010 18:00
On Wednesday 30 June 2010 20:58:54 Kulikov Vasiliy wrote:
> Hi,
>
> On Sun, Jun 06, 2010 at 17:15 +0200, Nicolas Palix wrote:
> > + 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
>
> Here I've got output:
>
> /usr/lib/coccinelle/spatch: unknown option `-very_quiet'.
> Usage: spatch -sp_file <SP> <infile> [-o <outfile>] [-iso_file <iso>] [options]
> Options are:
> [...]
>
>
> I use ubuntu Lucid 10.04 as said in Documentation/coccinelle.txt.
>
> $ LANG=C apt-cache policy coccinelle
> [...]
> Installed: 0.2.0.deb-1ubuntu2
> [...]
>
>
> If I delete -very_quiet then It runs OK, but output is not ommited:

Indeed, I just checked that. This option has been added in 0.2.1
which was not ported from Debian before the feature freeze of Ubuntu Lucid :(

>
> init_defs_builtins: /usr/share/coccinelle/standard.h
> HANDLING: /home/vasya/dev/linux-next/security/min_addr.c
> HANDLING: /home/vasya/dev/linux-next/security/keys/proc.c
> HANDLING: /home/vasya/dev/linux-next/security/keys/keyring.c
> HANDLING: /home/vasya/dev/linux-next/security/keys/gc.c
> HANDLING: /home/vasya/dev/linux-next/security/keys/process_keys.c
> HANDLING: /home/vasya/dev/linux-next/security/keys/request_key_auth.c
> [...]
>
>
> > +if [ "$COCCI" = "" ] ; then
> > + for f in `find $srctree/scripts/coccinelle/ -name '*.cocci' -type f | sort`; do
> > + coccinelle $f $srctree;
> > + done
> > +else
> > + coccinelle $COCCI $srctree
> > +fi
>
> I think it is more usefull to use $M instead of $srctree to run simple
> 'make coccicheck'.

What is the purpose of $M ?

I submitted an incremental patch to add support for $C.


> --
> To unsubscribe from this list: send the line "unsubscribe kernel-janitors" in
> the body of a message to majordomo(a)vger.kernel.org
> More majordomo info at http://vger.kernel.org/majordomo-info.html
>

--
Nicolas Palix
Tel: (+33) 1 44 27 87 25
Tel: (+33) 6 81 07 91 72
Web: http://www.diku.dk/~npalix/
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo(a)vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
From: Kulikov Vasiliy on 2 Jul 2010 10:00
On Wed, Jun 30, 2010 at 23:52 +0200, Nicolas Palix wrote:
> On Wednesday 30 June 2010 20:58:54 Kulikov Vasiliy wrote:
> > > +if [ "$COCCI" = "" ] ; then
> > > + for f in `find $srctree/scripts/coccinelle/ -name '*.cocci' -type f | sort`; do
> > > + coccinelle $f $srctree;
> > > + done
> > > +else
> > > + coccinelle $COCCI $srctree
> > > +fi
> >
> > I think it is more usefull to use $M instead of $srctree to run simple
> > 'make coccicheck'.
>
> What is the purpose of $M ?
>
> I submitted an incremental patch to add support for $C.

From root Makefile:
# Use make M=dir to specify directory of external module to build
# Old syntax make ... SUBDIRS=$PWD is still supported
# Setting the environment variable KBUILD_EXTMOD take precedence

So, I compile all local modules as smth like
make -C ../../.. M=$PWD CONFIG_SMTH=m modules

If coccinelle is started as 'coccinelle $COCCI $M' then it checks only in
directory tree with $M root.
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo(a)vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
 |  Next  |  Last
Pages: 1 2
Prev: schedule inside spin_lock_irqsave
Next: Device tree update for the 460ex DWC SATA<resubmission>