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