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