scripts/checkpatch.pl

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