e3bfcbe8a520b63639b04115bf148fb4ddd144eb
[linux-2.6.git] / scripts / checkpatch.pl
1 #!/usr/bin/perl -w
2 # (c) 2001, Dave Jones. (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-2010 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.32';
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 $show_types = 0;
30 my $root;
31 my %debug;
32 my %ignore_type = ();
33 my @ignore = ();
34 my $help = 0;
35 my $configuration_file = ".checkpatch.conf";
36
37 sub help {
38         my ($exitcode) = @_;
39
40         print << "EOM";
41 Usage: $P [OPTION]... [FILE]...
42 Version: $V
43
44 Options:
45   -q, --quiet                quiet
46   --no-tree                  run without a kernel tree
47   --no-signoff               do not check for 'Signed-off-by' line
48   --patch                    treat FILE as patchfile (default)
49   --emacs                    emacs compile window format
50   --terse                    one line per report
51   -f, --file                 treat FILE as regular source file
52   --subjective, --strict     enable more subjective tests
53   --ignore TYPE(,TYPE2...)   ignore various comma separated message types
54   --show-types               show the message "types" in the output
55   --root=PATH                PATH to the kernel tree root
56   --no-summary               suppress the per-file summary
57   --mailback                 only produce a report in case of warnings/errors
58   --summary-file             include the filename in summary
59   --debug KEY=[0|1]          turn on/off debugging of KEY, where KEY is one of
60                              'values', 'possible', 'type', and 'attr' (default
61                              is all off)
62   --test-only=WORD           report only warnings/errors containing WORD
63                              literally
64   -h, --help, --version      display this help and exit
65
66 When FILE is - read standard input.
67 EOM
68
69         exit($exitcode);
70 }
71
72 my $conf = which_conf($configuration_file);
73 if (-f $conf) {
74         my @conf_args;
75         open(my $conffile, '<', "$conf")
76             or warn "$P: Can't find a readable $configuration_file file $!\n";
77
78         while (<$conffile>) {
79                 my $line = $_;
80
81                 $line =~ s/\s*\n?$//g;
82                 $line =~ s/^\s*//g;
83                 $line =~ s/\s+/ /g;
84
85                 next if ($line =~ m/^\s*#/);
86                 next if ($line =~ m/^\s*$/);
87
88                 my @words = split(" ", $line);
89                 foreach my $word (@words) {
90                         last if ($word =~ m/^#/);
91                         push (@conf_args, $word);
92                 }
93         }
94         close($conffile);
95         unshift(@ARGV, @conf_args) if @conf_args;
96 }
97
98 GetOptions(
99         'q|quiet+'      => \$quiet,
100         'tree!'         => \$tree,
101         'signoff!'      => \$chk_signoff,
102         'patch!'        => \$chk_patch,
103         'emacs!'        => \$emacs,
104         'terse!'        => \$terse,
105         'f|file!'       => \$file,
106         'subjective!'   => \$check,
107         'strict!'       => \$check,
108         'ignore=s'      => \@ignore,
109         'show-types!'   => \$show_types,
110         'root=s'        => \$root,
111         'summary!'      => \$summary,
112         'mailback!'     => \$mailback,
113         'summary-file!' => \$summary_file,
114
115         'debug=s'       => \%debug,
116         'test-only=s'   => \$tst_only,
117         'h|help'        => \$help,
118         'version'       => \$help
119 ) or help(1);
120
121 help(0) if ($help);
122
123 my $exit = 0;
124
125 if ($#ARGV < 0) {
126         print "$P: no input files\n";
127         exit(1);
128 }
129
130 @ignore = split(/,/, join(',',@ignore));
131 foreach my $word (@ignore) {
132         $word =~ s/\s*\n?$//g;
133         $word =~ s/^\s*//g;
134         $word =~ s/\s+/ /g;
135         $word =~ tr/[a-z]/[A-Z]/;
136
137         next if ($word =~ m/^\s*#/);
138         next if ($word =~ m/^\s*$/);
139
140         $ignore_type{$word}++;
141 }
142
143 my $dbg_values = 0;
144 my $dbg_possible = 0;
145 my $dbg_type = 0;
146 my $dbg_attr = 0;
147 for my $key (keys %debug) {
148         ## no critic
149         eval "\${dbg_$key} = '$debug{$key}';";
150         die "$@" if ($@);
151 }
152
153 my $rpt_cleaners = 0;
154
155 if ($terse) {
156         $emacs = 1;
157         $quiet++;
158 }
159
160 if ($tree) {
161         if (defined $root) {
162                 if (!top_of_kernel_tree($root)) {
163                         die "$P: $root: --root does not point at a valid tree\n";
164                 }
165         } else {
166                 if (top_of_kernel_tree('.')) {
167                         $root = '.';
168                 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
169                                                 top_of_kernel_tree($1)) {
170                         $root = $1;
171                 }
172         }
173
174         if (!defined $root) {
175                 print "Must be run from the top-level dir. of a kernel tree\n";
176                 exit(2);
177         }
178 }
179
180 my $emitted_corrupt = 0;
181
182 our $Ident      = qr{
183                         [A-Za-z_][A-Za-z\d_]*
184                         (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
185                 }x;
186 our $Storage    = qr{extern|static|asmlinkage};
187 our $Sparse     = qr{
188                         __user|
189                         __kernel|
190                         __force|
191                         __iomem|
192                         __must_check|
193                         __init_refok|
194                         __kprobes|
195                         __ref|
196                         __rcu
197                 }x;
198
199 # Notes to $Attribute:
200 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
201 our $Attribute  = qr{
202                         const|
203                         __percpu|
204                         __nocast|
205                         __safe|
206                         __bitwise__|
207                         __packed__|
208                         __packed2__|
209                         __naked|
210                         __maybe_unused|
211                         __always_unused|
212                         __noreturn|
213                         __used|
214                         __cold|
215                         __noclone|
216                         __deprecated|
217                         __read_mostly|
218                         __kprobes|
219                         __(?:mem|cpu|dev|)(?:initdata|initconst|init\b)|
220                         ____cacheline_aligned|
221                         ____cacheline_aligned_in_smp|
222                         ____cacheline_internodealigned_in_smp|
223                         __weak
224                   }x;
225 our $Modifier;
226 our $Inline     = qr{inline|__always_inline|noinline};
227 our $Member     = qr{->$Ident|\.$Ident|\[[^]]*\]};
228 our $Lval       = qr{$Ident(?:$Member)*};
229
230 our $Constant   = qr{(?i:(?:[0-9]+|0x[0-9a-f]+)[ul]*)};
231 our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
232 our $Compare    = qr{<=|>=|==|!=|<|>};
233 our $Operators  = qr{
234                         <=|>=|==|!=|
235                         =>|->|<<|>>|<|>|!|~|
236                         &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
237                   }x;
238
239 our $NonptrType;
240 our $Type;
241 our $Declare;
242
243 our $NON_ASCII_UTF8     = qr{
244         [\xC2-\xDF][\x80-\xBF]               # non-overlong 2-byte
245         |  \xE0[\xA0-\xBF][\x80-\xBF]        # excluding overlongs
246         | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2}  # straight 3-byte
247         |  \xED[\x80-\x9F][\x80-\xBF]        # excluding surrogates
248         |  \xF0[\x90-\xBF][\x80-\xBF]{2}     # planes 1-3
249         | [\xF1-\xF3][\x80-\xBF]{3}          # planes 4-15
250         |  \xF4[\x80-\x8F][\x80-\xBF]{2}     # plane 16
251 }x;
252
253 our $UTF8       = qr{
254         [\x09\x0A\x0D\x20-\x7E]              # ASCII
255         | $NON_ASCII_UTF8
256 }x;
257
258 our $typeTypedefs = qr{(?x:
259         (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
260         atomic_t
261 )};
262
263 our $logFunctions = qr{(?x:
264         printk(?:_ratelimited|_once|)|
265         [a-z0-9]+_(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
266         WARN(?:_RATELIMIT|_ONCE|)|
267         panic|
268         MODULE_[A-Z_]+
269 )};
270
271 our $signature_tags = qr{(?xi:
272         Signed-off-by:|
273         Acked-by:|
274         Tested-by:|
275         Reviewed-by:|
276         Reported-by:|
277         To:|
278         Cc:
279 )};
280
281 our @typeList = (
282         qr{void},
283         qr{(?:unsigned\s+)?char},
284         qr{(?:unsigned\s+)?short},
285         qr{(?:unsigned\s+)?int},
286         qr{(?:unsigned\s+)?long},
287         qr{(?:unsigned\s+)?long\s+int},
288         qr{(?:unsigned\s+)?long\s+long},
289         qr{(?:unsigned\s+)?long\s+long\s+int},
290         qr{unsigned},
291         qr{float},
292         qr{double},
293         qr{bool},
294         qr{struct\s+$Ident},
295         qr{union\s+$Ident},
296         qr{enum\s+$Ident},
297         qr{${Ident}_t},
298         qr{${Ident}_handler},
299         qr{${Ident}_handler_fn},
300 );
301 our @modifierList = (
302         qr{fastcall},
303 );
304
305 our $allowed_asm_includes = qr{(?x:
306         irq|
307         memory
308 )};
309 # memory.h: ARM has a custom one
310
311 sub build_types {
312         my $mods = "(?x:  \n" . join("|\n  ", @modifierList) . "\n)";
313         my $all = "(?x:  \n" . join("|\n  ", @typeList) . "\n)";
314         $Modifier       = qr{(?:$Attribute|$Sparse|$mods)};
315         $NonptrType     = qr{
316                         (?:$Modifier\s+|const\s+)*
317                         (?:
318                                 (?:typeof|__typeof__)\s*\([^\)]*\)|
319                                 (?:$typeTypedefs\b)|
320                                 (?:${all}\b)
321                         )
322                         (?:\s+$Modifier|\s+const)*
323                   }x;
324         $Type   = qr{
325                         $NonptrType
326                         (?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)?
327                         (?:\s+$Inline|\s+$Modifier)*
328                   }x;
329         $Declare        = qr{(?:$Storage\s+)?$Type};
330 }
331 build_types();
332
333 our $match_balanced_parentheses = qr/(\((?:[^\(\)]+|(-1))*\))/;
334
335 our $Typecast   = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
336 our $LvalOrFunc = qr{($Lval)\s*($match_balanced_parentheses{0,1})\s*};
337 our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
338
339 sub deparenthesize {
340         my ($string) = @_;
341         return "" if (!defined($string));
342         $string =~ s@^\s*\(\s*@@g;
343         $string =~ s@\s*\)\s*$@@g;
344         $string =~ s@\s+@ @g;
345         return $string;
346 }
347
348 $chk_signoff = 0 if ($file);
349
350 my @dep_includes = ();
351 my @dep_functions = ();
352 my $removal = "Documentation/feature-removal-schedule.txt";
353 if ($tree && -f "$root/$removal") {
354         open(my $REMOVE, '<', "$root/$removal") ||
355                                 die "$P: $removal: open failed - $!\n";
356         while (<$REMOVE>) {
357                 if (/^Check:\s+(.*\S)/) {
358                         for my $entry (split(/[, ]+/, $1)) {
359                                 if ($entry =~ m@include/(.*)@) {
360                                         push(@dep_includes, $1);
361
362                                 } elsif ($entry !~ m@/@) {
363                                         push(@dep_functions, $entry);
364                                 }
365                         }
366                 }
367         }
368         close($REMOVE);
369 }
370
371 my @rawlines = ();
372 my @lines = ();
373 my $vname;
374 for my $filename (@ARGV) {
375         my $FILE;
376         if ($file) {
377                 open($FILE, '-|', "diff -u /dev/null $filename") ||
378                         die "$P: $filename: diff failed - $!\n";
379         } elsif ($filename eq '-') {
380                 open($FILE, '<&STDIN');
381         } else {
382                 open($FILE, '<', "$filename") ||
383                         die "$P: $filename: open failed - $!\n";
384         }
385         if ($filename eq '-') {
386                 $vname = 'Your patch';
387         } else {
388                 $vname = $filename;
389         }
390         while (<$FILE>) {
391                 chomp;
392                 push(@rawlines, $_);
393         }
394         close($FILE);
395         if (!process($filename)) {
396                 $exit = 1;
397         }
398         @rawlines = ();
399         @lines = ();
400 }
401
402 exit($exit);
403
404 sub top_of_kernel_tree {
405         my ($root) = @_;
406
407         my @tree_check = (
408                 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
409                 "README", "Documentation", "arch", "include", "drivers",
410                 "fs", "init", "ipc", "kernel", "lib", "scripts",
411         );
412
413         foreach my $check (@tree_check) {
414                 if (! -e $root . '/' . $check) {
415                         return 0;
416                 }
417         }
418         return 1;
419     }
420
421 sub parse_email {
422         my ($formatted_email) = @_;
423
424         my $name = "";
425         my $address = "";
426         my $comment = "";
427
428         if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
429                 $name = $1;
430                 $address = $2;
431                 $comment = $3 if defined $3;
432         } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
433                 $address = $1;
434                 $comment = $2 if defined $2;
435         } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
436                 $address = $1;
437                 $comment = $2 if defined $2;
438                 $formatted_email =~ s/$address.*$//;
439                 $name = $formatted_email;
440                 $name =~ s/^\s+|\s+$//g;
441                 $name =~ s/^\"|\"$//g;
442                 # If there's a name left after stripping spaces and
443                 # leading quotes, and the address doesn't have both
444                 # leading and trailing angle brackets, the address
445                 # is invalid. ie:
446                 #   "joe smith joe@smith.com" bad
447                 #   "joe smith <joe@smith.com" bad
448                 if ($name ne "" && $address !~ /^<[^>]+>$/) {
449                         $name = "";
450                         $address = "";
451                         $comment = "";
452                 }
453         }
454
455         $name =~ s/^\s+|\s+$//g;
456         $name =~ s/^\"|\"$//g;
457         $address =~ s/^\s+|\s+$//g;
458         $address =~ s/^\<|\>$//g;
459
460         if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
461                 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
462                 $name = "\"$name\"";
463         }
464
465         return ($name, $address, $comment);
466 }
467
468 sub format_email {
469         my ($name, $address) = @_;
470
471         my $formatted_email;
472
473         $name =~ s/^\s+|\s+$//g;
474         $name =~ s/^\"|\"$//g;
475         $address =~ s/^\s+|\s+$//g;
476
477         if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
478                 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
479                 $name = "\"$name\"";
480         }
481
482         if ("$name" eq "") {
483                 $formatted_email = "$address";
484         } else {
485                 $formatted_email = "$name <$address>";
486         }
487
488         return $formatted_email;
489 }
490
491 sub which_conf {
492         my ($conf) = @_;
493
494         foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
495                 if (-e "$path/$conf") {
496                         return "$path/$conf";
497                 }
498         }
499
500         return "";
501 }
502
503 sub expand_tabs {
504         my ($str) = @_;
505
506         my $res = '';
507         my $n = 0;
508         for my $c (split(//, $str)) {
509                 if ($c eq "\t") {
510                         $res .= ' ';
511                         $n++;
512                         for (; ($n % 8) != 0; $n++) {
513                                 $res .= ' ';
514                         }
515                         next;
516                 }
517                 $res .= $c;
518                 $n++;
519         }
520
521         return $res;
522 }
523 sub copy_spacing {
524         (my $res = shift) =~ tr/\t/ /c;
525         return $res;
526 }
527
528 sub line_stats {
529         my ($line) = @_;
530
531         # Drop the diff line leader and expand tabs
532         $line =~ s/^.//;
533         $line = expand_tabs($line);
534
535         # Pick the indent from the front of the line.
536         my ($white) = ($line =~ /^(\s*)/);
537
538         return (length($line), length($white));
539 }
540
541 my $sanitise_quote = '';
542
543 sub sanitise_line_reset {
544         my ($in_comment) = @_;
545
546         if ($in_comment) {
547                 $sanitise_quote = '*/';
548         } else {
549                 $sanitise_quote = '';
550         }
551 }
552 sub sanitise_line {
553         my ($line) = @_;
554
555         my $res = '';
556         my $l = '';
557
558         my $qlen = 0;
559         my $off = 0;
560         my $c;
561
562         # Always copy over the diff marker.
563         $res = substr($line, 0, 1);
564
565         for ($off = 1; $off < length($line); $off++) {
566                 $c = substr($line, $off, 1);
567
568                 # Comments we are wacking completly including the begin
569                 # and end, all to $;.
570                 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
571                         $sanitise_quote = '*/';
572
573                         substr($res, $off, 2, "$;$;");
574                         $off++;
575                         next;
576                 }
577                 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
578                         $sanitise_quote = '';
579                         substr($res, $off, 2, "$;$;");
580                         $off++;
581                         next;
582                 }
583                 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
584                         $sanitise_quote = '//';
585
586                         substr($res, $off, 2, $sanitise_quote);
587                         $off++;
588                         next;
589                 }
590
591                 # A \ in a string means ignore the next character.
592                 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
593                     $c eq "\\") {
594                         substr($res, $off, 2, 'XX');
595                         $off++;
596                         next;
597                 }
598                 # Regular quotes.
599                 if ($c eq "'" || $c eq '"') {
600                         if ($sanitise_quote eq '') {
601                                 $sanitise_quote = $c;
602
603                                 substr($res, $off, 1, $c);
604                                 next;
605                         } elsif ($sanitise_quote eq $c) {
606                                 $sanitise_quote = '';
607                         }
608                 }
609
610                 #print "c<$c> SQ<$sanitise_quote>\n";
611                 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
612                         substr($res, $off, 1, $;);
613                 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
614                         substr($res, $off, 1, $;);
615                 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
616                         substr($res, $off, 1, 'X');
617                 } else {
618                         substr($res, $off, 1, $c);
619                 }
620         }
621
622         if ($sanitise_quote eq '//') {
623                 $sanitise_quote = '';
624         }
625
626         # The pathname on a #include may be surrounded by '<' and '>'.
627         if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
628                 my $clean = 'X' x length($1);
629                 $res =~ s@\<.*\>@<$clean>@;
630
631         # The whole of a #error is a string.
632         } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
633                 my $clean = 'X' x length($1);
634                 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
635         }
636
637         return $res;
638 }
639
640 sub ctx_statement_block {
641         my ($linenr, $remain, $off) = @_;
642         my $line = $linenr - 1;
643         my $blk = '';
644         my $soff = $off;
645         my $coff = $off - 1;
646         my $coff_set = 0;
647
648         my $loff = 0;
649
650         my $type = '';
651         my $level = 0;
652         my @stack = ();
653         my $p;
654         my $c;
655         my $len = 0;
656
657         my $remainder;
658         while (1) {
659                 @stack = (['', 0]) if ($#stack == -1);
660
661                 #warn "CSB: blk<$blk> remain<$remain>\n";
662                 # If we are about to drop off the end, pull in more
663                 # context.
664                 if ($off >= $len) {
665                         for (; $remain > 0; $line++) {
666                                 last if (!defined $lines[$line]);
667                                 next if ($lines[$line] =~ /^-/);
668                                 $remain--;
669                                 $loff = $len;
670                                 $blk .= $lines[$line] . "\n";
671                                 $len = length($blk);
672                                 $line++;
673                                 last;
674                         }
675                         # Bail if there is no further context.
676                         #warn "CSB: blk<$blk> off<$off> len<$len>\n";
677                         if ($off >= $len) {
678                                 last;
679                         }
680                         if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
681                                 $level++;
682                                 $type = '#';
683                         }
684                 }
685                 $p = $c;
686                 $c = substr($blk, $off, 1);
687                 $remainder = substr($blk, $off);
688
689                 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
690
691                 # Handle nested #if/#else.
692                 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
693                         push(@stack, [ $type, $level ]);
694                 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
695                         ($type, $level) = @{$stack[$#stack - 1]};
696                 } elsif ($remainder =~ /^#\s*endif\b/) {
697                         ($type, $level) = @{pop(@stack)};
698                 }
699
700                 # Statement ends at the ';' or a close '}' at the
701                 # outermost level.
702                 if ($level == 0 && $c eq ';') {
703                         last;
704                 }
705
706                 # An else is really a conditional as long as its not else if
707                 if ($level == 0 && $coff_set == 0 &&
708                                 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
709                                 $remainder =~ /^(else)(?:\s|{)/ &&
710                                 $remainder !~ /^else\s+if\b/) {
711                         $coff = $off + length($1) - 1;
712                         $coff_set = 1;
713                         #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
714                         #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
715                 }
716
717                 if (($type eq '' || $type eq '(') && $c eq '(') {
718                         $level++;
719                         $type = '(';
720                 }
721                 if ($type eq '(' && $c eq ')') {
722                         $level--;
723                         $type = ($level != 0)? '(' : '';
724
725                         if ($level == 0 && $coff < $soff) {
726                                 $coff = $off;
727                                 $coff_set = 1;
728                                 #warn "CSB: mark coff<$coff>\n";
729                         }
730                 }
731                 if (($type eq '' || $type eq '{') && $c eq '{') {
732                         $level++;
733                         $type = '{';
734                 }
735                 if ($type eq '{' && $c eq '}') {
736                         $level--;
737                         $type = ($level != 0)? '{' : '';
738
739                         if ($level == 0) {
740                                 if (substr($blk, $off + 1, 1) eq ';') {
741                                         $off++;
742                                 }
743                                 last;
744                         }
745                 }
746                 # Preprocessor commands end at the newline unless escaped.
747                 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
748                         $level--;
749                         $type = '';
750                         $off++;
751                         last;
752                 }
753                 $off++;
754         }
755         # We are truly at the end, so shuffle to the next line.
756         if ($off == $len) {
757                 $loff = $len + 1;
758                 $line++;
759                 $remain--;
760         }
761
762         my $statement = substr($blk, $soff, $off - $soff + 1);
763         my $condition = substr($blk, $soff, $coff - $soff + 1);
764
765         #warn "STATEMENT<$statement>\n";
766         #warn "CONDITION<$condition>\n";
767
768         #print "coff<$coff> soff<$off> loff<$loff>\n";
769
770         return ($statement, $condition,
771                         $line, $remain + 1, $off - $loff + 1, $level);
772 }
773
774 sub statement_lines {
775         my ($stmt) = @_;
776
777         # Strip the diff line prefixes and rip blank lines at start and end.
778         $stmt =~ s/(^|\n)./$1/g;
779         $stmt =~ s/^\s*//;
780         $stmt =~ s/\s*$//;
781
782         my @stmt_lines = ($stmt =~ /\n/g);
783
784         return $#stmt_lines + 2;
785 }
786
787 sub statement_rawlines {
788         my ($stmt) = @_;
789
790         my @stmt_lines = ($stmt =~ /\n/g);
791
792         return $#stmt_lines + 2;
793 }
794
795 sub statement_block_size {
796         my ($stmt) = @_;
797
798         $stmt =~ s/(^|\n)./$1/g;
799         $stmt =~ s/^\s*{//;
800         $stmt =~ s/}\s*$//;
801         $stmt =~ s/^\s*//;
802         $stmt =~ s/\s*$//;
803
804         my @stmt_lines = ($stmt =~ /\n/g);
805         my @stmt_statements = ($stmt =~ /;/g);
806
807         my $stmt_lines = $#stmt_lines + 2;
808         my $stmt_statements = $#stmt_statements + 1;
809
810         if ($stmt_lines > $stmt_statements) {
811                 return $stmt_lines;
812         } else {
813                 return $stmt_statements;
814         }
815 }
816
817 sub ctx_statement_full {
818         my ($linenr, $remain, $off) = @_;
819         my ($statement, $condition, $level);
820
821         my (@chunks);
822
823         # Grab the first conditional/block pair.
824         ($statement, $condition, $linenr, $remain, $off, $level) =
825                                 ctx_statement_block($linenr, $remain, $off);
826         #print "F: c<$condition> s<$statement> remain<$remain>\n";
827         push(@chunks, [ $condition, $statement ]);
828         if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
829                 return ($level, $linenr, @chunks);
830         }
831
832         # Pull in the following conditional/block pairs and see if they
833         # could continue the statement.
834         for (;;) {
835                 ($statement, $condition, $linenr, $remain, $off, $level) =
836                                 ctx_statement_block($linenr, $remain, $off);
837                 #print "C: c<$condition> s<$statement> remain<$remain>\n";
838                 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
839                 #print "C: push\n";
840                 push(@chunks, [ $condition, $statement ]);
841         }
842
843         return ($level, $linenr, @chunks);
844 }
845
846 sub ctx_block_get {
847         my ($linenr, $remain, $outer, $open, $close, $off) = @_;
848         my $line;
849         my $start = $linenr - 1;
850         my $blk = '';
851         my @o;
852         my @c;
853         my @res = ();
854
855         my $level = 0;
856         my @stack = ($level);
857         for ($line = $start; $remain > 0; $line++) {
858                 next if ($rawlines[$line] =~ /^-/);
859                 $remain--;
860
861                 $blk .= $rawlines[$line];
862
863                 # Handle nested #if/#else.
864                 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
865                         push(@stack, $level);
866                 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
867                         $level = $stack[$#stack - 1];
868                 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
869                         $level = pop(@stack);
870                 }
871
872                 foreach my $c (split(//, $lines[$line])) {
873                         ##print "C<$c>L<$level><$open$close>O<$off>\n";
874                         if ($off > 0) {
875                                 $off--;
876                                 next;
877                         }
878
879                         if ($c eq $close && $level > 0) {
880                                 $level--;
881                                 last if ($level == 0);
882                         } elsif ($c eq $open) {
883                                 $level++;
884                         }
885                 }
886
887                 if (!$outer || $level <= 1) {
888                         push(@res, $rawlines[$line]);
889                 }
890
891                 last if ($level == 0);
892         }
893
894         return ($level, @res);
895 }
896 sub ctx_block_outer {
897         my ($linenr, $remain) = @_;
898
899         my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
900         return @r;
901 }
902 sub ctx_block {
903         my ($linenr, $remain) = @_;
904
905         my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
906         return @r;
907 }
908 sub ctx_statement {
909         my ($linenr, $remain, $off) = @_;
910
911         my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
912         return @r;
913 }
914 sub ctx_block_level {
915         my ($linenr, $remain) = @_;
916
917         return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
918 }
919 sub ctx_statement_level {
920         my ($linenr, $remain, $off) = @_;
921
922         return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
923 }
924
925 sub ctx_locate_comment {
926         my ($first_line, $end_line) = @_;
927
928         # Catch a comment on the end of the line itself.
929         my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
930         return $current_comment if (defined $current_comment);
931
932         # Look through the context and try and figure out if there is a
933         # comment.
934         my $in_comment = 0;
935         $current_comment = '';
936         for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
937                 my $line = $rawlines[$linenr - 1];
938                 #warn "           $line\n";
939                 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
940                         $in_comment = 1;
941                 }
942                 if ($line =~ m@/\*@) {
943                         $in_comment = 1;
944                 }
945                 if (!$in_comment && $current_comment ne '') {
946                         $current_comment = '';
947                 }
948                 $current_comment .= $line . "\n" if ($in_comment);
949                 if ($line =~ m@\*/@) {
950                         $in_comment = 0;
951                 }
952         }
953
954         chomp($current_comment);
955         return($current_comment);
956 }
957 sub ctx_has_comment {
958         my ($first_line, $end_line) = @_;
959         my $cmt = ctx_locate_comment($first_line, $end_line);
960
961         ##print "LINE: $rawlines[$end_line - 1 ]\n";
962         ##print "CMMT: $cmt\n";
963
964         return ($cmt ne '');
965 }
966
967 sub raw_line {
968         my ($linenr, $cnt) = @_;
969
970         my $offset = $linenr - 1;
971         $cnt++;
972
973         my $line;
974         while ($cnt) {
975                 $line = $rawlines[$offset++];
976                 next if (defined($line) && $line =~ /^-/);
977                 $cnt--;
978         }
979
980         return $line;
981 }
982
983 sub cat_vet {
984         my ($vet) = @_;
985         my ($res, $coded);
986
987         $res = '';
988         while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
989                 $res .= $1;
990                 if ($2 ne '') {
991                         $coded = sprintf("^%c", unpack('C', $2) + 64);
992                         $res .= $coded;
993                 }
994         }
995         $res =~ s/$/\$/;
996
997         return $res;
998 }
999
1000 my $av_preprocessor = 0;
1001 my $av_pending;
1002 my @av_paren_type;
1003 my $av_pend_colon;
1004
1005 sub annotate_reset {
1006         $av_preprocessor = 0;
1007         $av_pending = '_';
1008         @av_paren_type = ('E');
1009         $av_pend_colon = 'O';
1010 }
1011
1012 sub annotate_values {
1013         my ($stream, $type) = @_;
1014
1015         my $res;
1016         my $var = '_' x length($stream);
1017         my $cur = $stream;
1018
1019         print "$stream\n" if ($dbg_values > 1);
1020
1021         while (length($cur)) {
1022                 @av_paren_type = ('E') if ($#av_paren_type < 0);
1023                 print " <" . join('', @av_paren_type) .
1024                                 "> <$type> <$av_pending>" if ($dbg_values > 1);
1025                 if ($cur =~ /^(\s+)/o) {
1026                         print "WS($1)\n" if ($dbg_values > 1);
1027                         if ($1 =~ /\n/ && $av_preprocessor) {
1028                                 $type = pop(@av_paren_type);
1029                                 $av_preprocessor = 0;
1030                         }
1031
1032                 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1033                         print "CAST($1)\n" if ($dbg_values > 1);
1034                         push(@av_paren_type, $type);
1035                         $type = 'c';
1036
1037                 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1038                         print "DECLARE($1)\n" if ($dbg_values > 1);
1039                         $type = 'T';
1040
1041                 } elsif ($cur =~ /^($Modifier)\s*/) {
1042                         print "MODIFIER($1)\n" if ($dbg_values > 1);
1043                         $type = 'T';
1044
1045                 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1046                         print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1047                         $av_preprocessor = 1;
1048                         push(@av_paren_type, $type);
1049                         if ($2 ne '') {
1050                                 $av_pending = 'N';
1051                         }
1052                         $type = 'E';
1053
1054                 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1055                         print "UNDEF($1)\n" if ($dbg_values > 1);
1056                         $av_preprocessor = 1;
1057                         push(@av_paren_type, $type);
1058
1059                 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1060                         print "PRE_START($1)\n" if ($dbg_values > 1);
1061                         $av_preprocessor = 1;
1062
1063                         push(@av_paren_type, $type);
1064                         push(@av_paren_type, $type);
1065                         $type = 'E';
1066
1067                 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1068                         print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1069                         $av_preprocessor = 1;
1070
1071                         push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1072
1073                         $type = 'E';
1074
1075                 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1076                         print "PRE_END($1)\n" if ($dbg_values > 1);
1077
1078                         $av_preprocessor = 1;
1079
1080                         # Assume all arms of the conditional end as this
1081                         # one does, and continue as if the #endif was not here.
1082                         pop(@av_paren_type);
1083                         push(@av_paren_type, $type);
1084                         $type = 'E';
1085
1086                 } elsif ($cur =~ /^(\\\n)/o) {
1087                         print "PRECONT($1)\n" if ($dbg_values > 1);
1088
1089                 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1090                         print "ATTR($1)\n" if ($dbg_values > 1);
1091                         $av_pending = $type;
1092                         $type = 'N';
1093
1094                 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1095                         print "SIZEOF($1)\n" if ($dbg_values > 1);
1096                         if (defined $2) {
1097                                 $av_pending = 'V';
1098                         }
1099                         $type = 'N';
1100
1101                 } elsif ($cur =~ /^(if|while|for)\b/o) {
1102                         print "COND($1)\n" if ($dbg_values > 1);
1103                         $av_pending = 'E';
1104                         $type = 'N';
1105
1106                 } elsif ($cur =~/^(case)/o) {
1107                         print "CASE($1)\n" if ($dbg_values > 1);
1108                         $av_pend_colon = 'C';
1109                         $type = 'N';
1110
1111                 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1112                         print "KEYWORD($1)\n" if ($dbg_values > 1);
1113                         $type = 'N';
1114
1115                 } elsif ($cur =~ /^(\()/o) {
1116                         print "PAREN('$1')\n" if ($dbg_values > 1);
1117                         push(@av_paren_type, $av_pending);
1118                         $av_pending = '_';
1119                         $type = 'N';
1120
1121                 } elsif ($cur =~ /^(\))/o) {
1122                         my $new_type = pop(@av_paren_type);
1123                         if ($new_type ne '_') {
1124                                 $type = $new_type;
1125                                 print "PAREN('$1') -> $type\n"
1126                                                         if ($dbg_values > 1);
1127                         } else {
1128                                 print "PAREN('$1')\n" if ($dbg_values > 1);
1129                         }
1130
1131                 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1132                         print "FUNC($1)\n" if ($dbg_values > 1);
1133                         $type = 'V';
1134                         $av_pending = 'V';
1135
1136                 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1137                         if (defined $2 && $type eq 'C' || $type eq 'T') {
1138                                 $av_pend_colon = 'B';
1139                         } elsif ($type eq 'E') {
1140                                 $av_pend_colon = 'L';
1141                         }
1142                         print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1143                         $type = 'V';
1144
1145                 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1146                         print "IDENT($1)\n" if ($dbg_values > 1);
1147                         $type = 'V';
1148
1149                 } elsif ($cur =~ /^($Assignment)/o) {
1150                         print "ASSIGN($1)\n" if ($dbg_values > 1);
1151                         $type = 'N';
1152
1153                 } elsif ($cur =~/^(;|{|})/) {
1154                         print "END($1)\n" if ($dbg_values > 1);
1155                         $type = 'E';
1156                         $av_pend_colon = 'O';
1157
1158                 } elsif ($cur =~/^(,)/) {
1159                         print "COMMA($1)\n" if ($dbg_values > 1);
1160                         $type = 'C';
1161
1162                 } elsif ($cur =~ /^(\?)/o) {
1163                         print "QUESTION($1)\n" if ($dbg_values > 1);
1164                         $type = 'N';
1165
1166                 } elsif ($cur =~ /^(:)/o) {
1167                         print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1168
1169                         substr($var, length($res), 1, $av_pend_colon);
1170                         if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1171                                 $type = 'E';
1172                         } else {
1173                                 $type = 'N';
1174                         }
1175                         $av_pend_colon = 'O';
1176
1177                 } elsif ($cur =~ /^(\[)/o) {
1178                         print "CLOSE($1)\n" if ($dbg_values > 1);
1179                         $type = 'N';
1180
1181                 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1182                         my $variant;
1183
1184                         print "OPV($1)\n" if ($dbg_values > 1);
1185                         if ($type eq 'V') {
1186                                 $variant = 'B';
1187                         } else {
1188                                 $variant = 'U';
1189                         }
1190
1191                         substr($var, length($res), 1, $variant);
1192                         $type = 'N';
1193
1194                 } elsif ($cur =~ /^($Operators)/o) {
1195                         print "OP($1)\n" if ($dbg_values > 1);
1196                         if ($1 ne '++' && $1 ne '--') {
1197                                 $type = 'N';
1198                         }
1199
1200                 } elsif ($cur =~ /(^.)/o) {
1201                         print "C($1)\n" if ($dbg_values > 1);
1202                 }
1203                 if (defined $1) {
1204                         $cur = substr($cur, length($1));
1205                         $res .= $type x length($1);
1206                 }
1207         }
1208
1209         return ($res, $var);
1210 }
1211
1212 sub possible {
1213         my ($possible, $line) = @_;
1214         my $notPermitted = qr{(?:
1215                 ^(?:
1216                         $Modifier|
1217                         $Storage|
1218                         $Type|
1219                         DEFINE_\S+
1220                 )$|
1221                 ^(?:
1222                         goto|
1223                         return|
1224                         case|
1225                         else|
1226                         asm|__asm__|
1227                         do|
1228                         \#|
1229                         \#\#|
1230                 )(?:\s|$)|
1231                 ^(?:typedef|struct|enum)\b
1232             )}x;
1233         warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1234         if ($possible !~ $notPermitted) {
1235                 # Check for modifiers.
1236                 $possible =~ s/\s*$Storage\s*//g;
1237                 $possible =~ s/\s*$Sparse\s*//g;
1238                 if ($possible =~ /^\s*$/) {
1239
1240                 } elsif ($possible =~ /\s/) {
1241                         $possible =~ s/\s*$Type\s*//g;
1242                         for my $modifier (split(' ', $possible)) {
1243                                 if ($modifier !~ $notPermitted) {
1244                                         warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1245                                         push(@modifierList, $modifier);
1246                                 }
1247                         }
1248
1249                 } else {
1250                         warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1251                         push(@typeList, $possible);
1252                 }
1253                 build_types();
1254         } else {
1255                 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1256         }
1257 }
1258
1259 my $prefix = '';
1260
1261 sub show_type {
1262        return !defined $ignore_type{$_[0]};
1263 }
1264
1265 sub report {
1266         if (!show_type($_[1]) ||
1267             (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) {
1268                 return 0;
1269         }
1270         my $line;
1271         if ($show_types) {
1272                 $line = "$prefix$_[0]:$_[1]: $_[2]\n";
1273         } else {
1274                 $line = "$prefix$_[0]: $_[2]\n";
1275         }
1276         $line = (split('\n', $line))[0] . "\n" if ($terse);
1277
1278         push(our @report, $line);
1279
1280         return 1;
1281 }
1282 sub report_dump {
1283         our @report;
1284 }
1285
1286 sub ERROR {
1287         if (report("ERROR", $_[0], $_[1])) {
1288                 our $clean = 0;
1289                 our $cnt_error++;
1290         }
1291 }
1292 sub WARN {
1293         if (report("WARNING", $_[0], $_[1])) {
1294                 our $clean = 0;
1295                 our $cnt_warn++;
1296         }
1297 }
1298 sub CHK {
1299         if ($check && report("CHECK", $_[0], $_[1])) {
1300                 our $clean = 0;
1301                 our $cnt_chk++;
1302         }
1303 }
1304
1305 sub check_absolute_file {
1306         my ($absolute, $herecurr) = @_;
1307         my $file = $absolute;
1308
1309         ##print "absolute<$absolute>\n";
1310
1311         # See if any suffix of this path is a path within the tree.
1312         while ($file =~ s@^[^/]*/@@) {
1313                 if (-f "$root/$file") {
1314                         ##print "file<$file>\n";
1315                         last;
1316                 }
1317         }
1318         if (! -f _)  {
1319                 return 0;
1320         }
1321
1322         # It is, so see if the prefix is acceptable.
1323         my $prefix = $absolute;
1324         substr($prefix, -length($file)) = '';
1325
1326         ##print "prefix<$prefix>\n";
1327         if ($prefix ne ".../") {
1328                 WARN("USE_RELATIVE_PATH",
1329                      "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1330         }
1331 }
1332
1333 sub process {
1334         my $filename = shift;
1335
1336         my $linenr=0;
1337         my $prevline="";
1338         my $prevrawline="";
1339         my $stashline="";
1340         my $stashrawline="";
1341
1342         my $length;
1343         my $indent;
1344         my $previndent=0;
1345         my $stashindent=0;
1346
1347         our $clean = 1;
1348         my $signoff = 0;
1349         my $is_patch = 0;
1350
1351         my $in_header_lines = 1;
1352         my $in_commit_log = 0;          #Scanning lines before patch
1353
1354         our @report = ();
1355         our $cnt_lines = 0;
1356         our $cnt_error = 0;
1357         our $cnt_warn = 0;
1358         our $cnt_chk = 0;
1359
1360         # Trace the real file/line as we go.
1361         my $realfile = '';
1362         my $realline = 0;
1363         my $realcnt = 0;
1364         my $here = '';
1365         my $in_comment = 0;
1366         my $comment_edge = 0;
1367         my $first_line = 0;
1368         my $p1_prefix = '';
1369
1370         my $prev_values = 'E';
1371
1372         # suppression flags
1373         my %suppress_ifbraces;
1374         my %suppress_whiletrailers;
1375         my %suppress_export;
1376         my $suppress_statement = 0;
1377
1378         # Pre-scan the patch sanitizing the lines.
1379         # Pre-scan the patch looking for any __setup documentation.
1380         #
1381         my @setup_docs = ();
1382         my $setup_docs = 0;
1383
1384         sanitise_line_reset();
1385         my $line;
1386         foreach my $rawline (@rawlines) {
1387                 $linenr++;
1388                 $line = $rawline;
1389
1390                 if ($rawline=~/^\+\+\+\s+(\S+)/) {
1391                         $setup_docs = 0;
1392                         if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1393                                 $setup_docs = 1;
1394                         }
1395                         #next;
1396                 }
1397                 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1398                         $realline=$1-1;
1399                         if (defined $2) {
1400                                 $realcnt=$3+1;
1401                         } else {
1402                                 $realcnt=1+1;
1403                         }
1404                         $in_comment = 0;
1405
1406                         # Guestimate if this is a continuing comment.  Run
1407                         # the context looking for a comment "edge".  If this
1408                         # edge is a close comment then we must be in a comment
1409                         # at context start.
1410                         my $edge;
1411                         my $cnt = $realcnt;
1412                         for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1413                                 next if (defined $rawlines[$ln - 1] &&
1414                                          $rawlines[$ln - 1] =~ /^-/);
1415                                 $cnt--;
1416                                 #print "RAW<$rawlines[$ln - 1]>\n";
1417                                 last if (!defined $rawlines[$ln - 1]);
1418                                 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1419                                     $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1420                                         ($edge) = $1;
1421                                         last;
1422                                 }
1423                         }
1424                         if (defined $edge && $edge eq '*/') {
1425                                 $in_comment = 1;
1426                         }
1427
1428                         # Guestimate if this is a continuing comment.  If this
1429                         # is the start of a diff block and this line starts
1430                         # ' *' then it is very likely a comment.
1431                         if (!defined $edge &&
1432                             $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1433                         {
1434                                 $in_comment = 1;
1435                         }
1436
1437                         ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1438                         sanitise_line_reset($in_comment);
1439
1440                 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1441                         # Standardise the strings and chars within the input to
1442                         # simplify matching -- only bother with positive lines.
1443                         $line = sanitise_line($rawline);
1444                 }
1445                 push(@lines, $line);
1446
1447                 if ($realcnt > 1) {
1448                         $realcnt-- if ($line =~ /^(?:\+| |$)/);
1449                 } else {
1450                         $realcnt = 0;
1451                 }
1452
1453                 #print "==>$rawline\n";
1454                 #print "-->$line\n";
1455
1456                 if ($setup_docs && $line =~ /^\+/) {
1457                         push(@setup_docs, $line);
1458                 }
1459         }
1460
1461         $prefix = '';
1462
1463         $realcnt = 0;
1464         $linenr = 0;
1465         foreach my $line (@lines) {
1466                 $linenr++;
1467
1468                 my $rawline = $rawlines[$linenr - 1];
1469
1470 #extract the line range in the file after the patch is applied
1471                 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1472                         $is_patch = 1;
1473                         $first_line = $linenr + 1;
1474                         $realline=$1-1;
1475                         if (defined $2) {
1476                                 $realcnt=$3+1;
1477                         } else {
1478                                 $realcnt=1+1;
1479                         }
1480                         annotate_reset();
1481                         $prev_values = 'E';
1482
1483                         %suppress_ifbraces = ();
1484                         %suppress_whiletrailers = ();
1485                         %suppress_export = ();
1486                         $suppress_statement = 0;
1487                         next;
1488
1489 # track the line number as we move through the hunk, note that
1490 # new versions of GNU diff omit the leading space on completely
1491 # blank context lines so we need to count that too.
1492                 } elsif ($line =~ /^( |\+|$)/) {
1493                         $realline++;
1494                         $realcnt-- if ($realcnt != 0);
1495
1496                         # Measure the line length and indent.
1497                         ($length, $indent) = line_stats($rawline);
1498
1499                         # Track the previous line.
1500                         ($prevline, $stashline) = ($stashline, $line);
1501                         ($previndent, $stashindent) = ($stashindent, $indent);
1502                         ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1503
1504                         #warn "line<$line>\n";
1505
1506                 } elsif ($realcnt == 1) {
1507                         $realcnt--;
1508                 }
1509
1510                 my $hunk_line = ($realcnt != 0);
1511
1512 #make up the handle for any error we report on this line
1513                 $prefix = "$filename:$realline: " if ($emacs && $file);
1514                 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1515
1516                 $here = "#$linenr: " if (!$file);
1517                 $here = "#$realline: " if ($file);
1518
1519                 # extract the filename as it passes
1520                 if ($line =~ /^diff --git.*?(\S+)$/) {
1521                         $realfile = $1;
1522                         $realfile =~ s@^([^/]*)/@@;
1523                         $in_commit_log = 0;
1524                 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
1525                         $realfile = $1;
1526                         $realfile =~ s@^([^/]*)/@@;
1527                         $in_commit_log = 0;
1528
1529                         $p1_prefix = $1;
1530                         if (!$file && $tree && $p1_prefix ne '' &&
1531                             -e "$root/$p1_prefix") {
1532                                 WARN("PATCH_PREFIX",
1533                                      "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1534                         }
1535
1536                         if ($realfile =~ m@^include/asm/@) {
1537                                 ERROR("MODIFIED_INCLUDE_ASM",
1538                                       "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1539                         }
1540                         next;
1541                 }
1542
1543                 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
1544
1545                 my $hereline = "$here\n$rawline\n";
1546                 my $herecurr = "$here\n$rawline\n";
1547                 my $hereprev = "$here\n$prevrawline\n$rawline\n";
1548
1549                 $cnt_lines++ if ($realcnt != 0);
1550
1551 # Check for incorrect file permissions
1552                 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1553                         my $permhere = $here . "FILE: $realfile\n";
1554                         if ($realfile =~ /(Makefile|Kconfig|\.c|\.h|\.S|\.tmpl)$/) {
1555                                 ERROR("EXECUTE_PERMISSIONS",
1556                                       "do not set execute permissions for source files\n" . $permhere);
1557                         }
1558                 }
1559
1560 # Check the patch for a signoff:
1561                 if ($line =~ /^\s*signed-off-by:/i) {
1562                         $signoff++;
1563                         $in_commit_log = 0;
1564                 }
1565
1566 # Check signature styles
1567                 if (!$in_header_lines &&
1568                     $line =~ /^(\s*)($signature_tags)(\s*)(.*)/) {
1569                         my $space_before = $1;
1570                         my $sign_off = $2;
1571                         my $space_after = $3;
1572                         my $email = $4;
1573                         my $ucfirst_sign_off = ucfirst(lc($sign_off));
1574
1575                         if (defined $space_before && $space_before ne "") {
1576                                 WARN("BAD_SIGN_OFF",
1577                                      "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr);
1578                         }
1579                         if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
1580                                 WARN("BAD_SIGN_OFF",
1581                                      "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr);
1582                         }
1583                         if (!defined $space_after || $space_after ne " ") {
1584                                 WARN("BAD_SIGN_OFF",
1585                                      "Use a single space after $ucfirst_sign_off\n" . $herecurr);
1586                         }
1587
1588                         my ($email_name, $email_address, $comment) = parse_email($email);
1589                         my $suggested_email = format_email(($email_name, $email_address));
1590                         if ($suggested_email eq "") {
1591                                 ERROR("BAD_SIGN_OFF",
1592                                       "Unrecognized email address: '$email'\n" . $herecurr);
1593                         } else {
1594                                 my $dequoted = $suggested_email;
1595                                 $dequoted =~ s/^"//;
1596                                 $dequoted =~ s/" </ </;
1597                                 # Don't force email to have quotes
1598                                 # Allow just an angle bracketed address
1599                                 if ("$dequoted$comment" ne $email &&
1600                                     "<$email_address>$comment" ne $email &&
1601                                     "$suggested_email$comment" ne $email) {
1602                                         WARN("BAD_SIGN_OFF",
1603                                              "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
1604                                 }
1605                         }
1606                 }
1607
1608 # Check for wrappage within a valid hunk of the file
1609                 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1610                         ERROR("CORRUPTED_PATCH",
1611                               "patch seems to be corrupt (line wrapped?)\n" .
1612                                 $herecurr) if (!$emitted_corrupt++);
1613                 }
1614
1615 # Check for absolute kernel paths.
1616                 if ($tree) {
1617                         while ($line =~ m{(?:^|\s)(/\S*)}g) {
1618                                 my $file = $1;
1619
1620                                 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1621                                     check_absolute_file($1, $herecurr)) {
1622                                         #
1623                                 } else {
1624                                         check_absolute_file($file, $herecurr);
1625                                 }
1626                         }
1627                 }
1628
1629 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1630                 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1631                     $rawline !~ m/^$UTF8*$/) {
1632                         my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1633
1634                         my $blank = copy_spacing($rawline);
1635                         my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1636                         my $hereptr = "$hereline$ptr\n";
1637
1638                         CHK("INVALID_UTF8",
1639                             "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1640                 }
1641
1642 # Check if it's the start of a commit log
1643 # (not a header line and we haven't seen the patch filename)
1644                 if ($in_header_lines && $realfile =~ /^$/ &&
1645                     $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
1646                         $in_header_lines = 0;
1647                         $in_commit_log = 1;
1648                 }
1649
1650 # Still not yet in a patch, check for any UTF-8
1651                 if ($in_commit_log && $realfile =~ /^$/ &&
1652                     $rawline =~ /$NON_ASCII_UTF8/) {
1653                         CHK("UTF8_BEFORE_PATCH",
1654                             "8-bit UTF-8 used in possible commit log\n" . $herecurr);
1655                 }
1656
1657 # ignore non-hunk lines and lines being removed
1658                 next if (!$hunk_line || $line =~ /^-/);
1659
1660 #trailing whitespace
1661                 if ($line =~ /^\+.*\015/) {
1662                         my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1663                         ERROR("DOS_LINE_ENDINGS",
1664                               "DOS line endings\n" . $herevet);
1665
1666                 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1667                         my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1668                         ERROR("TRAILING_WHITESPACE",
1669                               "trailing whitespace\n" . $herevet);
1670                         $rpt_cleaners = 1;
1671                 }
1672
1673 # check for Kconfig help text having a real description
1674 # Only applies when adding the entry originally, after that we do not have
1675 # sufficient context to determine whether it is indeed long enough.
1676                 if ($realfile =~ /Kconfig/ &&
1677                     $line =~ /.\s*config\s+/) {
1678                         my $length = 0;
1679                         my $cnt = $realcnt;
1680                         my $ln = $linenr + 1;
1681                         my $f;
1682                         my $is_start = 0;
1683                         my $is_end = 0;
1684                         for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
1685                                 $f = $lines[$ln - 1];
1686                                 $cnt-- if ($lines[$ln - 1] !~ /^-/);
1687                                 $is_end = $lines[$ln - 1] =~ /^\+/;
1688
1689                                 next if ($f =~ /^-/);
1690
1691                                 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
1692                                         $is_start = 1;
1693                                 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
1694                                         $length = -1;
1695                                 }
1696
1697                                 $f =~ s/^.//;
1698                                 $f =~ s/#.*//;
1699                                 $f =~ s/^\s+//;
1700                                 next if ($f =~ /^$/);
1701                                 if ($f =~ /^\s*config\s/) {
1702                                         $is_end = 1;
1703                                         last;
1704                                 }
1705                                 $length++;
1706                         }
1707                         WARN("CONFIG_DESCRIPTION",
1708                              "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
1709                         #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
1710                 }
1711
1712                 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
1713                     ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
1714                         my $flag = $1;
1715                         my $replacement = {
1716                                 'EXTRA_AFLAGS' =>   'asflags-y',
1717                                 'EXTRA_CFLAGS' =>   'ccflags-y',
1718                                 'EXTRA_CPPFLAGS' => 'cppflags-y',
1719                                 'EXTRA_LDFLAGS' =>  'ldflags-y',
1720                         };
1721
1722                         WARN("DEPRECATED_VARIABLE",
1723                              "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
1724                 }
1725
1726 # check we are in a valid source file if not then ignore this hunk
1727                 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1728
1729 #80 column limit
1730                 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
1731                     $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1732                     !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
1733                     $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
1734                     $length > 80)
1735                 {
1736                         WARN("LONG_LINE",
1737                              "line over 80 characters\n" . $herecurr);
1738                 }
1739
1740 # check for spaces before a quoted newline
1741                 if ($rawline =~ /^.*\".*\s\\n/) {
1742                         WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
1743                              "unnecessary whitespace before a quoted newline\n" . $herecurr);
1744                 }
1745
1746 # check for adding lines without a newline.
1747                 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1748                         WARN("MISSING_EOF_NEWLINE",
1749                              "adding a line without newline at end of file\n" . $herecurr);
1750                 }
1751
1752 # Blackfin: use hi/lo macros
1753                 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
1754                         if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
1755                                 my $herevet = "$here\n" . cat_vet($line) . "\n";
1756                                 ERROR("LO_MACRO",
1757                                       "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
1758                         }
1759                         if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
1760                                 my $herevet = "$here\n" . cat_vet($line) . "\n";
1761                                 ERROR("HI_MACRO",
1762                                       "use the HI() macro, not (... >> 16)\n" . $herevet);
1763                         }
1764                 }
1765
1766 # check we are in a valid source file C or perl if not then ignore this hunk
1767                 next if ($realfile !~ /\.(h|c|pl)$/);
1768
1769 # at the beginning of a line any tabs must come first and anything
1770 # more than 8 must use tabs.
1771                 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1772                     $rawline =~ /^\+\s*        \s*/) {
1773                         my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1774                         ERROR("CODE_INDENT",
1775                               "code indent should use tabs where possible\n" . $herevet);
1776                         $rpt_cleaners = 1;
1777                 }
1778
1779 # check for space before tabs.
1780                 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
1781                         my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1782                         WARN("SPACE_BEFORE_TAB",
1783                              "please, no space before tabs\n" . $herevet);
1784                 }
1785
1786 # check for spaces at the beginning of a line.
1787 # Exceptions:
1788 #  1) within comments
1789 #  2) indented preprocessor commands
1790 #  3) hanging labels
1791                 if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/)  {
1792                         my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1793                         WARN("LEADING_SPACE",
1794                              "please, no spaces at the start of a line\n" . $herevet);
1795                 }
1796
1797 # check we are in a valid C source file if not then ignore this hunk
1798                 next if ($realfile !~ /\.(h|c)$/);
1799
1800 # check for RCS/CVS revision markers
1801                 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
1802                         WARN("CVS_KEYWORD",
1803                              "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1804                 }
1805
1806 # Blackfin: don't use __builtin_bfin_[cs]sync
1807                 if ($line =~ /__builtin_bfin_csync/) {
1808                         my $herevet = "$here\n" . cat_vet($line) . "\n";
1809                         ERROR("CSYNC",
1810                               "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
1811                 }
1812                 if ($line =~ /__builtin_bfin_ssync/) {
1813                         my $herevet = "$here\n" . cat_vet($line) . "\n";
1814                         ERROR("SSYNC",
1815                               "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
1816                 }
1817
1818 # Check for potential 'bare' types
1819                 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
1820                     $realline_next);
1821 #print "LINE<$line>\n";
1822                 if ($linenr >= $suppress_statement &&
1823                     $realcnt && $line =~ /.\s*\S/) {
1824                         ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
1825                                 ctx_statement_block($linenr, $realcnt, 0);
1826                         $stat =~ s/\n./\n /g;
1827                         $cond =~ s/\n./\n /g;
1828
1829 #print "linenr<$linenr> <$stat>\n";
1830                         # If this statement has no statement boundaries within
1831                         # it there is no point in retrying a statement scan
1832                         # until we hit end of it.
1833                         my $frag = $stat; $frag =~ s/;+\s*$//;
1834                         if ($frag !~ /(?:{|;)/) {
1835 #print "skip<$line_nr_next>\n";
1836                                 $suppress_statement = $line_nr_next;
1837                         }
1838
1839                         # Find the real next line.
1840                         $realline_next = $line_nr_next;
1841                         if (defined $realline_next &&
1842                             (!defined $lines[$realline_next - 1] ||
1843                              substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
1844                                 $realline_next++;
1845                         }
1846
1847                         my $s = $stat;
1848                         $s =~ s/{.*$//s;
1849
1850                         # Ignore goto labels.
1851                         if ($s =~ /$Ident:\*$/s) {
1852
1853                         # Ignore functions being called
1854                         } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
1855
1856                         } elsif ($s =~ /^.\s*else\b/s) {
1857
1858                         # declarations always start with types
1859                         } 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) {
1860                                 my $type = $1;
1861                                 $type =~ s/\s+/ /g;
1862                                 possible($type, "A:" . $s);
1863
1864                         # definitions in global scope can only start with types
1865                         } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
1866                                 possible($1, "B:" . $s);
1867                         }
1868
1869                         # any (foo ... *) is a pointer cast, and foo is a type
1870                         while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
1871                                 possible($1, "C:" . $s);
1872                         }
1873
1874                         # Check for any sort of function declaration.
1875                         # int foo(something bar, other baz);
1876                         # void (*store_gdt)(x86_descr_ptr *);
1877                         if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
1878                                 my ($name_len) = length($1);
1879
1880                                 my $ctx = $s;
1881                                 substr($ctx, 0, $name_len + 1, '');
1882                                 $ctx =~ s/\)[^\)]*$//;
1883
1884                                 for my $arg (split(/\s*,\s*/, $ctx)) {
1885                                         if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
1886
1887                                                 possible($1, "D:" . $s);
1888                                         }
1889                                 }
1890                         }
1891
1892                 }
1893
1894 #
1895 # Checks which may be anchored in the context.
1896 #
1897
1898 # Check for switch () and associated case and default
1899 # statements should be at the same indent.
1900                 if ($line=~/\bswitch\s*\(.*\)/) {
1901                         my $err = '';
1902                         my $sep = '';
1903                         my @ctx = ctx_block_outer($linenr, $realcnt);
1904                         shift(@ctx);
1905                         for my $ctx (@ctx) {
1906                                 my ($clen, $cindent) = line_stats($ctx);
1907                                 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1908                                                         $indent != $cindent) {
1909                                         $err .= "$sep$ctx\n";
1910                                         $sep = '';
1911                                 } else {
1912                                         $sep = "[...]\n";
1913                                 }
1914                         }
1915                         if ($err ne '') {
1916                                 ERROR("SWITCH_CASE_INDENT_LEVEL",
1917                                       "switch and case should be at the same indent\n$hereline$err");
1918                         }
1919                 }
1920
1921 # if/while/etc brace do not go on next line, unless defining a do while loop,
1922 # or if that brace on the next line is for something else
1923                 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
1924                         my $pre_ctx = "$1$2";
1925
1926                         my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
1927                         my $ctx_cnt = $realcnt - $#ctx - 1;
1928                         my $ctx = join("\n", @ctx);
1929
1930                         my $ctx_ln = $linenr;
1931                         my $ctx_skip = $realcnt;
1932
1933                         while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1934                                         defined $lines[$ctx_ln - 1] &&
1935                                         $lines[$ctx_ln - 1] =~ /^-/)) {
1936                                 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1937                                 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
1938                                 $ctx_ln++;
1939                         }
1940
1941                         #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1942                         #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
1943
1944                         if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1945                                 ERROR("OPEN_BRACE",
1946                                       "that open brace { should be on the previous line\n" .
1947                                         "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
1948                         }
1949                         if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1950                             $ctx =~ /\)\s*\;\s*$/ &&
1951                             defined $lines[$ctx_ln - 1])
1952                         {
1953                                 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1954                                 if ($nindent > $indent) {
1955                                         WARN("TRAILING_SEMICOLON",
1956                                              "trailing semicolon indicates no statements, indent implies otherwise\n" .
1957                                                 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
1958                                 }
1959                         }
1960                 }
1961
1962 # Check relative indent for conditionals and blocks.
1963                 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1964                         ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
1965                                 ctx_statement_block($linenr, $realcnt, 0)
1966                                         if (!defined $stat);
1967                         my ($s, $c) = ($stat, $cond);
1968
1969                         substr($s, 0, length($c), '');
1970
1971                         # Make sure we remove the line prefixes as we have
1972                         # none on the first line, and are going to readd them
1973                         # where necessary.
1974                         $s =~ s/\n./\n/gs;
1975
1976                         # Find out how long the conditional actually is.
1977                         my @newlines = ($c =~ /\n/gs);
1978                         my $cond_lines = 1 + $#newlines;
1979
1980                         # We want to check the first line inside the block
1981                         # starting at the end of the conditional, so remove:
1982                         #  1) any blank line termination
1983                         #  2) any opening brace { on end of the line
1984                         #  3) any do (...) {
1985                         my $continuation = 0;
1986                         my $check = 0;
1987                         $s =~ s/^.*\bdo\b//;
1988                         $s =~ s/^\s*{//;
1989                         if ($s =~ s/^\s*\\//) {
1990                                 $continuation = 1;
1991                         }
1992                         if ($s =~ s/^\s*?\n//) {
1993                                 $check = 1;
1994                                 $cond_lines++;
1995                         }
1996
1997                         # Also ignore a loop construct at the end of a
1998                         # preprocessor statement.
1999                         if (($prevline =~ /^.\s*#\s*define\s/ ||
2000                             $prevline =~ /\\\s*$/) && $continuation == 0) {
2001                                 $check = 0;
2002                         }
2003
2004                         my $cond_ptr = -1;
2005                         $continuation = 0;
2006                         while ($cond_ptr != $cond_lines) {
2007                                 $cond_ptr = $cond_lines;
2008
2009                                 # If we see an #else/#elif then the code
2010                                 # is not linear.
2011                                 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2012                                         $check = 0;
2013                                 }
2014
2015                                 # Ignore:
2016                                 #  1) blank lines, they should be at 0,
2017                                 #  2) preprocessor lines, and
2018                                 #  3) labels.
2019                                 if ($continuation ||
2020                                     $s =~ /^\s*?\n/ ||
2021                                     $s =~ /^\s*#\s*?/ ||
2022                                     $s =~ /^\s*$Ident\s*:/) {
2023                                         $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
2024                                         if ($s =~ s/^.*?\n//) {
2025                                                 $cond_lines++;
2026                                         }
2027                                 }
2028                         }
2029
2030                         my (undef, $sindent) = line_stats("+" . $s);
2031                         my $stat_real = raw_line($linenr, $cond_lines);
2032
2033                         # Check if either of these lines are modified, else
2034                         # this is not this patch's fault.
2035                         if (!defined($stat_real) ||
2036                             $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2037                                 $check = 0;
2038                         }
2039                         if (defined($stat_real) && $cond_lines > 1) {
2040                                 $stat_real = "[...]\n$stat_real";
2041                         }
2042
2043                         #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";
2044
2045                         if ($check && (($sindent % 8) != 0 ||
2046                             ($sindent <= $indent && $s ne ''))) {
2047                                 WARN("SUSPECT_CODE_INDENT",
2048                                      "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
2049                         }
2050                 }
2051
2052                 # Track the 'values' across context and added lines.
2053                 my $opline = $line; $opline =~ s/^./ /;
2054                 my ($curr_values, $curr_vars) =
2055                                 annotate_values($opline . "\n", $prev_values);
2056                 $curr_values = $prev_values . $curr_values;
2057                 if ($dbg_values) {
2058                         my $outline = $opline; $outline =~ s/\t/ /g;
2059                         print "$linenr > .$outline\n";
2060                         print "$linenr > $curr_values\n";
2061                         print "$linenr >  $curr_vars\n";
2062                 }
2063                 $prev_values = substr($curr_values, -1);
2064
2065 #ignore lines not being added
2066                 if ($line=~/^[^\+]/) {next;}
2067
2068 # TEST: allow direct testing of the type matcher.
2069                 if ($dbg_type) {
2070                         if ($line =~ /^.\s*$Declare\s*$/) {
2071                                 ERROR("TEST_TYPE",
2072                                       "TEST: is type\n" . $herecurr);
2073                         } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
2074                                 ERROR("TEST_NOT_TYPE",
2075                                       "TEST: is not type ($1 is)\n". $herecurr);
2076                         }
2077                         next;
2078                 }
2079 # TEST: allow direct testing of the attribute matcher.
2080                 if ($dbg_attr) {
2081                         if ($line =~ /^.\s*$Modifier\s*$/) {
2082                                 ERROR("TEST_ATTR",
2083                                       "TEST: is attr\n" . $herecurr);
2084                         } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
2085                                 ERROR("TEST_NOT_ATTR",
2086                                       "TEST: is not attr ($1 is)\n". $herecurr);
2087                         }
2088                         next;
2089                 }
2090
2091 # check for initialisation to aggregates open brace on the next line
2092                 if ($line =~ /^.\s*{/ &&
2093                     $prevline =~ /(?:^|[^=])=\s*$/) {
2094                         ERROR("OPEN_BRACE",
2095                               "that open brace { should be on the previous line\n" . $hereprev);
2096                 }
2097
2098 #
2099 # Checks which are anchored on the added line.
2100 #
2101
2102 # check for malformed paths in #include statements (uses RAW line)
2103                 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
2104                         my $path = $1;
2105                         if ($path =~ m{//}) {
2106                                 ERROR("MALFORMED_INCLUDE",
2107                                       "malformed #include filename\n" .
2108                                         $herecurr);
2109                         }
2110                 }
2111
2112 # no C99 // comments
2113                 if ($line =~ m{//}) {
2114                         ERROR("C99_COMMENTS",
2115                               "do not use C99 // comments\n" . $herecurr);
2116                 }
2117                 # Remove C99 comments.
2118                 $line =~ s@//.*@@;
2119                 $opline =~ s@//.*@@;
2120
2121 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2122 # the whole statement.
2123 #print "APW <$lines[$realline_next - 1]>\n";
2124                 if (defined $realline_next &&
2125                     exists $lines[$realline_next - 1] &&
2126                     !defined $suppress_export{$realline_next} &&
2127                     ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2128                      $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2129                         # Handle definitions which produce identifiers with
2130                         # a prefix:
2131                         #   XXX(foo);
2132                         #   EXPORT_SYMBOL(something_foo);
2133                         my $name = $1;
2134                         if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
2135                             $name =~ /^${Ident}_$2/) {
2136 #print "FOO C name<$name>\n";
2137                                 $suppress_export{$realline_next} = 1;
2138
2139                         } elsif ($stat !~ /(?:
2140                                 \n.}\s*$|
2141                                 ^.DEFINE_$Ident\(\Q$name\E\)|
2142                                 ^.DECLARE_$Ident\(\Q$name\E\)|
2143                                 ^.LIST_HEAD\(\Q$name\E\)|
2144                                 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2145                                 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
2146                             )/x) {
2147 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2148                                 $suppress_export{$realline_next} = 2;
2149                         } else {
2150                                 $suppress_export{$realline_next} = 1;
2151                         }
2152                 }
2153                 if (!defined $suppress_export{$linenr} &&
2154                     $prevline =~ /^.\s*$/ &&
2155                     ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2156                      $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2157 #print "FOO B <$lines[$linenr - 1]>\n";
2158                         $suppress_export{$linenr} = 2;
2159                 }
2160                 if (defined $suppress_export{$linenr} &&
2161                     $suppress_export{$linenr} == 2) {
2162                         WARN("EXPORT_SYMBOL",
2163                              "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
2164                 }
2165
2166 # check for global initialisers.
2167                 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
2168                         ERROR("GLOBAL_INITIALISERS",
2169                               "do not initialise globals to 0 or NULL\n" .
2170                                 $herecurr);
2171                 }
2172 # check for static initialisers.
2173                 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2174                         ERROR("INITIALISED_STATIC",
2175                               "do not initialise statics to 0 or NULL\n" .
2176                                 $herecurr);
2177                 }
2178
2179 # check for static const char * arrays.
2180                 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
2181                         WARN("STATIC_CONST_CHAR_ARRAY",
2182                              "static const char * array should probably be static const char * const\n" .
2183                                 $herecurr);
2184                }
2185
2186 # check for static char foo[] = "bar" declarations.
2187                 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
2188                         WARN("STATIC_CONST_CHAR_ARRAY",
2189                              "static char array declaration should probably be static const char\n" .
2190                                 $herecurr);
2191                }
2192
2193 # check for declarations of struct pci_device_id
2194                 if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) {
2195                         WARN("DEFINE_PCI_DEVICE_TABLE",
2196                              "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr);
2197                 }
2198
2199 # check for new typedefs, only function parameters and sparse annotations
2200 # make sense.
2201                 if ($line =~ /\btypedef\s/ &&
2202                     $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
2203                     $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
2204                     $line !~ /\b$typeTypedefs\b/ &&
2205                     $line !~ /\b__bitwise(?:__|)\b/) {
2206                         WARN("NEW_TYPEDEFS",
2207                              "do not add new typedefs\n" . $herecurr);
2208                 }
2209
2210 # * goes on variable not on type
2211                 # (char*[ const])
2212                 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2213                         #print "AA<$1>\n";
2214                         my ($from, $to) = ($2, $2);
2215
2216                         # Should start with a space.
2217                         $to =~ s/^(\S)/ $1/;
2218                         # Should not end with a space.
2219                         $to =~ s/\s+$//;
2220                         # '*'s should not have spaces between.
2221                         while ($to =~ s/\*\s+\*/\*\*/) {
2222                         }
2223
2224                         #print "from<$from> to<$to>\n";
2225                         if ($from ne $to) {
2226                                 ERROR("POINTER_LOCATION",
2227                                       "\"(foo$from)\" should be \"(foo$to)\"\n" .  $herecurr);
2228                         }
2229                 }
2230                 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2231                         #print "BB<$1>\n";
2232                         my ($from, $to, $ident) = ($2, $2, $3);
2233
2234                         # Should start with a space.
2235                         $to =~ s/^(\S)/ $1/;
2236                         # Should not end with a space.
2237                         $to =~ s/\s+$//;
2238                         # '*'s should not have spaces between.
2239                         while ($to =~ s/\*\s+\*/\*\*/) {
2240                         }
2241                         # Modifiers should have spaces.
2242                         $to =~ s/(\b$Modifier$)/$1 /;
2243
2244                         #print "from<$from> to<$to> ident<$ident>\n";
2245                         if ($from ne $to && $ident !~ /^$Modifier$/) {
2246                                 ERROR("POINTER_LOCATION",
2247                                       "\"foo${from}bar\" should be \"foo${to}bar\"\n" .  $herecurr);
2248                         }
2249                 }
2250
2251 # # no BUG() or BUG_ON()
2252 #               if ($line =~ /\b(BUG|BUG_ON)\b/) {
2253 #                       print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2254 #                       print "$herecurr";
2255 #                       $clean = 0;
2256 #               }
2257
2258                 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
2259                         WARN("LINUX_VERSION_CODE",
2260                              "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
2261                 }
2262
2263 # check for uses of printk_ratelimit
2264                 if ($line =~ /\bprintk_ratelimit\s*\(/) {
2265                         WARN("PRINTK_RATELIMITED",
2266 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
2267                 }
2268
2269 # printk should use KERN_* levels.  Note that follow on printk's on the
2270 # same line do not need a level, so we use the current block context
2271 # to try and find and validate the current printk.  In summary the current
2272 # printk includes all preceding printk's which have no newline on the end.
2273 # we assume the first bad printk is the one to report.
2274                 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
2275                         my $ok = 0;
2276                         for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2277                                 #print "CHECK<$lines[$ln - 1]\n";
2278                                 # we have a preceding printk if it ends
2279                                 # with "\n" ignore it, else it is to blame
2280                                 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2281                                         if ($rawlines[$ln - 1] !~ m{\\n"}) {
2282                                                 $ok = 1;
2283                                         }
2284                                         last;
2285                                 }
2286                         }
2287                         if ($ok == 0) {
2288                                 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2289                                      "printk() should include KERN_ facility level\n" . $herecurr);
2290                         }
2291                 }
2292
2293 # function brace can't be on same line, except for #defines of do while,
2294 # or if closed on same line
2295                 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2296                     !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
2297                         ERROR("OPEN_BRACE",
2298                               "open brace '{' following function declarations go on the next line\n" . $herecurr);
2299                 }
2300
2301 # open braces for enum, union and struct go on the same line.
2302                 if ($line =~ /^.\s*{/ &&
2303                     $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
2304                         ERROR("OPEN_BRACE",
2305                               "open brace '{' following $1 go on the same line\n" . $hereprev);
2306                 }
2307
2308 # missing space after union, struct or enum definition
2309                 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) {
2310                     WARN("SPACING",
2311                          "missing space after $1 definition\n" . $herecurr);
2312                 }
2313
2314 # check for spacing round square brackets; allowed:
2315 #  1. with a type on the left -- int [] a;
2316 #  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2317 #  3. inside a curly brace -- = { [0...10] = 5 }
2318                 while ($line =~ /(.*?\s)\[/g) {
2319                         my ($where, $prefix) = ($-[1], $1);
2320                         if ($prefix !~ /$Type\s+$/ &&
2321                             ($where != 0 || $prefix !~ /^.\s+$/) &&
2322                             $prefix !~ /{\s+$/) {
2323                                 ERROR("BRACKET_SPACE",
2324                                       "space prohibited before open square bracket '['\n" . $herecurr);
2325                         }
2326                 }
2327
2328 # check for spaces between functions and their parentheses.
2329                 while ($line =~ /($Ident)\s+\(/g) {
2330                         my $name = $1;
2331                         my $ctx_before = substr($line, 0, $-[1]);
2332                         my $ctx = "$ctx_before$name";
2333
2334                         # Ignore those directives where spaces _are_ permitted.
2335                         if ($name =~ /^(?:
2336                                 if|for|while|switch|return|case|
2337                                 volatile|__volatile__|
2338                                 __attribute__|format|__extension__|
2339                                 asm|__asm__)$/x)
2340                         {
2341
2342                         # cpp #define statements have non-optional spaces, ie
2343                         # if there is a space between the name and the open
2344                         # parenthesis it is simply not a parameter group.
2345                         } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
2346
2347                         # cpp #elif statement condition may start with a (
2348                         } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
2349
2350                         # If this whole things ends with a type its most
2351                         # likely a typedef for a function.
2352                         } elsif ($ctx =~ /$Type$/) {
2353
2354                         } else {
2355                                 WARN("SPACING",
2356                                      "space prohibited between function name and open parenthesis '('\n" . $herecurr);
2357                         }
2358                 }
2359 # Check operator spacing.
2360                 if (!($line=~/\#\s*include/)) {
2361                         my $ops = qr{
2362                                 <<=|>>=|<=|>=|==|!=|
2363                                 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
2364                                 =>|->|<<|>>|<|>|=|!|~|
2365                                 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
2366                                 \?|:
2367                         }x;
2368                         my @elements = split(/($ops|;)/, $opline);
2369                         my $off = 0;
2370
2371                         my $blank = copy_spacing($opline);
2372
2373                         for (my $n = 0; $n < $#elements; $n += 2) {
2374                                 $off += length($elements[$n]);
2375
2376                                 # Pick up the preceding and succeeding characters.
2377                                 my $ca = substr($opline, 0, $off);
2378                                 my $cc = '';
2379                                 if (length($opline) >= ($off + length($elements[$n + 1]))) {
2380                                         $cc = substr($opline, $off + length($elements[$n + 1]));
2381                                 }
2382                                 my $cb = "$ca$;$cc";
2383
2384                                 my $a = '';
2385                                 $a = 'V' if ($elements[$n] ne '');
2386                                 $a = 'W' if ($elements[$n] =~ /\s$/);
2387                                 $a = 'C' if ($elements[$n] =~ /$;$/);
2388                                 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
2389                                 $a = 'O' if ($elements[$n] eq '');
2390                                 $a = 'E' if ($ca =~ /^\s*$/);
2391
2392                                 my $op = $elements[$n + 1];
2393
2394                                 my $c = '';
2395                                 if (defined $elements[$n + 2]) {
2396                                         $c = 'V' if ($elements[$n + 2] ne '');
2397                                         $c = 'W' if ($elements[$n + 2] =~ /^\s/);
2398                                         $c = 'C' if ($elements[$n + 2] =~ /^$;/);
2399                                         $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
2400                                         $c = 'O' if ($elements[$n + 2] eq '');
2401                                         $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
2402                                 } else {
2403                                         $c = 'E';
2404                                 }
2405
2406                                 my $ctx = "${a}x${c}";
2407
2408                                 my $at = "(ctx:$ctx)";
2409
2410                                 my $ptr = substr($blank, 0, $off) . "^";
2411                                 my $hereptr = "$hereline$ptr\n";
2412
2413                                 # Pull out the value of this operator.
2414                                 my $op_type = substr($curr_values, $off + 1, 1);
2415
2416                                 # Get the full operator variant.
2417                                 my $opv = $op . substr($curr_vars, $off, 1);
2418
2419                                 # Ignore operators passed as parameters.
2420                                 if ($op_type ne 'V' &&
2421                                     $ca =~ /\s$/ && $cc =~ /^\s*,/) {
2422
2423 #                               # Ignore comments
2424 #                               } elsif ($op =~ /^$;+$/) {
2425
2426                                 # ; should have either the end of line or a space or \ after it
2427                                 } elsif ($op eq ';') {
2428                                         if ($ctx !~ /.x[WEBC]/ &&
2429                                             $cc !~ /^\\/ && $cc !~ /^;/) {
2430                                                 ERROR("SPACING",
2431                                                       "space required after that '$op' $at\n" . $hereptr);
2432                                         }
2433
2434                                 # // is a comment
2435                                 } elsif ($op eq '//') {
2436
2437                                 # No spaces for:
2438                                 #   ->
2439                                 #   :   when part of a bitfield
2440                                 } elsif ($op eq '->' || $opv eq ':B') {
2441                                         if ($ctx =~ /Wx.|.xW/) {
2442                                                 ERROR("SPACING",
2443                                                       "spaces prohibited around that '$op' $at\n" . $hereptr);
2444                                         }
2445
2446                                 # , must have a space on the right.
2447                                 } elsif ($op eq ',') {
2448                                         if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
2449                                                 ERROR("SPACING",
2450                                                       "space required after that '$op' $at\n" . $hereptr);
2451                                         }
2452
2453                                 # '*' as part of a type definition -- reported already.
2454                                 } elsif ($opv eq '*_') {
2455                                         #warn "'*' is part of type\n";
2456
2457                                 # unary operators should have a space before and
2458                                 # none after.  May be left adjacent to another
2459                                 # unary operator, or a cast
2460                                 } elsif ($op eq '!' || $op eq '~' ||
2461                                          $opv eq '*U' || $opv eq '-U' ||
2462                                          $opv eq '&U' || $opv eq '&&U') {
2463                                         if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
2464                                                 ERROR("SPACING",
2465                                                       "space required before that '$op' $at\n" . $hereptr);
2466                                         }
2467                                         if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
2468                                                 # A unary '*' may be const
2469
2470                                         } elsif ($ctx =~ /.xW/) {
2471                                                 ERROR("SPACING",
2472                                                       "space prohibited after that '$op' $at\n" . $hereptr);
2473                                         }
2474
2475                                 # unary ++ and unary -- are allowed no space on one side.
2476                                 } elsif ($op eq '++' or $op eq '--') {
2477                                         if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
2478                                                 ERROR("SPACING",
2479                                                       "space required one side of that '$op' $at\n" . $hereptr);
2480                                         }
2481                                         if ($ctx =~ /Wx[BE]/ ||
2482                                             ($ctx =~ /Wx./ && $cc =~ /^;/)) {
2483                                                 ERROR("SPACING",
2484                                                       "space prohibited before that '$op' $at\n" . $hereptr);
2485                                         }
2486                                         if ($ctx =~ /ExW/) {
2487                                                 ERROR("SPACING",
2488                                                       "space prohibited after that '$op' $at\n" . $hereptr);
2489                                         }
2490
2491
2492                                 # << and >> may either have or not have spaces both sides
2493                                 } elsif ($op eq '<<' or $op eq '>>' or
2494                                          $op eq '&' or $op eq '^' or $op eq '|' or
2495                                          $op eq '+' or $op eq '-' or
2496                                          $op eq '*' or $op eq '/' or
2497                                          $op eq '%')
2498                                 {
2499                                         if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
2500                                                 ERROR("SPACING",
2501                                                       "need consistent spacing around '$op' $at\n" .
2502                                                         $hereptr);
2503                                         }
2504
2505                                 # A colon needs no spaces before when it is
2506                                 # terminating a case value or a label.
2507                                 } elsif ($opv eq ':C' || $opv eq ':L') {
2508                                         if ($ctx =~ /Wx./) {
2509                                                 ERROR("SPACING",
2510                                                       "space prohibited before that '$op' $at\n" . $hereptr);
2511                                         }
2512
2513                                 # All the others need spaces both sides.
2514                                 } elsif ($ctx !~ /[EWC]x[CWE]/) {
2515                                         my $ok = 0;
2516
2517                                         # Ignore email addresses <foo@bar>
2518                                         if (($op eq '<' &&
2519                                              $cc =~ /^\S+\@\S+>/) ||
2520                                             ($op eq '>' &&
2521                                              $ca =~ /<\S+\@\S+$/))
2522                                         {
2523                                                 $ok = 1;
2524                                         }
2525
2526                                         # Ignore ?:
2527                                         if (($opv eq ':O' && $ca =~ /\?$/) ||
2528                                             ($op eq '?' && $cc =~ /^:/)) {
2529                                                 $ok = 1;
2530                                         }
2531
2532                                         if ($ok == 0) {
2533                                                 ERROR("SPACING",
2534                                                       "spaces required around that '$op' $at\n" . $hereptr);
2535                                         }
2536                                 }
2537                                 $off += length($elements[$n + 1]);
2538                         }
2539                 }
2540
2541 # check for multiple assignments
2542                 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
2543                         CHK("MULTIPLE_ASSIGNMENTS",
2544                             "multiple assignments should be avoided\n" . $herecurr);
2545                 }
2546
2547 ## # check for multiple declarations, allowing for a function declaration
2548 ## # continuation.
2549 ##              if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
2550 ##                  $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
2551 ##
2552 ##                      # Remove any bracketed sections to ensure we do not
2553 ##                      # falsly report the parameters of functions.
2554 ##                      my $ln = $line;
2555 ##                      while ($ln =~ s/\([^\(\)]*\)//g) {
2556 ##                      }
2557 ##                      if ($ln =~ /,/) {
2558 ##                              WARN("MULTIPLE_DECLARATION",
2559 ##                                   "declaring multiple variables together should be avoided\n" . $herecurr);
2560 ##                      }
2561 ##              }
2562
2563 #need space before brace following if, while, etc
2564                 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
2565                     $line =~ /do{/) {
2566                         ERROR("SPACING",
2567                               "space required before the open brace '{'\n" . $herecurr);
2568                 }
2569
2570 # closing brace should have a space following it when it has anything
2571 # on the line
2572                 if ($line =~ /}(?!(?:,|;|\)))\S/) {
2573                         ERROR("SPACING",
2574                               "space required after that close brace '}'\n" . $herecurr);
2575                 }
2576
2577 # check spacing on square brackets
2578                 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
2579                         ERROR("SPACING",
2580                               "space prohibited after that open square bracket '['\n" . $herecurr);
2581                 }
2582                 if ($line =~ /\s\]/) {
2583                         ERROR("SPACING",
2584                               "space prohibited before that close square bracket ']'\n" . $herecurr);
2585                 }
2586
2587 # check spacing on parentheses
2588                 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
2589                     $line !~ /for\s*\(\s+;/) {
2590                         ERROR("SPACING",
2591                               "space prohibited after that open parenthesis '('\n" . $herecurr);
2592                 }
2593                 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
2594                     $line !~ /for\s*\(.*;\s+\)/ &&
2595                     $line !~ /:\s+\)/) {
2596                         ERROR("SPACING",
2597                               "space prohibited before that close parenthesis ')'\n" . $herecurr);
2598                 }
2599
2600 #goto labels aren't indented, allow a single space however
2601                 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
2602                    !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
2603                         WARN("INDENTED_LABEL",
2604                              "labels should not be indented\n" . $herecurr);
2605                 }
2606
2607 # Return is not a function.
2608                 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2609                         my $spacing = $1;
2610                         my $value = $2;
2611
2612                         # Flatten any parentheses
2613                         $value =~ s/\(/ \(/g;
2614                         $value =~ s/\)/\) /g;
2615                         while ($value =~ s/\[[^\[\]]*\]/1/ ||
2616                                $value !~ /(?:$Ident|-?$Constant)\s*
2617                                              $Compare\s*
2618                                              (?:$Ident|-?$Constant)/x &&
2619                                $value =~ s/\([^\(\)]*\)/1/) {
2620                         }
2621 #print "value<$value>\n";
2622                         if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
2623                                 ERROR("RETURN_PARENTHESES",
2624                                       "return is not a function, parentheses are not required\n" . $herecurr);
2625
2626                         } elsif ($spacing !~ /\s+/) {
2627                                 ERROR("SPACING",
2628                                       "space required before the open parenthesis '('\n" . $herecurr);
2629                         }
2630                 }
2631 # Return of what appears to be an errno should normally be -'ve
2632                 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
2633                         my $name = $1;
2634                         if ($name ne 'EOF' && $name ne 'ERROR') {
2635                                 WARN("USE_NEGATIVE_ERRNO",
2636                                      "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
2637                         }
2638                 }
2639
2640 # Need a space before open parenthesis after if, while etc
2641                 if ($line=~/\b(if|while|for|switch)\(/) {
2642                         ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr);
2643                 }
2644
2645 # Check for illegal assignment in if conditional -- and check for trailing
2646 # statements after the conditional.
2647                 if ($line =~ /do\s*(?!{)/) {
2648                         ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2649                                 ctx_statement_block($linenr, $realcnt, 0)
2650                                         if (!defined $stat);
2651                         my ($stat_next) = ctx_statement_block($line_nr_next,
2652                                                 $remain_next, $off_next);
2653                         $stat_next =~ s/\n./\n /g;
2654                         ##print "stat<$stat> stat_next<$stat_next>\n";
2655
2656                         if ($stat_next =~ /^\s*while\b/) {
2657                                 # If the statement carries leading newlines,
2658                                 # then count those as offsets.
2659                                 my ($whitespace) =
2660                                         ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2661                                 my $offset =
2662                                         statement_rawlines($whitespace) - 1;
2663
2664                                 $suppress_whiletrailers{$line_nr_next +
2665                                                                 $offset} = 1;
2666                         }
2667                 }
2668                 if (!defined $suppress_whiletrailers{$linenr} &&
2669                     $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
2670                         my ($s, $c) = ($stat, $cond);
2671
2672                         if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
2673                                 ERROR("ASSIGN_IN_IF",
2674                                       "do not use assignment in if condition\n" . $herecurr);
2675                         }
2676
2677                         # Find out what is on the end of the line after the
2678                         # conditional.
2679                         substr($s, 0, length($c), '');
2680                         $s =~ s/\n.*//g;
2681                         $s =~ s/$;//g;  # Remove any comments
2682                         if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2683                             $c !~ /}\s*while\s*/)
2684                         {
2685                                 # Find out how long the conditional actually is.
2686                                 my @newlines = ($c =~ /\n/gs);
2687                                 my $cond_lines = 1 + $#newlines;
2688                                 my $stat_real = '';
2689
2690                                 $stat_real = raw_line($linenr, $cond_lines)
2691                                                         . "\n" if ($cond_lines);
2692                                 if (defined($stat_real) && $cond_lines > 1) {
2693                                         $stat_real = "[...]\n$stat_real";
2694                                 }
2695
2696                                 ERROR("TRAILING_STATEMENTS",
2697                                       "trailing statements should be on next line\n" . $herecurr . $stat_real);
2698                         }
2699                 }
2700
2701 # Check for bitwise tests written as boolean
2702                 if ($line =~ /
2703                         (?:
2704                                 (?:\[|\(|\&\&|\|\|)
2705                                 \s*0[xX][0-9]+\s*
2706                                 (?:\&\&|\|\|)
2707                         |
2708                                 (?:\&\&|\|\|)
2709                                 \s*0[xX][0-9]+\s*
2710                                 (?:\&\&|\|\||\)|\])
2711                         )/x)
2712                 {
2713                         WARN("HEXADECIMAL_BOOLEAN_TEST",
2714                              "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2715                 }
2716
2717 # if and else should not have general statements after it
2718                 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2719                         my $s = $1;
2720                         $s =~ s/$;//g;  # Remove any comments
2721                         if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2722                                 ERROR("TRAILING_STATEMENTS",
2723                                       "trailing statements should be on next line\n" . $herecurr);
2724                         }
2725                 }
2726 # if should not continue a brace
2727                 if ($line =~ /}\s*if\b/) {
2728                         ERROR("TRAILING_STATEMENTS",
2729                               "trailing statements should be on next line\n" .
2730                                 $herecurr);
2731                 }
2732 # case and default should not have general statements after them
2733                 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2734                     $line !~ /\G(?:
2735                         (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
2736                         \s*return\s+
2737                     )/xg)
2738                 {
2739                         ERROR("TRAILING_STATEMENTS",
2740                               "trailing statements should be on next line\n" . $herecurr);
2741                 }
2742
2743                 # Check for }<nl>else {, these must be at the same
2744                 # indent level to be relevant to each other.
2745                 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2746                                                 $previndent == $indent) {
2747                         ERROR("ELSE_AFTER_BRACE",
2748                               "else should follow close brace '}'\n" . $hereprev);
2749                 }
2750
2751                 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2752                                                 $previndent == $indent) {
2753                         my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2754
2755                         # Find out what is on the end of the line after the
2756                         # conditional.
2757                         substr($s, 0, length($c), '');
2758                         $s =~ s/\n.*//g;
2759
2760                         if ($s =~ /^\s*;/) {
2761                                 ERROR("WHILE_AFTER_BRACE",
2762                                       "while should follow close brace '}'\n" . $hereprev);
2763                         }
2764                 }
2765
2766 #studly caps, commented out until figure out how to distinguish between use of existing and adding new
2767 #               if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2768 #                   print "No studly caps, use _\n";
2769 #                   print "$herecurr";
2770 #                   $clean = 0;
2771 #               }
2772
2773 #no spaces allowed after \ in define
2774                 if ($line=~/\#\s*define.*\\\s$/) {
2775                         WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
2776                              "Whitepspace after \\ makes next lines useless\n" . $herecurr);
2777                 }
2778
2779 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
2780                 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
2781                         my $file = "$1.h";
2782                         my $checkfile = "include/linux/$file";
2783                         if (-f "$root/$checkfile" &&
2784                             $realfile ne $checkfile &&
2785                             $1 !~ /$allowed_asm_includes/)
2786                         {
2787                                 if ($realfile =~ m{^arch/}) {
2788                                         CHK("ARCH_INCLUDE_LINUX",
2789                                             "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2790                                 } else {
2791                                         WARN("INCLUDE_LINUX",
2792                                              "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2793                                 }
2794                         }
2795                 }
2796
2797 # multi-statement macros should be enclosed in a do while loop, grab the
2798 # first statement and ensure its the whole macro if its not enclosed
2799 # in a known good container
2800                 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2801                     $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
2802                         my $ln = $linenr;
2803                         my $cnt = $realcnt;
2804                         my ($off, $dstat, $dcond, $rest);
2805                         my $ctx = '';
2806                         ($dstat, $dcond, $ln, $cnt, $off) =
2807                                 ctx_statement_block($linenr, $realcnt, 0);
2808                         $ctx = $dstat;
2809                         #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
2810                         #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
2811
2812                         $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
2813                         $dstat =~ s/$;//g;
2814                         $dstat =~ s/\\\n.//g;
2815                         $dstat =~ s/^\s*//s;
2816                         $dstat =~ s/\s*$//s;
2817
2818                         # Flatten any parentheses and braces
2819                         while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2820                                $dstat =~ s/\{[^\{\}]*\}/1/ ||
2821                                $dstat =~ s/\[[^\[\]]*\]/1/)
2822                         {
2823                         }
2824
2825                         my $exceptions = qr{
2826                                 $Declare|
2827                                 module_param_named|
2828                                 MODULE_PARAM_DESC|
2829                                 DECLARE_PER_CPU|
2830                                 DEFINE_PER_CPU|
2831                                 __typeof__\(|
2832                                 union|
2833                                 struct|
2834                                 \.$Ident\s*=\s*|
2835                                 ^\"|\"$
2836                         }x;
2837                         #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
2838                         if ($dstat ne '' &&
2839                             $dstat !~ /^(?:$Ident|-?$Constant),$/ &&                    # 10, // foo(),
2840                             $dstat !~ /^(?:$Ident|-?$Constant);$/ &&                    # foo();
2841                             $dstat !~ /^(?:$Ident|-?$Constant)$/ &&                     # 10 // foo()
2842                             $dstat !~ /$exceptions/ &&
2843                             $dstat !~ /^\.$Ident\s*=/ &&                                # .foo =
2844                             $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ &&       # do {...} while (...); // do {...} while (...)
2845                             $dstat !~ /^for\s*$Constant$/ &&                            # for (...)
2846                             $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ &&   # for (...) bar()
2847                             $dstat !~ /^do\s*{/ &&                                      # do {...
2848                             $dstat !~ /^\({/)                                           # ({...
2849                         {
2850                                 $ctx =~ s/\n*$//;
2851                                 my $herectx = $here . "\n";
2852                                 my $cnt = statement_rawlines($ctx);
2853
2854                                 for (my $n = 0; $n < $cnt; $n++) {
2855                                         $herectx .= raw_line($linenr, $n) . "\n";
2856                                 }
2857
2858                                 if ($dstat =~ /;/) {
2859                                         ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
2860                                               "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
2861                                 } else {
2862                                         ERROR("COMPLEX_MACRO",
2863                                               "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
2864                                 }
2865                         }
2866                 }
2867
2868 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
2869 # all assignments may have only one of the following with an assignment:
2870 #       .
2871 #       ALIGN(...)
2872 #       VMLINUX_SYMBOL(...)
2873                 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
2874                         WARN("MISSING_VMLINUX_SYMBOL",
2875                              "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
2876                 }
2877
2878 # check for redundant bracing round if etc
2879                 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2880                         my ($level, $endln, @chunks) =
2881                                 ctx_statement_full($linenr, $realcnt, 1);
2882                         #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
2883                         #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2884                         if ($#chunks > 0 && $level == 0) {
2885                                 my $allowed = 0;
2886                                 my $seen = 0;
2887                                 my $herectx = $here . "\n";
2888                                 my $ln = $linenr - 1;
2889                                 for my $chunk (@chunks) {
2890                                         my ($cond, $block) = @{$chunk};
2891
2892                                         # If the condition carries leading newlines, then count those as offsets.
2893                                         my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2894                                         my $offset = statement_rawlines($whitespace) - 1;
2895
2896                                         #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2897
2898                                         # We have looked at and allowed this specific line.
2899                                         $suppress_ifbraces{$ln + $offset} = 1;
2900
2901                                         $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
2902                                         $ln += statement_rawlines($block) - 1;
2903
2904                                         substr($block, 0, length($cond), '');
2905
2906                                         $seen++ if ($block =~ /^\s*{/);
2907
2908                                         #print "cond<$cond> block<$block> allowed<$allowed>\n";
2909                                         if (statement_lines($cond) > 1) {
2910                                                 #print "APW: ALLOWED: cond<$cond>\n";
2911                                                 $allowed = 1;
2912                                         }
2913                                         if ($block =~/\b(?:if|for|while)\b/) {
2914                                                 #print "APW: ALLOWED: block<$block>\n";
2915                                                 $allowed = 1;
2916                                         }
2917                                         if (statement_block_size($block) > 1) {
2918                                                 #print "APW: ALLOWED: lines block<$block>\n";
2919                                                 $allowed = 1;
2920                                         }
2921                                 }
2922                                 if ($seen && !$allowed) {
2923                                         WARN("BRACES",
2924                                              "braces {} are not necessary for any arm of this statement\n" . $herectx);
2925                                 }
2926                         }
2927                 }
2928                 if (!defined $suppress_ifbraces{$linenr - 1} &&
2929                                         $line =~ /\b(if|while|for|else)\b/) {
2930                         my $allowed = 0;
2931
2932                         # Check the pre-context.
2933                         if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2934                                 #print "APW: ALLOWED: pre<$1>\n";
2935                                 $allowed = 1;
2936                         }
2937
2938                         my ($level, $endln, @chunks) =
2939                                 ctx_statement_full($linenr, $realcnt, $-[0]);
2940
2941                         # Check the condition.
2942                         my ($cond, $block) = @{$chunks[0]};
2943                         #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
2944                         if (defined $cond) {
2945                                 substr($block, 0, length($cond), '');
2946                         }
2947                         if (statement_lines($cond) > 1) {
2948                                 #print "APW: ALLOWED: cond<$cond>\n";
2949                                 $allowed = 1;
2950                         }
2951                         if ($block =~/\b(?:if|for|while)\b/) {
2952                                 #print "APW: ALLOWED: block<$block>\n";
2953                                 $allowed = 1;
2954                         }
2955                         if (statement_block_size($block) > 1) {
2956                                 #print "APW: ALLOWED: lines block<$block>\n";
2957                                 $allowed = 1;
2958                         }
2959                         # Check the post-context.
2960                         if (defined $chunks[1]) {
2961                                 my ($cond, $block) = @{$chunks[1]};
2962                                 if (defined $cond) {
2963                                         substr($block, 0, length($cond), '');
2964                                 }
2965                                 if ($block =~ /^\s*\{/) {
2966                                         #print "APW: ALLOWED: chunk-1 block<$block>\n";
2967                                         $allowed = 1;
2968                                 }
2969                         }
2970                         if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
2971                                 my $herectx = $here . "\n";
2972                                 my $cnt = statement_rawlines($block);
2973
2974                                 for (my $n = 0; $n < $cnt; $n++) {
2975                                         $herectx .= raw_line($linenr, $n) . "\n";
2976                                 }
2977
2978                                 WARN("BRACES",
2979                                      "braces {} are not necessary for single statement blocks\n" . $herectx);
2980                         }
2981                 }
2982
2983 # don't include deprecated include files (uses RAW line)
2984                 for my $inc (@dep_includes) {
2985                         if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
2986                                 ERROR("DEPRECATED_INCLUDE",
2987                                       "Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2988                         }
2989                 }
2990
2991 # don't use deprecated functions
2992                 for my $func (@dep_functions) {
2993                         if ($line =~ /\b$func\b/) {
2994                                 ERROR("DEPRECATED_FUNCTION",
2995                                       "Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2996                         }
2997                 }
2998
2999 # no volatiles please
3000                 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
3001                 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
3002                         WARN("VOLATILE",
3003                              "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
3004                 }
3005
3006 # warn about #if 0
3007                 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
3008                         CHK("REDUNDANT_CODE",
3009                             "if this code is redundant consider removing it\n" .
3010                                 $herecurr);
3011                 }
3012
3013 # check for needless kfree() checks
3014                 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
3015                         my $expr = $1;
3016                         if ($line =~ /\bkfree\(\Q$expr\E\);/) {
3017                                 WARN("NEEDLESS_KFREE",
3018                                      "kfree(NULL) is safe this check is probably not required\n" . $hereprev);
3019                         }
3020                 }
3021 # check for needless usb_free_urb() checks
3022                 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
3023                         my $expr = $1;
3024                         if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
3025                                 WARN("NEEDLESS_USB_FREE_URB",
3026                                      "usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
3027                         }
3028                 }
3029
3030 # prefer usleep_range over udelay
3031                 if ($line =~ /\budelay\s*\(\s*(\w+)\s*\)/) {
3032                         # ignore udelay's < 10, however
3033                         if (! (($1 =~ /(\d+)/) && ($1 < 10)) ) {
3034                                 CHK("USLEEP_RANGE",
3035                                     "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
3036                         }
3037                 }
3038
3039 # warn about unexpectedly long msleep's
3040                 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
3041                         if ($1 < 20) {
3042                                 WARN("MSLEEP",
3043                                      "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
3044                         }
3045                 }
3046
3047 # warn about #ifdefs in C files
3048 #               if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
3049 #                       print "#ifdef in C files should be avoided\n";
3050 #                       print "$herecurr";
3051 #                       $clean = 0;
3052 #               }
3053
3054 # warn about spacing in #ifdefs
3055                 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
3056                         ERROR("SPACING",
3057                               "exactly one space required after that #$1\n" . $herecurr);
3058                 }
3059
3060 # check for spinlock_t definitions without a comment.
3061                 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
3062                     $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
3063                         my $which = $1;
3064                         if (!ctx_has_comment($first_line, $linenr)) {
3065                                 CHK("UNCOMMENTED_DEFINITION",
3066                                     "$1 definition without comment\n" . $herecurr);
3067                         }
3068                 }
3069 # check for memory barriers without a comment.
3070                 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
3071                         if (!ctx_has_comment($first_line, $linenr)) {
3072                                 CHK("MEMORY_BARRIER",
3073                                     "memory barrier without comment\n" . $herecurr);
3074                         }
3075                 }
3076 # check of hardware specific defines
3077                 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
3078                         CHK("ARCH_DEFINES",
3079                             "architecture specific defines should be avoided\n" .  $herecurr);
3080                 }
3081
3082 # Check that the storage class is at the beginning of a declaration
3083                 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
3084                         WARN("STORAGE_CLASS",
3085                              "storage class should be at the beginning of the declaration\n" . $herecurr)
3086                 }
3087
3088 # check the location of the inline attribute, that it is between
3089 # storage class and type.
3090                 if ($line =~ /\b$Type\s+$Inline\b/ ||
3091                     $line =~ /\b$Inline\s+$Storage\b/) {
3092                         ERROR("INLINE_LOCATION",
3093                               "inline keyword should sit between storage class and type\n" . $herecurr);
3094                 }
3095
3096 # Check for __inline__ and __inline, prefer inline
3097                 if ($line =~ /\b(__inline__|__inline)\b/) {
3098                         WARN("INLINE",
3099                              "plain inline is preferred over $1\n" . $herecurr);
3100                 }
3101
3102 # Check for __attribute__ packed, prefer __packed
3103                 if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
3104                         WARN("PREFER_PACKED",
3105                              "__packed is preferred over __attribute__((packed))\n" . $herecurr);
3106                 }
3107
3108 # Check for __attribute__ aligned, prefer __aligned
3109                 if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
3110                         WARN("PREFER_ALIGNED",
3111                              "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
3112                 }
3113
3114 # Check for __attribute__ format(printf, prefer __printf
3115                 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
3116                         WARN("PREFER_PRINTF",
3117                              "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr);
3118                 }
3119
3120 # check for sizeof(&)
3121                 if ($line =~ /\bsizeof\s*\(\s*\&/) {
3122                         WARN("SIZEOF_ADDRESS",
3123                              "sizeof(& should be avoided\n" . $herecurr);
3124                 }
3125
3126 # check for line continuations in quoted strings with odd counts of "
3127                 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
3128                         WARN("LINE_CONTINUATIONS",
3129                              "Avoid line continuations in quoted strings\n" . $herecurr);
3130                 }
3131
3132 # Check for misused memsets
3133                 if (defined $stat &&
3134                     $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
3135
3136                         my $ms_addr = $2;
3137                         my $ms_val = $8;
3138                         my $ms_size = $14;
3139
3140                         if ($ms_size =~ /^(0x|)0$/i) {
3141                                 ERROR("MEMSET",
3142                                       "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
3143                         } elsif ($ms_size =~ /^(0x|)1$/i) {
3144                                 WARN("MEMSET",
3145                                      "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
3146                         }
3147                 }
3148
3149 # typecasts on min/max could be min_t/max_t
3150                 if (defined $stat &&
3151                     $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
3152                         if (defined $2 || defined $8) {
3153                                 my $call = $1;
3154                                 my $cast1 = deparenthesize($2);
3155                                 my $arg1 = $3;
3156                                 my $cast2 = deparenthesize($8);
3157                                 my $arg2 = $9;
3158                                 my $cast;
3159
3160                                 if ($cast1 ne "" && $cast2 ne "") {
3161                                         $cast = "$cast1 or $cast2";
3162                                 } elsif ($cast1 ne "") {
3163                                         $cast = $cast1;
3164                                 } else {
3165                                         $cast = $cast2;
3166                                 }
3167                                 WARN("MINMAX",
3168                                      "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
3169                         }
3170                 }
3171
3172 # check for new externs in .c files.
3173                 if ($realfile =~ /\.c$/ && defined $stat &&
3174                     $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
3175                 {
3176                         my $function_name = $1;
3177                         my $paren_space = $2;
3178
3179                         my $s = $stat;
3180                         if (defined $cond) {
3181                                 substr($s, 0, length($cond), '');
3182                         }
3183                         if ($s =~ /^\s*;/ &&
3184                             $function_name ne 'uninitialized_var')
3185                         {
3186                                 WARN("AVOID_EXTERNS",
3187                                      "externs should be avoided in .c files\n" .  $herecurr);
3188                         }
3189
3190                         if ($paren_space =~ /\n/) {
3191                                 WARN("FUNCTION_ARGUMENTS",
3192                                      "arguments for function declarations should follow identifier\n" . $herecurr);
3193                         }
3194
3195                 } elsif ($realfile =~ /\.c$/ && defined $stat &&
3196                     $stat =~ /^.\s*extern\s+/)
3197                 {
3198                         WARN("AVOID_EXTERNS",
3199                              "externs should be avoided in .c files\n" .  $herecurr);
3200                 }
3201
3202 # checks for new __setup's
3203                 if ($rawline =~ /\b__setup\("([^"]*)"/) {
3204                         my $name = $1;
3205
3206                         if (!grep(/$name/, @setup_docs)) {
3207                                 CHK("UNDOCUMENTED_SETUP",
3208                                     "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
3209                         }
3210                 }
3211
3212 # check for pointless casting of kmalloc return
3213                 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
3214                         WARN("UNNECESSARY_CASTS",
3215                              "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
3216                 }
3217
3218 # check for multiple semicolons
3219                 if ($line =~ /;\s*;\s*$/) {
3220                     WARN("ONE_SEMICOLON",
3221                          "Statements terminations use 1 semicolon\n" . $herecurr);
3222                 }
3223
3224 # check for gcc specific __FUNCTION__
3225                 if ($line =~ /__FUNCTION__/) {
3226                         WARN("USE_FUNC",
3227                              "__func__ should be used instead of gcc specific __FUNCTION__\n"  . $herecurr);
3228                 }
3229
3230 # check for semaphores initialized locked
3231                 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
3232                         WARN("CONSIDER_COMPLETION",
3233                              "consider using a completion\n" . $herecurr);
3234
3235                 }
3236 # recommend kstrto* over simple_strto* and strict_strto*
3237                 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
3238                         WARN("CONSIDER_KSTRTO",
3239                              "$1 is obsolete, use k$3 instead\n" . $herecurr);
3240                 }
3241 # check for __initcall(), use device_initcall() explicitly please
3242                 if ($line =~ /^.\s*__initcall\s*\(/) {
3243                         WARN("USE_DEVICE_INITCALL",
3244                              "please use device_initcall() instead of __initcall()\n" . $herecurr);
3245                 }
3246 # check for various ops structs, ensure they are const.
3247                 my $struct_ops = qr{acpi_dock_ops|
3248                                 address_space_operations|
3249                                 backlight_ops|
3250                                 block_device_operations|
3251                                 dentry_operations|
3252                                 dev_pm_ops|
3253                                 dma_map_ops|
3254                                 extent_io_ops|
3255                                 file_lock_operations|
3256                                 file_operations|
3257                                 hv_ops|
3258                                 ide_dma_ops|
3259                                 intel_dvo_dev_ops|
3260                                 item_operations|
3261                                 iwl_ops|
3262                                 kgdb_arch|
3263                                 kgdb_io|
3264                                 kset_uevent_ops|
3265                                 lock_manager_operations|
3266                                 microcode_ops|
3267                                 mtrr_ops|
3268                                 neigh_ops|
3269                                 nlmsvc_binding|
3270                                 pci_raw_ops|
3271                                 pipe_buf_operations|
3272                                 platform_hibernation_ops|
3273                                 platform_suspend_ops|
3274                                 proto_ops|
3275                                 rpc_pipe_ops|
3276                                 seq_operations|
3277                                 snd_ac97_build_ops|
3278                                 soc_pcmcia_socket_ops|
3279                                 stacktrace_ops|
3280                                 sysfs_ops|
3281                                 tty_operations|
3282                                 usb_mon_operations|
3283                                 wd_ops}x;
3284                 if ($line !~ /\bconst\b/ &&
3285                     $line =~ /\bstruct\s+($struct_ops)\b/) {
3286                         WARN("CONST_STRUCT",
3287                              "struct $1 should normally be const\n" .
3288                                 $herecurr);
3289                 }
3290
3291 # use of NR_CPUS is usually wrong
3292 # ignore definitions of NR_CPUS and usage to define arrays as likely right
3293                 if ($line =~ /\bNR_CPUS\b/ &&
3294                     $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
3295                     $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
3296                     $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
3297                     $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
3298                     $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
3299                 {
3300                         WARN("NR_CPUS",
3301                              "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
3302                 }
3303
3304 # check for %L{u,d,i} in strings
3305                 my $string;
3306                 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
3307                         $string = substr($rawline, $-[1], $+[1] - $-[1]);
3308                         $string =~ s/%%/__/g;
3309                         if ($string =~ /(?<!%)%L[udi]/) {
3310                                 WARN("PRINTF_L",
3311                                      "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
3312                                 last;
3313                         }
3314                 }
3315
3316 # whine mightly about in_atomic
3317                 if ($line =~ /\bin_atomic\s*\(/) {
3318                         if ($realfile =~ m@^drivers/@) {
3319                                 ERROR("IN_ATOMIC",
3320                                       "do not use in_atomic in drivers\n" . $herecurr);
3321                         } elsif ($realfile !~ m@^kernel/@) {
3322                                 WARN("IN_ATOMIC",
3323                                      "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
3324                         }
3325                 }
3326
3327 # check for lockdep_set_novalidate_class
3328                 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
3329                     $line =~ /__lockdep_no_validate__\s*\)/ ) {
3330                         if ($realfile !~ m@^kernel/lockdep@ &&
3331                             $realfile !~ m@^include/linux/lockdep@ &&
3332                             $realfile !~ m@^drivers/base/core@) {
3333                                 ERROR("LOCKDEP",
3334                                       "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
3335                         }
3336                 }
3337
3338                 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
3339                     $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
3340                         WARN("EXPORTED_WORLD_WRITABLE",
3341                              "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
3342                 }
3343         }
3344
3345         # If we have no input at all, then there is nothing to report on
3346         # so just keep quiet.
3347         if ($#rawlines == -1) {
3348                 exit(0);
3349         }
3350
3351         # In mailback mode only produce a report in the negative, for
3352         # things that appear to be patches.
3353         if ($mailback && ($clean == 1 || !$is_patch)) {
3354                 exit(0);
3355         }
3356
3357         # This is not a patch, and we are are in 'no-patch' mode so
3358         # just keep quiet.
3359         if (!$chk_patch && !$is_patch) {
3360                 exit(0);
3361         }
3362
3363         if (!$is_patch) {
3364                 ERROR("NOT_UNIFIED_DIFF",
3365                       "Does not appear to be a unified-diff format patch\n");
3366         }
3367         if ($is_patch && $chk_signoff && $signoff == 0) {
3368                 ERROR("MISSING_SIGN_OFF",
3369                       "Missing Signed-off-by: line(s)\n");
3370         }
3371
3372         print report_dump();
3373         if ($summary && !($clean == 1 && $quiet == 1)) {
3374                 print "$filename " if ($summary_file);
3375                 print "total: $cnt_error errors, $cnt_warn warnings, " .
3376                         (($check)? "$cnt_chk checks, " : "") .
3377                         "$cnt_lines lines checked\n";
3378                 print "\n" if ($quiet == 0);
3379         }
3380
3381         if ($quiet == 0) {
3382                 # If there were whitespace errors which cleanpatch can fix
3383                 # then suggest that.
3384                 if ($rpt_cleaners) {
3385                         print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
3386                         print "      scripts/cleanfile\n\n";
3387                         $rpt_cleaners = 0;
3388                 }
3389         }
3390
3391         if (keys %ignore_type) {
3392             print "NOTE: Ignored message types:";
3393             foreach my $ignore (sort keys %ignore_type) {
3394                 print " $ignore";
3395             }
3396             print "\n";
3397             print "\n" if ($quiet == 0);
3398         }
3399
3400         if ($clean == 1 && $quiet == 0) {
3401                 print "$vname has no obvious style problems and is ready for submission.\n"
3402         }
3403         if ($clean == 0 && $quiet == 0) {
3404                 print << "EOM";
3405 $vname has style problems, please review.
3406
3407 If any of these errors are false positives, please report
3408 them to the maintainer, see CHECKPATCH in MAINTAINERS.
3409 EOM
3410         }
3411
3412         return $clean;
3413 }