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