Pileus Git - ~andy/linux/blob - scripts/checkpatch.pl

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