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