Merge tag 'arm64-fixes' of git://git.kernel.org/pub/scm/linux/kernel/git/arm64/linux
[firefly-linux-kernel-4.4.55.git] / scripts / coccicheck
1 #!/bin/bash
2
3 #
4 # This script requires at least spatch
5 # version 1.0.0-rc11.
6 #
7
8 SPATCH="`which ${SPATCH:=spatch}`"
9
10 trap kill_running SIGTERM SIGINT
11 declare -a SPATCH_PID
12
13 # The verbosity may be set by the environmental parameter V=
14 # as for example with 'make V=1 coccicheck'
15
16 if [ -n "$V" -a "$V" != "0" ]; then
17         VERBOSE="$V"
18 else
19         VERBOSE=0
20 fi
21
22 if [ -z "$J" ]; then
23         NPROC=$(getconf _NPROCESSORS_ONLN)
24 else
25         NPROC="$J"
26 fi
27
28 FLAGS="$SPFLAGS --very-quiet"
29
30 # spatch only allows include directories with the syntax "-I include"
31 # while gcc also allows "-Iinclude" and "-include include"
32 COCCIINCLUDE=${LINUXINCLUDE//-I/-I }
33 COCCIINCLUDE=${COCCIINCLUDE//-include/-I}
34
35 if [ "$C" = "1" -o "$C" = "2" ]; then
36     ONLINE=1
37
38     # Take only the last argument, which is the C file to test
39     shift $(( $# - 1 ))
40     OPTIONS="$COCCIINCLUDE $1"
41 else
42     ONLINE=0
43     if [ "$KBUILD_EXTMOD" = "" ] ; then
44         OPTIONS="--dir $srctree $COCCIINCLUDE"
45     else
46         OPTIONS="--dir $KBUILD_EXTMOD $COCCIINCLUDE"
47     fi
48 fi
49
50 if [ "$KBUILD_EXTMOD" != "" ] ; then
51     OPTIONS="--patch $srctree $OPTIONS"
52 fi
53
54 if [ ! -x "$SPATCH" ]; then
55     echo 'spatch is part of the Coccinelle project and is available at http://coccinelle.lip6.fr/'
56     exit 1
57 fi
58
59 if [ "$MODE" = "" ] ; then
60     if [ "$ONLINE" = "0" ] ; then
61         echo 'You have not explicitly specified the mode to use. Using default "report" mode.'
62         echo 'Available modes are the following: patch, report, context, org'
63         echo 'You can specify the mode with "make coccicheck MODE=<mode>"'
64         echo 'Note however that some modes are not implemented by some semantic patches.'
65     fi
66     MODE="report"
67 fi
68
69 if [ "$MODE" = "chain" ] ; then
70     if [ "$ONLINE" = "0" ] ; then
71         echo 'You have selected the "chain" mode.'
72         echo 'All available modes will be tried (in that order): patch, report, context, org'
73     fi
74 elif [ "$MODE" = "report" -o "$MODE" = "org" ] ; then
75     FLAGS="$FLAGS --no-show-diff"
76 fi
77
78 if [ "$ONLINE" = "0" ] ; then
79     echo ''
80     echo 'Please check for false positives in the output before submitting a patch.'
81     echo 'When using "patch" mode, carefully review the patch before submitting it.'
82     echo ''
83 fi
84
85 run_cmd() {
86         local i
87         if [ $VERBOSE -ne 0 ] ; then
88                 echo "Running ($NPROC in parallel): $@"
89         fi
90         for i in $(seq 0 $(( NPROC - 1)) ); do
91                 eval "$@ --max $NPROC --index $i &"
92                 SPATCH_PID[$i]=$!
93                 if [ $VERBOSE -eq 2 ] ; then
94                         echo "${SPATCH_PID[$i]} running"
95                 fi
96         done
97         wait
98 }
99
100 kill_running() {
101         for i in $(seq $(( NPROC - 1 )) ); do
102                 if [ $VERBOSE -eq 2 ] ; then
103                         echo "Killing ${SPATCH_PID[$i]}"
104                 fi
105                 kill ${SPATCH_PID[$i]} 2>/dev/null
106         done
107 }
108
109 coccinelle () {
110     COCCI="$1"
111
112     OPT=`grep "Option" $COCCI | cut -d':' -f2`
113
114 #   The option '--parse-cocci' can be used to syntactically check the SmPL files.
115 #
116 #    $SPATCH -D $MODE $FLAGS -parse_cocci $COCCI $OPT > /dev/null
117
118     if [ $VERBOSE -ne 0 -a $ONLINE -eq 0 ] ; then
119
120         FILE=`echo $COCCI | sed "s|$srctree/||"`
121
122         echo "Processing `basename $COCCI`"
123         echo "with option(s) \"$OPT\""
124         echo ''
125         echo 'Message example to submit a patch:'
126
127         sed -ne 's|^///||p' $COCCI
128
129         if [ "$MODE" = "patch" ] ; then
130             echo ' The semantic patch that makes this change is available'
131         elif [ "$MODE" = "report" ] ; then
132             echo ' The semantic patch that makes this report is available'
133         elif [ "$MODE" = "context" ] ; then
134             echo ' The semantic patch that spots this code is available'
135         elif [ "$MODE" = "org" ] ; then
136             echo ' The semantic patch that makes this Org report is available'
137         else
138             echo ' The semantic patch that makes this output is available'
139         fi
140         echo " in $FILE."
141         echo ''
142         echo ' More information about semantic patching is available at'
143         echo ' http://coccinelle.lip6.fr/'
144         echo ''
145
146         if [ "`sed -ne 's|^//#||p' $COCCI`" ] ; then
147             echo 'Semantic patch information:'
148             sed -ne 's|^//#||p' $COCCI
149             echo ''
150         fi
151     fi
152
153     if [ "$MODE" = "chain" ] ; then
154         run_cmd $SPATCH -D patch   \
155                 $FLAGS --cocci-file $COCCI $OPT $OPTIONS               || \
156         run_cmd $SPATCH -D report  \
157                 $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff || \
158         run_cmd $SPATCH -D context \
159                 $FLAGS --cocci-file $COCCI $OPT $OPTIONS               || \
160         run_cmd $SPATCH -D org     \
161                 $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff || exit 1
162     elif [ "$MODE" = "rep+ctxt" ] ; then
163         run_cmd $SPATCH -D report  \
164                 $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff && \
165         run_cmd $SPATCH -D context \
166                 $FLAGS --cocci-file $COCCI $OPT $OPTIONS || exit 1
167     else
168         run_cmd $SPATCH -D $MODE   $FLAGS --cocci-file $COCCI $OPT $OPTIONS || exit 1
169     fi
170
171 }
172
173 if [ "$COCCI" = "" ] ; then
174     for f in `find $srctree/scripts/coccinelle/ -name '*.cocci' -type f | sort`; do
175         coccinelle $f
176     done
177 else
178     coccinelle $COCCI
179 fi