scripts/checkpatch.pl

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