Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit be1fa900 authored by Luis R. Rodriguez's avatar Luis R. Rodriguez Committed by Michal Marek
Browse files

coccicheck: add support for DEBUG_FILE 



Enable to capture stderr via a DEBUG_FILE variable passed to
coccicheck. You can now do:

$ rm -f cocci.err
$ export COCCI=scripts/coccinelle/free/kfree.cocci
$ make coccicheck MODE=report DEBUG_FILE=cocci.err
...
$ cat cocci.err

This will be come more useful once we add support to
use more things which would go into stderr, such as
profiling. That will be done separately in another
commit.

Expand Documentation/coccinelle.txt with details.

Signed-off-by: default avatarLuis R. Rodriguez <mcgrof@kernel.org>
Acked-by: default avatarNicolas Palix <nicolas.palix@imag.fr>
Signed-off-by: default avatarMichal Marek <mmarek@suse.com>
parent c930a1b2

Documentation/coccinelle.txt

+20 −0
Original line number Diff line number Diff line
@@ -157,6 +157,26 @@ semantic patch as shown in the previous section. 
The "report" mode is the default. You can select another one with the

MODE variable explained above.



 Debugging Coccinelle SmPL patches

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



Using coccicheck is best as it provides in the spatch command line

include options matching the options used when we compile the kernel.

You can learn what these options are by using V=1, you could then

manually run Coccinelle with debug options added.



Alternatively you can debug running Coccinelle against SmPL patches

by asking for stderr to be redirected to stderr, by default stderr

is redirected to /dev/null, if you'd like to capture stderr you

can specify the DEBUG_FILE="file.txt" option to coccicheck. For

instance:



    rm -f cocci.err

    make coccicheck COCCI=scripts/coccinelle/free/kfree.cocci MODE=report DEBUG_FILE=cocci.err

    cat cocci.err



DEBUG_FILE support is only supported when using coccinelle >= 1.2.



 Additional flags

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

scripts/coccicheck

+9 −1
Original line number Diff line number Diff line
@@ -96,7 +96,15 @@ run_cmd_parmap() { 
	if [ $VERBOSE -ne 0 ] ; then

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

	fi

	$@ 2>/dev/null

	if [ "$DEBUG_FILE" != "/dev/null" -a "$DEBUG_FILE" != "" ]; then

		if [ -f $DEBUG_FILE ]; then

			echo "Debug file $DEBUG_FILE exists, bailing"

			exit

		fi

	else

		DEBUG_FILE="/dev/null"

	fi

	$@ 2>$DEBUG_FILE

	if [[ $? -ne 0 ]]; then

		echo "coccicheck failed"

		exit $?