]>
Commit | Line | Data |
---|---|---|
0a920b5b AW |
1 | #!/usr/bin/perl -w |
2 | # (c) 2001, Dave Jones. <davej@codemonkey.org.uk> (the file handling bit) | |
00df344f | 3 | # (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit) |
0a920b5b AW |
4 | # (c) 2007, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite, etc) |
5 | # Licensed under the terms of the GNU GPL License version 2 | |
6 | ||
7 | use strict; | |
8 | ||
9 | my $P = $0; | |
00df344f | 10 | $P =~ s@.*/@@g; |
0a920b5b | 11 | |
6cbb2e71 | 12 | my $V = '0.20'; |
0a920b5b AW |
13 | |
14 | use Getopt::Long qw(:config no_auto_abbrev); | |
15 | ||
16 | my $quiet = 0; | |
17 | my $tree = 1; | |
18 | my $chk_signoff = 1; | |
19 | my $chk_patch = 1; | |
653d4876 | 20 | my $tst_type = 0; |
773647a0 | 21 | my $tst_only; |
6c72ffaa | 22 | my $emacs = 0; |
8905a67c | 23 | my $terse = 0; |
6c72ffaa AW |
24 | my $file = 0; |
25 | my $check = 0; | |
8905a67c AW |
26 | my $summary = 1; |
27 | my $mailback = 0; | |
13214adf | 28 | my $summary_file = 0; |
6c72ffaa | 29 | my $root; |
c2fdda0d | 30 | my %debug; |
0a920b5b | 31 | GetOptions( |
6c72ffaa | 32 | 'q|quiet+' => \$quiet, |
0a920b5b AW |
33 | 'tree!' => \$tree, |
34 | 'signoff!' => \$chk_signoff, | |
35 | 'patch!' => \$chk_patch, | |
6c72ffaa | 36 | 'emacs!' => \$emacs, |
8905a67c | 37 | 'terse!' => \$terse, |
6c72ffaa AW |
38 | 'file!' => \$file, |
39 | 'subjective!' => \$check, | |
40 | 'strict!' => \$check, | |
41 | 'root=s' => \$root, | |
8905a67c AW |
42 | 'summary!' => \$summary, |
43 | 'mailback!' => \$mailback, | |
13214adf AW |
44 | 'summary-file!' => \$summary_file, |
45 | ||
c2fdda0d | 46 | 'debug=s' => \%debug, |
13214adf | 47 | 'test-type!' => \$tst_type, |
773647a0 | 48 | 'test-only=s' => \$tst_only, |
0a920b5b AW |
49 | ) or exit; |
50 | ||
51 | my $exit = 0; | |
52 | ||
53 | if ($#ARGV < 0) { | |
00df344f | 54 | print "usage: $P [options] patchfile\n"; |
0a920b5b | 55 | print "version: $V\n"; |
13214adf AW |
56 | print "options: -q => quiet\n"; |
57 | print " --no-tree => run without a kernel tree\n"; | |
58 | print " --terse => one line per report\n"; | |
59 | print " --emacs => emacs compile window format\n"; | |
60 | print " --file => check a source file\n"; | |
61 | print " --strict => enable more subjective tests\n"; | |
62 | print " --root => path to the kernel tree root\n"; | |
63 | print " --no-summary => suppress the per-file summary\n"; | |
64 | print " --summary-file => include the filename in summary\n"; | |
0a920b5b AW |
65 | exit(1); |
66 | } | |
67 | ||
c2fdda0d AW |
68 | my $dbg_values = 0; |
69 | my $dbg_possible = 0; | |
70 | for my $key (keys %debug) { | |
71 | eval "\${dbg_$key} = '$debug{$key}';" | |
72 | } | |
73 | ||
8905a67c AW |
74 | if ($terse) { |
75 | $emacs = 1; | |
76 | $quiet++; | |
77 | } | |
78 | ||
6c72ffaa AW |
79 | if ($tree) { |
80 | if (defined $root) { | |
81 | if (!top_of_kernel_tree($root)) { | |
82 | die "$P: $root: --root does not point at a valid tree\n"; | |
83 | } | |
84 | } else { | |
85 | if (top_of_kernel_tree('.')) { | |
86 | $root = '.'; | |
87 | } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && | |
88 | top_of_kernel_tree($1)) { | |
89 | $root = $1; | |
90 | } | |
91 | } | |
92 | ||
93 | if (!defined $root) { | |
94 | print "Must be run from the top-level dir. of a kernel tree\n"; | |
95 | exit(2); | |
96 | } | |
0a920b5b AW |
97 | } |
98 | ||
6c72ffaa AW |
99 | my $emitted_corrupt = 0; |
100 | ||
101 | our $Ident = qr{[A-Za-z_][A-Za-z\d_]*}; | |
102 | our $Storage = qr{extern|static|asmlinkage}; | |
103 | our $Sparse = qr{ | |
104 | __user| | |
105 | __kernel| | |
106 | __force| | |
107 | __iomem| | |
108 | __must_check| | |
109 | __init_refok| | |
cf655043 | 110 | __kprobes |
6c72ffaa AW |
111 | }x; |
112 | our $Attribute = qr{ | |
113 | const| | |
114 | __read_mostly| | |
115 | __kprobes| | |
116 | __(?:mem|cpu|dev|)(?:initdata|init) | |
117 | }x; | |
c45dcabd | 118 | our $Modifier; |
6c72ffaa | 119 | our $Inline = qr{inline|__always_inline|noinline}; |
6c72ffaa AW |
120 | our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; |
121 | our $Lval = qr{$Ident(?:$Member)*}; | |
122 | ||
123 | our $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*}; | |
124 | our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)}; | |
125 | our $Operators = qr{ | |
126 | <=|>=|==|!=| | |
127 | =>|->|<<|>>|<|>|!|~| | |
c2fdda0d | 128 | &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|% |
6c72ffaa AW |
129 | }x; |
130 | ||
8905a67c AW |
131 | our $NonptrType; |
132 | our $Type; | |
133 | our $Declare; | |
134 | ||
171ae1a4 AW |
135 | our $UTF8 = qr { |
136 | [\x09\x0A\x0D\x20-\x7E] # ASCII | |
137 | | [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte | |
138 | | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs | |
139 | | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte | |
140 | | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates | |
141 | | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 | |
142 | | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 | |
143 | | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 | |
144 | }x; | |
145 | ||
8905a67c AW |
146 | our @typeList = ( |
147 | qr{void}, | |
c45dcabd AW |
148 | qr{(?:unsigned\s+)?char}, |
149 | qr{(?:unsigned\s+)?short}, | |
150 | qr{(?:unsigned\s+)?int}, | |
151 | qr{(?:unsigned\s+)?long}, | |
152 | qr{(?:unsigned\s+)?long\s+int}, | |
153 | qr{(?:unsigned\s+)?long\s+long}, | |
154 | qr{(?:unsigned\s+)?long\s+long\s+int}, | |
8905a67c AW |
155 | qr{unsigned}, |
156 | qr{float}, | |
157 | qr{double}, | |
158 | qr{bool}, | |
8905a67c AW |
159 | qr{(?:__)?(?:u|s|be|le)(?:8|16|32|64)}, |
160 | qr{struct\s+$Ident}, | |
161 | qr{union\s+$Ident}, | |
162 | qr{enum\s+$Ident}, | |
163 | qr{${Ident}_t}, | |
164 | qr{${Ident}_handler}, | |
165 | qr{${Ident}_handler_fn}, | |
166 | ); | |
c45dcabd AW |
167 | our @modifierList = ( |
168 | qr{fastcall}, | |
169 | ); | |
8905a67c AW |
170 | |
171 | sub build_types { | |
c45dcabd | 172 | my $mods = "(?: \n" . join("|\n ", @modifierList) . "\n)"; |
8905a67c | 173 | my $all = "(?: \n" . join("|\n ", @typeList) . "\n)"; |
c8cb2ca3 | 174 | $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; |
8905a67c | 175 | $NonptrType = qr{ |
8905a67c | 176 | (?:const\s+)? |
c45dcabd | 177 | (?:$mods\s+)? |
cf655043 | 178 | (?: |
c45dcabd AW |
179 | (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)| |
180 | (?:${all}\b) | |
cf655043 | 181 | ) |
c8cb2ca3 | 182 | (?:\s+$Modifier|\s+const)* |
8905a67c AW |
183 | }x; |
184 | $Type = qr{ | |
c45dcabd | 185 | $NonptrType |
8905a67c | 186 | (?:\s*\*+\s*const|\s*\*+|(?:\s*\[\s*\])+)? |
c8cb2ca3 | 187 | (?:\s+$Inline|\s+$Modifier)* |
8905a67c AW |
188 | }x; |
189 | $Declare = qr{(?:$Storage\s+)?$Type}; | |
190 | } | |
191 | build_types(); | |
6c72ffaa AW |
192 | |
193 | $chk_signoff = 0 if ($file); | |
194 | ||
4a0df2ef AW |
195 | my @dep_includes = (); |
196 | my @dep_functions = (); | |
6c72ffaa AW |
197 | my $removal = "Documentation/feature-removal-schedule.txt"; |
198 | if ($tree && -f "$root/$removal") { | |
199 | open(REMOVE, "<$root/$removal") || | |
200 | die "$P: $removal: open failed - $!\n"; | |
0a920b5b | 201 | while (<REMOVE>) { |
f0a594c1 AW |
202 | if (/^Check:\s+(.*\S)/) { |
203 | for my $entry (split(/[, ]+/, $1)) { | |
204 | if ($entry =~ m@include/(.*)@) { | |
4a0df2ef | 205 | push(@dep_includes, $1); |
4a0df2ef | 206 | |
f0a594c1 AW |
207 | } elsif ($entry !~ m@/@) { |
208 | push(@dep_functions, $entry); | |
209 | } | |
4a0df2ef | 210 | } |
0a920b5b AW |
211 | } |
212 | } | |
213 | } | |
214 | ||
00df344f | 215 | my @rawlines = (); |
c2fdda0d AW |
216 | my @lines = (); |
217 | my $vname; | |
6c72ffaa AW |
218 | for my $filename (@ARGV) { |
219 | if ($file) { | |
220 | open(FILE, "diff -u /dev/null $filename|") || | |
221 | die "$P: $filename: diff failed - $!\n"; | |
222 | } else { | |
223 | open(FILE, "<$filename") || | |
224 | die "$P: $filename: open failed - $!\n"; | |
0a920b5b | 225 | } |
c2fdda0d AW |
226 | if ($filename eq '-') { |
227 | $vname = 'Your patch'; | |
228 | } else { | |
229 | $vname = $filename; | |
230 | } | |
6c72ffaa AW |
231 | while (<FILE>) { |
232 | chomp; | |
233 | push(@rawlines, $_); | |
234 | } | |
235 | close(FILE); | |
c2fdda0d | 236 | if (!process($filename)) { |
6c72ffaa AW |
237 | $exit = 1; |
238 | } | |
239 | @rawlines = (); | |
13214adf | 240 | @lines = (); |
0a920b5b AW |
241 | } |
242 | ||
243 | exit($exit); | |
244 | ||
245 | sub top_of_kernel_tree { | |
6c72ffaa AW |
246 | my ($root) = @_; |
247 | ||
248 | my @tree_check = ( | |
249 | "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", | |
250 | "README", "Documentation", "arch", "include", "drivers", | |
251 | "fs", "init", "ipc", "kernel", "lib", "scripts", | |
252 | ); | |
253 | ||
254 | foreach my $check (@tree_check) { | |
255 | if (! -e $root . '/' . $check) { | |
256 | return 0; | |
257 | } | |
0a920b5b | 258 | } |
6c72ffaa | 259 | return 1; |
0a920b5b AW |
260 | } |
261 | ||
262 | sub expand_tabs { | |
263 | my ($str) = @_; | |
264 | ||
265 | my $res = ''; | |
266 | my $n = 0; | |
267 | for my $c (split(//, $str)) { | |
268 | if ($c eq "\t") { | |
269 | $res .= ' '; | |
270 | $n++; | |
271 | for (; ($n % 8) != 0; $n++) { | |
272 | $res .= ' '; | |
273 | } | |
274 | next; | |
275 | } | |
276 | $res .= $c; | |
277 | $n++; | |
278 | } | |
279 | ||
280 | return $res; | |
281 | } | |
6c72ffaa | 282 | sub copy_spacing { |
773647a0 | 283 | (my $res = shift) =~ tr/\t/ /c; |
6c72ffaa AW |
284 | return $res; |
285 | } | |
0a920b5b | 286 | |
4a0df2ef AW |
287 | sub line_stats { |
288 | my ($line) = @_; | |
289 | ||
290 | # Drop the diff line leader and expand tabs | |
291 | $line =~ s/^.//; | |
292 | $line = expand_tabs($line); | |
293 | ||
294 | # Pick the indent from the front of the line. | |
295 | my ($white) = ($line =~ /^(\s*)/); | |
296 | ||
297 | return (length($line), length($white)); | |
298 | } | |
299 | ||
773647a0 AW |
300 | my $sanitise_quote = ''; |
301 | ||
302 | sub sanitise_line_reset { | |
303 | my ($in_comment) = @_; | |
304 | ||
305 | if ($in_comment) { | |
306 | $sanitise_quote = '*/'; | |
307 | } else { | |
308 | $sanitise_quote = ''; | |
309 | } | |
310 | } | |
00df344f AW |
311 | sub sanitise_line { |
312 | my ($line) = @_; | |
313 | ||
314 | my $res = ''; | |
315 | my $l = ''; | |
316 | ||
c2fdda0d | 317 | my $qlen = 0; |
773647a0 AW |
318 | my $off = 0; |
319 | my $c; | |
00df344f | 320 | |
773647a0 AW |
321 | # Always copy over the diff marker. |
322 | $res = substr($line, 0, 1); | |
323 | ||
324 | for ($off = 1; $off < length($line); $off++) { | |
325 | $c = substr($line, $off, 1); | |
326 | ||
327 | # Comments we are wacking completly including the begin | |
328 | # and end, all to $;. | |
329 | if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { | |
330 | $sanitise_quote = '*/'; | |
331 | ||
332 | substr($res, $off, 2, "$;$;"); | |
333 | $off++; | |
334 | next; | |
00df344f | 335 | } |
c45dcabd | 336 | if (substr($line, $off, 2) eq '*/') { |
773647a0 AW |
337 | $sanitise_quote = ''; |
338 | substr($res, $off, 2, "$;$;"); | |
339 | $off++; | |
340 | next; | |
c2fdda0d | 341 | } |
773647a0 AW |
342 | |
343 | # A \ in a string means ignore the next character. | |
344 | if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && | |
345 | $c eq "\\") { | |
346 | substr($res, $off, 2, 'XX'); | |
347 | $off++; | |
348 | next; | |
00df344f | 349 | } |
773647a0 AW |
350 | # Regular quotes. |
351 | if ($c eq "'" || $c eq '"') { | |
352 | if ($sanitise_quote eq '') { | |
353 | $sanitise_quote = $c; | |
00df344f | 354 | |
773647a0 AW |
355 | substr($res, $off, 1, $c); |
356 | next; | |
357 | } elsif ($sanitise_quote eq $c) { | |
358 | $sanitise_quote = ''; | |
359 | } | |
360 | } | |
00df344f | 361 | |
773647a0 AW |
362 | #print "SQ:$sanitise_quote\n"; |
363 | if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { | |
364 | substr($res, $off, 1, $;); | |
365 | } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { | |
366 | substr($res, $off, 1, 'X'); | |
367 | } else { | |
368 | substr($res, $off, 1, $c); | |
369 | } | |
c2fdda0d AW |
370 | } |
371 | ||
372 | # The pathname on a #include may be surrounded by '<' and '>'. | |
c45dcabd | 373 | if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { |
c2fdda0d AW |
374 | my $clean = 'X' x length($1); |
375 | $res =~ s@\<.*\>@<$clean>@; | |
376 | ||
377 | # The whole of a #error is a string. | |
c45dcabd | 378 | } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { |
c2fdda0d | 379 | my $clean = 'X' x length($1); |
c45dcabd | 380 | $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; |
c2fdda0d AW |
381 | } |
382 | ||
00df344f AW |
383 | return $res; |
384 | } | |
385 | ||
8905a67c AW |
386 | sub ctx_statement_block { |
387 | my ($linenr, $remain, $off) = @_; | |
388 | my $line = $linenr - 1; | |
389 | my $blk = ''; | |
390 | my $soff = $off; | |
391 | my $coff = $off - 1; | |
773647a0 | 392 | my $coff_set = 0; |
8905a67c | 393 | |
13214adf AW |
394 | my $loff = 0; |
395 | ||
8905a67c AW |
396 | my $type = ''; |
397 | my $level = 0; | |
cf655043 | 398 | my $p; |
8905a67c AW |
399 | my $c; |
400 | my $len = 0; | |
13214adf AW |
401 | |
402 | my $remainder; | |
8905a67c | 403 | while (1) { |
773647a0 | 404 | #warn "CSB: blk<$blk> remain<$remain>\n"; |
8905a67c AW |
405 | # If we are about to drop off the end, pull in more |
406 | # context. | |
407 | if ($off >= $len) { | |
408 | for (; $remain > 0; $line++) { | |
c2fdda0d | 409 | next if ($lines[$line] =~ /^-/); |
8905a67c | 410 | $remain--; |
13214adf | 411 | $loff = $len; |
c2fdda0d | 412 | $blk .= $lines[$line] . "\n"; |
8905a67c AW |
413 | $len = length($blk); |
414 | $line++; | |
415 | last; | |
416 | } | |
417 | # Bail if there is no further context. | |
418 | #warn "CSB: blk<$blk> off<$off> len<$len>\n"; | |
13214adf | 419 | if ($off >= $len) { |
8905a67c AW |
420 | last; |
421 | } | |
422 | } | |
cf655043 | 423 | $p = $c; |
8905a67c | 424 | $c = substr($blk, $off, 1); |
13214adf | 425 | $remainder = substr($blk, $off); |
8905a67c | 426 | |
773647a0 | 427 | #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; |
8905a67c AW |
428 | # Statement ends at the ';' or a close '}' at the |
429 | # outermost level. | |
430 | if ($level == 0 && $c eq ';') { | |
431 | last; | |
432 | } | |
433 | ||
13214adf | 434 | # An else is really a conditional as long as its not else if |
773647a0 AW |
435 | if ($level == 0 && $coff_set == 0 && |
436 | (!defined($p) || $p =~ /(?:\s|\}|\+)/) && | |
437 | $remainder =~ /^(else)(?:\s|{)/ && | |
438 | $remainder !~ /^else\s+if\b/) { | |
439 | $coff = $off + length($1) - 1; | |
440 | $coff_set = 1; | |
441 | #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; | |
442 | #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; | |
13214adf AW |
443 | } |
444 | ||
8905a67c AW |
445 | if (($type eq '' || $type eq '(') && $c eq '(') { |
446 | $level++; | |
447 | $type = '('; | |
448 | } | |
449 | if ($type eq '(' && $c eq ')') { | |
450 | $level--; | |
451 | $type = ($level != 0)? '(' : ''; | |
452 | ||
453 | if ($level == 0 && $coff < $soff) { | |
454 | $coff = $off; | |
773647a0 AW |
455 | $coff_set = 1; |
456 | #warn "CSB: mark coff<$coff>\n"; | |
8905a67c AW |
457 | } |
458 | } | |
459 | if (($type eq '' || $type eq '{') && $c eq '{') { | |
460 | $level++; | |
461 | $type = '{'; | |
462 | } | |
463 | if ($type eq '{' && $c eq '}') { | |
464 | $level--; | |
465 | $type = ($level != 0)? '{' : ''; | |
466 | ||
467 | if ($level == 0) { | |
468 | last; | |
469 | } | |
470 | } | |
471 | $off++; | |
472 | } | |
a3bb97a7 | 473 | # We are truly at the end, so shuffle to the next line. |
13214adf | 474 | if ($off == $len) { |
a3bb97a7 | 475 | $loff = $len + 1; |
13214adf AW |
476 | $line++; |
477 | $remain--; | |
478 | } | |
8905a67c AW |
479 | |
480 | my $statement = substr($blk, $soff, $off - $soff + 1); | |
481 | my $condition = substr($blk, $soff, $coff - $soff + 1); | |
482 | ||
483 | #warn "STATEMENT<$statement>\n"; | |
484 | #warn "CONDITION<$condition>\n"; | |
485 | ||
773647a0 | 486 | #print "coff<$coff> soff<$off> loff<$loff>\n"; |
13214adf AW |
487 | |
488 | return ($statement, $condition, | |
489 | $line, $remain + 1, $off - $loff + 1, $level); | |
490 | } | |
491 | ||
cf655043 AW |
492 | sub statement_lines { |
493 | my ($stmt) = @_; | |
494 | ||
495 | # Strip the diff line prefixes and rip blank lines at start and end. | |
496 | $stmt =~ s/(^|\n)./$1/g; | |
497 | $stmt =~ s/^\s*//; | |
498 | $stmt =~ s/\s*$//; | |
499 | ||
500 | my @stmt_lines = ($stmt =~ /\n/g); | |
501 | ||
502 | return $#stmt_lines + 2; | |
503 | } | |
504 | ||
505 | sub statement_rawlines { | |
506 | my ($stmt) = @_; | |
507 | ||
508 | my @stmt_lines = ($stmt =~ /\n/g); | |
509 | ||
510 | return $#stmt_lines + 2; | |
511 | } | |
512 | ||
513 | sub statement_block_size { | |
514 | my ($stmt) = @_; | |
515 | ||
516 | $stmt =~ s/(^|\n)./$1/g; | |
517 | $stmt =~ s/^\s*{//; | |
518 | $stmt =~ s/}\s*$//; | |
519 | $stmt =~ s/^\s*//; | |
520 | $stmt =~ s/\s*$//; | |
521 | ||
522 | my @stmt_lines = ($stmt =~ /\n/g); | |
523 | my @stmt_statements = ($stmt =~ /;/g); | |
524 | ||
525 | my $stmt_lines = $#stmt_lines + 2; | |
526 | my $stmt_statements = $#stmt_statements + 1; | |
527 | ||
528 | if ($stmt_lines > $stmt_statements) { | |
529 | return $stmt_lines; | |
530 | } else { | |
531 | return $stmt_statements; | |
532 | } | |
533 | } | |
534 | ||
13214adf AW |
535 | sub ctx_statement_full { |
536 | my ($linenr, $remain, $off) = @_; | |
537 | my ($statement, $condition, $level); | |
538 | ||
539 | my (@chunks); | |
540 | ||
cf655043 | 541 | # Grab the first conditional/block pair. |
13214adf AW |
542 | ($statement, $condition, $linenr, $remain, $off, $level) = |
543 | ctx_statement_block($linenr, $remain, $off); | |
773647a0 | 544 | #print "F: c<$condition> s<$statement> remain<$remain>\n"; |
cf655043 AW |
545 | push(@chunks, [ $condition, $statement ]); |
546 | if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { | |
547 | return ($level, $linenr, @chunks); | |
548 | } | |
549 | ||
550 | # Pull in the following conditional/block pairs and see if they | |
551 | # could continue the statement. | |
13214adf | 552 | for (;;) { |
13214adf AW |
553 | ($statement, $condition, $linenr, $remain, $off, $level) = |
554 | ctx_statement_block($linenr, $remain, $off); | |
cf655043 | 555 | #print "C: c<$condition> s<$statement> remain<$remain>\n"; |
773647a0 | 556 | last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); |
cf655043 AW |
557 | #print "C: push\n"; |
558 | push(@chunks, [ $condition, $statement ]); | |
13214adf AW |
559 | } |
560 | ||
561 | return ($level, $linenr, @chunks); | |
8905a67c AW |
562 | } |
563 | ||
4a0df2ef | 564 | sub ctx_block_get { |
f0a594c1 | 565 | my ($linenr, $remain, $outer, $open, $close, $off) = @_; |
4a0df2ef AW |
566 | my $line; |
567 | my $start = $linenr - 1; | |
4a0df2ef AW |
568 | my $blk = ''; |
569 | my @o; | |
570 | my @c; | |
571 | my @res = (); | |
572 | ||
f0a594c1 | 573 | my $level = 0; |
00df344f AW |
574 | for ($line = $start; $remain > 0; $line++) { |
575 | next if ($rawlines[$line] =~ /^-/); | |
576 | $remain--; | |
577 | ||
578 | $blk .= $rawlines[$line]; | |
f0a594c1 AW |
579 | foreach my $c (split(//, $rawlines[$line])) { |
580 | ##print "C<$c>L<$level><$open$close>O<$off>\n"; | |
581 | if ($off > 0) { | |
582 | $off--; | |
583 | next; | |
584 | } | |
4a0df2ef | 585 | |
f0a594c1 AW |
586 | if ($c eq $close && $level > 0) { |
587 | $level--; | |
588 | last if ($level == 0); | |
589 | } elsif ($c eq $open) { | |
590 | $level++; | |
591 | } | |
592 | } | |
4a0df2ef | 593 | |
f0a594c1 | 594 | if (!$outer || $level <= 1) { |
00df344f | 595 | push(@res, $rawlines[$line]); |
4a0df2ef AW |
596 | } |
597 | ||
f0a594c1 | 598 | last if ($level == 0); |
4a0df2ef AW |
599 | } |
600 | ||
f0a594c1 | 601 | return ($level, @res); |
4a0df2ef AW |
602 | } |
603 | sub ctx_block_outer { | |
604 | my ($linenr, $remain) = @_; | |
605 | ||
f0a594c1 AW |
606 | my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); |
607 | return @r; | |
4a0df2ef AW |
608 | } |
609 | sub ctx_block { | |
610 | my ($linenr, $remain) = @_; | |
611 | ||
f0a594c1 AW |
612 | my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); |
613 | return @r; | |
653d4876 AW |
614 | } |
615 | sub ctx_statement { | |
f0a594c1 AW |
616 | my ($linenr, $remain, $off) = @_; |
617 | ||
618 | my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); | |
619 | return @r; | |
620 | } | |
621 | sub ctx_block_level { | |
653d4876 AW |
622 | my ($linenr, $remain) = @_; |
623 | ||
f0a594c1 | 624 | return ctx_block_get($linenr, $remain, 0, '{', '}', 0); |
4a0df2ef | 625 | } |
9c0ca6f9 AW |
626 | sub ctx_statement_level { |
627 | my ($linenr, $remain, $off) = @_; | |
628 | ||
629 | return ctx_block_get($linenr, $remain, 0, '(', ')', $off); | |
630 | } | |
4a0df2ef AW |
631 | |
632 | sub ctx_locate_comment { | |
633 | my ($first_line, $end_line) = @_; | |
634 | ||
635 | # Catch a comment on the end of the line itself. | |
beae6332 | 636 | my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); |
4a0df2ef AW |
637 | return $current_comment if (defined $current_comment); |
638 | ||
639 | # Look through the context and try and figure out if there is a | |
640 | # comment. | |
641 | my $in_comment = 0; | |
642 | $current_comment = ''; | |
643 | for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { | |
00df344f AW |
644 | my $line = $rawlines[$linenr - 1]; |
645 | #warn " $line\n"; | |
4a0df2ef AW |
646 | if ($linenr == $first_line and $line =~ m@^.\s*\*@) { |
647 | $in_comment = 1; | |
648 | } | |
649 | if ($line =~ m@/\*@) { | |
650 | $in_comment = 1; | |
651 | } | |
652 | if (!$in_comment && $current_comment ne '') { | |
653 | $current_comment = ''; | |
654 | } | |
655 | $current_comment .= $line . "\n" if ($in_comment); | |
656 | if ($line =~ m@\*/@) { | |
657 | $in_comment = 0; | |
658 | } | |
659 | } | |
660 | ||
661 | chomp($current_comment); | |
662 | return($current_comment); | |
663 | } | |
664 | sub ctx_has_comment { | |
665 | my ($first_line, $end_line) = @_; | |
666 | my $cmt = ctx_locate_comment($first_line, $end_line); | |
667 | ||
00df344f | 668 | ##print "LINE: $rawlines[$end_line - 1 ]\n"; |
4a0df2ef AW |
669 | ##print "CMMT: $cmt\n"; |
670 | ||
671 | return ($cmt ne ''); | |
672 | } | |
673 | ||
6c72ffaa AW |
674 | sub cat_vet { |
675 | my ($vet) = @_; | |
676 | my ($res, $coded); | |
9c0ca6f9 | 677 | |
6c72ffaa AW |
678 | $res = ''; |
679 | while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { | |
680 | $res .= $1; | |
681 | if ($2 ne '') { | |
682 | $coded = sprintf("^%c", unpack('C', $2) + 64); | |
683 | $res .= $coded; | |
9c0ca6f9 AW |
684 | } |
685 | } | |
6c72ffaa | 686 | $res =~ s/$/\$/; |
9c0ca6f9 | 687 | |
6c72ffaa | 688 | return $res; |
9c0ca6f9 AW |
689 | } |
690 | ||
c2fdda0d | 691 | my $av_preprocessor = 0; |
cf655043 | 692 | my $av_pending; |
c2fdda0d AW |
693 | my @av_paren_type; |
694 | ||
695 | sub annotate_reset { | |
696 | $av_preprocessor = 0; | |
cf655043 AW |
697 | $av_pending = '_'; |
698 | @av_paren_type = ('E'); | |
c2fdda0d AW |
699 | } |
700 | ||
6c72ffaa AW |
701 | sub annotate_values { |
702 | my ($stream, $type) = @_; | |
0a920b5b | 703 | |
6c72ffaa AW |
704 | my $res; |
705 | my $cur = $stream; | |
706 | ||
c2fdda0d | 707 | print "$stream\n" if ($dbg_values > 1); |
6c72ffaa | 708 | |
6c72ffaa | 709 | while (length($cur)) { |
773647a0 | 710 | @av_paren_type = ('E') if ($#av_paren_type < 0); |
cf655043 | 711 | print " <" . join('', @av_paren_type) . |
171ae1a4 | 712 | "> <$type> <$av_pending>" if ($dbg_values > 1); |
6c72ffaa | 713 | if ($cur =~ /^(\s+)/o) { |
c2fdda0d AW |
714 | print "WS($1)\n" if ($dbg_values > 1); |
715 | if ($1 =~ /\n/ && $av_preprocessor) { | |
cf655043 | 716 | $type = pop(@av_paren_type); |
c2fdda0d | 717 | $av_preprocessor = 0; |
6c72ffaa AW |
718 | } |
719 | ||
c8cb2ca3 | 720 | } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\))/) { |
c2fdda0d | 721 | print "DECLARE($1)\n" if ($dbg_values > 1); |
6c72ffaa AW |
722 | $type = 'T'; |
723 | ||
c45dcabd | 724 | } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { |
171ae1a4 | 725 | print "DEFINE($1,$2)\n" if ($dbg_values > 1); |
c2fdda0d | 726 | $av_preprocessor = 1; |
171ae1a4 AW |
727 | push(@av_paren_type, $type); |
728 | if ($2 ne '') { | |
729 | $av_pending = 'N'; | |
730 | } | |
731 | $type = 'E'; | |
732 | ||
c45dcabd | 733 | } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { |
171ae1a4 AW |
734 | print "UNDEF($1)\n" if ($dbg_values > 1); |
735 | $av_preprocessor = 1; | |
736 | push(@av_paren_type, $type); | |
6c72ffaa | 737 | |
c45dcabd | 738 | } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { |
cf655043 | 739 | print "PRE_START($1)\n" if ($dbg_values > 1); |
c2fdda0d | 740 | $av_preprocessor = 1; |
cf655043 AW |
741 | |
742 | push(@av_paren_type, $type); | |
743 | push(@av_paren_type, $type); | |
171ae1a4 | 744 | $type = 'E'; |
cf655043 | 745 | |
c45dcabd | 746 | } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { |
cf655043 AW |
747 | print "PRE_RESTART($1)\n" if ($dbg_values > 1); |
748 | $av_preprocessor = 1; | |
749 | ||
750 | push(@av_paren_type, $av_paren_type[$#av_paren_type]); | |
751 | ||
171ae1a4 | 752 | $type = 'E'; |
cf655043 | 753 | |
c45dcabd | 754 | } elsif ($cur =~ /^(\#\s*(?:endif))/o) { |
cf655043 AW |
755 | print "PRE_END($1)\n" if ($dbg_values > 1); |
756 | ||
757 | $av_preprocessor = 1; | |
758 | ||
759 | # Assume all arms of the conditional end as this | |
760 | # one does, and continue as if the #endif was not here. | |
761 | pop(@av_paren_type); | |
762 | push(@av_paren_type, $type); | |
171ae1a4 | 763 | $type = 'E'; |
6c72ffaa AW |
764 | |
765 | } elsif ($cur =~ /^(\\\n)/o) { | |
c2fdda0d | 766 | print "PRECONT($1)\n" if ($dbg_values > 1); |
6c72ffaa | 767 | |
171ae1a4 AW |
768 | } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { |
769 | print "ATTR($1)\n" if ($dbg_values > 1); | |
770 | $av_pending = $type; | |
771 | $type = 'N'; | |
772 | ||
6c72ffaa | 773 | } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { |
c2fdda0d | 774 | print "SIZEOF($1)\n" if ($dbg_values > 1); |
6c72ffaa | 775 | if (defined $2) { |
cf655043 | 776 | $av_pending = 'V'; |
6c72ffaa AW |
777 | } |
778 | $type = 'N'; | |
779 | ||
13214adf | 780 | } elsif ($cur =~ /^(if|while|typeof|__typeof__|for)\b/o) { |
c2fdda0d | 781 | print "COND($1)\n" if ($dbg_values > 1); |
cf655043 | 782 | $av_pending = 'N'; |
6c72ffaa AW |
783 | $type = 'N'; |
784 | ||
6ef9b297 | 785 | } elsif ($cur =~/^(return|case|else|goto)/o) { |
c2fdda0d | 786 | print "KEYWORD($1)\n" if ($dbg_values > 1); |
6c72ffaa AW |
787 | $type = 'N'; |
788 | ||
789 | } elsif ($cur =~ /^(\()/o) { | |
c2fdda0d | 790 | print "PAREN('$1')\n" if ($dbg_values > 1); |
cf655043 AW |
791 | push(@av_paren_type, $av_pending); |
792 | $av_pending = '_'; | |
6c72ffaa AW |
793 | $type = 'N'; |
794 | ||
795 | } elsif ($cur =~ /^(\))/o) { | |
cf655043 AW |
796 | my $new_type = pop(@av_paren_type); |
797 | if ($new_type ne '_') { | |
798 | $type = $new_type; | |
c2fdda0d AW |
799 | print "PAREN('$1') -> $type\n" |
800 | if ($dbg_values > 1); | |
6c72ffaa | 801 | } else { |
c2fdda0d | 802 | print "PAREN('$1')\n" if ($dbg_values > 1); |
6c72ffaa AW |
803 | } |
804 | ||
c8cb2ca3 | 805 | } elsif ($cur =~ /^($Ident)\s*\(/o) { |
c2fdda0d | 806 | print "FUNC($1)\n" if ($dbg_values > 1); |
c8cb2ca3 | 807 | $type = 'V'; |
cf655043 | 808 | $av_pending = 'V'; |
6c72ffaa AW |
809 | |
810 | } elsif ($cur =~ /^($Ident|$Constant)/o) { | |
c2fdda0d | 811 | print "IDENT($1)\n" if ($dbg_values > 1); |
6c72ffaa AW |
812 | $type = 'V'; |
813 | ||
814 | } elsif ($cur =~ /^($Assignment)/o) { | |
c2fdda0d | 815 | print "ASSIGN($1)\n" if ($dbg_values > 1); |
6c72ffaa AW |
816 | $type = 'N'; |
817 | ||
cf655043 | 818 | } elsif ($cur =~/^(;|{|})/) { |
c2fdda0d | 819 | print "END($1)\n" if ($dbg_values > 1); |
13214adf AW |
820 | $type = 'E'; |
821 | ||
cf655043 | 822 | } elsif ($cur =~ /^(;|\?|:|\[)/o) { |
13214adf | 823 | print "CLOSE($1)\n" if ($dbg_values > 1); |
6c72ffaa AW |
824 | $type = 'N'; |
825 | ||
826 | } elsif ($cur =~ /^($Operators)/o) { | |
c2fdda0d | 827 | print "OP($1)\n" if ($dbg_values > 1); |
6c72ffaa AW |
828 | if ($1 ne '++' && $1 ne '--') { |
829 | $type = 'N'; | |
830 | } | |
831 | ||
832 | } elsif ($cur =~ /(^.)/o) { | |
c2fdda0d | 833 | print "C($1)\n" if ($dbg_values > 1); |
6c72ffaa AW |
834 | } |
835 | if (defined $1) { | |
836 | $cur = substr($cur, length($1)); | |
837 | $res .= $type x length($1); | |
838 | } | |
9c0ca6f9 | 839 | } |
0a920b5b | 840 | |
9c0ca6f9 | 841 | return $res; |
0a920b5b AW |
842 | } |
843 | ||
8905a67c | 844 | sub possible { |
13214adf | 845 | my ($possible, $line) = @_; |
8905a67c | 846 | |
c45dcabd | 847 | print "CHECK<$possible> ($line)\n" if ($dbg_possible > 1); |
8905a67c AW |
848 | if ($possible !~ /^(?:$Storage|$Type|DEFINE_\S+)$/ && |
849 | $possible ne 'goto' && $possible ne 'return' && | |
8905a67c | 850 | $possible ne 'case' && $possible ne 'else' && |
d3ddcf47 | 851 | $possible ne 'asm' && $possible ne '__asm__' && |
c45dcabd AW |
852 | $possible !~ /^(typedef|struct|enum)\b/) { |
853 | # Check for modifiers. | |
854 | $possible =~ s/\s*$Storage\s*//g; | |
855 | $possible =~ s/\s*$Sparse\s*//g; | |
856 | if ($possible =~ /^\s*$/) { | |
857 | ||
858 | } elsif ($possible =~ /\s/) { | |
859 | $possible =~ s/\s*$Type\s*//g; | |
860 | warn "MODIFIER: $possible ($line)\n" if ($dbg_possible); | |
861 | push(@modifierList, $possible); | |
862 | ||
863 | } else { | |
864 | warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); | |
865 | push(@typeList, $possible); | |
866 | } | |
8905a67c AW |
867 | build_types(); |
868 | } | |
869 | } | |
870 | ||
6c72ffaa AW |
871 | my $prefix = ''; |
872 | ||
f0a594c1 | 873 | sub report { |
773647a0 AW |
874 | if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) { |
875 | return 0; | |
876 | } | |
8905a67c AW |
877 | my $line = $prefix . $_[0]; |
878 | ||
879 | $line = (split('\n', $line))[0] . "\n" if ($terse); | |
880 | ||
13214adf | 881 | push(our @report, $line); |
773647a0 AW |
882 | |
883 | return 1; | |
f0a594c1 AW |
884 | } |
885 | sub report_dump { | |
13214adf | 886 | our @report; |
f0a594c1 | 887 | } |
de7d4f0e | 888 | sub ERROR { |
773647a0 AW |
889 | if (report("ERROR: $_[0]\n")) { |
890 | our $clean = 0; | |
891 | our $cnt_error++; | |
892 | } | |
de7d4f0e AW |
893 | } |
894 | sub WARN { | |
773647a0 AW |
895 | if (report("WARNING: $_[0]\n")) { |
896 | our $clean = 0; | |
897 | our $cnt_warn++; | |
898 | } | |
de7d4f0e AW |
899 | } |
900 | sub CHK { | |
773647a0 | 901 | if ($check && report("CHECK: $_[0]\n")) { |
6c72ffaa AW |
902 | our $clean = 0; |
903 | our $cnt_chk++; | |
904 | } | |
de7d4f0e AW |
905 | } |
906 | ||
0a920b5b AW |
907 | sub process { |
908 | my $filename = shift; | |
0a920b5b AW |
909 | |
910 | my $linenr=0; | |
911 | my $prevline=""; | |
c2fdda0d | 912 | my $prevrawline=""; |
0a920b5b | 913 | my $stashline=""; |
c2fdda0d | 914 | my $stashrawline=""; |
0a920b5b | 915 | |
4a0df2ef | 916 | my $length; |
0a920b5b AW |
917 | my $indent; |
918 | my $previndent=0; | |
919 | my $stashindent=0; | |
920 | ||
de7d4f0e | 921 | our $clean = 1; |
0a920b5b AW |
922 | my $signoff = 0; |
923 | my $is_patch = 0; | |
924 | ||
13214adf | 925 | our @report = (); |
6c72ffaa AW |
926 | our $cnt_lines = 0; |
927 | our $cnt_error = 0; | |
928 | our $cnt_warn = 0; | |
929 | our $cnt_chk = 0; | |
930 | ||
0a920b5b AW |
931 | # Trace the real file/line as we go. |
932 | my $realfile = ''; | |
933 | my $realline = 0; | |
934 | my $realcnt = 0; | |
935 | my $here = ''; | |
936 | my $in_comment = 0; | |
c2fdda0d | 937 | my $comment_edge = 0; |
0a920b5b AW |
938 | my $first_line = 0; |
939 | ||
13214adf AW |
940 | my $prev_values = 'E'; |
941 | ||
942 | # suppression flags | |
773647a0 | 943 | my %suppress_ifbraces; |
653d4876 | 944 | |
c2fdda0d | 945 | # Pre-scan the patch sanitizing the lines. |
de7d4f0e | 946 | # Pre-scan the patch looking for any __setup documentation. |
c2fdda0d | 947 | # |
de7d4f0e AW |
948 | my @setup_docs = (); |
949 | my $setup_docs = 0; | |
773647a0 AW |
950 | |
951 | sanitise_line_reset(); | |
c2fdda0d AW |
952 | my $line; |
953 | foreach my $rawline (@rawlines) { | |
773647a0 AW |
954 | $linenr++; |
955 | $line = $rawline; | |
c2fdda0d | 956 | |
773647a0 | 957 | if ($rawline=~/^\+\+\+\s+(\S+)/) { |
de7d4f0e AW |
958 | $setup_docs = 0; |
959 | if ($1 =~ m@Documentation/kernel-parameters.txt$@) { | |
960 | $setup_docs = 1; | |
961 | } | |
773647a0 AW |
962 | #next; |
963 | } | |
964 | if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { | |
965 | $realline=$1-1; | |
966 | if (defined $2) { | |
967 | $realcnt=$3+1; | |
968 | } else { | |
969 | $realcnt=1+1; | |
970 | } | |
c45dcabd | 971 | $in_comment = 0; |
773647a0 AW |
972 | |
973 | # Guestimate if this is a continuing comment. Run | |
974 | # the context looking for a comment "edge". If this | |
975 | # edge is a close comment then we must be in a comment | |
976 | # at context start. | |
977 | my $edge; | |
171ae1a4 | 978 | for (my $ln = $linenr + 1; $ln < ($linenr + $realcnt); $ln++) { |
773647a0 AW |
979 | next if ($line =~ /^-/); |
980 | ($edge) = ($rawlines[$ln - 1] =~ m@(/\*|\*/)@); | |
981 | last if (defined $edge); | |
982 | } | |
983 | if (defined $edge && $edge eq '*/') { | |
984 | $in_comment = 1; | |
985 | } | |
986 | ||
987 | # Guestimate if this is a continuing comment. If this | |
988 | # is the start of a diff block and this line starts | |
989 | # ' *' then it is very likely a comment. | |
990 | if (!defined $edge && | |
991 | $rawlines[$linenr] =~ m@^.\s* \*(?:\s|$)@) | |
992 | { | |
993 | $in_comment = 1; | |
994 | } | |
995 | ||
996 | ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; | |
997 | sanitise_line_reset($in_comment); | |
998 | ||
171ae1a4 | 999 | } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { |
773647a0 | 1000 | # Standardise the strings and chars within the input to |
171ae1a4 | 1001 | # simplify matching -- only bother with positive lines. |
773647a0 | 1002 | $line = sanitise_line($rawline); |
de7d4f0e | 1003 | } |
773647a0 AW |
1004 | push(@lines, $line); |
1005 | ||
1006 | if ($realcnt > 1) { | |
1007 | $realcnt-- if ($line =~ /^(?:\+| |$)/); | |
1008 | } else { | |
1009 | $realcnt = 0; | |
1010 | } | |
1011 | ||
1012 | #print "==>$rawline\n"; | |
1013 | #print "-->$line\n"; | |
de7d4f0e AW |
1014 | |
1015 | if ($setup_docs && $line =~ /^\+/) { | |
1016 | push(@setup_docs, $line); | |
1017 | } | |
1018 | } | |
1019 | ||
6c72ffaa AW |
1020 | $prefix = ''; |
1021 | ||
773647a0 AW |
1022 | $realcnt = 0; |
1023 | $linenr = 0; | |
0a920b5b AW |
1024 | foreach my $line (@lines) { |
1025 | $linenr++; | |
1026 | ||
c2fdda0d | 1027 | my $rawline = $rawlines[$linenr - 1]; |
6c72ffaa | 1028 | |
0a920b5b | 1029 | #extract the line range in the file after the patch is applied |
6c72ffaa | 1030 | if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { |
0a920b5b | 1031 | $is_patch = 1; |
4a0df2ef | 1032 | $first_line = $linenr + 1; |
0a920b5b AW |
1033 | $realline=$1-1; |
1034 | if (defined $2) { | |
1035 | $realcnt=$3+1; | |
1036 | } else { | |
1037 | $realcnt=1+1; | |
1038 | } | |
c2fdda0d | 1039 | annotate_reset(); |
13214adf AW |
1040 | $prev_values = 'E'; |
1041 | ||
773647a0 | 1042 | %suppress_ifbraces = (); |
0a920b5b | 1043 | next; |
0a920b5b | 1044 | |
4a0df2ef AW |
1045 | # track the line number as we move through the hunk, note that |
1046 | # new versions of GNU diff omit the leading space on completely | |
1047 | # blank context lines so we need to count that too. | |
773647a0 | 1048 | } elsif ($line =~ /^( |\+|$)/) { |
0a920b5b | 1049 | $realline++; |
d8aaf121 | 1050 | $realcnt-- if ($realcnt != 0); |
0a920b5b | 1051 | |
4a0df2ef | 1052 | # Measure the line length and indent. |
c2fdda0d | 1053 | ($length, $indent) = line_stats($rawline); |
0a920b5b AW |
1054 | |
1055 | # Track the previous line. | |
1056 | ($prevline, $stashline) = ($stashline, $line); | |
1057 | ($previndent, $stashindent) = ($stashindent, $indent); | |
c2fdda0d AW |
1058 | ($prevrawline, $stashrawline) = ($stashrawline, $rawline); |
1059 | ||
773647a0 | 1060 | #warn "line<$line>\n"; |
6c72ffaa | 1061 | |
d8aaf121 AW |
1062 | } elsif ($realcnt == 1) { |
1063 | $realcnt--; | |
0a920b5b AW |
1064 | } |
1065 | ||
1066 | #make up the handle for any error we report on this line | |
773647a0 AW |
1067 | $prefix = "$filename:$realline: " if ($emacs && $file); |
1068 | $prefix = "$filename:$linenr: " if ($emacs && !$file); | |
1069 | ||
6c72ffaa AW |
1070 | $here = "#$linenr: " if (!$file); |
1071 | $here = "#$realline: " if ($file); | |
773647a0 AW |
1072 | |
1073 | # extract the filename as it passes | |
1074 | if ($line=~/^\+\+\+\s+(\S+)/) { | |
1075 | $realfile = $1; | |
1076 | $realfile =~ s@^[^/]*/@@; | |
1077 | ||
1078 | if ($realfile =~ m@include/asm/@) { | |
1079 | ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); | |
1080 | } | |
1081 | next; | |
1082 | } | |
1083 | ||
389834b6 | 1084 | $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); |
0a920b5b | 1085 | |
c2fdda0d AW |
1086 | my $hereline = "$here\n$rawline\n"; |
1087 | my $herecurr = "$here\n$rawline\n"; | |
1088 | my $hereprev = "$here\n$prevrawline\n$rawline\n"; | |
0a920b5b | 1089 | |
6c72ffaa AW |
1090 | $cnt_lines++ if ($realcnt != 0); |
1091 | ||
0a920b5b | 1092 | #check the patch for a signoff: |
d8aaf121 | 1093 | if ($line =~ /^\s*signed-off-by:/i) { |
4a0df2ef AW |
1094 | # This is a signoff, if ugly, so do not double report. |
1095 | $signoff++; | |
0a920b5b | 1096 | if (!($line =~ /^\s*Signed-off-by:/)) { |
de7d4f0e AW |
1097 | WARN("Signed-off-by: is the preferred form\n" . |
1098 | $herecurr); | |
0a920b5b AW |
1099 | } |
1100 | if ($line =~ /^\s*signed-off-by:\S/i) { | |
773647a0 | 1101 | WARN("space required after Signed-off-by:\n" . |
de7d4f0e | 1102 | $herecurr); |
0a920b5b AW |
1103 | } |
1104 | } | |
1105 | ||
00df344f | 1106 | # Check for wrappage within a valid hunk of the file |
8905a67c | 1107 | if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { |
de7d4f0e | 1108 | ERROR("patch seems to be corrupt (line wrapped?)\n" . |
6c72ffaa | 1109 | $herecurr) if (!$emitted_corrupt++); |
de7d4f0e AW |
1110 | } |
1111 | ||
1112 | # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php | |
1113 | if (($realfile =~ /^$/ || $line =~ /^\+/) && | |
171ae1a4 AW |
1114 | $rawline !~ m/^$UTF8*$/) { |
1115 | my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); | |
1116 | ||
1117 | my $blank = copy_spacing($rawline); | |
1118 | my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; | |
1119 | my $hereptr = "$hereline$ptr\n"; | |
1120 | ||
1121 | ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); | |
00df344f AW |
1122 | } |
1123 | ||
1124 | #ignore lines being removed | |
1125 | if ($line=~/^-/) {next;} | |
0a920b5b | 1126 | |
00df344f AW |
1127 | # check we are in a valid source file if not then ignore this hunk |
1128 | next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/); | |
0a920b5b AW |
1129 | |
1130 | #trailing whitespace | |
9c0ca6f9 | 1131 | if ($line =~ /^\+.*\015/) { |
c2fdda0d | 1132 | my $herevet = "$here\n" . cat_vet($rawline) . "\n"; |
9c0ca6f9 AW |
1133 | ERROR("DOS line endings\n" . $herevet); |
1134 | ||
c2fdda0d AW |
1135 | } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { |
1136 | my $herevet = "$here\n" . cat_vet($rawline) . "\n"; | |
de7d4f0e | 1137 | ERROR("trailing whitespace\n" . $herevet); |
0a920b5b AW |
1138 | } |
1139 | #80 column limit | |
c45dcabd | 1140 | if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ && |
f4c014c0 AW |
1141 | $rawline !~ /^.\s*\*\s*\@$Ident\s/ && |
1142 | $line !~ /^\+\s*printk\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ && | |
1143 | $length > 80) | |
c45dcabd | 1144 | { |
de7d4f0e | 1145 | WARN("line over 80 characters\n" . $herecurr); |
0a920b5b AW |
1146 | } |
1147 | ||
8905a67c AW |
1148 | # check for adding lines without a newline. |
1149 | if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { | |
1150 | WARN("adding a line without newline at end of file\n" . $herecurr); | |
1151 | } | |
1152 | ||
0a920b5b AW |
1153 | # check we are in a valid source file *.[hc] if not then ignore this hunk |
1154 | next if ($realfile !~ /\.[hc]$/); | |
1155 | ||
1156 | # at the beginning of a line any tabs must come first and anything | |
1157 | # more than 8 must use tabs. | |
c2fdda0d AW |
1158 | if ($rawline =~ /^\+\s* \t\s*\S/ || |
1159 | $rawline =~ /^\+\s* \s*/) { | |
1160 | my $herevet = "$here\n" . cat_vet($rawline) . "\n"; | |
171ae1a4 | 1161 | ERROR("code indent should use tabs where possible\n" . $herevet); |
0a920b5b AW |
1162 | } |
1163 | ||
c2fdda0d | 1164 | # check for RCS/CVS revision markers |
cf655043 | 1165 | if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { |
c2fdda0d AW |
1166 | WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr); |
1167 | } | |
22f2a2ef | 1168 | |
9c0ca6f9 | 1169 | # Check for potential 'bare' types |
f5fe35dd | 1170 | my ($stat, $cond, $line_nr_next, $remain_next); |
9c9ba34e | 1171 | if ($realcnt && $line =~ /.\s*\S/) { |
f5fe35dd AW |
1172 | ($stat, $cond, $line_nr_next, $remain_next) = |
1173 | ctx_statement_block($linenr, $realcnt, 0); | |
171ae1a4 AW |
1174 | $stat =~ s/\n./\n /g; |
1175 | $cond =~ s/\n./\n /g; | |
1176 | ||
1177 | my $s = $stat; | |
1178 | $s =~ s/{.*$//s; | |
cf655043 | 1179 | |
c2fdda0d | 1180 | # Ignore goto labels. |
171ae1a4 | 1181 | if ($s =~ /$Ident:\*$/s) { |
c2fdda0d AW |
1182 | |
1183 | # Ignore functions being called | |
171ae1a4 | 1184 | } elsif ($s =~ /^.\s*$Ident\s*\(/s) { |
c2fdda0d | 1185 | |
c45dcabd AW |
1186 | # declarations always start with types |
1187 | } elsif ($prev_values eq 'E' && $s =~ /^.\s*(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?((?:\s*$Ident)+)\b(?:\s+$Sparse)?\s*\**\s*(?:$Ident|\(\*[^\)]*\))\s*(?:;|=|,|\()/s) { | |
1188 | my $type = $1; | |
1189 | $type =~ s/\s+/ /g; | |
1190 | possible($type, "A:" . $s); | |
1191 | ||
8905a67c | 1192 | # definitions in global scope can only start with types |
171ae1a4 | 1193 | } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b/s) { |
c45dcabd | 1194 | possible($1, "B:" . $s); |
c2fdda0d | 1195 | } |
8905a67c AW |
1196 | |
1197 | # any (foo ... *) is a pointer cast, and foo is a type | |
171ae1a4 | 1198 | while ($s =~ /\(($Ident)(?:\s+$Sparse)*\s*\*+\s*\)/sg) { |
c45dcabd | 1199 | possible($1, "C:" . $s); |
8905a67c AW |
1200 | } |
1201 | ||
1202 | # Check for any sort of function declaration. | |
1203 | # int foo(something bar, other baz); | |
1204 | # void (*store_gdt)(x86_descr_ptr *); | |
171ae1a4 | 1205 | if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { |
8905a67c | 1206 | my ($name_len) = length($1); |
8905a67c | 1207 | |
cf655043 | 1208 | my $ctx = $s; |
773647a0 | 1209 | substr($ctx, 0, $name_len + 1, ''); |
8905a67c | 1210 | $ctx =~ s/\)[^\)]*$//; |
cf655043 | 1211 | |
8905a67c | 1212 | for my $arg (split(/\s*,\s*/, $ctx)) { |
c45dcabd | 1213 | if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { |
8905a67c | 1214 | |
c45dcabd | 1215 | possible($1, "D:" . $s); |
8905a67c AW |
1216 | } |
1217 | } | |
9c0ca6f9 | 1218 | } |
8905a67c | 1219 | |
9c0ca6f9 AW |
1220 | } |
1221 | ||
653d4876 AW |
1222 | # |
1223 | # Checks which may be anchored in the context. | |
1224 | # | |
00df344f | 1225 | |
653d4876 AW |
1226 | # Check for switch () and associated case and default |
1227 | # statements should be at the same indent. | |
00df344f AW |
1228 | if ($line=~/\bswitch\s*\(.*\)/) { |
1229 | my $err = ''; | |
1230 | my $sep = ''; | |
1231 | my @ctx = ctx_block_outer($linenr, $realcnt); | |
1232 | shift(@ctx); | |
1233 | for my $ctx (@ctx) { | |
1234 | my ($clen, $cindent) = line_stats($ctx); | |
1235 | if ($ctx =~ /^\+\s*(case\s+|default:)/ && | |
1236 | $indent != $cindent) { | |
1237 | $err .= "$sep$ctx\n"; | |
1238 | $sep = ''; | |
1239 | } else { | |
1240 | $sep = "[...]\n"; | |
1241 | } | |
1242 | } | |
1243 | if ($err ne '') { | |
9c0ca6f9 | 1244 | ERROR("switch and case should be at the same indent\n$hereline$err"); |
de7d4f0e AW |
1245 | } |
1246 | } | |
e2a763c2 AW |
1247 | if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && |
1248 | $line !~ /\G(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$/g) { | |
1249 | ERROR("trailing statements should be on next line\n" . $herecurr); | |
1250 | } | |
de7d4f0e AW |
1251 | |
1252 | # if/while/etc brace do not go on next line, unless defining a do while loop, | |
1253 | # or if that brace on the next line is for something else | |
c45dcabd | 1254 | if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { |
773647a0 AW |
1255 | my $pre_ctx = "$1$2"; |
1256 | ||
9c0ca6f9 | 1257 | my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); |
de7d4f0e AW |
1258 | my $ctx_cnt = $realcnt - $#ctx - 1; |
1259 | my $ctx = join("\n", @ctx); | |
1260 | ||
548596d5 AW |
1261 | my $ctx_ln = $linenr; |
1262 | my $ctx_skip = $realcnt; | |
773647a0 | 1263 | |
548596d5 AW |
1264 | while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && |
1265 | defined $lines[$ctx_ln - 1] && | |
1266 | $lines[$ctx_ln - 1] =~ /^-/)) { | |
1267 | ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; | |
1268 | $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); | |
de7d4f0e | 1269 | $ctx_ln++; |
de7d4f0e | 1270 | } |
548596d5 | 1271 | |
53210168 AW |
1272 | #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; |
1273 | #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; | |
de7d4f0e | 1274 | |
773647a0 AW |
1275 | if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { |
1276 | ERROR("that open brace { should be on the previous line\n" . | |
c45dcabd | 1277 | "$here\n$ctx\n$lines[$ctx_ln - 1]\n"); |
00df344f | 1278 | } |
773647a0 AW |
1279 | if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && |
1280 | $ctx =~ /\)\s*\;\s*$/ && | |
1281 | defined $lines[$ctx_ln - 1]) | |
1282 | { | |
9c0ca6f9 AW |
1283 | my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); |
1284 | if ($nindent > $indent) { | |
773647a0 | 1285 | WARN("trailing semicolon indicates no statements, indent implies otherwise\n" . |
c45dcabd | 1286 | "$here\n$ctx\n$lines[$ctx_ln - 1]\n"); |
9c0ca6f9 AW |
1287 | } |
1288 | } | |
00df344f AW |
1289 | } |
1290 | ||
6c72ffaa AW |
1291 | # Track the 'values' across context and added lines. |
1292 | my $opline = $line; $opline =~ s/^./ /; | |
1293 | my $curr_values = annotate_values($opline . "\n", $prev_values); | |
1294 | $curr_values = $prev_values . $curr_values; | |
c2fdda0d AW |
1295 | if ($dbg_values) { |
1296 | my $outline = $opline; $outline =~ s/\t/ /g; | |
cf655043 AW |
1297 | print "$linenr > .$outline\n"; |
1298 | print "$linenr > $curr_values\n"; | |
c2fdda0d | 1299 | } |
6c72ffaa AW |
1300 | $prev_values = substr($curr_values, -1); |
1301 | ||
00df344f AW |
1302 | #ignore lines not being added |
1303 | if ($line=~/^[^\+]/) {next;} | |
1304 | ||
653d4876 AW |
1305 | # TEST: allow direct testing of the type matcher. |
1306 | if ($tst_type && $line =~ /^.$Declare$/) { | |
de7d4f0e | 1307 | ERROR("TEST: is type $Declare\n" . $herecurr); |
653d4876 AW |
1308 | next; |
1309 | } | |
1310 | ||
f0a594c1 AW |
1311 | # check for initialisation to aggregates open brace on the next line |
1312 | if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ && | |
1313 | $line =~ /^.\s*{/) { | |
773647a0 | 1314 | ERROR("that open brace { should be on the previous line\n" . $hereprev); |
f0a594c1 AW |
1315 | } |
1316 | ||
653d4876 AW |
1317 | # |
1318 | # Checks which are anchored on the added line. | |
1319 | # | |
1320 | ||
1321 | # check for malformed paths in #include statements (uses RAW line) | |
c45dcabd | 1322 | if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { |
653d4876 AW |
1323 | my $path = $1; |
1324 | if ($path =~ m{//}) { | |
de7d4f0e AW |
1325 | ERROR("malformed #include filename\n" . |
1326 | $herecurr); | |
653d4876 | 1327 | } |
653d4876 | 1328 | } |
00df344f | 1329 | |
0a920b5b | 1330 | # no C99 // comments |
00df344f | 1331 | if ($line =~ m{//}) { |
de7d4f0e | 1332 | ERROR("do not use C99 // comments\n" . $herecurr); |
0a920b5b | 1333 | } |
00df344f | 1334 | # Remove C99 comments. |
0a920b5b | 1335 | $line =~ s@//.*@@; |
6c72ffaa | 1336 | $opline =~ s@//.*@@; |
0a920b5b AW |
1337 | |
1338 | #EXPORT_SYMBOL should immediately follow its function closing }. | |
653d4876 AW |
1339 | if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) || |
1340 | ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { | |
1341 | my $name = $1; | |
0a920b5b AW |
1342 | if (($prevline !~ /^}/) && |
1343 | ($prevline !~ /^\+}/) && | |
653d4876 | 1344 | ($prevline !~ /^ }/) && |
cf655043 AW |
1345 | ($prevline !~ /^.DECLARE_$Ident\(\Q$name\E\)/) && |
1346 | ($prevline !~ /^.LIST_HEAD\(\Q$name\E\)/) && | |
171ae1a4 | 1347 | ($prevline !~ /^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(/) && |
cf655043 | 1348 | ($prevline !~ /\b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[)/)) { |
de7d4f0e | 1349 | WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); |
0a920b5b AW |
1350 | } |
1351 | } | |
1352 | ||
f0a594c1 | 1353 | # check for external initialisers. |
c45dcabd | 1354 | if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) { |
f0a594c1 AW |
1355 | ERROR("do not initialise externals to 0 or NULL\n" . |
1356 | $herecurr); | |
1357 | } | |
653d4876 | 1358 | # check for static initialisers. |
9c9ba34e | 1359 | if ($line =~ /\s*static\s.*=\s*(0|NULL|false)\s*;/) { |
de7d4f0e AW |
1360 | ERROR("do not initialise statics to 0 or NULL\n" . |
1361 | $herecurr); | |
0a920b5b AW |
1362 | } |
1363 | ||
653d4876 AW |
1364 | # check for new typedefs, only function parameters and sparse annotations |
1365 | # make sense. | |
1366 | if ($line =~ /\btypedef\s/ && | |
9c0ca6f9 | 1367 | $line !~ /\btypedef\s+$Type\s+\(\s*\*?$Ident\s*\)\s*\(/ && |
c45dcabd | 1368 | $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && |
653d4876 | 1369 | $line !~ /\b__bitwise(?:__|)\b/) { |
de7d4f0e | 1370 | WARN("do not add new typedefs\n" . $herecurr); |
0a920b5b AW |
1371 | } |
1372 | ||
1373 | # * goes on variable not on type | |
d8aaf121 | 1374 | if ($line =~ m{\($NonptrType(\*+)(?:\s+const)?\)}) { |
de7d4f0e AW |
1375 | ERROR("\"(foo$1)\" should be \"(foo $1)\"\n" . |
1376 | $herecurr); | |
d8aaf121 AW |
1377 | |
1378 | } elsif ($line =~ m{\($NonptrType\s+(\*+)(?!\s+const)\s+\)}) { | |
de7d4f0e AW |
1379 | ERROR("\"(foo $1 )\" should be \"(foo $1)\"\n" . |
1380 | $herecurr); | |
d8aaf121 | 1381 | |
9c0ca6f9 | 1382 | } elsif ($line =~ m{$NonptrType(\*+)(?:\s+(?:$Attribute|$Sparse))?\s+[A-Za-z\d_]+}) { |
de7d4f0e AW |
1383 | ERROR("\"foo$1 bar\" should be \"foo $1bar\"\n" . |
1384 | $herecurr); | |
d8aaf121 | 1385 | |
9c0ca6f9 | 1386 | } elsif ($line =~ m{$NonptrType\s+(\*+)(?!\s+(?:$Attribute|$Sparse))\s+[A-Za-z\d_]+}) { |
de7d4f0e AW |
1387 | ERROR("\"foo $1 bar\" should be \"foo $1bar\"\n" . |
1388 | $herecurr); | |
0a920b5b AW |
1389 | } |
1390 | ||
1391 | # # no BUG() or BUG_ON() | |
1392 | # if ($line =~ /\b(BUG|BUG_ON)\b/) { | |
1393 | # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; | |
1394 | # print "$herecurr"; | |
1395 | # $clean = 0; | |
1396 | # } | |
1397 | ||
8905a67c | 1398 | if ($line =~ /\bLINUX_VERSION_CODE\b/) { |
c2fdda0d | 1399 | WARN("LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); |
8905a67c AW |
1400 | } |
1401 | ||
00df344f AW |
1402 | # printk should use KERN_* levels. Note that follow on printk's on the |
1403 | # same line do not need a level, so we use the current block context | |
1404 | # to try and find and validate the current printk. In summary the current | |
1405 | # printk includes all preceeding printk's which have no newline on the end. | |
1406 | # we assume the first bad printk is the one to report. | |
f0a594c1 | 1407 | if ($line =~ /\bprintk\((?!KERN_)\s*"/) { |
00df344f AW |
1408 | my $ok = 0; |
1409 | for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { | |
1410 | #print "CHECK<$lines[$ln - 1]\n"; | |
1411 | # we have a preceeding printk if it ends | |
1412 | # with "\n" ignore it, else it is to blame | |
1413 | if ($lines[$ln - 1] =~ m{\bprintk\(}) { | |
1414 | if ($rawlines[$ln - 1] !~ m{\\n"}) { | |
1415 | $ok = 1; | |
1416 | } | |
1417 | last; | |
1418 | } | |
1419 | } | |
1420 | if ($ok == 0) { | |
de7d4f0e | 1421 | WARN("printk() should include KERN_ facility level\n" . $herecurr); |
00df344f | 1422 | } |
0a920b5b AW |
1423 | } |
1424 | ||
653d4876 AW |
1425 | # function brace can't be on same line, except for #defines of do while, |
1426 | # or if closed on same line | |
c45dcabd AW |
1427 | if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and |
1428 | !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { | |
de7d4f0e | 1429 | ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr); |
0a920b5b | 1430 | } |
653d4876 | 1431 | |
8905a67c AW |
1432 | # open braces for enum, union and struct go on the same line. |
1433 | if ($line =~ /^.\s*{/ && | |
1434 | $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { | |
1435 | ERROR("open brace '{' following $1 go on the same line\n" . $hereprev); | |
1436 | } | |
1437 | ||
8d31cfce AW |
1438 | # check for spacing round square brackets; allowed: |
1439 | # 1. with a type on the left -- int [] a; | |
1440 | # 2. at the beginning of a line for slice initialisers -- [0..10] = 5, | |
1441 | while ($line =~ /(.*?\s)\[/g) { | |
1442 | my ($where, $prefix) = ($-[1], $1); | |
1443 | if ($prefix !~ /$Type\s+$/ && | |
1444 | ($where != 0 || $prefix !~ /^.\s+$/)) { | |
1445 | ERROR("space prohibited before open square bracket '['\n" . $herecurr); | |
1446 | } | |
1447 | } | |
1448 | ||
f0a594c1 | 1449 | # check for spaces between functions and their parentheses. |
6c72ffaa | 1450 | while ($line =~ /($Ident)\s+\(/g) { |
c2fdda0d | 1451 | my $name = $1; |
773647a0 AW |
1452 | my $ctx_before = substr($line, 0, $-[1]); |
1453 | my $ctx = "$ctx_before$name"; | |
c2fdda0d AW |
1454 | |
1455 | # Ignore those directives where spaces _are_ permitted. | |
773647a0 AW |
1456 | if ($name =~ /^(?: |
1457 | if|for|while|switch|return|case| | |
1458 | volatile|__volatile__| | |
1459 | __attribute__|format|__extension__| | |
1460 | asm|__asm__)$/x) | |
1461 | { | |
c2fdda0d AW |
1462 | |
1463 | # cpp #define statements have non-optional spaces, ie | |
1464 | # if there is a space between the name and the open | |
1465 | # parenthesis it is simply not a parameter group. | |
c45dcabd | 1466 | } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { |
773647a0 AW |
1467 | |
1468 | # cpp #elif statement condition may start with a ( | |
c45dcabd | 1469 | } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { |
c2fdda0d AW |
1470 | |
1471 | # If this whole things ends with a type its most | |
1472 | # likely a typedef for a function. | |
773647a0 | 1473 | } elsif ($ctx =~ /$Type$/) { |
c2fdda0d AW |
1474 | |
1475 | } else { | |
773647a0 | 1476 | WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr); |
6c72ffaa | 1477 | } |
f0a594c1 | 1478 | } |
653d4876 | 1479 | # Check operator spacing. |
0a920b5b | 1480 | if (!($line=~/\#\s*include/)) { |
9c0ca6f9 AW |
1481 | my $ops = qr{ |
1482 | <<=|>>=|<=|>=|==|!=| | |
1483 | \+=|-=|\*=|\/=|%=|\^=|\|=|&=| | |
1484 | =>|->|<<|>>|<|>|=|!|~| | |
c2fdda0d | 1485 | &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|% |
9c0ca6f9 | 1486 | }x; |
cf655043 | 1487 | my @elements = split(/($ops|;)/, $opline); |
00df344f | 1488 | my $off = 0; |
6c72ffaa AW |
1489 | |
1490 | my $blank = copy_spacing($opline); | |
1491 | ||
0a920b5b | 1492 | for (my $n = 0; $n < $#elements; $n += 2) { |
4a0df2ef AW |
1493 | $off += length($elements[$n]); |
1494 | ||
773647a0 AW |
1495 | # Pick up the preceeding and succeeding characters. |
1496 | my $ca = substr($opline, 0, $off); | |
1497 | my $cc = ''; | |
1498 | if (length($opline) >= ($off + length($elements[$n + 1]))) { | |
1499 | $cc = substr($opline, $off + length($elements[$n + 1])); | |
1500 | } | |
1501 | my $cb = "$ca$;$cc"; | |
1502 | ||
4a0df2ef AW |
1503 | my $a = ''; |
1504 | $a = 'V' if ($elements[$n] ne ''); | |
1505 | $a = 'W' if ($elements[$n] =~ /\s$/); | |
cf655043 | 1506 | $a = 'C' if ($elements[$n] =~ /$;$/); |
4a0df2ef AW |
1507 | $a = 'B' if ($elements[$n] =~ /(\[|\()$/); |
1508 | $a = 'O' if ($elements[$n] eq ''); | |
773647a0 | 1509 | $a = 'E' if ($ca =~ /^\s*$/); |
4a0df2ef | 1510 | |
0a920b5b | 1511 | my $op = $elements[$n + 1]; |
4a0df2ef AW |
1512 | |
1513 | my $c = ''; | |
0a920b5b | 1514 | if (defined $elements[$n + 2]) { |
4a0df2ef AW |
1515 | $c = 'V' if ($elements[$n + 2] ne ''); |
1516 | $c = 'W' if ($elements[$n + 2] =~ /^\s/); | |
cf655043 | 1517 | $c = 'C' if ($elements[$n + 2] =~ /^$;/); |
4a0df2ef AW |
1518 | $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); |
1519 | $c = 'O' if ($elements[$n + 2] eq ''); | |
22f2a2ef | 1520 | $c = 'E' if ($elements[$n + 2] =~ /\s*\\$/); |
4a0df2ef AW |
1521 | } else { |
1522 | $c = 'E'; | |
0a920b5b AW |
1523 | } |
1524 | ||
4a0df2ef AW |
1525 | my $ctx = "${a}x${c}"; |
1526 | ||
1527 | my $at = "(ctx:$ctx)"; | |
1528 | ||
6c72ffaa | 1529 | my $ptr = substr($blank, 0, $off) . "^"; |
de7d4f0e | 1530 | my $hereptr = "$hereline$ptr\n"; |
0a920b5b | 1531 | |
9c0ca6f9 AW |
1532 | # Classify operators into binary, unary, or |
1533 | # definitions (* only) where they have more | |
1534 | # than one mode. | |
6c72ffaa AW |
1535 | my $op_type = substr($curr_values, $off + 1, 1); |
1536 | my $op_left = substr($curr_values, $off, 1); | |
1537 | my $is_unary; | |
1538 | if ($op_type eq 'T') { | |
1539 | $is_unary = 2; | |
1540 | } elsif ($op_left eq 'V') { | |
1541 | $is_unary = 0; | |
1542 | } else { | |
1543 | $is_unary = 1; | |
9c0ca6f9 | 1544 | } |
9c0ca6f9 | 1545 | #if ($op eq '-' || $op eq '&' || $op eq '*') { |
6c72ffaa | 1546 | # print "UNARY: <$op_left$op_type $is_unary $a:$op:$c> <$ca:$op:$cc> <$unary_ctx>\n"; |
9c0ca6f9 | 1547 | #} |
0a920b5b | 1548 | |
13214adf AW |
1549 | # Ignore operators passed as parameters. |
1550 | if ($op_type ne 'V' && | |
1551 | $ca =~ /\s$/ && $cc =~ /^\s*,/) { | |
1552 | ||
cf655043 AW |
1553 | # # Ignore comments |
1554 | # } elsif ($op =~ /^$;+$/) { | |
13214adf | 1555 | |
d8aaf121 | 1556 | # ; should have either the end of line or a space or \ after it |
13214adf | 1557 | } elsif ($op eq ';') { |
cf655043 AW |
1558 | if ($ctx !~ /.x[WEBC]/ && |
1559 | $cc !~ /^\\/ && $cc !~ /^;/) { | |
773647a0 | 1560 | ERROR("space required after that '$op' $at\n" . $hereptr); |
d8aaf121 AW |
1561 | } |
1562 | ||
1563 | # // is a comment | |
1564 | } elsif ($op eq '//') { | |
0a920b5b AW |
1565 | |
1566 | # -> should have no spaces | |
1567 | } elsif ($op eq '->') { | |
4a0df2ef | 1568 | if ($ctx =~ /Wx.|.xW/) { |
773647a0 | 1569 | ERROR("spaces prohibited around that '$op' $at\n" . $hereptr); |
0a920b5b AW |
1570 | } |
1571 | ||
1572 | # , must have a space on the right. | |
1573 | } elsif ($op eq ',') { | |
cf655043 | 1574 | if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { |
773647a0 | 1575 | ERROR("space required after that '$op' $at\n" . $hereptr); |
0a920b5b AW |
1576 | } |
1577 | ||
9c0ca6f9 AW |
1578 | # '*' as part of a type definition -- reported already. |
1579 | } elsif ($op eq '*' && $is_unary == 2) { | |
1580 | #warn "'*' is part of type\n"; | |
1581 | ||
1582 | # unary operators should have a space before and | |
1583 | # none after. May be left adjacent to another | |
1584 | # unary operator, or a cast | |
1585 | } elsif ($op eq '!' || $op eq '~' || | |
1586 | ($is_unary && ($op eq '*' || $op eq '-' || $op eq '&'))) { | |
cf655043 | 1587 | if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { |
773647a0 | 1588 | ERROR("space required before that '$op' $at\n" . $hereptr); |
0a920b5b | 1589 | } |
171ae1a4 AW |
1590 | if ($op eq '*' && $cc =~/\s*const\b/) { |
1591 | # A unary '*' may be const | |
1592 | ||
1593 | } elsif ($ctx =~ /.xW/) { | |
773647a0 | 1594 | ERROR("space prohibited after that '$op' $at\n" . $hereptr); |
0a920b5b AW |
1595 | } |
1596 | ||
1597 | # unary ++ and unary -- are allowed no space on one side. | |
1598 | } elsif ($op eq '++' or $op eq '--') { | |
773647a0 AW |
1599 | if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { |
1600 | ERROR("space required one side of that '$op' $at\n" . $hereptr); | |
1601 | } | |
1602 | if ($ctx =~ /Wx[BE]/ || | |
1603 | ($ctx =~ /Wx./ && $cc =~ /^;/)) { | |
1604 | ERROR("space prohibited before that '$op' $at\n" . $hereptr); | |
0a920b5b | 1605 | } |
773647a0 AW |
1606 | if ($ctx =~ /ExW/) { |
1607 | ERROR("space prohibited after that '$op' $at\n" . $hereptr); | |
653d4876 | 1608 | } |
0a920b5b | 1609 | |
773647a0 | 1610 | |
0a920b5b | 1611 | # << and >> may either have or not have spaces both sides |
9c0ca6f9 AW |
1612 | } elsif ($op eq '<<' or $op eq '>>' or |
1613 | $op eq '&' or $op eq '^' or $op eq '|' or | |
1614 | $op eq '+' or $op eq '-' or | |
c2fdda0d AW |
1615 | $op eq '*' or $op eq '/' or |
1616 | $op eq '%') | |
0a920b5b | 1617 | { |
773647a0 | 1618 | if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { |
de7d4f0e AW |
1619 | ERROR("need consistent spacing around '$op' $at\n" . |
1620 | $hereptr); | |
0a920b5b AW |
1621 | } |
1622 | ||
1623 | # All the others need spaces both sides. | |
cf655043 | 1624 | } elsif ($ctx !~ /[EWC]x[CWE]/) { |
22f2a2ef AW |
1625 | # Ignore email addresses <foo@bar> |
1626 | if (!($op eq '<' && $cb =~ /$;\S+\@\S+>/) && | |
1627 | !($op eq '>' && $cb =~ /<\S+\@\S+$;/)) { | |
773647a0 | 1628 | ERROR("spaces required around that '$op' $at\n" . $hereptr); |
22f2a2ef | 1629 | } |
0a920b5b | 1630 | } |
4a0df2ef | 1631 | $off += length($elements[$n + 1]); |
0a920b5b AW |
1632 | } |
1633 | } | |
1634 | ||
f0a594c1 AW |
1635 | # check for multiple assignments |
1636 | if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { | |
6c72ffaa | 1637 | CHK("multiple assignments should be avoided\n" . $herecurr); |
f0a594c1 AW |
1638 | } |
1639 | ||
22f2a2ef AW |
1640 | ## # check for multiple declarations, allowing for a function declaration |
1641 | ## # continuation. | |
1642 | ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && | |
1643 | ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { | |
1644 | ## | |
1645 | ## # Remove any bracketed sections to ensure we do not | |
1646 | ## # falsly report the parameters of functions. | |
1647 | ## my $ln = $line; | |
1648 | ## while ($ln =~ s/\([^\(\)]*\)//g) { | |
1649 | ## } | |
1650 | ## if ($ln =~ /,/) { | |
1651 | ## WARN("declaring multiple variables together should be avoided\n" . $herecurr); | |
1652 | ## } | |
1653 | ## } | |
f0a594c1 | 1654 | |
0a920b5b | 1655 | #need space before brace following if, while, etc |
22f2a2ef AW |
1656 | if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || |
1657 | $line =~ /do{/) { | |
773647a0 | 1658 | ERROR("space required before the open brace '{'\n" . $herecurr); |
de7d4f0e AW |
1659 | } |
1660 | ||
1661 | # closing brace should have a space following it when it has anything | |
1662 | # on the line | |
1663 | if ($line =~ /}(?!(?:,|;|\)))\S/) { | |
773647a0 | 1664 | ERROR("space required after that close brace '}'\n" . $herecurr); |
0a920b5b AW |
1665 | } |
1666 | ||
22f2a2ef AW |
1667 | # check spacing on square brackets |
1668 | if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { | |
773647a0 | 1669 | ERROR("space prohibited after that open square bracket '['\n" . $herecurr); |
22f2a2ef AW |
1670 | } |
1671 | if ($line =~ /\s\]/) { | |
773647a0 | 1672 | ERROR("space prohibited before that close square bracket ']'\n" . $herecurr); |
22f2a2ef AW |
1673 | } |
1674 | ||
c45dcabd | 1675 | # check spacing on parentheses |
9c0ca6f9 AW |
1676 | if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && |
1677 | $line !~ /for\s*\(\s+;/) { | |
773647a0 | 1678 | ERROR("space prohibited after that open parenthesis '('\n" . $herecurr); |
22f2a2ef | 1679 | } |
13214adf | 1680 | if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && |
c45dcabd AW |
1681 | $line !~ /for\s*\(.*;\s+\)/ && |
1682 | $line !~ /:\s+\)/) { | |
773647a0 | 1683 | ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr); |
22f2a2ef AW |
1684 | } |
1685 | ||
0a920b5b | 1686 | #goto labels aren't indented, allow a single space however |
4a0df2ef | 1687 | if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and |
0a920b5b | 1688 | !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { |
de7d4f0e | 1689 | WARN("labels should not be indented\n" . $herecurr); |
0a920b5b AW |
1690 | } |
1691 | ||
c45dcabd AW |
1692 | # Return is not a function. |
1693 | if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) { | |
1694 | my $spacing = $1; | |
1695 | my $value = $2; | |
1696 | ||
1697 | # Flatten any parentheses and braces | |
fee61c47 | 1698 | $value =~ s/\)\(/\) \(/g; |
c45dcabd AW |
1699 | while ($value =~ s/\([^\(\)]*\)/1/) { |
1700 | } | |
1701 | ||
1702 | if ($value =~ /^(?:$Ident|-?$Constant)$/) { | |
1703 | ERROR("return is not a function, parentheses are not required\n" . $herecurr); | |
1704 | ||
1705 | } elsif ($spacing !~ /\s+/) { | |
1706 | ERROR("space required before the open parenthesis '('\n" . $herecurr); | |
1707 | } | |
1708 | } | |
1709 | ||
0a920b5b | 1710 | # Need a space before open parenthesis after if, while etc |
4a0df2ef | 1711 | if ($line=~/\b(if|while|for|switch)\(/) { |
773647a0 | 1712 | ERROR("space required before the open parenthesis '('\n" . $herecurr); |
0a920b5b AW |
1713 | } |
1714 | ||
f5fe35dd AW |
1715 | # Check for illegal assignment in if conditional -- and check for trailing |
1716 | # statements after the conditional. | |
53210168 | 1717 | if ($line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { |
171ae1a4 | 1718 | my ($s, $c) = ($stat, $cond); |
8905a67c AW |
1719 | |
1720 | if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/) { | |
c2fdda0d | 1721 | ERROR("do not use assignment in if condition\n" . $herecurr); |
8905a67c AW |
1722 | } |
1723 | ||
1724 | # Find out what is on the end of the line after the | |
1725 | # conditional. | |
773647a0 | 1726 | substr($s, 0, length($c), ''); |
8905a67c | 1727 | $s =~ s/\n.*//g; |
13214adf | 1728 | $s =~ s/$;//g; # Remove any comments |
53210168 AW |
1729 | if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && |
1730 | $c !~ /}\s*while\s*/) | |
773647a0 | 1731 | { |
8905a67c AW |
1732 | ERROR("trailing statements should be on next line\n" . $herecurr); |
1733 | } | |
1734 | } | |
1735 | ||
f5fe35dd AW |
1736 | # Check relative indent for conditionals and blocks. |
1737 | if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { | |
1738 | my ($s, $c) = ($stat, $cond); | |
1739 | ||
1740 | substr($s, 0, length($c), ''); | |
1741 | ||
1742 | # Make sure we remove the line prefixes as we have | |
1743 | # none on the first line, and are going to readd them | |
1744 | # where necessary. | |
1745 | $s =~ s/\n./\n/gs; | |
1746 | ||
1747 | # We want to check the first line inside the block | |
1748 | # starting at the end of the conditional, so remove: | |
1749 | # 1) any blank line termination | |
1750 | # 2) any opening brace { on end of the line | |
1751 | # 3) any do (...) { | |
1752 | my $continuation = 0; | |
1753 | my $check = 0; | |
1754 | $s =~ s/^.*\bdo\b//; | |
1755 | $s =~ s/^\s*{//; | |
1756 | if ($s =~ s/^\s*\\//) { | |
1757 | $continuation = 1; | |
1758 | } | |
1759 | if ($s =~ s/^\s*\n//) { | |
1760 | $check = 1; | |
1761 | } | |
1762 | ||
1763 | # Also ignore a loop construct at the end of a | |
1764 | # preprocessor statement. | |
1765 | if (($prevline =~ /^.\s*#\s*define\s/ || | |
1766 | $prevline =~ /\\\s*$/) && $continuation == 0) { | |
1767 | $check = 0; | |
1768 | } | |
1769 | ||
1770 | # Ignore the current line if its is a preprocessor | |
1771 | # line. | |
1772 | if ($s =~ /^\s*#\s*/) { | |
1773 | $check = 0; | |
1774 | } | |
1775 | ||
1776 | my (undef, $sindent) = line_stats("+" . $s); | |
1777 | ||
1778 | ##print "line<$line> prevline<$prevline> indent<$indent> sindent<$sindent> check<$check> continuation<$continuation> s<$s>\n"; | |
1779 | ||
1780 | if ($check && (($sindent % 8) != 0 || | |
1781 | ($sindent <= $indent && $s ne ''))) { | |
1782 | WARN("suspect code indent for conditional statements\n" . $herecurr); | |
1783 | } | |
1784 | } | |
1785 | ||
13214adf AW |
1786 | # Check for bitwise tests written as boolean |
1787 | if ($line =~ / | |
1788 | (?: | |
1789 | (?:\[|\(|\&\&|\|\|) | |
1790 | \s*0[xX][0-9]+\s* | |
1791 | (?:\&\&|\|\|) | |
1792 | | | |
1793 | (?:\&\&|\|\|) | |
1794 | \s*0[xX][0-9]+\s* | |
1795 | (?:\&\&|\|\||\)|\]) | |
1796 | )/x) | |
1797 | { | |
1798 | WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); | |
1799 | } | |
1800 | ||
8905a67c | 1801 | # if and else should not have general statements after it |
13214adf AW |
1802 | if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { |
1803 | my $s = $1; | |
1804 | $s =~ s/$;//g; # Remove any comments | |
1805 | if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { | |
1806 | ERROR("trailing statements should be on next line\n" . $herecurr); | |
1807 | } | |
0a920b5b AW |
1808 | } |
1809 | ||
1810 | # Check for }<nl>else {, these must be at the same | |
1811 | # indent level to be relevant to each other. | |
1812 | if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and | |
1813 | $previndent == $indent) { | |
de7d4f0e | 1814 | ERROR("else should follow close brace '}'\n" . $hereprev); |
0a920b5b AW |
1815 | } |
1816 | ||
c2fdda0d AW |
1817 | if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and |
1818 | $previndent == $indent) { | |
1819 | my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); | |
1820 | ||
1821 | # Find out what is on the end of the line after the | |
1822 | # conditional. | |
773647a0 | 1823 | substr($s, 0, length($c), ''); |
c2fdda0d AW |
1824 | $s =~ s/\n.*//g; |
1825 | ||
1826 | if ($s =~ /^\s*;/) { | |
1827 | ERROR("while should follow close brace '}'\n" . $hereprev); | |
1828 | } | |
1829 | } | |
1830 | ||
0a920b5b AW |
1831 | #studly caps, commented out until figure out how to distinguish between use of existing and adding new |
1832 | # if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) { | |
1833 | # print "No studly caps, use _\n"; | |
1834 | # print "$herecurr"; | |
1835 | # $clean = 0; | |
1836 | # } | |
1837 | ||
1838 | #no spaces allowed after \ in define | |
c45dcabd | 1839 | if ($line=~/\#\s*define.*\\\s$/) { |
de7d4f0e | 1840 | WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr); |
0a920b5b AW |
1841 | } |
1842 | ||
653d4876 | 1843 | #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line) |
c45dcabd AW |
1844 | if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { |
1845 | my $checkfile = "include/linux/$1.h"; | |
1846 | if (-f "$root/$checkfile" && $realfile ne $checkfile && | |
1847 | $1 ne 'irq') | |
1848 | { | |
773647a0 | 1849 | WARN("Use #include <linux/$1.h> instead of <asm/$1.h>\n" . |
de7d4f0e | 1850 | $herecurr); |
0a920b5b AW |
1851 | } |
1852 | } | |
1853 | ||
653d4876 AW |
1854 | # multi-statement macros should be enclosed in a do while loop, grab the |
1855 | # first statement and ensure its the whole macro if its not enclosed | |
cf655043 | 1856 | # in a known good container |
c45dcabd | 1857 | if ($line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { |
d8aaf121 AW |
1858 | my $ln = $linenr; |
1859 | my $cnt = $realcnt; | |
c45dcabd AW |
1860 | my ($off, $dstat, $dcond, $rest); |
1861 | my $ctx = ''; | |
653d4876 | 1862 | |
c45dcabd AW |
1863 | my $args = defined($1); |
1864 | ||
1865 | # Find the end of the macro and limit our statement | |
1866 | # search to that. | |
1867 | while ($cnt > 0 && defined $lines[$ln - 1] && | |
1868 | $lines[$ln - 1] =~ /^(?:-|..*\\$)/) | |
1869 | { | |
1870 | $ctx .= $rawlines[$ln - 1] . "\n"; | |
a3bb97a7 | 1871 | $cnt-- if ($lines[$ln - 1] !~ /^-/); |
c45dcabd | 1872 | $ln++; |
c45dcabd AW |
1873 | } |
1874 | $ctx .= $rawlines[$ln - 1]; | |
1875 | ||
1876 | ($dstat, $dcond, $ln, $cnt, $off) = | |
1877 | ctx_statement_block($linenr, $ln - $linenr + 1, 0); | |
1878 | #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; | |
a3bb97a7 | 1879 | #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; |
c45dcabd AW |
1880 | |
1881 | # Extract the remainder of the define (if any) and | |
1882 | # rip off surrounding spaces, and trailing \'s. | |
1883 | $rest = ''; | |
a3bb97a7 AW |
1884 | while ($off != 0 || ($cnt > 0 && $rest =~ /(?:^|\\)\s*$/)) { |
1885 | #print "ADDING $off <" . substr($lines[$ln - 1], $off) . ">\n"; | |
1886 | if ($off != 0 || $lines[$ln - 1] !~ /^-/) { | |
1887 | $rest .= substr($lines[$ln - 1], $off) . "\n"; | |
1888 | $cnt--; | |
1889 | } | |
c45dcabd | 1890 | $ln++; |
c45dcabd AW |
1891 | $off = 0; |
1892 | } | |
1893 | $rest =~ s/\\\n.//g; | |
1894 | $rest =~ s/^\s*//s; | |
1895 | $rest =~ s/\s*$//s; | |
1896 | ||
1897 | # Clean up the original statement. | |
1898 | if ($args) { | |
1899 | substr($dstat, 0, length($dcond), ''); | |
1900 | } else { | |
1901 | $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//; | |
d8aaf121 | 1902 | } |
c45dcabd AW |
1903 | $dstat =~ s/\\\n.//g; |
1904 | $dstat =~ s/^\s*//s; | |
1905 | $dstat =~ s/\s*$//s; | |
de7d4f0e | 1906 | |
c45dcabd AW |
1907 | # Flatten any parentheses and braces |
1908 | while ($dstat =~ s/\([^\(\)]*\)/1/) { | |
1909 | } | |
1910 | while ($dstat =~ s/\{[^\{\}]*\}/1/) { | |
de7d4f0e | 1911 | } |
d8aaf121 | 1912 | |
c45dcabd AW |
1913 | my $exceptions = qr{ |
1914 | $Declare| | |
1915 | module_param_named| | |
1916 | MODULE_PARAM_DESC| | |
1917 | DECLARE_PER_CPU| | |
1918 | DEFINE_PER_CPU| | |
1919 | __typeof__\( | |
1920 | }x; | |
a3bb97a7 | 1921 | #print "REST<$rest>\n"; |
c45dcabd AW |
1922 | if ($rest ne '') { |
1923 | if ($rest !~ /while\s*\(/ && | |
1924 | $dstat !~ /$exceptions/) | |
1925 | { | |
de7d4f0e | 1926 | ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n"); |
c45dcabd AW |
1927 | } |
1928 | ||
1929 | } elsif ($ctx !~ /;/) { | |
1930 | if ($dstat ne '' && | |
1931 | $dstat !~ /^(?:$Ident|-?$Constant)$/ && | |
1932 | $dstat !~ /$exceptions/ && | |
1933 | $dstat =~ /$Operators/) | |
1934 | { | |
de7d4f0e | 1935 | ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n"); |
d8aaf121 | 1936 | } |
653d4876 | 1937 | } |
0a920b5b AW |
1938 | } |
1939 | ||
f0a594c1 | 1940 | # check for redundant bracing round if etc |
13214adf AW |
1941 | if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { |
1942 | my ($level, $endln, @chunks) = | |
cf655043 | 1943 | ctx_statement_full($linenr, $realcnt, 1); |
13214adf | 1944 | #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; |
cf655043 AW |
1945 | #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; |
1946 | if ($#chunks > 0 && $level == 0) { | |
13214adf AW |
1947 | my $allowed = 0; |
1948 | my $seen = 0; | |
773647a0 | 1949 | my $herectx = $here . "\n"; |
cf655043 | 1950 | my $ln = $linenr - 1; |
13214adf AW |
1951 | for my $chunk (@chunks) { |
1952 | my ($cond, $block) = @{$chunk}; | |
1953 | ||
773647a0 AW |
1954 | # If the condition carries leading newlines, then count those as offsets. |
1955 | my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); | |
1956 | my $offset = statement_rawlines($whitespace) - 1; | |
1957 | ||
1958 | #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; | |
1959 | ||
1960 | # We have looked at and allowed this specific line. | |
1961 | $suppress_ifbraces{$ln + $offset} = 1; | |
1962 | ||
1963 | $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; | |
cf655043 AW |
1964 | $ln += statement_rawlines($block) - 1; |
1965 | ||
773647a0 | 1966 | substr($block, 0, length($cond), ''); |
13214adf AW |
1967 | |
1968 | $seen++ if ($block =~ /^\s*{/); | |
1969 | ||
cf655043 AW |
1970 | #print "cond<$cond> block<$block> allowed<$allowed>\n"; |
1971 | if (statement_lines($cond) > 1) { | |
1972 | #print "APW: ALLOWED: cond<$cond>\n"; | |
13214adf AW |
1973 | $allowed = 1; |
1974 | } | |
1975 | if ($block =~/\b(?:if|for|while)\b/) { | |
cf655043 | 1976 | #print "APW: ALLOWED: block<$block>\n"; |
13214adf AW |
1977 | $allowed = 1; |
1978 | } | |
cf655043 AW |
1979 | if (statement_block_size($block) > 1) { |
1980 | #print "APW: ALLOWED: lines block<$block>\n"; | |
13214adf AW |
1981 | $allowed = 1; |
1982 | } | |
1983 | } | |
1984 | if ($seen && !$allowed) { | |
cf655043 | 1985 | WARN("braces {} are not necessary for any arm of this statement\n" . $herectx); |
13214adf AW |
1986 | } |
1987 | } | |
1988 | } | |
773647a0 | 1989 | if (!defined $suppress_ifbraces{$linenr - 1} && |
13214adf | 1990 | $line =~ /\b(if|while|for|else)\b/) { |
cf655043 AW |
1991 | my $allowed = 0; |
1992 | ||
1993 | # Check the pre-context. | |
1994 | if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { | |
1995 | #print "APW: ALLOWED: pre<$1>\n"; | |
1996 | $allowed = 1; | |
1997 | } | |
773647a0 AW |
1998 | |
1999 | my ($level, $endln, @chunks) = | |
2000 | ctx_statement_full($linenr, $realcnt, $-[0]); | |
2001 | ||
cf655043 AW |
2002 | # Check the condition. |
2003 | my ($cond, $block) = @{$chunks[0]}; | |
773647a0 | 2004 | #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; |
cf655043 | 2005 | if (defined $cond) { |
773647a0 | 2006 | substr($block, 0, length($cond), ''); |
cf655043 AW |
2007 | } |
2008 | if (statement_lines($cond) > 1) { | |
2009 | #print "APW: ALLOWED: cond<$cond>\n"; | |
2010 | $allowed = 1; | |
2011 | } | |
2012 | if ($block =~/\b(?:if|for|while)\b/) { | |
2013 | #print "APW: ALLOWED: block<$block>\n"; | |
2014 | $allowed = 1; | |
2015 | } | |
2016 | if (statement_block_size($block) > 1) { | |
2017 | #print "APW: ALLOWED: lines block<$block>\n"; | |
2018 | $allowed = 1; | |
2019 | } | |
2020 | # Check the post-context. | |
2021 | if (defined $chunks[1]) { | |
2022 | my ($cond, $block) = @{$chunks[1]}; | |
2023 | if (defined $cond) { | |
773647a0 | 2024 | substr($block, 0, length($cond), ''); |
cf655043 AW |
2025 | } |
2026 | if ($block =~ /^\s*\{/) { | |
2027 | #print "APW: ALLOWED: chunk-1 block<$block>\n"; | |
2028 | $allowed = 1; | |
2029 | } | |
2030 | } | |
2031 | if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { | |
2032 | my $herectx = $here . "\n";; | |
2033 | my $end = $linenr + statement_rawlines($block) - 1; | |
2034 | ||
2035 | for (my $ln = $linenr - 1; $ln < $end; $ln++) { | |
2036 | $herectx .= $rawlines[$ln] . "\n";; | |
f0a594c1 | 2037 | } |
cf655043 AW |
2038 | |
2039 | WARN("braces {} are not necessary for single statement blocks\n" . $herectx); | |
f0a594c1 AW |
2040 | } |
2041 | } | |
2042 | ||
653d4876 | 2043 | # don't include deprecated include files (uses RAW line) |
4a0df2ef | 2044 | for my $inc (@dep_includes) { |
c45dcabd | 2045 | if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) { |
de7d4f0e | 2046 | ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr); |
0a920b5b AW |
2047 | } |
2048 | } | |
2049 | ||
4a0df2ef AW |
2050 | # don't use deprecated functions |
2051 | for my $func (@dep_functions) { | |
00df344f | 2052 | if ($line =~ /\b$func\b/) { |
de7d4f0e | 2053 | ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr); |
4a0df2ef AW |
2054 | } |
2055 | } | |
2056 | ||
2057 | # no volatiles please | |
6c72ffaa AW |
2058 | my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; |
2059 | if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { | |
de7d4f0e | 2060 | WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); |
4a0df2ef AW |
2061 | } |
2062 | ||
9c0ca6f9 AW |
2063 | # SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated |
2064 | if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) { | |
2065 | ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr); | |
2066 | } | |
2067 | ||
00df344f | 2068 | # warn about #if 0 |
c45dcabd | 2069 | if ($line =~ /^.\s*\#\s*if\s+0\b/) { |
de7d4f0e AW |
2070 | CHK("if this code is redundant consider removing it\n" . |
2071 | $herecurr); | |
4a0df2ef AW |
2072 | } |
2073 | ||
f0a594c1 AW |
2074 | # check for needless kfree() checks |
2075 | if ($prevline =~ /\bif\s*\(([^\)]*)\)/) { | |
2076 | my $expr = $1; | |
2077 | if ($line =~ /\bkfree\(\Q$expr\E\);/) { | |
2078 | WARN("kfree(NULL) is safe this check is probabally not required\n" . $hereprev); | |
2079 | } | |
2080 | } | |
4c432a8f GKH |
2081 | # check for needless usb_free_urb() checks |
2082 | if ($prevline =~ /\bif\s*\(([^\)]*)\)/) { | |
2083 | my $expr = $1; | |
2084 | if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) { | |
2085 | WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev); | |
2086 | } | |
2087 | } | |
f0a594c1 | 2088 | |
00df344f | 2089 | # warn about #ifdefs in C files |
c45dcabd | 2090 | # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { |
00df344f AW |
2091 | # print "#ifdef in C files should be avoided\n"; |
2092 | # print "$herecurr"; | |
2093 | # $clean = 0; | |
2094 | # } | |
2095 | ||
22f2a2ef | 2096 | # warn about spacing in #ifdefs |
c45dcabd | 2097 | if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { |
22f2a2ef AW |
2098 | ERROR("exactly one space required after that #$1\n" . $herecurr); |
2099 | } | |
2100 | ||
4a0df2ef | 2101 | # check for spinlock_t definitions without a comment. |
171ae1a4 AW |
2102 | if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || |
2103 | $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { | |
4a0df2ef AW |
2104 | my $which = $1; |
2105 | if (!ctx_has_comment($first_line, $linenr)) { | |
de7d4f0e | 2106 | CHK("$1 definition without comment\n" . $herecurr); |
4a0df2ef AW |
2107 | } |
2108 | } | |
2109 | # check for memory barriers without a comment. | |
2110 | if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { | |
2111 | if (!ctx_has_comment($first_line, $linenr)) { | |
de7d4f0e | 2112 | CHK("memory barrier without comment\n" . $herecurr); |
4a0df2ef AW |
2113 | } |
2114 | } | |
2115 | # check of hardware specific defines | |
c45dcabd | 2116 | if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { |
de7d4f0e | 2117 | CHK("architecture specific defines should be avoided\n" . $herecurr); |
0a920b5b | 2118 | } |
653d4876 | 2119 | |
de7d4f0e AW |
2120 | # check the location of the inline attribute, that it is between |
2121 | # storage class and type. | |
9c0ca6f9 AW |
2122 | if ($line =~ /\b$Type\s+$Inline\b/ || |
2123 | $line =~ /\b$Inline\s+$Storage\b/) { | |
de7d4f0e AW |
2124 | ERROR("inline keyword should sit between storage class and type\n" . $herecurr); |
2125 | } | |
2126 | ||
8905a67c AW |
2127 | # Check for __inline__ and __inline, prefer inline |
2128 | if ($line =~ /\b(__inline__|__inline)\b/) { | |
2129 | WARN("plain inline is preferred over $1\n" . $herecurr); | |
2130 | } | |
2131 | ||
de7d4f0e | 2132 | # check for new externs in .c files. |
171ae1a4 | 2133 | if ($realfile =~ /\.c$/ && defined $stat && |
c45dcabd | 2134 | $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) |
171ae1a4 | 2135 | { |
c45dcabd AW |
2136 | my $function_name = $1; |
2137 | my $paren_space = $2; | |
171ae1a4 AW |
2138 | |
2139 | my $s = $stat; | |
2140 | if (defined $cond) { | |
2141 | substr($s, 0, length($cond), ''); | |
2142 | } | |
c45dcabd AW |
2143 | if ($s =~ /^\s*;/ && |
2144 | $function_name ne 'uninitialized_var') | |
2145 | { | |
171ae1a4 AW |
2146 | WARN("externs should be avoided in .c files\n" . $herecurr); |
2147 | } | |
2148 | ||
2149 | if ($paren_space =~ /\n/) { | |
2150 | WARN("arguments for function declarations should follow identifier\n" . $herecurr); | |
2151 | } | |
9c9ba34e AW |
2152 | |
2153 | } elsif ($realfile =~ /\.c$/ && defined $stat && | |
2154 | $stat =~ /^.\s*extern\s+/) | |
2155 | { | |
2156 | WARN("externs should be avoided in .c files\n" . $herecurr); | |
de7d4f0e AW |
2157 | } |
2158 | ||
2159 | # checks for new __setup's | |
2160 | if ($rawline =~ /\b__setup\("([^"]*)"/) { | |
2161 | my $name = $1; | |
2162 | ||
2163 | if (!grep(/$name/, @setup_docs)) { | |
2164 | CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); | |
2165 | } | |
653d4876 | 2166 | } |
9c0ca6f9 AW |
2167 | |
2168 | # check for pointless casting of kmalloc return | |
2169 | if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) { | |
2170 | WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); | |
2171 | } | |
13214adf AW |
2172 | |
2173 | # check for gcc specific __FUNCTION__ | |
2174 | if ($line =~ /__FUNCTION__/) { | |
2175 | WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr); | |
2176 | } | |
773647a0 AW |
2177 | |
2178 | # check for semaphores used as mutexes | |
171ae1a4 | 2179 | if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) { |
773647a0 AW |
2180 | WARN("mutexes are preferred for single holder semaphores\n" . $herecurr); |
2181 | } | |
2182 | # check for semaphores used as mutexes | |
171ae1a4 | 2183 | if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) { |
773647a0 AW |
2184 | WARN("consider using a completion\n" . $herecurr); |
2185 | } | |
2186 | # recommend strict_strto* over simple_strto* | |
2187 | if ($line =~ /\bsimple_(strto.*?)\s*\(/) { | |
2188 | WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr); | |
2189 | } | |
f3db6639 ME |
2190 | # check for __initcall(), use device_initcall() explicitly please |
2191 | if ($line =~ /^.\s*__initcall\s*\(/) { | |
2192 | WARN("please use device_initcall() instead of __initcall()\n" . $herecurr); | |
2193 | } | |
773647a0 AW |
2194 | |
2195 | # use of NR_CPUS is usually wrong | |
2196 | # ignore definitions of NR_CPUS and usage to define arrays as likely right | |
2197 | if ($line =~ /\bNR_CPUS\b/ && | |
c45dcabd AW |
2198 | $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && |
2199 | $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && | |
171ae1a4 AW |
2200 | $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && |
2201 | $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && | |
2202 | $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) | |
773647a0 AW |
2203 | { |
2204 | WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); | |
2205 | } | |
9c9ba34e AW |
2206 | |
2207 | # check for %L{u,d,i} in strings | |
2208 | my $string; | |
2209 | while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { | |
2210 | $string = substr($rawline, $-[1], $+[1] - $-[1]); | |
2211 | if ($string =~ /(?<!%)%L[udi]/) { | |
2212 | WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); | |
2213 | last; | |
2214 | } | |
2215 | } | |
13214adf AW |
2216 | } |
2217 | ||
2218 | # If we have no input at all, then there is nothing to report on | |
2219 | # so just keep quiet. | |
2220 | if ($#rawlines == -1) { | |
2221 | exit(0); | |
0a920b5b AW |
2222 | } |
2223 | ||
8905a67c AW |
2224 | # In mailback mode only produce a report in the negative, for |
2225 | # things that appear to be patches. | |
2226 | if ($mailback && ($clean == 1 || !$is_patch)) { | |
2227 | exit(0); | |
2228 | } | |
2229 | ||
2230 | # This is not a patch, and we are are in 'no-patch' mode so | |
2231 | # just keep quiet. | |
2232 | if (!$chk_patch && !$is_patch) { | |
2233 | exit(0); | |
2234 | } | |
2235 | ||
2236 | if (!$is_patch) { | |
de7d4f0e | 2237 | ERROR("Does not appear to be a unified-diff format patch\n"); |
0a920b5b AW |
2238 | } |
2239 | if ($is_patch && $chk_signoff && $signoff == 0) { | |
de7d4f0e | 2240 | ERROR("Missing Signed-off-by: line(s)\n"); |
0a920b5b AW |
2241 | } |
2242 | ||
8905a67c | 2243 | print report_dump(); |
13214adf AW |
2244 | if ($summary && !($clean == 1 && $quiet == 1)) { |
2245 | print "$filename " if ($summary_file); | |
8905a67c AW |
2246 | print "total: $cnt_error errors, $cnt_warn warnings, " . |
2247 | (($check)? "$cnt_chk checks, " : "") . | |
2248 | "$cnt_lines lines checked\n"; | |
2249 | print "\n" if ($quiet == 0); | |
f0a594c1 | 2250 | } |
8905a67c | 2251 | |
0a920b5b | 2252 | if ($clean == 1 && $quiet == 0) { |
c2fdda0d | 2253 | print "$vname has no obvious style problems and is ready for submission.\n" |
0a920b5b AW |
2254 | } |
2255 | if ($clean == 0 && $quiet == 0) { | |
c2fdda0d | 2256 | print "$vname has style problems, please review. If any of these errors\n"; |
0a920b5b AW |
2257 | print "are false positives report them to the maintainer, see\n"; |
2258 | print "CHECKPATCH in MAINTAINERS.\n"; | |
2259 | } | |
13214adf | 2260 | |
0a920b5b AW |
2261 | return $clean; |
2262 | } |