scripts/checkpatch.pl

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