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