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