Commit | Line | Data |
---|---|---|
0a920b5b | 1 | #!/usr/bin/perl -w |
dbf004d7 | 2 | # (c) 2001, Dave Jones. (the file handling bit) |
00df344f | 3 | # (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit) |
2a5a2c25 | 4 | # (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite) |
131edb34 | 5 | # (c) 2008,2009, Andy Whitcroft <apw@canonical.com> |
0a920b5b AW |
6 | # Licensed under the terms of the GNU GPL License version 2 |
7 | ||
8 | use strict; | |
9 | ||
10 | my $P = $0; | |
00df344f | 11 | $P =~ s@.*/@@g; |
0a920b5b | 12 | |
5e8d8f6f | 13 | my $V = '0.30'; |
0a920b5b AW |
14 | |
15 | use Getopt::Long qw(:config no_auto_abbrev); | |
16 | ||
17 | my $quiet = 0; | |
18 | my $tree = 1; | |
19 | my $chk_signoff = 1; | |
20 | my $chk_patch = 1; | |
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; |
77f5b10a HE |
31 | my $help = 0; |
32 | ||
33 | sub help { | |
34 | my ($exitcode) = @_; | |
35 | ||
36 | print << "EOM"; | |
37 | Usage: $P [OPTION]... [FILE]... | |
38 | Version: $V | |
39 | ||
40 | Options: | |
41 | -q, --quiet quiet | |
42 | --no-tree run without a kernel tree | |
43 | --no-signoff do not check for 'Signed-off-by' line | |
44 | --patch treat FILE as patchfile (default) | |
45 | --emacs emacs compile window format | |
46 | --terse one line per report | |
47 | -f, --file treat FILE as regular source file | |
48 | --subjective, --strict enable more subjective tests | |
49 | --root=PATH PATH to the kernel tree root | |
50 | --no-summary suppress the per-file summary | |
51 | --mailback only produce a report in case of warnings/errors | |
52 | --summary-file include the filename in summary | |
53 | --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of | |
54 | 'values', 'possible', 'type', and 'attr' (default | |
55 | is all off) | |
56 | --test-only=WORD report only warnings/errors containing WORD | |
57 | literally | |
58 | -h, --help, --version display this help and exit | |
59 | ||
60 | When FILE is - read standard input. | |
61 | EOM | |
62 | ||
63 | exit($exitcode); | |
64 | } | |
65 | ||
0a920b5b | 66 | GetOptions( |
6c72ffaa | 67 | 'q|quiet+' => \$quiet, |
0a920b5b AW |
68 | 'tree!' => \$tree, |
69 | 'signoff!' => \$chk_signoff, | |
70 | 'patch!' => \$chk_patch, | |
6c72ffaa | 71 | 'emacs!' => \$emacs, |
8905a67c | 72 | 'terse!' => \$terse, |
77f5b10a | 73 | 'f|file!' => \$file, |
6c72ffaa AW |
74 | 'subjective!' => \$check, |
75 | 'strict!' => \$check, | |
76 | 'root=s' => \$root, | |
8905a67c AW |
77 | 'summary!' => \$summary, |
78 | 'mailback!' => \$mailback, | |
13214adf AW |
79 | 'summary-file!' => \$summary_file, |
80 | ||
c2fdda0d | 81 | 'debug=s' => \%debug, |
773647a0 | 82 | 'test-only=s' => \$tst_only, |
77f5b10a HE |
83 | 'h|help' => \$help, |
84 | 'version' => \$help | |
85 | ) or help(1); | |
86 | ||
87 | help(0) if ($help); | |
0a920b5b AW |
88 | |
89 | my $exit = 0; | |
90 | ||
91 | if ($#ARGV < 0) { | |
77f5b10a | 92 | print "$P: no input files\n"; |
0a920b5b AW |
93 | exit(1); |
94 | } | |
95 | ||
c2fdda0d AW |
96 | my $dbg_values = 0; |
97 | my $dbg_possible = 0; | |
7429c690 | 98 | my $dbg_type = 0; |
a1ef277e | 99 | my $dbg_attr = 0; |
c2fdda0d | 100 | for my $key (keys %debug) { |
21caa13c AW |
101 | ## no critic |
102 | eval "\${dbg_$key} = '$debug{$key}';"; | |
103 | die "$@" if ($@); | |
c2fdda0d AW |
104 | } |
105 | ||
d2c0a235 AW |
106 | my $rpt_cleaners = 0; |
107 | ||
8905a67c AW |
108 | if ($terse) { |
109 | $emacs = 1; | |
110 | $quiet++; | |
111 | } | |
112 | ||
6c72ffaa AW |
113 | if ($tree) { |
114 | if (defined $root) { | |
115 | if (!top_of_kernel_tree($root)) { | |
116 | die "$P: $root: --root does not point at a valid tree\n"; | |
117 | } | |
118 | } else { | |
119 | if (top_of_kernel_tree('.')) { | |
120 | $root = '.'; | |
121 | } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && | |
122 | top_of_kernel_tree($1)) { | |
123 | $root = $1; | |
124 | } | |
125 | } | |
126 | ||
127 | if (!defined $root) { | |
128 | print "Must be run from the top-level dir. of a kernel tree\n"; | |
129 | exit(2); | |
130 | } | |
0a920b5b AW |
131 | } |
132 | ||
6c72ffaa AW |
133 | my $emitted_corrupt = 0; |
134 | ||
2ceb532b AW |
135 | our $Ident = qr{ |
136 | [A-Za-z_][A-Za-z\d_]* | |
137 | (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* | |
138 | }x; | |
6c72ffaa AW |
139 | our $Storage = qr{extern|static|asmlinkage}; |
140 | our $Sparse = qr{ | |
141 | __user| | |
142 | __kernel| | |
143 | __force| | |
144 | __iomem| | |
145 | __must_check| | |
146 | __init_refok| | |
417495ed AW |
147 | __kprobes| |
148 | __ref | |
6c72ffaa | 149 | }x; |
52131292 WS |
150 | |
151 | # Notes to $Attribute: | |
152 | # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check | |
6c72ffaa AW |
153 | our $Attribute = qr{ |
154 | const| | |
155 | __read_mostly| | |
156 | __kprobes| | |
52131292 | 157 | __(?:mem|cpu|dev|)(?:initdata|initconst|init\b)| |
24e1d81a AW |
158 | ____cacheline_aligned| |
159 | ____cacheline_aligned_in_smp| | |
5fe3af11 AW |
160 | ____cacheline_internodealigned_in_smp| |
161 | __weak | |
6c72ffaa | 162 | }x; |
c45dcabd | 163 | our $Modifier; |
6c72ffaa | 164 | our $Inline = qr{inline|__always_inline|noinline}; |
6c72ffaa AW |
165 | our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; |
166 | our $Lval = qr{$Ident(?:$Member)*}; | |
167 | ||
168 | our $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*}; | |
169 | our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)}; | |
86f9d059 | 170 | our $Compare = qr{<=|>=|==|!=|<|>}; |
6c72ffaa AW |
171 | our $Operators = qr{ |
172 | <=|>=|==|!=| | |
173 | =>|->|<<|>>|<|>|!|~| | |
c2fdda0d | 174 | &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|% |
6c72ffaa AW |
175 | }x; |
176 | ||
8905a67c AW |
177 | our $NonptrType; |
178 | our $Type; | |
179 | our $Declare; | |
180 | ||
171ae1a4 AW |
181 | our $UTF8 = qr { |
182 | [\x09\x0A\x0D\x20-\x7E] # ASCII | |
183 | | [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte | |
184 | | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs | |
185 | | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte | |
186 | | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates | |
187 | | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 | |
188 | | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 | |
189 | | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 | |
190 | }x; | |
191 | ||
8ed22cad | 192 | our $typeTypedefs = qr{(?x: |
fb9e9096 | 193 | (?:__)?(?:u|s|be|le)(?:8|16|32|64)| |
8ed22cad AW |
194 | atomic_t |
195 | )}; | |
196 | ||
691e669b JP |
197 | our $logFunctions = qr{(?x: |
198 | printk| | |
199 | pr_(debug|dbg|vdbg|devel|info|warning|err|notice|alert|crit|emerg|cont)| | |
8bbea968 | 200 | (dev|netdev|netif)_(printk|dbg|vdbg|info|warn|err|notice|alert|crit|emerg|WARN)| |
691e669b JP |
201 | WARN| |
202 | panic | |
203 | )}; | |
204 | ||
8905a67c AW |
205 | our @typeList = ( |
206 | qr{void}, | |
c45dcabd AW |
207 | qr{(?:unsigned\s+)?char}, |
208 | qr{(?:unsigned\s+)?short}, | |
209 | qr{(?:unsigned\s+)?int}, | |
210 | qr{(?:unsigned\s+)?long}, | |
211 | qr{(?:unsigned\s+)?long\s+int}, | |
212 | qr{(?:unsigned\s+)?long\s+long}, | |
213 | qr{(?:unsigned\s+)?long\s+long\s+int}, | |
8905a67c AW |
214 | qr{unsigned}, |
215 | qr{float}, | |
216 | qr{double}, | |
217 | qr{bool}, | |
8905a67c AW |
218 | qr{struct\s+$Ident}, |
219 | qr{union\s+$Ident}, | |
220 | qr{enum\s+$Ident}, | |
221 | qr{${Ident}_t}, | |
222 | qr{${Ident}_handler}, | |
223 | qr{${Ident}_handler_fn}, | |
224 | ); | |
c45dcabd AW |
225 | our @modifierList = ( |
226 | qr{fastcall}, | |
227 | ); | |
8905a67c | 228 | |
7840a94c WS |
229 | our $allowed_asm_includes = qr{(?x: |
230 | irq| | |
231 | memory | |
232 | )}; | |
233 | # memory.h: ARM has a custom one | |
234 | ||
8905a67c | 235 | sub build_types { |
d2172eb5 AW |
236 | my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)"; |
237 | my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)"; | |
c8cb2ca3 | 238 | $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; |
8905a67c | 239 | $NonptrType = qr{ |
d2172eb5 | 240 | (?:$Modifier\s+|const\s+)* |
cf655043 | 241 | (?: |
c45dcabd | 242 | (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)| |
8ed22cad | 243 | (?:$typeTypedefs\b)| |
c45dcabd | 244 | (?:${all}\b) |
cf655043 | 245 | ) |
c8cb2ca3 | 246 | (?:\s+$Modifier|\s+const)* |
8905a67c AW |
247 | }x; |
248 | $Type = qr{ | |
c45dcabd | 249 | $NonptrType |
65863862 | 250 | (?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)? |
c8cb2ca3 | 251 | (?:\s+$Inline|\s+$Modifier)* |
8905a67c AW |
252 | }x; |
253 | $Declare = qr{(?:$Storage\s+)?$Type}; | |
254 | } | |
255 | build_types(); | |
6c72ffaa AW |
256 | |
257 | $chk_signoff = 0 if ($file); | |
258 | ||
4a0df2ef AW |
259 | my @dep_includes = (); |
260 | my @dep_functions = (); | |
6c72ffaa AW |
261 | my $removal = "Documentation/feature-removal-schedule.txt"; |
262 | if ($tree && -f "$root/$removal") { | |
21caa13c | 263 | open(my $REMOVE, '<', "$root/$removal") || |
6c72ffaa | 264 | die "$P: $removal: open failed - $!\n"; |
21caa13c | 265 | while (<$REMOVE>) { |
f0a594c1 AW |
266 | if (/^Check:\s+(.*\S)/) { |
267 | for my $entry (split(/[, ]+/, $1)) { | |
268 | if ($entry =~ m@include/(.*)@) { | |
4a0df2ef | 269 | push(@dep_includes, $1); |
4a0df2ef | 270 | |
f0a594c1 AW |
271 | } elsif ($entry !~ m@/@) { |
272 | push(@dep_functions, $entry); | |
273 | } | |
4a0df2ef | 274 | } |
0a920b5b AW |
275 | } |
276 | } | |
21caa13c | 277 | close($REMOVE); |
0a920b5b AW |
278 | } |
279 | ||
00df344f | 280 | my @rawlines = (); |
c2fdda0d AW |
281 | my @lines = (); |
282 | my $vname; | |
6c72ffaa | 283 | for my $filename (@ARGV) { |
21caa13c | 284 | my $FILE; |
6c72ffaa | 285 | if ($file) { |
21caa13c | 286 | open($FILE, '-|', "diff -u /dev/null $filename") || |
6c72ffaa | 287 | die "$P: $filename: diff failed - $!\n"; |
21caa13c AW |
288 | } elsif ($filename eq '-') { |
289 | open($FILE, '<&STDIN'); | |
6c72ffaa | 290 | } else { |
21caa13c | 291 | open($FILE, '<', "$filename") || |
6c72ffaa | 292 | die "$P: $filename: open failed - $!\n"; |
0a920b5b | 293 | } |
c2fdda0d AW |
294 | if ($filename eq '-') { |
295 | $vname = 'Your patch'; | |
296 | } else { | |
297 | $vname = $filename; | |
298 | } | |
21caa13c | 299 | while (<$FILE>) { |
6c72ffaa AW |
300 | chomp; |
301 | push(@rawlines, $_); | |
302 | } | |
21caa13c | 303 | close($FILE); |
c2fdda0d | 304 | if (!process($filename)) { |
6c72ffaa AW |
305 | $exit = 1; |
306 | } | |
307 | @rawlines = (); | |
13214adf | 308 | @lines = (); |
0a920b5b AW |
309 | } |
310 | ||
311 | exit($exit); | |
312 | ||
313 | sub top_of_kernel_tree { | |
6c72ffaa AW |
314 | my ($root) = @_; |
315 | ||
316 | my @tree_check = ( | |
317 | "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", | |
318 | "README", "Documentation", "arch", "include", "drivers", | |
319 | "fs", "init", "ipc", "kernel", "lib", "scripts", | |
320 | ); | |
321 | ||
322 | foreach my $check (@tree_check) { | |
323 | if (! -e $root . '/' . $check) { | |
324 | return 0; | |
325 | } | |
0a920b5b | 326 | } |
6c72ffaa | 327 | return 1; |
0a920b5b AW |
328 | } |
329 | ||
330 | sub expand_tabs { | |
331 | my ($str) = @_; | |
332 | ||
333 | my $res = ''; | |
334 | my $n = 0; | |
335 | for my $c (split(//, $str)) { | |
336 | if ($c eq "\t") { | |
337 | $res .= ' '; | |
338 | $n++; | |
339 | for (; ($n % 8) != 0; $n++) { | |
340 | $res .= ' '; | |
341 | } | |
342 | next; | |
343 | } | |
344 | $res .= $c; | |
345 | $n++; | |
346 | } | |
347 | ||
348 | return $res; | |
349 | } | |
6c72ffaa | 350 | sub copy_spacing { |
773647a0 | 351 | (my $res = shift) =~ tr/\t/ /c; |
6c72ffaa AW |
352 | return $res; |
353 | } | |
0a920b5b | 354 | |
4a0df2ef AW |
355 | sub line_stats { |
356 | my ($line) = @_; | |
357 | ||
358 | # Drop the diff line leader and expand tabs | |
359 | $line =~ s/^.//; | |
360 | $line = expand_tabs($line); | |
361 | ||
362 | # Pick the indent from the front of the line. | |
363 | my ($white) = ($line =~ /^(\s*)/); | |
364 | ||
365 | return (length($line), length($white)); | |
366 | } | |
367 | ||
773647a0 AW |
368 | my $sanitise_quote = ''; |
369 | ||
370 | sub sanitise_line_reset { | |
371 | my ($in_comment) = @_; | |
372 | ||
373 | if ($in_comment) { | |
374 | $sanitise_quote = '*/'; | |
375 | } else { | |
376 | $sanitise_quote = ''; | |
377 | } | |
378 | } | |
00df344f AW |
379 | sub sanitise_line { |
380 | my ($line) = @_; | |
381 | ||
382 | my $res = ''; | |
383 | my $l = ''; | |
384 | ||
c2fdda0d | 385 | my $qlen = 0; |
773647a0 AW |
386 | my $off = 0; |
387 | my $c; | |
00df344f | 388 | |
773647a0 AW |
389 | # Always copy over the diff marker. |
390 | $res = substr($line, 0, 1); | |
391 | ||
392 | for ($off = 1; $off < length($line); $off++) { | |
393 | $c = substr($line, $off, 1); | |
394 | ||
395 | # Comments we are wacking completly including the begin | |
396 | # and end, all to $;. | |
397 | if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { | |
398 | $sanitise_quote = '*/'; | |
399 | ||
400 | substr($res, $off, 2, "$;$;"); | |
401 | $off++; | |
402 | next; | |
00df344f | 403 | } |
81bc0e02 | 404 | if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { |
773647a0 AW |
405 | $sanitise_quote = ''; |
406 | substr($res, $off, 2, "$;$;"); | |
407 | $off++; | |
408 | next; | |
c2fdda0d | 409 | } |
113f04a8 DW |
410 | if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { |
411 | $sanitise_quote = '//'; | |
412 | ||
413 | substr($res, $off, 2, $sanitise_quote); | |
414 | $off++; | |
415 | next; | |
416 | } | |
773647a0 AW |
417 | |
418 | # A \ in a string means ignore the next character. | |
419 | if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && | |
420 | $c eq "\\") { | |
421 | substr($res, $off, 2, 'XX'); | |
422 | $off++; | |
423 | next; | |
00df344f | 424 | } |
773647a0 AW |
425 | # Regular quotes. |
426 | if ($c eq "'" || $c eq '"') { | |
427 | if ($sanitise_quote eq '') { | |
428 | $sanitise_quote = $c; | |
00df344f | 429 | |
773647a0 AW |
430 | substr($res, $off, 1, $c); |
431 | next; | |
432 | } elsif ($sanitise_quote eq $c) { | |
433 | $sanitise_quote = ''; | |
434 | } | |
435 | } | |
00df344f | 436 | |
fae17dae | 437 | #print "c<$c> SQ<$sanitise_quote>\n"; |
773647a0 AW |
438 | if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { |
439 | substr($res, $off, 1, $;); | |
113f04a8 DW |
440 | } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { |
441 | substr($res, $off, 1, $;); | |
773647a0 AW |
442 | } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { |
443 | substr($res, $off, 1, 'X'); | |
444 | } else { | |
445 | substr($res, $off, 1, $c); | |
446 | } | |
c2fdda0d AW |
447 | } |
448 | ||
113f04a8 DW |
449 | if ($sanitise_quote eq '//') { |
450 | $sanitise_quote = ''; | |
451 | } | |
452 | ||
c2fdda0d | 453 | # The pathname on a #include may be surrounded by '<' and '>'. |
c45dcabd | 454 | if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { |
c2fdda0d AW |
455 | my $clean = 'X' x length($1); |
456 | $res =~ s@\<.*\>@<$clean>@; | |
457 | ||
458 | # The whole of a #error is a string. | |
c45dcabd | 459 | } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { |
c2fdda0d | 460 | my $clean = 'X' x length($1); |
c45dcabd | 461 | $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; |
c2fdda0d AW |
462 | } |
463 | ||
00df344f AW |
464 | return $res; |
465 | } | |
466 | ||
8905a67c AW |
467 | sub ctx_statement_block { |
468 | my ($linenr, $remain, $off) = @_; | |
469 | my $line = $linenr - 1; | |
470 | my $blk = ''; | |
471 | my $soff = $off; | |
472 | my $coff = $off - 1; | |
773647a0 | 473 | my $coff_set = 0; |
8905a67c | 474 | |
13214adf AW |
475 | my $loff = 0; |
476 | ||
8905a67c AW |
477 | my $type = ''; |
478 | my $level = 0; | |
a2750645 | 479 | my @stack = (); |
cf655043 | 480 | my $p; |
8905a67c AW |
481 | my $c; |
482 | my $len = 0; | |
13214adf AW |
483 | |
484 | my $remainder; | |
8905a67c | 485 | while (1) { |
a2750645 AW |
486 | @stack = (['', 0]) if ($#stack == -1); |
487 | ||
773647a0 | 488 | #warn "CSB: blk<$blk> remain<$remain>\n"; |
8905a67c AW |
489 | # If we are about to drop off the end, pull in more |
490 | # context. | |
491 | if ($off >= $len) { | |
492 | for (; $remain > 0; $line++) { | |
dea33496 | 493 | last if (!defined $lines[$line]); |
c2fdda0d | 494 | next if ($lines[$line] =~ /^-/); |
8905a67c | 495 | $remain--; |
13214adf | 496 | $loff = $len; |
c2fdda0d | 497 | $blk .= $lines[$line] . "\n"; |
8905a67c AW |
498 | $len = length($blk); |
499 | $line++; | |
500 | last; | |
501 | } | |
502 | # Bail if there is no further context. | |
503 | #warn "CSB: blk<$blk> off<$off> len<$len>\n"; | |
13214adf | 504 | if ($off >= $len) { |
8905a67c AW |
505 | last; |
506 | } | |
507 | } | |
cf655043 | 508 | $p = $c; |
8905a67c | 509 | $c = substr($blk, $off, 1); |
13214adf | 510 | $remainder = substr($blk, $off); |
8905a67c | 511 | |
773647a0 | 512 | #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; |
4635f4fb AW |
513 | |
514 | # Handle nested #if/#else. | |
515 | if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { | |
516 | push(@stack, [ $type, $level ]); | |
517 | } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { | |
518 | ($type, $level) = @{$stack[$#stack - 1]}; | |
519 | } elsif ($remainder =~ /^#\s*endif\b/) { | |
520 | ($type, $level) = @{pop(@stack)}; | |
521 | } | |
522 | ||
8905a67c AW |
523 | # Statement ends at the ';' or a close '}' at the |
524 | # outermost level. | |
525 | if ($level == 0 && $c eq ';') { | |
526 | last; | |
527 | } | |
528 | ||
13214adf | 529 | # An else is really a conditional as long as its not else if |
773647a0 AW |
530 | if ($level == 0 && $coff_set == 0 && |
531 | (!defined($p) || $p =~ /(?:\s|\}|\+)/) && | |
532 | $remainder =~ /^(else)(?:\s|{)/ && | |
533 | $remainder !~ /^else\s+if\b/) { | |
534 | $coff = $off + length($1) - 1; | |
535 | $coff_set = 1; | |
536 | #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; | |
537 | #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; | |
13214adf AW |
538 | } |
539 | ||
8905a67c AW |
540 | if (($type eq '' || $type eq '(') && $c eq '(') { |
541 | $level++; | |
542 | $type = '('; | |
543 | } | |
544 | if ($type eq '(' && $c eq ')') { | |
545 | $level--; | |
546 | $type = ($level != 0)? '(' : ''; | |
547 | ||
548 | if ($level == 0 && $coff < $soff) { | |
549 | $coff = $off; | |
773647a0 AW |
550 | $coff_set = 1; |
551 | #warn "CSB: mark coff<$coff>\n"; | |
8905a67c AW |
552 | } |
553 | } | |
554 | if (($type eq '' || $type eq '{') && $c eq '{') { | |
555 | $level++; | |
556 | $type = '{'; | |
557 | } | |
558 | if ($type eq '{' && $c eq '}') { | |
559 | $level--; | |
560 | $type = ($level != 0)? '{' : ''; | |
561 | ||
562 | if ($level == 0) { | |
b998e001 PP |
563 | if (substr($blk, $off + 1, 1) eq ';') { |
564 | $off++; | |
565 | } | |
8905a67c AW |
566 | last; |
567 | } | |
568 | } | |
569 | $off++; | |
570 | } | |
a3bb97a7 | 571 | # We are truly at the end, so shuffle to the next line. |
13214adf | 572 | if ($off == $len) { |
a3bb97a7 | 573 | $loff = $len + 1; |
13214adf AW |
574 | $line++; |
575 | $remain--; | |
576 | } | |
8905a67c AW |
577 | |
578 | my $statement = substr($blk, $soff, $off - $soff + 1); | |
579 | my $condition = substr($blk, $soff, $coff - $soff + 1); | |
580 | ||
581 | #warn "STATEMENT<$statement>\n"; | |
582 | #warn "CONDITION<$condition>\n"; | |
583 | ||
773647a0 | 584 | #print "coff<$coff> soff<$off> loff<$loff>\n"; |
13214adf AW |
585 | |
586 | return ($statement, $condition, | |
587 | $line, $remain + 1, $off - $loff + 1, $level); | |
588 | } | |
589 | ||
cf655043 AW |
590 | sub statement_lines { |
591 | my ($stmt) = @_; | |
592 | ||
593 | # Strip the diff line prefixes and rip blank lines at start and end. | |
594 | $stmt =~ s/(^|\n)./$1/g; | |
595 | $stmt =~ s/^\s*//; | |
596 | $stmt =~ s/\s*$//; | |
597 | ||
598 | my @stmt_lines = ($stmt =~ /\n/g); | |
599 | ||
600 | return $#stmt_lines + 2; | |
601 | } | |
602 | ||
603 | sub statement_rawlines { | |
604 | my ($stmt) = @_; | |
605 | ||
606 | my @stmt_lines = ($stmt =~ /\n/g); | |
607 | ||
608 | return $#stmt_lines + 2; | |
609 | } | |
610 | ||
611 | sub statement_block_size { | |
612 | my ($stmt) = @_; | |
613 | ||
614 | $stmt =~ s/(^|\n)./$1/g; | |
615 | $stmt =~ s/^\s*{//; | |
616 | $stmt =~ s/}\s*$//; | |
617 | $stmt =~ s/^\s*//; | |
618 | $stmt =~ s/\s*$//; | |
619 | ||
620 | my @stmt_lines = ($stmt =~ /\n/g); | |
621 | my @stmt_statements = ($stmt =~ /;/g); | |
622 | ||
623 | my $stmt_lines = $#stmt_lines + 2; | |
624 | my $stmt_statements = $#stmt_statements + 1; | |
625 | ||
626 | if ($stmt_lines > $stmt_statements) { | |
627 | return $stmt_lines; | |
628 | } else { | |
629 | return $stmt_statements; | |
630 | } | |
631 | } | |
632 | ||
13214adf AW |
633 | sub ctx_statement_full { |
634 | my ($linenr, $remain, $off) = @_; | |
635 | my ($statement, $condition, $level); | |
636 | ||
637 | my (@chunks); | |
638 | ||
cf655043 | 639 | # Grab the first conditional/block pair. |
13214adf AW |
640 | ($statement, $condition, $linenr, $remain, $off, $level) = |
641 | ctx_statement_block($linenr, $remain, $off); | |
773647a0 | 642 | #print "F: c<$condition> s<$statement> remain<$remain>\n"; |
cf655043 AW |
643 | push(@chunks, [ $condition, $statement ]); |
644 | if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { | |
645 | return ($level, $linenr, @chunks); | |
646 | } | |
647 | ||
648 | # Pull in the following conditional/block pairs and see if they | |
649 | # could continue the statement. | |
13214adf | 650 | for (;;) { |
13214adf AW |
651 | ($statement, $condition, $linenr, $remain, $off, $level) = |
652 | ctx_statement_block($linenr, $remain, $off); | |
cf655043 | 653 | #print "C: c<$condition> s<$statement> remain<$remain>\n"; |
773647a0 | 654 | last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); |
cf655043 AW |
655 | #print "C: push\n"; |
656 | push(@chunks, [ $condition, $statement ]); | |
13214adf AW |
657 | } |
658 | ||
659 | return ($level, $linenr, @chunks); | |
8905a67c AW |
660 | } |
661 | ||
4a0df2ef | 662 | sub ctx_block_get { |
f0a594c1 | 663 | my ($linenr, $remain, $outer, $open, $close, $off) = @_; |
4a0df2ef AW |
664 | my $line; |
665 | my $start = $linenr - 1; | |
4a0df2ef AW |
666 | my $blk = ''; |
667 | my @o; | |
668 | my @c; | |
669 | my @res = (); | |
670 | ||
f0a594c1 | 671 | my $level = 0; |
4635f4fb | 672 | my @stack = ($level); |
00df344f AW |
673 | for ($line = $start; $remain > 0; $line++) { |
674 | next if ($rawlines[$line] =~ /^-/); | |
675 | $remain--; | |
676 | ||
677 | $blk .= $rawlines[$line]; | |
4635f4fb AW |
678 | |
679 | # Handle nested #if/#else. | |
680 | if ($rawlines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { | |
681 | push(@stack, $level); | |
682 | } elsif ($rawlines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { | |
683 | $level = $stack[$#stack - 1]; | |
684 | } elsif ($rawlines[$line] =~ /^.\s*#\s*endif\b/) { | |
685 | $level = pop(@stack); | |
686 | } | |
687 | ||
f0a594c1 AW |
688 | foreach my $c (split(//, $rawlines[$line])) { |
689 | ##print "C<$c>L<$level><$open$close>O<$off>\n"; | |
690 | if ($off > 0) { | |
691 | $off--; | |
692 | next; | |
693 | } | |
4a0df2ef | 694 | |
f0a594c1 AW |
695 | if ($c eq $close && $level > 0) { |
696 | $level--; | |
697 | last if ($level == 0); | |
698 | } elsif ($c eq $open) { | |
699 | $level++; | |
700 | } | |
701 | } | |
4a0df2ef | 702 | |
f0a594c1 | 703 | if (!$outer || $level <= 1) { |
00df344f | 704 | push(@res, $rawlines[$line]); |
4a0df2ef AW |
705 | } |
706 | ||
f0a594c1 | 707 | last if ($level == 0); |
4a0df2ef AW |
708 | } |
709 | ||
f0a594c1 | 710 | return ($level, @res); |
4a0df2ef AW |
711 | } |
712 | sub ctx_block_outer { | |
713 | my ($linenr, $remain) = @_; | |
714 | ||
f0a594c1 AW |
715 | my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); |
716 | return @r; | |
4a0df2ef AW |
717 | } |
718 | sub ctx_block { | |
719 | my ($linenr, $remain) = @_; | |
720 | ||
f0a594c1 AW |
721 | my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); |
722 | return @r; | |
653d4876 AW |
723 | } |
724 | sub ctx_statement { | |
f0a594c1 AW |
725 | my ($linenr, $remain, $off) = @_; |
726 | ||
727 | my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); | |
728 | return @r; | |
729 | } | |
730 | sub ctx_block_level { | |
653d4876 AW |
731 | my ($linenr, $remain) = @_; |
732 | ||
f0a594c1 | 733 | return ctx_block_get($linenr, $remain, 0, '{', '}', 0); |
4a0df2ef | 734 | } |
9c0ca6f9 AW |
735 | sub ctx_statement_level { |
736 | my ($linenr, $remain, $off) = @_; | |
737 | ||
738 | return ctx_block_get($linenr, $remain, 0, '(', ')', $off); | |
739 | } | |
4a0df2ef AW |
740 | |
741 | sub ctx_locate_comment { | |
742 | my ($first_line, $end_line) = @_; | |
743 | ||
744 | # Catch a comment on the end of the line itself. | |
beae6332 | 745 | my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); |
4a0df2ef AW |
746 | return $current_comment if (defined $current_comment); |
747 | ||
748 | # Look through the context and try and figure out if there is a | |
749 | # comment. | |
750 | my $in_comment = 0; | |
751 | $current_comment = ''; | |
752 | for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { | |
00df344f AW |
753 | my $line = $rawlines[$linenr - 1]; |
754 | #warn " $line\n"; | |
4a0df2ef AW |
755 | if ($linenr == $first_line and $line =~ m@^.\s*\*@) { |
756 | $in_comment = 1; | |
757 | } | |
758 | if ($line =~ m@/\*@) { | |
759 | $in_comment = 1; | |
760 | } | |
761 | if (!$in_comment && $current_comment ne '') { | |
762 | $current_comment = ''; | |
763 | } | |
764 | $current_comment .= $line . "\n" if ($in_comment); | |
765 | if ($line =~ m@\*/@) { | |
766 | $in_comment = 0; | |
767 | } | |
768 | } | |
769 | ||
770 | chomp($current_comment); | |
771 | return($current_comment); | |
772 | } | |
773 | sub ctx_has_comment { | |
774 | my ($first_line, $end_line) = @_; | |
775 | my $cmt = ctx_locate_comment($first_line, $end_line); | |
776 | ||
00df344f | 777 | ##print "LINE: $rawlines[$end_line - 1 ]\n"; |
4a0df2ef AW |
778 | ##print "CMMT: $cmt\n"; |
779 | ||
780 | return ($cmt ne ''); | |
781 | } | |
782 | ||
4d001e4d AW |
783 | sub raw_line { |
784 | my ($linenr, $cnt) = @_; | |
785 | ||
786 | my $offset = $linenr - 1; | |
787 | $cnt++; | |
788 | ||
789 | my $line; | |
790 | while ($cnt) { | |
791 | $line = $rawlines[$offset++]; | |
792 | next if (defined($line) && $line =~ /^-/); | |
793 | $cnt--; | |
794 | } | |
795 | ||
796 | return $line; | |
797 | } | |
798 | ||
6c72ffaa AW |
799 | sub cat_vet { |
800 | my ($vet) = @_; | |
801 | my ($res, $coded); | |
9c0ca6f9 | 802 | |
6c72ffaa AW |
803 | $res = ''; |
804 | while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { | |
805 | $res .= $1; | |
806 | if ($2 ne '') { | |
807 | $coded = sprintf("^%c", unpack('C', $2) + 64); | |
808 | $res .= $coded; | |
9c0ca6f9 AW |
809 | } |
810 | } | |
6c72ffaa | 811 | $res =~ s/$/\$/; |
9c0ca6f9 | 812 | |
6c72ffaa | 813 | return $res; |
9c0ca6f9 AW |
814 | } |
815 | ||
c2fdda0d | 816 | my $av_preprocessor = 0; |
cf655043 | 817 | my $av_pending; |
c2fdda0d | 818 | my @av_paren_type; |
1f65f947 | 819 | my $av_pend_colon; |
c2fdda0d AW |
820 | |
821 | sub annotate_reset { | |
822 | $av_preprocessor = 0; | |
cf655043 AW |
823 | $av_pending = '_'; |
824 | @av_paren_type = ('E'); | |
1f65f947 | 825 | $av_pend_colon = 'O'; |
c2fdda0d AW |
826 | } |
827 | ||
6c72ffaa AW |
828 | sub annotate_values { |
829 | my ($stream, $type) = @_; | |
0a920b5b | 830 | |
6c72ffaa | 831 | my $res; |
1f65f947 | 832 | my $var = '_' x length($stream); |
6c72ffaa AW |
833 | my $cur = $stream; |
834 | ||
c2fdda0d | 835 | print "$stream\n" if ($dbg_values > 1); |
6c72ffaa | 836 | |
6c72ffaa | 837 | while (length($cur)) { |
773647a0 | 838 | @av_paren_type = ('E') if ($#av_paren_type < 0); |
cf655043 | 839 | print " <" . join('', @av_paren_type) . |
171ae1a4 | 840 | "> <$type> <$av_pending>" if ($dbg_values > 1); |
6c72ffaa | 841 | if ($cur =~ /^(\s+)/o) { |
c2fdda0d AW |
842 | print "WS($1)\n" if ($dbg_values > 1); |
843 | if ($1 =~ /\n/ && $av_preprocessor) { | |
cf655043 | 844 | $type = pop(@av_paren_type); |
c2fdda0d | 845 | $av_preprocessor = 0; |
6c72ffaa AW |
846 | } |
847 | ||
e91b6e26 | 848 | } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { |
c2fdda0d | 849 | print "DECLARE($1)\n" if ($dbg_values > 1); |
6c72ffaa AW |
850 | $type = 'T'; |
851 | ||
389a2fe5 AW |
852 | } elsif ($cur =~ /^($Modifier)\s*/) { |
853 | print "MODIFIER($1)\n" if ($dbg_values > 1); | |
854 | $type = 'T'; | |
855 | ||
c45dcabd | 856 | } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { |
171ae1a4 | 857 | print "DEFINE($1,$2)\n" if ($dbg_values > 1); |
c2fdda0d | 858 | $av_preprocessor = 1; |
171ae1a4 AW |
859 | push(@av_paren_type, $type); |
860 | if ($2 ne '') { | |
861 | $av_pending = 'N'; | |
862 | } | |
863 | $type = 'E'; | |
864 | ||
c45dcabd | 865 | } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { |
171ae1a4 AW |
866 | print "UNDEF($1)\n" if ($dbg_values > 1); |
867 | $av_preprocessor = 1; | |
868 | push(@av_paren_type, $type); | |
6c72ffaa | 869 | |
c45dcabd | 870 | } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { |
cf655043 | 871 | print "PRE_START($1)\n" if ($dbg_values > 1); |
c2fdda0d | 872 | $av_preprocessor = 1; |
cf655043 AW |
873 | |
874 | push(@av_paren_type, $type); | |
875 | push(@av_paren_type, $type); | |
171ae1a4 | 876 | $type = 'E'; |
cf655043 | 877 | |
c45dcabd | 878 | } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { |
cf655043 AW |
879 | print "PRE_RESTART($1)\n" if ($dbg_values > 1); |
880 | $av_preprocessor = 1; | |
881 | ||
882 | push(@av_paren_type, $av_paren_type[$#av_paren_type]); | |
883 | ||
171ae1a4 | 884 | $type = 'E'; |
cf655043 | 885 | |
c45dcabd | 886 | } elsif ($cur =~ /^(\#\s*(?:endif))/o) { |
cf655043 AW |
887 | print "PRE_END($1)\n" if ($dbg_values > 1); |
888 | ||
889 | $av_preprocessor = 1; | |
890 | ||
891 | # Assume all arms of the conditional end as this | |
892 | # one does, and continue as if the #endif was not here. | |
893 | pop(@av_paren_type); | |
894 | push(@av_paren_type, $type); | |
171ae1a4 | 895 | $type = 'E'; |
6c72ffaa AW |
896 | |
897 | } elsif ($cur =~ /^(\\\n)/o) { | |
c2fdda0d | 898 | print "PRECONT($1)\n" if ($dbg_values > 1); |
6c72ffaa | 899 | |
171ae1a4 AW |
900 | } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { |
901 | print "ATTR($1)\n" if ($dbg_values > 1); | |
902 | $av_pending = $type; | |
903 | $type = 'N'; | |
904 | ||
6c72ffaa | 905 | } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { |
c2fdda0d | 906 | print "SIZEOF($1)\n" if ($dbg_values > 1); |
6c72ffaa | 907 | if (defined $2) { |
cf655043 | 908 | $av_pending = 'V'; |
6c72ffaa AW |
909 | } |
910 | $type = 'N'; | |
911 | ||
14b111c1 | 912 | } elsif ($cur =~ /^(if|while|for)\b/o) { |
c2fdda0d | 913 | print "COND($1)\n" if ($dbg_values > 1); |
14b111c1 | 914 | $av_pending = 'E'; |
6c72ffaa AW |
915 | $type = 'N'; |
916 | ||
1f65f947 AW |
917 | } elsif ($cur =~/^(case)/o) { |
918 | print "CASE($1)\n" if ($dbg_values > 1); | |
919 | $av_pend_colon = 'C'; | |
920 | $type = 'N'; | |
921 | ||
14b111c1 | 922 | } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { |
c2fdda0d | 923 | print "KEYWORD($1)\n" if ($dbg_values > 1); |
6c72ffaa AW |
924 | $type = 'N'; |
925 | ||
926 | } elsif ($cur =~ /^(\()/o) { | |
c2fdda0d | 927 | print "PAREN('$1')\n" if ($dbg_values > 1); |
cf655043 AW |
928 | push(@av_paren_type, $av_pending); |
929 | $av_pending = '_'; | |
6c72ffaa AW |
930 | $type = 'N'; |
931 | ||
932 | } elsif ($cur =~ /^(\))/o) { | |
cf655043 AW |
933 | my $new_type = pop(@av_paren_type); |
934 | if ($new_type ne '_') { | |
935 | $type = $new_type; | |
c2fdda0d AW |
936 | print "PAREN('$1') -> $type\n" |
937 | if ($dbg_values > 1); | |
6c72ffaa | 938 | } else { |
c2fdda0d | 939 | print "PAREN('$1')\n" if ($dbg_values > 1); |
6c72ffaa AW |
940 | } |
941 | ||
c8cb2ca3 | 942 | } elsif ($cur =~ /^($Ident)\s*\(/o) { |
c2fdda0d | 943 | print "FUNC($1)\n" if ($dbg_values > 1); |
c8cb2ca3 | 944 | $type = 'V'; |
cf655043 | 945 | $av_pending = 'V'; |
6c72ffaa | 946 | |
8e761b04 AW |
947 | } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { |
948 | if (defined $2 && $type eq 'C' || $type eq 'T') { | |
1f65f947 | 949 | $av_pend_colon = 'B'; |
8e761b04 AW |
950 | } elsif ($type eq 'E') { |
951 | $av_pend_colon = 'L'; | |
1f65f947 AW |
952 | } |
953 | print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); | |
954 | $type = 'V'; | |
955 | ||
6c72ffaa | 956 | } elsif ($cur =~ /^($Ident|$Constant)/o) { |
c2fdda0d | 957 | print "IDENT($1)\n" if ($dbg_values > 1); |
6c72ffaa AW |
958 | $type = 'V'; |
959 | ||
960 | } elsif ($cur =~ /^($Assignment)/o) { | |
c2fdda0d | 961 | print "ASSIGN($1)\n" if ($dbg_values > 1); |
6c72ffaa AW |
962 | $type = 'N'; |
963 | ||
cf655043 | 964 | } elsif ($cur =~/^(;|{|})/) { |
c2fdda0d | 965 | print "END($1)\n" if ($dbg_values > 1); |
13214adf | 966 | $type = 'E'; |
1f65f947 AW |
967 | $av_pend_colon = 'O'; |
968 | ||
8e761b04 AW |
969 | } elsif ($cur =~/^(,)/) { |
970 | print "COMMA($1)\n" if ($dbg_values > 1); | |
971 | $type = 'C'; | |
972 | ||
1f65f947 AW |
973 | } elsif ($cur =~ /^(\?)/o) { |
974 | print "QUESTION($1)\n" if ($dbg_values > 1); | |
975 | $type = 'N'; | |
976 | ||
977 | } elsif ($cur =~ /^(:)/o) { | |
978 | print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); | |
979 | ||
980 | substr($var, length($res), 1, $av_pend_colon); | |
981 | if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { | |
982 | $type = 'E'; | |
983 | } else { | |
984 | $type = 'N'; | |
985 | } | |
986 | $av_pend_colon = 'O'; | |
13214adf | 987 | |
8e761b04 | 988 | } elsif ($cur =~ /^(\[)/o) { |
13214adf | 989 | print "CLOSE($1)\n" if ($dbg_values > 1); |
6c72ffaa AW |
990 | $type = 'N'; |
991 | ||
0d413866 | 992 | } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { |
74048ed8 AW |
993 | my $variant; |
994 | ||
995 | print "OPV($1)\n" if ($dbg_values > 1); | |
996 | if ($type eq 'V') { | |
997 | $variant = 'B'; | |
998 | } else { | |
999 | $variant = 'U'; | |
1000 | } | |
1001 | ||
1002 | substr($var, length($res), 1, $variant); | |
1003 | $type = 'N'; | |
1004 | ||
6c72ffaa | 1005 | } elsif ($cur =~ /^($Operators)/o) { |
c2fdda0d | 1006 | print "OP($1)\n" if ($dbg_values > 1); |
6c72ffaa AW |
1007 | if ($1 ne '++' && $1 ne '--') { |
1008 | $type = 'N'; | |
1009 | } | |
1010 | ||
1011 | } elsif ($cur =~ /(^.)/o) { | |
c2fdda0d | 1012 | print "C($1)\n" if ($dbg_values > 1); |
6c72ffaa AW |
1013 | } |
1014 | if (defined $1) { | |
1015 | $cur = substr($cur, length($1)); | |
1016 | $res .= $type x length($1); | |
1017 | } | |
9c0ca6f9 | 1018 | } |
0a920b5b | 1019 | |
1f65f947 | 1020 | return ($res, $var); |
0a920b5b AW |
1021 | } |
1022 | ||
8905a67c | 1023 | sub possible { |
13214adf | 1024 | my ($possible, $line) = @_; |
9a974fdb | 1025 | my $notPermitted = qr{(?: |
0776e594 AW |
1026 | ^(?: |
1027 | $Modifier| | |
1028 | $Storage| | |
1029 | $Type| | |
9a974fdb AW |
1030 | DEFINE_\S+ |
1031 | )$| | |
1032 | ^(?: | |
0776e594 AW |
1033 | goto| |
1034 | return| | |
1035 | case| | |
1036 | else| | |
1037 | asm|__asm__| | |
1038 | do | |
9a974fdb | 1039 | )(?:\s|$)| |
0776e594 | 1040 | ^(?:typedef|struct|enum)\b |
9a974fdb AW |
1041 | )}x; |
1042 | warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); | |
1043 | if ($possible !~ $notPermitted) { | |
c45dcabd AW |
1044 | # Check for modifiers. |
1045 | $possible =~ s/\s*$Storage\s*//g; | |
1046 | $possible =~ s/\s*$Sparse\s*//g; | |
1047 | if ($possible =~ /^\s*$/) { | |
1048 | ||
1049 | } elsif ($possible =~ /\s/) { | |
1050 | $possible =~ s/\s*$Type\s*//g; | |
d2506586 | 1051 | for my $modifier (split(' ', $possible)) { |
9a974fdb AW |
1052 | if ($modifier !~ $notPermitted) { |
1053 | warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); | |
1054 | push(@modifierList, $modifier); | |
1055 | } | |
d2506586 | 1056 | } |
c45dcabd AW |
1057 | |
1058 | } else { | |
1059 | warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); | |
1060 | push(@typeList, $possible); | |
1061 | } | |
8905a67c | 1062 | build_types(); |
0776e594 AW |
1063 | } else { |
1064 | warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); | |
8905a67c AW |
1065 | } |
1066 | } | |
1067 | ||
6c72ffaa AW |
1068 | my $prefix = ''; |
1069 | ||
f0a594c1 | 1070 | sub report { |
773647a0 AW |
1071 | if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) { |
1072 | return 0; | |
1073 | } | |
8905a67c AW |
1074 | my $line = $prefix . $_[0]; |
1075 | ||
1076 | $line = (split('\n', $line))[0] . "\n" if ($terse); | |
1077 | ||
13214adf | 1078 | push(our @report, $line); |
773647a0 AW |
1079 | |
1080 | return 1; | |
f0a594c1 AW |
1081 | } |
1082 | sub report_dump { | |
13214adf | 1083 | our @report; |
f0a594c1 | 1084 | } |
de7d4f0e | 1085 | sub ERROR { |
773647a0 AW |
1086 | if (report("ERROR: $_[0]\n")) { |
1087 | our $clean = 0; | |
1088 | our $cnt_error++; | |
1089 | } | |
de7d4f0e AW |
1090 | } |
1091 | sub WARN { | |
773647a0 AW |
1092 | if (report("WARNING: $_[0]\n")) { |
1093 | our $clean = 0; | |
1094 | our $cnt_warn++; | |
1095 | } | |
de7d4f0e AW |
1096 | } |
1097 | sub CHK { | |
773647a0 | 1098 | if ($check && report("CHECK: $_[0]\n")) { |
6c72ffaa AW |
1099 | our $clean = 0; |
1100 | our $cnt_chk++; | |
1101 | } | |
de7d4f0e AW |
1102 | } |
1103 | ||
6ecd9674 AW |
1104 | sub check_absolute_file { |
1105 | my ($absolute, $herecurr) = @_; | |
1106 | my $file = $absolute; | |
1107 | ||
1108 | ##print "absolute<$absolute>\n"; | |
1109 | ||
1110 | # See if any suffix of this path is a path within the tree. | |
1111 | while ($file =~ s@^[^/]*/@@) { | |
1112 | if (-f "$root/$file") { | |
1113 | ##print "file<$file>\n"; | |
1114 | last; | |
1115 | } | |
1116 | } | |
1117 | if (! -f _) { | |
1118 | return 0; | |
1119 | } | |
1120 | ||
1121 | # It is, so see if the prefix is acceptable. | |
1122 | my $prefix = $absolute; | |
1123 | substr($prefix, -length($file)) = ''; | |
1124 | ||
1125 | ##print "prefix<$prefix>\n"; | |
1126 | if ($prefix ne ".../") { | |
1127 | WARN("use relative pathname instead of absolute in changelog text\n" . $herecurr); | |
1128 | } | |
1129 | } | |
1130 | ||
0a920b5b AW |
1131 | sub process { |
1132 | my $filename = shift; | |
0a920b5b AW |
1133 | |
1134 | my $linenr=0; | |
1135 | my $prevline=""; | |
c2fdda0d | 1136 | my $prevrawline=""; |
0a920b5b | 1137 | my $stashline=""; |
c2fdda0d | 1138 | my $stashrawline=""; |
0a920b5b | 1139 | |
4a0df2ef | 1140 | my $length; |
0a920b5b AW |
1141 | my $indent; |
1142 | my $previndent=0; | |
1143 | my $stashindent=0; | |
1144 | ||
de7d4f0e | 1145 | our $clean = 1; |
0a920b5b AW |
1146 | my $signoff = 0; |
1147 | my $is_patch = 0; | |
1148 | ||
13214adf | 1149 | our @report = (); |
6c72ffaa AW |
1150 | our $cnt_lines = 0; |
1151 | our $cnt_error = 0; | |
1152 | our $cnt_warn = 0; | |
1153 | our $cnt_chk = 0; | |
1154 | ||
0a920b5b AW |
1155 | # Trace the real file/line as we go. |
1156 | my $realfile = ''; | |
1157 | my $realline = 0; | |
1158 | my $realcnt = 0; | |
1159 | my $here = ''; | |
1160 | my $in_comment = 0; | |
c2fdda0d | 1161 | my $comment_edge = 0; |
0a920b5b | 1162 | my $first_line = 0; |
1e855726 | 1163 | my $p1_prefix = ''; |
0a920b5b | 1164 | |
13214adf AW |
1165 | my $prev_values = 'E'; |
1166 | ||
1167 | # suppression flags | |
773647a0 | 1168 | my %suppress_ifbraces; |
170d3a22 | 1169 | my %suppress_whiletrailers; |
2b474a1a | 1170 | my %suppress_export; |
653d4876 | 1171 | |
c2fdda0d | 1172 | # Pre-scan the patch sanitizing the lines. |
de7d4f0e | 1173 | # Pre-scan the patch looking for any __setup documentation. |
c2fdda0d | 1174 | # |
de7d4f0e AW |
1175 | my @setup_docs = (); |
1176 | my $setup_docs = 0; | |
773647a0 AW |
1177 | |
1178 | sanitise_line_reset(); | |
c2fdda0d AW |
1179 | my $line; |
1180 | foreach my $rawline (@rawlines) { | |
773647a0 AW |
1181 | $linenr++; |
1182 | $line = $rawline; | |
c2fdda0d | 1183 | |
773647a0 | 1184 | if ($rawline=~/^\+\+\+\s+(\S+)/) { |
de7d4f0e AW |
1185 | $setup_docs = 0; |
1186 | if ($1 =~ m@Documentation/kernel-parameters.txt$@) { | |
1187 | $setup_docs = 1; | |
1188 | } | |
773647a0 AW |
1189 | #next; |
1190 | } | |
1191 | if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { | |
1192 | $realline=$1-1; | |
1193 | if (defined $2) { | |
1194 | $realcnt=$3+1; | |
1195 | } else { | |
1196 | $realcnt=1+1; | |
1197 | } | |
c45dcabd | 1198 | $in_comment = 0; |
773647a0 AW |
1199 | |
1200 | # Guestimate if this is a continuing comment. Run | |
1201 | # the context looking for a comment "edge". If this | |
1202 | # edge is a close comment then we must be in a comment | |
1203 | # at context start. | |
1204 | my $edge; | |
01fa9147 AW |
1205 | my $cnt = $realcnt; |
1206 | for (my $ln = $linenr + 1; $cnt > 0; $ln++) { | |
1207 | next if (defined $rawlines[$ln - 1] && | |
1208 | $rawlines[$ln - 1] =~ /^-/); | |
1209 | $cnt--; | |
1210 | #print "RAW<$rawlines[$ln - 1]>\n"; | |
721c1cb6 | 1211 | last if (!defined $rawlines[$ln - 1]); |
fae17dae AW |
1212 | if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && |
1213 | $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { | |
1214 | ($edge) = $1; | |
1215 | last; | |
1216 | } | |
773647a0 AW |
1217 | } |
1218 | if (defined $edge && $edge eq '*/') { | |
1219 | $in_comment = 1; | |
1220 | } | |
1221 | ||
1222 | # Guestimate if this is a continuing comment. If this | |
1223 | # is the start of a diff block and this line starts | |
1224 | # ' *' then it is very likely a comment. | |
1225 | if (!defined $edge && | |
83242e0c | 1226 | $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) |
773647a0 AW |
1227 | { |
1228 | $in_comment = 1; | |
1229 | } | |
1230 | ||
1231 | ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; | |
1232 | sanitise_line_reset($in_comment); | |
1233 | ||
171ae1a4 | 1234 | } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { |
773647a0 | 1235 | # Standardise the strings and chars within the input to |
171ae1a4 | 1236 | # simplify matching -- only bother with positive lines. |
773647a0 | 1237 | $line = sanitise_line($rawline); |
de7d4f0e | 1238 | } |
773647a0 AW |
1239 | push(@lines, $line); |
1240 | ||
1241 | if ($realcnt > 1) { | |
1242 | $realcnt-- if ($line =~ /^(?:\+| |$)/); | |
1243 | } else { | |
1244 | $realcnt = 0; | |
1245 | } | |
1246 | ||
1247 | #print "==>$rawline\n"; | |
1248 | #print "-->$line\n"; | |
de7d4f0e AW |
1249 | |
1250 | if ($setup_docs && $line =~ /^\+/) { | |
1251 | push(@setup_docs, $line); | |
1252 | } | |
1253 | } | |
1254 | ||
6c72ffaa AW |
1255 | $prefix = ''; |
1256 | ||
773647a0 AW |
1257 | $realcnt = 0; |
1258 | $linenr = 0; | |
0a920b5b AW |
1259 | foreach my $line (@lines) { |
1260 | $linenr++; | |
1261 | ||
c2fdda0d | 1262 | my $rawline = $rawlines[$linenr - 1]; |
6c72ffaa | 1263 | |
0a920b5b | 1264 | #extract the line range in the file after the patch is applied |
6c72ffaa | 1265 | if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { |
0a920b5b | 1266 | $is_patch = 1; |
4a0df2ef | 1267 | $first_line = $linenr + 1; |
0a920b5b AW |
1268 | $realline=$1-1; |
1269 | if (defined $2) { | |
1270 | $realcnt=$3+1; | |
1271 | } else { | |
1272 | $realcnt=1+1; | |
1273 | } | |
c2fdda0d | 1274 | annotate_reset(); |
13214adf AW |
1275 | $prev_values = 'E'; |
1276 | ||
773647a0 | 1277 | %suppress_ifbraces = (); |
170d3a22 | 1278 | %suppress_whiletrailers = (); |
2b474a1a | 1279 | %suppress_export = (); |
0a920b5b | 1280 | next; |
0a920b5b | 1281 | |
4a0df2ef AW |
1282 | # track the line number as we move through the hunk, note that |
1283 | # new versions of GNU diff omit the leading space on completely | |
1284 | # blank context lines so we need to count that too. | |
773647a0 | 1285 | } elsif ($line =~ /^( |\+|$)/) { |
0a920b5b | 1286 | $realline++; |
d8aaf121 | 1287 | $realcnt-- if ($realcnt != 0); |
0a920b5b | 1288 | |
4a0df2ef | 1289 | # Measure the line length and indent. |
c2fdda0d | 1290 | ($length, $indent) = line_stats($rawline); |
0a920b5b AW |
1291 | |
1292 | # Track the previous line. | |
1293 | ($prevline, $stashline) = ($stashline, $line); | |
1294 | ($previndent, $stashindent) = ($stashindent, $indent); | |
c2fdda0d AW |
1295 | ($prevrawline, $stashrawline) = ($stashrawline, $rawline); |
1296 | ||
773647a0 | 1297 | #warn "line<$line>\n"; |
6c72ffaa | 1298 | |
d8aaf121 AW |
1299 | } elsif ($realcnt == 1) { |
1300 | $realcnt--; | |
0a920b5b AW |
1301 | } |
1302 | ||
cc77cdca AW |
1303 | my $hunk_line = ($realcnt != 0); |
1304 | ||
0a920b5b | 1305 | #make up the handle for any error we report on this line |
773647a0 AW |
1306 | $prefix = "$filename:$realline: " if ($emacs && $file); |
1307 | $prefix = "$filename:$linenr: " if ($emacs && !$file); | |
1308 | ||
6c72ffaa AW |
1309 | $here = "#$linenr: " if (!$file); |
1310 | $here = "#$realline: " if ($file); | |
773647a0 AW |
1311 | |
1312 | # extract the filename as it passes | |
1313 | if ($line=~/^\+\+\+\s+(\S+)/) { | |
1314 | $realfile = $1; | |
1e855726 WS |
1315 | $realfile =~ s@^([^/]*)/@@; |
1316 | ||
1317 | $p1_prefix = $1; | |
e2f7aa4b AW |
1318 | if (!$file && $tree && $p1_prefix ne '' && |
1319 | -e "$root/$p1_prefix") { | |
1e855726 WS |
1320 | WARN("patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); |
1321 | } | |
773647a0 | 1322 | |
c1ab3326 | 1323 | if ($realfile =~ m@^include/asm/@) { |
773647a0 AW |
1324 | ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); |
1325 | } | |
1326 | next; | |
1327 | } | |
1328 | ||
389834b6 | 1329 | $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); |
0a920b5b | 1330 | |
c2fdda0d AW |
1331 | my $hereline = "$here\n$rawline\n"; |
1332 | my $herecurr = "$here\n$rawline\n"; | |
1333 | my $hereprev = "$here\n$prevrawline\n$rawline\n"; | |
0a920b5b | 1334 | |
6c72ffaa AW |
1335 | $cnt_lines++ if ($realcnt != 0); |
1336 | ||
0a920b5b | 1337 | #check the patch for a signoff: |
d8aaf121 | 1338 | if ($line =~ /^\s*signed-off-by:/i) { |
4a0df2ef AW |
1339 | # This is a signoff, if ugly, so do not double report. |
1340 | $signoff++; | |
0a920b5b | 1341 | if (!($line =~ /^\s*Signed-off-by:/)) { |
de7d4f0e AW |
1342 | WARN("Signed-off-by: is the preferred form\n" . |
1343 | $herecurr); | |
0a920b5b AW |
1344 | } |
1345 | if ($line =~ /^\s*signed-off-by:\S/i) { | |
773647a0 | 1346 | WARN("space required after Signed-off-by:\n" . |
de7d4f0e | 1347 | $herecurr); |
0a920b5b AW |
1348 | } |
1349 | } | |
1350 | ||
00df344f | 1351 | # Check for wrappage within a valid hunk of the file |
8905a67c | 1352 | if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { |
de7d4f0e | 1353 | ERROR("patch seems to be corrupt (line wrapped?)\n" . |
6c72ffaa | 1354 | $herecurr) if (!$emitted_corrupt++); |
de7d4f0e AW |
1355 | } |
1356 | ||
6ecd9674 AW |
1357 | # Check for absolute kernel paths. |
1358 | if ($tree) { | |
1359 | while ($line =~ m{(?:^|\s)(/\S*)}g) { | |
1360 | my $file = $1; | |
1361 | ||
1362 | if ($file =~ m{^(.*?)(?::\d+)+:?$} && | |
1363 | check_absolute_file($1, $herecurr)) { | |
1364 | # | |
1365 | } else { | |
1366 | check_absolute_file($file, $herecurr); | |
1367 | } | |
1368 | } | |
1369 | } | |
1370 | ||
de7d4f0e AW |
1371 | # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php |
1372 | if (($realfile =~ /^$/ || $line =~ /^\+/) && | |
171ae1a4 AW |
1373 | $rawline !~ m/^$UTF8*$/) { |
1374 | my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); | |
1375 | ||
1376 | my $blank = copy_spacing($rawline); | |
1377 | my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; | |
1378 | my $hereptr = "$hereline$ptr\n"; | |
1379 | ||
1380 | ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); | |
00df344f AW |
1381 | } |
1382 | ||
30670854 AW |
1383 | # ignore non-hunk lines and lines being removed |
1384 | next if (!$hunk_line || $line =~ /^-/); | |
0a920b5b | 1385 | |
0a920b5b | 1386 | #trailing whitespace |
9c0ca6f9 | 1387 | if ($line =~ /^\+.*\015/) { |
c2fdda0d | 1388 | my $herevet = "$here\n" . cat_vet($rawline) . "\n"; |
9c0ca6f9 AW |
1389 | ERROR("DOS line endings\n" . $herevet); |
1390 | ||
c2fdda0d AW |
1391 | } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { |
1392 | my $herevet = "$here\n" . cat_vet($rawline) . "\n"; | |
de7d4f0e | 1393 | ERROR("trailing whitespace\n" . $herevet); |
d2c0a235 | 1394 | $rpt_cleaners = 1; |
0a920b5b | 1395 | } |
5368df20 | 1396 | |
3354957a AK |
1397 | # check for Kconfig help text having a real description |
1398 | if ($realfile =~ /Kconfig/ && | |
1399 | $line =~ /\+?\s*(---)?help(---)?$/) { | |
1400 | my $length = 0; | |
1401 | for (my $l = $linenr; defined($lines[$l]); $l++) { | |
1402 | my $f = $lines[$l]; | |
1403 | $f =~ s/#.*//; | |
1404 | $f =~ s/^\s+//; | |
1405 | next if ($f =~ /^$/); | |
1406 | last if ($f =~ /^\s*config\s/); | |
1407 | $length++; | |
1408 | } | |
1409 | WARN("please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($length < 4); | |
1410 | } | |
1411 | ||
5368df20 AW |
1412 | # check we are in a valid source file if not then ignore this hunk |
1413 | next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/); | |
1414 | ||
0a920b5b | 1415 | #80 column limit |
c45dcabd | 1416 | if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ && |
f4c014c0 | 1417 | $rawline !~ /^.\s*\*\s*\@$Ident\s/ && |
8bbea968 JP |
1418 | !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ || |
1419 | $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) && | |
f4c014c0 | 1420 | $length > 80) |
c45dcabd | 1421 | { |
de7d4f0e | 1422 | WARN("line over 80 characters\n" . $herecurr); |
0a920b5b AW |
1423 | } |
1424 | ||
5e79d96e JP |
1425 | # check for spaces before a quoted newline |
1426 | if ($rawline =~ /^.*\".*\s\\n/) { | |
1427 | WARN("unnecessary whitespace before a quoted newline\n" . $herecurr); | |
1428 | } | |
1429 | ||
8905a67c AW |
1430 | # check for adding lines without a newline. |
1431 | if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { | |
1432 | WARN("adding a line without newline at end of file\n" . $herecurr); | |
1433 | } | |
1434 | ||
42e41c54 MF |
1435 | # Blackfin: use hi/lo macros |
1436 | if ($realfile =~ m@arch/blackfin/.*\.S$@) { | |
1437 | if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { | |
1438 | my $herevet = "$here\n" . cat_vet($line) . "\n"; | |
1439 | ERROR("use the LO() macro, not (... & 0xFFFF)\n" . $herevet); | |
1440 | } | |
1441 | if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { | |
1442 | my $herevet = "$here\n" . cat_vet($line) . "\n"; | |
1443 | ERROR("use the HI() macro, not (... >> 16)\n" . $herevet); | |
1444 | } | |
1445 | } | |
1446 | ||
b9ea10d6 AW |
1447 | # check we are in a valid source file C or perl if not then ignore this hunk |
1448 | next if ($realfile !~ /\.(h|c|pl)$/); | |
0a920b5b AW |
1449 | |
1450 | # at the beginning of a line any tabs must come first and anything | |
1451 | # more than 8 must use tabs. | |
c2fdda0d AW |
1452 | if ($rawline =~ /^\+\s* \t\s*\S/ || |
1453 | $rawline =~ /^\+\s* \s*/) { | |
1454 | my $herevet = "$here\n" . cat_vet($rawline) . "\n"; | |
171ae1a4 | 1455 | ERROR("code indent should use tabs where possible\n" . $herevet); |
d2c0a235 | 1456 | $rpt_cleaners = 1; |
0a920b5b AW |
1457 | } |
1458 | ||
08e44365 AP |
1459 | # check for space before tabs. |
1460 | if ($rawline =~ /^\+/ && $rawline =~ / \t/) { | |
1461 | my $herevet = "$here\n" . cat_vet($rawline) . "\n"; | |
1462 | WARN("please, no space before tabs\n" . $herevet); | |
1463 | } | |
1464 | ||
5f7ddae6 | 1465 | # check for spaces at the beginning of a line. |
6b4c5beb AW |
1466 | # Exceptions: |
1467 | # 1) within comments | |
1468 | # 2) indented preprocessor commands | |
1469 | # 3) hanging labels | |
1470 | if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/) { | |
5f7ddae6 | 1471 | my $herevet = "$here\n" . cat_vet($rawline) . "\n"; |
6b4c5beb | 1472 | WARN("please, no spaces at the start of a line\n" . $herevet); |
5f7ddae6 RR |
1473 | } |
1474 | ||
b9ea10d6 AW |
1475 | # check we are in a valid C source file if not then ignore this hunk |
1476 | next if ($realfile !~ /\.(h|c)$/); | |
1477 | ||
c2fdda0d | 1478 | # check for RCS/CVS revision markers |
cf655043 | 1479 | if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { |
c2fdda0d AW |
1480 | WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr); |
1481 | } | |
22f2a2ef | 1482 | |
42e41c54 MF |
1483 | # Blackfin: don't use __builtin_bfin_[cs]sync |
1484 | if ($line =~ /__builtin_bfin_csync/) { | |
1485 | my $herevet = "$here\n" . cat_vet($line) . "\n"; | |
1486 | ERROR("use the CSYNC() macro in asm/blackfin.h\n" . $herevet); | |
1487 | } | |
1488 | if ($line =~ /__builtin_bfin_ssync/) { | |
1489 | my $herevet = "$here\n" . cat_vet($line) . "\n"; | |
1490 | ERROR("use the SSYNC() macro in asm/blackfin.h\n" . $herevet); | |
1491 | } | |
1492 | ||
9c0ca6f9 | 1493 | # Check for potential 'bare' types |
2b474a1a AW |
1494 | my ($stat, $cond, $line_nr_next, $remain_next, $off_next, |
1495 | $realline_next); | |
9c9ba34e | 1496 | if ($realcnt && $line =~ /.\s*\S/) { |
170d3a22 | 1497 | ($stat, $cond, $line_nr_next, $remain_next, $off_next) = |
f5fe35dd | 1498 | ctx_statement_block($linenr, $realcnt, 0); |
171ae1a4 AW |
1499 | $stat =~ s/\n./\n /g; |
1500 | $cond =~ s/\n./\n /g; | |
1501 | ||
2b474a1a AW |
1502 | # Find the real next line. |
1503 | $realline_next = $line_nr_next; | |
1504 | if (defined $realline_next && | |
1505 | (!defined $lines[$realline_next - 1] || | |
1506 | substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { | |
1507 | $realline_next++; | |
1508 | } | |
1509 | ||
171ae1a4 AW |
1510 | my $s = $stat; |
1511 | $s =~ s/{.*$//s; | |
cf655043 | 1512 | |
c2fdda0d | 1513 | # Ignore goto labels. |
171ae1a4 | 1514 | if ($s =~ /$Ident:\*$/s) { |
c2fdda0d AW |
1515 | |
1516 | # Ignore functions being called | |
171ae1a4 | 1517 | } elsif ($s =~ /^.\s*$Ident\s*\(/s) { |
c2fdda0d | 1518 | |
463f2864 AW |
1519 | } elsif ($s =~ /^.\s*else\b/s) { |
1520 | ||
c45dcabd | 1521 | # declarations always start with types |
d2506586 | 1522 | } elsif ($prev_values eq 'E' && $s =~ /^.\s*(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?((?:\s*$Ident)+?)\b(?:\s+$Sparse)?\s*\**\s*(?:$Ident|\(\*[^\)]*\))(?:\s*$Modifier)?\s*(?:;|=|,|\()/s) { |
c45dcabd AW |
1523 | my $type = $1; |
1524 | $type =~ s/\s+/ /g; | |
1525 | possible($type, "A:" . $s); | |
1526 | ||
8905a67c | 1527 | # definitions in global scope can only start with types |
a6a84062 | 1528 | } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { |
c45dcabd | 1529 | possible($1, "B:" . $s); |
c2fdda0d | 1530 | } |
8905a67c AW |
1531 | |
1532 | # any (foo ... *) is a pointer cast, and foo is a type | |
65863862 | 1533 | while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { |
c45dcabd | 1534 | possible($1, "C:" . $s); |
8905a67c AW |
1535 | } |
1536 | ||
1537 | # Check for any sort of function declaration. | |
1538 | # int foo(something bar, other baz); | |
1539 | # void (*store_gdt)(x86_descr_ptr *); | |
171ae1a4 | 1540 | if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { |
8905a67c | 1541 | my ($name_len) = length($1); |
8905a67c | 1542 | |
cf655043 | 1543 | my $ctx = $s; |
773647a0 | 1544 | substr($ctx, 0, $name_len + 1, ''); |
8905a67c | 1545 | $ctx =~ s/\)[^\)]*$//; |
cf655043 | 1546 | |
8905a67c | 1547 | for my $arg (split(/\s*,\s*/, $ctx)) { |
c45dcabd | 1548 | if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { |
8905a67c | 1549 | |
c45dcabd | 1550 | possible($1, "D:" . $s); |
8905a67c AW |
1551 | } |
1552 | } | |
9c0ca6f9 | 1553 | } |
8905a67c | 1554 | |
9c0ca6f9 AW |
1555 | } |
1556 | ||
653d4876 AW |
1557 | # |
1558 | # Checks which may be anchored in the context. | |
1559 | # | |
00df344f | 1560 | |
653d4876 AW |
1561 | # Check for switch () and associated case and default |
1562 | # statements should be at the same indent. | |
00df344f AW |
1563 | if ($line=~/\bswitch\s*\(.*\)/) { |
1564 | my $err = ''; | |
1565 | my $sep = ''; | |
1566 | my @ctx = ctx_block_outer($linenr, $realcnt); | |
1567 | shift(@ctx); | |
1568 | for my $ctx (@ctx) { | |
1569 | my ($clen, $cindent) = line_stats($ctx); | |
1570 | if ($ctx =~ /^\+\s*(case\s+|default:)/ && | |
1571 | $indent != $cindent) { | |
1572 | $err .= "$sep$ctx\n"; | |
1573 | $sep = ''; | |
1574 | } else { | |
1575 | $sep = "[...]\n"; | |
1576 | } | |
1577 | } | |
1578 | if ($err ne '') { | |
9c0ca6f9 | 1579 | ERROR("switch and case should be at the same indent\n$hereline$err"); |
de7d4f0e AW |
1580 | } |
1581 | } | |
1582 | ||
1583 | # if/while/etc brace do not go on next line, unless defining a do while loop, | |
1584 | # or if that brace on the next line is for something else | |
c45dcabd | 1585 | if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { |
773647a0 AW |
1586 | my $pre_ctx = "$1$2"; |
1587 | ||
9c0ca6f9 | 1588 | my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); |
de7d4f0e AW |
1589 | my $ctx_cnt = $realcnt - $#ctx - 1; |
1590 | my $ctx = join("\n", @ctx); | |
1591 | ||
548596d5 AW |
1592 | my $ctx_ln = $linenr; |
1593 | my $ctx_skip = $realcnt; | |
773647a0 | 1594 | |
548596d5 AW |
1595 | while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && |
1596 | defined $lines[$ctx_ln - 1] && | |
1597 | $lines[$ctx_ln - 1] =~ /^-/)) { | |
1598 | ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; | |
1599 | $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); | |
de7d4f0e | 1600 | $ctx_ln++; |
de7d4f0e | 1601 | } |
548596d5 | 1602 | |
53210168 AW |
1603 | #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; |
1604 | #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; | |
de7d4f0e | 1605 | |
773647a0 AW |
1606 | if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { |
1607 | ERROR("that open brace { should be on the previous line\n" . | |
c45dcabd | 1608 | "$here\n$ctx\n$lines[$ctx_ln - 1]\n"); |
00df344f | 1609 | } |
773647a0 AW |
1610 | if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && |
1611 | $ctx =~ /\)\s*\;\s*$/ && | |
1612 | defined $lines[$ctx_ln - 1]) | |
1613 | { | |
9c0ca6f9 AW |
1614 | my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); |
1615 | if ($nindent > $indent) { | |
773647a0 | 1616 | WARN("trailing semicolon indicates no statements, indent implies otherwise\n" . |
c45dcabd | 1617 | "$here\n$ctx\n$lines[$ctx_ln - 1]\n"); |
9c0ca6f9 AW |
1618 | } |
1619 | } | |
00df344f AW |
1620 | } |
1621 | ||
4d001e4d AW |
1622 | # Check relative indent for conditionals and blocks. |
1623 | if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { | |
1624 | my ($s, $c) = ($stat, $cond); | |
1625 | ||
1626 | substr($s, 0, length($c), ''); | |
1627 | ||
1628 | # Make sure we remove the line prefixes as we have | |
1629 | # none on the first line, and are going to readd them | |
1630 | # where necessary. | |
1631 | $s =~ s/\n./\n/gs; | |
1632 | ||
1633 | # Find out how long the conditional actually is. | |
6f779c18 AW |
1634 | my @newlines = ($c =~ /\n/gs); |
1635 | my $cond_lines = 1 + $#newlines; | |
4d001e4d AW |
1636 | |
1637 | # We want to check the first line inside the block | |
1638 | # starting at the end of the conditional, so remove: | |
1639 | # 1) any blank line termination | |
1640 | # 2) any opening brace { on end of the line | |
1641 | # 3) any do (...) { | |
1642 | my $continuation = 0; | |
1643 | my $check = 0; | |
1644 | $s =~ s/^.*\bdo\b//; | |
1645 | $s =~ s/^\s*{//; | |
1646 | if ($s =~ s/^\s*\\//) { | |
1647 | $continuation = 1; | |
1648 | } | |
9bd49efe | 1649 | if ($s =~ s/^\s*?\n//) { |
4d001e4d AW |
1650 | $check = 1; |
1651 | $cond_lines++; | |
1652 | } | |
1653 | ||
1654 | # Also ignore a loop construct at the end of a | |
1655 | # preprocessor statement. | |
1656 | if (($prevline =~ /^.\s*#\s*define\s/ || | |
1657 | $prevline =~ /\\\s*$/) && $continuation == 0) { | |
1658 | $check = 0; | |
1659 | } | |
1660 | ||
9bd49efe | 1661 | my $cond_ptr = -1; |
740504c6 | 1662 | $continuation = 0; |
9bd49efe AW |
1663 | while ($cond_ptr != $cond_lines) { |
1664 | $cond_ptr = $cond_lines; | |
1665 | ||
f16fa28f AW |
1666 | # If we see an #else/#elif then the code |
1667 | # is not linear. | |
1668 | if ($s =~ /^\s*\#\s*(?:else|elif)/) { | |
1669 | $check = 0; | |
1670 | } | |
1671 | ||
9bd49efe AW |
1672 | # Ignore: |
1673 | # 1) blank lines, they should be at 0, | |
1674 | # 2) preprocessor lines, and | |
1675 | # 3) labels. | |
740504c6 AW |
1676 | if ($continuation || |
1677 | $s =~ /^\s*?\n/ || | |
9bd49efe AW |
1678 | $s =~ /^\s*#\s*?/ || |
1679 | $s =~ /^\s*$Ident\s*:/) { | |
740504c6 | 1680 | $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; |
30dad6eb AW |
1681 | if ($s =~ s/^.*?\n//) { |
1682 | $cond_lines++; | |
1683 | } | |
9bd49efe | 1684 | } |
4d001e4d AW |
1685 | } |
1686 | ||
1687 | my (undef, $sindent) = line_stats("+" . $s); | |
1688 | my $stat_real = raw_line($linenr, $cond_lines); | |
1689 | ||
1690 | # Check if either of these lines are modified, else | |
1691 | # this is not this patch's fault. | |
1692 | if (!defined($stat_real) || | |
1693 | $stat !~ /^\+/ && $stat_real !~ /^\+/) { | |
1694 | $check = 0; | |
1695 | } | |
1696 | if (defined($stat_real) && $cond_lines > 1) { | |
1697 | $stat_real = "[...]\n$stat_real"; | |
1698 | } | |
1699 | ||
9bd49efe | 1700 | #print "line<$line> prevline<$prevline> indent<$indent> sindent<$sindent> check<$check> continuation<$continuation> s<$s> cond_lines<$cond_lines> stat_real<$stat_real> stat<$stat>\n"; |
4d001e4d AW |
1701 | |
1702 | if ($check && (($sindent % 8) != 0 || | |
1703 | ($sindent <= $indent && $s ne ''))) { | |
1704 | WARN("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); | |
1705 | } | |
1706 | } | |
1707 | ||
6c72ffaa AW |
1708 | # Track the 'values' across context and added lines. |
1709 | my $opline = $line; $opline =~ s/^./ /; | |
1f65f947 AW |
1710 | my ($curr_values, $curr_vars) = |
1711 | annotate_values($opline . "\n", $prev_values); | |
6c72ffaa | 1712 | $curr_values = $prev_values . $curr_values; |
c2fdda0d AW |
1713 | if ($dbg_values) { |
1714 | my $outline = $opline; $outline =~ s/\t/ /g; | |
cf655043 AW |
1715 | print "$linenr > .$outline\n"; |
1716 | print "$linenr > $curr_values\n"; | |
1f65f947 | 1717 | print "$linenr > $curr_vars\n"; |
c2fdda0d | 1718 | } |
6c72ffaa AW |
1719 | $prev_values = substr($curr_values, -1); |
1720 | ||
00df344f AW |
1721 | #ignore lines not being added |
1722 | if ($line=~/^[^\+]/) {next;} | |
1723 | ||
653d4876 | 1724 | # TEST: allow direct testing of the type matcher. |
7429c690 AW |
1725 | if ($dbg_type) { |
1726 | if ($line =~ /^.\s*$Declare\s*$/) { | |
1727 | ERROR("TEST: is type\n" . $herecurr); | |
1728 | } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { | |
1729 | ERROR("TEST: is not type ($1 is)\n". $herecurr); | |
1730 | } | |
653d4876 AW |
1731 | next; |
1732 | } | |
a1ef277e AW |
1733 | # TEST: allow direct testing of the attribute matcher. |
1734 | if ($dbg_attr) { | |
9360b0e5 | 1735 | if ($line =~ /^.\s*$Modifier\s*$/) { |
a1ef277e | 1736 | ERROR("TEST: is attr\n" . $herecurr); |
9360b0e5 | 1737 | } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { |
a1ef277e AW |
1738 | ERROR("TEST: is not attr ($1 is)\n". $herecurr); |
1739 | } | |
1740 | next; | |
1741 | } | |
653d4876 | 1742 | |
f0a594c1 | 1743 | # check for initialisation to aggregates open brace on the next line |
99423c20 AW |
1744 | if ($line =~ /^.\s*{/ && |
1745 | $prevline =~ /(?:^|[^=])=\s*$/) { | |
773647a0 | 1746 | ERROR("that open brace { should be on the previous line\n" . $hereprev); |
f0a594c1 AW |
1747 | } |
1748 | ||
653d4876 AW |
1749 | # |
1750 | # Checks which are anchored on the added line. | |
1751 | # | |
1752 | ||
1753 | # check for malformed paths in #include statements (uses RAW line) | |
c45dcabd | 1754 | if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { |
653d4876 AW |
1755 | my $path = $1; |
1756 | if ($path =~ m{//}) { | |
de7d4f0e AW |
1757 | ERROR("malformed #include filename\n" . |
1758 | $herecurr); | |
653d4876 | 1759 | } |
653d4876 | 1760 | } |
00df344f | 1761 | |
0a920b5b | 1762 | # no C99 // comments |
00df344f | 1763 | if ($line =~ m{//}) { |
de7d4f0e | 1764 | ERROR("do not use C99 // comments\n" . $herecurr); |
0a920b5b | 1765 | } |
00df344f | 1766 | # Remove C99 comments. |
0a920b5b | 1767 | $line =~ s@//.*@@; |
6c72ffaa | 1768 | $opline =~ s@//.*@@; |
0a920b5b | 1769 | |
2b474a1a AW |
1770 | # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider |
1771 | # the whole statement. | |
1772 | #print "APW <$lines[$realline_next - 1]>\n"; | |
1773 | if (defined $realline_next && | |
1774 | exists $lines[$realline_next - 1] && | |
1775 | !defined $suppress_export{$realline_next} && | |
1776 | ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || | |
1777 | $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { | |
653d4876 | 1778 | my $name = $1; |
2b474a1a AW |
1779 | if ($stat !~ /(?: |
1780 | \n.}\s*$| | |
48012058 AW |
1781 | ^.DEFINE_$Ident\(\Q$name\E\)| |
1782 | ^.DECLARE_$Ident\(\Q$name\E\)| | |
1783 | ^.LIST_HEAD\(\Q$name\E\)| | |
2b474a1a AW |
1784 | ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| |
1785 | \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() | |
48012058 | 1786 | )/x) { |
2b474a1a AW |
1787 | #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; |
1788 | $suppress_export{$realline_next} = 2; | |
1789 | } else { | |
1790 | $suppress_export{$realline_next} = 1; | |
0a920b5b AW |
1791 | } |
1792 | } | |
2b474a1a AW |
1793 | if (!defined $suppress_export{$linenr} && |
1794 | $prevline =~ /^.\s*$/ && | |
1795 | ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || | |
1796 | $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { | |
1797 | #print "FOO B <$lines[$linenr - 1]>\n"; | |
1798 | $suppress_export{$linenr} = 2; | |
1799 | } | |
1800 | if (defined $suppress_export{$linenr} && | |
1801 | $suppress_export{$linenr} == 2) { | |
1802 | WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); | |
1803 | } | |
0a920b5b | 1804 | |
5150bda4 | 1805 | # check for global initialisers. |
c45dcabd | 1806 | if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) { |
5150bda4 | 1807 | ERROR("do not initialise globals to 0 or NULL\n" . |
f0a594c1 AW |
1808 | $herecurr); |
1809 | } | |
653d4876 | 1810 | # check for static initialisers. |
2d1bafd7 | 1811 | if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) { |
de7d4f0e AW |
1812 | ERROR("do not initialise statics to 0 or NULL\n" . |
1813 | $herecurr); | |
0a920b5b AW |
1814 | } |
1815 | ||
653d4876 AW |
1816 | # check for new typedefs, only function parameters and sparse annotations |
1817 | # make sense. | |
1818 | if ($line =~ /\btypedef\s/ && | |
8054576d | 1819 | $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && |
c45dcabd | 1820 | $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && |
8ed22cad | 1821 | $line !~ /\b$typeTypedefs\b/ && |
653d4876 | 1822 | $line !~ /\b__bitwise(?:__|)\b/) { |
de7d4f0e | 1823 | WARN("do not add new typedefs\n" . $herecurr); |
0a920b5b AW |
1824 | } |
1825 | ||
1826 | # * goes on variable not on type | |
65863862 | 1827 | # (char*[ const]) |
00ef4ece | 1828 | if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) { |
65863862 AW |
1829 | my ($from, $to) = ($1, $1); |
1830 | ||
1831 | # Should start with a space. | |
1832 | $to =~ s/^(\S)/ $1/; | |
1833 | # Should not end with a space. | |
1834 | $to =~ s/\s+$//; | |
1835 | # '*'s should not have spaces between. | |
f9a0b3d1 | 1836 | while ($to =~ s/\*\s+\*/\*\*/) { |
65863862 | 1837 | } |
d8aaf121 | 1838 | |
65863862 AW |
1839 | #print "from<$from> to<$to>\n"; |
1840 | if ($from ne $to) { | |
1841 | ERROR("\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr); | |
1842 | } | |
00ef4ece | 1843 | } elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) { |
65863862 AW |
1844 | my ($from, $to, $ident) = ($1, $1, $2); |
1845 | ||
1846 | # Should start with a space. | |
1847 | $to =~ s/^(\S)/ $1/; | |
1848 | # Should not end with a space. | |
1849 | $to =~ s/\s+$//; | |
1850 | # '*'s should not have spaces between. | |
f9a0b3d1 | 1851 | while ($to =~ s/\*\s+\*/\*\*/) { |
65863862 AW |
1852 | } |
1853 | # Modifiers should have spaces. | |
1854 | $to =~ s/(\b$Modifier$)/$1 /; | |
d8aaf121 | 1855 | |
667026e7 AW |
1856 | #print "from<$from> to<$to> ident<$ident>\n"; |
1857 | if ($from ne $to && $ident !~ /^$Modifier$/) { | |
65863862 AW |
1858 | ERROR("\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr); |
1859 | } | |
0a920b5b AW |
1860 | } |
1861 | ||
1862 | # # no BUG() or BUG_ON() | |
1863 | # if ($line =~ /\b(BUG|BUG_ON)\b/) { | |
1864 | # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; | |
1865 | # print "$herecurr"; | |
1866 | # $clean = 0; | |
1867 | # } | |
1868 | ||
8905a67c | 1869 | if ($line =~ /\bLINUX_VERSION_CODE\b/) { |
c2fdda0d | 1870 | WARN("LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); |
8905a67c AW |
1871 | } |
1872 | ||
00df344f AW |
1873 | # printk should use KERN_* levels. Note that follow on printk's on the |
1874 | # same line do not need a level, so we use the current block context | |
1875 | # to try and find and validate the current printk. In summary the current | |
1876 | # printk includes all preceeding printk's which have no newline on the end. | |
1877 | # we assume the first bad printk is the one to report. | |
f0a594c1 | 1878 | if ($line =~ /\bprintk\((?!KERN_)\s*"/) { |
00df344f AW |
1879 | my $ok = 0; |
1880 | for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { | |
1881 | #print "CHECK<$lines[$ln - 1]\n"; | |
1882 | # we have a preceeding printk if it ends | |
1883 | # with "\n" ignore it, else it is to blame | |
1884 | if ($lines[$ln - 1] =~ m{\bprintk\(}) { | |
1885 | if ($rawlines[$ln - 1] !~ m{\\n"}) { | |
1886 | $ok = 1; | |
1887 | } | |
1888 | last; | |
1889 | } | |
1890 | } | |
1891 | if ($ok == 0) { | |
de7d4f0e | 1892 | WARN("printk() should include KERN_ facility level\n" . $herecurr); |
00df344f | 1893 | } |
0a920b5b AW |
1894 | } |
1895 | ||
653d4876 AW |
1896 | # function brace can't be on same line, except for #defines of do while, |
1897 | # or if closed on same line | |
c45dcabd AW |
1898 | if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and |
1899 | !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { | |
de7d4f0e | 1900 | ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr); |
0a920b5b | 1901 | } |
653d4876 | 1902 | |
8905a67c AW |
1903 | # open braces for enum, union and struct go on the same line. |
1904 | if ($line =~ /^.\s*{/ && | |
1905 | $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { | |
1906 | ERROR("open brace '{' following $1 go on the same line\n" . $hereprev); | |
1907 | } | |
1908 | ||
8d31cfce AW |
1909 | # check for spacing round square brackets; allowed: |
1910 | # 1. with a type on the left -- int [] a; | |
fe2a7dbc AW |
1911 | # 2. at the beginning of a line for slice initialisers -- [0...10] = 5, |
1912 | # 3. inside a curly brace -- = { [0...10] = 5 } | |
8d31cfce AW |
1913 | while ($line =~ /(.*?\s)\[/g) { |
1914 | my ($where, $prefix) = ($-[1], $1); | |
1915 | if ($prefix !~ /$Type\s+$/ && | |
fe2a7dbc AW |
1916 | ($where != 0 || $prefix !~ /^.\s+$/) && |
1917 | $prefix !~ /{\s+$/) { | |
8d31cfce AW |
1918 | ERROR("space prohibited before open square bracket '['\n" . $herecurr); |
1919 | } | |
1920 | } | |
1921 | ||
f0a594c1 | 1922 | # check for spaces between functions and their parentheses. |
6c72ffaa | 1923 | while ($line =~ /($Ident)\s+\(/g) { |
c2fdda0d | 1924 | my $name = $1; |
773647a0 AW |
1925 | my $ctx_before = substr($line, 0, $-[1]); |
1926 | my $ctx = "$ctx_before$name"; | |
c2fdda0d AW |
1927 | |
1928 | # Ignore those directives where spaces _are_ permitted. | |
773647a0 AW |
1929 | if ($name =~ /^(?: |
1930 | if|for|while|switch|return|case| | |
1931 | volatile|__volatile__| | |
1932 | __attribute__|format|__extension__| | |
1933 | asm|__asm__)$/x) | |
1934 | { | |
c2fdda0d AW |
1935 | |
1936 | # cpp #define statements have non-optional spaces, ie | |
1937 | # if there is a space between the name and the open | |
1938 | # parenthesis it is simply not a parameter group. | |
c45dcabd | 1939 | } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { |
773647a0 AW |
1940 | |
1941 | # cpp #elif statement condition may start with a ( | |
c45dcabd | 1942 | } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { |
c2fdda0d AW |
1943 | |
1944 | # If this whole things ends with a type its most | |
1945 | # likely a typedef for a function. | |
773647a0 | 1946 | } elsif ($ctx =~ /$Type$/) { |
c2fdda0d AW |
1947 | |
1948 | } else { | |
773647a0 | 1949 | WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr); |
6c72ffaa | 1950 | } |
f0a594c1 | 1951 | } |
653d4876 | 1952 | # Check operator spacing. |
0a920b5b | 1953 | if (!($line=~/\#\s*include/)) { |
9c0ca6f9 AW |
1954 | my $ops = qr{ |
1955 | <<=|>>=|<=|>=|==|!=| | |
1956 | \+=|-=|\*=|\/=|%=|\^=|\|=|&=| | |
1957 | =>|->|<<|>>|<|>|=|!|~| | |
1f65f947 AW |
1958 | &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| |
1959 | \?|: | |
9c0ca6f9 | 1960 | }x; |
cf655043 | 1961 | my @elements = split(/($ops|;)/, $opline); |
00df344f | 1962 | my $off = 0; |
6c72ffaa AW |
1963 | |
1964 | my $blank = copy_spacing($opline); | |
1965 | ||
0a920b5b | 1966 | for (my $n = 0; $n < $#elements; $n += 2) { |
4a0df2ef AW |
1967 | $off += length($elements[$n]); |
1968 | ||
773647a0 AW |
1969 | # Pick up the preceeding and succeeding characters. |
1970 | my $ca = substr($opline, 0, $off); | |
1971 | my $cc = ''; | |
1972 | if (length($opline) >= ($off + length($elements[$n + 1]))) { | |
1973 | $cc = substr($opline, $off + length($elements[$n + 1])); | |
1974 | } | |
1975 | my $cb = "$ca$;$cc"; | |
1976 | ||
4a0df2ef AW |
1977 | my $a = ''; |
1978 | $a = 'V' if ($elements[$n] ne ''); | |
1979 | $a = 'W' if ($elements[$n] =~ /\s$/); | |
cf655043 | 1980 | $a = 'C' if ($elements[$n] =~ /$;$/); |
4a0df2ef AW |
1981 | $a = 'B' if ($elements[$n] =~ /(\[|\()$/); |
1982 | $a = 'O' if ($elements[$n] eq ''); | |
773647a0 | 1983 | $a = 'E' if ($ca =~ /^\s*$/); |
4a0df2ef | 1984 | |
0a920b5b | 1985 | my $op = $elements[$n + 1]; |
4a0df2ef AW |
1986 | |
1987 | my $c = ''; | |
0a920b5b | 1988 | if (defined $elements[$n + 2]) { |
4a0df2ef AW |
1989 | $c = 'V' if ($elements[$n + 2] ne ''); |
1990 | $c = 'W' if ($elements[$n + 2] =~ /^\s/); | |
cf655043 | 1991 | $c = 'C' if ($elements[$n + 2] =~ /^$;/); |
4a0df2ef AW |
1992 | $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); |
1993 | $c = 'O' if ($elements[$n + 2] eq ''); | |
8b1b3378 | 1994 | $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); |
4a0df2ef AW |
1995 | } else { |
1996 | $c = 'E'; | |
0a920b5b AW |
1997 | } |
1998 | ||
4a0df2ef AW |
1999 | my $ctx = "${a}x${c}"; |
2000 | ||
2001 | my $at = "(ctx:$ctx)"; | |
2002 | ||
6c72ffaa | 2003 | my $ptr = substr($blank, 0, $off) . "^"; |
de7d4f0e | 2004 | my $hereptr = "$hereline$ptr\n"; |
0a920b5b | 2005 | |
74048ed8 | 2006 | # Pull out the value of this operator. |
6c72ffaa | 2007 | my $op_type = substr($curr_values, $off + 1, 1); |
0a920b5b | 2008 | |
1f65f947 AW |
2009 | # Get the full operator variant. |
2010 | my $opv = $op . substr($curr_vars, $off, 1); | |
2011 | ||
13214adf AW |
2012 | # Ignore operators passed as parameters. |
2013 | if ($op_type ne 'V' && | |
2014 | $ca =~ /\s$/ && $cc =~ /^\s*,/) { | |
2015 | ||
cf655043 AW |
2016 | # # Ignore comments |
2017 | # } elsif ($op =~ /^$;+$/) { | |
13214adf | 2018 | |
d8aaf121 | 2019 | # ; should have either the end of line or a space or \ after it |
13214adf | 2020 | } elsif ($op eq ';') { |
cf655043 AW |
2021 | if ($ctx !~ /.x[WEBC]/ && |
2022 | $cc !~ /^\\/ && $cc !~ /^;/) { | |
773647a0 | 2023 | ERROR("space required after that '$op' $at\n" . $hereptr); |
d8aaf121 AW |
2024 | } |
2025 | ||
2026 | # // is a comment | |
2027 | } elsif ($op eq '//') { | |
0a920b5b | 2028 | |
1f65f947 AW |
2029 | # No spaces for: |
2030 | # -> | |
2031 | # : when part of a bitfield | |
2032 | } elsif ($op eq '->' || $opv eq ':B') { | |
4a0df2ef | 2033 | if ($ctx =~ /Wx.|.xW/) { |
773647a0 | 2034 | ERROR("spaces prohibited around that '$op' $at\n" . $hereptr); |
0a920b5b AW |
2035 | } |
2036 | ||
2037 | # , must have a space on the right. | |
2038 | } elsif ($op eq ',') { | |
cf655043 | 2039 | if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { |
773647a0 | 2040 | ERROR("space required after that '$op' $at\n" . $hereptr); |
0a920b5b AW |
2041 | } |
2042 | ||
9c0ca6f9 | 2043 | # '*' as part of a type definition -- reported already. |
74048ed8 | 2044 | } elsif ($opv eq '*_') { |
9c0ca6f9 AW |
2045 | #warn "'*' is part of type\n"; |
2046 | ||
2047 | # unary operators should have a space before and | |
2048 | # none after. May be left adjacent to another | |
2049 | # unary operator, or a cast | |
2050 | } elsif ($op eq '!' || $op eq '~' || | |
74048ed8 | 2051 | $opv eq '*U' || $opv eq '-U' || |
0d413866 | 2052 | $opv eq '&U' || $opv eq '&&U') { |
cf655043 | 2053 | if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { |
773647a0 | 2054 | ERROR("space required before that '$op' $at\n" . $hereptr); |
0a920b5b | 2055 | } |
a3340b35 | 2056 | if ($op eq '*' && $cc =~/\s*$Modifier\b/) { |
171ae1a4 AW |
2057 | # A unary '*' may be const |
2058 | ||
2059 | } elsif ($ctx =~ /.xW/) { | |
fb9e9096 | 2060 | ERROR("space prohibited after that '$op' $at\n" . $hereptr); |
0a920b5b AW |
2061 | } |
2062 | ||
2063 | # unary ++ and unary -- are allowed no space on one side. | |
2064 | } elsif ($op eq '++' or $op eq '--') { | |
773647a0 AW |
2065 | if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { |
2066 | ERROR("space required one side of that '$op' $at\n" . $hereptr); | |
2067 | } | |
2068 | if ($ctx =~ /Wx[BE]/ || | |
2069 | ($ctx =~ /Wx./ && $cc =~ /^;/)) { | |
2070 | ERROR("space prohibited before that '$op' $at\n" . $hereptr); | |
0a920b5b | 2071 | } |
773647a0 AW |
2072 | if ($ctx =~ /ExW/) { |
2073 | ERROR("space prohibited after that '$op' $at\n" . $hereptr); | |
653d4876 | 2074 | } |
0a920b5b | 2075 | |
773647a0 | 2076 | |
0a920b5b | 2077 | # << and >> may either have or not have spaces both sides |
9c0ca6f9 AW |
2078 | } elsif ($op eq '<<' or $op eq '>>' or |
2079 | $op eq '&' or $op eq '^' or $op eq '|' or | |
2080 | $op eq '+' or $op eq '-' or | |
c2fdda0d AW |
2081 | $op eq '*' or $op eq '/' or |
2082 | $op eq '%') | |
0a920b5b | 2083 | { |
773647a0 | 2084 | if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { |
de7d4f0e AW |
2085 | ERROR("need consistent spacing around '$op' $at\n" . |
2086 | $hereptr); | |
0a920b5b AW |
2087 | } |
2088 | ||
1f65f947 AW |
2089 | # A colon needs no spaces before when it is |
2090 | # terminating a case value or a label. | |
2091 | } elsif ($opv eq ':C' || $opv eq ':L') { | |
2092 | if ($ctx =~ /Wx./) { | |
2093 | ERROR("space prohibited before that '$op' $at\n" . $hereptr); | |
2094 | } | |
2095 | ||
0a920b5b | 2096 | # All the others need spaces both sides. |
cf655043 | 2097 | } elsif ($ctx !~ /[EWC]x[CWE]/) { |
1f65f947 AW |
2098 | my $ok = 0; |
2099 | ||
22f2a2ef | 2100 | # Ignore email addresses <foo@bar> |
1f65f947 AW |
2101 | if (($op eq '<' && |
2102 | $cc =~ /^\S+\@\S+>/) || | |
2103 | ($op eq '>' && | |
2104 | $ca =~ /<\S+\@\S+$/)) | |
2105 | { | |
2106 | $ok = 1; | |
2107 | } | |
2108 | ||
2109 | # Ignore ?: | |
2110 | if (($opv eq ':O' && $ca =~ /\?$/) || | |
2111 | ($op eq '?' && $cc =~ /^:/)) { | |
2112 | $ok = 1; | |
2113 | } | |
2114 | ||
2115 | if ($ok == 0) { | |
773647a0 | 2116 | ERROR("spaces required around that '$op' $at\n" . $hereptr); |
22f2a2ef | 2117 | } |
0a920b5b | 2118 | } |
4a0df2ef | 2119 | $off += length($elements[$n + 1]); |
0a920b5b AW |
2120 | } |
2121 | } | |
2122 | ||
f0a594c1 AW |
2123 | # check for multiple assignments |
2124 | if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { | |
6c72ffaa | 2125 | CHK("multiple assignments should be avoided\n" . $herecurr); |
f0a594c1 AW |
2126 | } |
2127 | ||
22f2a2ef AW |
2128 | ## # check for multiple declarations, allowing for a function declaration |
2129 | ## # continuation. | |
2130 | ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && | |
2131 | ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { | |
2132 | ## | |
2133 | ## # Remove any bracketed sections to ensure we do not | |
2134 | ## # falsly report the parameters of functions. | |
2135 | ## my $ln = $line; | |
2136 | ## while ($ln =~ s/\([^\(\)]*\)//g) { | |
2137 | ## } | |
2138 | ## if ($ln =~ /,/) { | |
2139 | ## WARN("declaring multiple variables together should be avoided\n" . $herecurr); | |
2140 | ## } | |
2141 | ## } | |
f0a594c1 | 2142 | |
0a920b5b | 2143 | #need space before brace following if, while, etc |
22f2a2ef AW |
2144 | if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || |
2145 | $line =~ /do{/) { | |
773647a0 | 2146 | ERROR("space required before the open brace '{'\n" . $herecurr); |
de7d4f0e AW |
2147 | } |
2148 | ||
2149 | # closing brace should have a space following it when it has anything | |
2150 | # on the line | |
2151 | if ($line =~ /}(?!(?:,|;|\)))\S/) { | |
773647a0 | 2152 | ERROR("space required after that close brace '}'\n" . $herecurr); |
0a920b5b AW |
2153 | } |
2154 | ||
22f2a2ef AW |
2155 | # check spacing on square brackets |
2156 | if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { | |
773647a0 | 2157 | ERROR("space prohibited after that open square bracket '['\n" . $herecurr); |
22f2a2ef AW |
2158 | } |
2159 | if ($line =~ /\s\]/) { | |
773647a0 | 2160 | ERROR("space prohibited before that close square bracket ']'\n" . $herecurr); |
22f2a2ef AW |
2161 | } |
2162 | ||
c45dcabd | 2163 | # check spacing on parentheses |
9c0ca6f9 AW |
2164 | if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && |
2165 | $line !~ /for\s*\(\s+;/) { | |
773647a0 | 2166 | ERROR("space prohibited after that open parenthesis '('\n" . $herecurr); |
22f2a2ef | 2167 | } |
13214adf | 2168 | if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && |
c45dcabd AW |
2169 | $line !~ /for\s*\(.*;\s+\)/ && |
2170 | $line !~ /:\s+\)/) { | |
773647a0 | 2171 | ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr); |
22f2a2ef AW |
2172 | } |
2173 | ||
0a920b5b | 2174 | #goto labels aren't indented, allow a single space however |
4a0df2ef | 2175 | if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and |
0a920b5b | 2176 | !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { |
de7d4f0e | 2177 | WARN("labels should not be indented\n" . $herecurr); |
0a920b5b AW |
2178 | } |
2179 | ||
c45dcabd AW |
2180 | # Return is not a function. |
2181 | if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) { | |
2182 | my $spacing = $1; | |
2183 | my $value = $2; | |
2184 | ||
86f9d059 | 2185 | # Flatten any parentheses |
fb2d2c1b AW |
2186 | $value =~ s/\(/ \(/g; |
2187 | $value =~ s/\)/\) /g; | |
63f17f89 AW |
2188 | while ($value =~ s/\[[^\{\}]*\]/1/ || |
2189 | $value !~ /(?:$Ident|-?$Constant)\s* | |
2190 | $Compare\s* | |
2191 | (?:$Ident|-?$Constant)/x && | |
2192 | $value =~ s/\([^\(\)]*\)/1/) { | |
c45dcabd | 2193 | } |
fb2d2c1b AW |
2194 | #print "value<$value>\n"; |
2195 | if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) { | |
c45dcabd AW |
2196 | ERROR("return is not a function, parentheses are not required\n" . $herecurr); |
2197 | ||
2198 | } elsif ($spacing !~ /\s+/) { | |
2199 | ERROR("space required before the open parenthesis '('\n" . $herecurr); | |
2200 | } | |
2201 | } | |
2202 | ||
0a920b5b | 2203 | # Need a space before open parenthesis after if, while etc |
4a0df2ef | 2204 | if ($line=~/\b(if|while|for|switch)\(/) { |
773647a0 | 2205 | ERROR("space required before the open parenthesis '('\n" . $herecurr); |
0a920b5b AW |
2206 | } |
2207 | ||
f5fe35dd AW |
2208 | # Check for illegal assignment in if conditional -- and check for trailing |
2209 | # statements after the conditional. | |
170d3a22 AW |
2210 | if ($line =~ /do\s*(?!{)/) { |
2211 | my ($stat_next) = ctx_statement_block($line_nr_next, | |
2212 | $remain_next, $off_next); | |
2213 | $stat_next =~ s/\n./\n /g; | |
2214 | ##print "stat<$stat> stat_next<$stat_next>\n"; | |
2215 | ||
2216 | if ($stat_next =~ /^\s*while\b/) { | |
2217 | # If the statement carries leading newlines, | |
2218 | # then count those as offsets. | |
2219 | my ($whitespace) = | |
2220 | ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); | |
2221 | my $offset = | |
2222 | statement_rawlines($whitespace) - 1; | |
2223 | ||
2224 | $suppress_whiletrailers{$line_nr_next + | |
2225 | $offset} = 1; | |
2226 | } | |
2227 | } | |
2228 | if (!defined $suppress_whiletrailers{$linenr} && | |
2229 | $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { | |
171ae1a4 | 2230 | my ($s, $c) = ($stat, $cond); |
8905a67c | 2231 | |
b53c8e10 | 2232 | if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { |
c2fdda0d | 2233 | ERROR("do not use assignment in if condition\n" . $herecurr); |
8905a67c AW |
2234 | } |
2235 | ||
2236 | # Find out what is on the end of the line after the | |
2237 | # conditional. | |
773647a0 | 2238 | substr($s, 0, length($c), ''); |
8905a67c | 2239 | $s =~ s/\n.*//g; |
13214adf | 2240 | $s =~ s/$;//g; # Remove any comments |
53210168 AW |
2241 | if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && |
2242 | $c !~ /}\s*while\s*/) | |
773647a0 | 2243 | { |
bb44ad39 AW |
2244 | # Find out how long the conditional actually is. |
2245 | my @newlines = ($c =~ /\n/gs); | |
2246 | my $cond_lines = 1 + $#newlines; | |
42bdf74c | 2247 | my $stat_real = ''; |
bb44ad39 | 2248 | |
42bdf74c HS |
2249 | $stat_real = raw_line($linenr, $cond_lines) |
2250 | . "\n" if ($cond_lines); | |
bb44ad39 AW |
2251 | if (defined($stat_real) && $cond_lines > 1) { |
2252 | $stat_real = "[...]\n$stat_real"; | |
2253 | } | |
2254 | ||
2255 | ERROR("trailing statements should be on next line\n" . $herecurr . $stat_real); | |
8905a67c AW |
2256 | } |
2257 | } | |
2258 | ||
13214adf AW |
2259 | # Check for bitwise tests written as boolean |
2260 | if ($line =~ / | |
2261 | (?: | |
2262 | (?:\[|\(|\&\&|\|\|) | |
2263 | \s*0[xX][0-9]+\s* | |
2264 | (?:\&\&|\|\|) | |
2265 | | | |
2266 | (?:\&\&|\|\|) | |
2267 | \s*0[xX][0-9]+\s* | |
2268 | (?:\&\&|\|\||\)|\]) | |
2269 | )/x) | |
2270 | { | |
2271 | WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); | |
2272 | } | |
2273 | ||
8905a67c | 2274 | # if and else should not have general statements after it |
13214adf AW |
2275 | if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { |
2276 | my $s = $1; | |
2277 | $s =~ s/$;//g; # Remove any comments | |
2278 | if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { | |
2279 | ERROR("trailing statements should be on next line\n" . $herecurr); | |
2280 | } | |
0a920b5b | 2281 | } |
39667782 AW |
2282 | # if should not continue a brace |
2283 | if ($line =~ /}\s*if\b/) { | |
2284 | ERROR("trailing statements should be on next line\n" . | |
2285 | $herecurr); | |
2286 | } | |
a1080bf8 AW |
2287 | # case and default should not have general statements after them |
2288 | if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && | |
2289 | $line !~ /\G(?: | |
3fef12d6 | 2290 | (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| |
a1080bf8 AW |
2291 | \s*return\s+ |
2292 | )/xg) | |
2293 | { | |
2294 | ERROR("trailing statements should be on next line\n" . $herecurr); | |
2295 | } | |
0a920b5b AW |
2296 | |
2297 | # Check for }<nl>else {, these must be at the same | |
2298 | # indent level to be relevant to each other. | |
2299 | if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and | |
2300 | $previndent == $indent) { | |
de7d4f0e | 2301 | ERROR("else should follow close brace '}'\n" . $hereprev); |
0a920b5b AW |
2302 | } |
2303 | ||
c2fdda0d AW |
2304 | if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and |
2305 | $previndent == $indent) { | |
2306 | my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); | |
2307 | ||
2308 | # Find out what is on the end of the line after the | |
2309 | # conditional. | |
773647a0 | 2310 | substr($s, 0, length($c), ''); |
c2fdda0d AW |
2311 | $s =~ s/\n.*//g; |
2312 | ||
2313 | if ($s =~ /^\s*;/) { | |
2314 | ERROR("while should follow close brace '}'\n" . $hereprev); | |
2315 | } | |
2316 | } | |
2317 | ||
0a920b5b AW |
2318 | #studly caps, commented out until figure out how to distinguish between use of existing and adding new |
2319 | # if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) { | |
2320 | # print "No studly caps, use _\n"; | |
2321 | # print "$herecurr"; | |
2322 | # $clean = 0; | |
2323 | # } | |
2324 | ||
2325 | #no spaces allowed after \ in define | |
c45dcabd | 2326 | if ($line=~/\#\s*define.*\\\s$/) { |
de7d4f0e | 2327 | WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr); |
0a920b5b AW |
2328 | } |
2329 | ||
653d4876 | 2330 | #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line) |
c45dcabd | 2331 | if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { |
e09dec48 AW |
2332 | my $file = "$1.h"; |
2333 | my $checkfile = "include/linux/$file"; | |
2334 | if (-f "$root/$checkfile" && | |
2335 | $realfile ne $checkfile && | |
7840a94c | 2336 | $1 !~ /$allowed_asm_includes/) |
c45dcabd | 2337 | { |
e09dec48 AW |
2338 | if ($realfile =~ m{^arch/}) { |
2339 | CHK("Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); | |
2340 | } else { | |
2341 | WARN("Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); | |
2342 | } | |
0a920b5b AW |
2343 | } |
2344 | } | |
2345 | ||
653d4876 AW |
2346 | # multi-statement macros should be enclosed in a do while loop, grab the |
2347 | # first statement and ensure its the whole macro if its not enclosed | |
cf655043 | 2348 | # in a known good container |
b8f96a31 AW |
2349 | if ($realfile !~ m@/vmlinux.lds.h$@ && |
2350 | $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { | |
d8aaf121 AW |
2351 | my $ln = $linenr; |
2352 | my $cnt = $realcnt; | |
c45dcabd AW |
2353 | my ($off, $dstat, $dcond, $rest); |
2354 | my $ctx = ''; | |
653d4876 | 2355 | |
c45dcabd AW |
2356 | my $args = defined($1); |
2357 | ||
2358 | # Find the end of the macro and limit our statement | |
2359 | # search to that. | |
2360 | while ($cnt > 0 && defined $lines[$ln - 1] && | |
2361 | $lines[$ln - 1] =~ /^(?:-|..*\\$)/) | |
2362 | { | |
2363 | $ctx .= $rawlines[$ln - 1] . "\n"; | |
a3bb97a7 | 2364 | $cnt-- if ($lines[$ln - 1] !~ /^-/); |
c45dcabd | 2365 | $ln++; |
c45dcabd AW |
2366 | } |
2367 | $ctx .= $rawlines[$ln - 1]; | |
2368 | ||
2369 | ($dstat, $dcond, $ln, $cnt, $off) = | |
2370 | ctx_statement_block($linenr, $ln - $linenr + 1, 0); | |
2371 | #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; | |
a3bb97a7 | 2372 | #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; |
c45dcabd AW |
2373 | |
2374 | # Extract the remainder of the define (if any) and | |
2375 | # rip off surrounding spaces, and trailing \'s. | |
2376 | $rest = ''; | |
636d140a AW |
2377 | while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) { |
2378 | #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n"; | |
a3bb97a7 AW |
2379 | if ($off != 0 || $lines[$ln - 1] !~ /^-/) { |
2380 | $rest .= substr($lines[$ln - 1], $off) . "\n"; | |
2381 | $cnt--; | |
2382 | } | |
c45dcabd | 2383 | $ln++; |
c45dcabd AW |
2384 | $off = 0; |
2385 | } | |
2386 | $rest =~ s/\\\n.//g; | |
2387 | $rest =~ s/^\s*//s; | |
2388 | $rest =~ s/\s*$//s; | |
2389 | ||
2390 | # Clean up the original statement. | |
2391 | if ($args) { | |
2392 | substr($dstat, 0, length($dcond), ''); | |
2393 | } else { | |
2394 | $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//; | |
d8aaf121 | 2395 | } |
292f1a9b | 2396 | $dstat =~ s/$;//g; |
c45dcabd AW |
2397 | $dstat =~ s/\\\n.//g; |
2398 | $dstat =~ s/^\s*//s; | |
2399 | $dstat =~ s/\s*$//s; | |
de7d4f0e | 2400 | |
c45dcabd | 2401 | # Flatten any parentheses and braces |
bf30d6ed AW |
2402 | while ($dstat =~ s/\([^\(\)]*\)/1/ || |
2403 | $dstat =~ s/\{[^\{\}]*\}/1/ || | |
2404 | $dstat =~ s/\[[^\{\}]*\]/1/) | |
2405 | { | |
de7d4f0e | 2406 | } |
d8aaf121 | 2407 | |
c45dcabd AW |
2408 | my $exceptions = qr{ |
2409 | $Declare| | |
2410 | module_param_named| | |
2411 | MODULE_PARAM_DESC| | |
2412 | DECLARE_PER_CPU| | |
2413 | DEFINE_PER_CPU| | |
383099fd | 2414 | __typeof__\(| |
22fd2d3e SS |
2415 | union| |
2416 | struct| | |
ea71a0a0 AW |
2417 | \.$Ident\s*=\s*| |
2418 | ^\"|\"$ | |
c45dcabd | 2419 | }x; |
383099fd | 2420 | #print "REST<$rest> dstat<$dstat>\n"; |
c45dcabd AW |
2421 | if ($rest ne '') { |
2422 | if ($rest !~ /while\s*\(/ && | |
2423 | $dstat !~ /$exceptions/) | |
2424 | { | |
de7d4f0e | 2425 | ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n"); |
c45dcabd AW |
2426 | } |
2427 | ||
2428 | } elsif ($ctx !~ /;/) { | |
2429 | if ($dstat ne '' && | |
2430 | $dstat !~ /^(?:$Ident|-?$Constant)$/ && | |
2431 | $dstat !~ /$exceptions/ && | |
b132e5d5 | 2432 | $dstat !~ /^\.$Ident\s*=/ && |
c45dcabd AW |
2433 | $dstat =~ /$Operators/) |
2434 | { | |
de7d4f0e | 2435 | ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n"); |
d8aaf121 | 2436 | } |
653d4876 | 2437 | } |
0a920b5b AW |
2438 | } |
2439 | ||
080ba929 MF |
2440 | # make sure symbols are always wrapped with VMLINUX_SYMBOL() ... |
2441 | # all assignments may have only one of the following with an assignment: | |
2442 | # . | |
2443 | # ALIGN(...) | |
2444 | # VMLINUX_SYMBOL(...) | |
2445 | if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { | |
2446 | WARN("vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); | |
2447 | } | |
2448 | ||
f0a594c1 | 2449 | # check for redundant bracing round if etc |
13214adf AW |
2450 | if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { |
2451 | my ($level, $endln, @chunks) = | |
cf655043 | 2452 | ctx_statement_full($linenr, $realcnt, 1); |
13214adf | 2453 | #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; |
cf655043 AW |
2454 | #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; |
2455 | if ($#chunks > 0 && $level == 0) { | |
13214adf AW |
2456 | my $allowed = 0; |
2457 | my $seen = 0; | |
773647a0 | 2458 | my $herectx = $here . "\n"; |
cf655043 | 2459 | my $ln = $linenr - 1; |
13214adf AW |
2460 | for my $chunk (@chunks) { |
2461 | my ($cond, $block) = @{$chunk}; | |
2462 | ||
773647a0 AW |
2463 | # If the condition carries leading newlines, then count those as offsets. |
2464 | my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); | |
2465 | my $offset = statement_rawlines($whitespace) - 1; | |
2466 | ||
2467 | #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; | |
2468 | ||
2469 | # We have looked at and allowed this specific line. | |
2470 | $suppress_ifbraces{$ln + $offset} = 1; | |
2471 | ||
2472 | $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; | |
cf655043 AW |
2473 | $ln += statement_rawlines($block) - 1; |
2474 | ||
773647a0 | 2475 | substr($block, 0, length($cond), ''); |
13214adf AW |
2476 | |
2477 | $seen++ if ($block =~ /^\s*{/); | |
2478 | ||
cf655043 AW |
2479 | #print "cond<$cond> block<$block> allowed<$allowed>\n"; |
2480 | if (statement_lines($cond) > 1) { | |
2481 | #print "APW: ALLOWED: cond<$cond>\n"; | |
13214adf AW |
2482 | $allowed = 1; |
2483 | } | |
2484 | if ($block =~/\b(?:if|for|while)\b/) { | |
cf655043 | 2485 | #print "APW: ALLOWED: block<$block>\n"; |
13214adf AW |
2486 | $allowed = 1; |
2487 | } | |
cf655043 AW |
2488 | if (statement_block_size($block) > 1) { |
2489 | #print "APW: ALLOWED: lines block<$block>\n"; | |
13214adf AW |
2490 | $allowed = 1; |
2491 | } | |
2492 | } | |
2493 | if ($seen && !$allowed) { | |
cf655043 | 2494 | WARN("braces {} are not necessary for any arm of this statement\n" . $herectx); |
13214adf AW |
2495 | } |
2496 | } | |
2497 | } | |
773647a0 | 2498 | if (!defined $suppress_ifbraces{$linenr - 1} && |
13214adf | 2499 | $line =~ /\b(if|while|for|else)\b/) { |
cf655043 AW |
2500 | my $allowed = 0; |
2501 | ||
2502 | # Check the pre-context. | |
2503 | if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { | |
2504 | #print "APW: ALLOWED: pre<$1>\n"; | |
2505 | $allowed = 1; | |
2506 | } | |
773647a0 AW |
2507 | |
2508 | my ($level, $endln, @chunks) = | |
2509 | ctx_statement_full($linenr, $realcnt, $-[0]); | |
2510 | ||
cf655043 AW |
2511 | # Check the condition. |
2512 | my ($cond, $block) = @{$chunks[0]}; | |
773647a0 | 2513 | #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; |
cf655043 | 2514 | if (defined $cond) { |
773647a0 | 2515 | substr($block, 0, length($cond), ''); |
cf655043 AW |
2516 | } |
2517 | if (statement_lines($cond) > 1) { | |
2518 | #print "APW: ALLOWED: cond<$cond>\n"; | |
2519 | $allowed = 1; | |
2520 | } | |
2521 | if ($block =~/\b(?:if|for|while)\b/) { | |
2522 | #print "APW: ALLOWED: block<$block>\n"; | |
2523 | $allowed = 1; | |
2524 | } | |
2525 | if (statement_block_size($block) > 1) { | |
2526 | #print "APW: ALLOWED: lines block<$block>\n"; | |
2527 | $allowed = 1; | |
2528 | } | |
2529 | # Check the post-context. | |
2530 | if (defined $chunks[1]) { | |
2531 | my ($cond, $block) = @{$chunks[1]}; | |
2532 | if (defined $cond) { | |
773647a0 | 2533 | substr($block, 0, length($cond), ''); |
cf655043 AW |
2534 | } |
2535 | if ($block =~ /^\s*\{/) { | |
2536 | #print "APW: ALLOWED: chunk-1 block<$block>\n"; | |
2537 | $allowed = 1; | |
2538 | } | |
2539 | } | |
2540 | if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { | |
2541 | my $herectx = $here . "\n";; | |
f055663c | 2542 | my $cnt = statement_rawlines($block); |
cf655043 | 2543 | |
f055663c AW |
2544 | for (my $n = 0; $n < $cnt; $n++) { |
2545 | $herectx .= raw_line($linenr, $n) . "\n";; | |
f0a594c1 | 2546 | } |
cf655043 AW |
2547 | |
2548 | WARN("braces {} are not necessary for single statement blocks\n" . $herectx); | |
f0a594c1 AW |
2549 | } |
2550 | } | |
2551 | ||
653d4876 | 2552 | # don't include deprecated include files (uses RAW line) |
4a0df2ef | 2553 | for my $inc (@dep_includes) { |
c45dcabd | 2554 | if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) { |
de7d4f0e | 2555 | ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr); |
0a920b5b AW |
2556 | } |
2557 | } | |
2558 | ||
4a0df2ef AW |
2559 | # don't use deprecated functions |
2560 | for my $func (@dep_functions) { | |
00df344f | 2561 | if ($line =~ /\b$func\b/) { |
de7d4f0e | 2562 | ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr); |
4a0df2ef AW |
2563 | } |
2564 | } | |
2565 | ||
2566 | # no volatiles please | |
6c72ffaa AW |
2567 | my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; |
2568 | if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { | |
de7d4f0e | 2569 | WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); |
4a0df2ef AW |
2570 | } |
2571 | ||
9c0ca6f9 AW |
2572 | # SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated |
2573 | if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) { | |
2574 | ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr); | |
2575 | } | |
2576 | ||
00df344f | 2577 | # warn about #if 0 |
c45dcabd | 2578 | if ($line =~ /^.\s*\#\s*if\s+0\b/) { |
de7d4f0e AW |
2579 | CHK("if this code is redundant consider removing it\n" . |
2580 | $herecurr); | |
4a0df2ef AW |
2581 | } |
2582 | ||
f0a594c1 AW |
2583 | # check for needless kfree() checks |
2584 | if ($prevline =~ /\bif\s*\(([^\)]*)\)/) { | |
2585 | my $expr = $1; | |
2586 | if ($line =~ /\bkfree\(\Q$expr\E\);/) { | |
3c232147 | 2587 | WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev); |
f0a594c1 AW |
2588 | } |
2589 | } | |
4c432a8f GKH |
2590 | # check for needless usb_free_urb() checks |
2591 | if ($prevline =~ /\bif\s*\(([^\)]*)\)/) { | |
2592 | my $expr = $1; | |
2593 | if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) { | |
2594 | WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev); | |
2595 | } | |
2596 | } | |
f0a594c1 | 2597 | |
1a15a250 PP |
2598 | # prefer usleep_range over udelay |
2599 | if ($line =~ /\budelay\s*\(\s*(\w+)\s*\)/) { | |
2600 | # ignore udelay's < 10, however | |
2601 | if (! (($1 =~ /(\d+)/) && ($1 < 10)) ) { | |
2602 | CHK("usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line); | |
2603 | } | |
2604 | } | |
2605 | ||
09ef8725 PP |
2606 | # warn about unexpectedly long msleep's |
2607 | if ($line =~ /\bmsleep\s*\((\d+)\);/) { | |
2608 | if ($1 < 20) { | |
2609 | WARN("msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line); | |
2610 | } | |
2611 | } | |
2612 | ||
00df344f | 2613 | # warn about #ifdefs in C files |
c45dcabd | 2614 | # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { |
00df344f AW |
2615 | # print "#ifdef in C files should be avoided\n"; |
2616 | # print "$herecurr"; | |
2617 | # $clean = 0; | |
2618 | # } | |
2619 | ||
22f2a2ef | 2620 | # warn about spacing in #ifdefs |
c45dcabd | 2621 | if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { |
22f2a2ef AW |
2622 | ERROR("exactly one space required after that #$1\n" . $herecurr); |
2623 | } | |
2624 | ||
4a0df2ef | 2625 | # check for spinlock_t definitions without a comment. |
171ae1a4 AW |
2626 | if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || |
2627 | $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { | |
4a0df2ef AW |
2628 | my $which = $1; |
2629 | if (!ctx_has_comment($first_line, $linenr)) { | |
de7d4f0e | 2630 | CHK("$1 definition without comment\n" . $herecurr); |
4a0df2ef AW |
2631 | } |
2632 | } | |
2633 | # check for memory barriers without a comment. | |
2634 | if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { | |
2635 | if (!ctx_has_comment($first_line, $linenr)) { | |
de7d4f0e | 2636 | CHK("memory barrier without comment\n" . $herecurr); |
4a0df2ef AW |
2637 | } |
2638 | } | |
2639 | # check of hardware specific defines | |
c45dcabd | 2640 | if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { |
de7d4f0e | 2641 | CHK("architecture specific defines should be avoided\n" . $herecurr); |
0a920b5b | 2642 | } |
653d4876 | 2643 | |
d4977c78 TK |
2644 | # Check that the storage class is at the beginning of a declaration |
2645 | if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { | |
2646 | WARN("storage class should be at the beginning of the declaration\n" . $herecurr) | |
2647 | } | |
2648 | ||
de7d4f0e AW |
2649 | # check the location of the inline attribute, that it is between |
2650 | # storage class and type. | |
9c0ca6f9 AW |
2651 | if ($line =~ /\b$Type\s+$Inline\b/ || |
2652 | $line =~ /\b$Inline\s+$Storage\b/) { | |
de7d4f0e AW |
2653 | ERROR("inline keyword should sit between storage class and type\n" . $herecurr); |
2654 | } | |
2655 | ||
8905a67c AW |
2656 | # Check for __inline__ and __inline, prefer inline |
2657 | if ($line =~ /\b(__inline__|__inline)\b/) { | |
2658 | WARN("plain inline is preferred over $1\n" . $herecurr); | |
2659 | } | |
2660 | ||
8f53a9b8 JP |
2661 | # check for sizeof(&) |
2662 | if ($line =~ /\bsizeof\s*\(\s*\&/) { | |
2663 | WARN("sizeof(& should be avoided\n" . $herecurr); | |
2664 | } | |
2665 | ||
de7d4f0e | 2666 | # check for new externs in .c files. |
171ae1a4 | 2667 | if ($realfile =~ /\.c$/ && defined $stat && |
c45dcabd | 2668 | $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) |
171ae1a4 | 2669 | { |
c45dcabd AW |
2670 | my $function_name = $1; |
2671 | my $paren_space = $2; | |
171ae1a4 AW |
2672 | |
2673 | my $s = $stat; | |
2674 | if (defined $cond) { | |
2675 | substr($s, 0, length($cond), ''); | |
2676 | } | |
c45dcabd AW |
2677 | if ($s =~ /^\s*;/ && |
2678 | $function_name ne 'uninitialized_var') | |
2679 | { | |
171ae1a4 AW |
2680 | WARN("externs should be avoided in .c files\n" . $herecurr); |
2681 | } | |
2682 | ||
2683 | if ($paren_space =~ /\n/) { | |
2684 | WARN("arguments for function declarations should follow identifier\n" . $herecurr); | |
2685 | } | |
9c9ba34e AW |
2686 | |
2687 | } elsif ($realfile =~ /\.c$/ && defined $stat && | |
2688 | $stat =~ /^.\s*extern\s+/) | |
2689 | { | |
2690 | WARN("externs should be avoided in .c files\n" . $herecurr); | |
de7d4f0e AW |
2691 | } |
2692 | ||
2693 | # checks for new __setup's | |
2694 | if ($rawline =~ /\b__setup\("([^"]*)"/) { | |
2695 | my $name = $1; | |
2696 | ||
2697 | if (!grep(/$name/, @setup_docs)) { | |
2698 | CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); | |
2699 | } | |
653d4876 | 2700 | } |
9c0ca6f9 AW |
2701 | |
2702 | # check for pointless casting of kmalloc return | |
2703 | if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) { | |
2704 | WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); | |
2705 | } | |
13214adf AW |
2706 | |
2707 | # check for gcc specific __FUNCTION__ | |
2708 | if ($line =~ /__FUNCTION__/) { | |
2709 | WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr); | |
2710 | } | |
773647a0 AW |
2711 | |
2712 | # check for semaphores used as mutexes | |
171ae1a4 | 2713 | if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) { |
773647a0 AW |
2714 | WARN("mutexes are preferred for single holder semaphores\n" . $herecurr); |
2715 | } | |
2716 | # check for semaphores used as mutexes | |
171ae1a4 | 2717 | if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) { |
773647a0 | 2718 | WARN("consider using a completion\n" . $herecurr); |
1704f47b | 2719 | |
773647a0 AW |
2720 | } |
2721 | # recommend strict_strto* over simple_strto* | |
2722 | if ($line =~ /\bsimple_(strto.*?)\s*\(/) { | |
2723 | WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr); | |
2724 | } | |
f3db6639 ME |
2725 | # check for __initcall(), use device_initcall() explicitly please |
2726 | if ($line =~ /^.\s*__initcall\s*\(/) { | |
2727 | WARN("please use device_initcall() instead of __initcall()\n" . $herecurr); | |
2728 | } | |
79404849 ER |
2729 | # check for various ops structs, ensure they are const. |
2730 | my $struct_ops = qr{acpi_dock_ops| | |
2731 | address_space_operations| | |
2732 | backlight_ops| | |
2733 | block_device_operations| | |
2734 | dentry_operations| | |
2735 | dev_pm_ops| | |
2736 | dma_map_ops| | |
2737 | extent_io_ops| | |
2738 | file_lock_operations| | |
2739 | file_operations| | |
2740 | hv_ops| | |
2741 | ide_dma_ops| | |
2742 | intel_dvo_dev_ops| | |
2743 | item_operations| | |
2744 | iwl_ops| | |
2745 | kgdb_arch| | |
2746 | kgdb_io| | |
2747 | kset_uevent_ops| | |
2748 | lock_manager_operations| | |
2749 | microcode_ops| | |
2750 | mtrr_ops| | |
2751 | neigh_ops| | |
2752 | nlmsvc_binding| | |
2753 | pci_raw_ops| | |
2754 | pipe_buf_operations| | |
2755 | platform_hibernation_ops| | |
2756 | platform_suspend_ops| | |
2757 | proto_ops| | |
2758 | rpc_pipe_ops| | |
2759 | seq_operations| | |
2760 | snd_ac97_build_ops| | |
2761 | soc_pcmcia_socket_ops| | |
2762 | stacktrace_ops| | |
2763 | sysfs_ops| | |
2764 | tty_operations| | |
2765 | usb_mon_operations| | |
2766 | wd_ops}x; | |
6903ffb2 | 2767 | if ($line !~ /\bconst\b/ && |
79404849 | 2768 | $line =~ /\bstruct\s+($struct_ops)\b/) { |
6903ffb2 AW |
2769 | WARN("struct $1 should normally be const\n" . |
2770 | $herecurr); | |
2b6db5cb | 2771 | } |
773647a0 AW |
2772 | |
2773 | # use of NR_CPUS is usually wrong | |
2774 | # ignore definitions of NR_CPUS and usage to define arrays as likely right | |
2775 | if ($line =~ /\bNR_CPUS\b/ && | |
c45dcabd AW |
2776 | $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && |
2777 | $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && | |
171ae1a4 AW |
2778 | $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && |
2779 | $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && | |
2780 | $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) | |
773647a0 AW |
2781 | { |
2782 | WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); | |
2783 | } | |
9c9ba34e AW |
2784 | |
2785 | # check for %L{u,d,i} in strings | |
2786 | my $string; | |
2787 | while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { | |
2788 | $string = substr($rawline, $-[1], $+[1] - $-[1]); | |
2a1bc5d5 | 2789 | $string =~ s/%%/__/g; |
9c9ba34e AW |
2790 | if ($string =~ /(?<!%)%L[udi]/) { |
2791 | WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); | |
2792 | last; | |
2793 | } | |
2794 | } | |
691d77b6 AW |
2795 | |
2796 | # whine mightly about in_atomic | |
2797 | if ($line =~ /\bin_atomic\s*\(/) { | |
2798 | if ($realfile =~ m@^drivers/@) { | |
2799 | ERROR("do not use in_atomic in drivers\n" . $herecurr); | |
f4a87736 | 2800 | } elsif ($realfile !~ m@^kernel/@) { |
691d77b6 AW |
2801 | WARN("use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); |
2802 | } | |
2803 | } | |
1704f47b PZ |
2804 | |
2805 | # check for lockdep_set_novalidate_class | |
2806 | if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || | |
2807 | $line =~ /__lockdep_no_validate__\s*\)/ ) { | |
2808 | if ($realfile !~ m@^kernel/lockdep@ && | |
2809 | $realfile !~ m@^include/linux/lockdep@ && | |
2810 | $realfile !~ m@^drivers/base/core@) { | |
2811 | ERROR("lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); | |
2812 | } | |
2813 | } | |
13214adf AW |
2814 | } |
2815 | ||
2816 | # If we have no input at all, then there is nothing to report on | |
2817 | # so just keep quiet. | |
2818 | if ($#rawlines == -1) { | |
2819 | exit(0); | |
0a920b5b AW |
2820 | } |
2821 | ||
8905a67c AW |
2822 | # In mailback mode only produce a report in the negative, for |
2823 | # things that appear to be patches. | |
2824 | if ($mailback && ($clean == 1 || !$is_patch)) { | |
2825 | exit(0); | |
2826 | } | |
2827 | ||
2828 | # This is not a patch, and we are are in 'no-patch' mode so | |
2829 | # just keep quiet. | |
2830 | if (!$chk_patch && !$is_patch) { | |
2831 | exit(0); | |
2832 | } | |
2833 | ||
2834 | if (!$is_patch) { | |
de7d4f0e | 2835 | ERROR("Does not appear to be a unified-diff format patch\n"); |
0a920b5b AW |
2836 | } |
2837 | if ($is_patch && $chk_signoff && $signoff == 0) { | |
de7d4f0e | 2838 | ERROR("Missing Signed-off-by: line(s)\n"); |
0a920b5b AW |
2839 | } |
2840 | ||
8905a67c | 2841 | print report_dump(); |
13214adf AW |
2842 | if ($summary && !($clean == 1 && $quiet == 1)) { |
2843 | print "$filename " if ($summary_file); | |
8905a67c AW |
2844 | print "total: $cnt_error errors, $cnt_warn warnings, " . |
2845 | (($check)? "$cnt_chk checks, " : "") . | |
2846 | "$cnt_lines lines checked\n"; | |
2847 | print "\n" if ($quiet == 0); | |
f0a594c1 | 2848 | } |
8905a67c | 2849 | |
d2c0a235 AW |
2850 | if ($quiet == 0) { |
2851 | # If there were whitespace errors which cleanpatch can fix | |
2852 | # then suggest that. | |
2853 | if ($rpt_cleaners) { | |
2854 | print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n"; | |
2855 | print " scripts/cleanfile\n\n"; | |
2856 | } | |
2857 | } | |
2858 | ||
0a920b5b | 2859 | if ($clean == 1 && $quiet == 0) { |
c2fdda0d | 2860 | print "$vname has no obvious style problems and is ready for submission.\n" |
0a920b5b AW |
2861 | } |
2862 | if ($clean == 0 && $quiet == 0) { | |
c2fdda0d | 2863 | print "$vname has style problems, please review. If any of these errors\n"; |
0a920b5b AW |
2864 | print "are false positives report them to the maintainer, see\n"; |
2865 | print "CHECKPATCH in MAINTAINERS.\n"; | |
2866 | } | |
13214adf | 2867 | |
0a920b5b AW |
2868 | return $clean; |
2869 | } |