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