scripts/checkpatch.pl

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