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