scripts/checkpatch.pl

   1 #!/usr/bin/env perl
   2 # SPDX-License-Identifier: GPL-2.0
   3 #
   4 # (c) 2001, Dave Jones. (the file handling bit)
   5 # (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
   6 # (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
   7 # (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
   8 # (c) 2010-2018 Joe Perches <joe@perches.com>
   9
  10 use strict;
  11 use warnings;
  12 use POSIX;
  13 use File::Basename;
  14 use Cwd 'abs_path';
  15 use Term::ANSIColor qw(:constants);
  16 use Encode qw(decode encode);
  17
  18 my $P = $0;
  19 my $D = dirname(abs_path($P));
  20
  21 my $V = '0.32';
  22
  23 use Getopt::Long qw(:config no_auto_abbrev);
  24
  25 my $quiet = 0;
  26 my $tree = 1;
  27 my $chk_signoff = 1;
  28 my $chk_patch = 1;
  29 my $tst_only;
  30 my $emacs = 0;
  31 my $terse = 0;
  32 my $showfile = 0;
  33 my $file = 0;
  34 my $git = 0;
  35 my %git_commits = ();
  36 my $check = 0;
  37 my $check_orig = 0;
  38 my $summary = 1;
  39 my $mailback = 0;
  40 my $summary_file = 0;
  41 my $show_types = 0;
  42 my $list_types = 0;
  43 my $fix = 0;
  44 my $fix_inplace = 0;
  45 my $root;
  46 my %debug;
  47 my %camelcase = ();
  48 my %use_type = ();
  49 my @use = ();
  50 my %ignore_type = ();
  51 my @ignore = ();
  52 my $help = 0;
  53 my $configuration_file = ".checkpatch.conf";
  54 my $max_line_length = 100;
  55 my $ignore_perl_version = 0;
  56 my $minimum_perl_version = 5.10.0;
  57 my $min_conf_desc_length = 4;
  58 my $spelling_file = "$D/spelling.txt";
  59 my $codespell = 0;
  60 my $codespellfile = "/usr/share/codespell/dictionary.txt";
  61 my $conststructsfile = "$D/const_structs.checkpatch";
  62 my $typedefsfile;
  63 my $color = "auto";
  64 my $allow_c99_comments = 1; # Can be overridden by --ignore C99_COMMENT_TOLERANCE
  65 # git output parsing needs US English output, so first set backtick child process LANGUAGE
  66 my $git_command ='export LANGUAGE=en_US.UTF-8; git';
  67 my $tabsize = 8;
  68
  69 sub help {
  70         my ($exitcode) = @_;
  71
  72         print << "EOM";
  73 Usage: $P [OPTION]... [FILE]...
  74 Version: $V
  75
  76 Options:
  77   -q, --quiet                quiet
  78   --no-tree                  run without a kernel tree
  79   --no-signoff               do not check for 'Signed-off-by' line
  80   --patch                    treat FILE as patchfile (default)
  81   --emacs                    emacs compile window format
  82   --terse                    one line per report
  83   --showfile                 emit diffed file position, not input file position
  84   -g, --git                  treat FILE as a single commit or git revision range
  85                              single git commit with:
  86                                <rev>
  87                                <rev>^
  88                                <rev>~n
  89                              multiple git commits with:
  90                                <rev1>..<rev2>
  91                                <rev1>...<rev2>
  92                                <rev>-<count>
  93                              git merges are ignored
  94   -f, --file                 treat FILE as regular source file
  95   --subjective, --strict     enable more subjective tests
  96   --list-types               list the possible message types
  97   --types TYPE(,TYPE2...)    show only these comma separated message types
  98   --ignore TYPE(,TYPE2...)   ignore various comma separated message types
  99   --show-types               show the specific message type in the output
 100   --max-line-length=n        set the maximum line length, (default $max_line_length)
 101                              if exceeded, warn on patches
 102                              requires --strict for use with --file
 103   --min-conf-desc-length=n   set the min description length, if shorter, warn
 104   --tab-size=n               set the number of spaces for tab (default $tabsize)
 105   --root=PATH                PATH to the kernel tree root
 106   --no-summary               suppress the per-file summary
 107   --mailback                 only produce a report in case of warnings/errors
 108   --summary-file             include the filename in summary
 109   --debug KEY=[0|1]          turn on/off debugging of KEY, where KEY is one of
 110                              'values', 'possible', 'type', and 'attr' (default
 111                              is all off)
 112   --test-only=WORD           report only warnings/errors containing WORD
 113                              literally
 114   --fix                      EXPERIMENTAL - may create horrible results
 115                              If correctable single-line errors exist, create
 116                              "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
 117                              with potential errors corrected to the preferred
 118                              checkpatch style
 119   --fix-inplace              EXPERIMENTAL - may create horrible results
 120                              Is the same as --fix, but overwrites the input
 121                              file.  It's your fault if there's no backup or git
 122   --ignore-perl-version      override checking of perl version.  expect
 123                              runtime errors.
 124   --codespell                Use the codespell dictionary for spelling/typos
 125                              (default:/usr/share/codespell/dictionary.txt)
 126   --codespellfile            Use this codespell dictionary
 127   --typedefsfile             Read additional types from this file
 128   --color[=WHEN]             Use colors 'always', 'never', or only when output
 129                              is a terminal ('auto'). Default is 'auto'.
 130   -h, --help, --version      display this help and exit
 131
 132 When FILE is - read standard input.
 133 EOM
 134
 135         exit($exitcode);
 136 }
 137
 138 sub uniq {
 139         my %seen;
 140         return grep { !$seen{$_}++ } @_;
 141 }
 142
 143 sub list_types {
 144         my ($exitcode) = @_;
 145
 146         my $count = 0;
 147
 148         local $/ = undef;
 149
 150         open(my $script, '<', abs_path($P)) or
 151             die "$P: Can't read '$P' $!\n";
 152
 153         my $text = <$script>;
 154         close($script);
 155
 156         my @types = ();
 157         # Also catch when type or level is passed through a variable
 158         for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
 159                 push (@types, $_);
 160         }
 161         @types = sort(uniq(@types));
 162         print("#\tMessage type\n\n");
 163         foreach my $type (@types) {
 164                 print(++$count . "\t" . $type . "\n");
 165         }
 166
 167         exit($exitcode);
 168 }
 169
 170 my $conf = which_conf($configuration_file);
 171 if (-f $conf) {
 172         my @conf_args;
 173         open(my $conffile, '<', "$conf")
 174             or warn "$P: Can't find a readable $configuration_file file $!\n";
 175
 176         while (<$conffile>) {
 177                 my $line = $_;
 178
 179                 $line =~ s/\s*\n?$//g;
 180                 $line =~ s/^\s*//g;
 181                 $line =~ s/\s+/ /g;
 182
 183                 next if ($line =~ m/^\s*#/);
 184                 next if ($line =~ m/^\s*$/);
 185
 186                 my @words = split(" ", $line);
 187                 foreach my $word (@words) {
 188                         last if ($word =~ m/^#/);
 189                         push (@conf_args, $word);
 190                 }
 191         }
 192         close($conffile);
 193         unshift(@ARGV, @conf_args) if @conf_args;
 194 }
 195
 196 # Perl's Getopt::Long allows options to take optional arguments after a space.
 197 # Prevent --color by itself from consuming other arguments
 198 foreach (@ARGV) {
 199         if ($_ eq "--color" || $_ eq "-color") {
 200                 $_ = "--color=$color";
 201         }
 202 }
 203
 204 GetOptions(
 205         'q|quiet+'      => \$quiet,
 206         'tree!'         => \$tree,
 207         'signoff!'      => \$chk_signoff,
 208         'patch!'        => \$chk_patch,
 209         'emacs!'        => \$emacs,
 210         'terse!'        => \$terse,
 211         'showfile!'     => \$showfile,
 212         'f|file!'       => \$file,
 213         'g|git!'        => \$git,
 214         'subjective!'   => \$check,
 215         'strict!'       => \$check,
 216         'ignore=s'      => \@ignore,
 217         'types=s'       => \@use,
 218         'show-types!'   => \$show_types,
 219         'list-types!'   => \$list_types,
 220         'max-line-length=i' => \$max_line_length,
 221         'min-conf-desc-length=i' => \$min_conf_desc_length,
 222         'tab-size=i'    => \$tabsize,
 223         'root=s'        => \$root,
 224         'summary!'      => \$summary,
 225         'mailback!'     => \$mailback,
 226         'summary-file!' => \$summary_file,
 227         'fix!'          => \$fix,
 228         'fix-inplace!'  => \$fix_inplace,
 229         'ignore-perl-version!' => \$ignore_perl_version,
 230         'debug=s'       => \%debug,
 231         'test-only=s'   => \$tst_only,
 232         'codespell!'    => \$codespell,
 233         'codespellfile=s'       => \$codespellfile,
 234         'typedefsfile=s'        => \$typedefsfile,
 235         'color=s'       => \$color,
 236         'no-color'      => \$color,     #keep old behaviors of -nocolor
 237         'nocolor'       => \$color,     #keep old behaviors of -nocolor
 238         'h|help'        => \$help,
 239         'version'       => \$help
 240 ) or help(1);
 241
 242 help(0) if ($help);
 243
 244 list_types(0) if ($list_types);
 245
 246 $fix = 1 if ($fix_inplace);
 247 $check_orig = $check;
 248
 249 die "$P: --git cannot be used with --file or --fix\n" if ($git && ($file || $fix));
 250
 251 my $exit = 0;
 252
 253 my $perl_version_ok = 1;
 254 if ($^V && $^V lt $minimum_perl_version) {
 255         $perl_version_ok = 0;
 256         printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
 257         exit(1) if (!$ignore_perl_version);
 258 }
 259
 260 #if no filenames are given, push '-' to read patch from stdin
 261 if ($#ARGV < 0) {
 262         push(@ARGV, '-');
 263 }
 264
 265 if ($color =~ /^[01]$/) {
 266         $color = !$color;
 267 } elsif ($color =~ /^always$/i) {
 268         $color = 1;
 269 } elsif ($color =~ /^never$/i) {
 270         $color = 0;
 271 } elsif ($color =~ /^auto$/i) {
 272         $color = (-t STDOUT);
 273 } else {
 274         die "$P: Invalid color mode: $color\n";
 275 }
 276
 277 # skip TAB size 1 to avoid additional checks on $tabsize - 1
 278 die "$P: Invalid TAB size: $tabsize\n" if ($tabsize < 2);
 279
 280 sub hash_save_array_words {
 281         my ($hashRef, $arrayRef) = @_;
 282
 283         my @array = split(/,/, join(',', @$arrayRef));
 284         foreach my $word (@array) {
 285                 $word =~ s/\s*\n?$//g;
 286                 $word =~ s/^\s*//g;
 287                 $word =~ s/\s+/ /g;
 288                 $word =~ tr/[a-z]/[A-Z]/;
 289
 290                 next if ($word =~ m/^\s*#/);
 291                 next if ($word =~ m/^\s*$/);
 292
 293                 $hashRef->{$word}++;
 294         }
 295 }
 296
 297 sub hash_show_words {
 298         my ($hashRef, $prefix) = @_;
 299
 300         if (keys %$hashRef) {
 301                 print "\nNOTE: $prefix message types:";
 302                 foreach my $word (sort keys %$hashRef) {
 303                         print " $word";
 304                 }
 305                 print "\n";
 306         }
 307 }
 308
 309 hash_save_array_words(\%ignore_type, \@ignore);
 310 hash_save_array_words(\%use_type, \@use);
 311
 312 my $dbg_values = 0;
 313 my $dbg_possible = 0;
 314 my $dbg_type = 0;
 315 my $dbg_attr = 0;
 316 for my $key (keys %debug) {
 317         ## no critic
 318         eval "\${dbg_$key} = '$debug{$key}';";
 319         die "$@" if ($@);
 320 }
 321
 322 my $rpt_cleaners = 0;
 323
 324 if ($terse) {
 325         $emacs = 1;
 326         $quiet++;
 327 }
 328
 329 if ($tree) {
 330         if (defined $root) {
 331                 if (!top_of_kernel_tree($root)) {
 332                         die "$P: $root: --root does not point at a valid tree\n";
 333                 }
 334         } else {
 335                 if (top_of_kernel_tree('.')) {
 336                         $root = '.';
 337                 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
 338                                                 top_of_kernel_tree($1)) {
 339                         $root = $1;
 340                 }
 341         }
 342
 343         if (!defined $root) {
 344                 print "Must be run from the top-level dir. of a kernel tree\n";
 345                 exit(2);
 346         }
 347 }
 348
 349 my $emitted_corrupt = 0;
 350
 351 our $Ident      = qr{
 352                         [A-Za-z_][A-Za-z\d_]*
 353                         (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
 354                 }x;
 355 our $Storage    = qr{extern|static|asmlinkage};
 356 our $Sparse     = qr{
 357                         __user|
 358                         __kernel|
 359                         __force|
 360                         __iomem|
 361                         __must_check|
 362                         __kprobes|
 363                         __ref|
 364                         __refconst|
 365                         __refdata|
 366                         __rcu|
 367                         __private
 368                 }x;
 369 our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
 370 our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
 371 our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
 372 our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
 373 our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
 374
 375 # Notes to $Attribute:
 376 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
 377 our $Attribute  = qr{
 378                         const|
 379                         __percpu|
 380                         __nocast|
 381                         __safe|
 382                         __bitwise|
 383                         __packed__|
 384                         __packed2__|
 385                         __naked|
 386                         __maybe_unused|
 387                         __always_unused|
 388                         __noreturn|
 389                         __used|
 390                         __cold|
 391                         __pure|
 392                         __noclone|
 393                         __deprecated|
 394                         __read_mostly|
 395                         __ro_after_init|
 396                         __kprobes|
 397                         $InitAttribute|
 398                         ____cacheline_aligned|
 399                         ____cacheline_aligned_in_smp|
 400                         ____cacheline_internodealigned_in_smp|
 401                         __weak
 402                   }x;
 403 our $Modifier;
 404 our $Inline     = qr{inline|__always_inline|noinline|__inline|__inline__};
 405 our $Member     = qr{->$Ident|\.$Ident|\[[^]]*\]};
 406 our $Lval       = qr{$Ident(?:$Member)*};
 407
 408 our $Int_type   = qr{(?i)llu|ull|ll|lu|ul|l|u};
 409 our $Binary     = qr{(?i)0b[01]+$Int_type?};
 410 our $Hex        = qr{(?i)0x[0-9a-f]+$Int_type?};
 411 our $Int        = qr{[0-9]+$Int_type?};
 412 our $Octal      = qr{0[0-7]+$Int_type?};
 413 our $String     = qr{"[X\t]*"};
 414 our $Float_hex  = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
 415 our $Float_dec  = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
 416 our $Float_int  = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
 417 our $Float      = qr{$Float_hex|$Float_dec|$Float_int};
 418 our $Constant   = qr{$Float|$Binary|$Octal|$Hex|$Int};
 419 our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
 420 our $Compare    = qr{<=|>=|==|!=|<|(?<!-)>};
 421 our $Arithmetic = qr{\+|-|\*|\/|%};
 422 our $Operators  = qr{
 423                         <=|>=|==|!=|
 424                         =>|->|<<|>>|<|>|!|~|
 425                         &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
 426                   }x;
 427
 428 our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
 429
 430 our $BasicType;
 431 our $NonptrType;
 432 our $NonptrTypeMisordered;
 433 our $NonptrTypeWithAttr;
 434 our $Type;
 435 our $TypeMisordered;
 436 our $Declare;
 437 our $DeclareMisordered;
 438
 439 our $NON_ASCII_UTF8     = qr{
 440         [\xC2-\xDF][\x80-\xBF]               # non-overlong 2-byte
 441         |  \xE0[\xA0-\xBF][\x80-\xBF]        # excluding overlongs
 442         | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2}  # straight 3-byte
 443         |  \xED[\x80-\x9F][\x80-\xBF]        # excluding surrogates
 444         |  \xF0[\x90-\xBF][\x80-\xBF]{2}     # planes 1-3
 445         | [\xF1-\xF3][\x80-\xBF]{3}          # planes 4-15
 446         |  \xF4[\x80-\x8F][\x80-\xBF]{2}     # plane 16
 447 }x;
 448
 449 our $UTF8       = qr{
 450         [\x09\x0A\x0D\x20-\x7E]              # ASCII
 451         | $NON_ASCII_UTF8
 452 }x;
 453
 454 our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
 455 our $typeOtherOSTypedefs = qr{(?x:
 456         u_(?:char|short|int|long) |          # bsd
 457         u(?:nchar|short|int|long)            # sysv
 458 )};
 459 our $typeKernelTypedefs = qr{(?x:
 460         (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
 461         atomic_t
 462 )};
 463 our $typeTypedefs = qr{(?x:
 464         $typeC99Typedefs\b|
 465         $typeOtherOSTypedefs\b|
 466         $typeKernelTypedefs\b
 467 )};
 468
 469 our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
 470
 471 our $logFunctions = qr{(?x:
 472         printk(?:_ratelimited|_once|_deferred_once|_deferred|)|
 473         (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
 474         TP_printk|
 475         WARN(?:_RATELIMIT|_ONCE|)|
 476         panic|
 477         MODULE_[A-Z_]+|
 478         seq_vprintf|seq_printf|seq_puts
 479 )};
 480
 481 our $allocFunctions = qr{(?x:
 482         (?:(?:devm_)?
 483                 (?:kv|k|v)[czm]alloc(?:_node|_array)? |
 484                 kstrdup(?:_const)? |
 485                 kmemdup(?:_nul)?) |
 486         (?:\w+)?alloc_skb(?:_ip_align)? |
 487                                 # dev_alloc_skb/netdev_alloc_skb, et al
 488         dma_alloc_coherent
 489 )};
 490
 491 our $signature_tags = qr{(?xi:
 492         Signed-off-by:|
 493         Co-developed-by:|
 494         Acked-by:|
 495         Tested-by:|
 496         Reviewed-by:|
 497         Reported-by:|
 498         Suggested-by:|
 499         To:|
 500         Cc:
 501 )};
 502
 503 our @typeListMisordered = (
 504         qr{char\s+(?:un)?signed},
 505         qr{int\s+(?:(?:un)?signed\s+)?short\s},
 506         qr{int\s+short(?:\s+(?:un)?signed)},
 507         qr{short\s+int(?:\s+(?:un)?signed)},
 508         qr{(?:un)?signed\s+int\s+short},
 509         qr{short\s+(?:un)?signed},
 510         qr{long\s+int\s+(?:un)?signed},
 511         qr{int\s+long\s+(?:un)?signed},
 512         qr{long\s+(?:un)?signed\s+int},
 513         qr{int\s+(?:un)?signed\s+long},
 514         qr{int\s+(?:un)?signed},
 515         qr{int\s+long\s+long\s+(?:un)?signed},
 516         qr{long\s+long\s+int\s+(?:un)?signed},
 517         qr{long\s+long\s+(?:un)?signed\s+int},
 518         qr{long\s+long\s+(?:un)?signed},
 519         qr{long\s+(?:un)?signed},
 520 );
 521
 522 our @typeList = (
 523         qr{void},
 524         qr{(?:(?:un)?signed\s+)?char},
 525         qr{(?:(?:un)?signed\s+)?short\s+int},
 526         qr{(?:(?:un)?signed\s+)?short},
 527         qr{(?:(?:un)?signed\s+)?int},
 528         qr{(?:(?:un)?signed\s+)?long\s+int},
 529         qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
 530         qr{(?:(?:un)?signed\s+)?long\s+long},
 531         qr{(?:(?:un)?signed\s+)?long},
 532         qr{(?:un)?signed},
 533         qr{float},
 534         qr{double},
 535         qr{bool},
 536         qr{struct\s+$Ident},
 537         qr{union\s+$Ident},
 538         qr{enum\s+$Ident},
 539         qr{${Ident}_t},
 540         qr{${Ident}_handler},
 541         qr{${Ident}_handler_fn},
 542         @typeListMisordered,
 543 );
 544
 545 our $C90_int_types = qr{(?x:
 546         long\s+long\s+int\s+(?:un)?signed|
 547         long\s+long\s+(?:un)?signed\s+int|
 548         long\s+long\s+(?:un)?signed|
 549         (?:(?:un)?signed\s+)?long\s+long\s+int|
 550         (?:(?:un)?signed\s+)?long\s+long|
 551         int\s+long\s+long\s+(?:un)?signed|
 552         int\s+(?:(?:un)?signed\s+)?long\s+long|
 553
 554         long\s+int\s+(?:un)?signed|
 555         long\s+(?:un)?signed\s+int|
 556         long\s+(?:un)?signed|
 557         (?:(?:un)?signed\s+)?long\s+int|
 558         (?:(?:un)?signed\s+)?long|
 559         int\s+long\s+(?:un)?signed|
 560         int\s+(?:(?:un)?signed\s+)?long|
 561
 562         int\s+(?:un)?signed|
 563         (?:(?:un)?signed\s+)?int
 564 )};
 565
 566 our @typeListFile = ();
 567 our @typeListWithAttr = (
 568         @typeList,
 569         qr{struct\s+$InitAttribute\s+$Ident},
 570         qr{union\s+$InitAttribute\s+$Ident},
 571 );
 572
 573 our @modifierList = (
 574         qr{fastcall},
 575 );
 576 our @modifierListFile = ();
 577
 578 our @mode_permission_funcs = (
 579         ["module_param", 3],
 580         ["module_param_(?:array|named|string)", 4],
 581         ["module_param_array_named", 5],
 582         ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
 583         ["proc_create(?:_data|)", 2],
 584         ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2],
 585         ["IIO_DEV_ATTR_[A-Z_]+", 1],
 586         ["SENSOR_(?:DEVICE_|)ATTR_2", 2],
 587         ["SENSOR_TEMPLATE(?:_2|)", 3],
 588         ["__ATTR", 2],
 589 );
 590
 591 my $word_pattern = '\b[A-Z]?[a-z]{2,}\b';
 592
 593 #Create a search pattern for all these functions to speed up a loop below
 594 our $mode_perms_search = "";
 595 foreach my $entry (@mode_permission_funcs) {
 596         $mode_perms_search .= '|' if ($mode_perms_search ne "");
 597         $mode_perms_search .= $entry->[0];
 598 }
 599 $mode_perms_search = "(?:${mode_perms_search})";
 600
 601 our %deprecated_apis = (
 602         "synchronize_rcu_bh"                    => "synchronize_rcu",
 603         "synchronize_rcu_bh_expedited"          => "synchronize_rcu_expedited",
 604         "call_rcu_bh"                           => "call_rcu",
 605         "rcu_barrier_bh"                        => "rcu_barrier",
 606         "synchronize_sched"                     => "synchronize_rcu",
 607         "synchronize_sched_expedited"           => "synchronize_rcu_expedited",
 608         "call_rcu_sched"                        => "call_rcu",
 609         "rcu_barrier_sched"                     => "rcu_barrier",
 610         "get_state_synchronize_sched"           => "get_state_synchronize_rcu",
 611         "cond_synchronize_sched"                => "cond_synchronize_rcu",
 612 );
 613
 614 #Create a search pattern for all these strings to speed up a loop below
 615 our $deprecated_apis_search = "";
 616 foreach my $entry (keys %deprecated_apis) {
 617         $deprecated_apis_search .= '|' if ($deprecated_apis_search ne "");
 618         $deprecated_apis_search .= $entry;
 619 }
 620 $deprecated_apis_search = "(?:${deprecated_apis_search})";
 621
 622 our $mode_perms_world_writable = qr{
 623         S_IWUGO         |
 624         S_IWOTH         |
 625         S_IRWXUGO       |
 626         S_IALLUGO       |
 627         0[0-7][0-7][2367]
 628 }x;
 629
 630 our %mode_permission_string_types = (
 631         "S_IRWXU" => 0700,
 632         "S_IRUSR" => 0400,
 633         "S_IWUSR" => 0200,
 634         "S_IXUSR" => 0100,
 635         "S_IRWXG" => 0070,
 636         "S_IRGRP" => 0040,
 637         "S_IWGRP" => 0020,
 638         "S_IXGRP" => 0010,
 639         "S_IRWXO" => 0007,
 640         "S_IROTH" => 0004,
 641         "S_IWOTH" => 0002,
 642         "S_IXOTH" => 0001,
 643         "S_IRWXUGO" => 0777,
 644         "S_IRUGO" => 0444,
 645         "S_IWUGO" => 0222,
 646         "S_IXUGO" => 0111,
 647 );
 648
 649 #Create a search pattern for all these strings to speed up a loop below
 650 our $mode_perms_string_search = "";
 651 foreach my $entry (keys %mode_permission_string_types) {
 652         $mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
 653         $mode_perms_string_search .= $entry;
 654 }
 655 our $single_mode_perms_string_search = "(?:${mode_perms_string_search})";
 656 our $multi_mode_perms_string_search = qr{
 657         ${single_mode_perms_string_search}
 658         (?:\s*\|\s*${single_mode_perms_string_search})*
 659 }x;
 660
 661 sub perms_to_octal {
 662         my ($string) = @_;
 663
 664         return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/);
 665
 666         my $val = "";
 667         my $oval = "";
 668         my $to = 0;
 669         my $curpos = 0;
 670         my $lastpos = 0;
 671         while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
 672                 $curpos = pos($string);
 673                 my $match = $2;
 674                 my $omatch = $1;
 675                 last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
 676                 $lastpos = $curpos;
 677                 $to |= $mode_permission_string_types{$match};
 678                 $val .= '\s*\|\s*' if ($val ne "");
 679                 $val .= $match;
 680                 $oval .= $omatch;
 681         }
 682         $oval =~ s/^\s*\|\s*//;
 683         $oval =~ s/\s*\|\s*$//;
 684         return sprintf("%04o", $to);
 685 }
 686
 687 our $allowed_asm_includes = qr{(?x:
 688         irq|
 689         memory|
 690         time|
 691         reboot
 692 )};
 693 # memory.h: ARM has a custom one
 694
 695 # Load common spelling mistakes and build regular expression list.
 696 my $misspellings;
 697 my %spelling_fix;
 698
 699 if (open(my $spelling, '<', $spelling_file)) {
 700         while (<$spelling>) {
 701                 my $line = $_;
 702
 703                 $line =~ s/\s*\n?$//g;
 704                 $line =~ s/^\s*//g;
 705
 706                 next if ($line =~ m/^\s*#/);
 707                 next if ($line =~ m/^\s*$/);
 708
 709                 my ($suspect, $fix) = split(/\|\|/, $line);
 710
 711                 $spelling_fix{$suspect} = $fix;
 712         }
 713         close($spelling);
 714 } else {
 715         warn "No typos will be found - file '$spelling_file': $!\n";
 716 }
 717
 718 if ($codespell) {
 719         if (open(my $spelling, '<', $codespellfile)) {
 720                 while (<$spelling>) {
 721                         my $line = $_;
 722
 723                         $line =~ s/\s*\n?$//g;
 724                         $line =~ s/^\s*//g;
 725
 726                         next if ($line =~ m/^\s*#/);
 727                         next if ($line =~ m/^\s*$/);
 728                         next if ($line =~ m/, disabled/i);
 729
 730                         $line =~ s/,.*$//;
 731
 732                         my ($suspect, $fix) = split(/->/, $line);
 733
 734                         $spelling_fix{$suspect} = $fix;
 735                 }
 736                 close($spelling);
 737         } else {
 738                 warn "No codespell typos will be found - file '$codespellfile': $!\n";
 739         }
 740 }
 741
 742 $misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
 743
 744 sub read_words {
 745         my ($wordsRef, $file) = @_;
 746
 747         if (open(my $words, '<', $file)) {
 748                 while (<$words>) {
 749                         my $line = $_;
 750
 751                         $line =~ s/\s*\n?$//g;
 752                         $line =~ s/^\s*//g;
 753
 754                         next if ($line =~ m/^\s*#/);
 755                         next if ($line =~ m/^\s*$/);
 756                         if ($line =~ /\s/) {
 757                                 print("$file: '$line' invalid - ignored\n");
 758                                 next;
 759                         }
 760
 761                         $$wordsRef .= '|' if (defined $$wordsRef);
 762                         $$wordsRef .= $line;
 763                 }
 764                 close($file);
 765                 return 1;
 766         }
 767
 768         return 0;
 769 }
 770
 771 my $const_structs;
 772 if (show_type("CONST_STRUCT")) {
 773         read_words(\$const_structs, $conststructsfile)
 774             or warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
 775 }
 776
 777 if (defined($typedefsfile)) {
 778         my $typeOtherTypedefs;
 779         read_words(\$typeOtherTypedefs, $typedefsfile)
 780             or warn "No additional types will be considered - file '$typedefsfile': $!\n";
 781         $typeTypedefs .= '|' . $typeOtherTypedefs if (defined $typeOtherTypedefs);
 782 }
 783
 784 sub build_types {
 785         my $mods = "(?x:  \n" . join("|\n  ", (@modifierList, @modifierListFile)) . "\n)";
 786         my $all = "(?x:  \n" . join("|\n  ", (@typeList, @typeListFile)) . "\n)";
 787         my $Misordered = "(?x:  \n" . join("|\n  ", @typeListMisordered) . "\n)";
 788         my $allWithAttr = "(?x:  \n" . join("|\n  ", @typeListWithAttr) . "\n)";
 789         $Modifier       = qr{(?:$Attribute|$Sparse|$mods)};
 790         $BasicType      = qr{
 791                                 (?:$typeTypedefs\b)|
 792                                 (?:${all}\b)
 793                 }x;
 794         $NonptrType     = qr{
 795                         (?:$Modifier\s+|const\s+)*
 796                         (?:
 797                                 (?:typeof|__typeof__)\s*\([^\)]*\)|
 798                                 (?:$typeTypedefs\b)|
 799                                 (?:${all}\b)
 800                         )
 801                         (?:\s+$Modifier|\s+const)*
 802                   }x;
 803         $NonptrTypeMisordered   = qr{
 804                         (?:$Modifier\s+|const\s+)*
 805                         (?:
 806                                 (?:${Misordered}\b)
 807                         )
 808                         (?:\s+$Modifier|\s+const)*
 809                   }x;
 810         $NonptrTypeWithAttr     = qr{
 811                         (?:$Modifier\s+|const\s+)*
 812                         (?:
 813                                 (?:typeof|__typeof__)\s*\([^\)]*\)|
 814                                 (?:$typeTypedefs\b)|
 815                                 (?:${allWithAttr}\b)
 816                         )
 817                         (?:\s+$Modifier|\s+const)*
 818                   }x;
 819         $Type   = qr{
 820                         $NonptrType
 821                         (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4}
 822                         (?:\s+$Inline|\s+$Modifier)*
 823                   }x;
 824         $TypeMisordered = qr{
 825                         $NonptrTypeMisordered
 826                         (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4}
 827                         (?:\s+$Inline|\s+$Modifier)*
 828                   }x;
 829         $Declare        = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
 830         $DeclareMisordered      = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
 831 }
 832 build_types();
 833
 834 our $Typecast   = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
 835
 836 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
 837 # requires at least perl version v5.10.0
 838 # Any use must be runtime checked with $^V
 839
 840 our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
 841 our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
 842 our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
 843
 844 our $declaration_macros = qr{(?x:
 845         (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
 846         (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(|
 847         (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\(
 848 )};
 849
 850 sub deparenthesize {
 851         my ($string) = @_;
 852         return "" if (!defined($string));
 853
 854         while ($string =~ /^\s*\(.*\)\s*$/) {
 855                 $string =~ s@^\s*\(\s*@@;
 856                 $string =~ s@\s*\)\s*$@@;
 857         }
 858
 859         $string =~ s@\s+@ @g;
 860
 861         return $string;
 862 }
 863
 864 sub seed_camelcase_file {
 865         my ($file) = @_;
 866
 867         return if (!(-f $file));
 868
 869         local $/;
 870
 871         open(my $include_file, '<', "$file")
 872             or warn "$P: Can't read '$file' $!\n";
 873         my $text = <$include_file>;
 874         close($include_file);
 875
 876         my @lines = split('\n', $text);
 877
 878         foreach my $line (@lines) {
 879                 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
 880                 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
 881                         $camelcase{$1} = 1;
 882                 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
 883                         $camelcase{$1} = 1;
 884                 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
 885                         $camelcase{$1} = 1;
 886                 }
 887         }
 888 }
 889
 890 our %maintained_status = ();
 891
 892 sub is_maintained_obsolete {
 893         my ($filename) = @_;
 894
 895         return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl"));
 896
 897         if (!exists($maintained_status{$filename})) {
 898                 $maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
 899         }
 900
 901         return $maintained_status{$filename} =~ /obsolete/i;
 902 }
 903
 904 sub is_SPDX_License_valid {
 905         my ($license) = @_;
 906
 907         return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$root/.git"));
 908
 909         my $root_path = abs_path($root);
 910         my $status = `cd "$root_path"; echo "$license" | python scripts/spdxcheck.py -`;
 911         return 0 if ($status ne "");
 912         return 1;
 913 }
 914
 915 my $camelcase_seeded = 0;
 916 sub seed_camelcase_includes {
 917         return if ($camelcase_seeded);
 918
 919         my $files;
 920         my $camelcase_cache = "";
 921         my @include_files = ();
 922
 923         $camelcase_seeded = 1;
 924
 925         if (-e ".git") {
 926                 my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`;
 927                 chomp $git_last_include_commit;
 928                 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
 929         } else {
 930                 my $last_mod_date = 0;
 931                 $files = `find $root/include -name "*.h"`;
 932                 @include_files = split('\n', $files);
 933                 foreach my $file (@include_files) {
 934                         my $date = POSIX::strftime("%Y%m%d%H%M",
 935                                                    localtime((stat $file)[9]));
 936                         $last_mod_date = $date if ($last_mod_date < $date);
 937                 }
 938                 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
 939         }
 940
 941         if ($camelcase_cache ne "" && -f $camelcase_cache) {
 942                 open(my $camelcase_file, '<', "$camelcase_cache")
 943                     or warn "$P: Can't read '$camelcase_cache' $!\n";
 944                 while (<$camelcase_file>) {
 945                         chomp;
 946                         $camelcase{$_} = 1;
 947                 }
 948                 close($camelcase_file);
 949
 950                 return;
 951         }
 952
 953         if (-e ".git") {
 954                 $files = `${git_command} ls-files "include/*.h"`;
 955                 @include_files = split('\n', $files);
 956         }
 957
 958         foreach my $file (@include_files) {
 959                 seed_camelcase_file($file);
 960         }
 961
 962         if ($camelcase_cache ne "") {
 963                 unlink glob ".checkpatch-camelcase.*";
 964                 open(my $camelcase_file, '>', "$camelcase_cache")
 965                     or warn "$P: Can't write '$camelcase_cache' $!\n";
 966                 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
 967                         print $camelcase_file ("$_\n");
 968                 }
 969                 close($camelcase_file);
 970         }
 971 }
 972
 973 sub git_commit_info {
 974         my ($commit, $id, $desc) = @_;
 975
 976         return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
 977
 978         my $output = `${git_command} log --no-color --format='%H %s' -1 $commit 2>&1`;
 979         $output =~ s/^\s*//gm;
 980         my @lines = split("\n", $output);
 981
 982         return ($id, $desc) if ($#lines < 0);
 983
 984         if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous/) {
 985 # Maybe one day convert this block of bash into something that returns
 986 # all matching commit ids, but it's very slow...
 987 #
 988 #               echo "checking commits $1..."
 989 #               git rev-list --remotes | grep -i "^$1" |
 990 #               while read line ; do
 991 #                   git log --format='%H %s' -1 $line |
 992 #                   echo "commit $(cut -c 1-12,41-)"
 993 #               done
 994         } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
 995                 $id = undef;
 996         } else {
 997                 $id = substr($lines[0], 0, 12);
 998                 $desc = substr($lines[0], 41);
 999         }
1000
1001         return ($id, $desc);
1002 }
1003
1004 $chk_signoff = 0 if ($file);
1005
1006 my @rawlines = ();
1007 my @lines = ();
1008 my @fixed = ();
1009 my @fixed_inserted = ();
1010 my @fixed_deleted = ();
1011 my $fixlinenr = -1;
1012
1013 # If input is git commits, extract all commits from the commit expressions.
1014 # For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
1015 die "$P: No git repository found\n" if ($git && !-e ".git");
1016
1017 if ($git) {
1018         my @commits = ();
1019         foreach my $commit_expr (@ARGV) {
1020                 my $git_range;
1021                 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
1022                         $git_range = "-$2 $1";
1023                 } elsif ($commit_expr =~ m/\.\./) {
1024                         $git_range = "$commit_expr";
1025                 } else {
1026                         $git_range = "-1 $commit_expr";
1027                 }
1028                 my $lines = `${git_command} log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
1029                 foreach my $line (split(/\n/, $lines)) {
1030                         $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
1031                         next if (!defined($1) || !defined($2));
1032                         my $sha1 = $1;
1033                         my $subject = $2;
1034                         unshift(@commits, $sha1);
1035                         $git_commits{$sha1} = $subject;
1036                 }
1037         }
1038         die "$P: no git commits after extraction!\n" if (@commits == 0);
1039         @ARGV = @commits;
1040 }
1041
1042 my $vname;
1043 $allow_c99_comments = !defined $ignore_type{"C99_COMMENT_TOLERANCE"};
1044 for my $filename (@ARGV) {
1045         my $FILE;
1046         if ($git) {
1047                 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
1048                         die "$P: $filename: git format-patch failed - $!\n";
1049         } elsif ($file) {
1050                 open($FILE, '-|', "diff -u /dev/null $filename") ||
1051                         die "$P: $filename: diff failed - $!\n";
1052         } elsif ($filename eq '-') {
1053                 open($FILE, '<&STDIN');
1054         } else {
1055                 open($FILE, '<', "$filename") ||
1056                         die "$P: $filename: open failed - $!\n";
1057         }
1058         if ($filename eq '-') {
1059                 $vname = 'Your patch';
1060         } elsif ($git) {
1061                 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
1062         } else {
1063                 $vname = $filename;
1064         }
1065         while (<$FILE>) {
1066                 chomp;
1067                 push(@rawlines, $_);
1068                 $vname = qq("$1") if ($filename eq '-' && $_ =~ m/^Subject:\s+(.+)/i);
1069         }
1070         close($FILE);
1071
1072         if ($#ARGV > 0 && $quiet == 0) {
1073                 print '-' x length($vname) . "\n";
1074                 print "$vname\n";
1075                 print '-' x length($vname) . "\n";
1076         }
1077
1078         if (!process($filename)) {
1079                 $exit = 1;
1080         }
1081         @rawlines = ();
1082         @lines = ();
1083         @fixed = ();
1084         @fixed_inserted = ();
1085         @fixed_deleted = ();
1086         $fixlinenr = -1;
1087         @modifierListFile = ();
1088         @typeListFile = ();
1089         build_types();
1090 }
1091
1092 if (!$quiet) {
1093         hash_show_words(\%use_type, "Used");
1094         hash_show_words(\%ignore_type, "Ignored");
1095
1096         if (!$perl_version_ok) {
1097                 print << "EOM"
1098
1099 NOTE: perl $^V is not modern enough to detect all possible issues.
1100       An upgrade to at least perl $minimum_perl_version is suggested.
1101 EOM
1102         }
1103         if ($exit) {
1104                 print << "EOM"
1105
1106 NOTE: If any of the errors are false positives, please report
1107       them to the maintainer, see CHECKPATCH in MAINTAINERS.
1108 EOM
1109         }
1110 }
1111
1112 exit($exit);
1113
1114 sub top_of_kernel_tree {
1115         my ($root) = @_;
1116
1117         my @tree_check = (
1118                 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
1119                 "README", "Documentation", "arch", "include", "drivers",
1120                 "fs", "init", "ipc", "kernel", "lib", "scripts",
1121         );
1122
1123         foreach my $check (@tree_check) {
1124                 if (! -e $root . '/' . $check) {
1125                         return 0;
1126                 }
1127         }
1128         return 1;
1129 }
1130
1131 sub parse_email {
1132         my ($formatted_email) = @_;
1133
1134         my $name = "";
1135         my $name_comment = "";
1136         my $address = "";
1137         my $comment = "";
1138
1139         if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
1140                 $name = $1;
1141                 $address = $2;
1142                 $comment = $3 if defined $3;
1143         } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
1144                 $address = $1;
1145                 $comment = $2 if defined $2;
1146         } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
1147                 $address = $1;
1148                 $comment = $2 if defined $2;
1149                 $formatted_email =~ s/\Q$address\E.*$//;
1150                 $name = $formatted_email;
1151                 $name = trim($name);
1152                 $name =~ s/^\"|\"$//g;
1153                 # If there's a name left after stripping spaces and
1154                 # leading quotes, and the address doesn't have both
1155                 # leading and trailing angle brackets, the address
1156                 # is invalid. ie:
1157                 #   "joe smith joe@smith.com" bad
1158                 #   "joe smith <joe@smith.com" bad
1159                 if ($name ne "" && $address !~ /^<[^>]+>$/) {
1160                         $name = "";
1161                         $address = "";
1162                         $comment = "";
1163                 }
1164         }
1165
1166         $name = trim($name);
1167         $name =~ s/^\"|\"$//g;
1168         $name =~ s/(\s*\([^\)]+\))\s*//;
1169         if (defined($1)) {
1170                 $name_comment = trim($1);
1171         }
1172         $address = trim($address);
1173         $address =~ s/^\<|\>$//g;
1174
1175         if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1176                 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1177                 $name = "\"$name\"";
1178         }
1179
1180         return ($name, $name_comment, $address, $comment);
1181 }
1182
1183 sub format_email {
1184         my ($name, $address) = @_;
1185
1186         my $formatted_email;
1187
1188         $name = trim($name);
1189         $name =~ s/^\"|\"$//g;
1190         $address = trim($address);
1191
1192         if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1193                 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1194                 $name = "\"$name\"";
1195         }
1196
1197         if ("$name" eq "") {
1198                 $formatted_email = "$address";
1199         } else {
1200                 $formatted_email = "$name <$address>";
1201         }
1202
1203         return $formatted_email;
1204 }
1205
1206 sub reformat_email {
1207         my ($email) = @_;
1208
1209         my ($email_name, $name_comment, $email_address, $comment) = parse_email($email);
1210         return format_email($email_name, $email_address);
1211 }
1212
1213 sub same_email_addresses {
1214         my ($email1, $email2) = @_;
1215
1216         my ($email1_name, $name1_comment, $email1_address, $comment1) = parse_email($email1);
1217         my ($email2_name, $name2_comment, $email2_address, $comment2) = parse_email($email2);
1218
1219         return $email1_name eq $email2_name &&
1220                $email1_address eq $email2_address;
1221 }
1222
1223 sub which {
1224         my ($bin) = @_;
1225
1226         foreach my $path (split(/:/, $ENV{PATH})) {
1227                 if (-e "$path/$bin") {
1228                         return "$path/$bin";
1229                 }
1230         }
1231
1232         return "";
1233 }
1234
1235 sub which_conf {
1236         my ($conf) = @_;
1237
1238         foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1239                 if (-e "$path/$conf") {
1240                         return "$path/$conf";
1241                 }
1242         }
1243
1244         return "";
1245 }
1246
1247 sub expand_tabs {
1248         my ($str) = @_;
1249
1250         my $res = '';
1251         my $n = 0;
1252         for my $c (split(//, $str)) {
1253                 if ($c eq "\t") {
1254                         $res .= ' ';
1255                         $n++;
1256                         for (; ($n % $tabsize) != 0; $n++) {
1257                                 $res .= ' ';
1258                         }
1259                         next;
1260                 }
1261                 $res .= $c;
1262                 $n++;
1263         }
1264
1265         return $res;
1266 }
1267 sub copy_spacing {
1268         (my $res = shift) =~ tr/\t/ /c;
1269         return $res;
1270 }
1271
1272 sub line_stats {
1273         my ($line) = @_;
1274
1275         # Drop the diff line leader and expand tabs
1276         $line =~ s/^.//;
1277         $line = expand_tabs($line);
1278
1279         # Pick the indent from the front of the line.
1280         my ($white) = ($line =~ /^(\s*)/);
1281
1282         return (length($line), length($white));
1283 }
1284
1285 my $sanitise_quote = '';
1286
1287 sub sanitise_line_reset {
1288         my ($in_comment) = @_;
1289
1290         if ($in_comment) {
1291                 $sanitise_quote = '*/';
1292         } else {
1293                 $sanitise_quote = '';
1294         }
1295 }
1296 sub sanitise_line {
1297         my ($line) = @_;
1298
1299         my $res = '';
1300         my $l = '';
1301
1302         my $qlen = 0;
1303         my $off = 0;
1304         my $c;
1305
1306         # Always copy over the diff marker.
1307         $res = substr($line, 0, 1);
1308
1309         for ($off = 1; $off < length($line); $off++) {
1310                 $c = substr($line, $off, 1);
1311
1312                 # Comments we are whacking completely including the begin
1313                 # and end, all to $;.
1314                 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1315                         $sanitise_quote = '*/';
1316
1317                         substr($res, $off, 2, "$;$;");
1318                         $off++;
1319                         next;
1320                 }
1321                 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
1322                         $sanitise_quote = '';
1323                         substr($res, $off, 2, "$;$;");
1324                         $off++;
1325                         next;
1326                 }
1327                 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1328                         $sanitise_quote = '//';
1329
1330                         substr($res, $off, 2, $sanitise_quote);
1331                         $off++;
1332                         next;
1333                 }
1334
1335                 # A \ in a string means ignore the next character.
1336                 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1337                     $c eq "\\") {
1338                         substr($res, $off, 2, 'XX');
1339                         $off++;
1340                         next;
1341                 }
1342                 # Regular quotes.
1343                 if ($c eq "'" || $c eq '"') {
1344                         if ($sanitise_quote eq '') {
1345                                 $sanitise_quote = $c;
1346
1347                                 substr($res, $off, 1, $c);
1348                                 next;
1349                         } elsif ($sanitise_quote eq $c) {
1350                                 $sanitise_quote = '';
1351                         }
1352                 }
1353
1354                 #print "c<$c> SQ<$sanitise_quote>\n";
1355                 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1356                         substr($res, $off, 1, $;);
1357                 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1358                         substr($res, $off, 1, $;);
1359                 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1360                         substr($res, $off, 1, 'X');
1361                 } else {
1362                         substr($res, $off, 1, $c);
1363                 }
1364         }
1365
1366         if ($sanitise_quote eq '//') {
1367                 $sanitise_quote = '';
1368         }
1369
1370         # The pathname on a #include may be surrounded by '<' and '>'.
1371         if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
1372                 my $clean = 'X' x length($1);
1373                 $res =~ s@\<.*\>@<$clean>@;
1374
1375         # The whole of a #error is a string.
1376         } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
1377                 my $clean = 'X' x length($1);
1378                 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
1379         }
1380
1381         if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1382                 my $match = $1;
1383                 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1384         }
1385
1386         return $res;
1387 }
1388
1389 sub get_quoted_string {
1390         my ($line, $rawline) = @_;
1391
1392         return "" if (!defined($line) || !defined($rawline));
1393         return "" if ($line !~ m/($String)/g);
1394         return substr($rawline, $-[0], $+[0] - $-[0]);
1395 }
1396
1397 sub ctx_statement_block {
1398         my ($linenr, $remain, $off) = @_;
1399         my $line = $linenr - 1;
1400         my $blk = '';
1401         my $soff = $off;
1402         my $coff = $off - 1;
1403         my $coff_set = 0;
1404
1405         my $loff = 0;
1406
1407         my $type = '';
1408         my $level = 0;
1409         my @stack = ();
1410         my $p;
1411         my $c;
1412         my $len = 0;
1413
1414         my $remainder;
1415         while (1) {
1416                 @stack = (['', 0]) if ($#stack == -1);
1417
1418                 #warn "CSB: blk<$blk> remain<$remain>\n";
1419                 # If we are about to drop off the end, pull in more
1420                 # context.
1421                 if ($off >= $len) {
1422                         for (; $remain > 0; $line++) {
1423                                 last if (!defined $lines[$line]);
1424                                 next if ($lines[$line] =~ /^-/);
1425                                 $remain--;
1426                                 $loff = $len;
1427                                 $blk .= $lines[$line] . "\n";
1428                                 $len = length($blk);
1429                                 $line++;
1430                                 last;
1431                         }
1432                         # Bail if there is no further context.
1433                         #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1434                         if ($off >= $len) {
1435                                 last;
1436                         }
1437                         if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1438                                 $level++;
1439                                 $type = '#';
1440                         }
1441                 }
1442                 $p = $c;
1443                 $c = substr($blk, $off, 1);
1444                 $remainder = substr($blk, $off);
1445
1446                 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1447
1448                 # Handle nested #if/#else.
1449                 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1450                         push(@stack, [ $type, $level ]);
1451                 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1452                         ($type, $level) = @{$stack[$#stack - 1]};
1453                 } elsif ($remainder =~ /^#\s*endif\b/) {
1454                         ($type, $level) = @{pop(@stack)};
1455                 }
1456
1457                 # Statement ends at the ';' or a close '}' at the
1458                 # outermost level.
1459                 if ($level == 0 && $c eq ';') {
1460                         last;
1461                 }
1462
1463                 # An else is really a conditional as long as its not else if
1464                 if ($level == 0 && $coff_set == 0 &&
1465                                 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1466                                 $remainder =~ /^(else)(?:\s|{)/ &&
1467                                 $remainder !~ /^else\s+if\b/) {
1468                         $coff = $off + length($1) - 1;
1469                         $coff_set = 1;
1470                         #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1471                         #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1472                 }
1473
1474                 if (($type eq '' || $type eq '(') && $c eq '(') {
1475                         $level++;
1476                         $type = '(';
1477                 }
1478                 if ($type eq '(' && $c eq ')') {
1479                         $level--;
1480                         $type = ($level != 0)? '(' : '';
1481
1482                         if ($level == 0 && $coff < $soff) {
1483                                 $coff = $off;
1484                                 $coff_set = 1;
1485                                 #warn "CSB: mark coff<$coff>\n";
1486                         }
1487                 }
1488                 if (($type eq '' || $type eq '{') && $c eq '{') {
1489                         $level++;
1490                         $type = '{';
1491                 }
1492                 if ($type eq '{' && $c eq '}') {
1493                         $level--;
1494                         $type = ($level != 0)? '{' : '';
1495
1496                         if ($level == 0) {
1497                                 if (substr($blk, $off + 1, 1) eq ';') {
1498                                         $off++;
1499                                 }
1500                                 last;
1501                         }
1502                 }
1503                 # Preprocessor commands end at the newline unless escaped.
1504                 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1505                         $level--;
1506                         $type = '';
1507                         $off++;
1508                         last;
1509                 }
1510                 $off++;
1511         }
1512         # We are truly at the end, so shuffle to the next line.
1513         if ($off == $len) {
1514                 $loff = $len + 1;
1515                 $line++;
1516                 $remain--;
1517         }
1518
1519         my $statement = substr($blk, $soff, $off - $soff + 1);
1520         my $condition = substr($blk, $soff, $coff - $soff + 1);
1521
1522         #warn "STATEMENT<$statement>\n";
1523         #warn "CONDITION<$condition>\n";
1524
1525         #print "coff<$coff> soff<$off> loff<$loff>\n";
1526
1527         return ($statement, $condition,
1528                         $line, $remain + 1, $off - $loff + 1, $level);
1529 }
1530
1531 sub statement_lines {
1532         my ($stmt) = @_;
1533
1534         # Strip the diff line prefixes and rip blank lines at start and end.
1535         $stmt =~ s/(^|\n)./$1/g;
1536         $stmt =~ s/^\s*//;
1537         $stmt =~ s/\s*$//;
1538
1539         my @stmt_lines = ($stmt =~ /\n/g);
1540
1541         return $#stmt_lines + 2;
1542 }
1543
1544 sub statement_rawlines {
1545         my ($stmt) = @_;
1546
1547         my @stmt_lines = ($stmt =~ /\n/g);
1548
1549         return $#stmt_lines + 2;
1550 }
1551
1552 sub statement_block_size {
1553         my ($stmt) = @_;
1554
1555         $stmt =~ s/(^|\n)./$1/g;
1556         $stmt =~ s/^\s*{//;
1557         $stmt =~ s/}\s*$//;
1558         $stmt =~ s/^\s*//;
1559         $stmt =~ s/\s*$//;
1560
1561         my @stmt_lines = ($stmt =~ /\n/g);
1562         my @stmt_statements = ($stmt =~ /;/g);
1563
1564         my $stmt_lines = $#stmt_lines + 2;
1565         my $stmt_statements = $#stmt_statements + 1;
1566
1567         if ($stmt_lines > $stmt_statements) {
1568                 return $stmt_lines;
1569         } else {
1570                 return $stmt_statements;
1571         }
1572 }
1573
1574 sub ctx_statement_full {
1575         my ($linenr, $remain, $off) = @_;
1576         my ($statement, $condition, $level);
1577
1578         my (@chunks);
1579
1580         # Grab the first conditional/block pair.
1581         ($statement, $condition, $linenr, $remain, $off, $level) =
1582                                 ctx_statement_block($linenr, $remain, $off);
1583         #print "F: c<$condition> s<$statement> remain<$remain>\n";
1584         push(@chunks, [ $condition, $statement ]);
1585         if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1586                 return ($level, $linenr, @chunks);
1587         }
1588
1589         # Pull in the following conditional/block pairs and see if they
1590         # could continue the statement.
1591         for (;;) {
1592                 ($statement, $condition, $linenr, $remain, $off, $level) =
1593                                 ctx_statement_block($linenr, $remain, $off);
1594                 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1595                 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1596                 #print "C: push\n";
1597                 push(@chunks, [ $condition, $statement ]);
1598         }
1599
1600         return ($level, $linenr, @chunks);
1601 }
1602
1603 sub ctx_block_get {
1604         my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1605         my $line;
1606         my $start = $linenr - 1;
1607         my $blk = '';
1608         my @o;
1609         my @c;
1610         my @res = ();
1611
1612         my $level = 0;
1613         my @stack = ($level);
1614         for ($line = $start; $remain > 0; $line++) {
1615                 next if ($rawlines[$line] =~ /^-/);
1616                 $remain--;
1617
1618                 $blk .= $rawlines[$line];
1619
1620                 # Handle nested #if/#else.
1621                 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1622                         push(@stack, $level);
1623                 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1624                         $level = $stack[$#stack - 1];
1625                 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1626                         $level = pop(@stack);
1627                 }
1628
1629                 foreach my $c (split(//, $lines[$line])) {
1630                         ##print "C<$c>L<$level><$open$close>O<$off>\n";
1631                         if ($off > 0) {
1632                                 $off--;
1633                                 next;
1634                         }
1635
1636                         if ($c eq $close && $level > 0) {
1637                                 $level--;
1638                                 last if ($level == 0);
1639                         } elsif ($c eq $open) {
1640                                 $level++;
1641                         }
1642                 }
1643
1644                 if (!$outer || $level <= 1) {
1645                         push(@res, $rawlines[$line]);
1646                 }
1647
1648                 last if ($level == 0);
1649         }
1650
1651         return ($level, @res);
1652 }
1653 sub ctx_block_outer {
1654         my ($linenr, $remain) = @_;
1655
1656         my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1657         return @r;
1658 }
1659 sub ctx_block {
1660         my ($linenr, $remain) = @_;
1661
1662         my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1663         return @r;
1664 }
1665 sub ctx_statement {
1666         my ($linenr, $remain, $off) = @_;
1667
1668         my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1669         return @r;
1670 }
1671 sub ctx_block_level {
1672         my ($linenr, $remain) = @_;
1673
1674         return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1675 }
1676 sub ctx_statement_level {
1677         my ($linenr, $remain, $off) = @_;
1678
1679         return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1680 }
1681
1682 sub ctx_locate_comment {
1683         my ($first_line, $end_line) = @_;
1684
1685         # If c99 comment on the current line, or the line before or after
1686         my ($current_comment) = ($rawlines[$end_line - 1] =~ m@^\+.*(//.*$)@);
1687         return $current_comment if (defined $current_comment);
1688         ($current_comment) = ($rawlines[$end_line - 2] =~ m@^[\+ ].*(//.*$)@);
1689         return $current_comment if (defined $current_comment);
1690         ($current_comment) = ($rawlines[$end_line] =~ m@^[\+ ].*(//.*$)@);
1691         return $current_comment if (defined $current_comment);
1692
1693         # Catch a comment on the end of the line itself.
1694         ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1695         return $current_comment if (defined $current_comment);
1696
1697         # Look through the context and try and figure out if there is a
1698         # comment.
1699         my $in_comment = 0;
1700         $current_comment = '';
1701         for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1702                 my $line = $rawlines[$linenr - 1];
1703                 #warn "           $line\n";
1704                 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1705                         $in_comment = 1;
1706                 }
1707                 if ($line =~ m@/\*@) {
1708                         $in_comment = 1;
1709                 }
1710                 if (!$in_comment && $current_comment ne '') {
1711                         $current_comment = '';
1712                 }
1713                 $current_comment .= $line . "\n" if ($in_comment);
1714                 if ($line =~ m@\*/@) {
1715                         $in_comment = 0;
1716                 }
1717         }
1718
1719         chomp($current_comment);
1720         return($current_comment);
1721 }
1722 sub ctx_has_comment {
1723         my ($first_line, $end_line) = @_;
1724         my $cmt = ctx_locate_comment($first_line, $end_line);
1725
1726         ##print "LINE: $rawlines[$end_line - 1 ]\n";
1727         ##print "CMMT: $cmt\n";
1728
1729         return ($cmt ne '');
1730 }
1731
1732 sub raw_line {
1733         my ($linenr, $cnt) = @_;
1734
1735         my $offset = $linenr - 1;
1736         $cnt++;
1737
1738         my $line;
1739         while ($cnt) {
1740                 $line = $rawlines[$offset++];
1741                 next if (defined($line) && $line =~ /^-/);
1742                 $cnt--;
1743         }
1744
1745         return $line;
1746 }
1747
1748 sub get_stat_real {
1749         my ($linenr, $lc) = @_;
1750
1751         my $stat_real = raw_line($linenr, 0);
1752         for (my $count = $linenr + 1; $count <= $lc; $count++) {
1753                 $stat_real = $stat_real . "\n" . raw_line($count, 0);
1754         }
1755
1756         return $stat_real;
1757 }
1758
1759 sub get_stat_here {
1760         my ($linenr, $cnt, $here) = @_;
1761
1762         my $herectx = $here . "\n";
1763         for (my $n = 0; $n < $cnt; $n++) {
1764                 $herectx .= raw_line($linenr, $n) . "\n";
1765         }
1766
1767         return $herectx;
1768 }
1769
1770 sub cat_vet {
1771         my ($vet) = @_;
1772         my ($res, $coded);
1773
1774         $res = '';
1775         while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1776                 $res .= $1;
1777                 if ($2 ne '') {
1778                         $coded = sprintf("^%c", unpack('C', $2) + 64);
1779                         $res .= $coded;
1780                 }
1781         }
1782         $res =~ s/$/\$/;
1783
1784         return $res;
1785 }
1786
1787 my $av_preprocessor = 0;
1788 my $av_pending;
1789 my @av_paren_type;
1790 my $av_pend_colon;
1791
1792 sub annotate_reset {
1793         $av_preprocessor = 0;
1794         $av_pending = '_';
1795         @av_paren_type = ('E');
1796         $av_pend_colon = 'O';
1797 }
1798
1799 sub annotate_values {
1800         my ($stream, $type) = @_;
1801
1802         my $res;
1803         my $var = '_' x length($stream);
1804         my $cur = $stream;
1805
1806         print "$stream\n" if ($dbg_values > 1);
1807
1808         while (length($cur)) {
1809                 @av_paren_type = ('E') if ($#av_paren_type < 0);
1810                 print " <" . join('', @av_paren_type) .
1811                                 "> <$type> <$av_pending>" if ($dbg_values > 1);
1812                 if ($cur =~ /^(\s+)/o) {
1813                         print "WS($1)\n" if ($dbg_values > 1);
1814                         if ($1 =~ /\n/ && $av_preprocessor) {
1815                                 $type = pop(@av_paren_type);
1816                                 $av_preprocessor = 0;
1817                         }
1818
1819                 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1820                         print "CAST($1)\n" if ($dbg_values > 1);
1821                         push(@av_paren_type, $type);
1822                         $type = 'c';
1823
1824                 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1825                         print "DECLARE($1)\n" if ($dbg_values > 1);
1826                         $type = 'T';
1827
1828                 } elsif ($cur =~ /^($Modifier)\s*/) {
1829                         print "MODIFIER($1)\n" if ($dbg_values > 1);
1830                         $type = 'T';
1831
1832                 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1833                         print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1834                         $av_preprocessor = 1;
1835                         push(@av_paren_type, $type);
1836                         if ($2 ne '') {
1837                                 $av_pending = 'N';
1838                         }
1839                         $type = 'E';
1840
1841                 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1842                         print "UNDEF($1)\n" if ($dbg_values > 1);
1843                         $av_preprocessor = 1;
1844                         push(@av_paren_type, $type);
1845
1846                 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1847                         print "PRE_START($1)\n" if ($dbg_values > 1);
1848                         $av_preprocessor = 1;
1849
1850                         push(@av_paren_type, $type);
1851                         push(@av_paren_type, $type);
1852                         $type = 'E';
1853
1854                 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1855                         print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1856                         $av_preprocessor = 1;
1857
1858                         push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1859
1860                         $type = 'E';
1861
1862                 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1863                         print "PRE_END($1)\n" if ($dbg_values > 1);
1864
1865                         $av_preprocessor = 1;
1866
1867                         # Assume all arms of the conditional end as this
1868                         # one does, and continue as if the #endif was not here.
1869                         pop(@av_paren_type);
1870                         push(@av_paren_type, $type);
1871                         $type = 'E';
1872
1873                 } elsif ($cur =~ /^(\\\n)/o) {
1874                         print "PRECONT($1)\n" if ($dbg_values > 1);
1875
1876                 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1877                         print "ATTR($1)\n" if ($dbg_values > 1);
1878                         $av_pending = $type;
1879                         $type = 'N';
1880
1881                 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1882                         print "SIZEOF($1)\n" if ($dbg_values > 1);
1883                         if (defined $2) {
1884                                 $av_pending = 'V';
1885                         }
1886                         $type = 'N';
1887
1888                 } elsif ($cur =~ /^(if|while|for)\b/o) {
1889                         print "COND($1)\n" if ($dbg_values > 1);
1890                         $av_pending = 'E';
1891                         $type = 'N';
1892
1893                 } elsif ($cur =~/^(case)/o) {
1894                         print "CASE($1)\n" if ($dbg_values > 1);
1895                         $av_pend_colon = 'C';
1896                         $type = 'N';
1897
1898                 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1899                         print "KEYWORD($1)\n" if ($dbg_values > 1);
1900                         $type = 'N';
1901
1902                 } elsif ($cur =~ /^(\()/o) {
1903                         print "PAREN('$1')\n" if ($dbg_values > 1);
1904                         push(@av_paren_type, $av_pending);
1905                         $av_pending = '_';
1906                         $type = 'N';
1907
1908                 } elsif ($cur =~ /^(\))/o) {
1909                         my $new_type = pop(@av_paren_type);
1910                         if ($new_type ne '_') {
1911                                 $type = $new_type;
1912                                 print "PAREN('$1') -> $type\n"
1913                                                         if ($dbg_values > 1);
1914                         } else {
1915                                 print "PAREN('$1')\n" if ($dbg_values > 1);
1916                         }
1917
1918                 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1919                         print "FUNC($1)\n" if ($dbg_values > 1);
1920                         $type = 'V';
1921                         $av_pending = 'V';
1922
1923                 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1924                         if (defined $2 && $type eq 'C' || $type eq 'T') {
1925                                 $av_pend_colon = 'B';
1926                         } elsif ($type eq 'E') {
1927                                 $av_pend_colon = 'L';
1928                         }
1929                         print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1930                         $type = 'V';
1931
1932                 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1933                         print "IDENT($1)\n" if ($dbg_values > 1);
1934                         $type = 'V';
1935
1936                 } elsif ($cur =~ /^($Assignment)/o) {
1937                         print "ASSIGN($1)\n" if ($dbg_values > 1);
1938                         $type = 'N';
1939
1940                 } elsif ($cur =~/^(;|{|})/) {
1941                         print "END($1)\n" if ($dbg_values > 1);
1942                         $type = 'E';
1943                         $av_pend_colon = 'O';
1944
1945                 } elsif ($cur =~/^(,)/) {
1946                         print "COMMA($1)\n" if ($dbg_values > 1);
1947                         $type = 'C';
1948
1949                 } elsif ($cur =~ /^(\?)/o) {
1950                         print "QUESTION($1)\n" if ($dbg_values > 1);
1951                         $type = 'N';
1952
1953                 } elsif ($cur =~ /^(:)/o) {
1954                         print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1955
1956                         substr($var, length($res), 1, $av_pend_colon);
1957                         if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1958                                 $type = 'E';
1959                         } else {
1960                                 $type = 'N';
1961                         }
1962                         $av_pend_colon = 'O';
1963
1964                 } elsif ($cur =~ /^(\[)/o) {
1965                         print "CLOSE($1)\n" if ($dbg_values > 1);
1966                         $type = 'N';
1967
1968                 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1969                         my $variant;
1970
1971                         print "OPV($1)\n" if ($dbg_values > 1);
1972                         if ($type eq 'V') {
1973                                 $variant = 'B';
1974                         } else {
1975                                 $variant = 'U';
1976                         }
1977
1978                         substr($var, length($res), 1, $variant);
1979                         $type = 'N';
1980
1981                 } elsif ($cur =~ /^($Operators)/o) {
1982                         print "OP($1)\n" if ($dbg_values > 1);
1983                         if ($1 ne '++' && $1 ne '--') {
1984                                 $type = 'N';
1985                         }
1986
1987                 } elsif ($cur =~ /(^.)/o) {
1988                         print "C($1)\n" if ($dbg_values > 1);
1989                 }
1990                 if (defined $1) {
1991                         $cur = substr($cur, length($1));
1992                         $res .= $type x length($1);
1993                 }
1994         }
1995
1996         return ($res, $var);
1997 }
1998
1999 sub possible {
2000         my ($possible, $line) = @_;
2001         my $notPermitted = qr{(?:
2002                 ^(?:
2003                         $Modifier|
2004                         $Storage|
2005                         $Type|
2006                         DEFINE_\S+
2007                 )$|
2008                 ^(?:
2009                         goto|
2010                         return|
2011                         case|
2012                         else|
2013                         asm|__asm__|
2014                         do|
2015                         \#|
2016                         \#\#|
2017                 )(?:\s|$)|
2018                 ^(?:typedef|struct|enum)\b
2019             )}x;
2020         warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
2021         if ($possible !~ $notPermitted) {
2022                 # Check for modifiers.
2023                 $possible =~ s/\s*$Storage\s*//g;
2024                 $possible =~ s/\s*$Sparse\s*//g;
2025                 if ($possible =~ /^\s*$/) {
2026
2027                 } elsif ($possible =~ /\s/) {
2028                         $possible =~ s/\s*$Type\s*//g;
2029                         for my $modifier (split(' ', $possible)) {
2030                                 if ($modifier !~ $notPermitted) {
2031                                         warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
2032                                         push(@modifierListFile, $modifier);
2033                                 }
2034                         }
2035
2036                 } else {
2037                         warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
2038                         push(@typeListFile, $possible);
2039                 }
2040                 build_types();
2041         } else {
2042                 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
2043         }
2044 }
2045
2046 my $prefix = '';
2047
2048 sub show_type {
2049         my ($type) = @_;
2050
2051         $type =~ tr/[a-z]/[A-Z]/;
2052
2053         return defined $use_type{$type} if (scalar keys %use_type > 0);
2054
2055         return !defined $ignore_type{$type};
2056 }
2057
2058 sub report {
2059         my ($level, $type, $msg) = @_;
2060
2061         if (!show_type($type) ||
2062             (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
2063                 return 0;
2064         }
2065         my $output = '';
2066         if ($color) {
2067                 if ($level eq 'ERROR') {
2068                         $output .= RED;
2069                 } elsif ($level eq 'WARNING') {
2070                         $output .= YELLOW;
2071                 } else {
2072                         $output .= GREEN;
2073                 }
2074         }
2075         $output .= $prefix . $level . ':';
2076         if ($show_types) {
2077                 $output .= BLUE if ($color);
2078                 $output .= "$type:";
2079         }
2080         $output .= RESET if ($color);
2081         $output .= ' ' . $msg . "\n";
2082
2083         if ($showfile) {
2084                 my @lines = split("\n", $output, -1);
2085                 splice(@lines, 1, 1);
2086                 $output = join("\n", @lines);
2087         }
2088         $output = (split('\n', $output))[0] . "\n" if ($terse);
2089
2090         push(our @report, $output);
2091
2092         return 1;
2093 }
2094
2095 sub report_dump {
2096         our @report;
2097 }
2098
2099 sub fixup_current_range {
2100         my ($lineRef, $offset, $length) = @_;
2101
2102         if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
2103                 my $o = $1;
2104                 my $l = $2;
2105                 my $no = $o + $offset;
2106                 my $nl = $l + $length;
2107                 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
2108         }
2109 }
2110
2111 sub fix_inserted_deleted_lines {
2112         my ($linesRef, $insertedRef, $deletedRef) = @_;
2113
2114         my $range_last_linenr = 0;
2115         my $delta_offset = 0;
2116
2117         my $old_linenr = 0;
2118         my $new_linenr = 0;
2119
2120         my $next_insert = 0;
2121         my $next_delete = 0;
2122
2123         my @lines = ();
2124
2125         my $inserted = @{$insertedRef}[$next_insert++];
2126         my $deleted = @{$deletedRef}[$next_delete++];
2127
2128         foreach my $old_line (@{$linesRef}) {
2129                 my $save_line = 1;
2130                 my $line = $old_line;   #don't modify the array
2131                 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) {      #new filename
2132                         $delta_offset = 0;
2133                 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) {    #new hunk
2134                         $range_last_linenr = $new_linenr;
2135                         fixup_current_range(\$line, $delta_offset, 0);
2136                 }
2137
2138                 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
2139                         $deleted = @{$deletedRef}[$next_delete++];
2140                         $save_line = 0;
2141                         fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
2142                 }
2143
2144                 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
2145                         push(@lines, ${$inserted}{'LINE'});
2146                         $inserted = @{$insertedRef}[$next_insert++];
2147                         $new_linenr++;
2148                         fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
2149                 }
2150
2151                 if ($save_line) {
2152                         push(@lines, $line);
2153                         $new_linenr++;
2154                 }
2155
2156                 $old_linenr++;
2157         }
2158
2159         return @lines;
2160 }
2161
2162 sub fix_insert_line {
2163         my ($linenr, $line) = @_;
2164
2165         my $inserted = {
2166                 LINENR => $linenr,
2167                 LINE => $line,
2168         };
2169         push(@fixed_inserted, $inserted);
2170 }
2171
2172 sub fix_delete_line {
2173         my ($linenr, $line) = @_;
2174
2175         my $deleted = {
2176                 LINENR => $linenr,
2177                 LINE => $line,
2178         };
2179
2180         push(@fixed_deleted, $deleted);
2181 }
2182
2183 sub ERROR {
2184         my ($type, $msg) = @_;
2185
2186         if (report("ERROR", $type, $msg)) {
2187                 our $clean = 0;
2188                 our $cnt_error++;
2189                 return 1;
2190         }
2191         return 0;
2192 }
2193 sub WARN {
2194         my ($type, $msg) = @_;
2195
2196         if (report("WARNING", $type, $msg)) {
2197                 our $clean = 0;
2198                 our $cnt_warn++;
2199                 return 1;
2200         }
2201         return 0;
2202 }
2203 sub CHK {
2204         my ($type, $msg) = @_;
2205
2206         if ($check && report("CHECK", $type, $msg)) {
2207                 our $clean = 0;
2208                 our $cnt_chk++;
2209                 return 1;
2210         }
2211         return 0;
2212 }
2213
2214 sub check_absolute_file {
2215         my ($absolute, $herecurr) = @_;
2216         my $file = $absolute;
2217
2218         ##print "absolute<$absolute>\n";
2219
2220         # See if any suffix of this path is a path within the tree.
2221         while ($file =~ s@^[^/]*/@@) {
2222                 if (-f "$root/$file") {
2223                         ##print "file<$file>\n";
2224                         last;
2225                 }
2226         }
2227         if (! -f _)  {
2228                 return 0;
2229         }
2230
2231         # It is, so see if the prefix is acceptable.
2232         my $prefix = $absolute;
2233         substr($prefix, -length($file)) = '';
2234
2235         ##print "prefix<$prefix>\n";
2236         if ($prefix ne ".../") {
2237                 WARN("USE_RELATIVE_PATH",
2238                      "use relative pathname instead of absolute in changelog text\n" . $herecurr);
2239         }
2240 }
2241
2242 sub trim {
2243         my ($string) = @_;
2244
2245         $string =~ s/^\s+|\s+$//g;
2246
2247         return $string;
2248 }
2249
2250 sub ltrim {
2251         my ($string) = @_;
2252
2253         $string =~ s/^\s+//;
2254
2255         return $string;
2256 }
2257
2258 sub rtrim {
2259         my ($string) = @_;
2260
2261         $string =~ s/\s+$//;
2262
2263         return $string;
2264 }
2265
2266 sub string_find_replace {
2267         my ($string, $find, $replace) = @_;
2268
2269         $string =~ s/$find/$replace/g;
2270
2271         return $string;
2272 }
2273
2274 sub tabify {
2275         my ($leading) = @_;
2276
2277         my $source_indent = $tabsize;
2278         my $max_spaces_before_tab = $source_indent - 1;
2279         my $spaces_to_tab = " " x $source_indent;
2280
2281         #convert leading spaces to tabs
2282         1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2283         #Remove spaces before a tab
2284         1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2285
2286         return "$leading";
2287 }
2288
2289 sub pos_last_openparen {
2290         my ($line) = @_;
2291
2292         my $pos = 0;
2293
2294         my $opens = $line =~ tr/\(/\(/;
2295         my $closes = $line =~ tr/\)/\)/;
2296
2297         my $last_openparen = 0;
2298
2299         if (($opens == 0) || ($closes >= $opens)) {
2300                 return -1;
2301         }
2302
2303         my $len = length($line);
2304
2305         for ($pos = 0; $pos < $len; $pos++) {
2306                 my $string = substr($line, $pos);
2307                 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2308                         $pos += length($1) - 1;
2309                 } elsif (substr($line, $pos, 1) eq '(') {
2310                         $last_openparen = $pos;
2311                 } elsif (index($string, '(') == -1) {
2312                         last;
2313                 }
2314         }
2315
2316         return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
2317 }
2318
2319 sub get_raw_comment {
2320         my ($line, $rawline) = @_;
2321         my $comment = '';
2322
2323         for my $i (0 .. (length($line) - 1)) {
2324                 if (substr($line, $i, 1) eq "$;") {
2325                         $comment .= substr($rawline, $i, 1);
2326                 }
2327         }
2328
2329         return $comment;
2330 }
2331
2332 sub process {
2333         my $filename = shift;
2334
2335         my $linenr=0;
2336         my $prevline="";
2337         my $prevrawline="";
2338         my $stashline="";
2339         my $stashrawline="";
2340
2341         my $length;
2342         my $indent;
2343         my $previndent=0;
2344         my $stashindent=0;
2345
2346         our $clean = 1;
2347         my $signoff = 0;
2348         my $author = '';
2349         my $authorsignoff = 0;
2350         my $is_patch = 0;
2351         my $is_binding_patch = -1;
2352         my $in_header_lines = $file ? 0 : 1;
2353         my $in_commit_log = 0;          #Scanning lines before patch
2354         my $has_patch_separator = 0;    #Found a --- line
2355         my $has_commit_log = 0;         #Encountered lines before patch
2356         my $commit_log_lines = 0;       #Number of commit log lines
2357         my $commit_log_possible_stack_dump = 0;
2358         my $commit_log_long_line = 0;
2359         my $commit_log_has_diff = 0;
2360         my $reported_maintainer_file = 0;
2361         my $non_utf8_charset = 0;
2362
2363         my $last_blank_line = 0;
2364         my $last_coalesced_string_linenr = -1;
2365
2366         our @report = ();
2367         our $cnt_lines = 0;
2368         our $cnt_error = 0;
2369         our $cnt_warn = 0;
2370         our $cnt_chk = 0;
2371
2372         # Trace the real file/line as we go.
2373         my $realfile = '';
2374         my $realline = 0;
2375         my $realcnt = 0;
2376         my $here = '';
2377         my $context_function;           #undef'd unless there's a known function
2378         my $in_comment = 0;
2379         my $comment_edge = 0;
2380         my $first_line = 0;
2381         my $p1_prefix = '';
2382
2383         my $prev_values = 'E';
2384
2385         # suppression flags
2386         my %suppress_ifbraces;
2387         my %suppress_whiletrailers;
2388         my %suppress_export;
2389         my $suppress_statement = 0;
2390
2391         my %signatures = ();
2392
2393         # Pre-scan the patch sanitizing the lines.
2394         # Pre-scan the patch looking for any __setup documentation.
2395         #
2396         my @setup_docs = ();
2397         my $setup_docs = 0;
2398
2399         my $camelcase_file_seeded = 0;
2400
2401         my $checklicenseline = 1;
2402
2403         sanitise_line_reset();
2404         my $line;
2405         foreach my $rawline (@rawlines) {
2406                 $linenr++;
2407                 $line = $rawline;
2408
2409                 push(@fixed, $rawline) if ($fix);
2410
2411                 if ($rawline=~/^\+\+\+\s+(\S+)/) {
2412                         $setup_docs = 0;
2413                         if ($1 =~ m@Documentation/admin-guide/kernel-parameters.txt$@) {
2414                                 $setup_docs = 1;
2415                         }
2416                         #next;
2417                 }
2418                 if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2419                         $realline=$1-1;
2420                         if (defined $2) {
2421                                 $realcnt=$3+1;
2422                         } else {
2423                                 $realcnt=1+1;
2424                         }
2425                         $in_comment = 0;
2426
2427                         # Guestimate if this is a continuing comment.  Run
2428                         # the context looking for a comment "edge".  If this
2429                         # edge is a close comment then we must be in a comment
2430                         # at context start.
2431                         my $edge;
2432                         my $cnt = $realcnt;
2433                         for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2434                                 next if (defined $rawlines[$ln - 1] &&
2435                                          $rawlines[$ln - 1] =~ /^-/);
2436                                 $cnt--;
2437                                 #print "RAW<$rawlines[$ln - 1]>\n";
2438                                 last if (!defined $rawlines[$ln - 1]);
2439                                 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2440                                     $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2441                                         ($edge) = $1;
2442                                         last;
2443                                 }
2444                         }
2445                         if (defined $edge && $edge eq '*/') {
2446                                 $in_comment = 1;
2447                         }
2448
2449                         # Guestimate if this is a continuing comment.  If this
2450                         # is the start of a diff block and this line starts
2451                         # ' *' then it is very likely a comment.
2452                         if (!defined $edge &&
2453                             $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
2454                         {
2455                                 $in_comment = 1;
2456                         }
2457
2458                         ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2459                         sanitise_line_reset($in_comment);
2460
2461                 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
2462                         # Standardise the strings and chars within the input to
2463                         # simplify matching -- only bother with positive lines.
2464                         $line = sanitise_line($rawline);
2465                 }
2466                 push(@lines, $line);
2467
2468                 if ($realcnt > 1) {
2469                         $realcnt-- if ($line =~ /^(?:\+| |$)/);
2470                 } else {
2471                         $realcnt = 0;
2472                 }
2473
2474                 #print "==>$rawline\n";
2475                 #print "-->$line\n";
2476
2477                 if ($setup_docs && $line =~ /^\+/) {
2478                         push(@setup_docs, $line);
2479                 }
2480         }
2481
2482         $prefix = '';
2483
2484         $realcnt = 0;
2485         $linenr = 0;
2486         $fixlinenr = -1;
2487         foreach my $line (@lines) {
2488                 $linenr++;
2489                 $fixlinenr++;
2490                 my $sline = $line;      #copy of $line
2491                 $sline =~ s/$;/ /g;     #with comments as spaces
2492
2493                 my $rawline = $rawlines[$linenr - 1];
2494                 my $raw_comment = get_raw_comment($line, $rawline);
2495
2496 # check if it's a mode change, rename or start of a patch
2497                 if (!$in_commit_log &&
2498                     ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ ||
2499                     ($line =~ /^rename (?:from|to) \S+\s*$/ ||
2500                      $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) {
2501                         $is_patch = 1;
2502                 }
2503
2504 #extract the line range in the file after the patch is applied
2505                 if (!$in_commit_log &&
2506                     $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2507                         my $context = $4;
2508                         $is_patch = 1;
2509                         $first_line = $linenr + 1;
2510                         $realline=$1-1;
2511                         if (defined $2) {
2512                                 $realcnt=$3+1;
2513                         } else {
2514                                 $realcnt=1+1;
2515                         }
2516                         annotate_reset();
2517                         $prev_values = 'E';
2518
2519                         %suppress_ifbraces = ();
2520                         %suppress_whiletrailers = ();
2521                         %suppress_export = ();
2522                         $suppress_statement = 0;
2523                         if ($context =~ /\b(\w+)\s*\(/) {
2524                                 $context_function = $1;
2525                         } else {
2526                                 undef $context_function;
2527                         }
2528                         next;
2529
2530 # track the line number as we move through the hunk, note that
2531 # new versions of GNU diff omit the leading space on completely
2532 # blank context lines so we need to count that too.
2533                 } elsif ($line =~ /^( |\+|$)/) {
2534                         $realline++;
2535                         $realcnt-- if ($realcnt != 0);
2536
2537                         # Measure the line length and indent.
2538                         ($length, $indent) = line_stats($rawline);
2539
2540                         # Track the previous line.
2541                         ($prevline, $stashline) = ($stashline, $line);
2542                         ($previndent, $stashindent) = ($stashindent, $indent);
2543                         ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2544
2545                         #warn "line<$line>\n";
2546
2547                 } elsif ($realcnt == 1) {
2548                         $realcnt--;
2549                 }
2550
2551                 my $hunk_line = ($realcnt != 0);
2552
2553                 $here = "#$linenr: " if (!$file);
2554                 $here = "#$realline: " if ($file);
2555
2556                 my $found_file = 0;
2557                 # extract the filename as it passes
2558                 if ($line =~ /^diff --git.*?(\S+)$/) {
2559                         $realfile = $1;
2560                         $realfile =~ s@^([^/]*)/@@ if (!$file);
2561                         $in_commit_log = 0;
2562                         $found_file = 1;
2563                 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2564                         $realfile = $1;
2565                         $realfile =~ s@^([^/]*)/@@ if (!$file);
2566                         $in_commit_log = 0;
2567
2568                         $p1_prefix = $1;
2569                         if (!$file && $tree && $p1_prefix ne '' &&
2570                             -e "$root/$p1_prefix") {
2571                                 WARN("PATCH_PREFIX",
2572                                      "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
2573                         }
2574
2575                         if ($realfile =~ m@^include/asm/@) {
2576                                 ERROR("MODIFIED_INCLUDE_ASM",
2577                                       "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2578                         }
2579                         $found_file = 1;
2580                 }
2581
2582 #make up the handle for any error we report on this line
2583                 if ($showfile) {
2584                         $prefix = "$realfile:$realline: "
2585                 } elsif ($emacs) {
2586                         if ($file) {
2587                                 $prefix = "$filename:$realline: ";
2588                         } else {
2589                                 $prefix = "$filename:$linenr: ";
2590                         }
2591                 }
2592
2593                 if ($found_file) {
2594                         if (is_maintained_obsolete($realfile)) {
2595                                 WARN("OBSOLETE",
2596                                      "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy.  No unnecessary modifications please.\n");
2597                         }
2598                         if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
2599                                 $check = 1;
2600                         } else {
2601                                 $check = $check_orig;
2602                         }
2603                         $checklicenseline = 1;
2604
2605                         if ($realfile !~ /^MAINTAINERS/) {
2606                                 my $last_binding_patch = $is_binding_patch;
2607
2608                                 $is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@;
2609
2610                                 if (($last_binding_patch != -1) &&
2611                                     ($last_binding_patch ^ $is_binding_patch)) {
2612                                         WARN("DT_SPLIT_BINDING_PATCH",
2613                                              "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.rst\n");
2614                                 }
2615                         }
2616
2617                         next;
2618                 }
2619
2620                 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
2621
2622                 my $hereline = "$here\n$rawline\n";
2623                 my $herecurr = "$here\n$rawline\n";
2624                 my $hereprev = "$here\n$prevrawline\n$rawline\n";
2625
2626                 $cnt_lines++ if ($realcnt != 0);
2627
2628 # Verify the existence of a commit log if appropriate
2629 # 2 is used because a $signature is counted in $commit_log_lines
2630                 if ($in_commit_log) {
2631                         if ($line !~ /^\s*$/) {
2632                                 $commit_log_lines++;    #could be a $signature
2633                         }
2634                 } elsif ($has_commit_log && $commit_log_lines < 2) {
2635                         WARN("COMMIT_MESSAGE",
2636                              "Missing commit description - Add an appropriate one\n");
2637                         $commit_log_lines = 2;  #warn only once
2638                 }
2639
2640 # Check if the commit log has what seems like a diff which can confuse patch
2641                 if ($in_commit_log && !$commit_log_has_diff &&
2642                     (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2643                       $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2644                      $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2645                      $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2646                         ERROR("DIFF_IN_COMMIT_MSG",
2647                               "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2648                         $commit_log_has_diff = 1;
2649                 }
2650
2651 # Check for incorrect file permissions
2652                 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2653                         my $permhere = $here . "FILE: $realfile\n";
2654                         if ($realfile !~ m@scripts/@ &&
2655                             $realfile !~ /\.(py|pl|awk|sh)$/) {
2656                                 ERROR("EXECUTE_PERMISSIONS",
2657                                       "do not set execute permissions for source files\n" . $permhere);
2658                         }
2659                 }
2660
2661 # Check the patch for a From:
2662                 if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) {
2663                         $author = $1;
2664                         $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i);
2665                         $author =~ s/"//g;
2666                         $author = reformat_email($author);
2667                 }
2668
2669 # Check the patch for a signoff:
2670                 if ($line =~ /^\s*signed-off-by:\s*(.*)/i) {
2671                         $signoff++;
2672                         $in_commit_log = 0;
2673                         if ($author ne '') {
2674                                 if (same_email_addresses($1, $author)) {
2675                                         $authorsignoff = 1;
2676                                 }
2677                         }
2678                 }
2679
2680 # Check for patch separator
2681                 if ($line =~ /^---$/) {
2682                         $has_patch_separator = 1;
2683                         $in_commit_log = 0;
2684                 }
2685
2686 # Check if MAINTAINERS is being updated.  If so, there's probably no need to
2687 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2688                 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2689                         $reported_maintainer_file = 1;
2690                 }
2691
2692 # Check signature styles
2693                 if (!$in_header_lines &&
2694                     $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
2695                         my $space_before = $1;
2696                         my $sign_off = $2;
2697                         my $space_after = $3;
2698                         my $email = $4;
2699                         my $ucfirst_sign_off = ucfirst(lc($sign_off));
2700
2701                         if ($sign_off !~ /$signature_tags/) {
2702                                 WARN("BAD_SIGN_OFF",
2703                                      "Non-standard signature: $sign_off\n" . $herecurr);
2704                         }
2705                         if (defined $space_before && $space_before ne "") {
2706                                 if (WARN("BAD_SIGN_OFF",
2707                                          "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2708                                     $fix) {
2709                                         $fixed[$fixlinenr] =
2710                                             "$ucfirst_sign_off $email";
2711                                 }
2712                         }
2713                         if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
2714                                 if (WARN("BAD_SIGN_OFF",
2715                                          "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2716                                     $fix) {
2717                                         $fixed[$fixlinenr] =
2718                                             "$ucfirst_sign_off $email";
2719                                 }
2720
2721                         }
2722                         if (!defined $space_after || $space_after ne " ") {
2723                                 if (WARN("BAD_SIGN_OFF",
2724                                          "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2725                                     $fix) {
2726                                         $fixed[$fixlinenr] =
2727                                             "$ucfirst_sign_off $email";
2728                                 }
2729                         }
2730
2731                         my ($email_name, $name_comment, $email_address, $comment) = parse_email($email);
2732                         my $suggested_email = format_email(($email_name, $email_address));
2733                         if ($suggested_email eq "") {
2734                                 ERROR("BAD_SIGN_OFF",
2735                                       "Unrecognized email address: '$email'\n" . $herecurr);
2736                         } else {
2737                                 my $dequoted = $suggested_email;
2738                                 $dequoted =~ s/^"//;
2739                                 $dequoted =~ s/" </ </;
2740                                 # Don't force email to have quotes
2741                                 # Allow just an angle bracketed address
2742                                 if (!same_email_addresses($email, $suggested_email)) {
2743                                         WARN("BAD_SIGN_OFF",
2744                                              "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
2745                                 }
2746                         }
2747
2748 # Check for duplicate signatures
2749                         my $sig_nospace = $line;
2750                         $sig_nospace =~ s/\s//g;
2751                         $sig_nospace = lc($sig_nospace);
2752                         if (defined $signatures{$sig_nospace}) {
2753                                 WARN("BAD_SIGN_OFF",
2754                                      "Duplicate signature\n" . $herecurr);
2755                         } else {
2756                                 $signatures{$sig_nospace} = 1;
2757                         }
2758
2759 # Check Co-developed-by: immediately followed by Signed-off-by: with same name and email
2760                         if ($sign_off =~ /^co-developed-by:$/i) {
2761                                 if ($email eq $author) {
2762                                         WARN("BAD_SIGN_OFF",
2763                                               "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline);
2764                                 }
2765                                 if (!defined $lines[$linenr]) {
2766                                         WARN("BAD_SIGN_OFF",
2767                                              "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline);
2768                                 } elsif ($rawlines[$linenr] !~ /^\s*signed-off-by:\s*(.*)/i) {
2769                                         WARN("BAD_SIGN_OFF",
2770                                              "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2771                                 } elsif ($1 ne $email) {
2772                                         WARN("BAD_SIGN_OFF",
2773                                              "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2774                                 }
2775                         }
2776                 }
2777
2778 # Check email subject for common tools that don't need to be mentioned
2779                 if ($in_header_lines &&
2780                     $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2781                         WARN("EMAIL_SUBJECT",
2782                              "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2783                 }
2784
2785 # Check for Gerrit Change-Ids not in any patch context
2786                 if ($realfile eq '' && !$has_patch_separator && $line =~ /^\s*change-id:/i) {
2787                         ERROR("GERRIT_CHANGE_ID",
2788                               "Remove Gerrit Change-Id's before submitting upstream\n" . $herecurr);
2789                 }
2790
2791 # Check if the commit log is in a possible stack dump
2792                 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2793                     ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2794                      $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2795                                         # timestamp
2796                      $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/) ||
2797                      $line =~ /^(?:\s+\w+:\s+[0-9a-fA-F]+){3,3}/ ||
2798                      $line =~ /^\s*\#\d+\s*\[[0-9a-fA-F]+\]\s*\w+ at [0-9a-fA-F]+/) {
2799                                         # stack dump address styles
2800                         $commit_log_possible_stack_dump = 1;
2801                 }
2802
2803 # Check for line lengths > 75 in commit log, warn once
2804                 if ($in_commit_log && !$commit_log_long_line &&
2805                     length($line) > 75 &&
2806                     !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2807                                         # file delta changes
2808                       $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2809                                         # filename then :
2810                       $line =~ /^\s*(?:Fixes:|Link:)/i ||
2811                                         # A Fixes: or Link: line
2812                       $commit_log_possible_stack_dump)) {
2813                         WARN("COMMIT_LOG_LONG_LINE",
2814                              "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2815                         $commit_log_long_line = 1;
2816                 }
2817
2818 # Reset possible stack dump if a blank line is found
2819                 if ($in_commit_log && $commit_log_possible_stack_dump &&
2820                     $line =~ /^\s*$/) {
2821                         $commit_log_possible_stack_dump = 0;
2822                 }
2823
2824 # Check for git id commit length and improperly formed commit descriptions
2825                 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2826                     $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink|base-commit):/i &&
2827                     $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
2828                     ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
2829                      ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
2830                       $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2831                       $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
2832                         my $init_char = "c";
2833                         my $orig_commit = "";
2834                         my $short = 1;
2835                         my $long = 0;
2836                         my $case = 1;
2837                         my $space = 1;
2838                         my $hasdesc = 0;
2839                         my $hasparens = 0;
2840                         my $id = '0123456789ab';
2841                         my $orig_desc = "commit description";
2842                         my $description = "";
2843
2844                         if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2845                                 $init_char = $1;
2846                                 $orig_commit = lc($2);
2847                         } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2848                                 $orig_commit = lc($1);
2849                         }
2850
2851                         $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2852                         $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2853                         $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2854                         $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2855                         if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2856                                 $orig_desc = $1;
2857                                 $hasparens = 1;
2858                         } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2859                                  defined $rawlines[$linenr] &&
2860                                  $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2861                                 $orig_desc = $1;
2862                                 $hasparens = 1;
2863                         } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2864                                  defined $rawlines[$linenr] &&
2865                                  $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2866                                 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2867                                 $orig_desc = $1;
2868                                 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2869                                 $orig_desc .= " " . $1;
2870                                 $hasparens = 1;
2871                         }
2872
2873                         ($id, $description) = git_commit_info($orig_commit,
2874                                                               $id, $orig_desc);
2875
2876                         if (defined($id) &&
2877                            ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
2878                                 ERROR("GIT_COMMIT_ID",
2879                                       "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2880                         }
2881                 }
2882
2883 # Check for added, moved or deleted files
2884                 if (!$reported_maintainer_file && !$in_commit_log &&
2885                     ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2886                      $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2887                      ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2888                       (defined($1) || defined($2))))) {
2889                         $is_patch = 1;
2890                         $reported_maintainer_file = 1;
2891                         WARN("FILE_PATH_CHANGES",
2892                              "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2893                 }
2894
2895 # Check for adding new DT bindings not in schema format
2896                 if (!$in_commit_log &&
2897                     ($line =~ /^new file mode\s*\d+\s*$/) &&
2898                     ($realfile =~ m@^Documentation/devicetree/bindings/.*\.txt$@)) {
2899                         WARN("DT_SCHEMA_BINDING_PATCH",
2900                              "DT bindings should be in DT schema format. See: Documentation/devicetree/writing-schema.rst\n");
2901                 }
2902
2903 # Check for wrappage within a valid hunk of the file
2904                 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
2905                         ERROR("CORRUPTED_PATCH",
2906                               "patch seems to be corrupt (line wrapped?)\n" .
2907                                 $herecurr) if (!$emitted_corrupt++);
2908                 }
2909
2910 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2911                 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
2912                     $rawline !~ m/^$UTF8*$/) {
2913                         my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2914
2915                         my $blank = copy_spacing($rawline);
2916                         my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2917                         my $hereptr = "$hereline$ptr\n";
2918
2919                         CHK("INVALID_UTF8",
2920                             "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
2921                 }
2922
2923 # Check if it's the start of a commit log
2924 # (not a header line and we haven't seen the patch filename)
2925                 if ($in_header_lines && $realfile =~ /^$/ &&
2926                     !($rawline =~ /^\s+(?:\S|$)/ ||
2927                       $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
2928                         $in_header_lines = 0;
2929                         $in_commit_log = 1;
2930                         $has_commit_log = 1;
2931                 }
2932
2933 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2934 # declined it, i.e defined some charset where it is missing.
2935                 if ($in_header_lines &&
2936                     $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2937                     $1 !~ /utf-8/i) {
2938                         $non_utf8_charset = 1;
2939                 }
2940
2941                 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
2942                     $rawline =~ /$NON_ASCII_UTF8/) {
2943                         WARN("UTF8_BEFORE_PATCH",
2944                             "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2945                 }
2946
2947 # Check for absolute kernel paths in commit message
2948                 if ($tree && $in_commit_log) {
2949                         while ($line =~ m{(?:^|\s)(/\S*)}g) {
2950                                 my $file = $1;
2951
2952                                 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2953                                     check_absolute_file($1, $herecurr)) {
2954                                         #
2955                                 } else {
2956                                         check_absolute_file($file, $herecurr);
2957                                 }
2958                         }
2959                 }
2960
2961 # Check for various typo / spelling mistakes
2962                 if (defined($misspellings) &&
2963                     ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
2964                         while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
2965                                 my $typo = $1;
2966                                 my $typo_fix = $spelling_fix{lc($typo)};
2967                                 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2968                                 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2969                                 my $msg_level = \&WARN;
2970                                 $msg_level = \&CHK if ($file);
2971                                 if (&{$msg_level}("TYPO_SPELLING",
2972                                                   "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2973                                     $fix) {
2974                                         $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2975                                 }
2976                         }
2977                 }
2978
2979 # check for invalid commit id
2980                 if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) {
2981                         my $id;
2982                         my $description;
2983                         ($id, $description) = git_commit_info($2, undef, undef);
2984                         if (!defined($id)) {
2985                                 WARN("UNKNOWN_COMMIT_ID",
2986                                      "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr);
2987                         }
2988                 }
2989
2990 # ignore non-hunk lines and lines being removed
2991                 next if (!$hunk_line || $line =~ /^-/);
2992
2993 #trailing whitespace
2994                 if ($line =~ /^\+.*\015/) {
2995                         my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2996                         if (ERROR("DOS_LINE_ENDINGS",
2997                                   "DOS line endings\n" . $herevet) &&
2998                             $fix) {
2999                                 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
3000                         }
3001                 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
3002                         my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3003                         if (ERROR("TRAILING_WHITESPACE",
3004                                   "trailing whitespace\n" . $herevet) &&
3005                             $fix) {
3006                                 $fixed[$fixlinenr] =~ s/\s+$//;
3007                         }
3008
3009                         $rpt_cleaners = 1;
3010                 }
3011
3012 # Check for FSF mailing addresses.
3013                 if ($rawline =~ /\bwrite to the Free/i ||
3014                     $rawline =~ /\b675\s+Mass\s+Ave/i ||
3015                     $rawline =~ /\b59\s+Temple\s+Pl/i ||
3016                     $rawline =~ /\b51\s+Franklin\s+St/i) {
3017                         my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3018                         my $msg_level = \&ERROR;
3019                         $msg_level = \&CHK if ($file);
3020                         &{$msg_level}("FSF_MAILING_ADDRESS",
3021                                       "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)
3022                 }
3023
3024 # check for Kconfig help text having a real description
3025 # Only applies when adding the entry originally, after that we do not have
3026 # sufficient context to determine whether it is indeed long enough.
3027                 if ($realfile =~ /Kconfig/ &&
3028                     # 'choice' is usually the last thing on the line (though
3029                     # Kconfig supports named choices), so use a word boundary
3030                     # (\b) rather than a whitespace character (\s)
3031                     $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) {
3032                         my $length = 0;
3033                         my $cnt = $realcnt;
3034                         my $ln = $linenr + 1;
3035                         my $f;
3036                         my $is_start = 0;
3037                         my $is_end = 0;
3038                         for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
3039                                 $f = $lines[$ln - 1];
3040                                 $cnt-- if ($lines[$ln - 1] !~ /^-/);
3041                                 $is_end = $lines[$ln - 1] =~ /^\+/;
3042
3043                                 next if ($f =~ /^-/);
3044                                 last if (!$file && $f =~ /^\@\@/);
3045
3046                                 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
3047                                         $is_start = 1;
3048                                 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
3049                                         $length = -1;
3050                                 }
3051
3052                                 $f =~ s/^.//;
3053                                 $f =~ s/#.*//;
3054                                 $f =~ s/^\s+//;
3055                                 next if ($f =~ /^$/);
3056
3057                                 # This only checks context lines in the patch
3058                                 # and so hopefully shouldn't trigger false
3059                                 # positives, even though some of these are
3060                                 # common words in help texts
3061                                 if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice|
3062                                                   if|endif|menu|endmenu|source)\b/x) {
3063                                         $is_end = 1;
3064                                         last;
3065                                 }
3066                                 $length++;
3067                         }
3068                         if ($is_start && $is_end && $length < $min_conf_desc_length) {
3069                                 WARN("CONFIG_DESCRIPTION",
3070                                      "please write a paragraph that describes the config symbol fully\n" . $herecurr);
3071                         }
3072                         #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
3073                 }
3074
3075 # check MAINTAINERS entries
3076                 if ($realfile =~ /^MAINTAINERS$/) {
3077 # check MAINTAINERS entries for the right form
3078                         if ($rawline =~ /^\+[A-Z]:/ &&
3079                             $rawline !~ /^\+[A-Z]:\t\S/) {
3080                                 if (WARN("MAINTAINERS_STYLE",
3081                                          "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
3082                                     $fix) {
3083                                         $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
3084                                 }
3085                         }
3086 # check MAINTAINERS entries for the right ordering too
3087                         my $preferred_order = 'MRLSWQBCPTFXNK';
3088                         if ($rawline =~ /^\+[A-Z]:/ &&
3089                             $prevrawline =~ /^[\+ ][A-Z]:/) {
3090                                 $rawline =~ /^\+([A-Z]):\s*(.*)/;
3091                                 my $cur = $1;
3092                                 my $curval = $2;
3093                                 $prevrawline =~ /^[\+ ]([A-Z]):\s*(.*)/;
3094                                 my $prev = $1;
3095                                 my $prevval = $2;
3096                                 my $curindex = index($preferred_order, $cur);
3097                                 my $previndex = index($preferred_order, $prev);
3098                                 if ($curindex < 0) {
3099                                         WARN("MAINTAINERS_STYLE",
3100                                              "Unknown MAINTAINERS entry type: '$cur'\n" . $herecurr);
3101                                 } else {
3102                                         if ($previndex >= 0 && $curindex < $previndex) {
3103                                                 WARN("MAINTAINERS_STYLE",
3104                                                      "Misordered MAINTAINERS entry - list '$cur:' before '$prev:'\n" . $hereprev);
3105                                         } elsif ((($prev eq 'F' && $cur eq 'F') ||
3106                                                   ($prev eq 'X' && $cur eq 'X')) &&
3107                                                  ($prevval cmp $curval) > 0) {
3108                                                 WARN("MAINTAINERS_STYLE",
3109                                                      "Misordered MAINTAINERS entry - list file patterns in alphabetic order\n" . $hereprev);
3110                                         }
3111                                 }
3112                         }
3113                 }
3114
3115 # discourage the use of boolean for type definition attributes of Kconfig options
3116                 if ($realfile =~ /Kconfig/ &&
3117                     $line =~ /^\+\s*\bboolean\b/) {
3118                         WARN("CONFIG_TYPE_BOOLEAN",
3119                              "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
3120                 }
3121
3122                 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
3123                     ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
3124                         my $flag = $1;
3125                         my $replacement = {
3126                                 'EXTRA_AFLAGS' =>   'asflags-y',
3127                                 'EXTRA_CFLAGS' =>   'ccflags-y',
3128                                 'EXTRA_CPPFLAGS' => 'cppflags-y',
3129                                 'EXTRA_LDFLAGS' =>  'ldflags-y',
3130                         };
3131
3132                         WARN("DEPRECATED_VARIABLE",
3133                              "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
3134                 }
3135
3136 # check for DT compatible documentation
3137                 if (defined $root &&
3138                         (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
3139                          ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
3140
3141                         my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
3142
3143                         my $dt_path = $root . "/Documentation/devicetree/bindings/";
3144                         my $vp_file = $dt_path . "vendor-prefixes.yaml";
3145
3146                         foreach my $compat (@compats) {
3147                                 my $compat2 = $compat;
3148                                 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
3149                                 my $compat3 = $compat;
3150                                 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
3151                                 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
3152                                 if ( $? >> 8 ) {
3153                                         WARN("UNDOCUMENTED_DT_STRING",
3154                                              "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
3155                                 }
3156
3157                                 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
3158                                 my $vendor = $1;
3159                                 `grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`;
3160                                 if ( $? >> 8 ) {
3161                                         WARN("UNDOCUMENTED_DT_STRING",
3162                                              "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
3163                                 }
3164                         }
3165                 }
3166
3167 # check for using SPDX license tag at beginning of files
3168                 if ($realline == $checklicenseline) {
3169                         if ($rawline =~ /^[ \+]\s*\#\!\s*\//) {
3170                                 $checklicenseline = 2;
3171                         } elsif ($rawline =~ /^\+/) {
3172                                 my $comment = "";
3173                                 if ($realfile =~ /\.(h|s|S)$/) {
3174                                         $comment = '/*';
3175                                 } elsif ($realfile =~ /\.(c|dts|dtsi)$/) {
3176                                         $comment = '//';
3177                                 } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc|yaml)$/) {
3178                                         $comment = '#';
3179                                 } elsif ($realfile =~ /\.rst$/) {
3180                                         $comment = '..';
3181                                 }
3182
3183 # check SPDX comment style for .[chsS] files
3184                                 if ($realfile =~ /\.[chsS]$/ &&
3185                                     $rawline =~ /SPDX-License-Identifier:/ &&
3186                                     $rawline !~ m@^\+\s*\Q$comment\E\s*@) {
3187                                         WARN("SPDX_LICENSE_TAG",
3188                                              "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr);
3189                                 }
3190
3191                                 if ($comment !~ /^$/ &&
3192                                     $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) {
3193                                         WARN("SPDX_LICENSE_TAG",
3194                                              "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr);
3195                                 } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) {
3196                                         my $spdx_license = $1;
3197                                         if (!is_SPDX_License_valid($spdx_license)) {
3198                                                 WARN("SPDX_LICENSE_TAG",
3199                                                      "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr);
3200                                         }
3201                                         if ($realfile =~ m@^Documentation/devicetree/bindings/@ &&
3202                                             not $spdx_license =~ /GPL-2\.0.*BSD-2-Clause/) {
3203                                                 my $msg_level = \&WARN;
3204                                                 $msg_level = \&CHK if ($file);
3205                                                 if (&{$msg_level}("SPDX_LICENSE_TAG",
3206
3207                                                                   "DT binding documents should be licensed (GPL-2.0-only OR BSD-2-Clause)\n" . $herecurr) &&
3208                                                     $fix) {
3209                                                         $fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/;
3210                                                 }
3211                                         }
3212                                 }
3213                         }
3214                 }
3215
3216 # check we are in a valid source file if not then ignore this hunk
3217                 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
3218
3219 # check for using SPDX-License-Identifier on the wrong line number
3220                 if ($realline != $checklicenseline &&
3221                     $rawline =~ /\bSPDX-License-Identifier:/ &&
3222                     substr($line, @-, @+ - @-) eq "$;" x (@+ - @-)) {
3223                         WARN("SPDX_LICENSE_TAG",
3224                              "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr);
3225                 }
3226
3227 # line length limit (with some exclusions)
3228 #
3229 # There are a few types of lines that may extend beyond $max_line_length:
3230 #       logging functions like pr_info that end in a string
3231 #       lines with a single string
3232 #       #defines that are a single string
3233 #       lines with an RFC3986 like URL
3234 #
3235 # There are 3 different line length message types:
3236 # LONG_LINE_COMMENT     a comment starts before but extends beyond $max_line_length
3237 # LONG_LINE_STRING      a string starts before but extends beyond $max_line_length
3238 # LONG_LINE             all other lines longer than $max_line_length
3239 #
3240 # if LONG_LINE is ignored, the other 2 types are also ignored
3241 #
3242
3243                 if ($line =~ /^\+/ && $length > $max_line_length) {
3244                         my $msg_type = "LONG_LINE";
3245
3246                         # Check the allowed long line types first
3247
3248                         # logging functions that end in a string that starts
3249                         # before $max_line_length
3250                         if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3251                             length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3252                                 $msg_type = "";
3253
3254                         # lines with only strings (w/ possible termination)
3255                         # #defines with only strings
3256                         } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
3257                                  $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
3258                                 $msg_type = "";
3259
3260                         # More special cases
3261                         } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
3262                                  $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
3263                                 $msg_type = "";
3264
3265                         # URL ($rawline is used in case the URL is in a comment)
3266                         } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) {
3267                                 $msg_type = "";
3268
3269                         # Otherwise set the alternate message types
3270
3271                         # a comment starts before $max_line_length
3272                         } elsif ($line =~ /($;[\s$;]*)$/ &&
3273                                  length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3274                                 $msg_type = "LONG_LINE_COMMENT"
3275
3276                         # a quoted string starts before $max_line_length
3277                         } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
3278                                  length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3279                                 $msg_type = "LONG_LINE_STRING"
3280                         }
3281
3282                         if ($msg_type ne "" &&
3283                             (show_type("LONG_LINE") || show_type($msg_type))) {
3284                                 my $msg_level = \&WARN;
3285                                 $msg_level = \&CHK if ($file);
3286                                 &{$msg_level}($msg_type,
3287                                               "line length of $length exceeds $max_line_length columns\n" . $herecurr);
3288                         }
3289                 }
3290
3291 # check for adding lines without a newline.
3292                 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
3293                         WARN("MISSING_EOF_NEWLINE",
3294                              "adding a line without newline at end of file\n" . $herecurr);
3295                 }
3296
3297 # check we are in a valid source file C or perl if not then ignore this hunk
3298                 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
3299
3300 # at the beginning of a line any tabs must come first and anything
3301 # more than $tabsize must use tabs.
3302                 if ($rawline =~ /^\+\s* \t\s*\S/ ||
3303                     $rawline =~ /^\+\s*        \s*/) {
3304                         my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3305                         $rpt_cleaners = 1;
3306                         if (ERROR("CODE_INDENT",
3307                                   "code indent should use tabs where possible\n" . $herevet) &&
3308                             $fix) {
3309                                 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3310                         }
3311                 }
3312
3313 # check for repeated words separated by a single space
3314                 if ($rawline =~ /^\+/) {
3315                         while ($rawline =~ /\b($word_pattern) (?=($word_pattern))/g) {
3316
3317                                 my $first = $1;
3318                                 my $second = $2;
3319
3320                                 if ($first =~ /(?:struct|union|enum)/) {
3321                                         pos($rawline) += length($first) + length($second) + 1;
3322                                         next;
3323                                 }
3324
3325                                 next if ($first ne $second);
3326                                 next if ($first eq 'long');
3327
3328                                 if (WARN("REPEATED_WORD",
3329                                          "Possible repeated word: '$first'\n" . $herecurr) &&
3330                                     $fix) {
3331                                         $fixed[$fixlinenr] =~ s/\b$first $second\b/$first/;
3332                                 }
3333                         }
3334
3335                         # if it's a repeated word on consecutive lines in a comment block
3336                         if ($prevline =~ /$;+\s*$/ &&
3337                             $prevrawline =~ /($word_pattern)\s*$/) {
3338                                 my $last_word = $1;
3339                                 if ($rawline =~ /^\+\s*\*\s*$last_word /) {
3340                                         if (WARN("REPEATED_WORD",
3341                                                  "Possible repeated word: '$last_word'\n" . $hereprev) &&
3342                                             $fix) {
3343                                                 $fixed[$fixlinenr] =~ s/(\+\s*\*\s*)$last_word /$1/;
3344                                         }
3345                                 }
3346                         }
3347                 }
3348
3349 # check for space before tabs.
3350                 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
3351                         my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3352                         if (WARN("SPACE_BEFORE_TAB",
3353                                 "please, no space before tabs\n" . $herevet) &&
3354                             $fix) {
3355                                 while ($fixed[$fixlinenr] =~
3356                                            s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {}
3357                                 while ($fixed[$fixlinenr] =~
3358                                            s/(^\+.*) +\t/$1\t/) {}
3359                         }
3360                 }
3361
3362 # check for assignments on the start of a line
3363                 if ($sline =~ /^\+\s+($Assignment)[^=]/) {
3364                         CHK("ASSIGNMENT_CONTINUATIONS",
3365                             "Assignment operator '$1' should be on the previous line\n" . $hereprev);
3366                 }
3367
3368 # check for && or || at the start of a line
3369                 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
3370                         CHK("LOGICAL_CONTINUATIONS",
3371                             "Logical continuations should be on the previous line\n" . $hereprev);
3372                 }
3373
3374 # check indentation starts on a tab stop
3375                 if ($perl_version_ok &&
3376                     $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
3377                         my $indent = length($1);
3378                         if ($indent % $tabsize) {
3379                                 if (WARN("TABSTOP",
3380                                          "Statements should start on a tabstop\n" . $herecurr) &&
3381                                     $fix) {
3382                                         $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e;
3383                                 }
3384                         }
3385                 }
3386
3387 # check multi-line statement indentation matches previous line
3388                 if ($perl_version_ok &&
3389                     $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
3390                         $prevline =~ /^\+(\t*)(.*)$/;
3391                         my $oldindent = $1;
3392                         my $rest = $2;
3393
3394                         my $pos = pos_last_openparen($rest);
3395                         if ($pos >= 0) {
3396                                 $line =~ /^(\+| )([ \t]*)/;
3397                                 my $newindent = $2;
3398
3399                                 my $goodtabindent = $oldindent .
3400                                         "\t" x ($pos / $tabsize) .
3401                                         " "  x ($pos % $tabsize);
3402                                 my $goodspaceindent = $oldindent . " "  x $pos;
3403
3404                                 if ($newindent ne $goodtabindent &&
3405                                     $newindent ne $goodspaceindent) {
3406
3407                                         if (CHK("PARENTHESIS_ALIGNMENT",
3408                                                 "Alignment should match open parenthesis\n" . $hereprev) &&
3409                                             $fix && $line =~ /^\+/) {
3410                                                 $fixed[$fixlinenr] =~
3411                                                     s/^\+[ \t]*/\+$goodtabindent/;
3412                                         }
3413                                 }
3414                         }
3415                 }
3416
3417 # check for space after cast like "(int) foo" or "(struct foo) bar"
3418 # avoid checking a few false positives:
3419 #   "sizeof(<type>)" or "__alignof__(<type>)"
3420 #   function pointer declarations like "(*foo)(int) = bar;"
3421 #   structure definitions like "(struct foo) { 0 };"
3422 #   multiline macros that define functions
3423 #   known attributes or the __attribute__ keyword
3424                 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
3425                     (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
3426                         if (CHK("SPACING",
3427                                 "No space is necessary after a cast\n" . $herecurr) &&
3428                             $fix) {
3429                                 $fixed[$fixlinenr] =~
3430                                     s/(\(\s*$Type\s*\))[ \t]+/$1/;
3431                         }
3432                 }
3433
3434 # Block comment styles
3435 # Networking with an initial /*
3436                 if ($realfile =~ m@^(drivers/net/|net/)@ &&
3437                     $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
3438                     $rawline =~ /^\+[ \t]*\*/ &&
3439                     $realline > 2) {
3440                         WARN("NETWORKING_BLOCK_COMMENT_STYLE",
3441                              "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3442                 }
3443
3444 # Block comments use * on subsequent lines
3445                 if ($prevline =~ /$;[ \t]*$/ &&                 #ends in comment
3446                     $prevrawline =~ /^\+.*?\/\*/ &&             #starting /*
3447                     $prevrawline !~ /\*\/[ \t]*$/ &&            #no trailing */
3448                     $rawline =~ /^\+/ &&                        #line is new
3449                     $rawline !~ /^\+[ \t]*\*/) {                #no leading *
3450                         WARN("BLOCK_COMMENT_STYLE",
3451                              "Block comments use * on subsequent lines\n" . $hereprev);
3452                 }
3453
3454 # Block comments use */ on trailing lines
3455                 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ &&       #trailing */
3456                     $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ &&      #inline /*...*/
3457                     $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ &&       #trailing **/
3458                     $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) {    #non blank */
3459                         WARN("BLOCK_COMMENT_STYLE",
3460                              "Block comments use a trailing */ on a separate line\n" . $herecurr);
3461                 }
3462
3463 # Block comment * alignment
3464                 if ($prevline =~ /$;[ \t]*$/ &&                 #ends in comment
3465                     $line =~ /^\+[ \t]*$;/ &&                   #leading comment
3466                     $rawline =~ /^\+[ \t]*\*/ &&                #leading *
3467                     (($prevrawline =~ /^\+.*?\/\*/ &&           #leading /*
3468                       $prevrawline !~ /\*\/[ \t]*$/) ||         #no trailing */
3469                      $prevrawline =~ /^\+[ \t]*\*/)) {          #leading *
3470                         my $oldindent;
3471                         $prevrawline =~ m@^\+([ \t]*/?)\*@;
3472                         if (defined($1)) {
3473                                 $oldindent = expand_tabs($1);
3474                         } else {
3475                                 $prevrawline =~ m@^\+(.*/?)\*@;
3476                                 $oldindent = expand_tabs($1);
3477                         }
3478                         $rawline =~ m@^\+([ \t]*)\*@;
3479                         my $newindent = $1;
3480                         $newindent = expand_tabs($newindent);
3481                         if (length($oldindent) ne length($newindent)) {
3482                                 WARN("BLOCK_COMMENT_STYLE",
3483                                      "Block comments should align the * on each line\n" . $hereprev);
3484                         }
3485                 }
3486
3487 # check for missing blank lines after struct/union declarations
3488 # with exceptions for various attributes and macros
3489                 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3490                     $line =~ /^\+/ &&
3491                     !($line =~ /^\+\s*$/ ||
3492                       $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3493                       $line =~ /^\+\s*MODULE_/i ||
3494                       $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3495                       $line =~ /^\+[a-z_]*init/ ||
3496                       $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3497                       $line =~ /^\+\s*DECLARE/ ||
3498                       $line =~ /^\+\s*builtin_[\w_]*driver/ ||
3499                       $line =~ /^\+\s*__setup/)) {
3500                         if (CHK("LINE_SPACING",
3501                                 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3502                             $fix) {
3503                                 fix_insert_line($fixlinenr, "\+");
3504                         }
3505                 }
3506
3507 # check for multiple consecutive blank lines
3508                 if ($prevline =~ /^[\+ ]\s*$/ &&
3509                     $line =~ /^\+\s*$/ &&
3510                     $last_blank_line != ($linenr - 1)) {
3511                         if (CHK("LINE_SPACING",
3512                                 "Please don't use multiple blank lines\n" . $hereprev) &&
3513                             $fix) {
3514                                 fix_delete_line($fixlinenr, $rawline);
3515                         }
3516
3517                         $last_blank_line = $linenr;
3518                 }
3519
3520 # check for missing blank lines after declarations
3521                 if ($sline =~ /^\+\s+\S/ &&                     #Not at char 1
3522                         # actual declarations
3523                     ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
3524                         # function pointer declarations
3525                      $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3526                         # foo bar; where foo is some local typedef or #define
3527                      $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3528                         # known declaration macros
3529                      $prevline =~ /^\+\s+$declaration_macros/) &&
3530                         # for "else if" which can look like "$Ident $Ident"
3531                     !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3532                         # other possible extensions of declaration lines
3533                       $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3534                         # not starting a section or a macro "\" extended line
3535                       $prevline =~ /(?:\{\s*|\\)$/) &&
3536                         # looks like a declaration
3537                     !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
3538                         # function pointer declarations
3539                       $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3540                         # foo bar; where foo is some local typedef or #define
3541                       $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3542                         # known declaration macros
3543                       $sline =~ /^\+\s+$declaration_macros/ ||
3544                         # start of struct or union or enum
3545                       $sline =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ ||
3546                         # start or end of block or continuation of declaration
3547                       $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3548                         # bitfield continuation
3549                       $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3550                         # other possible extensions of declaration lines
3551                       $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3552                         # indentation of previous and current line are the same
3553                     (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
3554                         if (WARN("LINE_SPACING",
3555                                  "Missing a blank line after declarations\n" . $hereprev) &&
3556                             $fix) {
3557                                 fix_insert_line($fixlinenr, "\+");
3558                         }
3559                 }
3560
3561 # check for spaces at the beginning of a line.
3562 # Exceptions:
3563 #  1) within comments
3564 #  2) indented preprocessor commands
3565 #  3) hanging labels
3566                 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/)  {
3567                         my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3568                         if (WARN("LEADING_SPACE",
3569                                  "please, no spaces at the start of a line\n" . $herevet) &&
3570                             $fix) {
3571                                 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3572                         }
3573                 }
3574
3575 # check we are in a valid C source file if not then ignore this hunk
3576                 next if ($realfile !~ /\.(h|c)$/);
3577
3578 # check for unusual line ending [ or (
3579                 if ($line =~ /^\+.*([\[\(])\s*$/) {
3580                         CHK("OPEN_ENDED_LINE",
3581                             "Lines should not end with a '$1'\n" . $herecurr);
3582                 }
3583
3584 # check if this appears to be the start function declaration, save the name
3585                 if ($sline =~ /^\+\{\s*$/ &&
3586                     $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
3587                         $context_function = $1;
3588                 }
3589
3590 # check if this appears to be the end of function declaration
3591                 if ($sline =~ /^\+\}\s*$/) {
3592                         undef $context_function;
3593                 }
3594
3595 # check indentation of any line with a bare else
3596 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
3597 # if the previous line is a break or return and is indented 1 tab more...
3598                 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3599                         my $tabs = length($1) + 1;
3600                         if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3601                             ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3602                              defined $lines[$linenr] &&
3603                              $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
3604                                 WARN("UNNECESSARY_ELSE",
3605                                      "else is not generally useful after a break or return\n" . $hereprev);
3606                         }
3607                 }
3608
3609 # check indentation of a line with a break;
3610 # if the previous line is a goto or return and is indented the same # of tabs
3611                 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3612                         my $tabs = $1;
3613                         if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3614                                 WARN("UNNECESSARY_BREAK",
3615                                      "break is not useful after a goto or return\n" . $hereprev);
3616                         }
3617                 }
3618
3619 # check for RCS/CVS revision markers
3620                 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
3621                         WARN("CVS_KEYWORD",
3622                              "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
3623                 }
3624
3625 # check for old HOTPLUG __dev<foo> section markings
3626                 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3627                         WARN("HOTPLUG_SECTION",
3628                              "Using $1 is unnecessary\n" . $herecurr);
3629                 }
3630
3631 # Check for potential 'bare' types
3632                 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3633                     $realline_next);
3634 #print "LINE<$line>\n";
3635                 if ($linenr > $suppress_statement &&
3636                     $realcnt && $sline =~ /.\s*\S/) {
3637                         ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3638                                 ctx_statement_block($linenr, $realcnt, 0);
3639                         $stat =~ s/\n./\n /g;
3640                         $cond =~ s/\n./\n /g;
3641
3642 #print "linenr<$linenr> <$stat>\n";
3643                         # If this statement has no statement boundaries within
3644                         # it there is no point in retrying a statement scan
3645                         # until we hit end of it.
3646                         my $frag = $stat; $frag =~ s/;+\s*$//;
3647                         if ($frag !~ /(?:{|;)/) {
3648 #print "skip<$line_nr_next>\n";
3649                                 $suppress_statement = $line_nr_next;
3650                         }
3651
3652                         # Find the real next line.
3653                         $realline_next = $line_nr_next;
3654                         if (defined $realline_next &&
3655                             (!defined $lines[$realline_next - 1] ||
3656                              substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3657                                 $realline_next++;
3658                         }
3659
3660                         my $s = $stat;
3661                         $s =~ s/{.*$//s;
3662
3663                         # Ignore goto labels.
3664                         if ($s =~ /$Ident:\*$/s) {
3665
3666                         # Ignore functions being called
3667                         } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
3668
3669                         } elsif ($s =~ /^.\s*else\b/s) {
3670
3671                         # declarations always start with types
3672                         } 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) {
3673                                 my $type = $1;
3674                                 $type =~ s/\s+/ /g;
3675                                 possible($type, "A:" . $s);
3676
3677                         # definitions in global scope can only start with types
3678                         } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
3679                                 possible($1, "B:" . $s);
3680                         }
3681
3682                         # any (foo ... *) is a pointer cast, and foo is a type
3683                         while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
3684                                 possible($1, "C:" . $s);
3685                         }
3686
3687                         # Check for any sort of function declaration.
3688                         # int foo(something bar, other baz);
3689                         # void (*store_gdt)(x86_descr_ptr *);
3690                         if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3691                                 my ($name_len) = length($1);
3692
3693                                 my $ctx = $s;
3694                                 substr($ctx, 0, $name_len + 1, '');
3695                                 $ctx =~ s/\)[^\)]*$//;
3696
3697                                 for my $arg (split(/\s*,\s*/, $ctx)) {
3698                                         if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3699
3700                                                 possible($1, "D:" . $s);
3701                                         }
3702                                 }
3703                         }
3704
3705                 }
3706
3707 #
3708 # Checks which may be anchored in the context.
3709 #
3710
3711 # Check for switch () and associated case and default
3712 # statements should be at the same indent.
3713                 if ($line=~/\bswitch\s*\(.*\)/) {
3714                         my $err = '';
3715                         my $sep = '';
3716                         my @ctx = ctx_block_outer($linenr, $realcnt);
3717                         shift(@ctx);
3718                         for my $ctx (@ctx) {
3719                                 my ($clen, $cindent) = line_stats($ctx);
3720                                 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3721                                                         $indent != $cindent) {
3722                                         $err .= "$sep$ctx\n";
3723                                         $sep = '';
3724                                 } else {
3725                                         $sep = "[...]\n";
3726                                 }
3727                         }
3728                         if ($err ne '') {
3729                                 ERROR("SWITCH_CASE_INDENT_LEVEL",
3730                                       "switch and case should be at the same indent\n$hereline$err");
3731                         }
3732                 }
3733
3734 # if/while/etc brace do not go on next line, unless defining a do while loop,
3735 # or if that brace on the next line is for something else
3736                 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3737                         my $pre_ctx = "$1$2";
3738
3739                         my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
3740
3741                         if ($line =~ /^\+\t{6,}/) {
3742                                 WARN("DEEP_INDENTATION",
3743                                      "Too many leading tabs - consider code refactoring\n" . $herecurr);
3744                         }
3745
3746                         my $ctx_cnt = $realcnt - $#ctx - 1;
3747                         my $ctx = join("\n", @ctx);
3748
3749                         my $ctx_ln = $linenr;
3750                         my $ctx_skip = $realcnt;
3751
3752                         while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3753                                         defined $lines[$ctx_ln - 1] &&
3754                                         $lines[$ctx_ln - 1] =~ /^-/)) {
3755                                 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3756                                 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
3757                                 $ctx_ln++;
3758                         }
3759
3760                         #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3761                         #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3762
3763                         if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
3764                                 ERROR("OPEN_BRACE",
3765                                       "that open brace { should be on the previous line\n" .
3766                                         "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3767                         }
3768                         if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3769                             $ctx =~ /\)\s*\;\s*$/ &&
3770                             defined $lines[$ctx_ln - 1])
3771                         {
3772                                 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3773                                 if ($nindent > $indent) {
3774                                         WARN("TRAILING_SEMICOLON",
3775                                              "trailing semicolon indicates no statements, indent implies otherwise\n" .
3776                                                 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3777                                 }
3778                         }
3779                 }
3780
3781 # Check relative indent for conditionals and blocks.
3782                 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3783                         ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3784                                 ctx_statement_block($linenr, $realcnt, 0)
3785                                         if (!defined $stat);
3786                         my ($s, $c) = ($stat, $cond);
3787
3788                         substr($s, 0, length($c), '');
3789
3790                         # remove inline comments
3791                         $s =~ s/$;/ /g;
3792                         $c =~ s/$;/ /g;
3793
3794                         # Find out how long the conditional actually is.
3795                         my @newlines = ($c =~ /\n/gs);
3796                         my $cond_lines = 1 + $#newlines;
3797
3798                         # Make sure we remove the line prefixes as we have
3799                         # none on the first line, and are going to readd them
3800                         # where necessary.
3801                         $s =~ s/\n./\n/gs;
3802                         while ($s =~ /\n\s+\\\n/) {
3803                                 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3804                         }
3805
3806                         # We want to check the first line inside the block
3807                         # starting at the end of the conditional, so remove:
3808                         #  1) any blank line termination
3809                         #  2) any opening brace { on end of the line
3810                         #  3) any do (...) {
3811                         my $continuation = 0;
3812                         my $check = 0;
3813                         $s =~ s/^.*\bdo\b//;
3814                         $s =~ s/^\s*{//;
3815                         if ($s =~ s/^\s*\\//) {
3816                                 $continuation = 1;
3817                         }
3818                         if ($s =~ s/^\s*?\n//) {
3819                                 $check = 1;
3820                                 $cond_lines++;
3821                         }
3822
3823                         # Also ignore a loop construct at the end of a
3824                         # preprocessor statement.
3825                         if (($prevline =~ /^.\s*#\s*define\s/ ||
3826                             $prevline =~ /\\\s*$/) && $continuation == 0) {
3827                                 $check = 0;
3828                         }
3829
3830                         my $cond_ptr = -1;
3831                         $continuation = 0;
3832                         while ($cond_ptr != $cond_lines) {
3833                                 $cond_ptr = $cond_lines;
3834
3835                                 # If we see an #else/#elif then the code
3836                                 # is not linear.
3837                                 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3838                                         $check = 0;
3839                                 }
3840
3841                                 # Ignore:
3842                                 #  1) blank lines, they should be at 0,
3843                                 #  2) preprocessor lines, and
3844                                 #  3) labels.
3845                                 if ($continuation ||
3846                                     $s =~ /^\s*?\n/ ||
3847                                     $s =~ /^\s*#\s*?/ ||
3848                                     $s =~ /^\s*$Ident\s*:/) {
3849                                         $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
3850                                         if ($s =~ s/^.*?\n//) {
3851                                                 $cond_lines++;
3852                                         }
3853                                 }
3854                         }
3855
3856                         my (undef, $sindent) = line_stats("+" . $s);
3857                         my $stat_real = raw_line($linenr, $cond_lines);
3858
3859                         # Check if either of these lines are modified, else
3860                         # this is not this patch's fault.
3861                         if (!defined($stat_real) ||
3862                             $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3863                                 $check = 0;
3864                         }
3865                         if (defined($stat_real) && $cond_lines > 1) {
3866                                 $stat_real = "[...]\n$stat_real";
3867                         }
3868
3869                         #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";
3870
3871                         if ($check && $s ne '' &&
3872                             (($sindent % $tabsize) != 0 ||
3873                              ($sindent < $indent) ||
3874                              ($sindent == $indent &&
3875                               ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
3876                              ($sindent > $indent + $tabsize))) {
3877                                 WARN("SUSPECT_CODE_INDENT",
3878                                      "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3879                         }
3880                 }
3881
3882                 # Track the 'values' across context and added lines.
3883                 my $opline = $line; $opline =~ s/^./ /;
3884                 my ($curr_values, $curr_vars) =
3885                                 annotate_values($opline . "\n", $prev_values);
3886                 $curr_values = $prev_values . $curr_values;
3887                 if ($dbg_values) {
3888                         my $outline = $opline; $outline =~ s/\t/ /g;
3889                         print "$linenr > .$outline\n";
3890                         print "$linenr > $curr_values\n";
3891                         print "$linenr >  $curr_vars\n";
3892                 }
3893                 $prev_values = substr($curr_values, -1);
3894
3895 #ignore lines not being added
3896                 next if ($line =~ /^[^\+]/);
3897
3898 # check for dereferences that span multiple lines
3899                 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
3900                     $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
3901                         $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
3902                         my $ref = $1;
3903                         $line =~ /^.\s*($Lval)/;
3904                         $ref .= $1;
3905                         $ref =~ s/\s//g;
3906                         WARN("MULTILINE_DEREFERENCE",
3907                              "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
3908                 }
3909
3910 # check for declarations of signed or unsigned without int
3911                 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3912                         my $type = $1;
3913                         my $var = $2;
3914                         $var = "" if (!defined $var);
3915                         if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
3916                                 my $sign = $1;
3917                                 my $pointer = $2;
3918
3919                                 $pointer = "" if (!defined $pointer);
3920
3921                                 if (WARN("UNSPECIFIED_INT",
3922                                          "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3923                                     $fix) {
3924                                         my $decl = trim($sign) . " int ";
3925                                         my $comp_pointer = $pointer;
3926                                         $comp_pointer =~ s/\s//g;
3927                                         $decl .= $comp_pointer;
3928                                         $decl = rtrim($decl) if ($var eq "");
3929                                         $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
3930                                 }
3931                         }
3932                 }
3933
3934 # TEST: allow direct testing of the type matcher.
3935                 if ($dbg_type) {
3936                         if ($line =~ /^.\s*$Declare\s*$/) {
3937                                 ERROR("TEST_TYPE",
3938                                       "TEST: is type\n" . $herecurr);
3939                         } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
3940                                 ERROR("TEST_NOT_TYPE",
3941                                       "TEST: is not type ($1 is)\n". $herecurr);
3942                         }
3943                         next;
3944                 }
3945 # TEST: allow direct testing of the attribute matcher.
3946                 if ($dbg_attr) {
3947                         if ($line =~ /^.\s*$Modifier\s*$/) {
3948                                 ERROR("TEST_ATTR",
3949                                       "TEST: is attr\n" . $herecurr);
3950                         } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
3951                                 ERROR("TEST_NOT_ATTR",
3952                                       "TEST: is not attr ($1 is)\n". $herecurr);
3953                         }
3954                         next;
3955                 }
3956
3957 # check for initialisation to aggregates open brace on the next line
3958                 if ($line =~ /^.\s*{/ &&
3959                     $prevline =~ /(?:^|[^=])=\s*$/) {
3960                         if (ERROR("OPEN_BRACE",
3961                                   "that open brace { should be on the previous line\n" . $hereprev) &&
3962                             $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3963                                 fix_delete_line($fixlinenr - 1, $prevrawline);
3964                                 fix_delete_line($fixlinenr, $rawline);
3965                                 my $fixedline = $prevrawline;
3966                                 $fixedline =~ s/\s*=\s*$/ = {/;
3967                                 fix_insert_line($fixlinenr, $fixedline);
3968                                 $fixedline = $line;
3969                                 $fixedline =~ s/^(.\s*)\{\s*/$1/;
3970                                 fix_insert_line($fixlinenr, $fixedline);
3971                         }
3972                 }
3973
3974 #
3975 # Checks which are anchored on the added line.
3976 #
3977
3978 # check for malformed paths in #include statements (uses RAW line)
3979                 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
3980                         my $path = $1;
3981                         if ($path =~ m{//}) {
3982                                 ERROR("MALFORMED_INCLUDE",
3983                                       "malformed #include filename\n" . $herecurr);
3984                         }
3985                         if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3986                                 ERROR("UAPI_INCLUDE",
3987                                       "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
3988                         }
3989                 }
3990
3991 # no C99 // comments
3992                 if ($line =~ m{//}) {
3993                         if (ERROR("C99_COMMENTS",
3994                                   "do not use C99 // comments\n" . $herecurr) &&
3995                             $fix) {
3996                                 my $line = $fixed[$fixlinenr];
3997                                 if ($line =~ /\/\/(.*)$/) {
3998                                         my $comment = trim($1);
3999                                         $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
4000                                 }
4001                         }
4002                 }
4003                 # Remove C99 comments.
4004                 $line =~ s@//.*@@;
4005                 $opline =~ s@//.*@@;
4006
4007 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
4008 # the whole statement.
4009 #print "APW <$lines[$realline_next - 1]>\n";
4010                 if (defined $realline_next &&
4011                     exists $lines[$realline_next - 1] &&
4012                     !defined $suppress_export{$realline_next} &&
4013                     ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
4014                      $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
4015                         # Handle definitions which produce identifiers with
4016                         # a prefix:
4017                         #   XXX(foo);
4018                         #   EXPORT_SYMBOL(something_foo);
4019                         my $name = $1;
4020                         if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
4021                             $name =~ /^${Ident}_$2/) {
4022 #print "FOO C name<$name>\n";
4023                                 $suppress_export{$realline_next} = 1;
4024
4025                         } elsif ($stat !~ /(?:
4026                                 \n.}\s*$|
4027                                 ^.DEFINE_$Ident\(\Q$name\E\)|
4028                                 ^.DECLARE_$Ident\(\Q$name\E\)|
4029                                 ^.LIST_HEAD\(\Q$name\E\)|
4030                                 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
4031                                 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
4032                             )/x) {
4033 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
4034                                 $suppress_export{$realline_next} = 2;
4035                         } else {
4036                                 $suppress_export{$realline_next} = 1;
4037                         }
4038                 }
4039                 if (!defined $suppress_export{$linenr} &&
4040                     $prevline =~ /^.\s*$/ &&
4041                     ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
4042                      $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
4043 #print "FOO B <$lines[$linenr - 1]>\n";
4044                         $suppress_export{$linenr} = 2;
4045                 }
4046                 if (defined $suppress_export{$linenr} &&
4047                     $suppress_export{$linenr} == 2) {
4048                         WARN("EXPORT_SYMBOL",
4049                              "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
4050                 }
4051
4052 # check for global initialisers.
4053                 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
4054                         if (ERROR("GLOBAL_INITIALISERS",
4055                                   "do not initialise globals to $1\n" . $herecurr) &&
4056                             $fix) {
4057                                 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
4058                         }
4059                 }
4060 # check for static initialisers.
4061                 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
4062                         if (ERROR("INITIALISED_STATIC",
4063                                   "do not initialise statics to $1\n" .
4064                                       $herecurr) &&
4065                             $fix) {
4066                                 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
4067                         }
4068                 }
4069
4070 # check for misordered declarations of char/short/int/long with signed/unsigned
4071                 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
4072                         my $tmp = trim($1);
4073                         WARN("MISORDERED_TYPE",
4074                              "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
4075                 }
4076
4077 # check for unnecessary <signed> int declarations of short/long/long long
4078                 while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) {
4079                         my $type = trim($1);
4080                         next if ($type !~ /\bint\b/);
4081                         next if ($type !~ /\b(?:short|long\s+long|long)\b/);
4082                         my $new_type = $type;
4083                         $new_type =~ s/\b\s*int\s*\b/ /;
4084                         $new_type =~ s/\b\s*(?:un)?signed\b\s*/ /;
4085                         $new_type =~ s/^const\s+//;
4086                         $new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/);
4087                         $new_type = "const $new_type" if ($type =~ /^const\b/);
4088                         $new_type =~ s/\s+/ /g;
4089                         $new_type = trim($new_type);
4090                         if (WARN("UNNECESSARY_INT",
4091                                  "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) &&
4092                             $fix) {
4093                                 $fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/;
4094                         }
4095                 }
4096
4097 # check for static const char * arrays.
4098                 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
4099                         WARN("STATIC_CONST_CHAR_ARRAY",
4100                              "static const char * array should probably be static const char * const\n" .
4101                                 $herecurr);
4102                 }
4103
4104 # check for initialized const char arrays that should be static const
4105                 if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) {
4106                         if (WARN("STATIC_CONST_CHAR_ARRAY",
4107                                  "const array should probably be static const\n" . $herecurr) &&
4108                             $fix) {
4109                                 $fixed[$fixlinenr] =~ s/(^.\s*)const\b/${1}static const/;
4110                         }
4111                 }
4112
4113 # check for static char foo[] = "bar" declarations.
4114                 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
4115                         WARN("STATIC_CONST_CHAR_ARRAY",
4116                              "static char array declaration should probably be static const char\n" .
4117                                 $herecurr);
4118                 }
4119
4120 # check for const <foo> const where <foo> is not a pointer or array type
4121                 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
4122                         my $found = $1;
4123                         if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
4124                                 WARN("CONST_CONST",
4125                                      "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
4126                         } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
4127                                 WARN("CONST_CONST",
4128                                      "'const $found const' should probably be 'const $found'\n" . $herecurr);
4129                         }
4130                 }
4131
4132 # check for non-global char *foo[] = {"bar", ...} declarations.
4133                 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
4134                         WARN("STATIC_CONST_CHAR_ARRAY",
4135                              "char * array declaration might be better as static const\n" .
4136                                 $herecurr);
4137                }
4138
4139 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
4140                 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
4141                         my $array = $1;
4142                         if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
4143                                 my $array_div = $1;
4144                                 if (WARN("ARRAY_SIZE",
4145                                          "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
4146                                     $fix) {
4147                                         $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
4148                                 }
4149                         }
4150                 }
4151
4152 # check for function declarations without arguments like "int foo()"
4153                 if ($line =~ /(\b$Type\s*$Ident)\s*\(\s*\)/) {
4154                         if (ERROR("FUNCTION_WITHOUT_ARGS",
4155                                   "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
4156                             $fix) {
4157                                 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
4158                         }
4159                 }
4160
4161 # check for new typedefs, only function parameters and sparse annotations
4162 # make sense.
4163                 if ($line =~ /\btypedef\s/ &&
4164                     $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
4165                     $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
4166                     $line !~ /\b$typeTypedefs\b/ &&
4167                     $line !~ /\b__bitwise\b/) {
4168                         WARN("NEW_TYPEDEFS",
4169                              "do not add new typedefs\n" . $herecurr);
4170                 }
4171
4172 # * goes on variable not on type
4173                 # (char*[ const])
4174                 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
4175                         #print "AA<$1>\n";
4176                         my ($ident, $from, $to) = ($1, $2, $2);
4177
4178                         # Should start with a space.
4179                         $to =~ s/^(\S)/ $1/;
4180                         # Should not end with a space.
4181                         $to =~ s/\s+$//;
4182                         # '*'s should not have spaces between.
4183                         while ($to =~ s/\*\s+\*/\*\*/) {
4184                         }
4185
4186 ##                      print "1: from<$from> to<$to> ident<$ident>\n";
4187                         if ($from ne $to) {
4188                                 if (ERROR("POINTER_LOCATION",
4189                                           "\"(foo$from)\" should be \"(foo$to)\"\n" .  $herecurr) &&
4190                                     $fix) {
4191                                         my $sub_from = $ident;
4192                                         my $sub_to = $ident;
4193                                         $sub_to =~ s/\Q$from\E/$to/;
4194                                         $fixed[$fixlinenr] =~
4195                                             s@\Q$sub_from\E@$sub_to@;
4196                                 }
4197                         }
4198                 }
4199                 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
4200                         #print "BB<$1>\n";
4201                         my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
4202
4203                         # Should start with a space.
4204                         $to =~ s/^(\S)/ $1/;
4205                         # Should not end with a space.
4206                         $to =~ s/\s+$//;
4207                         # '*'s should not have spaces between.
4208                         while ($to =~ s/\*\s+\*/\*\*/) {
4209                         }
4210                         # Modifiers should have spaces.
4211                         $to =~ s/(\b$Modifier$)/$1 /;
4212
4213 ##                      print "2: from<$from> to<$to> ident<$ident>\n";
4214                         if ($from ne $to && $ident !~ /^$Modifier$/) {
4215                                 if (ERROR("POINTER_LOCATION",
4216                                           "\"foo${from}bar\" should be \"foo${to}bar\"\n" .  $herecurr) &&
4217                                     $fix) {
4218
4219                                         my $sub_from = $match;
4220                                         my $sub_to = $match;
4221                                         $sub_to =~ s/\Q$from\E/$to/;
4222                                         $fixed[$fixlinenr] =~
4223                                             s@\Q$sub_from\E@$sub_to@;
4224                                 }
4225                         }
4226                 }
4227
4228 # avoid BUG() or BUG_ON()
4229                 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
4230                         my $msg_level = \&WARN;
4231                         $msg_level = \&CHK if ($file);
4232                         &{$msg_level}("AVOID_BUG",
4233                                       "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
4234                 }
4235
4236 # avoid LINUX_VERSION_CODE
4237                 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
4238                         WARN("LINUX_VERSION_CODE",
4239                              "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
4240                 }
4241
4242 # check for uses of printk_ratelimit
4243                 if ($line =~ /\bprintk_ratelimit\s*\(/) {
4244                         WARN("PRINTK_RATELIMITED",
4245                              "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
4246                 }
4247
4248 # printk should use KERN_* levels
4249                 if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
4250                         WARN("PRINTK_WITHOUT_KERN_LEVEL",
4251                              "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
4252                 }
4253
4254                 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
4255                         my $orig = $1;
4256                         my $level = lc($orig);
4257                         $level = "warn" if ($level eq "warning");
4258                         my $level2 = $level;
4259                         $level2 = "dbg" if ($level eq "debug");
4260                         WARN("PREFER_PR_LEVEL",
4261                              "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(...  to printk(KERN_$orig ...\n" . $herecurr);
4262                 }
4263
4264                 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
4265                         my $orig = $1;
4266                         my $level = lc($orig);
4267                         $level = "warn" if ($level eq "warning");
4268                         $level = "dbg" if ($level eq "debug");
4269                         WARN("PREFER_DEV_LEVEL",
4270                              "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
4271                 }
4272
4273 # ENOSYS means "bad syscall nr" and nothing else.  This will have a small
4274 # number of false positives, but assembly files are not checked, so at
4275 # least the arch entry code will not trigger this warning.
4276                 if ($line =~ /\bENOSYS\b/) {
4277                         WARN("ENOSYS",
4278                              "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
4279                 }
4280
4281 # ENOTSUPP is not a standard error code and should be avoided in new patches.
4282 # Folks usually mean EOPNOTSUPP (also called ENOTSUP), when they type ENOTSUPP.
4283 # Similarly to ENOSYS warning a small number of false positives is expected.
4284                 if (!$file && $line =~ /\bENOTSUPP\b/) {
4285                         if (WARN("ENOTSUPP",
4286                                  "ENOTSUPP is not a SUSV4 error code, prefer EOPNOTSUPP\n" . $herecurr) &&
4287                             $fix) {
4288                                 $fixed[$fixlinenr] =~ s/\bENOTSUPP\b/EOPNOTSUPP/;
4289                         }
4290                 }
4291
4292 # function brace can't be on same line, except for #defines of do while,
4293 # or if closed on same line
4294                 if ($perl_version_ok &&
4295                     $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ &&
4296                     $sline !~ /\#\s*define\b.*do\s*\{/ &&
4297                     $sline !~ /}/) {
4298                         if (ERROR("OPEN_BRACE",
4299                                   "open brace '{' following function definitions go on the next line\n" . $herecurr) &&
4300                             $fix) {
4301                                 fix_delete_line($fixlinenr, $rawline);
4302                                 my $fixed_line = $rawline;
4303                                 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
4304                                 my $line1 = $1;
4305                                 my $line2 = $2;
4306                                 fix_insert_line($fixlinenr, ltrim($line1));
4307                                 fix_insert_line($fixlinenr, "\+{");
4308                                 if ($line2 !~ /^\s*$/) {
4309                                         fix_insert_line($fixlinenr, "\+\t" . trim($line2));
4310                                 }
4311                         }
4312                 }
4313
4314 # open braces for enum, union and struct go on the same line.
4315                 if ($line =~ /^.\s*{/ &&
4316                     $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
4317                         if (ERROR("OPEN_BRACE",
4318                                   "open brace '{' following $1 go on the same line\n" . $hereprev) &&
4319                             $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4320                                 fix_delete_line($fixlinenr - 1, $prevrawline);
4321                                 fix_delete_line($fixlinenr, $rawline);
4322                                 my $fixedline = rtrim($prevrawline) . " {";
4323                                 fix_insert_line($fixlinenr, $fixedline);
4324                                 $fixedline = $rawline;
4325                                 $fixedline =~ s/^(.\s*)\{\s*/$1\t/;
4326                                 if ($fixedline !~ /^\+\s*$/) {
4327                                         fix_insert_line($fixlinenr, $fixedline);
4328                                 }
4329                         }
4330                 }
4331
4332 # missing space after union, struct or enum definition
4333                 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
4334                         if (WARN("SPACING",
4335                                  "missing space after $1 definition\n" . $herecurr) &&
4336                             $fix) {
4337                                 $fixed[$fixlinenr] =~
4338                                     s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
4339                         }
4340                 }
4341
4342 # Function pointer declarations
4343 # check spacing between type, funcptr, and args
4344 # canonical declaration is "type (*funcptr)(args...)"
4345                 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
4346                         my $declare = $1;
4347                         my $pre_pointer_space = $2;
4348                         my $post_pointer_space = $3;
4349                         my $funcname = $4;
4350                         my $post_funcname_space = $5;
4351                         my $pre_args_space = $6;
4352
4353 # the $Declare variable will capture all spaces after the type
4354 # so check it for a missing trailing missing space but pointer return types
4355 # don't need a space so don't warn for those.
4356                         my $post_declare_space = "";
4357                         if ($declare =~ /(\s+)$/) {
4358                                 $post_declare_space = $1;
4359                                 $declare = rtrim($declare);
4360                         }
4361                         if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
4362                                 WARN("SPACING",
4363                                      "missing space after return type\n" . $herecurr);
4364                                 $post_declare_space = " ";
4365                         }
4366
4367 # unnecessary space "type  (*funcptr)(args...)"
4368 # This test is not currently implemented because these declarations are
4369 # equivalent to
4370 #       int  foo(int bar, ...)
4371 # and this is form shouldn't/doesn't generate a checkpatch warning.
4372 #
4373 #                       elsif ($declare =~ /\s{2,}$/) {
4374 #                               WARN("SPACING",
4375 #                                    "Multiple spaces after return type\n" . $herecurr);
4376 #                       }
4377
4378 # unnecessary space "type ( *funcptr)(args...)"
4379                         if (defined $pre_pointer_space &&
4380                             $pre_pointer_space =~ /^\s/) {
4381                                 WARN("SPACING",
4382                                      "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
4383                         }
4384
4385 # unnecessary space "type (* funcptr)(args...)"
4386                         if (defined $post_pointer_space &&
4387                             $post_pointer_space =~ /^\s/) {
4388                                 WARN("SPACING",
4389                                      "Unnecessary space before function pointer name\n" . $herecurr);
4390                         }
4391
4392 # unnecessary space "type (*funcptr )(args...)"
4393                         if (defined $post_funcname_space &&
4394                             $post_funcname_space =~ /^\s/) {
4395                                 WARN("SPACING",
4396                                      "Unnecessary space after function pointer name\n" . $herecurr);
4397                         }
4398
4399 # unnecessary space "type (*funcptr) (args...)"
4400                         if (defined $pre_args_space &&
4401                             $pre_args_space =~ /^\s/) {
4402                                 WARN("SPACING",
4403                                      "Unnecessary space before function pointer arguments\n" . $herecurr);
4404                         }
4405
4406                         if (show_type("SPACING") && $fix) {
4407                                 $fixed[$fixlinenr] =~
4408                                     s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
4409                         }
4410                 }
4411
4412 # check for spacing round square brackets; allowed:
4413 #  1. with a type on the left -- int [] a;
4414 #  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4415 #  3. inside a curly brace -- = { [0...10] = 5 }
4416                 while ($line =~ /(.*?\s)\[/g) {
4417                         my ($where, $prefix) = ($-[1], $1);
4418                         if ($prefix !~ /$Type\s+$/ &&
4419                             ($where != 0 || $prefix !~ /^.\s+$/) &&
4420                             $prefix !~ /[{,:]\s+$/) {
4421                                 if (ERROR("BRACKET_SPACE",
4422                                           "space prohibited before open square bracket '['\n" . $herecurr) &&
4423                                     $fix) {
4424                                     $fixed[$fixlinenr] =~
4425                                         s/^(\+.*?)\s+\[/$1\[/;
4426                                 }
4427                         }
4428                 }
4429
4430 # check for spaces between functions and their parentheses.
4431                 while ($line =~ /($Ident)\s+\(/g) {
4432                         my $name = $1;
4433                         my $ctx_before = substr($line, 0, $-[1]);
4434                         my $ctx = "$ctx_before$name";
4435
4436                         # Ignore those directives where spaces _are_ permitted.
4437                         if ($name =~ /^(?:
4438                                 if|for|while|switch|return|case|
4439                                 volatile|__volatile__|
4440                                 __attribute__|format|__extension__|
4441                                 asm|__asm__)$/x)
4442                         {
4443                         # cpp #define statements have non-optional spaces, ie
4444                         # if there is a space between the name and the open
4445                         # parenthesis it is simply not a parameter group.
4446                         } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
4447
4448                         # cpp #elif statement condition may start with a (
4449                         } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
4450
4451                         # If this whole things ends with a type its most
4452                         # likely a typedef for a function.
4453                         } elsif ($ctx =~ /$Type$/) {
4454
4455                         } else {
4456                                 if (WARN("SPACING",
4457                                          "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
4458                                              $fix) {
4459                                         $fixed[$fixlinenr] =~
4460                                             s/\b$name\s+\(/$name\(/;
4461                                 }
4462                         }
4463                 }
4464
4465 # Check operator spacing.
4466                 if (!($line=~/\#\s*include/)) {
4467                         my $fixed_line = "";
4468                         my $line_fixed = 0;
4469
4470                         my $ops = qr{
4471                                 <<=|>>=|<=|>=|==|!=|
4472                                 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4473                                 =>|->|<<|>>|<|>|=|!|~|
4474                                 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
4475                                 \?:|\?|:
4476                         }x;
4477                         my @elements = split(/($ops|;)/, $opline);
4478
4479 ##                      print("element count: <" . $#elements . ">\n");
4480 ##                      foreach my $el (@elements) {
4481 ##                              print("el: <$el>\n");
4482 ##                      }
4483
4484                         my @fix_elements = ();
4485                         my $off = 0;
4486
4487                         foreach my $el (@elements) {
4488                                 push(@fix_elements, substr($rawline, $off, length($el)));
4489                                 $off += length($el);
4490                         }
4491
4492                         $off = 0;
4493
4494                         my $blank = copy_spacing($opline);
4495                         my $last_after = -1;
4496
4497                         for (my $n = 0; $n < $#elements; $n += 2) {
4498
4499                                 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4500
4501 ##                              print("n: <$n> good: <$good>\n");
4502
4503                                 $off += length($elements[$n]);
4504
4505                                 # Pick up the preceding and succeeding characters.
4506                                 my $ca = substr($opline, 0, $off);
4507                                 my $cc = '';
4508                                 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4509                                         $cc = substr($opline, $off + length($elements[$n + 1]));
4510                                 }
4511                                 my $cb = "$ca$;$cc";
4512
4513                                 my $a = '';
4514                                 $a = 'V' if ($elements[$n] ne '');
4515                                 $a = 'W' if ($elements[$n] =~ /\s$/);
4516                                 $a = 'C' if ($elements[$n] =~ /$;$/);
4517                                 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4518                                 $a = 'O' if ($elements[$n] eq '');
4519                                 $a = 'E' if ($ca =~ /^\s*$/);
4520
4521                                 my $op = $elements[$n + 1];
4522
4523                                 my $c = '';
4524                                 if (defined $elements[$n + 2]) {
4525                                         $c = 'V' if ($elements[$n + 2] ne '');
4526                                         $c = 'W' if ($elements[$n + 2] =~ /^\s/);
4527                                         $c = 'C' if ($elements[$n + 2] =~ /^$;/);
4528                                         $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4529                                         $c = 'O' if ($elements[$n + 2] eq '');
4530                                         $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
4531                                 } else {
4532                                         $c = 'E';
4533                                 }
4534
4535                                 my $ctx = "${a}x${c}";
4536
4537                                 my $at = "(ctx:$ctx)";
4538
4539                                 my $ptr = substr($blank, 0, $off) . "^";
4540                                 my $hereptr = "$hereline$ptr\n";
4541
4542                                 # Pull out the value of this operator.
4543                                 my $op_type = substr($curr_values, $off + 1, 1);
4544
4545                                 # Get the full operator variant.
4546                                 my $opv = $op . substr($curr_vars, $off, 1);
4547
4548                                 # Ignore operators passed as parameters.
4549                                 if ($op_type ne 'V' &&
4550                                     $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
4551
4552 #                               # Ignore comments
4553 #                               } elsif ($op =~ /^$;+$/) {
4554
4555                                 # ; should have either the end of line or a space or \ after it
4556                                 } elsif ($op eq ';') {
4557                                         if ($ctx !~ /.x[WEBC]/ &&
4558                                             $cc !~ /^\\/ && $cc !~ /^;/) {
4559                                                 if (ERROR("SPACING",
4560                                                           "space required after that '$op' $at\n" . $hereptr)) {
4561                                                         $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
4562                                                         $line_fixed = 1;
4563                                                 }
4564                                         }
4565
4566                                 # // is a comment
4567                                 } elsif ($op eq '//') {
4568
4569                                 #   :   when part of a bitfield
4570                                 } elsif ($opv eq ':B') {
4571                                         # skip the bitfield test for now
4572
4573                                 # No spaces for:
4574                                 #   ->
4575                                 } elsif ($op eq '->') {
4576                                         if ($ctx =~ /Wx.|.xW/) {
4577                                                 if (ERROR("SPACING",
4578                                                           "spaces prohibited around that '$op' $at\n" . $hereptr)) {
4579                                                         $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4580                                                         if (defined $fix_elements[$n + 2]) {
4581                                                                 $fix_elements[$n + 2] =~ s/^\s+//;
4582                                                         }
4583                                                         $line_fixed = 1;
4584                                                 }
4585                                         }
4586
4587                                 # , must not have a space before and must have a space on the right.
4588                                 } elsif ($op eq ',') {
4589                                         my $rtrim_before = 0;
4590                                         my $space_after = 0;
4591                                         if ($ctx =~ /Wx./) {
4592                                                 if (ERROR("SPACING",
4593                                                           "space prohibited before that '$op' $at\n" . $hereptr)) {
4594                                                         $line_fixed = 1;
4595                                                         $rtrim_before = 1;
4596                                                 }
4597                                         }
4598                                         if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
4599                                                 if (ERROR("SPACING",
4600                                                           "space required after that '$op' $at\n" . $hereptr)) {
4601                                                         $line_fixed = 1;
4602                                                         $last_after = $n;
4603                                                         $space_after = 1;
4604                                                 }
4605                                         }
4606                                         if ($rtrim_before || $space_after) {
4607                                                 if ($rtrim_before) {
4608                                                         $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4609                                                 } else {
4610                                                         $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4611                                                 }
4612                                                 if ($space_after) {
4613                                                         $good .= " ";
4614                                                 }
4615                                         }
4616
4617                                 # '*' as part of a type definition -- reported already.
4618                                 } elsif ($opv eq '*_') {
4619                                         #warn "'*' is part of type\n";
4620
4621                                 # unary operators should have a space before and
4622                                 # none after.  May be left adjacent to another
4623                                 # unary operator, or a cast
4624                                 } elsif ($op eq '!' || $op eq '~' ||
4625                                          $opv eq '*U' || $opv eq '-U' ||
4626                                          $opv eq '&U' || $opv eq '&&U') {
4627                                         if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
4628                                                 if (ERROR("SPACING",
4629                                                           "space required before that '$op' $at\n" . $hereptr)) {
4630                                                         if ($n != $last_after + 2) {
4631                                                                 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4632                                                                 $line_fixed = 1;
4633                                                         }
4634                                                 }
4635                                         }
4636                                         if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
4637                                                 # A unary '*' may be const
4638
4639                                         } elsif ($ctx =~ /.xW/) {
4640                                                 if (ERROR("SPACING",
4641                                                           "space prohibited after that '$op' $at\n" . $hereptr)) {
4642                                                         $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
4643                                                         if (defined $fix_elements[$n + 2]) {
4644                                                                 $fix_elements[$n + 2] =~ s/^\s+//;
4645                                                         }
4646                                                         $line_fixed = 1;
4647                                                 }
4648                                         }
4649
4650                                 # unary ++ and unary -- are allowed no space on one side.
4651                                 } elsif ($op eq '++' or $op eq '--') {
4652                                         if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
4653                                                 if (ERROR("SPACING",
4654                                                           "space required one side of that '$op' $at\n" . $hereptr)) {
4655                                                         $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
4656                                                         $line_fixed = 1;
4657                                                 }
4658                                         }
4659                                         if ($ctx =~ /Wx[BE]/ ||
4660                                             ($ctx =~ /Wx./ && $cc =~ /^;/)) {
4661                                                 if (ERROR("SPACING",
4662                                                           "space prohibited before that '$op' $at\n" . $hereptr)) {
4663                                                         $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4664                                                         $line_fixed = 1;
4665                                                 }
4666                                         }
4667                                         if ($ctx =~ /ExW/) {
4668                                                 if (ERROR("SPACING",
4669                                                           "space prohibited after that '$op' $at\n" . $hereptr)) {
4670                                                         $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4671                                                         if (defined $fix_elements[$n + 2]) {
4672                                                                 $fix_elements[$n + 2] =~ s/^\s+//;
4673                                                         }
4674                                                         $line_fixed = 1;
4675                                                 }
4676                                         }
4677
4678                                 # << and >> may either have or not have spaces both sides
4679                                 } elsif ($op eq '<<' or $op eq '>>' or
4680                                          $op eq '&' or $op eq '^' or $op eq '|' or
4681                                          $op eq '+' or $op eq '-' or
4682                                          $op eq '*' or $op eq '/' or
4683                                          $op eq '%')
4684                                 {
4685                                         if ($check) {
4686                                                 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4687                                                         if (CHK("SPACING",
4688                                                                 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4689                                                                 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4690                                                                 $fix_elements[$n + 2] =~ s/^\s+//;
4691                                                                 $line_fixed = 1;
4692                                                         }
4693                                                 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4694                                                         if (CHK("SPACING",
4695                                                                 "space preferred before that '$op' $at\n" . $hereptr)) {
4696                                                                 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4697                                                                 $line_fixed = 1;
4698                                                         }
4699                                                 }
4700                                         } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
4701                                                 if (ERROR("SPACING",
4702                                                           "need consistent spacing around '$op' $at\n" . $hereptr)) {
4703                                                         $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4704                                                         if (defined $fix_elements[$n + 2]) {
4705                                                                 $fix_elements[$n + 2] =~ s/^\s+//;
4706                                                         }
4707                                                         $line_fixed = 1;
4708                                                 }
4709                                         }
4710
4711                                 # A colon needs no spaces before when it is
4712                                 # terminating a case value or a label.
4713                                 } elsif ($opv eq ':C' || $opv eq ':L') {
4714                                         if ($ctx =~ /Wx./) {
4715                                                 if (ERROR("SPACING",
4716                                                           "space prohibited before that '$op' $at\n" . $hereptr)) {
4717                                                         $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4718                                                         $line_fixed = 1;
4719                                                 }
4720                                         }
4721
4722                                 # All the others need spaces both sides.
4723                                 } elsif ($ctx !~ /[EWC]x[CWE]/) {
4724                                         my $ok = 0;
4725
4726                                         # Ignore email addresses <foo@bar>
4727                                         if (($op eq '<' &&
4728                                              $cc =~ /^\S+\@\S+>/) ||
4729                                             ($op eq '>' &&
4730                                              $ca =~ /<\S+\@\S+$/))
4731                                         {
4732                                                 $ok = 1;
4733                                         }
4734
4735                                         # for asm volatile statements
4736                                         # ignore a colon with another
4737                                         # colon immediately before or after
4738                                         if (($op eq ':') &&
4739                                             ($ca =~ /:$/ || $cc =~ /^:/)) {
4740                                                 $ok = 1;
4741                                         }
4742
4743                                         # messages are ERROR, but ?: are CHK
4744                                         if ($ok == 0) {
4745                                                 my $msg_level = \&ERROR;
4746                                                 $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4747
4748                                                 if (&{$msg_level}("SPACING",
4749                                                                   "spaces required around that '$op' $at\n" . $hereptr)) {
4750                                                         $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4751                                                         if (defined $fix_elements[$n + 2]) {
4752                                                                 $fix_elements[$n + 2] =~ s/^\s+//;
4753                                                         }
4754                                                         $line_fixed = 1;
4755                                                 }
4756                                         }
4757                                 }
4758                                 $off += length($elements[$n + 1]);
4759
4760 ##                              print("n: <$n> GOOD: <$good>\n");
4761
4762                                 $fixed_line = $fixed_line . $good;
4763                         }
4764
4765                         if (($#elements % 2) == 0) {
4766                                 $fixed_line = $fixed_line . $fix_elements[$#elements];
4767                         }
4768
4769                         if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4770                                 $fixed[$fixlinenr] = $fixed_line;
4771                         }
4772
4773
4774                 }
4775
4776 # check for whitespace before a non-naked semicolon
4777                 if ($line =~ /^\+.*\S\s+;\s*$/) {
4778                         if (WARN("SPACING",
4779                                  "space prohibited before semicolon\n" . $herecurr) &&
4780                             $fix) {
4781                                 1 while $fixed[$fixlinenr] =~
4782                                     s/^(\+.*\S)\s+;/$1;/;
4783                         }
4784                 }
4785
4786 # check for multiple assignments
4787                 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
4788                         CHK("MULTIPLE_ASSIGNMENTS",
4789                             "multiple assignments should be avoided\n" . $herecurr);
4790                 }
4791
4792 ## # check for multiple declarations, allowing for a function declaration
4793 ## # continuation.
4794 ##              if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4795 ##                  $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4796 ##
4797 ##                      # Remove any bracketed sections to ensure we do not
4798 ##                      # falsly report the parameters of functions.
4799 ##                      my $ln = $line;
4800 ##                      while ($ln =~ s/\([^\(\)]*\)//g) {
4801 ##                      }
4802 ##                      if ($ln =~ /,/) {
4803 ##                              WARN("MULTIPLE_DECLARATION",
4804 ##                                   "declaring multiple variables together should be avoided\n" . $herecurr);
4805 ##                      }
4806 ##              }
4807
4808 #need space before brace following if, while, etc
4809                 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
4810                     $line =~ /\b(?:else|do)\{/) {
4811                         if (ERROR("SPACING",
4812                                   "space required before the open brace '{'\n" . $herecurr) &&
4813                             $fix) {
4814                                 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/;
4815                         }
4816                 }
4817
4818 ## # check for blank lines before declarations
4819 ##              if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4820 ##                  $prevrawline =~ /^.\s*$/) {
4821 ##                      WARN("SPACING",
4822 ##                           "No blank lines before declarations\n" . $hereprev);
4823 ##              }
4824 ##
4825
4826 # closing brace should have a space following it when it has anything
4827 # on the line
4828                 if ($line =~ /}(?!(?:,|;|\)|\}))\S/) {
4829                         if (ERROR("SPACING",
4830                                   "space required after that close brace '}'\n" . $herecurr) &&
4831                             $fix) {
4832                                 $fixed[$fixlinenr] =~
4833                                     s/}((?!(?:,|;|\)))\S)/} $1/;
4834                         }
4835                 }
4836
4837 # check spacing on square brackets
4838                 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
4839                         if (ERROR("SPACING",
4840                                   "space prohibited after that open square bracket '['\n" . $herecurr) &&
4841                             $fix) {
4842                                 $fixed[$fixlinenr] =~
4843                                     s/\[\s+/\[/;
4844                         }
4845                 }
4846                 if ($line =~ /\s\]/) {
4847                         if (ERROR("SPACING",
4848                                   "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4849                             $fix) {
4850                                 $fixed[$fixlinenr] =~
4851                                     s/\s+\]/\]/;
4852                         }
4853                 }
4854
4855 # check spacing on parentheses
4856                 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4857                     $line !~ /for\s*\(\s+;/) {
4858                         if (ERROR("SPACING",
4859                                   "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4860                             $fix) {
4861                                 $fixed[$fixlinenr] =~
4862                                     s/\(\s+/\(/;
4863                         }
4864                 }
4865                 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
4866                     $line !~ /for\s*\(.*;\s+\)/ &&
4867                     $line !~ /:\s+\)/) {
4868                         if (ERROR("SPACING",
4869                                   "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4870                             $fix) {
4871                                 $fixed[$fixlinenr] =~
4872                                     s/\s+\)/\)/;
4873                         }
4874                 }
4875
4876 # check unnecessary parentheses around addressof/dereference single $Lvals
4877 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4878
4879                 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
4880                         my $var = $1;
4881                         if (CHK("UNNECESSARY_PARENTHESES",
4882                                 "Unnecessary parentheses around $var\n" . $herecurr) &&
4883                             $fix) {
4884                                 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4885                         }
4886                 }
4887
4888 # check for unnecessary parentheses around function pointer uses
4889 # ie: (foo->bar)(); should be foo->bar();
4890 # but not "if (foo->bar) (" to avoid some false positives
4891                 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4892                         my $var = $2;
4893                         if (CHK("UNNECESSARY_PARENTHESES",
4894                                 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4895                             $fix) {
4896                                 my $var2 = deparenthesize($var);
4897                                 $var2 =~ s/\s//g;
4898                                 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4899                         }
4900                 }
4901
4902 # check for unnecessary parentheses around comparisons in if uses
4903 # when !drivers/staging or command-line uses --strict
4904                 if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) &&
4905                     $perl_version_ok && defined($stat) &&
4906                     $stat =~ /(^.\s*if\s*($balanced_parens))/) {
4907                         my $if_stat = $1;
4908                         my $test = substr($2, 1, -1);
4909                         my $herectx;
4910                         while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4911                                 my $match = $1;
4912                                 # avoid parentheses around potential macro args
4913                                 next if ($match =~ /^\s*\w+\s*$/);
4914                                 if (!defined($herectx)) {
4915                                         $herectx = $here . "\n";
4916                                         my $cnt = statement_rawlines($if_stat);
4917                                         for (my $n = 0; $n < $cnt; $n++) {
4918                                                 my $rl = raw_line($linenr, $n);
4919                                                 $herectx .=  $rl . "\n";
4920                                                 last if $rl =~ /^[ \+].*\{/;
4921                                         }
4922                                 }
4923                                 CHK("UNNECESSARY_PARENTHESES",
4924                                     "Unnecessary parentheses around '$match'\n" . $herectx);
4925                         }
4926                 }
4927
4928 #goto labels aren't indented, allow a single space however
4929                 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
4930                    !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
4931                         if (WARN("INDENTED_LABEL",
4932                                  "labels should not be indented\n" . $herecurr) &&
4933                             $fix) {
4934                                 $fixed[$fixlinenr] =~
4935                                     s/^(.)\s+/$1/;
4936                         }
4937                 }
4938
4939 # return is not a function
4940                 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
4941                         my $spacing = $1;
4942                         if ($perl_version_ok &&
4943                             $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4944                                 my $value = $1;
4945                                 $value = deparenthesize($value);
4946                                 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4947                                         ERROR("RETURN_PARENTHESES",
4948                                               "return is not a function, parentheses are not required\n" . $herecurr);
4949                                 }
4950                         } elsif ($spacing !~ /\s+/) {
4951                                 ERROR("SPACING",
4952                                       "space required before the open parenthesis '('\n" . $herecurr);
4953                         }
4954                 }
4955
4956 # unnecessary return in a void function
4957 # at end-of-function, with the previous line a single leading tab, then return;
4958 # and the line before that not a goto label target like "out:"
4959                 if ($sline =~ /^[ \+]}\s*$/ &&
4960                     $prevline =~ /^\+\treturn\s*;\s*$/ &&
4961                     $linenr >= 3 &&
4962                     $lines[$linenr - 3] =~ /^[ +]/ &&
4963                     $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
4964                         WARN("RETURN_VOID",
4965                              "void function return statements are not generally useful\n" . $hereprev);
4966                }
4967
4968 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4969                 if ($perl_version_ok &&
4970                     $line =~ /\bif\s*((?:\(\s*){2,})/) {
4971                         my $openparens = $1;
4972                         my $count = $openparens =~ tr@\(@\(@;
4973                         my $msg = "";
4974                         if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4975                                 my $comp = $4;  #Not $1 because of $LvalOrFunc
4976                                 $msg = " - maybe == should be = ?" if ($comp eq "==");
4977                                 WARN("UNNECESSARY_PARENTHESES",
4978                                      "Unnecessary parentheses$msg\n" . $herecurr);
4979                         }
4980                 }
4981
4982 # comparisons with a constant or upper case identifier on the left
4983 #       avoid cases like "foo + BAR < baz"
4984 #       only fix matches surrounded by parentheses to avoid incorrect
4985 #       conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4986                 if ($perl_version_ok &&
4987                     $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4988                         my $lead = $1;
4989                         my $const = $2;
4990                         my $comp = $3;
4991                         my $to = $4;
4992                         my $newcomp = $comp;
4993                         if ($lead !~ /(?:$Operators|\.)\s*$/ &&
4994                             $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4995                             WARN("CONSTANT_COMPARISON",
4996                                  "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4997                             $fix) {
4998                                 if ($comp eq "<") {
4999                                         $newcomp = ">";
5000                                 } elsif ($comp eq "<=") {
5001                                         $newcomp = ">=";
5002                                 } elsif ($comp eq ">") {
5003                                         $newcomp = "<";
5004                                 } elsif ($comp eq ">=") {
5005                                         $newcomp = "<=";
5006                                 }
5007                                 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
5008                         }
5009                 }
5010
5011 # Return of what appears to be an errno should normally be negative
5012                 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
5013                         my $name = $1;
5014                         if ($name ne 'EOF' && $name ne 'ERROR') {
5015                                 WARN("USE_NEGATIVE_ERRNO",
5016                                      "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
5017                         }
5018                 }
5019
5020 # Need a space before open parenthesis after if, while etc
5021                 if ($line =~ /\b(if|while|for|switch)\(/) {
5022                         if (ERROR("SPACING",
5023                                   "space required before the open parenthesis '('\n" . $herecurr) &&
5024                             $fix) {
5025                                 $fixed[$fixlinenr] =~
5026                                     s/\b(if|while|for|switch)\(/$1 \(/;
5027                         }
5028                 }
5029
5030 # Check for illegal assignment in if conditional -- and check for trailing
5031 # statements after the conditional.
5032                 if ($line =~ /do\s*(?!{)/) {
5033                         ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
5034                                 ctx_statement_block($linenr, $realcnt, 0)
5035                                         if (!defined $stat);
5036                         my ($stat_next) = ctx_statement_block($line_nr_next,
5037                                                 $remain_next, $off_next);
5038                         $stat_next =~ s/\n./\n /g;
5039                         ##print "stat<$stat> stat_next<$stat_next>\n";
5040
5041                         if ($stat_next =~ /^\s*while\b/) {
5042                                 # If the statement carries leading newlines,
5043                                 # then count those as offsets.
5044                                 my ($whitespace) =
5045                                         ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
5046                                 my $offset =
5047                                         statement_rawlines($whitespace) - 1;
5048
5049                                 $suppress_whiletrailers{$line_nr_next +
5050                                                                 $offset} = 1;
5051                         }
5052                 }
5053                 if (!defined $suppress_whiletrailers{$linenr} &&
5054                     defined($stat) && defined($cond) &&
5055                     $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
5056                         my ($s, $c) = ($stat, $cond);
5057
5058                         if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
5059                                 if (ERROR("ASSIGN_IN_IF",
5060                                           "do not use assignment in if condition\n" . $herecurr) &&
5061                                     $fix && $perl_version_ok) {
5062                                         if ($rawline =~ /^\+(\s+)if\s*\(\s*(\!)?\s*\(\s*(($Lval)\s*=\s*$LvalOrFunc)\s*\)\s*(?:($Compare)\s*($FuncArg))?\s*\)\s*(\{)?\s*$/) {
5063                                                 my $space = $1;
5064                                                 my $not = $2;
5065                                                 my $statement = $3;
5066                                                 my $assigned = $4;
5067                                                 my $test = $8;
5068                                                 my $against = $9;
5069                                                 my $brace = $15;
5070                                                 fix_delete_line($fixlinenr, $rawline);
5071                                                 fix_insert_line($fixlinenr, "$space$statement;");
5072                                                 my $newline = "${space}if (";
5073                                                 $newline .= '!' if defined($not);
5074                                                 $newline .= '(' if (defined $not && defined($test) && defined($against));
5075                                                 $newline .= "$assigned";
5076                                                 $newline .= " $test $against" if (defined($test) && defined($against));
5077                                                 $newline .= ')' if (defined $not && defined($test) && defined($against));
5078                                                 $newline .= ')';
5079                                                 $newline .= " {" if (defined($brace));
5080                                                 fix_insert_line($fixlinenr + 1, $newline);
5081                                         }
5082                                 }
5083                         }
5084
5085                         # Find out what is on the end of the line after the
5086                         # conditional.
5087                         substr($s, 0, length($c), '');
5088                         $s =~ s/\n.*//g;
5089                         $s =~ s/$;//g;  # Remove any comments
5090                         if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
5091                             $c !~ /}\s*while\s*/)
5092                         {
5093                                 # Find out how long the conditional actually is.
5094                                 my @newlines = ($c =~ /\n/gs);
5095                                 my $cond_lines = 1 + $#newlines;
5096                                 my $stat_real = '';
5097
5098                                 $stat_real = raw_line($linenr, $cond_lines)
5099                                                         . "\n" if ($cond_lines);
5100                                 if (defined($stat_real) && $cond_lines > 1) {
5101                                         $stat_real = "[...]\n$stat_real";
5102                                 }
5103
5104                                 ERROR("TRAILING_STATEMENTS",
5105                                       "trailing statements should be on next line\n" . $herecurr . $stat_real);
5106                         }
5107                 }
5108
5109 # Check for bitwise tests written as boolean
5110                 if ($line =~ /
5111                         (?:
5112                                 (?:\[|\(|\&\&|\|\|)
5113                                 \s*0[xX][0-9]+\s*
5114                                 (?:\&\&|\|\|)
5115                         |
5116                                 (?:\&\&|\|\|)
5117                                 \s*0[xX][0-9]+\s*
5118                                 (?:\&\&|\|\||\)|\])
5119                         )/x)
5120                 {
5121                         WARN("HEXADECIMAL_BOOLEAN_TEST",
5122                              "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
5123                 }
5124
5125 # if and else should not have general statements after it
5126                 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
5127                         my $s = $1;
5128                         $s =~ s/$;//g;  # Remove any comments
5129                         if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
5130                                 ERROR("TRAILING_STATEMENTS",
5131                                       "trailing statements should be on next line\n" . $herecurr);
5132                         }
5133                 }
5134 # if should not continue a brace
5135                 if ($line =~ /}\s*if\b/) {
5136                         ERROR("TRAILING_STATEMENTS",
5137                               "trailing statements should be on next line (or did you mean 'else if'?)\n" .
5138                                 $herecurr);
5139                 }
5140 # case and default should not have general statements after them
5141                 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
5142                     $line !~ /\G(?:
5143                         (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
5144                         \s*return\s+
5145                     )/xg)
5146                 {
5147                         ERROR("TRAILING_STATEMENTS",
5148                               "trailing statements should be on next line\n" . $herecurr);
5149                 }
5150
5151                 # Check for }<nl>else {, these must be at the same
5152                 # indent level to be relevant to each other.
5153                 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
5154                     $previndent == $indent) {
5155                         if (ERROR("ELSE_AFTER_BRACE",
5156                                   "else should follow close brace '}'\n" . $hereprev) &&
5157                             $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
5158                                 fix_delete_line($fixlinenr - 1, $prevrawline);
5159                                 fix_delete_line($fixlinenr, $rawline);
5160                                 my $fixedline = $prevrawline;
5161                                 $fixedline =~ s/}\s*$//;
5162                                 if ($fixedline !~ /^\+\s*$/) {
5163                                         fix_insert_line($fixlinenr, $fixedline);
5164                                 }
5165                                 $fixedline = $rawline;
5166                                 $fixedline =~ s/^(.\s*)else/$1} else/;
5167                                 fix_insert_line($fixlinenr, $fixedline);
5168                         }
5169                 }
5170
5171                 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
5172                     $previndent == $indent) {
5173                         my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
5174
5175                         # Find out what is on the end of the line after the
5176                         # conditional.
5177                         substr($s, 0, length($c), '');
5178                         $s =~ s/\n.*//g;
5179
5180                         if ($s =~ /^\s*;/) {
5181                                 if (ERROR("WHILE_AFTER_BRACE",
5182                                           "while should follow close brace '}'\n" . $hereprev) &&
5183                                     $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
5184                                         fix_delete_line($fixlinenr - 1, $prevrawline);
5185                                         fix_delete_line($fixlinenr, $rawline);
5186                                         my $fixedline = $prevrawline;
5187                                         my $trailing = $rawline;
5188                                         $trailing =~ s/^\+//;
5189                                         $trailing = trim($trailing);
5190                                         $fixedline =~ s/}\s*$/} $trailing/;
5191                                         fix_insert_line($fixlinenr, $fixedline);
5192                                 }
5193                         }
5194                 }
5195
5196 #Specific variable tests
5197                 while ($line =~ m{($Constant|$Lval)}g) {
5198                         my $var = $1;
5199
5200 #CamelCase
5201                         if ($var !~ /^$Constant$/ &&
5202                             $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
5203 #Ignore Page<foo> variants
5204                             $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
5205 #Ignore SI style variants like nS, mV and dB
5206 #(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE)
5207                             $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ &&
5208 #Ignore some three character SI units explicitly, like MiB and KHz
5209                             $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
5210                                 while ($var =~ m{($Ident)}g) {
5211                                         my $word = $1;
5212                                         next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
5213                                         if ($check) {
5214                                                 seed_camelcase_includes();
5215                                                 if (!$file && !$camelcase_file_seeded) {
5216                                                         seed_camelcase_file($realfile);
5217                                                         $camelcase_file_seeded = 1;
5218                                                 }
5219                                         }
5220                                         if (!defined $camelcase{$word}) {
5221                                                 $camelcase{$word} = 1;
5222                                                 CHK("CAMELCASE",
5223                                                     "Avoid CamelCase: <$word>\n" . $herecurr);
5224                                         }
5225                                 }
5226                         }
5227                 }
5228
5229 #no spaces allowed after \ in define
5230                 if ($line =~ /\#\s*define.*\\\s+$/) {
5231                         if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
5232                                  "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
5233                             $fix) {
5234                                 $fixed[$fixlinenr] =~ s/\s+$//;
5235                         }
5236                 }
5237
5238 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
5239 # itself <asm/foo.h> (uses RAW line)
5240                 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
5241                         my $file = "$1.h";
5242                         my $checkfile = "include/linux/$file";
5243                         if (-f "$root/$checkfile" &&
5244                             $realfile ne $checkfile &&
5245                             $1 !~ /$allowed_asm_includes/)
5246                         {
5247                                 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
5248                                 if ($asminclude > 0) {
5249                                         if ($realfile =~ m{^arch/}) {
5250                                                 CHK("ARCH_INCLUDE_LINUX",
5251                                                     "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5252                                         } else {
5253                                                 WARN("INCLUDE_LINUX",
5254                                                      "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5255                                         }
5256                                 }
5257                         }
5258                 }
5259
5260 # multi-statement macros should be enclosed in a do while loop, grab the
5261 # first statement and ensure its the whole macro if its not enclosed
5262 # in a known good container
5263                 if ($realfile !~ m@/vmlinux.lds.h$@ &&
5264                     $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
5265                         my $ln = $linenr;
5266                         my $cnt = $realcnt;
5267                         my ($off, $dstat, $dcond, $rest);
5268                         my $ctx = '';
5269                         my $has_flow_statement = 0;
5270                         my $has_arg_concat = 0;
5271                         ($dstat, $dcond, $ln, $cnt, $off) =
5272                                 ctx_statement_block($linenr, $realcnt, 0);
5273                         $ctx = $dstat;
5274                         #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
5275                         #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
5276
5277                         $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
5278                         $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
5279
5280                         $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
5281                         my $define_args = $1;
5282                         my $define_stmt = $dstat;
5283                         my @def_args = ();
5284
5285                         if (defined $define_args && $define_args ne "") {
5286                                 $define_args = substr($define_args, 1, length($define_args) - 2);
5287                                 $define_args =~ s/\s*//g;
5288                                 $define_args =~ s/\\\+?//g;
5289                                 @def_args = split(",", $define_args);
5290                         }
5291
5292                         $dstat =~ s/$;//g;
5293                         $dstat =~ s/\\\n.//g;
5294                         $dstat =~ s/^\s*//s;
5295                         $dstat =~ s/\s*$//s;
5296
5297                         # Flatten any parentheses and braces
5298                         while ($dstat =~ s/\([^\(\)]*\)/1/ ||
5299                                $dstat =~ s/\{[^\{\}]*\}/1/ ||
5300                                $dstat =~ s/.\[[^\[\]]*\]/1/)
5301                         {
5302                         }
5303
5304                         # Flatten any obvious string concatenation.
5305                         while ($dstat =~ s/($String)\s*$Ident/$1/ ||
5306                                $dstat =~ s/$Ident\s*($String)/$1/)
5307                         {
5308                         }
5309
5310                         # Make asm volatile uses seem like a generic function
5311                         $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
5312
5313                         my $exceptions = qr{
5314                                 $Declare|
5315                                 module_param_named|
5316                                 MODULE_PARM_DESC|
5317                                 DECLARE_PER_CPU|
5318                                 DEFINE_PER_CPU|
5319                                 __typeof__\(|
5320                                 union|
5321                                 struct|
5322                                 \.$Ident\s*=\s*|
5323                                 ^\"|\"$|
5324                                 ^\[
5325                         }x;
5326                         #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
5327
5328                         $ctx =~ s/\n*$//;
5329                         my $stmt_cnt = statement_rawlines($ctx);
5330                         my $herectx = get_stat_here($linenr, $stmt_cnt, $here);
5331
5332                         if ($dstat ne '' &&
5333                             $dstat !~ /^(?:$Ident|-?$Constant),$/ &&                    # 10, // foo(),
5334                             $dstat !~ /^(?:$Ident|-?$Constant);$/ &&                    # foo();
5335                             $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ &&          # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
5336                             $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ &&                  # character constants
5337                             $dstat !~ /$exceptions/ &&
5338                             $dstat !~ /^\.$Ident\s*=/ &&                                # .foo =
5339                             $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ &&          # stringification #foo
5340                             $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ &&       # do {...} while (...); // do {...} while (...)
5341                             $dstat !~ /^for\s*$Constant$/ &&                            # for (...)
5342                             $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ &&   # for (...) bar()
5343                             $dstat !~ /^do\s*{/ &&                                      # do {...
5344                             $dstat !~ /^\(\{/ &&                                                # ({...
5345                             $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
5346                         {
5347                                 if ($dstat =~ /^\s*if\b/) {
5348                                         ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5349                                               "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5350                                 } elsif ($dstat =~ /;/) {
5351                                         ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5352                                               "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
5353                                 } else {
5354                                         ERROR("COMPLEX_MACRO",
5355                                               "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
5356                                 }
5357
5358                         }
5359
5360                         # Make $define_stmt single line, comment-free, etc
5361                         my @stmt_array = split('\n', $define_stmt);
5362                         my $first = 1;
5363                         $define_stmt = "";
5364                         foreach my $l (@stmt_array) {
5365                                 $l =~ s/\\$//;
5366                                 if ($first) {
5367                                         $define_stmt = $l;
5368                                         $first = 0;
5369                                 } elsif ($l =~ /^[\+ ]/) {
5370                                         $define_stmt .= substr($l, 1);
5371                                 }
5372                         }
5373                         $define_stmt =~ s/$;//g;
5374                         $define_stmt =~ s/\s+/ /g;
5375                         $define_stmt = trim($define_stmt);
5376
5377 # check if any macro arguments are reused (ignore '...' and 'type')
5378                         foreach my $arg (@def_args) {
5379                                 next if ($arg =~ /\.\.\./);
5380                                 next if ($arg =~ /^type$/i);
5381                                 my $tmp_stmt = $define_stmt;
5382                                 $tmp_stmt =~ s/\b(sizeof|typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
5383                                 $tmp_stmt =~ s/\#+\s*$arg\b//g;
5384                                 $tmp_stmt =~ s/\b$arg\s*\#\#//g;
5385                                 my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g;
5386                                 if ($use_cnt > 1) {
5387                                         CHK("MACRO_ARG_REUSE",
5388                                             "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
5389                                     }
5390 # check if any macro arguments may have other precedence issues
5391                                 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
5392                                     ((defined($1) && $1 ne ',') ||
5393                                      (defined($2) && $2 ne ','))) {
5394                                         CHK("MACRO_ARG_PRECEDENCE",
5395                                             "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
5396                                 }
5397                         }
5398
5399 # check for macros with flow control, but without ## concatenation
5400 # ## concatenation is commonly a macro that defines a function so ignore those
5401                         if ($has_flow_statement && !$has_arg_concat) {
5402                                 my $cnt = statement_rawlines($ctx);
5403                                 my $herectx = get_stat_here($linenr, $cnt, $here);
5404
5405                                 WARN("MACRO_WITH_FLOW_CONTROL",
5406                                      "Macros with flow control statements should be avoided\n" . "$herectx");
5407                         }
5408
5409 # check for line continuations outside of #defines, preprocessor #, and asm
5410
5411                 } else {
5412                         if ($prevline !~ /^..*\\$/ &&
5413                             $line !~ /^\+\s*\#.*\\$/ &&         # preprocessor
5414                             $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ &&   # asm
5415                             $line =~ /^\+.*\\$/) {
5416                                 WARN("LINE_CONTINUATIONS",
5417                                      "Avoid unnecessary line continuations\n" . $herecurr);
5418                         }
5419                 }
5420
5421 # do {} while (0) macro tests:
5422 # single-statement macros do not need to be enclosed in do while (0) loop,
5423 # macro should not end with a semicolon
5424                 if ($perl_version_ok &&
5425                     $realfile !~ m@/vmlinux.lds.h$@ &&
5426                     $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
5427                         my $ln = $linenr;
5428                         my $cnt = $realcnt;
5429                         my ($off, $dstat, $dcond, $rest);
5430                         my $ctx = '';
5431                         ($dstat, $dcond, $ln, $cnt, $off) =
5432                                 ctx_statement_block($linenr, $realcnt, 0);
5433                         $ctx = $dstat;
5434
5435                         $dstat =~ s/\\\n.//g;
5436                         $dstat =~ s/$;/ /g;
5437
5438                         if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5439                                 my $stmts = $2;
5440                                 my $semis = $3;
5441
5442                                 $ctx =~ s/\n*$//;
5443                                 my $cnt = statement_rawlines($ctx);
5444                                 my $herectx = get_stat_here($linenr, $cnt, $here);
5445
5446                                 if (($stmts =~ tr/;/;/) == 1 &&
5447                                     $stmts !~ /^\s*(if|while|for|switch)\b/) {
5448                                         WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
5449                                              "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
5450                                 }
5451                                 if (defined $semis && $semis ne "") {
5452                                         WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
5453                                              "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
5454                                 }
5455                         } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
5456                                 $ctx =~ s/\n*$//;
5457                                 my $cnt = statement_rawlines($ctx);
5458                                 my $herectx = get_stat_here($linenr, $cnt, $here);
5459
5460                                 WARN("TRAILING_SEMICOLON",
5461                                      "macros should not use a trailing semicolon\n" . "$herectx");
5462                         }
5463                 }
5464
5465 # check for redundant bracing round if etc
5466                 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
5467                         my ($level, $endln, @chunks) =
5468                                 ctx_statement_full($linenr, $realcnt, 1);
5469                         #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
5470                         #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5471                         if ($#chunks > 0 && $level == 0) {
5472                                 my @allowed = ();
5473                                 my $allow = 0;
5474                                 my $seen = 0;
5475                                 my $herectx = $here . "\n";
5476                                 my $ln = $linenr - 1;
5477                                 for my $chunk (@chunks) {
5478                                         my ($cond, $block) = @{$chunk};
5479
5480                                         # If the condition carries leading newlines, then count those as offsets.
5481                                         my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5482                                         my $offset = statement_rawlines($whitespace) - 1;
5483
5484                                         $allowed[$allow] = 0;
5485                                         #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5486
5487                                         # We have looked at and allowed this specific line.
5488                                         $suppress_ifbraces{$ln + $offset} = 1;
5489
5490                                         $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
5491                                         $ln += statement_rawlines($block) - 1;
5492
5493                                         substr($block, 0, length($cond), '');
5494
5495                                         $seen++ if ($block =~ /^\s*{/);
5496
5497                                         #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5498                                         if (statement_lines($cond) > 1) {
5499                                                 #print "APW: ALLOWED: cond<$cond>\n";
5500                                                 $allowed[$allow] = 1;
5501                                         }
5502                                         if ($block =~/\b(?:if|for|while)\b/) {
5503                                                 #print "APW: ALLOWED: block<$block>\n";
5504                                                 $allowed[$allow] = 1;
5505                                         }
5506                                         if (statement_block_size($block) > 1) {
5507                                                 #print "APW: ALLOWED: lines block<$block>\n";
5508                                                 $allowed[$allow] = 1;
5509                                         }
5510                                         $allow++;
5511                                 }
5512                                 if ($seen) {
5513                                         my $sum_allowed = 0;
5514                                         foreach (@allowed) {
5515                                                 $sum_allowed += $_;
5516                                         }
5517                                         if ($sum_allowed == 0) {
5518                                                 WARN("BRACES",
5519                                                      "braces {} are not necessary for any arm of this statement\n" . $herectx);
5520                                         } elsif ($sum_allowed != $allow &&
5521                                                  $seen != $allow) {
5522                                                 CHK("BRACES",
5523                                                     "braces {} should be used on all arms of this statement\n" . $herectx);
5524                                         }
5525                                 }
5526                         }
5527                 }
5528                 if (!defined $suppress_ifbraces{$linenr - 1} &&
5529                                         $line =~ /\b(if|while|for|else)\b/) {
5530                         my $allowed = 0;
5531
5532                         # Check the pre-context.
5533                         if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5534                                 #print "APW: ALLOWED: pre<$1>\n";
5535                                 $allowed = 1;
5536                         }
5537
5538                         my ($level, $endln, @chunks) =
5539                                 ctx_statement_full($linenr, $realcnt, $-[0]);
5540
5541                         # Check the condition.
5542                         my ($cond, $block) = @{$chunks[0]};
5543                         #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5544                         if (defined $cond) {
5545                                 substr($block, 0, length($cond), '');
5546                         }
5547                         if (statement_lines($cond) > 1) {
5548                                 #print "APW: ALLOWED: cond<$cond>\n";
5549                                 $allowed = 1;
5550                         }
5551                         if ($block =~/\b(?:if|for|while)\b/) {
5552                                 #print "APW: ALLOWED: block<$block>\n";
5553                                 $allowed = 1;
5554                         }
5555                         if (statement_block_size($block) > 1) {
5556                                 #print "APW: ALLOWED: lines block<$block>\n";
5557                                 $allowed = 1;
5558                         }
5559                         # Check the post-context.
5560                         if (defined $chunks[1]) {
5561                                 my ($cond, $block) = @{$chunks[1]};
5562                                 if (defined $cond) {
5563                                         substr($block, 0, length($cond), '');
5564                                 }
5565                                 if ($block =~ /^\s*\{/) {
5566                                         #print "APW: ALLOWED: chunk-1 block<$block>\n";
5567                                         $allowed = 1;
5568                                 }
5569                         }
5570                         if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
5571                                 my $cnt = statement_rawlines($block);
5572                                 my $herectx = get_stat_here($linenr, $cnt, $here);
5573
5574                                 WARN("BRACES",
5575                                      "braces {} are not necessary for single statement blocks\n" . $herectx);
5576                         }
5577                 }
5578
5579 # check for single line unbalanced braces
5580                 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
5581                     $sline =~ /^.\s*else\s*\{\s*$/) {
5582                         CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
5583                 }
5584
5585 # check for unnecessary blank lines around braces
5586                 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
5587                         if (CHK("BRACES",
5588                                 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5589                             $fix && $prevrawline =~ /^\+/) {
5590                                 fix_delete_line($fixlinenr - 1, $prevrawline);
5591                         }
5592                 }
5593                 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
5594                         if (CHK("BRACES",
5595                                 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5596                             $fix) {
5597                                 fix_delete_line($fixlinenr, $rawline);
5598                         }
5599                 }
5600
5601 # no volatiles please
5602                 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5603                 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
5604                         WARN("VOLATILE",
5605                              "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
5606                 }
5607
5608 # Check for user-visible strings broken across lines, which breaks the ability
5609 # to grep for the string.  Make exceptions when the previous string ends in a
5610 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5611 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
5612                 if ($line =~ /^\+\s*$String/ &&
5613                     $prevline =~ /"\s*$/ &&
5614                     $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5615                         if (WARN("SPLIT_STRING",
5616                                  "quoted string split across lines\n" . $hereprev) &&
5617                                      $fix &&
5618                                      $prevrawline =~ /^\+.*"\s*$/ &&
5619                                      $last_coalesced_string_linenr != $linenr - 1) {
5620                                 my $extracted_string = get_quoted_string($line, $rawline);
5621                                 my $comma_close = "";
5622                                 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5623                                         $comma_close = $1;
5624                                 }
5625
5626                                 fix_delete_line($fixlinenr - 1, $prevrawline);
5627                                 fix_delete_line($fixlinenr, $rawline);
5628                                 my $fixedline = $prevrawline;
5629                                 $fixedline =~ s/"\s*$//;
5630                                 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5631                                 fix_insert_line($fixlinenr - 1, $fixedline);
5632                                 $fixedline = $rawline;
5633                                 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5634                                 if ($fixedline !~ /\+\s*$/) {
5635                                         fix_insert_line($fixlinenr, $fixedline);
5636                                 }
5637                                 $last_coalesced_string_linenr = $linenr;
5638                         }
5639                 }
5640
5641 # check for missing a space in a string concatenation
5642                 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5643                         WARN('MISSING_SPACE',
5644                              "break quoted strings at a space character\n" . $hereprev);
5645                 }
5646
5647 # check for an embedded function name in a string when the function is known
5648 # This does not work very well for -f --file checking as it depends on patch
5649 # context providing the function name or a single line form for in-file
5650 # function declarations
5651                 if ($line =~ /^\+.*$String/ &&
5652                     defined($context_function) &&
5653                     get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
5654                     length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
5655                         WARN("EMBEDDED_FUNCTION_NAME",
5656                              "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
5657                 }
5658
5659 # check for spaces before a quoted newline
5660                 if ($rawline =~ /^.*\".*\s\\n/) {
5661                         if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5662                                  "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5663                             $fix) {
5664                                 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5665                         }
5666
5667                 }
5668
5669 # concatenated string without spaces between elements
5670                 if ($line =~ /$String[A-Za-z0-9_]/ || $line =~ /[A-Za-z0-9_]$String/) {
5671                         if (CHK("CONCATENATED_STRING",
5672                                 "Concatenated strings should use spaces between elements\n" . $herecurr) &&
5673                             $fix) {
5674                                 while ($line =~ /($String)/g) {
5675                                         my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5676                                         $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/;
5677                                         $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/;
5678                                 }
5679                         }
5680                 }
5681
5682 # uncoalesced string fragments
5683                 if ($line =~ /$String\s*"/) {
5684                         if (WARN("STRING_FRAGMENTS",
5685                                  "Consecutive strings are generally better as a single string\n" . $herecurr) &&
5686                             $fix) {
5687                                 while ($line =~ /($String)(?=\s*")/g) {
5688                                         my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5689                                         $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e;
5690                                 }
5691                         }
5692                 }
5693
5694 # check for non-standard and hex prefixed decimal printf formats
5695                 my $show_L = 1; #don't show the same defect twice
5696                 my $show_Z = 1;
5697                 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
5698                         my $string = substr($rawline, $-[1], $+[1] - $-[1]);
5699                         $string =~ s/%%/__/g;
5700                         # check for %L
5701                         if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
5702                                 WARN("PRINTF_L",
5703                                      "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
5704                                 $show_L = 0;
5705                         }
5706                         # check for %Z
5707                         if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
5708                                 WARN("PRINTF_Z",
5709                                      "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
5710                                 $show_Z = 0;
5711                         }
5712                         # check for 0x<decimal>
5713                         if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
5714                                 ERROR("PRINTF_0XDECIMAL",
5715                                       "Prefixing 0x with decimal output is defective\n" . $herecurr);
5716                         }
5717                 }
5718
5719 # check for line continuations in quoted strings with odd counts of "
5720                 if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
5721                         WARN("LINE_CONTINUATIONS",
5722                              "Avoid line continuations in quoted strings\n" . $herecurr);
5723                 }
5724
5725 # warn about #if 0
5726                 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
5727                         WARN("IF_0",
5728                              "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr);
5729                 }
5730
5731 # warn about #if 1
5732                 if ($line =~ /^.\s*\#\s*if\s+1\b/) {
5733                         WARN("IF_1",
5734                              "Consider removing the #if 1 and its #endif\n" . $herecurr);
5735                 }
5736
5737 # check for needless "if (<foo>) fn(<foo>)" uses
5738                 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
5739                         my $tested = quotemeta($1);
5740                         my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5741                         if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5742                                 my $func = $1;
5743                                 if (WARN('NEEDLESS_IF',
5744                                          "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5745                                     $fix) {
5746                                         my $do_fix = 1;
5747                                         my $leading_tabs = "";
5748                                         my $new_leading_tabs = "";
5749                                         if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5750                                                 $leading_tabs = $1;
5751                                         } else {
5752                                                 $do_fix = 0;
5753                                         }
5754                                         if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5755                                                 $new_leading_tabs = $1;
5756                                                 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5757                                                         $do_fix = 0;
5758                                                 }
5759                                         } else {
5760                                                 $do_fix = 0;
5761                                         }
5762                                         if ($do_fix) {
5763                                                 fix_delete_line($fixlinenr - 1, $prevrawline);
5764                                                 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5765                                         }
5766                                 }
5767                         }
5768                 }
5769
5770 # check for unnecessary "Out of Memory" messages
5771                 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5772                     $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5773                     (defined $1 || defined $3) &&
5774                     $linenr > 3) {
5775                         my $testval = $2;
5776                         my $testline = $lines[$linenr - 3];
5777
5778                         my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5779 #                       print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5780
5781                         if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ &&
5782                             $s !~ /\b__GFP_NOWARN\b/ ) {
5783                                 WARN("OOM_MESSAGE",
5784                                      "Possible unnecessary 'out of memory' message\n" . $hereprev);
5785                         }
5786                 }
5787
5788 # check for logging functions with KERN_<LEVEL>
5789                 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
5790                     $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5791                         my $level = $1;
5792                         if (WARN("UNNECESSARY_KERN_LEVEL",
5793                                  "Possible unnecessary $level\n" . $herecurr) &&
5794                             $fix) {
5795                                 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5796                         }
5797                 }
5798
5799 # check for logging continuations
5800                 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
5801                         WARN("LOGGING_CONTINUATION",
5802                              "Avoid logging continuation uses where feasible\n" . $herecurr);
5803                 }
5804
5805 # check for mask then right shift without a parentheses
5806                 if ($perl_version_ok &&
5807                     $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5808                     $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5809                         WARN("MASK_THEN_SHIFT",
5810                              "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5811                 }
5812
5813 # check for pointer comparisons to NULL
5814                 if ($perl_version_ok) {
5815                         while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5816                                 my $val = $1;
5817                                 my $equal = "!";
5818                                 $equal = "" if ($4 eq "!=");
5819                                 if (CHK("COMPARISON_TO_NULL",
5820                                         "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5821                                             $fix) {
5822                                         $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5823                                 }
5824                         }
5825                 }
5826
5827 # check for bad placement of section $InitAttribute (e.g.: __initdata)
5828                 if ($line =~ /(\b$InitAttribute\b)/) {
5829                         my $attr = $1;
5830                         if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5831                                 my $ptr = $1;
5832                                 my $var = $2;
5833                                 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5834                                       ERROR("MISPLACED_INIT",
5835                                             "$attr should be placed after $var\n" . $herecurr)) ||
5836                                      ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5837                                       WARN("MISPLACED_INIT",
5838                                            "$attr should be placed after $var\n" . $herecurr))) &&
5839                                     $fix) {
5840                                         $fixed[$fixlinenr] =~ 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;
5841                                 }
5842                         }
5843                 }
5844
5845 # check for $InitAttributeData (ie: __initdata) with const
5846                 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5847                         my $attr = $1;
5848                         $attr =~ /($InitAttributePrefix)(.*)/;
5849                         my $attr_prefix = $1;
5850                         my $attr_type = $2;
5851                         if (ERROR("INIT_ATTRIBUTE",
5852                                   "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5853                             $fix) {
5854                                 $fixed[$fixlinenr] =~
5855                                     s/$InitAttributeData/${attr_prefix}initconst/;
5856                         }
5857                 }
5858
5859 # check for $InitAttributeConst (ie: __initconst) without const
5860                 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5861                         my $attr = $1;
5862                         if (ERROR("INIT_ATTRIBUTE",
5863                                   "Use of $attr requires a separate use of const\n" . $herecurr) &&
5864                             $fix) {
5865                                 my $lead = $fixed[$fixlinenr] =~
5866                                     /(^\+\s*(?:static\s+))/;
5867                                 $lead = rtrim($1);
5868                                 $lead = "$lead " if ($lead !~ /^\+$/);
5869                                 $lead = "${lead}const ";
5870                                 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
5871                         }
5872                 }
5873
5874 # check for __read_mostly with const non-pointer (should just be const)
5875                 if ($line =~ /\b__read_mostly\b/ &&
5876                     $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5877                         if (ERROR("CONST_READ_MOSTLY",
5878                                   "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5879                             $fix) {
5880                                 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5881                         }
5882                 }
5883
5884 # don't use __constant_<foo> functions outside of include/uapi/
5885                 if ($realfile !~ m@^include/uapi/@ &&
5886                     $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5887                         my $constant_func = $1;
5888                         my $func = $constant_func;
5889                         $func =~ s/^__constant_//;
5890                         if (WARN("CONSTANT_CONVERSION",
5891                                  "$constant_func should be $func\n" . $herecurr) &&
5892                             $fix) {
5893                                 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
5894                         }
5895                 }
5896
5897 # prefer usleep_range over udelay
5898                 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
5899                         my $delay = $1;
5900                         # ignore udelay's < 10, however
5901                         if (! ($delay < 10) ) {
5902                                 CHK("USLEEP_RANGE",
5903                                     "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr);
5904                         }
5905                         if ($delay > 2000) {
5906                                 WARN("LONG_UDELAY",
5907                                      "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
5908                         }
5909                 }
5910
5911 # warn about unexpectedly long msleep's
5912                 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5913                         if ($1 < 20) {
5914                                 WARN("MSLEEP",
5915                                      "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr);
5916                         }
5917                 }
5918
5919 # check for comparisons of jiffies
5920                 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5921                         WARN("JIFFIES_COMPARISON",
5922                              "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5923                 }
5924
5925 # check for comparisons of get_jiffies_64()
5926                 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5927                         WARN("JIFFIES_COMPARISON",
5928                              "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5929                 }
5930
5931 # warn about #ifdefs in C files
5932 #               if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5933 #                       print "#ifdef in C files should be avoided\n";
5934 #                       print "$herecurr";
5935 #                       $clean = 0;
5936 #               }
5937
5938 # warn about spacing in #ifdefs
5939                 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
5940                         if (ERROR("SPACING",
5941                                   "exactly one space required after that #$1\n" . $herecurr) &&
5942                             $fix) {
5943                                 $fixed[$fixlinenr] =~
5944                                     s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5945                         }
5946
5947                 }
5948
5949 # check for spinlock_t definitions without a comment.
5950                 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5951                     $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
5952                         my $which = $1;
5953                         if (!ctx_has_comment($first_line, $linenr)) {
5954                                 CHK("UNCOMMENTED_DEFINITION",
5955                                     "$1 definition without comment\n" . $herecurr);
5956                         }
5957                 }
5958 # check for memory barriers without a comment.
5959
5960                 my $barriers = qr{
5961                         mb|
5962                         rmb|
5963                         wmb
5964                 }x;
5965                 my $barrier_stems = qr{
5966                         mb__before_atomic|
5967                         mb__after_atomic|
5968                         store_release|
5969                         load_acquire|
5970                         store_mb|
5971                         (?:$barriers)
5972                 }x;
5973                 my $all_barriers = qr{
5974                         (?:$barriers)|
5975                         smp_(?:$barrier_stems)|
5976                         virt_(?:$barrier_stems)
5977                 }x;
5978
5979                 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
5980                         if (!ctx_has_comment($first_line, $linenr)) {
5981                                 WARN("MEMORY_BARRIER",
5982                                      "memory barrier without comment\n" . $herecurr);
5983                         }
5984                 }
5985
5986                 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5987
5988                 if ($realfile !~ m@^include/asm-generic/@ &&
5989                     $realfile !~ m@/barrier\.h$@ &&
5990                     $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5991                     $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5992                         WARN("MEMORY_BARRIER",
5993                              "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5994                 }
5995
5996 # check for waitqueue_active without a comment.
5997                 if ($line =~ /\bwaitqueue_active\s*\(/) {
5998                         if (!ctx_has_comment($first_line, $linenr)) {
5999                                 WARN("WAITQUEUE_ACTIVE",
6000                                      "waitqueue_active without comment\n" . $herecurr);
6001                         }
6002                 }
6003
6004 # check for data_race without a comment.
6005                 if ($line =~ /\bdata_race\s*\(/) {
6006                         if (!ctx_has_comment($first_line, $linenr)) {
6007                                 WARN("DATA_RACE",
6008                                      "data_race without comment\n" . $herecurr);
6009                         }
6010                 }
6011
6012 # check of hardware specific defines
6013                 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
6014                         CHK("ARCH_DEFINES",
6015                             "architecture specific defines should be avoided\n" .  $herecurr);
6016                 }
6017
6018 # check that the storage class is not after a type
6019                 if ($line =~ /\b($Type)\s+($Storage)\b/) {
6020                         WARN("STORAGE_CLASS",
6021                              "storage class '$2' should be located before type '$1'\n" . $herecurr);
6022                 }
6023 # Check that the storage class is at the beginning of a declaration
6024                 if ($line =~ /\b$Storage\b/ &&
6025                     $line !~ /^.\s*$Storage/ &&
6026                     $line =~ /^.\s*(.+?)\$Storage\s/ &&
6027                     $1 !~ /[\,\)]\s*$/) {
6028                         WARN("STORAGE_CLASS",
6029                              "storage class should be at the beginning of the declaration\n" . $herecurr);
6030                 }
6031
6032 # check the location of the inline attribute, that it is between
6033 # storage class and type.
6034                 if ($line =~ /\b$Type\s+$Inline\b/ ||
6035                     $line =~ /\b$Inline\s+$Storage\b/) {
6036                         ERROR("INLINE_LOCATION",
6037                               "inline keyword should sit between storage class and type\n" . $herecurr);
6038                 }
6039
6040 # Check for __inline__ and __inline, prefer inline
6041                 if ($realfile !~ m@\binclude/uapi/@ &&
6042                     $line =~ /\b(__inline__|__inline)\b/) {
6043                         if (WARN("INLINE",
6044                                  "plain inline is preferred over $1\n" . $herecurr) &&
6045                             $fix) {
6046                                 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
6047
6048                         }
6049                 }
6050
6051 # Check for __attribute__ packed, prefer __packed
6052                 if ($realfile !~ m@\binclude/uapi/@ &&
6053                     $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
6054                         WARN("PREFER_PACKED",
6055                              "__packed is preferred over __attribute__((packed))\n" . $herecurr);
6056                 }
6057
6058 # Check for __attribute__ aligned, prefer __aligned
6059                 if ($realfile !~ m@\binclude/uapi/@ &&
6060                     $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
6061                         WARN("PREFER_ALIGNED",
6062                              "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
6063                 }
6064
6065 # Check for __attribute__ section, prefer __section
6066                 if ($realfile !~ m@\binclude/uapi/@ &&
6067                     $line =~ /\b__attribute__\s*\(\s*\(.*_*section_*\s*\(\s*("[^"]*")/) {
6068                         my $old = substr($rawline, $-[1], $+[1] - $-[1]);
6069                         my $new = substr($old, 1, -1);
6070                         if (WARN("PREFER_SECTION",
6071                                  "__section($new) is preferred over __attribute__((section($old)))\n" . $herecurr) &&
6072                             $fix) {
6073                                 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*_*section_*\s*\(\s*\Q$old\E\s*\)\s*\)\s*\)/__section($new)/;
6074                         }
6075                 }
6076
6077 # Check for __attribute__ format(printf, prefer __printf
6078                 if ($realfile !~ m@\binclude/uapi/@ &&
6079                     $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
6080                         if (WARN("PREFER_PRINTF",
6081                                  "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
6082                             $fix) {
6083                                 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
6084
6085                         }
6086                 }
6087
6088 # Check for __attribute__ format(scanf, prefer __scanf
6089                 if ($realfile !~ m@\binclude/uapi/@ &&
6090                     $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
6091                         if (WARN("PREFER_SCANF",
6092                                  "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
6093                             $fix) {
6094                                 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
6095                         }
6096                 }
6097
6098 # Check for __attribute__ weak, or __weak declarations (may have link issues)
6099                 if ($perl_version_ok &&
6100                     $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
6101                     ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
6102                      $line =~ /\b__weak\b/)) {
6103                         ERROR("WEAK_DECLARATION",
6104                               "Using weak declarations can have unintended link defects\n" . $herecurr);
6105                 }
6106
6107 # check for c99 types like uint8_t used outside of uapi/ and tools/
6108                 if ($realfile !~ m@\binclude/uapi/@ &&
6109                     $realfile !~ m@\btools/@ &&
6110                     $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
6111                         my $type = $1;
6112                         if ($type =~ /\b($typeC99Typedefs)\b/) {
6113                                 $type = $1;
6114                                 my $kernel_type = 'u';
6115                                 $kernel_type = 's' if ($type =~ /^_*[si]/);
6116                                 $type =~ /(\d+)/;
6117                                 $kernel_type .= $1;
6118                                 if (CHK("PREFER_KERNEL_TYPES",
6119                                         "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
6120                                     $fix) {
6121                                         $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
6122                                 }
6123                         }
6124                 }
6125
6126 # check for cast of C90 native int or longer types constants
6127                 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
6128                         my $cast = $1;
6129                         my $const = $2;
6130                         if (WARN("TYPECAST_INT_CONSTANT",
6131                                  "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
6132                             $fix) {
6133                                 my $suffix = "";
6134                                 my $newconst = $const;
6135                                 $newconst =~ s/${Int_type}$//;
6136                                 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
6137                                 if ($cast =~ /\blong\s+long\b/) {
6138                                         $suffix .= 'LL';
6139                                 } elsif ($cast =~ /\blong\b/) {
6140                                         $suffix .= 'L';
6141                                 }
6142                                 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
6143                         }
6144                 }
6145
6146 # check for sizeof(&)
6147                 if ($line =~ /\bsizeof\s*\(\s*\&/) {
6148                         WARN("SIZEOF_ADDRESS",
6149                              "sizeof(& should be avoided\n" . $herecurr);
6150                 }
6151
6152 # check for sizeof without parenthesis
6153                 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
6154                         if (WARN("SIZEOF_PARENTHESIS",
6155                                  "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
6156                             $fix) {
6157                                 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
6158                         }
6159                 }
6160
6161 # check for struct spinlock declarations
6162                 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
6163                         WARN("USE_SPINLOCK_T",
6164                              "struct spinlock should be spinlock_t\n" . $herecurr);
6165                 }
6166
6167 # check for seq_printf uses that could be seq_puts
6168                 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
6169                         my $fmt = get_quoted_string($line, $rawline);
6170                         $fmt =~ s/%%//g;
6171                         if ($fmt !~ /%/) {
6172                                 if (WARN("PREFER_SEQ_PUTS",
6173                                          "Prefer seq_puts to seq_printf\n" . $herecurr) &&
6174                                     $fix) {
6175                                         $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
6176                                 }
6177                         }
6178                 }
6179
6180 # check for vsprintf extension %p<foo> misuses
6181                 if ($perl_version_ok &&
6182                     defined $stat &&
6183                     $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
6184                     $1 !~ /^_*volatile_*$/) {
6185                         my $stat_real;
6186
6187                         my $lc = $stat =~ tr@\n@@;
6188                         $lc = $lc + $linenr;
6189                         for (my $count = $linenr; $count <= $lc; $count++) {
6190                                 my $specifier;
6191                                 my $extension;
6192                                 my $qualifier;
6193                                 my $bad_specifier = "";
6194                                 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
6195                                 $fmt =~ s/%%//g;
6196
6197                                 while ($fmt =~ /(\%[\*\d\.]*p(\w)(\w*))/g) {
6198                                         $specifier = $1;
6199                                         $extension = $2;
6200                                         $qualifier = $3;
6201                                         if ($extension !~ /[SsBKRraEehMmIiUDdgVCbGNOxtf]/ ||
6202                                             ($extension eq "f" &&
6203                                              defined $qualifier && $qualifier !~ /^w/)) {
6204                                                 $bad_specifier = $specifier;
6205                                                 last;
6206                                         }
6207                                         if ($extension eq "x" && !defined($stat_real)) {
6208                                                 if (!defined($stat_real)) {
6209                                                         $stat_real = get_stat_real($linenr, $lc);
6210                                                 }
6211                                                 WARN("VSPRINTF_SPECIFIER_PX",
6212                                                      "Using vsprintf specifier '\%px' potentially exposes the kernel memory layout, if you don't really need the address please consider using '\%p'.\n" . "$here\n$stat_real\n");
6213                                         }
6214                                 }
6215                                 if ($bad_specifier ne "") {
6216                                         my $stat_real = get_stat_real($linenr, $lc);
6217                                         my $ext_type = "Invalid";
6218                                         my $use = "";
6219                                         if ($bad_specifier =~ /p[Ff]/) {
6220                                                 $use = " - use %pS instead";
6221                                                 $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/);
6222                                         }
6223
6224                                         WARN("VSPRINTF_POINTER_EXTENSION",
6225                                              "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n");
6226                                 }
6227                         }
6228                 }
6229
6230 # Check for misused memsets
6231                 if ($perl_version_ok &&
6232                     defined $stat &&
6233                     $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
6234
6235                         my $ms_addr = $2;
6236                         my $ms_val = $7;
6237                         my $ms_size = $12;
6238
6239                         if ($ms_size =~ /^(0x|)0$/i) {
6240                                 ERROR("MEMSET",
6241                                       "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
6242                         } elsif ($ms_size =~ /^(0x|)1$/i) {
6243                                 WARN("MEMSET",
6244                                      "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
6245                         }
6246                 }
6247
6248 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
6249 #               if ($perl_version_ok &&
6250 #                   defined $stat &&
6251 #                   $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6252 #                       if (WARN("PREFER_ETHER_ADDR_COPY",
6253 #                                "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
6254 #                           $fix) {
6255 #                               $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
6256 #                       }
6257 #               }
6258
6259 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
6260 #               if ($perl_version_ok &&
6261 #                   defined $stat &&
6262 #                   $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6263 #                       WARN("PREFER_ETHER_ADDR_EQUAL",
6264 #                            "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
6265 #               }
6266
6267 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
6268 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
6269 #               if ($perl_version_ok &&
6270 #                   defined $stat &&
6271 #                   $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6272 #
6273 #                       my $ms_val = $7;
6274 #
6275 #                       if ($ms_val =~ /^(?:0x|)0+$/i) {
6276 #                               if (WARN("PREFER_ETH_ZERO_ADDR",
6277 #                                        "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6278 #                                   $fix) {
6279 #                                       $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
6280 #                               }
6281 #                       } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
6282 #                               if (WARN("PREFER_ETH_BROADCAST_ADDR",
6283 #                                        "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
6284 #                                   $fix) {
6285 #                                       $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
6286 #                               }
6287 #                       }
6288 #               }
6289
6290 # typecasts on min/max could be min_t/max_t
6291                 if ($perl_version_ok &&
6292                     defined $stat &&
6293                     $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
6294                         if (defined $2 || defined $7) {
6295                                 my $call = $1;
6296                                 my $cast1 = deparenthesize($2);
6297                                 my $arg1 = $3;
6298                                 my $cast2 = deparenthesize($7);
6299                                 my $arg2 = $8;
6300                                 my $cast;
6301
6302                                 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
6303                                         $cast = "$cast1 or $cast2";
6304                                 } elsif ($cast1 ne "") {
6305                                         $cast = $cast1;
6306                                 } else {
6307                                         $cast = $cast2;
6308                                 }
6309                                 WARN("MINMAX",
6310                                      "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
6311                         }
6312                 }
6313
6314 # check usleep_range arguments
6315                 if ($perl_version_ok &&
6316                     defined $stat &&
6317                     $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
6318                         my $min = $1;
6319                         my $max = $7;
6320                         if ($min eq $max) {
6321                                 WARN("USLEEP_RANGE",
6322                                      "usleep_range should not use min == max args; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
6323                         } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
6324                                  $min > $max) {
6325                                 WARN("USLEEP_RANGE",
6326                                      "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
6327                         }
6328                 }
6329
6330 # check for naked sscanf
6331                 if ($perl_version_ok &&
6332                     defined $stat &&
6333                     $line =~ /\bsscanf\b/ &&
6334                     ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
6335                      $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
6336                      $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
6337                         my $lc = $stat =~ tr@\n@@;
6338                         $lc = $lc + $linenr;
6339                         my $stat_real = get_stat_real($linenr, $lc);
6340                         WARN("NAKED_SSCANF",
6341                              "unchecked sscanf return value\n" . "$here\n$stat_real\n");
6342                 }
6343
6344 # check for simple sscanf that should be kstrto<foo>
6345                 if ($perl_version_ok &&
6346                     defined $stat &&
6347                     $line =~ /\bsscanf\b/) {
6348                         my $lc = $stat =~ tr@\n@@;
6349                         $lc = $lc + $linenr;
6350                         my $stat_real = get_stat_real($linenr, $lc);
6351                         if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
6352                                 my $format = $6;
6353                                 my $count = $format =~ tr@%@%@;
6354                                 if ($count == 1 &&
6355                                     $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
6356                                         WARN("SSCANF_TO_KSTRTO",
6357                                              "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
6358                                 }
6359                         }
6360                 }
6361
6362 # check for new externs in .h files.
6363                 if ($realfile =~ /\.h$/ &&
6364                     $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
6365                         if (CHK("AVOID_EXTERNS",
6366                                 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
6367                             $fix) {
6368                                 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
6369                         }
6370                 }
6371
6372 # check for new externs in .c files.
6373                 if ($realfile =~ /\.c$/ && defined $stat &&
6374                     $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
6375                 {
6376                         my $function_name = $1;
6377                         my $paren_space = $2;
6378
6379                         my $s = $stat;
6380                         if (defined $cond) {
6381                                 substr($s, 0, length($cond), '');
6382                         }
6383                         if ($s =~ /^\s*;/)
6384                         {
6385                                 WARN("AVOID_EXTERNS",
6386                                      "externs should be avoided in .c files\n" .  $herecurr);
6387                         }
6388
6389                         if ($paren_space =~ /\n/) {
6390                                 WARN("FUNCTION_ARGUMENTS",
6391                                      "arguments for function declarations should follow identifier\n" . $herecurr);
6392                         }
6393
6394                 } elsif ($realfile =~ /\.c$/ && defined $stat &&
6395                     $stat =~ /^.\s*extern\s+/)
6396                 {
6397                         WARN("AVOID_EXTERNS",
6398                              "externs should be avoided in .c files\n" .  $herecurr);
6399                 }
6400
6401 # check for function declarations that have arguments without identifier names
6402                 if (defined $stat &&
6403                     $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
6404                     $1 ne "void") {
6405                         my $args = trim($1);
6406                         while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
6407                                 my $arg = trim($1);
6408                                 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
6409                                         WARN("FUNCTION_ARGUMENTS",
6410                                              "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
6411                                 }
6412                         }
6413                 }
6414
6415 # check for function definitions
6416                 if ($perl_version_ok &&
6417                     defined $stat &&
6418                     $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
6419                         $context_function = $1;
6420
6421 # check for multiline function definition with misplaced open brace
6422                         my $ok = 0;
6423                         my $cnt = statement_rawlines($stat);
6424                         my $herectx = $here . "\n";
6425                         for (my $n = 0; $n < $cnt; $n++) {
6426                                 my $rl = raw_line($linenr, $n);
6427                                 $herectx .=  $rl . "\n";
6428                                 $ok = 1 if ($rl =~ /^[ \+]\{/);
6429                                 $ok = 1 if ($rl =~ /\{/ && $n == 0);
6430                                 last if $rl =~ /^[ \+].*\{/;
6431                         }
6432                         if (!$ok) {
6433                                 ERROR("OPEN_BRACE",
6434                                       "open brace '{' following function definitions go on the next line\n" . $herectx);
6435                         }
6436                 }
6437
6438 # checks for new __setup's
6439                 if ($rawline =~ /\b__setup\("([^"]*)"/) {
6440                         my $name = $1;
6441
6442                         if (!grep(/$name/, @setup_docs)) {
6443                                 CHK("UNDOCUMENTED_SETUP",
6444                                     "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.txt\n" . $herecurr);
6445                         }
6446                 }
6447
6448 # check for pointless casting of alloc functions
6449                 if ($line =~ /\*\s*\)\s*$allocFunctions\b/) {
6450                         WARN("UNNECESSARY_CASTS",
6451                              "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
6452                 }
6453
6454 # alloc style
6455 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6456                 if ($perl_version_ok &&
6457                     $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6458                         CHK("ALLOC_SIZEOF_STRUCT",
6459                             "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
6460                 }
6461
6462 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6463                 if ($perl_version_ok &&
6464                     defined $stat &&
6465                     $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
6466                         my $oldfunc = $3;
6467                         my $a1 = $4;
6468                         my $a2 = $10;
6469                         my $newfunc = "kmalloc_array";
6470                         $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
6471                         my $r1 = $a1;
6472                         my $r2 = $a2;
6473                         if ($a1 =~ /^sizeof\s*\S/) {
6474                                 $r1 = $a2;
6475                                 $r2 = $a1;
6476                         }
6477                         if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
6478                             !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
6479                                 my $cnt = statement_rawlines($stat);
6480                                 my $herectx = get_stat_here($linenr, $cnt, $here);
6481
6482                                 if (WARN("ALLOC_WITH_MULTIPLY",
6483                                          "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
6484                                     $cnt == 1 &&
6485                                     $fix) {
6486                                         $fixed[$fixlinenr] =~ s/\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)/$1 . ' = ' . "$newfunc(" . trim($r1) . ', ' . trim($r2)/e;
6487                                 }
6488                         }
6489                 }
6490
6491 # check for krealloc arg reuse
6492                 if ($perl_version_ok &&
6493                     $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ &&
6494                     $1 eq $3) {
6495                         WARN("KREALLOC_ARG_REUSE",
6496                              "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
6497                 }
6498
6499 # check for alloc argument mismatch
6500                 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
6501                         WARN("ALLOC_ARRAY_ARGS",
6502                              "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
6503                 }
6504
6505 # check for multiple semicolons
6506                 if ($line =~ /;\s*;\s*$/) {
6507                         if (WARN("ONE_SEMICOLON",
6508                                  "Statements terminations use 1 semicolon\n" . $herecurr) &&
6509                             $fix) {
6510                                 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
6511                         }
6512                 }
6513
6514 # check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6515                 if ($realfile !~ m@^include/uapi/@ &&
6516                     $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
6517                         my $ull = "";
6518                         $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
6519                         if (CHK("BIT_MACRO",
6520                                 "Prefer using the BIT$ull macro\n" . $herecurr) &&
6521                             $fix) {
6522                                 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
6523                         }
6524                 }
6525
6526 # check for IS_ENABLED() without CONFIG_<FOO> ($rawline for comments too)
6527                 if ($rawline =~ /\bIS_ENABLED\s*\(\s*(\w+)\s*\)/ && $1 !~ /^CONFIG_/) {
6528                         WARN("IS_ENABLED_CONFIG",
6529                              "IS_ENABLED($1) is normally used as IS_ENABLED(CONFIG_$1)\n" . $herecurr);
6530                 }
6531
6532 # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6533                 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6534                         my $config = $1;
6535                         if (WARN("PREFER_IS_ENABLED",
6536                                  "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
6537                             $fix) {
6538                                 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
6539                         }
6540                 }
6541
6542 # check for /* fallthrough */ like comment, prefer fallthrough;
6543                 my @fallthroughs = (
6544                         'fallthrough',
6545                         '@fallthrough@',
6546                         'lint -fallthrough[ \t]*',
6547                         'intentional(?:ly)?[ \t]*fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)',
6548                         '(?:else,?\s*)?FALL(?:S | |-)?THR(?:OUGH|U|EW)[ \t.!]*(?:-[^\n\r]*)?',
6549                         'Fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?',
6550                         'fall(?:s | |-)?thr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?',
6551                     );
6552                 if ($raw_comment ne '') {
6553                         foreach my $ft (@fallthroughs) {
6554                                 if ($raw_comment =~ /$ft/) {
6555                                         my $msg_level = \&WARN;
6556                                         $msg_level = \&CHK if ($file);
6557                                         &{$msg_level}("PREFER_FALLTHROUGH",
6558                                                       "Prefer 'fallthrough;' over fallthrough comment\n" . $herecurr);
6559                                         last;
6560                                 }
6561                         }
6562                 }
6563
6564 # check for switch/default statements without a break;
6565                 if ($perl_version_ok &&
6566                     defined $stat &&
6567                     $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
6568                         my $cnt = statement_rawlines($stat);
6569                         my $herectx = get_stat_here($linenr, $cnt, $here);
6570
6571                         WARN("DEFAULT_NO_BREAK",
6572                              "switch default: should use break\n" . $herectx);
6573                 }
6574
6575 # check for gcc specific __FUNCTION__
6576                 if ($line =~ /\b__FUNCTION__\b/) {
6577                         if (WARN("USE_FUNC",
6578                                  "__func__ should be used instead of gcc specific __FUNCTION__\n"  . $herecurr) &&
6579                             $fix) {
6580                                 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
6581                         }
6582                 }
6583
6584 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
6585                 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
6586                         ERROR("DATE_TIME",
6587                               "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
6588                 }
6589
6590 # check for use of yield()
6591                 if ($line =~ /\byield\s*\(\s*\)/) {
6592                         WARN("YIELD",
6593                              "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n"  . $herecurr);
6594                 }
6595
6596 # check for comparisons against true and false
6597                 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6598                         my $lead = $1;
6599                         my $arg = $2;
6600                         my $test = $3;
6601                         my $otype = $4;
6602                         my $trail = $5;
6603                         my $op = "!";
6604
6605                         ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6606
6607                         my $type = lc($otype);
6608                         if ($type =~ /^(?:true|false)$/) {
6609                                 if (("$test" eq "==" && "$type" eq "true") ||
6610                                     ("$test" eq "!=" && "$type" eq "false")) {
6611                                         $op = "";
6612                                 }
6613
6614                                 CHK("BOOL_COMPARISON",
6615                                     "Using comparison to $otype is error prone\n" . $herecurr);
6616
6617 ## maybe suggesting a correct construct would better
6618 ##                                  "Using comparison to $otype is error prone.  Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6619
6620                         }
6621                 }
6622
6623 # check for semaphores initialized locked
6624                 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
6625                         WARN("CONSIDER_COMPLETION",
6626                              "consider using a completion\n" . $herecurr);
6627                 }
6628
6629 # recommend kstrto* over simple_strto* and strict_strto*
6630                 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
6631                         WARN("CONSIDER_KSTRTO",
6632                              "$1 is obsolete, use k$3 instead\n" . $herecurr);
6633                 }
6634
6635 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
6636                 if ($line =~ /^.\s*__initcall\s*\(/) {
6637                         WARN("USE_DEVICE_INITCALL",
6638                              "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
6639                 }
6640
6641 # check for spin_is_locked(), suggest lockdep instead
6642                 if ($line =~ /\bspin_is_locked\(/) {
6643                         WARN("USE_LOCKDEP",
6644                              "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr);
6645                 }
6646
6647 # check for deprecated apis
6648                 if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) {
6649                         my $deprecated_api = $1;
6650                         my $new_api = $deprecated_apis{$deprecated_api};
6651                         WARN("DEPRECATED_API",
6652                              "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr);
6653                 }
6654
6655 # check for various structs that are normally const (ops, kgdb, device_tree)
6656 # and avoid what seem like struct definitions 'struct foo {'
6657                 if (defined($const_structs) &&
6658                     $line !~ /\bconst\b/ &&
6659                     $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
6660                         WARN("CONST_STRUCT",
6661                              "struct $1 should normally be const\n" . $herecurr);
6662                 }
6663
6664 # use of NR_CPUS is usually wrong
6665 # ignore definitions of NR_CPUS and usage to define arrays as likely right
6666                 if ($line =~ /\bNR_CPUS\b/ &&
6667                     $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6668                     $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
6669                     $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6670                     $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6671                     $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
6672                 {
6673                         WARN("NR_CPUS",
6674                              "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
6675                 }
6676
6677 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6678                 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6679                         ERROR("DEFINE_ARCH_HAS",
6680                               "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6681                 }
6682
6683 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
6684                 if ($perl_version_ok &&
6685                     $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6686                         WARN("LIKELY_MISUSE",
6687                              "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6688                 }
6689
6690 # nested likely/unlikely calls
6691                 if ($line =~ /\b(?:(?:un)?likely)\s*\(\s*!?\s*(IS_ERR(?:_OR_NULL|_VALUE)?|WARN)/) {
6692                         WARN("LIKELY_MISUSE",
6693                              "nested (un)?likely() calls, $1 already uses unlikely() internally\n" . $herecurr);
6694                 }
6695
6696 # whine mightly about in_atomic
6697                 if ($line =~ /\bin_atomic\s*\(/) {
6698                         if ($realfile =~ m@^drivers/@) {
6699                                 ERROR("IN_ATOMIC",
6700                                       "do not use in_atomic in drivers\n" . $herecurr);
6701                         } elsif ($realfile !~ m@^kernel/@) {
6702                                 WARN("IN_ATOMIC",
6703                                      "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
6704                         }
6705                 }
6706
6707 # check for mutex_trylock_recursive usage
6708                 if ($line =~ /mutex_trylock_recursive/) {
6709                         ERROR("LOCKING",
6710                               "recursive locking is bad, do not use this ever.\n" . $herecurr);
6711                 }
6712
6713 # check for lockdep_set_novalidate_class
6714                 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6715                     $line =~ /__lockdep_no_validate__\s*\)/ ) {
6716                         if ($realfile !~ m@^kernel/lockdep@ &&
6717                             $realfile !~ m@^include/linux/lockdep@ &&
6718                             $realfile !~ m@^drivers/base/core@) {
6719                                 ERROR("LOCKDEP",
6720                                       "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
6721                         }
6722                 }
6723
6724                 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6725                     $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
6726                         WARN("EXPORTED_WORLD_WRITABLE",
6727                              "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6728                 }
6729
6730 # check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6731 # and whether or not function naming is typical and if
6732 # DEVICE_ATTR permissions uses are unusual too
6733                 if ($perl_version_ok &&
6734                     defined $stat &&
6735                     $stat =~ /\bDEVICE_ATTR\s*\(\s*(\w+)\s*,\s*\(?\s*(\s*(?:${multi_mode_perms_string_search}|0[0-7]{3,3})\s*)\s*\)?\s*,\s*(\w+)\s*,\s*(\w+)\s*\)/) {
6736                         my $var = $1;
6737                         my $perms = $2;
6738                         my $show = $3;
6739                         my $store = $4;
6740                         my $octal_perms = perms_to_octal($perms);
6741                         if ($show =~ /^${var}_show$/ &&
6742                             $store =~ /^${var}_store$/ &&
6743                             $octal_perms eq "0644") {
6744                                 if (WARN("DEVICE_ATTR_RW",
6745                                          "Use DEVICE_ATTR_RW\n" . $herecurr) &&
6746                                     $fix) {
6747                                         $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6748                                 }
6749                         } elsif ($show =~ /^${var}_show$/ &&
6750                                  $store =~ /^NULL$/ &&
6751                                  $octal_perms eq "0444") {
6752                                 if (WARN("DEVICE_ATTR_RO",
6753                                          "Use DEVICE_ATTR_RO\n" . $herecurr) &&
6754                                     $fix) {
6755                                         $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6756                                 }
6757                         } elsif ($show =~ /^NULL$/ &&
6758                                  $store =~ /^${var}_store$/ &&
6759                                  $octal_perms eq "0200") {
6760                                 if (WARN("DEVICE_ATTR_WO",
6761                                          "Use DEVICE_ATTR_WO\n" . $herecurr) &&
6762                                     $fix) {
6763                                         $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6764                                 }
6765                         } elsif ($octal_perms eq "0644" ||
6766                                  $octal_perms eq "0444" ||
6767                                  $octal_perms eq "0200") {
6768                                 my $newshow = "$show";
6769                                 $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show");
6770                                 my $newstore = $store;
6771                                 $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store");
6772                                 my $rename = "";
6773                                 if ($show ne $newshow) {
6774                                         $rename .= " '$show' to '$newshow'";
6775                                 }
6776                                 if ($store ne $newstore) {
6777                                         $rename .= " '$store' to '$newstore'";
6778                                 }
6779                                 WARN("DEVICE_ATTR_FUNCTIONS",
6780                                      "Consider renaming function(s)$rename\n" . $herecurr);
6781                         } else {
6782                                 WARN("DEVICE_ATTR_PERMS",
6783                                      "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr);
6784                         }
6785                 }
6786
6787 # Mode permission misuses where it seems decimal should be octal
6788 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6789 # o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6790 #   specific definition of not visible in sysfs.
6791 # o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6792 #   use the default permissions
6793                 if ($perl_version_ok &&
6794                     defined $stat &&
6795                     $line =~ /$mode_perms_search/) {
6796                         foreach my $entry (@mode_permission_funcs) {
6797                                 my $func = $entry->[0];
6798                                 my $arg_pos = $entry->[1];
6799
6800                                 my $lc = $stat =~ tr@\n@@;
6801                                 $lc = $lc + $linenr;
6802                                 my $stat_real = get_stat_real($linenr, $lc);
6803
6804                                 my $skip_args = "";
6805                                 if ($arg_pos > 1) {
6806                                         $arg_pos--;
6807                                         $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6808                                 }
6809                                 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
6810                                 if ($stat =~ /$test/) {
6811                                         my $val = $1;
6812                                         $val = $6 if ($skip_args ne "");
6813                                         if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
6814                                             (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6815                                              ($val =~ /^$Octal$/ && length($val) ne 4))) {
6816                                                 ERROR("NON_OCTAL_PERMISSIONS",
6817                                                       "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
6818                                         }
6819                                         if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
6820                                                 ERROR("EXPORTED_WORLD_WRITABLE",
6821                                                       "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
6822                                         }
6823                                 }
6824                         }
6825                 }
6826
6827 # check for uses of S_<PERMS> that could be octal for readability
6828                 while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) {
6829                         my $oval = $1;
6830                         my $octal = perms_to_octal($oval);
6831                         if (WARN("SYMBOLIC_PERMS",
6832                                  "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6833                             $fix) {
6834                                 $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
6835                         }
6836                 }
6837
6838 # validate content of MODULE_LICENSE against list from include/linux/module.h
6839                 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6840                         my $extracted_string = get_quoted_string($line, $rawline);
6841                         my $valid_licenses = qr{
6842                                                 GPL|
6843                                                 GPL\ v2|
6844                                                 GPL\ and\ additional\ rights|
6845                                                 Dual\ BSD/GPL|
6846                                                 Dual\ MIT/GPL|
6847                                                 Dual\ MPL/GPL|
6848                                                 Proprietary
6849                                         }x;
6850                         if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6851                                 WARN("MODULE_LICENSE",
6852                                      "unknown module license " . $extracted_string . "\n" . $herecurr);
6853                         }
6854                 }
6855
6856 # check for sysctl duplicate constants
6857                 if ($line =~ /\.extra[12]\s*=\s*&(zero|one|int_max)\b/) {
6858                         WARN("DUPLICATED_SYSCTL_CONST",
6859                                 "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr);
6860                 }
6861         }
6862
6863         # If we have no input at all, then there is nothing to report on
6864         # so just keep quiet.
6865         if ($#rawlines == -1) {
6866                 exit(0);
6867         }
6868
6869         # In mailback mode only produce a report in the negative, for
6870         # things that appear to be patches.
6871         if ($mailback && ($clean == 1 || !$is_patch)) {
6872                 exit(0);
6873         }
6874
6875         # This is not a patch, and we are are in 'no-patch' mode so
6876         # just keep quiet.
6877         if (!$chk_patch && !$is_patch) {
6878                 exit(0);
6879         }
6880
6881         if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
6882                 ERROR("NOT_UNIFIED_DIFF",
6883                       "Does not appear to be a unified-diff format patch\n");
6884         }
6885         if ($is_patch && $has_commit_log && $chk_signoff) {
6886                 if ($signoff == 0) {
6887                         ERROR("MISSING_SIGN_OFF",
6888                               "Missing Signed-off-by: line(s)\n");
6889                 } elsif (!$authorsignoff) {
6890                         WARN("NO_AUTHOR_SIGN_OFF",
6891                              "Missing Signed-off-by: line by nominal patch author '$author'\n");
6892                 }
6893         }
6894
6895         print report_dump();
6896         if ($summary && !($clean == 1 && $quiet == 1)) {
6897                 print "$filename " if ($summary_file);
6898                 print "total: $cnt_error errors, $cnt_warn warnings, " .
6899                         (($check)? "$cnt_chk checks, " : "") .
6900                         "$cnt_lines lines checked\n";
6901         }
6902
6903         if ($quiet == 0) {
6904                 # If there were any defects found and not already fixing them
6905                 if (!$clean and !$fix) {
6906                         print << "EOM"
6907
6908 NOTE: For some of the reported defects, checkpatch may be able to
6909       mechanically convert to the typical style using --fix or --fix-inplace.
6910 EOM
6911                 }
6912                 # If there were whitespace errors which cleanpatch can fix
6913                 # then suggest that.
6914                 if ($rpt_cleaners) {
6915                         $rpt_cleaners = 0;
6916                         print << "EOM"
6917
6918 NOTE: Whitespace errors detected.
6919       You may wish to use scripts/cleanpatch or scripts/cleanfile
6920 EOM
6921                 }
6922         }
6923
6924         if ($clean == 0 && $fix &&
6925             ("@rawlines" ne "@fixed" ||
6926              $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
6927                 my $newfile = $filename;
6928                 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
6929                 my $linecount = 0;
6930                 my $f;
6931
6932                 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6933
6934                 open($f, '>', $newfile)
6935                     or die "$P: Can't open $newfile for write\n";
6936                 foreach my $fixed_line (@fixed) {
6937                         $linecount++;
6938                         if ($file) {
6939                                 if ($linecount > 3) {
6940                                         $fixed_line =~ s/^\+//;
6941                                         print $f $fixed_line . "\n";
6942                                 }
6943                         } else {
6944                                 print $f $fixed_line . "\n";
6945                         }
6946                 }
6947                 close($f);
6948
6949                 if (!$quiet) {
6950                         print << "EOM";
6951
6952 Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6953
6954 Do _NOT_ trust the results written to this file.
6955 Do _NOT_ submit these changes without inspecting them for correctness.
6956
6957 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6958 No warranties, expressed or implied...
6959 EOM
6960                 }
6961         }
6962
6963         if ($quiet == 0) {
6964                 print "\n";
6965                 if ($clean == 1) {
6966                         print "$vname has no obvious style problems and is ready for submission.\n";
6967                 } else {
6968                         print "$vname has style problems, please review.\n";
6969                 }
6970         }
6971         return $clean;
6972 }