scripts/checkpatch.pl

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