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