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