scripts/checkpatch.pl

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