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