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