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