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