Commit ae924949 authored by Linus Torvalds's avatar Linus Torvalds
Browse files

Merge branch 'misc' of git://git.kernel.org/pub/scm/linux/kernel/git/mmarek/kbuild 

Pull coccinelle updates from Michal Marek:
 "The misc branch is reserved for Coccinelle this time:

   - 'report' is the default mode
   - MAINTAINERS update for Coccinelle
   - documentation udate
   - use new option format for spatch(1)
   - J=<n> variable to mimic make -j for coccicheck
   - check for missing pci_free_consistent() calls

  There are some patches for rpm-pkg and deb-pkg waiting for the
  3.12-rc1 merge window"

* 'misc' of git://git.kernel.org/pub/scm/linux/kernel/git/mmarek/kbuild:
  Coccinelle: Update information about the minimal version required
  Coccinelle: Update the options used to the new option scheme
  scripts: Coccinelle script for pci_free_consistent()
  Coccinelle: Update the documentation
  Coccinelle: Update section of MAINTAINERS
  coccicheck: span checks across CPUs
  scripts/coccinelle: check for field address argument to kfree
  Coccinelle: Update the Coccinelle section of MAINTAINERS
  Coccinelle: Make 'report' the default mode
parents b202c0d5 ec97946e

Documentation/coccinelle.txt

+39 −24
Original line number Diff line number Diff line
@@ -6,15 +6,17 @@ Copyright 2010 Gilles Muller <Gilles.Muller@lip6.fr> 
 Getting Coccinelle

~~~~~~~~~~~~~~~~~~~~



The semantic patches included in the kernel use the 'virtual rule'

feature which was introduced in Coccinelle version 0.1.11.

The semantic patches included in the kernel use features and options

which are provided by Coccinelle version 1.0.0-rc11 and above.

Using earlier versions will fail as the option names used by

the Coccinelle files and coccicheck have been updated.



Coccinelle (>=0.2.0) is available through the package manager

Coccinelle is available through the package manager

of many distributions, e.g. :



 - Debian (>=squeeze)

 - Fedora (>=13)

 - Ubuntu (>=10.04 Lucid Lynx)

 - Debian

 - Fedora

 - Ubuntu

 - OpenSUSE

 - Arch Linux

 - NetBSD
@@ -36,11 +38,6 @@ as a regular user, and install it with 


        sudo make install



The semantic patches in the kernel will work best with Coccinelle version

0.2.4 or later.  Using earlier versions may incur some parse errors in the

semantic patch code, but any results that are obtained should still be

correct.



 Using Coccinelle on the Linux kernel

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -48,7 +45,7 @@ A Coccinelle-specific target is defined in the top level 
Makefile. This target is named 'coccicheck' and calls the 'coccicheck'

front-end in the 'scripts' directory.



Four modes are defined: patch, report, context, and org. The mode to

Four basic modes are defined: patch, report, context, and org. The mode to

use is specified by setting the MODE variable with 'MODE=<mode>'.



'patch' proposes a fix, when possible.
@@ -62,15 +59,21 @@ diff-like style.Lines of interest are indicated with '-'. 
'org' generates a report in the Org mode format of Emacs.



Note that not all semantic patches implement all modes. For easy use

of Coccinelle, the default mode is "chain" which tries the previous

modes in the order above until one succeeds.

of Coccinelle, the default mode is "report".



Two other modes provide some common combinations of these modes.



'chain' tries the previous modes in the order above until one succeeds.



'rep+ctxt' runs successively the report mode and the context mode.

	   It should be used with the C option (described later)

	   which checks the code on a file basis.



Examples:

	To make a report for every semantic patch, run the following command:



		make coccicheck MODE=report



NB: The 'report' mode is the default one.



	To produce patches, run:



		make coccicheck MODE=patch
@@ -91,6 +94,11 @@ To enable verbose messages set the V= variable, for example: 


   make coccicheck MODE=report V=1



By default, coccicheck tries to run as parallel as possible. To change

the parallelism, set the J= variable. For example, to run across 4 CPUs:



   make coccicheck MODE=report J=4





 Using Coccinelle with a single semantic patch

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -124,26 +132,33 @@ To check only newly edited code, use the value 2 for the C flag, i.e. 


    make C=2 CHECK="scripts/coccicheck"



In these modes, which works on a file basis, there is no information

about semantic patches displayed, and no commit message proposed.



This runs every semantic patch in scripts/coccinelle by default. The

COCCI variable may additionally be used to only apply a single

semantic patch as shown in the previous section.



The "chain" mode is the default. You can select another one with the

The "report" mode is the default. You can select another one with the

MODE variable explained above.



In this mode, there is no information about semantic patches

displayed, and no commit message proposed.



 Additional flags

~~~~~~~~~~~~~~~~~~



Additional flags can be passed to spatch through the SPFLAGS

variable.



    make SPFLAGS=--use_glimpse coccicheck

    make SPFLAGS=--use-glimpse coccicheck

    make SPFLAGS=--use-idutils coccicheck



See spatch --help to learn more about spatch options.



Note that the '--use-glimpse' and '--use-idutils' options

require external tools for indexing the code. None of them is

thus active by default. However, by indexing the code with

one of these tools, and according to the cocci file used,

spatch could proceed the entire code base more quickly.



 Proposing new semantic patches

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

MAINTAINERS

+3 −0
Original line number Diff line number Diff line
@@ -2135,9 +2135,12 @@ COCCINELLE/Semantic Patches (SmPL) 
M:	Julia Lawall <Julia.Lawall@lip6.fr>

M:	Gilles Muller <Gilles.Muller@lip6.fr>

M:	Nicolas Palix <nicolas.palix@imag.fr>

M:	Michal Marek <mmarek@suse.cz>

L:	cocci@systeme.lip6.fr (moderated for non-subscribers)

T:	git git://git.kernel.org/pub/scm/linux/kernel/git/mmarek/kbuild.git misc

W:	http://coccinelle.lip6.fr/

S:	Supported

F:	Documentation/coccinelle.txt

F:	scripts/coccinelle/

F:	scripts/coccicheck

scripts/coccicheck

+57 −19
Original line number Diff line number Diff line 
#!/bin/bash



#

# This script requires at least spatch

# version 1.0.0-rc11.

#



SPATCH="`which ${SPATCH:=spatch}`"



trap kill_running SIGTERM SIGINT

declare -a SPATCH_PID



# The verbosity may be set by the environmental parameter V=

# as for example with 'make V=1 coccicheck'



if [ -n "$V" -a "$V" != "0" ]; then

	VERBOSE=1

	VERBOSE="$V"

else

	VERBOSE=0

fi



FLAGS="$SPFLAGS -very_quiet"

if [ -z "$J" ]; then

	NPROC=$(getconf _NPROCESSORS_ONLN)

else

	NPROC="$J"

fi



FLAGS="$SPFLAGS --very-quiet"



# spatch only allows include directories with the syntax "-I include"

# while gcc also allows "-Iinclude" and "-include include"
@@ -27,14 +41,14 @@ if [ "$C" = "1" -o "$C" = "2" ]; then 
else

    ONLINE=0

    if [ "$KBUILD_EXTMOD" = "" ] ; then

        OPTIONS="-dir $srctree $COCCIINCLUDE"

        OPTIONS="--dir $srctree $COCCIINCLUDE"

    else

        OPTIONS="-dir $KBUILD_EXTMOD $COCCIINCLUDE"

        OPTIONS="--dir $KBUILD_EXTMOD $COCCIINCLUDE"

    fi

fi



if [ "$KBUILD_EXTMOD" != "" ] ; then

    OPTIONS="-patch $srctree $OPTIONS"

    OPTIONS="--patch $srctree $OPTIONS"

fi



if [ ! -x "$SPATCH" ]; then
@@ -44,13 +58,21 @@ fi 


if [ "$MODE" = "" ] ; then

    if [ "$ONLINE" = "0" ] ; then

	echo 'You have not explicitly specified the mode to use. Using default "chain" mode.'

	echo 'All available modes will be tried (in that order): patch, report, context, org'

	echo 'You have not explicitly specified the mode to use. Using default "report" mode.'

	echo 'Available modes are the following: patch, report, context, org'

	echo 'You can specify the mode with "make coccicheck MODE=<mode>"'

	echo 'Note however that some modes are not implemented by some semantic patches.'

    fi

    MODE="report"

fi



if [ "$MODE" = "chain" ] ; then

    if [ "$ONLINE" = "0" ] ; then

	echo 'You have selected the "chain" mode.'

	echo 'All available modes will be tried (in that order): patch, report, context, org'

    fi

    MODE="chain"

elif [ "$MODE" = "report" -o "$MODE" = "org" ] ; then

    FLAGS="$FLAGS -no_show_diff"

    FLAGS="$FLAGS --no-show-diff"

fi



if [ "$ONLINE" = "0" ] ; then
@@ -61,19 +83,35 @@ if [ "$ONLINE" = "0" ] ; then 
fi



run_cmd() {

	local i

	if [ $VERBOSE -ne 0 ] ; then

		echo "Running: $@"

		echo "Running ($NPROC in parallel): $@"

	fi

	for i in $(seq 0 $(( NPROC - 1)) ); do

		eval "$@ --max $NPROC --index $i &"

		SPATCH_PID[$i]=$!

		if [ $VERBOSE -eq 2 ] ; then

			echo "${SPATCH_PID[$i]} running"

		fi

	eval $@

	done

	wait

}



kill_running() {

	for i in $(seq $(( NPROC - 1 )) ); do

		if [ $VERBOSE -eq 2 ] ; then

			echo "Killing ${SPATCH_PID[$i]}"

		fi

		kill ${SPATCH_PID[$i]} 2>/dev/null

	done

}



coccinelle () {

    COCCI="$1"



    OPT=`grep "Option" $COCCI | cut -d':' -f2`



#   The option '-parse_cocci' can be used to syntactically check the SmPL files.

#   The option '--parse-cocci' can be used to syntactically check the SmPL files.

#

#    $SPATCH -D $MODE $FLAGS -parse_cocci $COCCI $OPT > /dev/null
@@ -114,20 +152,20 @@ coccinelle () { 


    if [ "$MODE" = "chain" ] ; then

	run_cmd $SPATCH -D patch   \

		$FLAGS -sp_file $COCCI $OPT $OPTIONS               || \

		$FLAGS --cocci-file $COCCI $OPT $OPTIONS               || \

	run_cmd $SPATCH -D report  \

		$FLAGS -sp_file $COCCI $OPT $OPTIONS -no_show_diff || \

		$FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff || \

	run_cmd $SPATCH -D context \

		$FLAGS -sp_file $COCCI $OPT $OPTIONS               || \

		$FLAGS --cocci-file $COCCI $OPT $OPTIONS               || \

	run_cmd $SPATCH -D org     \

		$FLAGS -sp_file $COCCI $OPT $OPTIONS -no_show_diff || exit 1

		$FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff || exit 1

    elif [ "$MODE" = "rep+ctxt" ] ; then

	run_cmd $SPATCH -D report  \

		$FLAGS -sp_file $COCCI $OPT $OPTIONS -no_show_diff && \

		$FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff && \

	run_cmd $SPATCH -D context \

		$FLAGS -sp_file $COCCI $OPT $OPTIONS || exit 1

		$FLAGS --cocci-file $COCCI $OPT $OPTIONS || exit 1

    else

	run_cmd $SPATCH -D $MODE   $FLAGS -sp_file $COCCI $OPT $OPTIONS || exit 1

	run_cmd $SPATCH -D $MODE   $FLAGS --cocci-file $COCCI $OPT $OPTIONS || exit 1

    fi



}

scripts/coccinelle/api/alloc/drop_kmalloc_cast.cocci

+1 −1
Original line number Diff line number Diff line
@@ -5,7 +5,7 @@ 
// Confidence: High

// Copyright: 2009,2010 Nicolas Palix, DIKU.  GPLv2.

// URL: http://coccinelle.lip6.fr/

// Options: -no_includes -include_headers

// Options: --no-includes --include-headers

//

// Keywords: kmalloc, kzalloc, kcalloc

// Version min: < 2.6.12 kmalloc

scripts/coccinelle/api/alloc/kzalloc-simple.cocci

+1 −1
Original line number Diff line number Diff line
@@ -9,7 +9,7 @@ 
// Copyright: (C) 2009-2010 Julia Lawall, Nicolas Palix, DIKU.  GPLv2.

// Copyright: (C) 2009-2010 Gilles Muller, INRIA/LiP6.  GPLv2.

// URL: http://coccinelle.lip6.fr/rules/kzalloc.html

// Options: -no_includes -include_headers

// Options: --no-includes --include-headers

//

// Keywords: kmalloc, kzalloc

// Version min: < 2.6.12 kmalloc

CRA Git | Maintained and supported by SUSTech CRA and CCSE