Pileus Git - ~andy/linux/blob - scripts/checkpatch.pl

   1 #!/usr/bin/perl -w
   2 # (c) 2001, Dave Jones. (the file handling bit)
   3 # (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
   4 # (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
   5 # (c) 2008-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.32';
  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 $show_types = 0;
  30 my $root;
  31 my %debug;
  32 my %ignore_type = ();
  33 my @ignore = ();
  34 my $help = 0;
  35 my $configuration_file = ".checkpatch.conf";
  36 my $max_line_length = 80;
  37
  38 sub help {
  39         my ($exitcode) = @_;
  40
  41         print << "EOM";
  42 Usage: $P [OPTION]... [FILE]...
  43 Version: $V
  44
  45 Options:
  46   -q, --quiet                quiet
  47   --no-tree                  run without a kernel tree
  48   --no-signoff               do not check for 'Signed-off-by' line
  49   --patch                    treat FILE as patchfile (default)
  50   --emacs                    emacs compile window format
  51   --terse                    one line per report
  52   -f, --file                 treat FILE as regular source file
  53   --subjective, --strict     enable more subjective tests
  54   --ignore TYPE(,TYPE2...)   ignore various comma separated message types
  55   --max-line-length=n        set the maximum line length, if exceeded, warn
  56   --show-types               show the message "types" in the output
  57   --root=PATH                PATH to the kernel tree root
  58   --no-summary               suppress the per-file summary
  59   --mailback                 only produce a report in case of warnings/errors
  60   --summary-file             include the filename in summary
  61   --debug KEY=[0|1]          turn on/off debugging of KEY, where KEY is one of
  62                              'values', 'possible', 'type', and 'attr' (default
  63                              is all off)
  64   --test-only=WORD           report only warnings/errors containing WORD
  65                              literally
  66   -h, --help, --version      display this help and exit
  67
  68 When FILE is - read standard input.
  69 EOM
  70
  71         exit($exitcode);
  72 }
  73
  74 my $conf = which_conf($configuration_file);
  75 if (-f $conf) {
  76         my @conf_args;
  77         open(my $conffile, '<', "$conf")
  78             or warn "$P: Can't find a readable $configuration_file file $!\n";
  79
  80         while (<$conffile>) {
  81                 my $line = $_;
  82
  83                 $line =~ s/\s*\n?$//g;
  84                 $line =~ s/^\s*//g;
  85                 $line =~ s/\s+/ /g;
  86
  87                 next if ($line =~ m/^\s*#/);
  88                 next if ($line =~ m/^\s*$/);
  89
  90                 my @words = split(" ", $line);
  91                 foreach my $word (@words) {
  92                         last if ($word =~ m/^#/);
  93                         push (@conf_args, $word);
  94                 }
  95         }
  96         close($conffile);
  97         unshift(@ARGV, @conf_args) if @conf_args;
  98 }
  99
 100 GetOptions(
 101         'q|quiet+'      => \$quiet,
 102         'tree!'         => \$tree,
 103         'signoff!'      => \$chk_signoff,
 104         'patch!'        => \$chk_patch,
 105         'emacs!'        => \$emacs,
 106         'terse!'        => \$terse,
 107         'f|file!'       => \$file,
 108         'subjective!'   => \$check,
 109         'strict!'       => \$check,
 110         'ignore=s'      => \@ignore,
 111         'show-types!'   => \$show_types,
 112         'max-line-length=i' => \$max_line_length,
 113         'root=s'        => \$root,
 114         'summary!'      => \$summary,
 115         'mailback!'     => \$mailback,
 116         'summary-file!' => \$summary_file,
 117
 118         'debug=s'       => \%debug,
 119         'test-only=s'   => \$tst_only,
 120         'h|help'        => \$help,
 121         'version'       => \$help
 122 ) or help(1);
 123
 124 help(0) if ($help);
 125
 126 my $exit = 0;
 127
 128 if ($#ARGV < 0) {
 129         print "$P: no input files\n";
 130         exit(1);
 131 }
 132
 133 @ignore = split(/,/, join(',',@ignore));
 134 foreach my $word (@ignore) {
 135         $word =~ s/\s*\n?$//g;
 136         $word =~ s/^\s*//g;
 137         $word =~ s/\s+/ /g;
 138         $word =~ tr/[a-z]/[A-Z]/;
 139
 140         next if ($word =~ m/^\s*#/);
 141         next if ($word =~ m/^\s*$/);
 142
 143         $ignore_type{$word}++;
 144 }
 145
 146 my $dbg_values = 0;
 147 my $dbg_possible = 0;
 148 my $dbg_type = 0;
 149 my $dbg_attr = 0;
 150 for my $key (keys %debug) {
 151         ## no critic
 152         eval "\${dbg_$key} = '$debug{$key}';";
 153         die "$@" if ($@);
 154 }
 155
 156 my $rpt_cleaners = 0;
 157
 158 if ($terse) {
 159         $emacs = 1;
 160         $quiet++;
 161 }
 162
 163 if ($tree) {
 164         if (defined $root) {
 165                 if (!top_of_kernel_tree($root)) {
 166                         die "$P: $root: --root does not point at a valid tree\n";
 167                 }
 168         } else {
 169                 if (top_of_kernel_tree('.')) {
 170                         $root = '.';
 171                 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
 172                                                 top_of_kernel_tree($1)) {
 173                         $root = $1;
 174                 }
 175         }
 176
 177         if (!defined $root) {
 178                 print "Must be run from the top-level dir. of a kernel tree\n";
 179                 exit(2);
 180         }
 181 }
 182
 183 my $emitted_corrupt = 0;
 184
 185 our $Ident      = qr{
 186                         [A-Za-z_][A-Za-z\d_]*
 187                         (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
 188                 }x;
 189 our $Storage    = qr{extern|static|asmlinkage};
 190 our $Sparse     = qr{
 191                         __user|
 192                         __kernel|
 193                         __force|
 194                         __iomem|
 195                         __must_check|
 196                         __init_refok|
 197                         __kprobes|
 198                         __ref|
 199                         __rcu
 200                 }x;
 201
 202 # Notes to $Attribute:
 203 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
 204 our $Attribute  = qr{
 205                         const|
 206                         __percpu|
 207                         __nocast|
 208                         __safe|
 209                         __bitwise__|
 210                         __packed__|
 211                         __packed2__|
 212                         __naked|
 213                         __maybe_unused|
 214                         __always_unused|
 215                         __noreturn|
 216                         __used|
 217                         __cold|
 218                         __noclone|
 219                         __deprecated|
 220                         __read_mostly|
 221                         __kprobes|
 222                         __(?:mem|cpu|dev|)(?:initdata|initconst|init\b)|
 223                         ____cacheline_aligned|
 224                         ____cacheline_aligned_in_smp|
 225                         ____cacheline_internodealigned_in_smp|
 226                         __weak
 227                   }x;
 228 our $Modifier;
 229 our $Inline     = qr{inline|__always_inline|noinline};
 230 our $Member     = qr{->$Ident|\.$Ident|\[[^]]*\]};
 231 our $Lval       = qr{$Ident(?:$Member)*};
 232
 233 our $Float_hex  = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
 234 our $Float_dec  = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
 235 our $Float_int  = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
 236 our $Float      = qr{$Float_hex|$Float_dec|$Float_int};
 237 our $Constant   = qr{$Float|(?i)(?:0x[0-9a-f]+|[0-9]+)[ul]*};
 238 our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
 239 our $Compare    = qr{<=|>=|==|!=|<|>};
 240 our $Operators  = qr{
 241                         <=|>=|==|!=|
 242                         =>|->|<<|>>|<|>|!|~|
 243                         &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
 244                   }x;
 245
 246 our $NonptrType;
 247 our $Type;
 248 our $Declare;
 249
 250 our $NON_ASCII_UTF8     = qr{
 251         [\xC2-\xDF][\x80-\xBF]               # non-overlong 2-byte
 252         |  \xE0[\xA0-\xBF][\x80-\xBF]        # excluding overlongs
 253         | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2}  # straight 3-byte
 254         |  \xED[\x80-\x9F][\x80-\xBF]        # excluding surrogates
 255         |  \xF0[\x90-\xBF][\x80-\xBF]{2}     # planes 1-3
 256         | [\xF1-\xF3][\x80-\xBF]{3}          # planes 4-15
 257         |  \xF4[\x80-\x8F][\x80-\xBF]{2}     # plane 16
 258 }x;
 259
 260 our $UTF8       = qr{
 261         [\x09\x0A\x0D\x20-\x7E]              # ASCII
 262         | $NON_ASCII_UTF8
 263 }x;
 264
 265 our $typeTypedefs = qr{(?x:
 266         (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
 267         atomic_t
 268 )};
 269
 270 our $logFunctions = qr{(?x:
 271         printk(?:_ratelimited|_once|)|
 272         [a-z0-9]+_(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
 273         WARN(?:_RATELIMIT|_ONCE|)|
 274         panic|
 275         MODULE_[A-Z_]+
 276 )};
 277
 278 our $signature_tags = qr{(?xi:
 279         Signed-off-by:|
 280         Acked-by:|
 281         Tested-by:|
 282         Reviewed-by:|
 283         Reported-by:|
 284         To:|
 285         Cc:
 286 )};
 287
 288 our @typeList = (
 289         qr{void},
 290         qr{(?:unsigned\s+)?char},
 291         qr{(?:unsigned\s+)?short},
 292         qr{(?:unsigned\s+)?int},
 293         qr{(?:unsigned\s+)?long},
 294         qr{(?:unsigned\s+)?long\s+int},
 295         qr{(?:unsigned\s+)?long\s+long},
 296         qr{(?:unsigned\s+)?long\s+long\s+int},
 297         qr{unsigned},
 298         qr{float},
 299         qr{double},
 300         qr{bool},
 301         qr{struct\s+$Ident},
 302         qr{union\s+$Ident},
 303         qr{enum\s+$Ident},
 304         qr{${Ident}_t},
 305         qr{${Ident}_handler},
 306         qr{${Ident}_handler_fn},
 307 );
 308 our @modifierList = (
 309         qr{fastcall},
 310 );
 311
 312 our $allowed_asm_includes = qr{(?x:
 313         irq|
 314         memory
 315 )};
 316 # memory.h: ARM has a custom one
 317
 318 sub build_types {
 319         my $mods = "(?x:  \n" . join("|\n  ", @modifierList) . "\n)";
 320         my $all = "(?x:  \n" . join("|\n  ", @typeList) . "\n)";
 321         $Modifier       = qr{(?:$Attribute|$Sparse|$mods)};
 322         $NonptrType     = qr{
 323                         (?:$Modifier\s+|const\s+)*
 324                         (?:
 325                                 (?:typeof|__typeof__)\s*\([^\)]*\)|
 326                                 (?:$typeTypedefs\b)|
 327                                 (?:${all}\b)
 328                         )
 329                         (?:\s+$Modifier|\s+const)*
 330                   }x;
 331         $Type   = qr{
 332                         $NonptrType
 333                         (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*|\[\])+|(?:\s*\[\s*\])+)?
 334                         (?:\s+$Inline|\s+$Modifier)*
 335                   }x;
 336         $Declare        = qr{(?:$Storage\s+)?$Type};
 337 }
 338 build_types();
 339
 340
 341 our $Typecast   = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
 342
 343 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
 344 # requires at least perl version v5.10.0
 345 # Any use must be runtime checked with $^V
 346
 347 our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
 348 our $LvalOrFunc = qr{($Lval)\s*($balanced_parens{0,1})\s*};
 349 our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
 350
 351 sub deparenthesize {
 352         my ($string) = @_;
 353         return "" if (!defined($string));
 354         $string =~ s@^\s*\(\s*@@g;
 355         $string =~ s@\s*\)\s*$@@g;
 356         $string =~ s@\s+@ @g;
 357         return $string;
 358 }
 359
 360 $chk_signoff = 0 if ($file);
 361
 362 my @rawlines = ();
 363 my @lines = ();
 364 my $vname;
 365 for my $filename (@ARGV) {
 366         my $FILE;
 367         if ($file) {
 368                 open($FILE, '-|', "diff -u /dev/null $filename") ||
 369                         die "$P: $filename: diff failed - $!\n";
 370         } elsif ($filename eq '-') {
 371                 open($FILE, '<&STDIN');
 372         } else {
 373                 open($FILE, '<', "$filename") ||
 374                         die "$P: $filename: open failed - $!\n";
 375         }
 376         if ($filename eq '-') {
 377                 $vname = 'Your patch';
 378         } else {
 379                 $vname = $filename;
 380         }
 381         while (<$FILE>) {
 382                 chomp;
 383                 push(@rawlines, $_);
 384         }
 385         close($FILE);
 386         if (!process($filename)) {
 387                 $exit = 1;
 388         }
 389         @rawlines = ();
 390         @lines = ();
 391 }
 392
 393 exit($exit);
 394
 395 sub top_of_kernel_tree {
 396         my ($root) = @_;
 397
 398         my @tree_check = (
 399                 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
 400                 "README", "Documentation", "arch", "include", "drivers",
 401                 "fs", "init", "ipc", "kernel", "lib", "scripts",
 402         );
 403
 404         foreach my $check (@tree_check) {
 405                 if (! -e $root . '/' . $check) {
 406                         return 0;
 407                 }
 408         }
 409         return 1;
 410 }
 411
 412 sub parse_email {
 413         my ($formatted_email) = @_;
 414
 415         my $name = "";
 416         my $address = "";
 417         my $comment = "";
 418
 419         if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
 420                 $name = $1;
 421                 $address = $2;
 422                 $comment = $3 if defined $3;
 423         } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
 424                 $address = $1;
 425                 $comment = $2 if defined $2;
 426         } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
 427                 $address = $1;
 428                 $comment = $2 if defined $2;
 429                 $formatted_email =~ s/$address.*$//;
 430                 $name = $formatted_email;
 431                 $name =~ s/^\s+|\s+$//g;
 432                 $name =~ s/^\"|\"$//g;
 433                 # If there's a name left after stripping spaces and
 434                 # leading quotes, and the address doesn't have both
 435                 # leading and trailing angle brackets, the address
 436                 # is invalid. ie:
 437                 #   "joe smith joe@smith.com" bad
 438                 #   "joe smith <joe@smith.com" bad
 439                 if ($name ne "" && $address !~ /^<[^>]+>$/) {
 440                         $name = "";
 441                         $address = "";
 442                         $comment = "";
 443                 }
 444         }
 445
 446         $name =~ s/^\s+|\s+$//g;
 447         $name =~ s/^\"|\"$//g;
 448         $address =~ s/^\s+|\s+$//g;
 449         $address =~ s/^\<|\>$//g;
 450
 451         if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
 452                 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
 453                 $name = "\"$name\"";
 454         }
 455
 456         return ($name, $address, $comment);
 457 }
 458
 459 sub format_email {
 460         my ($name, $address) = @_;
 461
 462         my $formatted_email;
 463
 464         $name =~ s/^\s+|\s+$//g;
 465         $name =~ s/^\"|\"$//g;
 466         $address =~ s/^\s+|\s+$//g;
 467
 468         if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
 469                 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
 470                 $name = "\"$name\"";
 471         }
 472
 473         if ("$name" eq "") {
 474                 $formatted_email = "$address";
 475         } else {
 476                 $formatted_email = "$name <$address>";
 477         }
 478
 479         return $formatted_email;
 480 }
 481
 482 sub which_conf {
 483         my ($conf) = @_;
 484
 485         foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
 486                 if (-e "$path/$conf") {
 487                         return "$path/$conf";
 488                 }
 489         }
 490
 491         return "";
 492 }
 493
 494 sub expand_tabs {
 495         my ($str) = @_;
 496
 497         my $res = '';
 498         my $n = 0;
 499         for my $c (split(//, $str)) {
 500                 if ($c eq "\t") {
 501                         $res .= ' ';
 502                         $n++;
 503                         for (; ($n % 8) != 0; $n++) {
 504                                 $res .= ' ';
 505                         }
 506                         next;
 507                 }
 508                 $res .= $c;
 509                 $n++;
 510         }
 511
 512         return $res;
 513 }
 514 sub copy_spacing {
 515         (my $res = shift) =~ tr/\t/ /c;
 516         return $res;
 517 }
 518
 519 sub line_stats {
 520         my ($line) = @_;
 521
 522         # Drop the diff line leader and expand tabs
 523         $line =~ s/^.//;
 524         $line = expand_tabs($line);
 525
 526         # Pick the indent from the front of the line.
 527         my ($white) = ($line =~ /^(\s*)/);
 528
 529         return (length($line), length($white));
 530 }
 531
 532 my $sanitise_quote = '';
 533
 534 sub sanitise_line_reset {
 535         my ($in_comment) = @_;
 536
 537         if ($in_comment) {
 538                 $sanitise_quote = '*/';
 539         } else {
 540                 $sanitise_quote = '';
 541         }
 542 }
 543 sub sanitise_line {
 544         my ($line) = @_;
 545
 546         my $res = '';
 547         my $l = '';
 548
 549         my $qlen = 0;
 550         my $off = 0;
 551         my $c;
 552
 553         # Always copy over the diff marker.
 554         $res = substr($line, 0, 1);
 555
 556         for ($off = 1; $off < length($line); $off++) {
 557                 $c = substr($line, $off, 1);
 558
 559                 # Comments we are wacking completly including the begin
 560                 # and end, all to $;.
 561                 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
 562                         $sanitise_quote = '*/';
 563
 564                         substr($res, $off, 2, "$;$;");
 565                         $off++;
 566                         next;
 567                 }
 568                 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
 569                         $sanitise_quote = '';
 570                         substr($res, $off, 2, "$;$;");
 571                         $off++;
 572                         next;
 573                 }
 574                 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
 575                         $sanitise_quote = '//';
 576
 577                         substr($res, $off, 2, $sanitise_quote);
 578                         $off++;
 579                         next;
 580                 }
 581
 582                 # A \ in a string means ignore the next character.
 583                 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
 584                     $c eq "\\") {
 585                         substr($res, $off, 2, 'XX');
 586                         $off++;
 587                         next;
 588                 }
 589                 # Regular quotes.
 590                 if ($c eq "'" || $c eq '"') {
 591                         if ($sanitise_quote eq '') {
 592                                 $sanitise_quote = $c;
 593
 594                                 substr($res, $off, 1, $c);
 595                                 next;
 596                         } elsif ($sanitise_quote eq $c) {
 597                                 $sanitise_quote = '';
 598                         }
 599                 }
 600
 601                 #print "c<$c> SQ<$sanitise_quote>\n";
 602                 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
 603                         substr($res, $off, 1, $;);
 604                 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
 605                         substr($res, $off, 1, $;);
 606                 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
 607                         substr($res, $off, 1, 'X');
 608                 } else {
 609                         substr($res, $off, 1, $c);
 610                 }
 611         }
 612
 613         if ($sanitise_quote eq '//') {
 614                 $sanitise_quote = '';
 615         }
 616
 617         # The pathname on a #include may be surrounded by '<' and '>'.
 618         if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
 619                 my $clean = 'X' x length($1);
 620                 $res =~ s@\<.*\>@<$clean>@;
 621
 622         # The whole of a #error is a string.
 623         } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
 624                 my $clean = 'X' x length($1);
 625                 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
 626         }
 627
 628         return $res;
 629 }
 630
 631 sub get_quoted_string {
 632         my ($line, $rawline) = @_;
 633
 634         return "" if ($line !~ m/(\"[X]+\")/g);
 635         return substr($rawline, $-[0], $+[0] - $-[0]);
 636 }
 637
 638 sub ctx_statement_block {
 639         my ($linenr, $remain, $off) = @_;
 640         my $line = $linenr - 1;
 641         my $blk = '';
 642         my $soff = $off;
 643         my $coff = $off - 1;
 644         my $coff_set = 0;
 645
 646         my $loff = 0;
 647
 648         my $type = '';
 649         my $level = 0;
 650         my @stack = ();
 651         my $p;
 652         my $c;
 653         my $len = 0;
 654
 655         my $remainder;
 656         while (1) {
 657                 @stack = (['', 0]) if ($#stack == -1);
 658
 659                 #warn "CSB: blk<$blk> remain<$remain>\n";
 660                 # If we are about to drop off the end, pull in more
 661                 # context.
 662                 if ($off >= $len) {
 663                         for (; $remain > 0; $line++) {
 664                                 last if (!defined $lines[$line]);
 665                                 next if ($lines[$line] =~ /^-/);
 666                                 $remain--;
 667                                 $loff = $len;
 668                                 $blk .= $lines[$line] . "\n";
 669                                 $len = length($blk);
 670                                 $line++;
 671                                 last;
 672                         }
 673                         # Bail if there is no further context.
 674                         #warn "CSB: blk<$blk> off<$off> len<$len>\n";
 675                         if ($off >= $len) {
 676                                 last;
 677                         }
 678                         if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
 679                                 $level++;
 680                                 $type = '#';
 681                         }
 682                 }
 683                 $p = $c;
 684                 $c = substr($blk, $off, 1);
 685                 $remainder = substr($blk, $off);
 686
 687                 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
 688
 689                 # Handle nested #if/#else.
 690                 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
 691                         push(@stack, [ $type, $level ]);
 692                 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
 693                         ($type, $level) = @{$stack[$#stack - 1]};
 694                 } elsif ($remainder =~ /^#\s*endif\b/) {
 695                         ($type, $level) = @{pop(@stack)};
 696                 }
 697
 698                 # Statement ends at the ';' or a close '}' at the
 699                 # outermost level.
 700                 if ($level == 0 && $c eq ';') {
 701                         last;
 702                 }
 703
 704                 # An else is really a conditional as long as its not else if
 705                 if ($level == 0 && $coff_set == 0 &&
 706                                 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
 707                                 $remainder =~ /^(else)(?:\s|{)/ &&
 708                                 $remainder !~ /^else\s+if\b/) {
 709                         $coff = $off + length($1) - 1;
 710                         $coff_set = 1;
 711                         #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
 712                         #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
 713                 }
 714
 715                 if (($type eq '' || $type eq '(') && $c eq '(') {
 716                         $level++;
 717                         $type = '(';
 718                 }
 719                 if ($type eq '(' && $c eq ')') {
 720                         $level--;
 721                         $type = ($level != 0)? '(' : '';
 722
 723                         if ($level == 0 && $coff < $soff) {
 724                                 $coff = $off;
 725                                 $coff_set = 1;
 726                                 #warn "CSB: mark coff<$coff>\n";
 727                         }
 728                 }
 729                 if (($type eq '' || $type eq '{') && $c eq '{') {
 730                         $level++;
 731                         $type = '{';
 732                 }
 733                 if ($type eq '{' && $c eq '}') {
 734                         $level--;
 735                         $type = ($level != 0)? '{' : '';
 736
 737                         if ($level == 0) {
 738                                 if (substr($blk, $off + 1, 1) eq ';') {
 739                                         $off++;
 740                                 }
 741                                 last;
 742                         }
 743                 }
 744                 # Preprocessor commands end at the newline unless escaped.
 745                 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
 746                         $level--;
 747                         $type = '';
 748                         $off++;
 749                         last;
 750                 }
 751                 $off++;
 752         }
 753         # We are truly at the end, so shuffle to the next line.
 754         if ($off == $len) {
 755                 $loff = $len + 1;
 756                 $line++;
 757                 $remain--;
 758         }
 759
 760         my $statement = substr($blk, $soff, $off - $soff + 1);
 761         my $condition = substr($blk, $soff, $coff - $soff + 1);
 762
 763         #warn "STATEMENT<$statement>\n";
 764         #warn "CONDITION<$condition>\n";
 765
 766         #print "coff<$coff> soff<$off> loff<$loff>\n";
 767
 768         return ($statement, $condition,
 769                         $line, $remain + 1, $off - $loff + 1, $level);
 770 }
 771
 772 sub statement_lines {
 773         my ($stmt) = @_;
 774
 775         # Strip the diff line prefixes and rip blank lines at start and end.
 776         $stmt =~ s/(^|\n)./$1/g;
 777         $stmt =~ s/^\s*//;
 778         $stmt =~ s/\s*$//;
 779
 780         my @stmt_lines = ($stmt =~ /\n/g);
 781
 782         return $#stmt_lines + 2;
 783 }
 784
 785 sub statement_rawlines {
 786         my ($stmt) = @_;
 787
 788         my @stmt_lines = ($stmt =~ /\n/g);
 789
 790         return $#stmt_lines + 2;
 791 }
 792
 793 sub statement_block_size {
 794         my ($stmt) = @_;
 795
 796         $stmt =~ s/(^|\n)./$1/g;
 797         $stmt =~ s/^\s*{//;
 798         $stmt =~ s/}\s*$//;
 799         $stmt =~ s/^\s*//;
 800         $stmt =~ s/\s*$//;
 801
 802         my @stmt_lines = ($stmt =~ /\n/g);
 803         my @stmt_statements = ($stmt =~ /;/g);
 804
 805         my $stmt_lines = $#stmt_lines + 2;
 806         my $stmt_statements = $#stmt_statements + 1;
 807
 808         if ($stmt_lines > $stmt_statements) {
 809                 return $stmt_lines;
 810         } else {
 811                 return $stmt_statements;
 812         }
 813 }
 814
 815 sub ctx_statement_full {
 816         my ($linenr, $remain, $off) = @_;
 817         my ($statement, $condition, $level);
 818
 819         my (@chunks);
 820
 821         # Grab the first conditional/block pair.
 822         ($statement, $condition, $linenr, $remain, $off, $level) =
 823                                 ctx_statement_block($linenr, $remain, $off);
 824         #print "F: c<$condition> s<$statement> remain<$remain>\n";
 825         push(@chunks, [ $condition, $statement ]);
 826         if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
 827                 return ($level, $linenr, @chunks);
 828         }
 829
 830         # Pull in the following conditional/block pairs and see if they
 831         # could continue the statement.
 832         for (;;) {
 833                 ($statement, $condition, $linenr, $remain, $off, $level) =
 834                                 ctx_statement_block($linenr, $remain, $off);
 835                 #print "C: c<$condition> s<$statement> remain<$remain>\n";
 836                 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
 837                 #print "C: push\n";
 838                 push(@chunks, [ $condition, $statement ]);
 839         }
 840
 841         return ($level, $linenr, @chunks);
 842 }
 843
 844 sub ctx_block_get {
 845         my ($linenr, $remain, $outer, $open, $close, $off) = @_;
 846         my $line;
 847         my $start = $linenr - 1;
 848         my $blk = '';
 849         my @o;
 850         my @c;
 851         my @res = ();
 852
 853         my $level = 0;
 854         my @stack = ($level);
 855         for ($line = $start; $remain > 0; $line++) {
 856                 next if ($rawlines[$line] =~ /^-/);
 857                 $remain--;
 858
 859                 $blk .= $rawlines[$line];
 860
 861                 # Handle nested #if/#else.
 862                 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
 863                         push(@stack, $level);
 864                 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
 865                         $level = $stack[$#stack - 1];
 866                 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
 867                         $level = pop(@stack);
 868                 }
 869
 870                 foreach my $c (split(//, $lines[$line])) {
 871                         ##print "C<$c>L<$level><$open$close>O<$off>\n";
 872                         if ($off > 0) {
 873                                 $off--;
 874                                 next;
 875                         }
 876
 877                         if ($c eq $close && $level > 0) {
 878                                 $level--;
 879                                 last if ($level == 0);
 880                         } elsif ($c eq $open) {
 881                                 $level++;
 882                         }
 883                 }
 884
 885                 if (!$outer || $level <= 1) {
 886                         push(@res, $rawlines[$line]);
 887                 }
 888
 889                 last if ($level == 0);
 890         }
 891
 892         return ($level, @res);
 893 }
 894 sub ctx_block_outer {
 895         my ($linenr, $remain) = @_;
 896
 897         my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
 898         return @r;
 899 }
 900 sub ctx_block {
 901         my ($linenr, $remain) = @_;
 902
 903         my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
 904         return @r;
 905 }
 906 sub ctx_statement {
 907         my ($linenr, $remain, $off) = @_;
 908
 909         my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
 910         return @r;
 911 }
 912 sub ctx_block_level {
 913         my ($linenr, $remain) = @_;
 914
 915         return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
 916 }
 917 sub ctx_statement_level {
 918         my ($linenr, $remain, $off) = @_;
 919
 920         return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
 921 }
 922
 923 sub ctx_locate_comment {
 924         my ($first_line, $end_line) = @_;
 925
 926         # Catch a comment on the end of the line itself.
 927         my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
 928         return $current_comment if (defined $current_comment);
 929
 930         # Look through the context and try and figure out if there is a
 931         # comment.
 932         my $in_comment = 0;
 933         $current_comment = '';
 934         for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
 935                 my $line = $rawlines[$linenr - 1];
 936                 #warn "           $line\n";
 937                 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
 938                         $in_comment = 1;
 939                 }
 940                 if ($line =~ m@/\*@) {
 941                         $in_comment = 1;
 942                 }
 943                 if (!$in_comment && $current_comment ne '') {
 944                         $current_comment = '';
 945                 }
 946                 $current_comment .= $line . "\n" if ($in_comment);
 947                 if ($line =~ m@\*/@) {
 948                         $in_comment = 0;
 949                 }
 950         }
 951
 952         chomp($current_comment);
 953         return($current_comment);
 954 }
 955 sub ctx_has_comment {
 956         my ($first_line, $end_line) = @_;
 957         my $cmt = ctx_locate_comment($first_line, $end_line);
 958
 959         ##print "LINE: $rawlines[$end_line - 1 ]\n";
 960         ##print "CMMT: $cmt\n";
 961
 962         return ($cmt ne '');
 963 }
 964
 965 sub raw_line {
 966         my ($linenr, $cnt) = @_;
 967
 968         my $offset = $linenr - 1;
 969         $cnt++;
 970
 971         my $line;
 972         while ($cnt) {
 973                 $line = $rawlines[$offset++];
 974                 next if (defined($line) && $line =~ /^-/);
 975                 $cnt--;
 976         }
 977
 978         return $line;
 979 }
 980
 981 sub cat_vet {
 982         my ($vet) = @_;
 983         my ($res, $coded);
 984
 985         $res = '';
 986         while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
 987                 $res .= $1;
 988                 if ($2 ne '') {
 989                         $coded = sprintf("^%c", unpack('C', $2) + 64);
 990                         $res .= $coded;
 991                 }
 992         }
 993         $res =~ s/$/\$/;
 994
 995         return $res;
 996 }
 997
 998 my $av_preprocessor = 0;
 999 my $av_pending;
1000 my @av_paren_type;
1001 my $av_pend_colon;
1002
1003 sub annotate_reset {
1004         $av_preprocessor = 0;
1005         $av_pending = '_';
1006         @av_paren_type = ('E');
1007         $av_pend_colon = 'O';
1008 }
1009
1010 sub annotate_values {
1011         my ($stream, $type) = @_;
1012
1013         my $res;
1014         my $var = '_' x length($stream);
1015         my $cur = $stream;
1016
1017         print "$stream\n" if ($dbg_values > 1);
1018
1019         while (length($cur)) {
1020                 @av_paren_type = ('E') if ($#av_paren_type < 0);
1021                 print " <" . join('', @av_paren_type) .
1022                                 "> <$type> <$av_pending>" if ($dbg_values > 1);
1023                 if ($cur =~ /^(\s+)/o) {
1024                         print "WS($1)\n" if ($dbg_values > 1);
1025                         if ($1 =~ /\n/ && $av_preprocessor) {
1026                                 $type = pop(@av_paren_type);
1027                                 $av_preprocessor = 0;
1028                         }
1029
1030                 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1031                         print "CAST($1)\n" if ($dbg_values > 1);
1032                         push(@av_paren_type, $type);
1033                         $type = 'c';
1034
1035                 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1036                         print "DECLARE($1)\n" if ($dbg_values > 1);
1037                         $type = 'T';
1038
1039                 } elsif ($cur =~ /^($Modifier)\s*/) {
1040                         print "MODIFIER($1)\n" if ($dbg_values > 1);
1041                         $type = 'T';
1042
1043                 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1044                         print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1045                         $av_preprocessor = 1;
1046                         push(@av_paren_type, $type);
1047                         if ($2 ne '') {
1048                                 $av_pending = 'N';
1049                         }
1050                         $type = 'E';
1051
1052                 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1053                         print "UNDEF($1)\n" if ($dbg_values > 1);
1054                         $av_preprocessor = 1;
1055                         push(@av_paren_type, $type);
1056
1057                 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1058                         print "PRE_START($1)\n" if ($dbg_values > 1);
1059                         $av_preprocessor = 1;
1060
1061                         push(@av_paren_type, $type);
1062                         push(@av_paren_type, $type);
1063                         $type = 'E';
1064
1065                 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1066                         print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1067                         $av_preprocessor = 1;
1068
1069                         push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1070
1071                         $type = 'E';
1072
1073                 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1074                         print "PRE_END($1)\n" if ($dbg_values > 1);
1075
1076                         $av_preprocessor = 1;
1077
1078                         # Assume all arms of the conditional end as this
1079                         # one does, and continue as if the #endif was not here.
1080                         pop(@av_paren_type);
1081                         push(@av_paren_type, $type);
1082                         $type = 'E';
1083
1084                 } elsif ($cur =~ /^(\\\n)/o) {
1085                         print "PRECONT($1)\n" if ($dbg_values > 1);
1086
1087                 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1088                         print "ATTR($1)\n" if ($dbg_values > 1);
1089                         $av_pending = $type;
1090                         $type = 'N';
1091
1092                 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1093                         print "SIZEOF($1)\n" if ($dbg_values > 1);
1094                         if (defined $2) {
1095                                 $av_pending = 'V';
1096                         }
1097                         $type = 'N';
1098
1099                 } elsif ($cur =~ /^(if|while|for)\b/o) {
1100                         print "COND($1)\n" if ($dbg_values > 1);
1101                         $av_pending = 'E';
1102                         $type = 'N';
1103
1104                 } elsif ($cur =~/^(case)/o) {
1105                         print "CASE($1)\n" if ($dbg_values > 1);
1106                         $av_pend_colon = 'C';
1107                         $type = 'N';
1108
1109                 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1110                         print "KEYWORD($1)\n" if ($dbg_values > 1);
1111                         $type = 'N';
1112
1113                 } elsif ($cur =~ /^(\()/o) {
1114                         print "PAREN('$1')\n" if ($dbg_values > 1);
1115                         push(@av_paren_type, $av_pending);
1116                         $av_pending = '_';
1117                         $type = 'N';
1118
1119                 } elsif ($cur =~ /^(\))/o) {
1120                         my $new_type = pop(@av_paren_type);
1121                         if ($new_type ne '_') {
1122                                 $type = $new_type;
1123                                 print "PAREN('$1') -> $type\n"
1124                                                         if ($dbg_values > 1);
1125                         } else {
1126                                 print "PAREN('$1')\n" if ($dbg_values > 1);
1127                         }
1128
1129                 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1130                         print "FUNC($1)\n" if ($dbg_values > 1);
1131                         $type = 'V';
1132                         $av_pending = 'V';
1133
1134                 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1135                         if (defined $2 && $type eq 'C' || $type eq 'T') {
1136                                 $av_pend_colon = 'B';
1137                         } elsif ($type eq 'E') {
1138                                 $av_pend_colon = 'L';
1139                         }
1140                         print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1141                         $type = 'V';
1142
1143                 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1144                         print "IDENT($1)\n" if ($dbg_values > 1);
1145                         $type = 'V';
1146
1147                 } elsif ($cur =~ /^($Assignment)/o) {
1148                         print "ASSIGN($1)\n" if ($dbg_values > 1);
1149                         $type = 'N';
1150
1151                 } elsif ($cur =~/^(;|{|})/) {
1152                         print "END($1)\n" if ($dbg_values > 1);
1153                         $type = 'E';
1154                         $av_pend_colon = 'O';
1155
1156                 } elsif ($cur =~/^(,)/) {
1157                         print "COMMA($1)\n" if ($dbg_values > 1);
1158                         $type = 'C';
1159
1160                 } elsif ($cur =~ /^(\?)/o) {
1161                         print "QUESTION($1)\n" if ($dbg_values > 1);
1162                         $type = 'N';
1163
1164                 } elsif ($cur =~ /^(:)/o) {
1165                         print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1166
1167                         substr($var, length($res), 1, $av_pend_colon);
1168                         if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1169                                 $type = 'E';
1170                         } else {
1171                                 $type = 'N';
1172                         }
1173                         $av_pend_colon = 'O';
1174
1175                 } elsif ($cur =~ /^(\[)/o) {
1176                         print "CLOSE($1)\n" if ($dbg_values > 1);
1177                         $type = 'N';
1178
1179                 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1180                         my $variant;
1181
1182                         print "OPV($1)\n" if ($dbg_values > 1);
1183                         if ($type eq 'V') {
1184                                 $variant = 'B';
1185                         } else {
1186                                 $variant = 'U';
1187                         }
1188
1189                         substr($var, length($res), 1, $variant);
1190                         $type = 'N';
1191
1192                 } elsif ($cur =~ /^($Operators)/o) {
1193                         print "OP($1)\n" if ($dbg_values > 1);
1194                         if ($1 ne '++' && $1 ne '--') {
1195                                 $type = 'N';
1196                         }
1197
1198                 } elsif ($cur =~ /(^.)/o) {
1199                         print "C($1)\n" if ($dbg_values > 1);
1200                 }
1201                 if (defined $1) {
1202                         $cur = substr($cur, length($1));
1203                         $res .= $type x length($1);
1204                 }
1205         }
1206
1207         return ($res, $var);
1208 }
1209
1210 sub possible {
1211         my ($possible, $line) = @_;
1212         my $notPermitted = qr{(?:
1213                 ^(?:
1214                         $Modifier|
1215                         $Storage|
1216                         $Type|
1217                         DEFINE_\S+
1218                 )$|
1219                 ^(?:
1220                         goto|
1221                         return|
1222                         case|
1223                         else|
1224                         asm|__asm__|
1225                         do|
1226                         \#|
1227                         \#\#|
1228                 )(?:\s|$)|
1229                 ^(?:typedef|struct|enum)\b
1230             )}x;
1231         warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1232         if ($possible !~ $notPermitted) {
1233                 # Check for modifiers.
1234                 $possible =~ s/\s*$Storage\s*//g;
1235                 $possible =~ s/\s*$Sparse\s*//g;
1236                 if ($possible =~ /^\s*$/) {
1237
1238                 } elsif ($possible =~ /\s/) {
1239                         $possible =~ s/\s*$Type\s*//g;
1240                         for my $modifier (split(' ', $possible)) {
1241                                 if ($modifier !~ $notPermitted) {
1242                                         warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1243                                         push(@modifierList, $modifier);
1244                                 }
1245                         }
1246
1247                 } else {
1248                         warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1249                         push(@typeList, $possible);
1250                 }
1251                 build_types();
1252         } else {
1253                 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1254         }
1255 }
1256
1257 my $prefix = '';
1258
1259 sub show_type {
1260        return !defined $ignore_type{$_[0]};
1261 }
1262
1263 sub report {
1264         if (!show_type($_[1]) ||
1265             (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) {
1266                 return 0;
1267         }
1268         my $line;
1269         if ($show_types) {
1270                 $line = "$prefix$_[0]:$_[1]: $_[2]\n";
1271         } else {
1272                 $line = "$prefix$_[0]: $_[2]\n";
1273         }
1274         $line = (split('\n', $line))[0] . "\n" if ($terse);
1275
1276         push(our @report, $line);
1277
1278         return 1;
1279 }
1280 sub report_dump {
1281         our @report;
1282 }
1283
1284 sub ERROR {
1285         if (report("ERROR", $_[0], $_[1])) {
1286                 our $clean = 0;
1287                 our $cnt_error++;
1288         }
1289 }
1290 sub WARN {
1291         if (report("WARNING", $_[0], $_[1])) {
1292                 our $clean = 0;
1293                 our $cnt_warn++;
1294         }
1295 }
1296 sub CHK {
1297         if ($check && report("CHECK", $_[0], $_[1])) {
1298                 our $clean = 0;
1299                 our $cnt_chk++;
1300         }
1301 }
1302
1303 sub check_absolute_file {
1304         my ($absolute, $herecurr) = @_;
1305         my $file = $absolute;
1306
1307         ##print "absolute<$absolute>\n";
1308
1309         # See if any suffix of this path is a path within the tree.
1310         while ($file =~ s@^[^/]*/@@) {
1311                 if (-f "$root/$file") {
1312                         ##print "file<$file>\n";
1313                         last;
1314                 }
1315         }
1316         if (! -f _)  {
1317                 return 0;
1318         }
1319
1320         # It is, so see if the prefix is acceptable.
1321         my $prefix = $absolute;
1322         substr($prefix, -length($file)) = '';
1323
1324         ##print "prefix<$prefix>\n";
1325         if ($prefix ne ".../") {
1326                 WARN("USE_RELATIVE_PATH",
1327                      "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1328         }
1329 }
1330
1331 sub pos_last_openparen {
1332         my ($line) = @_;
1333
1334         my $pos = 0;
1335
1336         my $opens = $line =~ tr/\(/\(/;
1337         my $closes = $line =~ tr/\)/\)/;
1338
1339         my $last_openparen = 0;
1340
1341         if (($opens == 0) || ($closes >= $opens)) {
1342                 return -1;
1343         }
1344
1345         my $len = length($line);
1346
1347         for ($pos = 0; $pos < $len; $pos++) {
1348                 my $string = substr($line, $pos);
1349                 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1350                         $pos += length($1) - 1;
1351                 } elsif (substr($line, $pos, 1) eq '(') {
1352                         $last_openparen = $pos;
1353                 } elsif (index($string, '(') == -1) {
1354                         last;
1355                 }
1356         }
1357
1358         return $last_openparen + 1;
1359 }
1360
1361 sub process {
1362         my $filename = shift;
1363
1364         my $linenr=0;
1365         my $prevline="";
1366         my $prevrawline="";
1367         my $stashline="";
1368         my $stashrawline="";
1369
1370         my $length;
1371         my $indent;
1372         my $previndent=0;
1373         my $stashindent=0;
1374
1375         our $clean = 1;
1376         my $signoff = 0;
1377         my $is_patch = 0;
1378
1379         my $in_header_lines = 1;
1380         my $in_commit_log = 0;          #Scanning lines before patch
1381
1382         my $non_utf8_charset = 0;
1383
1384         our @report = ();
1385         our $cnt_lines = 0;
1386         our $cnt_error = 0;
1387         our $cnt_warn = 0;
1388         our $cnt_chk = 0;
1389
1390         # Trace the real file/line as we go.
1391         my $realfile = '';
1392         my $realline = 0;
1393         my $realcnt = 0;
1394         my $here = '';
1395         my $in_comment = 0;
1396         my $comment_edge = 0;
1397         my $first_line = 0;
1398         my $p1_prefix = '';
1399
1400         my $prev_values = 'E';
1401
1402         # suppression flags
1403         my %suppress_ifbraces;
1404         my %suppress_whiletrailers;
1405         my %suppress_export;
1406         my $suppress_statement = 0;
1407
1408         my %camelcase = ();
1409
1410         # Pre-scan the patch sanitizing the lines.
1411         # Pre-scan the patch looking for any __setup documentation.
1412         #
1413         my @setup_docs = ();
1414         my $setup_docs = 0;
1415
1416         sanitise_line_reset();
1417         my $line;
1418         foreach my $rawline (@rawlines) {
1419                 $linenr++;
1420                 $line = $rawline;
1421
1422                 if ($rawline=~/^\+\+\+\s+(\S+)/) {
1423                         $setup_docs = 0;
1424                         if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1425                                 $setup_docs = 1;
1426                         }
1427                         #next;
1428                 }
1429                 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1430                         $realline=$1-1;
1431                         if (defined $2) {
1432                                 $realcnt=$3+1;
1433                         } else {
1434                                 $realcnt=1+1;
1435                         }
1436                         $in_comment = 0;
1437
1438                         # Guestimate if this is a continuing comment.  Run
1439                         # the context looking for a comment "edge".  If this
1440                         # edge is a close comment then we must be in a comment
1441                         # at context start.
1442                         my $edge;
1443                         my $cnt = $realcnt;
1444                         for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1445                                 next if (defined $rawlines[$ln - 1] &&
1446                                          $rawlines[$ln - 1] =~ /^-/);
1447                                 $cnt--;
1448                                 #print "RAW<$rawlines[$ln - 1]>\n";
1449                                 last if (!defined $rawlines[$ln - 1]);
1450                                 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1451                                     $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1452                                         ($edge) = $1;
1453                                         last;
1454                                 }
1455                         }
1456                         if (defined $edge && $edge eq '*/') {
1457                                 $in_comment = 1;
1458                         }
1459
1460                         # Guestimate if this is a continuing comment.  If this
1461                         # is the start of a diff block and this line starts
1462                         # ' *' then it is very likely a comment.
1463                         if (!defined $edge &&
1464                             $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1465                         {
1466                                 $in_comment = 1;
1467                         }
1468
1469                         ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1470                         sanitise_line_reset($in_comment);
1471
1472                 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1473                         # Standardise the strings and chars within the input to
1474                         # simplify matching -- only bother with positive lines.
1475                         $line = sanitise_line($rawline);
1476                 }
1477                 push(@lines, $line);
1478
1479                 if ($realcnt > 1) {
1480                         $realcnt-- if ($line =~ /^(?:\+| |$)/);
1481                 } else {
1482                         $realcnt = 0;
1483                 }
1484
1485                 #print "==>$rawline\n";
1486                 #print "-->$line\n";
1487
1488                 if ($setup_docs && $line =~ /^\+/) {
1489                         push(@setup_docs, $line);
1490                 }
1491         }
1492
1493         $prefix = '';
1494
1495         $realcnt = 0;
1496         $linenr = 0;
1497         foreach my $line (@lines) {
1498                 $linenr++;
1499
1500                 my $rawline = $rawlines[$linenr - 1];
1501
1502 #extract the line range in the file after the patch is applied
1503                 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1504                         $is_patch = 1;
1505                         $first_line = $linenr + 1;
1506                         $realline=$1-1;
1507                         if (defined $2) {
1508                                 $realcnt=$3+1;
1509                         } else {
1510                                 $realcnt=1+1;
1511                         }
1512                         annotate_reset();
1513                         $prev_values = 'E';
1514
1515                         %suppress_ifbraces = ();
1516                         %suppress_whiletrailers = ();
1517                         %suppress_export = ();
1518                         $suppress_statement = 0;
1519                         next;
1520
1521 # track the line number as we move through the hunk, note that
1522 # new versions of GNU diff omit the leading space on completely
1523 # blank context lines so we need to count that too.
1524                 } elsif ($line =~ /^( |\+|$)/) {
1525                         $realline++;
1526                         $realcnt-- if ($realcnt != 0);
1527
1528                         # Measure the line length and indent.
1529                         ($length, $indent) = line_stats($rawline);
1530
1531                         # Track the previous line.
1532                         ($prevline, $stashline) = ($stashline, $line);
1533                         ($previndent, $stashindent) = ($stashindent, $indent);
1534                         ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1535
1536                         #warn "line<$line>\n";
1537
1538                 } elsif ($realcnt == 1) {
1539                         $realcnt--;
1540                 }
1541
1542                 my $hunk_line = ($realcnt != 0);
1543
1544 #make up the handle for any error we report on this line
1545                 $prefix = "$filename:$realline: " if ($emacs && $file);
1546                 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1547
1548                 $here = "#$linenr: " if (!$file);
1549                 $here = "#$realline: " if ($file);
1550
1551                 # extract the filename as it passes
1552                 if ($line =~ /^diff --git.*?(\S+)$/) {
1553                         $realfile = $1;
1554                         $realfile =~ s@^([^/]*)/@@;
1555                         $in_commit_log = 0;
1556                 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
1557                         $realfile = $1;
1558                         $realfile =~ s@^([^/]*)/@@;
1559                         $in_commit_log = 0;
1560
1561                         $p1_prefix = $1;
1562                         if (!$file && $tree && $p1_prefix ne '' &&
1563                             -e "$root/$p1_prefix") {
1564                                 WARN("PATCH_PREFIX",
1565                                      "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1566                         }
1567
1568                         if ($realfile =~ m@^include/asm/@) {
1569                                 ERROR("MODIFIED_INCLUDE_ASM",
1570                                       "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1571                         }
1572                         next;
1573                 }
1574
1575                 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
1576
1577                 my $hereline = "$here\n$rawline\n";
1578                 my $herecurr = "$here\n$rawline\n";
1579                 my $hereprev = "$here\n$prevrawline\n$rawline\n";
1580
1581                 $cnt_lines++ if ($realcnt != 0);
1582
1583 # Check for incorrect file permissions
1584                 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1585                         my $permhere = $here . "FILE: $realfile\n";
1586                         if ($realfile !~ m@scripts/@ &&
1587                             $realfile !~ /\.(py|pl|awk|sh)$/) {
1588                                 ERROR("EXECUTE_PERMISSIONS",
1589                                       "do not set execute permissions for source files\n" . $permhere);
1590                         }
1591                 }
1592
1593 # Check the patch for a signoff:
1594                 if ($line =~ /^\s*signed-off-by:/i) {
1595                         $signoff++;
1596                         $in_commit_log = 0;
1597                 }
1598
1599 # Check signature styles
1600                 if (!$in_header_lines &&
1601                     $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
1602                         my $space_before = $1;
1603                         my $sign_off = $2;
1604                         my $space_after = $3;
1605                         my $email = $4;
1606                         my $ucfirst_sign_off = ucfirst(lc($sign_off));
1607
1608                         if ($sign_off !~ /$signature_tags/) {
1609                                 WARN("BAD_SIGN_OFF",
1610                                      "Non-standard signature: $sign_off\n" . $herecurr);
1611                         }
1612                         if (defined $space_before && $space_before ne "") {
1613                                 WARN("BAD_SIGN_OFF",
1614                                      "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr);
1615                         }
1616                         if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
1617                                 WARN("BAD_SIGN_OFF",
1618                                      "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr);
1619                         }
1620                         if (!defined $space_after || $space_after ne " ") {
1621                                 WARN("BAD_SIGN_OFF",
1622                                      "Use a single space after $ucfirst_sign_off\n" . $herecurr);
1623                         }
1624
1625                         my ($email_name, $email_address, $comment) = parse_email($email);
1626                         my $suggested_email = format_email(($email_name, $email_address));
1627                         if ($suggested_email eq "") {
1628                                 ERROR("BAD_SIGN_OFF",
1629                                       "Unrecognized email address: '$email'\n" . $herecurr);
1630                         } else {
1631                                 my $dequoted = $suggested_email;
1632                                 $dequoted =~ s/^"//;
1633                                 $dequoted =~ s/" </ </;
1634                                 # Don't force email to have quotes
1635                                 # Allow just an angle bracketed address
1636                                 if ("$dequoted$comment" ne $email &&
1637                                     "<$email_address>$comment" ne $email &&
1638                                     "$suggested_email$comment" ne $email) {
1639                                         WARN("BAD_SIGN_OFF",
1640                                              "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
1641                                 }
1642                         }
1643                 }
1644
1645 # Check for wrappage within a valid hunk of the file
1646                 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1647                         ERROR("CORRUPTED_PATCH",
1648                               "patch seems to be corrupt (line wrapped?)\n" .
1649                                 $herecurr) if (!$emitted_corrupt++);
1650                 }
1651
1652 # Check for absolute kernel paths.
1653                 if ($tree) {
1654                         while ($line =~ m{(?:^|\s)(/\S*)}g) {
1655                                 my $file = $1;
1656
1657                                 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1658                                     check_absolute_file($1, $herecurr)) {
1659                                         #
1660                                 } else {
1661                                         check_absolute_file($file, $herecurr);
1662                                 }
1663                         }
1664                 }
1665
1666 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1667                 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1668                     $rawline !~ m/^$UTF8*$/) {
1669                         my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1670
1671                         my $blank = copy_spacing($rawline);
1672                         my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1673                         my $hereptr = "$hereline$ptr\n";
1674
1675                         CHK("INVALID_UTF8",
1676                             "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1677                 }
1678
1679 # Check if it's the start of a commit log
1680 # (not a header line and we haven't seen the patch filename)
1681                 if ($in_header_lines && $realfile =~ /^$/ &&
1682                     $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
1683                         $in_header_lines = 0;
1684                         $in_commit_log = 1;
1685                 }
1686
1687 # Check if there is UTF-8 in a commit log when a mail header has explicitly
1688 # declined it, i.e defined some charset where it is missing.
1689                 if ($in_header_lines &&
1690                     $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
1691                     $1 !~ /utf-8/i) {
1692                         $non_utf8_charset = 1;
1693                 }
1694
1695                 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
1696                     $rawline =~ /$NON_ASCII_UTF8/) {
1697                         WARN("UTF8_BEFORE_PATCH",
1698                             "8-bit UTF-8 used in possible commit log\n" . $herecurr);
1699                 }
1700
1701 # ignore non-hunk lines and lines being removed
1702                 next if (!$hunk_line || $line =~ /^-/);
1703
1704 #trailing whitespace
1705                 if ($line =~ /^\+.*\015/) {
1706                         my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1707                         ERROR("DOS_LINE_ENDINGS",
1708                               "DOS line endings\n" . $herevet);
1709
1710                 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1711                         my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1712                         ERROR("TRAILING_WHITESPACE",
1713                               "trailing whitespace\n" . $herevet);
1714                         $rpt_cleaners = 1;
1715                 }
1716
1717 # check for Kconfig help text having a real description
1718 # Only applies when adding the entry originally, after that we do not have
1719 # sufficient context to determine whether it is indeed long enough.
1720                 if ($realfile =~ /Kconfig/ &&
1721                     $line =~ /.\s*config\s+/) {
1722                         my $length = 0;
1723                         my $cnt = $realcnt;
1724                         my $ln = $linenr + 1;
1725                         my $f;
1726                         my $is_start = 0;
1727                         my $is_end = 0;
1728                         for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
1729                                 $f = $lines[$ln - 1];
1730                                 $cnt-- if ($lines[$ln - 1] !~ /^-/);
1731                                 $is_end = $lines[$ln - 1] =~ /^\+/;
1732
1733                                 next if ($f =~ /^-/);
1734
1735                                 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
1736                                         $is_start = 1;
1737                                 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
1738                                         $length = -1;
1739                                 }
1740
1741                                 $f =~ s/^.//;
1742                                 $f =~ s/#.*//;
1743                                 $f =~ s/^\s+//;
1744                                 next if ($f =~ /^$/);
1745                                 if ($f =~ /^\s*config\s/) {
1746                                         $is_end = 1;
1747                                         last;
1748                                 }
1749                                 $length++;
1750                         }
1751                         WARN("CONFIG_DESCRIPTION",
1752                              "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
1753                         #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
1754                 }
1755
1756 # discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
1757                 if ($realfile =~ /Kconfig/ &&
1758                     $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
1759                         WARN("CONFIG_EXPERIMENTAL",
1760                              "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
1761                 }
1762
1763                 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
1764                     ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
1765                         my $flag = $1;
1766                         my $replacement = {
1767                                 'EXTRA_AFLAGS' =>   'asflags-y',
1768                                 'EXTRA_CFLAGS' =>   'ccflags-y',
1769                                 'EXTRA_CPPFLAGS' => 'cppflags-y',
1770                                 'EXTRA_LDFLAGS' =>  'ldflags-y',
1771                         };
1772
1773                         WARN("DEPRECATED_VARIABLE",
1774                              "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
1775                 }
1776
1777 # check we are in a valid source file if not then ignore this hunk
1778                 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1779
1780 #line length limit
1781                 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
1782                     $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1783                     !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
1784                     $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
1785                     $length > $max_line_length)
1786                 {
1787                         WARN("LONG_LINE",
1788                              "line over $max_line_length characters\n" . $herecurr);
1789                 }
1790
1791 # Check for user-visible strings broken across lines, which breaks the ability
1792 # to grep for the string.  Limited to strings used as parameters (those
1793 # following an open parenthesis), which almost completely eliminates false
1794 # positives, as well as warning only once per parameter rather than once per
1795 # line of the string.  Make an exception when the previous string ends in a
1796 # newline (multiple lines in one string constant) or \n\t (common in inline
1797 # assembly to indent the instruction on the following line).
1798                 if ($line =~ /^\+\s*"/ &&
1799                     $prevline =~ /"\s*$/ &&
1800                     $prevline =~ /\(/ &&
1801                     $prevrawline !~ /\\n(?:\\t)*"\s*$/) {
1802                         WARN("SPLIT_STRING",
1803                              "quoted string split across lines\n" . $hereprev);
1804                 }
1805
1806 # check for spaces before a quoted newline
1807                 if ($rawline =~ /^.*\".*\s\\n/) {
1808                         WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
1809                              "unnecessary whitespace before a quoted newline\n" . $herecurr);
1810                 }
1811
1812 # check for adding lines without a newline.
1813                 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1814                         WARN("MISSING_EOF_NEWLINE",
1815                              "adding a line without newline at end of file\n" . $herecurr);
1816                 }
1817
1818 # Blackfin: use hi/lo macros
1819                 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
1820                         if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
1821                                 my $herevet = "$here\n" . cat_vet($line) . "\n";
1822                                 ERROR("LO_MACRO",
1823                                       "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
1824                         }
1825                         if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
1826                                 my $herevet = "$here\n" . cat_vet($line) . "\n";
1827                                 ERROR("HI_MACRO",
1828                                       "use the HI() macro, not (... >> 16)\n" . $herevet);
1829                         }
1830                 }
1831
1832 # check we are in a valid source file C or perl if not then ignore this hunk
1833                 next if ($realfile !~ /\.(h|c|pl)$/);
1834
1835 # at the beginning of a line any tabs must come first and anything
1836 # more than 8 must use tabs.
1837                 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1838                     $rawline =~ /^\+\s*        \s*/) {
1839                         my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1840                         ERROR("CODE_INDENT",
1841                               "code indent should use tabs where possible\n" . $herevet);
1842                         $rpt_cleaners = 1;
1843                 }
1844
1845 # check for space before tabs.
1846                 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
1847                         my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1848                         WARN("SPACE_BEFORE_TAB",
1849                              "please, no space before tabs\n" . $herevet);
1850                 }
1851
1852 # check for && or || at the start of a line
1853                 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
1854                         CHK("LOGICAL_CONTINUATIONS",
1855                             "Logical continuations should be on the previous line\n" . $hereprev);
1856                 }
1857
1858 # check multi-line statement indentation matches previous line
1859                 if ($^V && $^V ge 5.10.0 &&
1860                     $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) {
1861                         $prevline =~ /^\+(\t*)(.*)$/;
1862                         my $oldindent = $1;
1863                         my $rest = $2;
1864
1865                         my $pos = pos_last_openparen($rest);
1866                         if ($pos >= 0) {
1867                                 $line =~ /^(\+| )([ \t]*)/;
1868                                 my $newindent = $2;
1869
1870                                 my $goodtabindent = $oldindent .
1871                                         "\t" x ($pos / 8) .
1872                                         " "  x ($pos % 8);
1873                                 my $goodspaceindent = $oldindent . " "  x $pos;
1874
1875                                 if ($newindent ne $goodtabindent &&
1876                                     $newindent ne $goodspaceindent) {
1877                                         CHK("PARENTHESIS_ALIGNMENT",
1878                                             "Alignment should match open parenthesis\n" . $hereprev);
1879                                 }
1880                         }
1881                 }
1882
1883                 if ($line =~ /^\+.*\*[ \t]*\)[ \t]+/) {
1884                         CHK("SPACING",
1885                             "No space is necessary after a cast\n" . $hereprev);
1886                 }
1887
1888                 if ($realfile =~ m@^(drivers/net/|net/)@ &&
1889                     $rawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
1890                     $prevrawline =~ /^\+[ \t]*$/) {
1891                         WARN("NETWORKING_BLOCK_COMMENT_STYLE",
1892                              "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
1893                 }
1894
1895                 if ($realfile =~ m@^(drivers/net/|net/)@ &&
1896                     $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ &&       #trailing */
1897                     $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ &&      #inline /*...*/
1898                     $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ &&       #trailing **/
1899                     $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) {    #non blank */
1900                         WARN("NETWORKING_BLOCK_COMMENT_STYLE",
1901                              "networking block comments put the trailing */ on a separate line\n" . $herecurr);
1902                 }
1903
1904 # check for spaces at the beginning of a line.
1905 # Exceptions:
1906 #  1) within comments
1907 #  2) indented preprocessor commands
1908 #  3) hanging labels
1909                 if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/)  {
1910                         my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1911                         WARN("LEADING_SPACE",
1912                              "please, no spaces at the start of a line\n" . $herevet);
1913                 }
1914
1915 # check we are in a valid C source file if not then ignore this hunk
1916                 next if ($realfile !~ /\.(h|c)$/);
1917
1918 # discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
1919                 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
1920                         WARN("CONFIG_EXPERIMENTAL",
1921                              "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
1922                 }
1923
1924 # check for RCS/CVS revision markers
1925                 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
1926                         WARN("CVS_KEYWORD",
1927                              "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1928                 }
1929
1930 # Blackfin: don't use __builtin_bfin_[cs]sync
1931                 if ($line =~ /__builtin_bfin_csync/) {
1932                         my $herevet = "$here\n" . cat_vet($line) . "\n";
1933                         ERROR("CSYNC",
1934                               "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
1935                 }
1936                 if ($line =~ /__builtin_bfin_ssync/) {
1937                         my $herevet = "$here\n" . cat_vet($line) . "\n";
1938                         ERROR("SSYNC",
1939                               "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
1940                 }
1941
1942 # check for old HOTPLUG __dev<foo> section markings
1943                 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
1944                         WARN("HOTPLUG_SECTION",
1945                              "Using $1 is unnecessary\n" . $herecurr);
1946                 }
1947
1948 # Check for potential 'bare' types
1949                 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
1950                     $realline_next);
1951 #print "LINE<$line>\n";
1952                 if ($linenr >= $suppress_statement &&
1953                     $realcnt && $line =~ /.\s*\S/) {
1954                         ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
1955                                 ctx_statement_block($linenr, $realcnt, 0);
1956                         $stat =~ s/\n./\n /g;
1957                         $cond =~ s/\n./\n /g;
1958
1959 #print "linenr<$linenr> <$stat>\n";
1960                         # If this statement has no statement boundaries within
1961                         # it there is no point in retrying a statement scan
1962                         # until we hit end of it.
1963                         my $frag = $stat; $frag =~ s/;+\s*$//;
1964                         if ($frag !~ /(?:{|;)/) {
1965 #print "skip<$line_nr_next>\n";
1966                                 $suppress_statement = $line_nr_next;
1967                         }
1968
1969                         # Find the real next line.
1970                         $realline_next = $line_nr_next;
1971                         if (defined $realline_next &&
1972                             (!defined $lines[$realline_next - 1] ||
1973                              substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
1974                                 $realline_next++;
1975                         }
1976
1977                         my $s = $stat;
1978                         $s =~ s/{.*$//s;
1979
1980                         # Ignore goto labels.
1981                         if ($s =~ /$Ident:\*$/s) {
1982
1983                         # Ignore functions being called
1984                         } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
1985
1986                         } elsif ($s =~ /^.\s*else\b/s) {
1987
1988                         # declarations always start with types
1989                         } 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) {
1990                                 my $type = $1;
1991                                 $type =~ s/\s+/ /g;
1992                                 possible($type, "A:" . $s);
1993
1994                         # definitions in global scope can only start with types
1995                         } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
1996                                 possible($1, "B:" . $s);
1997                         }
1998
1999                         # any (foo ... *) is a pointer cast, and foo is a type
2000                         while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
2001                                 possible($1, "C:" . $s);
2002                         }
2003
2004                         # Check for any sort of function declaration.
2005                         # int foo(something bar, other baz);
2006                         # void (*store_gdt)(x86_descr_ptr *);
2007                         if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
2008                                 my ($name_len) = length($1);
2009
2010                                 my $ctx = $s;
2011                                 substr($ctx, 0, $name_len + 1, '');
2012                                 $ctx =~ s/\)[^\)]*$//;
2013
2014                                 for my $arg (split(/\s*,\s*/, $ctx)) {
2015                                         if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
2016
2017                                                 possible($1, "D:" . $s);
2018                                         }
2019                                 }
2020                         }
2021
2022                 }
2023
2024 #
2025 # Checks which may be anchored in the context.
2026 #
2027
2028 # Check for switch () and associated case and default
2029 # statements should be at the same indent.
2030                 if ($line=~/\bswitch\s*\(.*\)/) {
2031                         my $err = '';
2032                         my $sep = '';
2033                         my @ctx = ctx_block_outer($linenr, $realcnt);
2034                         shift(@ctx);
2035                         for my $ctx (@ctx) {
2036                                 my ($clen, $cindent) = line_stats($ctx);
2037                                 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2038                                                         $indent != $cindent) {
2039                                         $err .= "$sep$ctx\n";
2040                                         $sep = '';
2041                                 } else {
2042                                         $sep = "[...]\n";
2043                                 }
2044                         }
2045                         if ($err ne '') {
2046                                 ERROR("SWITCH_CASE_INDENT_LEVEL",
2047                                       "switch and case should be at the same indent\n$hereline$err");
2048                         }
2049                 }
2050
2051 # if/while/etc brace do not go on next line, unless defining a do while loop,
2052 # or if that brace on the next line is for something else
2053                 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
2054                         my $pre_ctx = "$1$2";
2055
2056                         my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
2057
2058                         if ($line =~ /^\+\t{6,}/) {
2059                                 WARN("DEEP_INDENTATION",
2060                                      "Too many leading tabs - consider code refactoring\n" . $herecurr);
2061                         }
2062
2063                         my $ctx_cnt = $realcnt - $#ctx - 1;
2064                         my $ctx = join("\n", @ctx);
2065
2066                         my $ctx_ln = $linenr;
2067                         my $ctx_skip = $realcnt;
2068
2069                         while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2070                                         defined $lines[$ctx_ln - 1] &&
2071                                         $lines[$ctx_ln - 1] =~ /^-/)) {
2072                                 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2073                                 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
2074                                 $ctx_ln++;
2075                         }
2076
2077                         #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2078                         #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
2079
2080                         if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
2081                                 ERROR("OPEN_BRACE",
2082                                       "that open brace { should be on the previous line\n" .
2083                                         "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2084                         }
2085                         if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2086                             $ctx =~ /\)\s*\;\s*$/ &&
2087                             defined $lines[$ctx_ln - 1])
2088                         {
2089                                 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2090                                 if ($nindent > $indent) {
2091                                         WARN("TRAILING_SEMICOLON",
2092                                              "trailing semicolon indicates no statements, indent implies otherwise\n" .
2093                                                 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2094                                 }
2095                         }
2096                 }
2097
2098 # Check relative indent for conditionals and blocks.
2099                 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2100                         ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2101                                 ctx_statement_block($linenr, $realcnt, 0)
2102                                         if (!defined $stat);
2103                         my ($s, $c) = ($stat, $cond);
2104
2105                         substr($s, 0, length($c), '');
2106
2107                         # Make sure we remove the line prefixes as we have
2108                         # none on the first line, and are going to readd them
2109                         # where necessary.
2110                         $s =~ s/\n./\n/gs;
2111
2112                         # Find out how long the conditional actually is.
2113                         my @newlines = ($c =~ /\n/gs);
2114                         my $cond_lines = 1 + $#newlines;
2115
2116                         # We want to check the first line inside the block
2117                         # starting at the end of the conditional, so remove:
2118                         #  1) any blank line termination
2119                         #  2) any opening brace { on end of the line
2120                         #  3) any do (...) {
2121                         my $continuation = 0;
2122                         my $check = 0;
2123                         $s =~ s/^.*\bdo\b//;
2124                         $s =~ s/^\s*{//;
2125                         if ($s =~ s/^\s*\\//) {
2126                                 $continuation = 1;
2127                         }
2128                         if ($s =~ s/^\s*?\n//) {
2129                                 $check = 1;
2130                                 $cond_lines++;
2131                         }
2132
2133                         # Also ignore a loop construct at the end of a
2134                         # preprocessor statement.
2135                         if (($prevline =~ /^.\s*#\s*define\s/ ||
2136                             $prevline =~ /\\\s*$/) && $continuation == 0) {
2137                                 $check = 0;
2138                         }
2139
2140                         my $cond_ptr = -1;
2141                         $continuation = 0;
2142                         while ($cond_ptr != $cond_lines) {
2143                                 $cond_ptr = $cond_lines;
2144
2145                                 # If we see an #else/#elif then the code
2146                                 # is not linear.
2147                                 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2148                                         $check = 0;
2149                                 }
2150
2151                                 # Ignore:
2152                                 #  1) blank lines, they should be at 0,
2153                                 #  2) preprocessor lines, and
2154                                 #  3) labels.
2155                                 if ($continuation ||
2156                                     $s =~ /^\s*?\n/ ||
2157                                     $s =~ /^\s*#\s*?/ ||
2158                                     $s =~ /^\s*$Ident\s*:/) {
2159                                         $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
2160                                         if ($s =~ s/^.*?\n//) {
2161                                                 $cond_lines++;
2162                                         }
2163                                 }
2164                         }
2165
2166                         my (undef, $sindent) = line_stats("+" . $s);
2167                         my $stat_real = raw_line($linenr, $cond_lines);
2168
2169                         # Check if either of these lines are modified, else
2170                         # this is not this patch's fault.
2171                         if (!defined($stat_real) ||
2172                             $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2173                                 $check = 0;
2174                         }
2175                         if (defined($stat_real) && $cond_lines > 1) {
2176                                 $stat_real = "[...]\n$stat_real";
2177                         }
2178
2179                         #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";
2180
2181                         if ($check && (($sindent % 8) != 0 ||
2182                             ($sindent <= $indent && $s ne ''))) {
2183                                 WARN("SUSPECT_CODE_INDENT",
2184                                      "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
2185                         }
2186                 }
2187
2188                 # Track the 'values' across context and added lines.
2189                 my $opline = $line; $opline =~ s/^./ /;
2190                 my ($curr_values, $curr_vars) =
2191                                 annotate_values($opline . "\n", $prev_values);
2192                 $curr_values = $prev_values . $curr_values;
2193                 if ($dbg_values) {
2194                         my $outline = $opline; $outline =~ s/\t/ /g;
2195                         print "$linenr > .$outline\n";
2196                         print "$linenr > $curr_values\n";
2197                         print "$linenr >  $curr_vars\n";
2198                 }
2199                 $prev_values = substr($curr_values, -1);
2200
2201 #ignore lines not being added
2202                 if ($line=~/^[^\+]/) {next;}
2203
2204 # TEST: allow direct testing of the type matcher.
2205                 if ($dbg_type) {
2206                         if ($line =~ /^.\s*$Declare\s*$/) {
2207                                 ERROR("TEST_TYPE",
2208                                       "TEST: is type\n" . $herecurr);
2209                         } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
2210                                 ERROR("TEST_NOT_TYPE",
2211                                       "TEST: is not type ($1 is)\n". $herecurr);
2212                         }
2213                         next;
2214                 }
2215 # TEST: allow direct testing of the attribute matcher.
2216                 if ($dbg_attr) {
2217                         if ($line =~ /^.\s*$Modifier\s*$/) {
2218                                 ERROR("TEST_ATTR",
2219                                       "TEST: is attr\n" . $herecurr);
2220                         } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
2221                                 ERROR("TEST_NOT_ATTR",
2222                                       "TEST: is not attr ($1 is)\n". $herecurr);
2223                         }
2224                         next;
2225                 }
2226
2227 # check for initialisation to aggregates open brace on the next line
2228                 if ($line =~ /^.\s*{/ &&
2229                     $prevline =~ /(?:^|[^=])=\s*$/) {
2230                         ERROR("OPEN_BRACE",
2231                               "that open brace { should be on the previous line\n" . $hereprev);
2232                 }
2233
2234 #
2235 # Checks which are anchored on the added line.
2236 #
2237
2238 # check for malformed paths in #include statements (uses RAW line)
2239                 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
2240                         my $path = $1;
2241                         if ($path =~ m{//}) {
2242                                 ERROR("MALFORMED_INCLUDE",
2243                                       "malformed #include filename\n" . $herecurr);
2244                         }
2245                         if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
2246                                 ERROR("UAPI_INCLUDE",
2247                                       "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
2248                         }
2249                 }
2250
2251 # no C99 // comments
2252                 if ($line =~ m{//}) {
2253                         ERROR("C99_COMMENTS",
2254                               "do not use C99 // comments\n" . $herecurr);
2255                 }
2256                 # Remove C99 comments.
2257                 $line =~ s@//.*@@;
2258                 $opline =~ s@//.*@@;
2259
2260 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2261 # the whole statement.
2262 #print "APW <$lines[$realline_next - 1]>\n";
2263                 if (defined $realline_next &&
2264                     exists $lines[$realline_next - 1] &&
2265                     !defined $suppress_export{$realline_next} &&
2266                     ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2267                      $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2268                         # Handle definitions which produce identifiers with
2269                         # a prefix:
2270                         #   XXX(foo);
2271                         #   EXPORT_SYMBOL(something_foo);
2272                         my $name = $1;
2273                         if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
2274                             $name =~ /^${Ident}_$2/) {
2275 #print "FOO C name<$name>\n";
2276                                 $suppress_export{$realline_next} = 1;
2277
2278                         } elsif ($stat !~ /(?:
2279                                 \n.}\s*$|
2280                                 ^.DEFINE_$Ident\(\Q$name\E\)|
2281                                 ^.DECLARE_$Ident\(\Q$name\E\)|
2282                                 ^.LIST_HEAD\(\Q$name\E\)|
2283                                 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2284                                 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
2285                             )/x) {
2286 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2287                                 $suppress_export{$realline_next} = 2;
2288                         } else {
2289                                 $suppress_export{$realline_next} = 1;
2290                         }
2291                 }
2292                 if (!defined $suppress_export{$linenr} &&
2293                     $prevline =~ /^.\s*$/ &&
2294                     ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2295                      $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2296 #print "FOO B <$lines[$linenr - 1]>\n";
2297                         $suppress_export{$linenr} = 2;
2298                 }
2299                 if (defined $suppress_export{$linenr} &&
2300                     $suppress_export{$linenr} == 2) {
2301                         WARN("EXPORT_SYMBOL",
2302                              "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
2303                 }
2304
2305 # check for global initialisers.
2306                 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
2307                         ERROR("GLOBAL_INITIALISERS",
2308                               "do not initialise globals to 0 or NULL\n" .
2309                                 $herecurr);
2310                 }
2311 # check for static initialisers.
2312                 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2313                         ERROR("INITIALISED_STATIC",
2314                               "do not initialise statics to 0 or NULL\n" .
2315                                 $herecurr);
2316                 }
2317
2318 # check for static const char * arrays.
2319                 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
2320                         WARN("STATIC_CONST_CHAR_ARRAY",
2321                              "static const char * array should probably be static const char * const\n" .
2322                                 $herecurr);
2323                }
2324
2325 # check for static char foo[] = "bar" declarations.
2326                 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
2327                         WARN("STATIC_CONST_CHAR_ARRAY",
2328                              "static char array declaration should probably be static const char\n" .
2329                                 $herecurr);
2330                }
2331
2332 # check for declarations of struct pci_device_id
2333                 if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) {
2334                         WARN("DEFINE_PCI_DEVICE_TABLE",
2335                              "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr);
2336                 }
2337
2338 # check for new typedefs, only function parameters and sparse annotations
2339 # make sense.
2340                 if ($line =~ /\btypedef\s/ &&
2341                     $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
2342                     $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
2343                     $line !~ /\b$typeTypedefs\b/ &&
2344                     $line !~ /\b__bitwise(?:__|)\b/) {
2345                         WARN("NEW_TYPEDEFS",
2346                              "do not add new typedefs\n" . $herecurr);
2347                 }
2348
2349 # * goes on variable not on type
2350                 # (char*[ const])
2351                 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2352                         #print "AA<$1>\n";
2353                         my ($from, $to) = ($2, $2);
2354
2355                         # Should start with a space.
2356                         $to =~ s/^(\S)/ $1/;
2357                         # Should not end with a space.
2358                         $to =~ s/\s+$//;
2359                         # '*'s should not have spaces between.
2360                         while ($to =~ s/\*\s+\*/\*\*/) {
2361                         }
2362
2363                         #print "from<$from> to<$to>\n";
2364                         if ($from ne $to) {
2365                                 ERROR("POINTER_LOCATION",
2366                                       "\"(foo$from)\" should be \"(foo$to)\"\n" .  $herecurr);
2367                         }
2368                 }
2369                 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2370                         #print "BB<$1>\n";
2371                         my ($from, $to, $ident) = ($2, $2, $3);
2372
2373                         # Should start with a space.
2374                         $to =~ s/^(\S)/ $1/;
2375                         # Should not end with a space.
2376                         $to =~ s/\s+$//;
2377                         # '*'s should not have spaces between.
2378                         while ($to =~ s/\*\s+\*/\*\*/) {
2379                         }
2380                         # Modifiers should have spaces.
2381                         $to =~ s/(\b$Modifier$)/$1 /;
2382
2383                         #print "from<$from> to<$to> ident<$ident>\n";
2384                         if ($from ne $to && $ident !~ /^$Modifier$/) {
2385                                 ERROR("POINTER_LOCATION",
2386                                       "\"foo${from}bar\" should be \"foo${to}bar\"\n" .  $herecurr);
2387                         }
2388                 }
2389
2390 # # no BUG() or BUG_ON()
2391 #               if ($line =~ /\b(BUG|BUG_ON)\b/) {
2392 #                       print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2393 #                       print "$herecurr";
2394 #                       $clean = 0;
2395 #               }
2396
2397                 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
2398                         WARN("LINUX_VERSION_CODE",
2399                              "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
2400                 }
2401
2402 # check for uses of printk_ratelimit
2403                 if ($line =~ /\bprintk_ratelimit\s*\(/) {
2404                         WARN("PRINTK_RATELIMITED",
2405 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
2406                 }
2407
2408 # printk should use KERN_* levels.  Note that follow on printk's on the
2409 # same line do not need a level, so we use the current block context
2410 # to try and find and validate the current printk.  In summary the current
2411 # printk includes all preceding printk's which have no newline on the end.
2412 # we assume the first bad printk is the one to report.
2413                 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
2414                         my $ok = 0;
2415                         for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2416                                 #print "CHECK<$lines[$ln - 1]\n";
2417                                 # we have a preceding printk if it ends
2418                                 # with "\n" ignore it, else it is to blame
2419                                 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2420                                         if ($rawlines[$ln - 1] !~ m{\\n"}) {
2421                                                 $ok = 1;
2422                                         }
2423                                         last;
2424                                 }
2425                         }
2426                         if ($ok == 0) {
2427                                 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2428                                      "printk() should include KERN_ facility level\n" . $herecurr);
2429                         }
2430                 }
2431
2432                 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
2433                         my $orig = $1;
2434                         my $level = lc($orig);
2435                         $level = "warn" if ($level eq "warning");
2436                         my $level2 = $level;
2437                         $level2 = "dbg" if ($level eq "debug");
2438                         WARN("PREFER_PR_LEVEL",
2439                              "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(...  to printk(KERN_$orig ...\n" . $herecurr);
2440                 }
2441
2442                 if ($line =~ /\bpr_warning\s*\(/) {
2443                         WARN("PREFER_PR_LEVEL",
2444                              "Prefer pr_warn(... to pr_warning(...\n" . $herecurr);
2445                 }
2446
2447                 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
2448                         my $orig = $1;
2449                         my $level = lc($orig);
2450                         $level = "warn" if ($level eq "warning");
2451                         $level = "dbg" if ($level eq "debug");
2452                         WARN("PREFER_DEV_LEVEL",
2453                              "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
2454                 }
2455
2456 # function brace can't be on same line, except for #defines of do while,
2457 # or if closed on same line
2458                 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2459                     !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
2460                         ERROR("OPEN_BRACE",
2461                               "open brace '{' following function declarations go on the next line\n" . $herecurr);
2462                 }
2463
2464 # open braces for enum, union and struct go on the same line.
2465                 if ($line =~ /^.\s*{/ &&
2466                     $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
2467                         ERROR("OPEN_BRACE",
2468                               "open brace '{' following $1 go on the same line\n" . $hereprev);
2469                 }
2470
2471 # missing space after union, struct or enum definition
2472                 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) {
2473                     WARN("SPACING",
2474                          "missing space after $1 definition\n" . $herecurr);
2475                 }
2476
2477 # check for spacing round square brackets; allowed:
2478 #  1. with a type on the left -- int [] a;
2479 #  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2480 #  3. inside a curly brace -- = { [0...10] = 5 }
2481                 while ($line =~ /(.*?\s)\[/g) {
2482                         my ($where, $prefix) = ($-[1], $1);
2483                         if ($prefix !~ /$Type\s+$/ &&
2484                             ($where != 0 || $prefix !~ /^.\s+$/) &&
2485                             $prefix !~ /[{,]\s+$/) {
2486                                 ERROR("BRACKET_SPACE",
2487                                       "space prohibited before open square bracket '['\n" . $herecurr);
2488                         }
2489                 }
2490
2491 # check for spaces between functions and their parentheses.
2492                 while ($line =~ /($Ident)\s+\(/g) {
2493                         my $name = $1;
2494                         my $ctx_before = substr($line, 0, $-[1]);
2495                         my $ctx = "$ctx_before$name";
2496
2497                         # Ignore those directives where spaces _are_ permitted.
2498                         if ($name =~ /^(?:
2499                                 if|for|while|switch|return|case|
2500                                 volatile|__volatile__|
2501                                 __attribute__|format|__extension__|
2502                                 asm|__asm__)$/x)
2503                         {
2504
2505                         # cpp #define statements have non-optional spaces, ie
2506                         # if there is a space between the name and the open
2507                         # parenthesis it is simply not a parameter group.
2508                         } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
2509
2510                         # cpp #elif statement condition may start with a (
2511                         } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
2512
2513                         # If this whole things ends with a type its most
2514                         # likely a typedef for a function.
2515                         } elsif ($ctx =~ /$Type$/) {
2516
2517                         } else {
2518                                 WARN("SPACING",
2519                                      "space prohibited between function name and open parenthesis '('\n" . $herecurr);
2520                         }
2521                 }
2522
2523 # check for whitespace before a non-naked semicolon
2524                 if ($line =~ /^\+.*\S\s+;/) {
2525                         WARN("SPACING",
2526                              "space prohibited before semicolon\n" . $herecurr);
2527                 }
2528
2529 # Check operator spacing.
2530                 if (!($line=~/\#\s*include/)) {
2531                         my $ops = qr{
2532                                 <<=|>>=|<=|>=|==|!=|
2533                                 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
2534                                 =>|->|<<|>>|<|>|=|!|~|
2535                                 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
2536                                 \?|:
2537                         }x;
2538                         my @elements = split(/($ops|;)/, $opline);
2539                         my $off = 0;
2540
2541                         my $blank = copy_spacing($opline);
2542
2543                         for (my $n = 0; $n < $#elements; $n += 2) {
2544                                 $off += length($elements[$n]);
2545
2546                                 # Pick up the preceding and succeeding characters.
2547                                 my $ca = substr($opline, 0, $off);
2548                                 my $cc = '';
2549                                 if (length($opline) >= ($off + length($elements[$n + 1]))) {
2550                                         $cc = substr($opline, $off + length($elements[$n + 1]));
2551                                 }
2552                                 my $cb = "$ca$;$cc";
2553
2554                                 my $a = '';
2555                                 $a = 'V' if ($elements[$n] ne '');
2556                                 $a = 'W' if ($elements[$n] =~ /\s$/);
2557                                 $a = 'C' if ($elements[$n] =~ /$;$/);
2558                                 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
2559                                 $a = 'O' if ($elements[$n] eq '');
2560                                 $a = 'E' if ($ca =~ /^\s*$/);
2561
2562                                 my $op = $elements[$n + 1];
2563
2564                                 my $c = '';
2565                                 if (defined $elements[$n + 2]) {
2566                                         $c = 'V' if ($elements[$n + 2] ne '');
2567                                         $c = 'W' if ($elements[$n + 2] =~ /^\s/);
2568                                         $c = 'C' if ($elements[$n + 2] =~ /^$;/);
2569                                         $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
2570                                         $c = 'O' if ($elements[$n + 2] eq '');
2571                                         $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
2572                                 } else {
2573                                         $c = 'E';
2574                                 }
2575
2576                                 my $ctx = "${a}x${c}";
2577
2578                                 my $at = "(ctx:$ctx)";
2579
2580                                 my $ptr = substr($blank, 0, $off) . "^";
2581                                 my $hereptr = "$hereline$ptr\n";
2582
2583                                 # Pull out the value of this operator.
2584                                 my $op_type = substr($curr_values, $off + 1, 1);
2585
2586                                 # Get the full operator variant.
2587                                 my $opv = $op . substr($curr_vars, $off, 1);
2588
2589                                 # Ignore operators passed as parameters.
2590                                 if ($op_type ne 'V' &&
2591                                     $ca =~ /\s$/ && $cc =~ /^\s*,/) {
2592
2593 #                               # Ignore comments
2594 #                               } elsif ($op =~ /^$;+$/) {
2595
2596                                 # ; should have either the end of line or a space or \ after it
2597                                 } elsif ($op eq ';') {
2598                                         if ($ctx !~ /.x[WEBC]/ &&
2599                                             $cc !~ /^\\/ && $cc !~ /^;/) {
2600                                                 ERROR("SPACING",
2601                                                       "space required after that '$op' $at\n" . $hereptr);
2602                                         }
2603
2604                                 # // is a comment
2605                                 } elsif ($op eq '//') {
2606
2607                                 # No spaces for:
2608                                 #   ->
2609                                 #   :   when part of a bitfield
2610                                 } elsif ($op eq '->' || $opv eq ':B') {
2611                                         if ($ctx =~ /Wx.|.xW/) {
2612                                                 ERROR("SPACING",
2613                                                       "spaces prohibited around that '$op' $at\n" . $hereptr);
2614                                         }
2615
2616                                 # , must have a space on the right.
2617                                 } elsif ($op eq ',') {
2618                                         if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
2619                                                 ERROR("SPACING",
2620                                                       "space required after that '$op' $at\n" . $hereptr);
2621                                         }
2622
2623                                 # '*' as part of a type definition -- reported already.
2624                                 } elsif ($opv eq '*_') {
2625                                         #warn "'*' is part of type\n";
2626
2627                                 # unary operators should have a space before and
2628                                 # none after.  May be left adjacent to another
2629                                 # unary operator, or a cast
2630                                 } elsif ($op eq '!' || $op eq '~' ||
2631                                          $opv eq '*U' || $opv eq '-U' ||
2632                                          $opv eq '&U' || $opv eq '&&U') {
2633                                         if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
2634                                                 ERROR("SPACING",
2635                                                       "space required before that '$op' $at\n" . $hereptr);
2636                                         }
2637                                         if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
2638                                                 # A unary '*' may be const
2639
2640                                         } elsif ($ctx =~ /.xW/) {
2641                                                 ERROR("SPACING",
2642                                                       "space prohibited after that '$op' $at\n" . $hereptr);
2643                                         }
2644
2645                                 # unary ++ and unary -- are allowed no space on one side.
2646                                 } elsif ($op eq '++' or $op eq '--') {
2647                                         if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
2648                                                 ERROR("SPACING",
2649                                                       "space required one side of that '$op' $at\n" . $hereptr);
2650                                         }
2651                                         if ($ctx =~ /Wx[BE]/ ||
2652                                             ($ctx =~ /Wx./ && $cc =~ /^;/)) {
2653                                                 ERROR("SPACING",
2654                                                       "space prohibited before that '$op' $at\n" . $hereptr);
2655                                         }
2656                                         if ($ctx =~ /ExW/) {
2657                                                 ERROR("SPACING",
2658                                                       "space prohibited after that '$op' $at\n" . $hereptr);
2659                                         }
2660
2661
2662                                 # << and >> may either have or not have spaces both sides
2663                                 } elsif ($op eq '<<' or $op eq '>>' or
2664                                          $op eq '&' or $op eq '^' or $op eq '|' or
2665                                          $op eq '+' or $op eq '-' or
2666                                          $op eq '*' or $op eq '/' or
2667                                          $op eq '%')
2668                                 {
2669                                         if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
2670                                                 ERROR("SPACING",
2671                                                       "need consistent spacing around '$op' $at\n" .
2672                                                         $hereptr);
2673                                         }
2674
2675                                 # A colon needs no spaces before when it is
2676                                 # terminating a case value or a label.
2677                                 } elsif ($opv eq ':C' || $opv eq ':L') {
2678                                         if ($ctx =~ /Wx./) {
2679                                                 ERROR("SPACING",
2680                                                       "space prohibited before that '$op' $at\n" . $hereptr);
2681                                         }
2682
2683                                 # All the others need spaces both sides.
2684                                 } elsif ($ctx !~ /[EWC]x[CWE]/) {
2685                                         my $ok = 0;
2686
2687                                         # Ignore email addresses <foo@bar>
2688                                         if (($op eq '<' &&
2689                                              $cc =~ /^\S+\@\S+>/) ||
2690                                             ($op eq '>' &&
2691                                              $ca =~ /<\S+\@\S+$/))
2692                                         {
2693                                                 $ok = 1;
2694                                         }
2695
2696                                         # Ignore ?:
2697                                         if (($opv eq ':O' && $ca =~ /\?$/) ||
2698                                             ($op eq '?' && $cc =~ /^:/)) {
2699                                                 $ok = 1;
2700                                         }
2701
2702                                         if ($ok == 0) {
2703                                                 ERROR("SPACING",
2704                                                       "spaces required around that '$op' $at\n" . $hereptr);
2705                                         }
2706                                 }
2707                                 $off += length($elements[$n + 1]);
2708                         }
2709                 }
2710
2711 # check for multiple assignments
2712                 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
2713                         CHK("MULTIPLE_ASSIGNMENTS",
2714                             "multiple assignments should be avoided\n" . $herecurr);
2715                 }
2716
2717 ## # check for multiple declarations, allowing for a function declaration
2718 ## # continuation.
2719 ##              if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
2720 ##                  $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
2721 ##
2722 ##                      # Remove any bracketed sections to ensure we do not
2723 ##                      # falsly report the parameters of functions.
2724 ##                      my $ln = $line;
2725 ##                      while ($ln =~ s/\([^\(\)]*\)//g) {
2726 ##                      }
2727 ##                      if ($ln =~ /,/) {
2728 ##                              WARN("MULTIPLE_DECLARATION",
2729 ##                                   "declaring multiple variables together should be avoided\n" . $herecurr);
2730 ##                      }
2731 ##              }
2732
2733 #need space before brace following if, while, etc
2734                 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
2735                     $line =~ /do{/) {
2736                         ERROR("SPACING",
2737                               "space required before the open brace '{'\n" . $herecurr);
2738                 }
2739
2740 # closing brace should have a space following it when it has anything
2741 # on the line
2742                 if ($line =~ /}(?!(?:,|;|\)))\S/) {
2743                         ERROR("SPACING",
2744                               "space required after that close brace '}'\n" . $herecurr);
2745                 }
2746
2747 # check spacing on square brackets
2748                 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
2749                         ERROR("SPACING",
2750                               "space prohibited after that open square bracket '['\n" . $herecurr);
2751                 }
2752                 if ($line =~ /\s\]/) {
2753                         ERROR("SPACING",
2754                               "space prohibited before that close square bracket ']'\n" . $herecurr);
2755                 }
2756
2757 # check spacing on parentheses
2758                 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
2759                     $line !~ /for\s*\(\s+;/) {
2760                         ERROR("SPACING",
2761                               "space prohibited after that open parenthesis '('\n" . $herecurr);
2762                 }
2763                 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
2764                     $line !~ /for\s*\(.*;\s+\)/ &&
2765                     $line !~ /:\s+\)/) {
2766                         ERROR("SPACING",
2767                               "space prohibited before that close parenthesis ')'\n" . $herecurr);
2768                 }
2769
2770 #goto labels aren't indented, allow a single space however
2771                 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
2772                    !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
2773                         WARN("INDENTED_LABEL",
2774                              "labels should not be indented\n" . $herecurr);
2775                 }
2776
2777 # Return is not a function.
2778                 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2779                         my $spacing = $1;
2780                         my $value = $2;
2781
2782                         # Flatten any parentheses
2783                         $value =~ s/\(/ \(/g;
2784                         $value =~ s/\)/\) /g;
2785                         while ($value =~ s/\[[^\[\]]*\]/1/ ||
2786                                $value !~ /(?:$Ident|-?$Constant)\s*
2787                                              $Compare\s*
2788                                              (?:$Ident|-?$Constant)/x &&
2789                                $value =~ s/\([^\(\)]*\)/1/) {
2790                         }
2791 #print "value<$value>\n";
2792                         if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
2793                                 ERROR("RETURN_PARENTHESES",
2794                                       "return is not a function, parentheses are not required\n" . $herecurr);
2795
2796                         } elsif ($spacing !~ /\s+/) {
2797                                 ERROR("SPACING",
2798                                       "space required before the open parenthesis '('\n" . $herecurr);
2799                         }
2800                 }
2801 # Return of what appears to be an errno should normally be -'ve
2802                 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
2803                         my $name = $1;
2804                         if ($name ne 'EOF' && $name ne 'ERROR') {
2805                                 WARN("USE_NEGATIVE_ERRNO",
2806                                      "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
2807                         }
2808                 }
2809
2810 # Need a space before open parenthesis after if, while etc
2811                 if ($line=~/\b(if|while|for|switch)\(/) {
2812                         ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr);
2813                 }
2814
2815 # Check for illegal assignment in if conditional -- and check for trailing
2816 # statements after the conditional.
2817                 if ($line =~ /do\s*(?!{)/) {
2818                         ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2819                                 ctx_statement_block($linenr, $realcnt, 0)
2820                                         if (!defined $stat);
2821                         my ($stat_next) = ctx_statement_block($line_nr_next,
2822                                                 $remain_next, $off_next);
2823                         $stat_next =~ s/\n./\n /g;
2824                         ##print "stat<$stat> stat_next<$stat_next>\n";
2825
2826                         if ($stat_next =~ /^\s*while\b/) {
2827                                 # If the statement carries leading newlines,
2828                                 # then count those as offsets.
2829                                 my ($whitespace) =
2830                                         ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2831                                 my $offset =
2832                                         statement_rawlines($whitespace) - 1;
2833
2834                                 $suppress_whiletrailers{$line_nr_next +
2835                                                                 $offset} = 1;
2836                         }
2837                 }
2838                 if (!defined $suppress_whiletrailers{$linenr} &&
2839                     $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
2840                         my ($s, $c) = ($stat, $cond);
2841
2842                         if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
2843                                 ERROR("ASSIGN_IN_IF",
2844                                       "do not use assignment in if condition\n" . $herecurr);
2845                         }
2846
2847                         # Find out what is on the end of the line after the
2848                         # conditional.
2849                         substr($s, 0, length($c), '');
2850                         $s =~ s/\n.*//g;
2851                         $s =~ s/$;//g;  # Remove any comments
2852                         if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2853                             $c !~ /}\s*while\s*/)
2854                         {
2855                                 # Find out how long the conditional actually is.
2856                                 my @newlines = ($c =~ /\n/gs);
2857                                 my $cond_lines = 1 + $#newlines;
2858                                 my $stat_real = '';
2859
2860                                 $stat_real = raw_line($linenr, $cond_lines)
2861                                                         . "\n" if ($cond_lines);
2862                                 if (defined($stat_real) && $cond_lines > 1) {
2863                                         $stat_real = "[...]\n$stat_real";
2864                                 }
2865
2866                                 ERROR("TRAILING_STATEMENTS",
2867                                       "trailing statements should be on next line\n" . $herecurr . $stat_real);
2868                         }
2869                 }
2870
2871 # Check for bitwise tests written as boolean
2872                 if ($line =~ /
2873                         (?:
2874                                 (?:\[|\(|\&\&|\|\|)
2875                                 \s*0[xX][0-9]+\s*
2876                                 (?:\&\&|\|\|)
2877                         |
2878                                 (?:\&\&|\|\|)
2879                                 \s*0[xX][0-9]+\s*
2880                                 (?:\&\&|\|\||\)|\])
2881                         )/x)
2882                 {
2883                         WARN("HEXADECIMAL_BOOLEAN_TEST",
2884                              "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2885                 }
2886
2887 # if and else should not have general statements after it
2888                 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2889                         my $s = $1;
2890                         $s =~ s/$;//g;  # Remove any comments
2891                         if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2892                                 ERROR("TRAILING_STATEMENTS",
2893                                       "trailing statements should be on next line\n" . $herecurr);
2894                         }
2895                 }
2896 # if should not continue a brace
2897                 if ($line =~ /}\s*if\b/) {
2898                         ERROR("TRAILING_STATEMENTS",
2899                               "trailing statements should be on next line\n" .
2900                                 $herecurr);
2901                 }
2902 # case and default should not have general statements after them
2903                 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2904                     $line !~ /\G(?:
2905                         (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
2906                         \s*return\s+
2907                     )/xg)
2908                 {
2909                         ERROR("TRAILING_STATEMENTS",
2910                               "trailing statements should be on next line\n" . $herecurr);
2911                 }
2912
2913                 # Check for }<nl>else {, these must be at the same
2914                 # indent level to be relevant to each other.
2915                 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2916                                                 $previndent == $indent) {
2917                         ERROR("ELSE_AFTER_BRACE",
2918                               "else should follow close brace '}'\n" . $hereprev);
2919                 }
2920
2921                 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2922                                                 $previndent == $indent) {
2923                         my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2924
2925                         # Find out what is on the end of the line after the
2926                         # conditional.
2927                         substr($s, 0, length($c), '');
2928                         $s =~ s/\n.*//g;
2929
2930                         if ($s =~ /^\s*;/) {
2931                                 ERROR("WHILE_AFTER_BRACE",
2932                                       "while should follow close brace '}'\n" . $hereprev);
2933                         }
2934                 }
2935
2936 #CamelCase
2937                 while ($line =~ m{($Constant|$Lval)}g) {
2938                         my $var = $1;
2939                         if ($var !~ /$Constant/ &&
2940                             $var =~ /[A-Z]\w*[a-z]|[a-z]\w*[A-Z]/ &&
2941                             $var !~ /"^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
2942                             !defined $camelcase{$var}) {
2943                                 $camelcase{$var} = 1;
2944                                 WARN("CAMELCASE",
2945                                      "Avoid CamelCase: <$var>\n" . $herecurr);
2946                         }
2947                 }
2948
2949 #no spaces allowed after \ in define
2950                 if ($line=~/\#\s*define.*\\\s$/) {
2951                         WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
2952                              "Whitepspace after \\ makes next lines useless\n" . $herecurr);
2953                 }
2954
2955 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
2956                 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
2957                         my $file = "$1.h";
2958                         my $checkfile = "include/linux/$file";
2959                         if (-f "$root/$checkfile" &&
2960                             $realfile ne $checkfile &&
2961                             $1 !~ /$allowed_asm_includes/)
2962                         {
2963                                 if ($realfile =~ m{^arch/}) {
2964                                         CHK("ARCH_INCLUDE_LINUX",
2965                                             "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2966                                 } else {
2967                                         WARN("INCLUDE_LINUX",
2968                                              "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2969                                 }
2970                         }
2971                 }
2972
2973 # multi-statement macros should be enclosed in a do while loop, grab the
2974 # first statement and ensure its the whole macro if its not enclosed
2975 # in a known good container
2976                 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2977                     $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
2978                         my $ln = $linenr;
2979                         my $cnt = $realcnt;
2980                         my ($off, $dstat, $dcond, $rest);
2981                         my $ctx = '';
2982                         ($dstat, $dcond, $ln, $cnt, $off) =
2983                                 ctx_statement_block($linenr, $realcnt, 0);
2984                         $ctx = $dstat;
2985                         #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
2986                         #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
2987
2988                         $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
2989                         $dstat =~ s/$;//g;
2990                         $dstat =~ s/\\\n.//g;
2991                         $dstat =~ s/^\s*//s;
2992                         $dstat =~ s/\s*$//s;
2993
2994                         # Flatten any parentheses and braces
2995                         while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2996                                $dstat =~ s/\{[^\{\}]*\}/1/ ||
2997                                $dstat =~ s/\[[^\[\]]*\]/1/)
2998                         {
2999                         }
3000
3001                         # Flatten any obvious string concatentation.
3002                         while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
3003                                $dstat =~ s/$Ident\s*("X*")/$1/)
3004                         {
3005                         }
3006
3007                         my $exceptions = qr{
3008                                 $Declare|
3009                                 module_param_named|
3010                                 MODULE_PARM_DESC|
3011                                 DECLARE_PER_CPU|
3012                                 DEFINE_PER_CPU|
3013                                 __typeof__\(|
3014                                 union|
3015                                 struct|
3016                                 \.$Ident\s*=\s*|
3017                                 ^\"|\"$
3018                         }x;
3019                         #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
3020                         if ($dstat ne '' &&
3021                             $dstat !~ /^(?:$Ident|-?$Constant),$/ &&                    # 10, // foo(),
3022                             $dstat !~ /^(?:$Ident|-?$Constant);$/ &&                    # foo();
3023                             $dstat !~ /^[!~-]?(?:$Ident|$Constant)$/ &&         # 10 // foo() // !foo // ~foo // -foo
3024                             $dstat !~ /^'X'$/ &&                                        # character constants
3025                             $dstat !~ /$exceptions/ &&
3026                             $dstat !~ /^\.$Ident\s*=/ &&                                # .foo =
3027                             $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ &&          # stringification #foo
3028                             $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ &&       # do {...} while (...); // do {...} while (...)
3029                             $dstat !~ /^for\s*$Constant$/ &&                            # for (...)
3030                             $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ &&   # for (...) bar()
3031                             $dstat !~ /^do\s*{/ &&                                      # do {...
3032                             $dstat !~ /^\({/)                                           # ({...
3033                         {
3034                                 $ctx =~ s/\n*$//;
3035                                 my $herectx = $here . "\n";
3036                                 my $cnt = statement_rawlines($ctx);
3037
3038                                 for (my $n = 0; $n < $cnt; $n++) {
3039                                         $herectx .= raw_line($linenr, $n) . "\n";
3040                                 }
3041
3042                                 if ($dstat =~ /;/) {
3043                                         ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
3044                                               "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
3045                                 } else {
3046                                         ERROR("COMPLEX_MACRO",
3047                                               "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
3048                                 }
3049                         }
3050
3051 # check for line continuations outside of #defines, preprocessor #, and asm
3052
3053                 } else {
3054                         if ($prevline !~ /^..*\\$/ &&
3055                             $line !~ /^\+\s*\#.*\\$/ &&         # preprocessor
3056                             $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ &&   # asm
3057                             $line =~ /^\+.*\\$/) {
3058                                 WARN("LINE_CONTINUATIONS",
3059                                      "Avoid unnecessary line continuations\n" . $herecurr);
3060                         }
3061                 }
3062
3063 # do {} while (0) macro tests:
3064 # single-statement macros do not need to be enclosed in do while (0) loop,
3065 # macro should not end with a semicolon
3066                 if ($^V && $^V ge 5.10.0 &&
3067                     $realfile !~ m@/vmlinux.lds.h$@ &&
3068                     $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
3069                         my $ln = $linenr;
3070                         my $cnt = $realcnt;
3071                         my ($off, $dstat, $dcond, $rest);
3072                         my $ctx = '';
3073                         ($dstat, $dcond, $ln, $cnt, $off) =
3074                                 ctx_statement_block($linenr, $realcnt, 0);
3075                         $ctx = $dstat;
3076
3077                         $dstat =~ s/\\\n.//g;
3078
3079                         if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
3080                                 my $stmts = $2;
3081                                 my $semis = $3;
3082
3083                                 $ctx =~ s/\n*$//;
3084                                 my $cnt = statement_rawlines($ctx);
3085                                 my $herectx = $here . "\n";
3086
3087                                 for (my $n = 0; $n < $cnt; $n++) {
3088                                         $herectx .= raw_line($linenr, $n) . "\n";
3089                                 }
3090
3091                                 if (($stmts =~ tr/;/;/) == 1 &&
3092                                     $stmts !~ /^\s*(if|while|for|switch)\b/) {
3093                                         WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
3094                                              "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
3095                                 }
3096                                 if (defined $semis && $semis ne "") {
3097                                         WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
3098                                              "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
3099                                 }
3100                         }
3101                 }
3102
3103 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3104 # all assignments may have only one of the following with an assignment:
3105 #       .
3106 #       ALIGN(...)
3107 #       VMLINUX_SYMBOL(...)
3108                 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
3109                         WARN("MISSING_VMLINUX_SYMBOL",
3110                              "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
3111                 }
3112
3113 # check for redundant bracing round if etc
3114                 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
3115                         my ($level, $endln, @chunks) =
3116                                 ctx_statement_full($linenr, $realcnt, 1);
3117                         #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
3118                         #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3119                         if ($#chunks > 0 && $level == 0) {
3120                                 my @allowed = ();
3121                                 my $allow = 0;
3122                                 my $seen = 0;
3123                                 my $herectx = $here . "\n";
3124                                 my $ln = $linenr - 1;
3125                                 for my $chunk (@chunks) {
3126                                         my ($cond, $block) = @{$chunk};
3127
3128                                         # If the condition carries leading newlines, then count those as offsets.
3129                                         my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
3130                                         my $offset = statement_rawlines($whitespace) - 1;
3131
3132                                         $allowed[$allow] = 0;
3133                                         #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3134
3135                                         # We have looked at and allowed this specific line.
3136                                         $suppress_ifbraces{$ln + $offset} = 1;
3137
3138                                         $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
3139                                         $ln += statement_rawlines($block) - 1;
3140
3141                                         substr($block, 0, length($cond), '');
3142
3143                                         $seen++ if ($block =~ /^\s*{/);
3144
3145                                         #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
3146                                         if (statement_lines($cond) > 1) {
3147                                                 #print "APW: ALLOWED: cond<$cond>\n";
3148                                                 $allowed[$allow] = 1;
3149                                         }
3150                                         if ($block =~/\b(?:if|for|while)\b/) {
3151                                                 #print "APW: ALLOWED: block<$block>\n";
3152                                                 $allowed[$allow] = 1;
3153                                         }
3154                                         if (statement_block_size($block) > 1) {
3155                                                 #print "APW: ALLOWED: lines block<$block>\n";
3156                                                 $allowed[$allow] = 1;
3157                                         }
3158                                         $allow++;
3159                                 }
3160                                 if ($seen) {
3161                                         my $sum_allowed = 0;
3162                                         foreach (@allowed) {
3163                                                 $sum_allowed += $_;
3164                                         }
3165                                         if ($sum_allowed == 0) {
3166                                                 WARN("BRACES",
3167                                                      "braces {} are not necessary for any arm of this statement\n" . $herectx);
3168                                         } elsif ($sum_allowed != $allow &&
3169                                                  $seen != $allow) {
3170                                                 CHK("BRACES",
3171                                                     "braces {} should be used on all arms of this statement\n" . $herectx);
3172                                         }
3173                                 }
3174                         }
3175                 }
3176                 if (!defined $suppress_ifbraces{$linenr - 1} &&
3177                                         $line =~ /\b(if|while|for|else)\b/) {
3178                         my $allowed = 0;
3179
3180                         # Check the pre-context.
3181                         if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
3182                                 #print "APW: ALLOWED: pre<$1>\n";
3183                                 $allowed = 1;
3184                         }
3185
3186                         my ($level, $endln, @chunks) =
3187                                 ctx_statement_full($linenr, $realcnt, $-[0]);
3188
3189                         # Check the condition.
3190                         my ($cond, $block) = @{$chunks[0]};
3191                         #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
3192                         if (defined $cond) {
3193                                 substr($block, 0, length($cond), '');
3194                         }
3195                         if (statement_lines($cond) > 1) {
3196                                 #print "APW: ALLOWED: cond<$cond>\n";
3197                                 $allowed = 1;
3198                         }
3199                         if ($block =~/\b(?:if|for|while)\b/) {
3200                                 #print "APW: ALLOWED: block<$block>\n";
3201                                 $allowed = 1;
3202                         }
3203                         if (statement_block_size($block) > 1) {
3204                                 #print "APW: ALLOWED: lines block<$block>\n";
3205                                 $allowed = 1;
3206                         }
3207                         # Check the post-context.
3208                         if (defined $chunks[1]) {
3209                                 my ($cond, $block) = @{$chunks[1]};
3210                                 if (defined $cond) {
3211                                         substr($block, 0, length($cond), '');
3212                                 }
3213                                 if ($block =~ /^\s*\{/) {
3214                                         #print "APW: ALLOWED: chunk-1 block<$block>\n";
3215                                         $allowed = 1;
3216                                 }
3217                         }
3218                         if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
3219                                 my $herectx = $here . "\n";
3220                                 my $cnt = statement_rawlines($block);
3221
3222                                 for (my $n = 0; $n < $cnt; $n++) {
3223                                         $herectx .= raw_line($linenr, $n) . "\n";
3224                                 }
3225
3226                                 WARN("BRACES",
3227                                      "braces {} are not necessary for single statement blocks\n" . $herectx);
3228                         }
3229                 }
3230
3231 # check for unnecessary blank lines around braces
3232                 if (($line =~ /^..*}\s*$/ && $prevline =~ /^.\s*$/)) {
3233                         CHK("BRACES",
3234                             "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
3235                 }
3236                 if (($line =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
3237                         CHK("BRACES",
3238                             "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
3239                 }
3240
3241 # no volatiles please
3242                 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
3243                 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
3244                         WARN("VOLATILE",
3245                              "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
3246                 }
3247
3248 # warn about #if 0
3249                 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
3250                         CHK("REDUNDANT_CODE",
3251                             "if this code is redundant consider removing it\n" .
3252                                 $herecurr);
3253                 }
3254
3255 # check for needless "if (<foo>) fn(<foo>)" uses
3256                 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
3257                         my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
3258                         if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
3259                                 WARN('NEEDLESS_IF',
3260                                      "$1(NULL) is safe this check is probably not required\n" . $hereprev);
3261                         }
3262                 }
3263
3264 # prefer usleep_range over udelay
3265                 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
3266                         # ignore udelay's < 10, however
3267                         if (! ($1 < 10) ) {
3268                                 CHK("USLEEP_RANGE",
3269                                     "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
3270                         }
3271                 }
3272
3273 # warn about unexpectedly long msleep's
3274                 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
3275                         if ($1 < 20) {
3276                                 WARN("MSLEEP",
3277                                      "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
3278                         }
3279                 }
3280
3281 # warn about #ifdefs in C files
3282 #               if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
3283 #                       print "#ifdef in C files should be avoided\n";
3284 #                       print "$herecurr";
3285 #                       $clean = 0;
3286 #               }
3287
3288 # warn about spacing in #ifdefs
3289                 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
3290                         ERROR("SPACING",
3291                               "exactly one space required after that #$1\n" . $herecurr);
3292                 }
3293
3294 # check for spinlock_t definitions without a comment.
3295                 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
3296                     $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
3297                         my $which = $1;
3298                         if (!ctx_has_comment($first_line, $linenr)) {
3299                                 CHK("UNCOMMENTED_DEFINITION",
3300                                     "$1 definition without comment\n" . $herecurr);
3301                         }
3302                 }
3303 # check for memory barriers without a comment.
3304                 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
3305                         if (!ctx_has_comment($first_line, $linenr)) {
3306                                 CHK("MEMORY_BARRIER",
3307                                     "memory barrier without comment\n" . $herecurr);
3308                         }
3309                 }
3310 # check of hardware specific defines
3311                 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
3312                         CHK("ARCH_DEFINES",
3313                             "architecture specific defines should be avoided\n" .  $herecurr);
3314                 }
3315
3316 # Check that the storage class is at the beginning of a declaration
3317                 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
3318                         WARN("STORAGE_CLASS",
3319                              "storage class should be at the beginning of the declaration\n" . $herecurr)
3320                 }
3321
3322 # check the location of the inline attribute, that it is between
3323 # storage class and type.
3324                 if ($line =~ /\b$Type\s+$Inline\b/ ||
3325                     $line =~ /\b$Inline\s+$Storage\b/) {
3326                         ERROR("INLINE_LOCATION",
3327                               "inline keyword should sit between storage class and type\n" . $herecurr);
3328                 }
3329
3330 # Check for __inline__ and __inline, prefer inline
3331                 if ($line =~ /\b(__inline__|__inline)\b/) {
3332                         WARN("INLINE",
3333                              "plain inline is preferred over $1\n" . $herecurr);
3334                 }
3335
3336 # Check for __attribute__ packed, prefer __packed
3337                 if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
3338                         WARN("PREFER_PACKED",
3339                              "__packed is preferred over __attribute__((packed))\n" . $herecurr);
3340                 }
3341
3342 # Check for __attribute__ aligned, prefer __aligned
3343                 if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
3344                         WARN("PREFER_ALIGNED",
3345                              "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
3346                 }
3347
3348 # Check for __attribute__ format(printf, prefer __printf
3349                 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
3350                         WARN("PREFER_PRINTF",
3351                              "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr);
3352                 }
3353
3354 # Check for __attribute__ format(scanf, prefer __scanf
3355                 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
3356                         WARN("PREFER_SCANF",
3357                              "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr);
3358                 }
3359
3360 # check for sizeof(&)
3361                 if ($line =~ /\bsizeof\s*\(\s*\&/) {
3362                         WARN("SIZEOF_ADDRESS",
3363                              "sizeof(& should be avoided\n" . $herecurr);
3364                 }
3365
3366 # check for sizeof without parenthesis
3367                 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
3368                         WARN("SIZEOF_PARENTHESIS",
3369                              "sizeof $1 should be sizeof($1)\n" . $herecurr);
3370                 }
3371
3372 # check for line continuations in quoted strings with odd counts of "
3373                 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
3374                         WARN("LINE_CONTINUATIONS",
3375                              "Avoid line continuations in quoted strings\n" . $herecurr);
3376                 }
3377
3378 # check for struct spinlock declarations
3379                 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
3380                         WARN("USE_SPINLOCK_T",
3381                              "struct spinlock should be spinlock_t\n" . $herecurr);
3382                 }
3383
3384 # check for seq_printf uses that could be seq_puts
3385                 if ($line =~ /\bseq_printf\s*\(/) {
3386                         my $fmt = get_quoted_string($line, $rawline);
3387                         if ($fmt !~ /[^\\]\%/) {
3388                                 WARN("PREFER_SEQ_PUTS",
3389                                      "Prefer seq_puts to seq_printf\n" . $herecurr);
3390                         }
3391                 }
3392
3393 # Check for misused memsets
3394                 if ($^V && $^V ge 5.10.0 &&
3395                     defined $stat &&
3396                     $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
3397
3398                         my $ms_addr = $2;
3399                         my $ms_val = $7;
3400                         my $ms_size = $12;
3401
3402                         if ($ms_size =~ /^(0x|)0$/i) {
3403                                 ERROR("MEMSET",
3404                                       "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
3405                         } elsif ($ms_size =~ /^(0x|)1$/i) {
3406                                 WARN("MEMSET",
3407                                      "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
3408                         }
3409                 }
3410
3411 # typecasts on min/max could be min_t/max_t
3412                 if ($^V && $^V ge 5.10.0 &&
3413                     defined $stat &&
3414                     $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
3415                         if (defined $2 || defined $7) {
3416                                 my $call = $1;
3417                                 my $cast1 = deparenthesize($2);
3418                                 my $arg1 = $3;
3419                                 my $cast2 = deparenthesize($7);
3420                                 my $arg2 = $8;
3421                                 my $cast;
3422
3423                                 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
3424                                         $cast = "$cast1 or $cast2";
3425                                 } elsif ($cast1 ne "") {
3426                                         $cast = $cast1;
3427                                 } else {
3428                                         $cast = $cast2;
3429                                 }
3430                                 WARN("MINMAX",
3431                                      "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
3432                         }
3433                 }
3434
3435 # check usleep_range arguments
3436                 if ($^V && $^V ge 5.10.0 &&
3437                     defined $stat &&
3438                     $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
3439                         my $min = $1;
3440                         my $max = $7;
3441                         if ($min eq $max) {
3442                                 WARN("USLEEP_RANGE",
3443                                      "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
3444                         } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
3445                                  $min > $max) {
3446                                 WARN("USLEEP_RANGE",
3447                                      "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
3448                         }
3449                 }
3450
3451 # check for new externs in .c files.
3452                 if ($realfile =~ /\.c$/ && defined $stat &&
3453                     $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
3454                 {
3455                         my $function_name = $1;
3456                         my $paren_space = $2;
3457
3458                         my $s = $stat;
3459                         if (defined $cond) {
3460                                 substr($s, 0, length($cond), '');
3461                         }
3462                         if ($s =~ /^\s*;/ &&
3463                             $function_name ne 'uninitialized_var')
3464                         {
3465                                 WARN("AVOID_EXTERNS",
3466                                      "externs should be avoided in .c files\n" .  $herecurr);
3467                         }
3468
3469                         if ($paren_space =~ /\n/) {
3470                                 WARN("FUNCTION_ARGUMENTS",
3471                                      "arguments for function declarations should follow identifier\n" . $herecurr);
3472                         }
3473
3474                 } elsif ($realfile =~ /\.c$/ && defined $stat &&
3475                     $stat =~ /^.\s*extern\s+/)
3476                 {
3477                         WARN("AVOID_EXTERNS",
3478                              "externs should be avoided in .c files\n" .  $herecurr);
3479                 }
3480
3481 # checks for new __setup's
3482                 if ($rawline =~ /\b__setup\("([^"]*)"/) {
3483                         my $name = $1;
3484
3485                         if (!grep(/$name/, @setup_docs)) {
3486                                 CHK("UNDOCUMENTED_SETUP",
3487                                     "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
3488                         }
3489                 }
3490
3491 # check for pointless casting of kmalloc return
3492                 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
3493                         WARN("UNNECESSARY_CASTS",
3494                              "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
3495                 }
3496
3497 # check for krealloc arg reuse
3498                 if ($^V && $^V ge 5.10.0 &&
3499                     $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
3500                         WARN("KREALLOC_ARG_REUSE",
3501                              "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
3502                 }
3503
3504 # check for alloc argument mismatch
3505                 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
3506                         WARN("ALLOC_ARRAY_ARGS",
3507                              "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
3508                 }
3509
3510 # check for multiple semicolons
3511                 if ($line =~ /;\s*;\s*$/) {
3512                         WARN("ONE_SEMICOLON",
3513                              "Statements terminations use 1 semicolon\n" . $herecurr);
3514                 }
3515
3516 # check for switch/default statements without a break;
3517                 if ($^V && $^V ge 5.10.0 &&
3518                     defined $stat &&
3519                     $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
3520                         my $ctx = '';
3521                         my $herectx = $here . "\n";
3522                         my $cnt = statement_rawlines($stat);
3523                         for (my $n = 0; $n < $cnt; $n++) {
3524                                 $herectx .= raw_line($linenr, $n) . "\n";
3525                         }
3526                         WARN("DEFAULT_NO_BREAK",
3527                              "switch default: should use break\n" . $herectx);
3528                 }
3529
3530 # check for gcc specific __FUNCTION__
3531                 if ($line =~ /__FUNCTION__/) {
3532                         WARN("USE_FUNC",
3533                              "__func__ should be used instead of gcc specific __FUNCTION__\n"  . $herecurr);
3534                 }
3535
3536 # check for use of yield()
3537                 if ($line =~ /\byield\s*\(\s*\)/) {
3538                         WARN("YIELD",
3539                              "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n"  . $herecurr);
3540                 }
3541
3542 # check for semaphores initialized locked
3543                 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
3544                         WARN("CONSIDER_COMPLETION",
3545                              "consider using a completion\n" . $herecurr);
3546                 }
3547
3548 # recommend kstrto* over simple_strto* and strict_strto*
3549                 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
3550                         WARN("CONSIDER_KSTRTO",
3551                              "$1 is obsolete, use k$3 instead\n" . $herecurr);
3552                 }
3553
3554 # check for __initcall(), use device_initcall() explicitly please
3555                 if ($line =~ /^.\s*__initcall\s*\(/) {
3556                         WARN("USE_DEVICE_INITCALL",
3557                              "please use device_initcall() instead of __initcall()\n" . $herecurr);
3558                 }
3559
3560 # check for various ops structs, ensure they are const.
3561                 my $struct_ops = qr{acpi_dock_ops|
3562                                 address_space_operations|
3563                                 backlight_ops|
3564                                 block_device_operations|
3565                                 dentry_operations|
3566                                 dev_pm_ops|
3567                                 dma_map_ops|
3568                                 extent_io_ops|
3569                                 file_lock_operations|
3570                                 file_operations|
3571                                 hv_ops|
3572                                 ide_dma_ops|
3573                                 intel_dvo_dev_ops|
3574                                 item_operations|
3575                                 iwl_ops|
3576                                 kgdb_arch|
3577                                 kgdb_io|
3578                                 kset_uevent_ops|
3579                                 lock_manager_operations|
3580                                 microcode_ops|
3581                                 mtrr_ops|
3582                                 neigh_ops|
3583                                 nlmsvc_binding|
3584                                 pci_raw_ops|
3585                                 pipe_buf_operations|
3586                                 platform_hibernation_ops|
3587                                 platform_suspend_ops|
3588                                 proto_ops|
3589                                 rpc_pipe_ops|
3590                                 seq_operations|
3591                                 snd_ac97_build_ops|
3592                                 soc_pcmcia_socket_ops|
3593                                 stacktrace_ops|
3594                                 sysfs_ops|
3595                                 tty_operations|
3596                                 usb_mon_operations|
3597                                 wd_ops}x;
3598                 if ($line !~ /\bconst\b/ &&
3599                     $line =~ /\bstruct\s+($struct_ops)\b/) {
3600                         WARN("CONST_STRUCT",
3601                              "struct $1 should normally be const\n" .
3602                                 $herecurr);
3603                 }
3604
3605 # use of NR_CPUS is usually wrong
3606 # ignore definitions of NR_CPUS and usage to define arrays as likely right
3607                 if ($line =~ /\bNR_CPUS\b/ &&
3608                     $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
3609                     $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
3610                     $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
3611                     $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
3612                     $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
3613                 {
3614                         WARN("NR_CPUS",
3615                              "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
3616                 }
3617
3618 # check for %L{u,d,i} in strings
3619                 my $string;
3620                 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
3621                         $string = substr($rawline, $-[1], $+[1] - $-[1]);
3622                         $string =~ s/%%/__/g;
3623                         if ($string =~ /(?<!%)%L[udi]/) {
3624                                 WARN("PRINTF_L",
3625                                      "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
3626                                 last;
3627                         }
3628                 }
3629
3630 # whine mightly about in_atomic
3631                 if ($line =~ /\bin_atomic\s*\(/) {
3632                         if ($realfile =~ m@^drivers/@) {
3633                                 ERROR("IN_ATOMIC",
3634                                       "do not use in_atomic in drivers\n" . $herecurr);
3635                         } elsif ($realfile !~ m@^kernel/@) {
3636                                 WARN("IN_ATOMIC",
3637                                      "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
3638                         }
3639                 }
3640
3641 # check for lockdep_set_novalidate_class
3642                 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
3643                     $line =~ /__lockdep_no_validate__\s*\)/ ) {
3644                         if ($realfile !~ m@^kernel/lockdep@ &&
3645                             $realfile !~ m@^include/linux/lockdep@ &&
3646                             $realfile !~ m@^drivers/base/core@) {
3647                                 ERROR("LOCKDEP",
3648                                       "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
3649                         }
3650                 }
3651
3652                 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
3653                     $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
3654                         WARN("EXPORTED_WORLD_WRITABLE",
3655                              "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
3656                 }
3657         }
3658
3659         # If we have no input at all, then there is nothing to report on
3660         # so just keep quiet.
3661         if ($#rawlines == -1) {
3662                 exit(0);
3663         }
3664
3665         # In mailback mode only produce a report in the negative, for
3666         # things that appear to be patches.
3667         if ($mailback && ($clean == 1 || !$is_patch)) {
3668                 exit(0);
3669         }
3670
3671         # This is not a patch, and we are are in 'no-patch' mode so
3672         # just keep quiet.
3673         if (!$chk_patch && !$is_patch) {
3674                 exit(0);
3675         }
3676
3677         if (!$is_patch) {
3678                 ERROR("NOT_UNIFIED_DIFF",
3679                       "Does not appear to be a unified-diff format patch\n");
3680         }
3681         if ($is_patch && $chk_signoff && $signoff == 0) {
3682                 ERROR("MISSING_SIGN_OFF",
3683                       "Missing Signed-off-by: line(s)\n");
3684         }
3685
3686         print report_dump();
3687         if ($summary && !($clean == 1 && $quiet == 1)) {
3688                 print "$filename " if ($summary_file);
3689                 print "total: $cnt_error errors, $cnt_warn warnings, " .
3690                         (($check)? "$cnt_chk checks, " : "") .
3691                         "$cnt_lines lines checked\n";
3692                 print "\n" if ($quiet == 0);
3693         }
3694
3695         if ($quiet == 0) {
3696
3697                 if ($^V lt 5.10.0) {
3698                         print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
3699                         print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
3700                 }
3701
3702                 # If there were whitespace errors which cleanpatch can fix
3703                 # then suggest that.
3704                 if ($rpt_cleaners) {
3705                         print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
3706                         print "      scripts/cleanfile\n\n";
3707                         $rpt_cleaners = 0;
3708                 }
3709         }
3710
3711         if ($quiet == 0 && keys %ignore_type) {
3712             print "NOTE: Ignored message types:";
3713             foreach my $ignore (sort keys %ignore_type) {
3714                 print " $ignore";
3715             }
3716             print "\n\n";
3717         }
3718
3719         if ($clean == 1 && $quiet == 0) {
3720                 print "$vname has no obvious style problems and is ready for submission.\n"
3721         }
3722         if ($clean == 0 && $quiet == 0) {
3723                 print << "EOM";
3724 $vname has style problems, please review.
3725
3726 If any of these errors are false positives, please report
3727 them to the maintainer, see CHECKPATCH in MAINTAINERS.
3728 EOM
3729         }
3730
3731         return $clean;
3732 }