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         # We are truly at the end, so shuffle to the next line.
 474         if ($off == $len) {
 475                 $loff = $len + 1;
 476                 $line++;
 477                 $remain--;
 478         }
 479
 480         my $statement = substr($blk, $soff, $off - $soff + 1);
 481         my $condition = substr($blk, $soff, $coff - $soff + 1);
 482
 483         #warn "STATEMENT<$statement>\n";
 484         #warn "CONDITION<$condition>\n";
 485
 486         #print "coff<$coff> soff<$off> loff<$loff>\n";
 487
 488         return ($statement, $condition,
 489                         $line, $remain + 1, $off - $loff + 1, $level);
 490 }
 491
 492 sub statement_lines {
 493         my ($stmt) = @_;
 494
 495         # Strip the diff line prefixes and rip blank lines at start and end.
 496         $stmt =~ s/(^|\n)./$1/g;
 497         $stmt =~ s/^\s*//;
 498         $stmt =~ s/\s*$//;
 499
 500         my @stmt_lines = ($stmt =~ /\n/g);
 501
 502         return $#stmt_lines + 2;
 503 }
 504
 505 sub statement_rawlines {
 506         my ($stmt) = @_;
 507
 508         my @stmt_lines = ($stmt =~ /\n/g);
 509
 510         return $#stmt_lines + 2;
 511 }
 512
 513 sub statement_block_size {
 514         my ($stmt) = @_;
 515
 516         $stmt =~ s/(^|\n)./$1/g;
 517         $stmt =~ s/^\s*{//;
 518         $stmt =~ s/}\s*$//;
 519         $stmt =~ s/^\s*//;
 520         $stmt =~ s/\s*$//;
 521
 522         my @stmt_lines = ($stmt =~ /\n/g);
 523         my @stmt_statements = ($stmt =~ /;/g);
 524
 525         my $stmt_lines = $#stmt_lines + 2;
 526         my $stmt_statements = $#stmt_statements + 1;
 527
 528         if ($stmt_lines > $stmt_statements) {
 529                 return $stmt_lines;
 530         } else {
 531                 return $stmt_statements;
 532         }
 533 }
 534
 535 sub ctx_statement_full {
 536         my ($linenr, $remain, $off) = @_;
 537         my ($statement, $condition, $level);
 538
 539         my (@chunks);
 540
 541         # Grab the first conditional/block pair.
 542         ($statement, $condition, $linenr, $remain, $off, $level) =
 543                                 ctx_statement_block($linenr, $remain, $off);
 544         #print "F: c<$condition> s<$statement> remain<$remain>\n";
 545         push(@chunks, [ $condition, $statement ]);
 546         if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
 547                 return ($level, $linenr, @chunks);
 548         }
 549
 550         # Pull in the following conditional/block pairs and see if they
 551         # could continue the statement.
 552         for (;;) {
 553                 ($statement, $condition, $linenr, $remain, $off, $level) =
 554                                 ctx_statement_block($linenr, $remain, $off);
 555                 #print "C: c<$condition> s<$statement> remain<$remain>\n";
 556                 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
 557                 #print "C: push\n";
 558                 push(@chunks, [ $condition, $statement ]);
 559         }
 560
 561         return ($level, $linenr, @chunks);
 562 }
 563
 564 sub ctx_block_get {
 565         my ($linenr, $remain, $outer, $open, $close, $off) = @_;
 566         my $line;
 567         my $start = $linenr - 1;
 568         my $blk = '';
 569         my @o;
 570         my @c;
 571         my @res = ();
 572
 573         my $level = 0;
 574         for ($line = $start; $remain > 0; $line++) {
 575                 next if ($rawlines[$line] =~ /^-/);
 576                 $remain--;
 577
 578                 $blk .= $rawlines[$line];
 579                 foreach my $c (split(//, $rawlines[$line])) {
 580                         ##print "C<$c>L<$level><$open$close>O<$off>\n";
 581                         if ($off > 0) {
 582                                 $off--;
 583                                 next;
 584                         }
 585
 586                         if ($c eq $close && $level > 0) {
 587                                 $level--;
 588                                 last if ($level == 0);
 589                         } elsif ($c eq $open) {
 590                                 $level++;
 591                         }
 592                 }
 593
 594                 if (!$outer || $level <= 1) {
 595                         push(@res, $rawlines[$line]);
 596                 }
 597
 598                 last if ($level == 0);
 599         }
 600
 601         return ($level, @res);
 602 }
 603 sub ctx_block_outer {
 604         my ($linenr, $remain) = @_;
 605
 606         my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
 607         return @r;
 608 }
 609 sub ctx_block {
 610         my ($linenr, $remain) = @_;
 611
 612         my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
 613         return @r;
 614 }
 615 sub ctx_statement {
 616         my ($linenr, $remain, $off) = @_;
 617
 618         my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
 619         return @r;
 620 }
 621 sub ctx_block_level {
 622         my ($linenr, $remain) = @_;
 623
 624         return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
 625 }
 626 sub ctx_statement_level {
 627         my ($linenr, $remain, $off) = @_;
 628
 629         return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
 630 }
 631
 632 sub ctx_locate_comment {
 633         my ($first_line, $end_line) = @_;
 634
 635         # Catch a comment on the end of the line itself.
 636         my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
 637         return $current_comment if (defined $current_comment);
 638
 639         # Look through the context and try and figure out if there is a
 640         # comment.
 641         my $in_comment = 0;
 642         $current_comment = '';
 643         for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
 644                 my $line = $rawlines[$linenr - 1];
 645                 #warn "           $line\n";
 646                 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
 647                         $in_comment = 1;
 648                 }
 649                 if ($line =~ m@/\*@) {
 650                         $in_comment = 1;
 651                 }
 652                 if (!$in_comment && $current_comment ne '') {
 653                         $current_comment = '';
 654                 }
 655                 $current_comment .= $line . "\n" if ($in_comment);
 656                 if ($line =~ m@\*/@) {
 657                         $in_comment = 0;
 658                 }
 659         }
 660
 661         chomp($current_comment);
 662         return($current_comment);
 663 }
 664 sub ctx_has_comment {
 665         my ($first_line, $end_line) = @_;
 666         my $cmt = ctx_locate_comment($first_line, $end_line);
 667
 668         ##print "LINE: $rawlines[$end_line - 1 ]\n";
 669         ##print "CMMT: $cmt\n";
 670
 671         return ($cmt ne '');
 672 }
 673
 674 sub cat_vet {
 675         my ($vet) = @_;
 676         my ($res, $coded);
 677
 678         $res = '';
 679         while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
 680                 $res .= $1;
 681                 if ($2 ne '') {
 682                         $coded = sprintf("^%c", unpack('C', $2) + 64);
 683                         $res .= $coded;
 684                 }
 685         }
 686         $res =~ s/$/\$/;
 687
 688         return $res;
 689 }
 690
 691 my $av_preprocessor = 0;
 692 my $av_pending;
 693 my @av_paren_type;
 694
 695 sub annotate_reset {
 696         $av_preprocessor = 0;
 697         $av_pending = '_';
 698         @av_paren_type = ('E');
 699 }
 700
 701 sub annotate_values {
 702         my ($stream, $type) = @_;
 703
 704         my $res;
 705         my $cur = $stream;
 706
 707         print "$stream\n" if ($dbg_values > 1);
 708
 709         while (length($cur)) {
 710                 @av_paren_type = ('E') if ($#av_paren_type < 0);
 711                 print " <" . join('', @av_paren_type) .
 712                                 "> <$type> <$av_pending>" if ($dbg_values > 1);
 713                 if ($cur =~ /^(\s+)/o) {
 714                         print "WS($1)\n" if ($dbg_values > 1);
 715                         if ($1 =~ /\n/ && $av_preprocessor) {
 716                                 $type = pop(@av_paren_type);
 717                                 $av_preprocessor = 0;
 718                         }
 719
 720                 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\))/) {
 721                         print "DECLARE($1)\n" if ($dbg_values > 1);
 722                         $type = 'T';
 723
 724                 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
 725                         print "DEFINE($1,$2)\n" if ($dbg_values > 1);
 726                         $av_preprocessor = 1;
 727                         push(@av_paren_type, $type);
 728                         if ($2 ne '') {
 729                                 $av_pending = 'N';
 730                         }
 731                         $type = 'E';
 732
 733                 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
 734                         print "UNDEF($1)\n" if ($dbg_values > 1);
 735                         $av_preprocessor = 1;
 736                         push(@av_paren_type, $type);
 737
 738                 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
 739                         print "PRE_START($1)\n" if ($dbg_values > 1);
 740                         $av_preprocessor = 1;
 741
 742                         push(@av_paren_type, $type);
 743                         push(@av_paren_type, $type);
 744                         $type = 'E';
 745
 746                 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
 747                         print "PRE_RESTART($1)\n" if ($dbg_values > 1);
 748                         $av_preprocessor = 1;
 749
 750                         push(@av_paren_type, $av_paren_type[$#av_paren_type]);
 751
 752                         $type = 'E';
 753
 754                 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
 755                         print "PRE_END($1)\n" if ($dbg_values > 1);
 756
 757                         $av_preprocessor = 1;
 758
 759                         # Assume all arms of the conditional end as this
 760                         # one does, and continue as if the #endif was not here.
 761                         pop(@av_paren_type);
 762                         push(@av_paren_type, $type);
 763                         $type = 'E';
 764
 765                 } elsif ($cur =~ /^(\\\n)/o) {
 766                         print "PRECONT($1)\n" if ($dbg_values > 1);
 767
 768                 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
 769                         print "ATTR($1)\n" if ($dbg_values > 1);
 770                         $av_pending = $type;
 771                         $type = 'N';
 772
 773                 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
 774                         print "SIZEOF($1)\n" if ($dbg_values > 1);
 775                         if (defined $2) {
 776                                 $av_pending = 'V';
 777                         }
 778                         $type = 'N';
 779
 780                 } elsif ($cur =~ /^(if|while|typeof|__typeof__|for)\b/o) {
 781                         print "COND($1)\n" if ($dbg_values > 1);
 782                         $av_pending = 'N';
 783                         $type = 'N';
 784
 785                 } elsif ($cur =~/^(return|case|else|goto)/o) {
 786                         print "KEYWORD($1)\n" if ($dbg_values > 1);
 787                         $type = 'N';
 788
 789                 } elsif ($cur =~ /^(\()/o) {
 790                         print "PAREN('$1')\n" if ($dbg_values > 1);
 791                         push(@av_paren_type, $av_pending);
 792                         $av_pending = '_';
 793                         $type = 'N';
 794
 795                 } elsif ($cur =~ /^(\))/o) {
 796                         my $new_type = pop(@av_paren_type);
 797                         if ($new_type ne '_') {
 798                                 $type = $new_type;
 799                                 print "PAREN('$1') -> $type\n"
 800                                                         if ($dbg_values > 1);
 801                         } else {
 802                                 print "PAREN('$1')\n" if ($dbg_values > 1);
 803                         }
 804
 805                 } elsif ($cur =~ /^($Ident)\s*\(/o) {
 806                         print "FUNC($1)\n" if ($dbg_values > 1);
 807                         $type = 'V';
 808                         $av_pending = 'V';
 809
 810                 } elsif ($cur =~ /^($Ident|$Constant)/o) {
 811                         print "IDENT($1)\n" if ($dbg_values > 1);
 812                         $type = 'V';
 813
 814                 } elsif ($cur =~ /^($Assignment)/o) {
 815                         print "ASSIGN($1)\n" if ($dbg_values > 1);
 816                         $type = 'N';
 817
 818                 } elsif ($cur =~/^(;|{|})/) {
 819                         print "END($1)\n" if ($dbg_values > 1);
 820                         $type = 'E';
 821
 822                 } elsif ($cur =~ /^(;|\?|:|\[)/o) {
 823                         print "CLOSE($1)\n" if ($dbg_values > 1);
 824                         $type = 'N';
 825
 826                 } elsif ($cur =~ /^($Operators)/o) {
 827                         print "OP($1)\n" if ($dbg_values > 1);
 828                         if ($1 ne '++' && $1 ne '--') {
 829                                 $type = 'N';
 830                         }
 831
 832                 } elsif ($cur =~ /(^.)/o) {
 833                         print "C($1)\n" if ($dbg_values > 1);
 834                 }
 835                 if (defined $1) {
 836                         $cur = substr($cur, length($1));
 837                         $res .= $type x length($1);
 838                 }
 839         }
 840
 841         return $res;
 842 }
 843
 844 sub possible {
 845         my ($possible, $line) = @_;
 846
 847         print "CHECK<$possible> ($line)\n" if ($dbg_possible > 1);
 848         if ($possible !~ /^(?:$Storage|$Type|DEFINE_\S+)$/ &&
 849             $possible ne 'goto' && $possible ne 'return' &&
 850             $possible ne 'case' && $possible ne 'else' &&
 851             $possible ne 'asm' && $possible ne '__asm__' &&
 852             $possible !~ /^(typedef|struct|enum)\b/) {
 853                 # Check for modifiers.
 854                 $possible =~ s/\s*$Storage\s*//g;
 855                 $possible =~ s/\s*$Sparse\s*//g;
 856                 if ($possible =~ /^\s*$/) {
 857
 858                 } elsif ($possible =~ /\s/) {
 859                         $possible =~ s/\s*$Type\s*//g;
 860                         warn "MODIFIER: $possible ($line)\n" if ($dbg_possible);
 861                         push(@modifierList, $possible);
 862
 863                 } else {
 864                         warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
 865                         push(@typeList, $possible);
 866                 }
 867                 build_types();
 868         }
 869 }
 870
 871 my $prefix = '';
 872
 873 sub report {
 874         if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
 875                 return 0;
 876         }
 877         my $line = $prefix . $_[0];
 878
 879         $line = (split('\n', $line))[0] . "\n" if ($terse);
 880
 881         push(our @report, $line);
 882
 883         return 1;
 884 }
 885 sub report_dump {
 886         our @report;
 887 }
 888 sub ERROR {
 889         if (report("ERROR: $_[0]\n")) {
 890                 our $clean = 0;
 891                 our $cnt_error++;
 892         }
 893 }
 894 sub WARN {
 895         if (report("WARNING: $_[0]\n")) {
 896                 our $clean = 0;
 897                 our $cnt_warn++;
 898         }
 899 }
 900 sub CHK {
 901         if ($check && report("CHECK: $_[0]\n")) {
 902                 our $clean = 0;
 903                 our $cnt_chk++;
 904         }
 905 }
 906
 907 sub process {
 908         my $filename = shift;
 909
 910         my $linenr=0;
 911         my $prevline="";
 912         my $prevrawline="";
 913         my $stashline="";
 914         my $stashrawline="";
 915
 916         my $length;
 917         my $indent;
 918         my $previndent=0;
 919         my $stashindent=0;
 920
 921         our $clean = 1;
 922         my $signoff = 0;
 923         my $is_patch = 0;
 924
 925         our @report = ();
 926         our $cnt_lines = 0;
 927         our $cnt_error = 0;
 928         our $cnt_warn = 0;
 929         our $cnt_chk = 0;
 930
 931         # Trace the real file/line as we go.
 932         my $realfile = '';
 933         my $realline = 0;
 934         my $realcnt = 0;
 935         my $here = '';
 936         my $in_comment = 0;
 937         my $comment_edge = 0;
 938         my $first_line = 0;
 939
 940         my $prev_values = 'E';
 941
 942         # suppression flags
 943         my %suppress_ifbraces;
 944
 945         # Pre-scan the patch sanitizing the lines.
 946         # Pre-scan the patch looking for any __setup documentation.
 947         #
 948         my @setup_docs = ();
 949         my $setup_docs = 0;
 950
 951         sanitise_line_reset();
 952         my $line;
 953         foreach my $rawline (@rawlines) {
 954                 $linenr++;
 955                 $line = $rawline;
 956
 957                 if ($rawline=~/^\+\+\+\s+(\S+)/) {
 958                         $setup_docs = 0;
 959                         if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
 960                                 $setup_docs = 1;
 961                         }
 962                         #next;
 963                 }
 964                 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
 965                         $realline=$1-1;
 966                         if (defined $2) {
 967                                 $realcnt=$3+1;
 968                         } else {
 969                                 $realcnt=1+1;
 970                         }
 971                         $in_comment = 0;
 972
 973                         # Guestimate if this is a continuing comment.  Run
 974                         # the context looking for a comment "edge".  If this
 975                         # edge is a close comment then we must be in a comment
 976                         # at context start.
 977                         my $edge;
 978                         for (my $ln = $linenr + 1; $ln < ($linenr + $realcnt); $ln++) {
 979                                 next if ($line =~ /^-/);
 980                                 ($edge) = ($rawlines[$ln - 1] =~ m@(/\*|\*/)@);
 981                                 last if (defined $edge);
 982                         }
 983                         if (defined $edge && $edge eq '*/') {
 984                                 $in_comment = 1;
 985                         }
 986
 987                         # Guestimate if this is a continuing comment.  If this
 988                         # is the start of a diff block and this line starts
 989                         # ' *' then it is very likely a comment.
 990                         if (!defined $edge &&
 991                             $rawlines[$linenr] =~ m@^.\s* \*(?:\s|$)@)
 992                         {
 993                                 $in_comment = 1;
 994                         }
 995
 996                         ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
 997                         sanitise_line_reset($in_comment);
 998
 999                 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1000                         # Standardise the strings and chars within the input to
1001                         # simplify matching -- only bother with positive lines.
1002                         $line = sanitise_line($rawline);
1003                 }
1004                 push(@lines, $line);
1005
1006                 if ($realcnt > 1) {
1007                         $realcnt-- if ($line =~ /^(?:\+| |$)/);
1008                 } else {
1009                         $realcnt = 0;
1010                 }
1011
1012                 #print "==>$rawline\n";
1013                 #print "-->$line\n";
1014
1015                 if ($setup_docs && $line =~ /^\+/) {
1016                         push(@setup_docs, $line);
1017                 }
1018         }
1019
1020         $prefix = '';
1021
1022         $realcnt = 0;
1023         $linenr = 0;
1024         foreach my $line (@lines) {
1025                 $linenr++;
1026
1027                 my $rawline = $rawlines[$linenr - 1];
1028
1029 #extract the line range in the file after the patch is applied
1030                 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1031                         $is_patch = 1;
1032                         $first_line = $linenr + 1;
1033                         $realline=$1-1;
1034                         if (defined $2) {
1035                                 $realcnt=$3+1;
1036                         } else {
1037                                 $realcnt=1+1;
1038                         }
1039                         annotate_reset();
1040                         $prev_values = 'E';
1041
1042                         %suppress_ifbraces = ();
1043                         next;
1044
1045 # track the line number as we move through the hunk, note that
1046 # new versions of GNU diff omit the leading space on completely
1047 # blank context lines so we need to count that too.
1048                 } elsif ($line =~ /^( |\+|$)/) {
1049                         $realline++;
1050                         $realcnt-- if ($realcnt != 0);
1051
1052                         # Measure the line length and indent.
1053                         ($length, $indent) = line_stats($rawline);
1054
1055                         # Track the previous line.
1056                         ($prevline, $stashline) = ($stashline, $line);
1057                         ($previndent, $stashindent) = ($stashindent, $indent);
1058                         ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1059
1060                         #warn "line<$line>\n";
1061
1062                 } elsif ($realcnt == 1) {
1063                         $realcnt--;
1064                 }
1065
1066 #make up the handle for any error we report on this line
1067                 $prefix = "$filename:$realline: " if ($emacs && $file);
1068                 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1069
1070                 $here = "#$linenr: " if (!$file);
1071                 $here = "#$realline: " if ($file);
1072
1073                 # extract the filename as it passes
1074                 if ($line=~/^\+\+\+\s+(\S+)/) {
1075                         $realfile = $1;
1076                         $realfile =~ s@^[^/]*/@@;
1077
1078                         if ($realfile =~ m@include/asm/@) {
1079                                 ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1080                         }
1081                         next;
1082                 }
1083
1084                 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
1085
1086                 my $hereline = "$here\n$rawline\n";
1087                 my $herecurr = "$here\n$rawline\n";
1088                 my $hereprev = "$here\n$prevrawline\n$rawline\n";
1089
1090                 $cnt_lines++ if ($realcnt != 0);
1091
1092 #check the patch for a signoff:
1093                 if ($line =~ /^\s*signed-off-by:/i) {
1094                         # This is a signoff, if ugly, so do not double report.
1095                         $signoff++;
1096                         if (!($line =~ /^\s*Signed-off-by:/)) {
1097                                 WARN("Signed-off-by: is the preferred form\n" .
1098                                         $herecurr);
1099                         }
1100                         if ($line =~ /^\s*signed-off-by:\S/i) {
1101                                 WARN("space required after Signed-off-by:\n" .
1102                                         $herecurr);
1103                         }
1104                 }
1105
1106 # Check for wrappage within a valid hunk of the file
1107                 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1108                         ERROR("patch seems to be corrupt (line wrapped?)\n" .
1109                                 $herecurr) if (!$emitted_corrupt++);
1110                 }
1111
1112 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1113                 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1114                     $rawline !~ m/^$UTF8*$/) {
1115                         my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1116
1117                         my $blank = copy_spacing($rawline);
1118                         my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1119                         my $hereptr = "$hereline$ptr\n";
1120
1121                         ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1122                 }
1123
1124 #ignore lines being removed
1125                 if ($line=~/^-/) {next;}
1126
1127 # check we are in a valid source file if not then ignore this hunk
1128                 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1129
1130 #trailing whitespace
1131                 if ($line =~ /^\+.*\015/) {
1132                         my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1133                         ERROR("DOS line endings\n" . $herevet);
1134
1135                 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1136                         my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1137                         ERROR("trailing whitespace\n" . $herevet);
1138                 }
1139 #80 column limit
1140                 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
1141                     $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1142                     $line !~ /^\+\s*printk\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ &&
1143                     $length > 80)
1144                 {
1145                         WARN("line over 80 characters\n" . $herecurr);
1146                 }
1147
1148 # check for adding lines without a newline.
1149                 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1150                         WARN("adding a line without newline at end of file\n" . $herecurr);
1151                 }
1152
1153 # check we are in a valid source file *.[hc] if not then ignore this hunk
1154                 next if ($realfile !~ /\.[hc]$/);
1155
1156 # at the beginning of a line any tabs must come first and anything
1157 # more than 8 must use tabs.
1158                 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1159                     $rawline =~ /^\+\s*        \s*/) {
1160                         my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1161                         ERROR("code indent should use tabs where possible\n" . $herevet);
1162                 }
1163
1164 # check for RCS/CVS revision markers
1165                 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
1166                         WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1167                 }
1168
1169 # Check for potential 'bare' types
1170                 my ($stat, $cond);
1171                 if ($realcnt && $line =~ /.\s*\S/) {
1172                         ($stat, $cond) = ctx_statement_block($linenr,
1173                                                                 $realcnt, 0);
1174                         $stat =~ s/\n./\n /g;
1175                         $cond =~ s/\n./\n /g;
1176
1177                         my $s = $stat;
1178                         $s =~ s/{.*$//s;
1179
1180                         # Ignore goto labels.
1181                         if ($s =~ /$Ident:\*$/s) {
1182
1183                         # Ignore functions being called
1184                         } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
1185
1186                         # declarations always start with types
1187                         } elsif ($prev_values eq 'E' && $s =~ /^.\s*(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?((?:\s*$Ident)+)\b(?:\s+$Sparse)?\s*\**\s*(?:$Ident|\(\*[^\)]*\))\s*(?:;|=|,|\()/s) {
1188                                 my $type = $1;
1189                                 $type =~ s/\s+/ /g;
1190                                 possible($type, "A:" . $s);
1191
1192                         # definitions in global scope can only start with types
1193                         } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b/s) {
1194                                 possible($1, "B:" . $s);
1195                         }
1196
1197                         # any (foo ... *) is a pointer cast, and foo is a type
1198                         while ($s =~ /\(($Ident)(?:\s+$Sparse)*\s*\*+\s*\)/sg) {
1199                                 possible($1, "C:" . $s);
1200                         }
1201
1202                         # Check for any sort of function declaration.
1203                         # int foo(something bar, other baz);
1204                         # void (*store_gdt)(x86_descr_ptr *);
1205                         if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
1206                                 my ($name_len) = length($1);
1207
1208                                 my $ctx = $s;
1209                                 substr($ctx, 0, $name_len + 1, '');
1210                                 $ctx =~ s/\)[^\)]*$//;
1211
1212                                 for my $arg (split(/\s*,\s*/, $ctx)) {
1213                                         if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
1214
1215                                                 possible($1, "D:" . $s);
1216                                         }
1217                                 }
1218                         }
1219
1220                 }
1221
1222 #
1223 # Checks which may be anchored in the context.
1224 #
1225
1226 # Check for switch () and associated case and default
1227 # statements should be at the same indent.
1228                 if ($line=~/\bswitch\s*\(.*\)/) {
1229                         my $err = '';
1230                         my $sep = '';
1231                         my @ctx = ctx_block_outer($linenr, $realcnt);
1232                         shift(@ctx);
1233                         for my $ctx (@ctx) {
1234                                 my ($clen, $cindent) = line_stats($ctx);
1235                                 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1236                                                         $indent != $cindent) {
1237                                         $err .= "$sep$ctx\n";
1238                                         $sep = '';
1239                                 } else {
1240                                         $sep = "[...]\n";
1241                                 }
1242                         }
1243                         if ($err ne '') {
1244                                 ERROR("switch and case should be at the same indent\n$hereline$err");
1245                         }
1246                 }
1247                 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
1248                     $line !~ /\G(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$/g) {
1249                         ERROR("trailing statements should be on next line\n" . $herecurr);
1250                 }
1251
1252 # if/while/etc brace do not go on next line, unless defining a do while loop,
1253 # or if that brace on the next line is for something else
1254                 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
1255                         my $pre_ctx = "$1$2";
1256
1257                         my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
1258                         my $ctx_cnt = $realcnt - $#ctx - 1;
1259                         my $ctx = join("\n", @ctx);
1260
1261                         my $ctx_ln = $linenr;
1262                         my $ctx_skip = $realcnt;
1263
1264                         while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1265                                         defined $lines[$ctx_ln - 1] &&
1266                                         $lines[$ctx_ln - 1] =~ /^-/)) {
1267                                 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1268                                 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
1269                                 $ctx_ln++;
1270                         }
1271
1272                         #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1273                         #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
1274
1275                         if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1276                                 ERROR("that open brace { should be on the previous line\n" .
1277                                         "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1278                         }
1279                         if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1280                             $ctx =~ /\)\s*\;\s*$/ &&
1281                             defined $lines[$ctx_ln - 1])
1282                         {
1283                                 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1284                                 if ($nindent > $indent) {
1285                                         WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
1286                                                 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1287                                 }
1288                         }
1289                 }
1290
1291                 # Track the 'values' across context and added lines.
1292                 my $opline = $line; $opline =~ s/^./ /;
1293                 my $curr_values = annotate_values($opline . "\n", $prev_values);
1294                 $curr_values = $prev_values . $curr_values;
1295                 if ($dbg_values) {
1296                         my $outline = $opline; $outline =~ s/\t/ /g;
1297                         print "$linenr > .$outline\n";
1298                         print "$linenr > $curr_values\n";
1299                 }
1300                 $prev_values = substr($curr_values, -1);
1301
1302 #ignore lines not being added
1303                 if ($line=~/^[^\+]/) {next;}
1304
1305 # TEST: allow direct testing of the type matcher.
1306                 if ($tst_type && $line =~ /^.$Declare$/) {
1307                         ERROR("TEST: is type $Declare\n" . $herecurr);
1308                         next;
1309                 }
1310
1311 # check for initialisation to aggregates open brace on the next line
1312                 if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ &&
1313                     $line =~ /^.\s*{/) {
1314                         ERROR("that open brace { should be on the previous line\n" . $hereprev);
1315                 }
1316
1317 #
1318 # Checks which are anchored on the added line.
1319 #
1320
1321 # check for malformed paths in #include statements (uses RAW line)
1322                 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
1323                         my $path = $1;
1324                         if ($path =~ m{//}) {
1325                                 ERROR("malformed #include filename\n" .
1326                                         $herecurr);
1327                         }
1328                 }
1329
1330 # no C99 // comments
1331                 if ($line =~ m{//}) {
1332                         ERROR("do not use C99 // comments\n" . $herecurr);
1333                 }
1334                 # Remove C99 comments.
1335                 $line =~ s@//.*@@;
1336                 $opline =~ s@//.*@@;
1337
1338 #EXPORT_SYMBOL should immediately follow its function closing }.
1339                 if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) ||
1340                     ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1341                         my $name = $1;
1342                         if (($prevline !~ /^}/) &&
1343                            ($prevline !~ /^\+}/) &&
1344                            ($prevline !~ /^ }/) &&
1345                            ($prevline !~ /^.DECLARE_$Ident\(\Q$name\E\)/) &&
1346                            ($prevline !~ /^.LIST_HEAD\(\Q$name\E\)/) &&
1347                            ($prevline !~ /^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(/) &&
1348                            ($prevline !~ /\b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[)/)) {
1349                                 WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
1350                         }
1351                 }
1352
1353 # check for external initialisers.
1354                 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
1355                         ERROR("do not initialise externals to 0 or NULL\n" .
1356                                 $herecurr);
1357                 }
1358 # check for static initialisers.
1359                 if ($line =~ /\s*static\s.*=\s*(0|NULL|false)\s*;/) {
1360                         ERROR("do not initialise statics to 0 or NULL\n" .
1361                                 $herecurr);
1362                 }
1363
1364 # check for new typedefs, only function parameters and sparse annotations
1365 # make sense.
1366                 if ($line =~ /\btypedef\s/ &&
1367                     $line !~ /\btypedef\s+$Type\s+\(\s*\*?$Ident\s*\)\s*\(/ &&
1368                     $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
1369                     $line !~ /\b__bitwise(?:__|)\b/) {
1370                         WARN("do not add new typedefs\n" . $herecurr);
1371                 }
1372
1373 # * goes on variable not on type
1374                 if ($line =~ m{\($NonptrType(\*+)(?:\s+const)?\)}) {
1375                         ERROR("\"(foo$1)\" should be \"(foo $1)\"\n" .
1376                                 $herecurr);
1377
1378                 } elsif ($line =~ m{\($NonptrType\s+(\*+)(?!\s+const)\s+\)}) {
1379                         ERROR("\"(foo $1 )\" should be \"(foo $1)\"\n" .
1380                                 $herecurr);
1381
1382                 } elsif ($line =~ m{$NonptrType(\*+)(?:\s+(?:$Attribute|$Sparse))?\s+[A-Za-z\d_]+}) {
1383                         ERROR("\"foo$1 bar\" should be \"foo $1bar\"\n" .
1384                                 $herecurr);
1385
1386                 } elsif ($line =~ m{$NonptrType\s+(\*+)(?!\s+(?:$Attribute|$Sparse))\s+[A-Za-z\d_]+}) {
1387                         ERROR("\"foo $1 bar\" should be \"foo $1bar\"\n" .
1388                                 $herecurr);
1389                 }
1390
1391 # # no BUG() or BUG_ON()
1392 #               if ($line =~ /\b(BUG|BUG_ON)\b/) {
1393 #                       print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
1394 #                       print "$herecurr";
1395 #                       $clean = 0;
1396 #               }
1397
1398                 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
1399                         WARN("LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
1400                 }
1401
1402 # printk should use KERN_* levels.  Note that follow on printk's on the
1403 # same line do not need a level, so we use the current block context
1404 # to try and find and validate the current printk.  In summary the current
1405 # printk includes all preceeding printk's which have no newline on the end.
1406 # we assume the first bad printk is the one to report.
1407                 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
1408                         my $ok = 0;
1409                         for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
1410                                 #print "CHECK<$lines[$ln - 1]\n";
1411                                 # we have a preceeding printk if it ends
1412                                 # with "\n" ignore it, else it is to blame
1413                                 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
1414                                         if ($rawlines[$ln - 1] !~ m{\\n"}) {
1415                                                 $ok = 1;
1416                                         }
1417                                         last;
1418                                 }
1419                         }
1420                         if ($ok == 0) {
1421                                 WARN("printk() should include KERN_ facility level\n" . $herecurr);
1422                         }
1423                 }
1424
1425 # function brace can't be on same line, except for #defines of do while,
1426 # or if closed on same line
1427                 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
1428                     !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
1429                         ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
1430                 }
1431
1432 # open braces for enum, union and struct go on the same line.
1433                 if ($line =~ /^.\s*{/ &&
1434                     $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1435                         ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
1436                 }
1437
1438 # check for spacing round square brackets; allowed:
1439 #  1. with a type on the left -- int [] a;
1440 #  2. at the beginning of a line for slice initialisers -- [0..10] = 5,
1441                 while ($line =~ /(.*?\s)\[/g) {
1442                         my ($where, $prefix) = ($-[1], $1);
1443                         if ($prefix !~ /$Type\s+$/ &&
1444                             ($where != 0 || $prefix !~ /^.\s+$/)) {
1445                                 ERROR("space prohibited before open square bracket '['\n" . $herecurr);
1446                         }
1447                 }
1448
1449 # check for spaces between functions and their parentheses.
1450                 while ($line =~ /($Ident)\s+\(/g) {
1451                         my $name = $1;
1452                         my $ctx_before = substr($line, 0, $-[1]);
1453                         my $ctx = "$ctx_before$name";
1454
1455                         # Ignore those directives where spaces _are_ permitted.
1456                         if ($name =~ /^(?:
1457                                 if|for|while|switch|return|case|
1458                                 volatile|__volatile__|
1459                                 __attribute__|format|__extension__|
1460                                 asm|__asm__)$/x)
1461                         {
1462
1463                         # cpp #define statements have non-optional spaces, ie
1464                         # if there is a space between the name and the open
1465                         # parenthesis it is simply not a parameter group.
1466                         } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
1467
1468                         # cpp #elif statement condition may start with a (
1469                         } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
1470
1471                         # If this whole things ends with a type its most
1472                         # likely a typedef for a function.
1473                         } elsif ($ctx =~ /$Type$/) {
1474
1475                         } else {
1476                                 WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
1477                         }
1478                 }
1479 # Check operator spacing.
1480                 if (!($line=~/\#\s*include/)) {
1481                         my $ops = qr{
1482                                 <<=|>>=|<=|>=|==|!=|
1483                                 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
1484                                 =>|->|<<|>>|<|>|=|!|~|
1485                                 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
1486                         }x;
1487                         my @elements = split(/($ops|;)/, $opline);
1488                         my $off = 0;
1489
1490                         my $blank = copy_spacing($opline);
1491
1492                         for (my $n = 0; $n < $#elements; $n += 2) {
1493                                 $off += length($elements[$n]);
1494
1495                                 # Pick up the preceeding and succeeding characters.
1496                                 my $ca = substr($opline, 0, $off);
1497                                 my $cc = '';
1498                                 if (length($opline) >= ($off + length($elements[$n + 1]))) {
1499                                         $cc = substr($opline, $off + length($elements[$n + 1]));
1500                                 }
1501                                 my $cb = "$ca$;$cc";
1502
1503                                 my $a = '';
1504                                 $a = 'V' if ($elements[$n] ne '');
1505                                 $a = 'W' if ($elements[$n] =~ /\s$/);
1506                                 $a = 'C' if ($elements[$n] =~ /$;$/);
1507                                 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
1508                                 $a = 'O' if ($elements[$n] eq '');
1509                                 $a = 'E' if ($ca =~ /^\s*$/);
1510
1511                                 my $op = $elements[$n + 1];
1512
1513                                 my $c = '';
1514                                 if (defined $elements[$n + 2]) {
1515                                         $c = 'V' if ($elements[$n + 2] ne '');
1516                                         $c = 'W' if ($elements[$n + 2] =~ /^\s/);
1517                                         $c = 'C' if ($elements[$n + 2] =~ /^$;/);
1518                                         $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
1519                                         $c = 'O' if ($elements[$n + 2] eq '');
1520                                         $c = 'E' if ($elements[$n + 2] =~ /\s*\\$/);
1521                                 } else {
1522                                         $c = 'E';
1523                                 }
1524
1525                                 my $ctx = "${a}x${c}";
1526
1527                                 my $at = "(ctx:$ctx)";
1528
1529                                 my $ptr = substr($blank, 0, $off) . "^";
1530                                 my $hereptr = "$hereline$ptr\n";
1531
1532                                 # Classify operators into binary, unary, or
1533                                 # definitions (* only) where they have more
1534                                 # than one mode.
1535                                 my $op_type = substr($curr_values, $off + 1, 1);
1536                                 my $op_left = substr($curr_values, $off, 1);
1537                                 my $is_unary;
1538                                 if ($op_type eq 'T') {
1539                                         $is_unary = 2;
1540                                 } elsif ($op_left eq 'V') {
1541                                         $is_unary = 0;
1542                                 } else {
1543                                         $is_unary = 1;
1544                                 }
1545                                 #if ($op eq '-' || $op eq '&' || $op eq '*') {
1546                                 #       print "UNARY: <$op_left$op_type $is_unary $a:$op:$c> <$ca:$op:$cc> <$unary_ctx>\n";
1547                                 #}
1548
1549                                 # Ignore operators passed as parameters.
1550                                 if ($op_type ne 'V' &&
1551                                     $ca =~ /\s$/ && $cc =~ /^\s*,/) {
1552
1553 #                               # Ignore comments
1554 #                               } elsif ($op =~ /^$;+$/) {
1555
1556                                 # ; should have either the end of line or a space or \ after it
1557                                 } elsif ($op eq ';') {
1558                                         if ($ctx !~ /.x[WEBC]/ &&
1559                                             $cc !~ /^\\/ && $cc !~ /^;/) {
1560                                                 ERROR("space required after that '$op' $at\n" . $hereptr);
1561                                         }
1562
1563                                 # // is a comment
1564                                 } elsif ($op eq '//') {
1565
1566                                 # -> should have no spaces
1567                                 } elsif ($op eq '->') {
1568                                         if ($ctx =~ /Wx.|.xW/) {
1569                                                 ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
1570                                         }
1571
1572                                 # , must have a space on the right.
1573                                 } elsif ($op eq ',') {
1574                                         if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
1575                                                 ERROR("space required after that '$op' $at\n" . $hereptr);
1576                                         }
1577
1578                                 # '*' as part of a type definition -- reported already.
1579                                 } elsif ($op eq '*' && $is_unary == 2) {
1580                                         #warn "'*' is part of type\n";
1581
1582                                 # unary operators should have a space before and
1583                                 # none after.  May be left adjacent to another
1584                                 # unary operator, or a cast
1585                                 } elsif ($op eq '!' || $op eq '~' ||
1586                                          ($is_unary && ($op eq '*' || $op eq '-' || $op eq '&'))) {
1587                                         if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
1588                                                 ERROR("space required before that '$op' $at\n" . $hereptr);
1589                                         }
1590                                         if ($op  eq '*' && $cc =~/\s*const\b/) {
1591                                                 # A unary '*' may be const
1592
1593                                         } elsif ($ctx =~ /.xW/) {
1594                                                 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1595                                         }
1596
1597                                 # unary ++ and unary -- are allowed no space on one side.
1598                                 } elsif ($op eq '++' or $op eq '--') {
1599                                         if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
1600                                                 ERROR("space required one side of that '$op' $at\n" . $hereptr);
1601                                         }
1602                                         if ($ctx =~ /Wx[BE]/ ||
1603                                             ($ctx =~ /Wx./ && $cc =~ /^;/)) {
1604                                                 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
1605                                         }
1606                                         if ($ctx =~ /ExW/) {
1607                                                 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1608                                         }
1609
1610
1611                                 # << and >> may either have or not have spaces both sides
1612                                 } elsif ($op eq '<<' or $op eq '>>' or
1613                                          $op eq '&' or $op eq '^' or $op eq '|' or
1614                                          $op eq '+' or $op eq '-' or
1615                                          $op eq '*' or $op eq '/' or
1616                                          $op eq '%')
1617                                 {
1618                                         if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
1619                                                 ERROR("need consistent spacing around '$op' $at\n" .
1620                                                         $hereptr);
1621                                         }
1622
1623                                 # All the others need spaces both sides.
1624                                 } elsif ($ctx !~ /[EWC]x[CWE]/) {
1625                                         # Ignore email addresses <foo@bar>
1626                                         if (!($op eq '<' && $cb =~ /$;\S+\@\S+>/) &&
1627                                             !($op eq '>' && $cb =~ /<\S+\@\S+$;/)) {
1628                                                 ERROR("spaces required around that '$op' $at\n" . $hereptr);
1629                                         }
1630                                 }
1631                                 $off += length($elements[$n + 1]);
1632                         }
1633                 }
1634
1635 # check for multiple assignments
1636                 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
1637                         CHK("multiple assignments should be avoided\n" . $herecurr);
1638                 }
1639
1640 ## # check for multiple declarations, allowing for a function declaration
1641 ## # continuation.
1642 ##              if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
1643 ##                  $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
1644 ##
1645 ##                      # Remove any bracketed sections to ensure we do not
1646 ##                      # falsly report the parameters of functions.
1647 ##                      my $ln = $line;
1648 ##                      while ($ln =~ s/\([^\(\)]*\)//g) {
1649 ##                      }
1650 ##                      if ($ln =~ /,/) {
1651 ##                              WARN("declaring multiple variables together should be avoided\n" . $herecurr);
1652 ##                      }
1653 ##              }
1654
1655 #need space before brace following if, while, etc
1656                 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
1657                     $line =~ /do{/) {
1658                         ERROR("space required before the open brace '{'\n" . $herecurr);
1659                 }
1660
1661 # closing brace should have a space following it when it has anything
1662 # on the line
1663                 if ($line =~ /}(?!(?:,|;|\)))\S/) {
1664                         ERROR("space required after that close brace '}'\n" . $herecurr);
1665                 }
1666
1667 # check spacing on square brackets
1668                 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
1669                         ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
1670                 }
1671                 if ($line =~ /\s\]/) {
1672                         ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
1673                 }
1674
1675 # check spacing on parentheses
1676                 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
1677                     $line !~ /for\s*\(\s+;/) {
1678                         ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
1679                 }
1680                 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
1681                     $line !~ /for\s*\(.*;\s+\)/ &&
1682                     $line !~ /:\s+\)/) {
1683                         ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
1684                 }
1685
1686 #goto labels aren't indented, allow a single space however
1687                 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
1688                    !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
1689                         WARN("labels should not be indented\n" . $herecurr);
1690                 }
1691
1692 # Return is not a function.
1693                 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
1694                         my $spacing = $1;
1695                         my $value = $2;
1696
1697                         # Flatten any parentheses and braces
1698                         $value =~ s/\)\(/\) \(/g;
1699                         while ($value =~ s/\([^\(\)]*\)/1/) {
1700                         }
1701
1702                         if ($value =~ /^(?:$Ident|-?$Constant)$/) {
1703                                 ERROR("return is not a function, parentheses are not required\n" . $herecurr);
1704
1705                         } elsif ($spacing !~ /\s+/) {
1706                                 ERROR("space required before the open parenthesis '('\n" . $herecurr);
1707                         }
1708                 }
1709
1710 # Need a space before open parenthesis after if, while etc
1711                 if ($line=~/\b(if|while|for|switch)\(/) {
1712                         ERROR("space required before the open parenthesis '('\n" . $herecurr);
1713                 }
1714
1715 # Check for illegal assignment in if conditional.
1716                 if ($line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
1717                         my ($s, $c) = ($stat, $cond);
1718
1719                         if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/) {
1720                                 ERROR("do not use assignment in if condition\n" . $herecurr);
1721                         }
1722
1723                         # Find out what is on the end of the line after the
1724                         # conditional.
1725                         substr($s, 0, length($c), '');
1726                         $s =~ s/\n.*//g;
1727                         $s =~ s/$;//g;  # Remove any comments
1728                         if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
1729                             $c !~ /}\s*while\s*/)
1730                         {
1731                                 ERROR("trailing statements should be on next line\n" . $herecurr);
1732                         }
1733                 }
1734
1735 # Check for bitwise tests written as boolean
1736                 if ($line =~ /
1737                         (?:
1738                                 (?:\[|\(|\&\&|\|\|)
1739                                 \s*0[xX][0-9]+\s*
1740                                 (?:\&\&|\|\|)
1741                         |
1742                                 (?:\&\&|\|\|)
1743                                 \s*0[xX][0-9]+\s*
1744                                 (?:\&\&|\|\||\)|\])
1745                         )/x)
1746                 {
1747                         WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
1748                 }
1749
1750 # if and else should not have general statements after it
1751                 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
1752                         my $s = $1;
1753                         $s =~ s/$;//g;  # Remove any comments
1754                         if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
1755                                 ERROR("trailing statements should be on next line\n" . $herecurr);
1756                         }
1757                 }
1758
1759                 # Check for }<nl>else {, these must be at the same
1760                 # indent level to be relevant to each other.
1761                 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
1762                                                 $previndent == $indent) {
1763                         ERROR("else should follow close brace '}'\n" . $hereprev);
1764                 }
1765
1766                 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
1767                                                 $previndent == $indent) {
1768                         my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
1769
1770                         # Find out what is on the end of the line after the
1771                         # conditional.
1772                         substr($s, 0, length($c), '');
1773                         $s =~ s/\n.*//g;
1774
1775                         if ($s =~ /^\s*;/) {
1776                                 ERROR("while should follow close brace '}'\n" . $hereprev);
1777                         }
1778                 }
1779
1780 #studly caps, commented out until figure out how to distinguish between use of existing and adding new
1781 #               if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
1782 #                   print "No studly caps, use _\n";
1783 #                   print "$herecurr";
1784 #                   $clean = 0;
1785 #               }
1786
1787 #no spaces allowed after \ in define
1788                 if ($line=~/\#\s*define.*\\\s$/) {
1789                         WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
1790                 }
1791
1792 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
1793                 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
1794                         my $checkfile = "include/linux/$1.h";
1795                         if (-f "$root/$checkfile" && $realfile ne $checkfile &&
1796                             $1 ne 'irq')
1797                         {
1798                                 WARN("Use #include <linux/$1.h> instead of <asm/$1.h>\n" .
1799                                         $herecurr);
1800                         }
1801                 }
1802
1803 # multi-statement macros should be enclosed in a do while loop, grab the
1804 # first statement and ensure its the whole macro if its not enclosed
1805 # in a known good container
1806                 if ($line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
1807                         my $ln = $linenr;
1808                         my $cnt = $realcnt;
1809                         my ($off, $dstat, $dcond, $rest);
1810                         my $ctx = '';
1811
1812                         my $args = defined($1);
1813
1814                         # Find the end of the macro and limit our statement
1815                         # search to that.
1816                         while ($cnt > 0 && defined $lines[$ln - 1] &&
1817                                 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
1818                         {
1819                                 $ctx .= $rawlines[$ln - 1] . "\n";
1820                                 $cnt-- if ($lines[$ln - 1] !~ /^-/);
1821                                 $ln++;
1822                         }
1823                         $ctx .= $rawlines[$ln - 1];
1824
1825                         ($dstat, $dcond, $ln, $cnt, $off) =
1826                                 ctx_statement_block($linenr, $ln - $linenr + 1, 0);
1827                         #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
1828                         #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
1829
1830                         # Extract the remainder of the define (if any) and
1831                         # rip off surrounding spaces, and trailing \'s.
1832                         $rest = '';
1833                         while ($off != 0 || ($cnt > 0 && $rest =~ /(?:^|\\)\s*$/)) {
1834                                 #print "ADDING $off <" . substr($lines[$ln - 1], $off) . ">\n";
1835                                 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
1836                                         $rest .= substr($lines[$ln - 1], $off) . "\n";
1837                                         $cnt--;
1838                                 }
1839                                 $ln++;
1840                                 $off = 0;
1841                         }
1842                         $rest =~ s/\\\n.//g;
1843                         $rest =~ s/^\s*//s;
1844                         $rest =~ s/\s*$//s;
1845
1846                         # Clean up the original statement.
1847                         if ($args) {
1848                                 substr($dstat, 0, length($dcond), '');
1849                         } else {
1850                                 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
1851                         }
1852                         $dstat =~ s/\\\n.//g;
1853                         $dstat =~ s/^\s*//s;
1854                         $dstat =~ s/\s*$//s;
1855
1856                         # Flatten any parentheses and braces
1857                         while ($dstat =~ s/\([^\(\)]*\)/1/) {
1858                         }
1859                         while ($dstat =~ s/\{[^\{\}]*\}/1/) {
1860                         }
1861
1862                         my $exceptions = qr{
1863                                 $Declare|
1864                                 module_param_named|
1865                                 MODULE_PARAM_DESC|
1866                                 DECLARE_PER_CPU|
1867                                 DEFINE_PER_CPU|
1868                                 __typeof__\(
1869                         }x;
1870                         #print "REST<$rest>\n";
1871                         if ($rest ne '') {
1872                                 if ($rest !~ /while\s*\(/ &&
1873                                     $dstat !~ /$exceptions/)
1874                                 {
1875                                         ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
1876                                 }
1877
1878                         } elsif ($ctx !~ /;/) {
1879                                 if ($dstat ne '' &&
1880                                     $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
1881                                     $dstat !~ /$exceptions/ &&
1882                                     $dstat =~ /$Operators/)
1883                                 {
1884                                         ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
1885                                 }
1886                         }
1887                 }
1888
1889 # check for redundant bracing round if etc
1890                 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
1891                         my ($level, $endln, @chunks) =
1892                                 ctx_statement_full($linenr, $realcnt, 1);
1893                         #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
1894                         #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
1895                         if ($#chunks > 0 && $level == 0) {
1896                                 my $allowed = 0;
1897                                 my $seen = 0;
1898                                 my $herectx = $here . "\n";
1899                                 my $ln = $linenr - 1;
1900                                 for my $chunk (@chunks) {
1901                                         my ($cond, $block) = @{$chunk};
1902
1903                                         # If the condition carries leading newlines, then count those as offsets.
1904                                         my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
1905                                         my $offset = statement_rawlines($whitespace) - 1;
1906
1907                                         #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
1908
1909                                         # We have looked at and allowed this specific line.
1910                                         $suppress_ifbraces{$ln + $offset} = 1;
1911
1912                                         $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
1913                                         $ln += statement_rawlines($block) - 1;
1914
1915                                         substr($block, 0, length($cond), '');
1916
1917                                         $seen++ if ($block =~ /^\s*{/);
1918
1919                                         #print "cond<$cond> block<$block> allowed<$allowed>\n";
1920                                         if (statement_lines($cond) > 1) {
1921                                                 #print "APW: ALLOWED: cond<$cond>\n";
1922                                                 $allowed = 1;
1923                                         }
1924                                         if ($block =~/\b(?:if|for|while)\b/) {
1925                                                 #print "APW: ALLOWED: block<$block>\n";
1926                                                 $allowed = 1;
1927                                         }
1928                                         if (statement_block_size($block) > 1) {
1929                                                 #print "APW: ALLOWED: lines block<$block>\n";
1930                                                 $allowed = 1;
1931                                         }
1932                                 }
1933                                 if ($seen && !$allowed) {
1934                                         WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
1935                                 }
1936                         }
1937                 }
1938                 if (!defined $suppress_ifbraces{$linenr - 1} &&
1939                                         $line =~ /\b(if|while|for|else)\b/) {
1940                         my $allowed = 0;
1941
1942                         # Check the pre-context.
1943                         if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
1944                                 #print "APW: ALLOWED: pre<$1>\n";
1945                                 $allowed = 1;
1946                         }
1947
1948                         my ($level, $endln, @chunks) =
1949                                 ctx_statement_full($linenr, $realcnt, $-[0]);
1950
1951                         # Check the condition.
1952                         my ($cond, $block) = @{$chunks[0]};
1953                         #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
1954                         if (defined $cond) {
1955                                 substr($block, 0, length($cond), '');
1956                         }
1957                         if (statement_lines($cond) > 1) {
1958                                 #print "APW: ALLOWED: cond<$cond>\n";
1959                                 $allowed = 1;
1960                         }
1961                         if ($block =~/\b(?:if|for|while)\b/) {
1962                                 #print "APW: ALLOWED: block<$block>\n";
1963                                 $allowed = 1;
1964                         }
1965                         if (statement_block_size($block) > 1) {
1966                                 #print "APW: ALLOWED: lines block<$block>\n";
1967                                 $allowed = 1;
1968                         }
1969                         # Check the post-context.
1970                         if (defined $chunks[1]) {
1971                                 my ($cond, $block) = @{$chunks[1]};
1972                                 if (defined $cond) {
1973                                         substr($block, 0, length($cond), '');
1974                                 }
1975                                 if ($block =~ /^\s*\{/) {
1976                                         #print "APW: ALLOWED: chunk-1 block<$block>\n";
1977                                         $allowed = 1;
1978                                 }
1979                         }
1980                         if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
1981                                 my $herectx = $here . "\n";;
1982                                 my $end = $linenr + statement_rawlines($block) - 1;
1983
1984                                 for (my $ln = $linenr - 1; $ln < $end; $ln++) {
1985                                         $herectx .= $rawlines[$ln] . "\n";;
1986                                 }
1987
1988                                 WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
1989                         }
1990                 }
1991
1992 # don't include deprecated include files (uses RAW line)
1993                 for my $inc (@dep_includes) {
1994                         if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
1995                                 ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
1996                         }
1997                 }
1998
1999 # don't use deprecated functions
2000                 for my $func (@dep_functions) {
2001                         if ($line =~ /\b$func\b/) {
2002                                 ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2003                         }
2004                 }
2005
2006 # no volatiles please
2007                 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2008                 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
2009                         WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
2010                 }
2011
2012 # SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
2013                 if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
2014                         ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
2015                 }
2016
2017 # warn about #if 0
2018                 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
2019                         CHK("if this code is redundant consider removing it\n" .
2020                                 $herecurr);
2021                 }
2022
2023 # check for needless kfree() checks
2024                 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2025                         my $expr = $1;
2026                         if ($line =~ /\bkfree\(\Q$expr\E\);/) {
2027                                 WARN("kfree(NULL) is safe this check is probabally not required\n" . $hereprev);
2028                         }
2029                 }
2030
2031 # warn about #ifdefs in C files
2032 #               if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
2033 #                       print "#ifdef in C files should be avoided\n";
2034 #                       print "$herecurr";
2035 #                       $clean = 0;
2036 #               }
2037
2038 # warn about spacing in #ifdefs
2039                 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
2040                         ERROR("exactly one space required after that #$1\n" . $herecurr);
2041                 }
2042
2043 # check for spinlock_t definitions without a comment.
2044                 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
2045                     $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
2046                         my $which = $1;
2047                         if (!ctx_has_comment($first_line, $linenr)) {
2048                                 CHK("$1 definition without comment\n" . $herecurr);
2049                         }
2050                 }
2051 # check for memory barriers without a comment.
2052                 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2053                         if (!ctx_has_comment($first_line, $linenr)) {
2054                                 CHK("memory barrier without comment\n" . $herecurr);
2055                         }
2056                 }
2057 # check of hardware specific defines
2058                 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
2059                         CHK("architecture specific defines should be avoided\n" .  $herecurr);
2060                 }
2061
2062 # check the location of the inline attribute, that it is between
2063 # storage class and type.
2064                 if ($line =~ /\b$Type\s+$Inline\b/ ||
2065                     $line =~ /\b$Inline\s+$Storage\b/) {
2066                         ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
2067                 }
2068
2069 # Check for __inline__ and __inline, prefer inline
2070                 if ($line =~ /\b(__inline__|__inline)\b/) {
2071                         WARN("plain inline is preferred over $1\n" . $herecurr);
2072                 }
2073
2074 # check for new externs in .c files.
2075                 if ($realfile =~ /\.c$/ && defined $stat &&
2076                     $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
2077                 {
2078                         my $function_name = $1;
2079                         my $paren_space = $2;
2080
2081                         my $s = $stat;
2082                         if (defined $cond) {
2083                                 substr($s, 0, length($cond), '');
2084                         }
2085                         if ($s =~ /^\s*;/ &&
2086                             $function_name ne 'uninitialized_var')
2087                         {
2088                                 WARN("externs should be avoided in .c files\n" .  $herecurr);
2089                         }
2090
2091                         if ($paren_space =~ /\n/) {
2092                                 WARN("arguments for function declarations should follow identifier\n" . $herecurr);
2093                         }
2094
2095                 } elsif ($realfile =~ /\.c$/ && defined $stat &&
2096                     $stat =~ /^.\s*extern\s+/)
2097                 {
2098                         WARN("externs should be avoided in .c files\n" .  $herecurr);
2099                 }
2100
2101 # checks for new __setup's
2102                 if ($rawline =~ /\b__setup\("([^"]*)"/) {
2103                         my $name = $1;
2104
2105                         if (!grep(/$name/, @setup_docs)) {
2106                                 CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
2107                         }
2108                 }
2109
2110 # check for pointless casting of kmalloc return
2111                 if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
2112                         WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
2113                 }
2114
2115 # check for gcc specific __FUNCTION__
2116                 if ($line =~ /__FUNCTION__/) {
2117                         WARN("__func__ should be used instead of gcc specific __FUNCTION__\n"  . $herecurr);
2118                 }
2119
2120 # check for semaphores used as mutexes
2121                 if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
2122                         WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
2123                 }
2124 # check for semaphores used as mutexes
2125                 if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
2126                         WARN("consider using a completion\n" . $herecurr);
2127                 }
2128 # recommend strict_strto* over simple_strto*
2129                 if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2130                         WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
2131                 }
2132 # check for __initcall(), use device_initcall() explicitly please
2133                 if ($line =~ /^.\s*__initcall\s*\(/) {
2134                         WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
2135                 }
2136
2137 # use of NR_CPUS is usually wrong
2138 # ignore definitions of NR_CPUS and usage to define arrays as likely right
2139                 if ($line =~ /\bNR_CPUS\b/ &&
2140                     $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
2141                     $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
2142                     $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
2143                     $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
2144                     $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
2145                 {
2146                         WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
2147                 }
2148
2149 # check for %L{u,d,i} in strings
2150                 my $string;
2151                 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2152                         $string = substr($rawline, $-[1], $+[1] - $-[1]);
2153                         if ($string =~ /(?<!%)%L[udi]/) {
2154                                 WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2155                                 last;
2156                         }
2157                 }
2158         }
2159
2160         # If we have no input at all, then there is nothing to report on
2161         # so just keep quiet.
2162         if ($#rawlines == -1) {
2163                 exit(0);
2164         }
2165
2166         # In mailback mode only produce a report in the negative, for
2167         # things that appear to be patches.
2168         if ($mailback && ($clean == 1 || !$is_patch)) {
2169                 exit(0);
2170         }
2171
2172         # This is not a patch, and we are are in 'no-patch' mode so
2173         # just keep quiet.
2174         if (!$chk_patch && !$is_patch) {
2175                 exit(0);
2176         }
2177
2178         if (!$is_patch) {
2179                 ERROR("Does not appear to be a unified-diff format patch\n");
2180         }
2181         if ($is_patch && $chk_signoff && $signoff == 0) {
2182                 ERROR("Missing Signed-off-by: line(s)\n");
2183         }
2184
2185         print report_dump();
2186         if ($summary && !($clean == 1 && $quiet == 1)) {
2187                 print "$filename " if ($summary_file);
2188                 print "total: $cnt_error errors, $cnt_warn warnings, " .
2189                         (($check)? "$cnt_chk checks, " : "") .
2190                         "$cnt_lines lines checked\n";
2191                 print "\n" if ($quiet == 0);
2192         }
2193
2194         if ($clean == 1 && $quiet == 0) {
2195                 print "$vname has no obvious style problems and is ready for submission.\n"
2196         }
2197         if ($clean == 0 && $quiet == 0) {
2198                 print "$vname has style problems, please review.  If any of these errors\n";
2199                 print "are false positives report them to the maintainer, see\n";
2200                 print "CHECKPATCH in MAINTAINERS.\n";
2201         }
2202
2203         return $clean;
2204 }