scripts/checkpatch.pl

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