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