SAFE public projects git trees. - safe/jmp/linux-2.6/blob - scripts/checkpatch.pl

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