git.gag.com Git - fw/openocd/blob - tools/scripts/checkpatch.pl

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