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