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                 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2755                     $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
2756                     $rawline =~ /^\+[ \t]*\*/ &&
2757                     $realline > 2) {
2758                         WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2759                              "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2760                 }
2761
2762                 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2763                     $prevrawline =~ /^\+[ \t]*\/\*/ &&          #starting /*
2764                     $prevrawline !~ /\*\/[ \t]*$/ &&            #no trailing */
2765                     $rawline =~ /^\+/ &&                        #line is new
2766                     $rawline !~ /^\+[ \t]*\*/) {                #no leading *
2767                         WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2768                              "networking block comments start with * on subsequent lines\n" . $hereprev);
2769                 }
2770
2771                 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2772                     $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ &&       #trailing */
2773                     $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ &&      #inline /*...*/
2774                     $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ &&       #trailing **/
2775                     $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) {    #non blank */
2776                         WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2777                              "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2778                 }
2779
2780 # check for missing blank lines after struct/union declarations
2781 # with exceptions for various attributes and macros
2782                 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2783                     $line =~ /^\+/ &&
2784                     !($line =~ /^\+\s*$/ ||
2785                       $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2786                       $line =~ /^\+\s*MODULE_/i ||
2787                       $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2788                       $line =~ /^\+[a-z_]*init/ ||
2789                       $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2790                       $line =~ /^\+\s*DECLARE/ ||
2791                       $line =~ /^\+\s*__setup/)) {
2792                         if (CHK("LINE_SPACING",
2793                                 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
2794                             $fix) {
2795                                 fix_insert_line($fixlinenr, "\+");
2796                         }
2797                 }
2798
2799 # check for multiple consecutive blank lines
2800                 if ($prevline =~ /^[\+ ]\s*$/ &&
2801                     $line =~ /^\+\s*$/ &&
2802                     $last_blank_line != ($linenr - 1)) {
2803                         if (CHK("LINE_SPACING",
2804                                 "Please don't use multiple blank lines\n" . $hereprev) &&
2805                             $fix) {
2806                                 fix_delete_line($fixlinenr, $rawline);
2807                         }
2808
2809                         $last_blank_line = $linenr;
2810                 }
2811
2812 # check for missing blank lines after declarations
2813                 if ($sline =~ /^\+\s+\S/ &&                     #Not at char 1
2814                         # actual declarations
2815                     ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2816                         # function pointer declarations
2817                      $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2818                         # foo bar; where foo is some local typedef or #define
2819                      $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2820                         # known declaration macros
2821                      $prevline =~ /^\+\s+$declaration_macros/) &&
2822                         # for "else if" which can look like "$Ident $Ident"
2823                     !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2824                         # other possible extensions of declaration lines
2825                       $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2826                         # not starting a section or a macro "\" extended line
2827                       $prevline =~ /(?:\{\s*|\\)$/) &&
2828                         # looks like a declaration
2829                     !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2830                         # function pointer declarations
2831                       $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2832                         # foo bar; where foo is some local typedef or #define
2833                       $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2834                         # known declaration macros
2835                       $sline =~ /^\+\s+$declaration_macros/ ||
2836                         # start of struct or union or enum
2837                       $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
2838                         # start or end of block or continuation of declaration
2839                       $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
2840                         # bitfield continuation
2841                       $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
2842                         # other possible extensions of declaration lines
2843                       $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
2844                         # indentation of previous and current line are the same
2845                     (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
2846                         if (WARN("LINE_SPACING",
2847                                  "Missing a blank line after declarations\n" . $hereprev) &&
2848                             $fix) {
2849                                 fix_insert_line($fixlinenr, "\+");
2850                         }
2851                 }
2852
2853 # check for spaces at the beginning of a line.
2854 # Exceptions:
2855 #  1) within comments
2856 #  2) indented preprocessor commands
2857 #  3) hanging labels
2858                 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/)  {
2859                         my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2860                         if (WARN("LEADING_SPACE",
2861                                  "please, no spaces at the start of a line\n" . $herevet) &&
2862                             $fix) {
2863                                 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2864                         }
2865                 }
2866
2867 # check we are in a valid C source file if not then ignore this hunk
2868                 next if ($realfile !~ /\.(h|c)$/);
2869
2870 # check indentation of any line with a bare else
2871 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
2872 # if the previous line is a break or return and is indented 1 tab more...
2873                 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
2874                         my $tabs = length($1) + 1;
2875                         if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
2876                             ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
2877                              defined $lines[$linenr] &&
2878                              $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
2879                                 WARN("UNNECESSARY_ELSE",
2880                                      "else is not generally useful after a break or return\n" . $hereprev);
2881                         }
2882                 }
2883
2884 # check indentation of a line with a break;
2885 # if the previous line is a goto or return and is indented the same # of tabs
2886                 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
2887                         my $tabs = $1;
2888                         if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
2889                                 WARN("UNNECESSARY_BREAK",
2890                                      "break is not useful after a goto or return\n" . $hereprev);
2891                         }
2892                 }
2893
2894 # discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2895                 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2896                         WARN("CONFIG_EXPERIMENTAL",
2897                              "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2898                 }
2899
2900 # check for RCS/CVS revision markers
2901                 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
2902                         WARN("CVS_KEYWORD",
2903                              "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
2904                 }
2905
2906 # Blackfin: don't use __builtin_bfin_[cs]sync
2907                 if ($line =~ /__builtin_bfin_csync/) {
2908                         my $herevet = "$here\n" . cat_vet($line) . "\n";
2909                         ERROR("CSYNC",
2910                               "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
2911                 }
2912                 if ($line =~ /__builtin_bfin_ssync/) {
2913                         my $herevet = "$here\n" . cat_vet($line) . "\n";
2914                         ERROR("SSYNC",
2915                               "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
2916                 }
2917
2918 # check for old HOTPLUG __dev<foo> section markings
2919                 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2920                         WARN("HOTPLUG_SECTION",
2921                              "Using $1 is unnecessary\n" . $herecurr);
2922                 }
2923
2924 # Check for potential 'bare' types
2925                 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2926                     $realline_next);
2927 #print "LINE<$line>\n";
2928                 if ($linenr >= $suppress_statement &&
2929                     $realcnt && $sline =~ /.\s*\S/) {
2930                         ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2931                                 ctx_statement_block($linenr, $realcnt, 0);
2932                         $stat =~ s/\n./\n /g;
2933                         $cond =~ s/\n./\n /g;
2934
2935 #print "linenr<$linenr> <$stat>\n";
2936                         # If this statement has no statement boundaries within
2937                         # it there is no point in retrying a statement scan
2938                         # until we hit end of it.
2939                         my $frag = $stat; $frag =~ s/;+\s*$//;
2940                         if ($frag !~ /(?:{|;)/) {
2941 #print "skip<$line_nr_next>\n";
2942                                 $suppress_statement = $line_nr_next;
2943                         }
2944
2945                         # Find the real next line.
2946                         $realline_next = $line_nr_next;
2947                         if (defined $realline_next &&
2948                             (!defined $lines[$realline_next - 1] ||
2949                              substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2950                                 $realline_next++;
2951                         }
2952
2953                         my $s = $stat;
2954                         $s =~ s/{.*$//s;
2955
2956                         # Ignore goto labels.
2957                         if ($s =~ /$Ident:\*$/s) {
2958
2959                         # Ignore functions being called
2960                         } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
2961
2962                         } elsif ($s =~ /^.\s*else\b/s) {
2963
2964                         # declarations always start with types
2965                         } 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) {
2966                                 my $type = $1;
2967                                 $type =~ s/\s+/ /g;
2968                                 possible($type, "A:" . $s);
2969
2970                         # definitions in global scope can only start with types
2971                         } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
2972                                 possible($1, "B:" . $s);
2973                         }
2974
2975                         # any (foo ... *) is a pointer cast, and foo is a type
2976                         while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
2977                                 possible($1, "C:" . $s);
2978                         }
2979
2980                         # Check for any sort of function declaration.
2981                         # int foo(something bar, other baz);
2982                         # void (*store_gdt)(x86_descr_ptr *);
2983                         if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
2984                                 my ($name_len) = length($1);
2985
2986                                 my $ctx = $s;
2987                                 substr($ctx, 0, $name_len + 1, '');
2988                                 $ctx =~ s/\)[^\)]*$//;
2989
2990                                 for my $arg (split(/\s*,\s*/, $ctx)) {
2991                                         if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
2992
2993                                                 possible($1, "D:" . $s);
2994                                         }
2995                                 }
2996                         }
2997
2998                 }
2999
3000 #
3001 # Checks which may be anchored in the context.
3002 #
3003
3004 # Check for switch () and associated case and default
3005 # statements should be at the same indent.
3006                 if ($line=~/\bswitch\s*\(.*\)/) {
3007                         my $err = '';
3008                         my $sep = '';
3009                         my @ctx = ctx_block_outer($linenr, $realcnt);
3010                         shift(@ctx);
3011                         for my $ctx (@ctx) {
3012                                 my ($clen, $cindent) = line_stats($ctx);
3013                                 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3014                                                         $indent != $cindent) {
3015                                         $err .= "$sep$ctx\n";
3016                                         $sep = '';
3017                                 } else {
3018                                         $sep = "[...]\n";
3019                                 }
3020                         }
3021                         if ($err ne '') {
3022                                 ERROR("SWITCH_CASE_INDENT_LEVEL",
3023                                       "switch and case should be at the same indent\n$hereline$err");
3024                         }
3025                 }
3026
3027 # if/while/etc brace do not go on next line, unless defining a do while loop,
3028 # or if that brace on the next line is for something else
3029                 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3030                         my $pre_ctx = "$1$2";
3031
3032                         my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
3033
3034                         if ($line =~ /^\+\t{6,}/) {
3035                                 WARN("DEEP_INDENTATION",
3036                                      "Too many leading tabs - consider code refactoring\n" . $herecurr);
3037                         }
3038
3039                         my $ctx_cnt = $realcnt - $#ctx - 1;
3040                         my $ctx = join("\n", @ctx);
3041
3042                         my $ctx_ln = $linenr;
3043                         my $ctx_skip = $realcnt;
3044
3045                         while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3046                                         defined $lines[$ctx_ln - 1] &&
3047                                         $lines[$ctx_ln - 1] =~ /^-/)) {
3048                                 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3049                                 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
3050                                 $ctx_ln++;
3051                         }
3052
3053                         #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3054                         #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3055
3056                         if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
3057                                 ERROR("OPEN_BRACE",
3058                                       "that open brace { should be on the previous line\n" .
3059                                         "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3060                         }
3061                         if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3062                             $ctx =~ /\)\s*\;\s*$/ &&
3063                             defined $lines[$ctx_ln - 1])
3064                         {
3065                                 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3066                                 if ($nindent > $indent) {
3067                                         WARN("TRAILING_SEMICOLON",
3068                                              "trailing semicolon indicates no statements, indent implies otherwise\n" .
3069                                                 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3070                                 }
3071                         }
3072                 }
3073
3074 # Check relative indent for conditionals and blocks.
3075                 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3076                         ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3077                                 ctx_statement_block($linenr, $realcnt, 0)
3078                                         if (!defined $stat);
3079                         my ($s, $c) = ($stat, $cond);
3080
3081                         substr($s, 0, length($c), '');
3082
3083                         # remove inline comments
3084                         $s =~ s/$;/ /g;
3085                         $c =~ s/$;/ /g;
3086
3087                         # Find out how long the conditional actually is.
3088                         my @newlines = ($c =~ /\n/gs);
3089                         my $cond_lines = 1 + $#newlines;
3090
3091                         # Make sure we remove the line prefixes as we have
3092                         # none on the first line, and are going to readd them
3093                         # where necessary.
3094                         $s =~ s/\n./\n/gs;
3095                         while ($s =~ /\n\s+\\\n/) {
3096                                 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3097                         }
3098
3099                         # We want to check the first line inside the block
3100                         # starting at the end of the conditional, so remove:
3101                         #  1) any blank line termination
3102                         #  2) any opening brace { on end of the line
3103                         #  3) any do (...) {
3104                         my $continuation = 0;
3105                         my $check = 0;
3106                         $s =~ s/^.*\bdo\b//;
3107                         $s =~ s/^\s*{//;
3108                         if ($s =~ s/^\s*\\//) {
3109                                 $continuation = 1;
3110                         }
3111                         if ($s =~ s/^\s*?\n//) {
3112                                 $check = 1;
3113                                 $cond_lines++;
3114                         }
3115
3116                         # Also ignore a loop construct at the end of a
3117                         # preprocessor statement.
3118                         if (($prevline =~ /^.\s*#\s*define\s/ ||
3119                             $prevline =~ /\\\s*$/) && $continuation == 0) {
3120                                 $check = 0;
3121                         }
3122
3123                         my $cond_ptr = -1;
3124                         $continuation = 0;
3125                         while ($cond_ptr != $cond_lines) {
3126                                 $cond_ptr = $cond_lines;
3127
3128                                 # If we see an #else/#elif then the code
3129                                 # is not linear.
3130                                 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3131                                         $check = 0;
3132                                 }
3133
3134                                 # Ignore:
3135                                 #  1) blank lines, they should be at 0,
3136                                 #  2) preprocessor lines, and
3137                                 #  3) labels.
3138                                 if ($continuation ||
3139                                     $s =~ /^\s*?\n/ ||
3140                                     $s =~ /^\s*#\s*?/ ||
3141                                     $s =~ /^\s*$Ident\s*:/) {
3142                                         $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
3143                                         if ($s =~ s/^.*?\n//) {
3144                                                 $cond_lines++;
3145                                         }
3146                                 }
3147                         }
3148
3149                         my (undef, $sindent) = line_stats("+" . $s);
3150                         my $stat_real = raw_line($linenr, $cond_lines);
3151
3152                         # Check if either of these lines are modified, else
3153                         # this is not this patch's fault.
3154                         if (!defined($stat_real) ||
3155                             $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3156                                 $check = 0;
3157                         }
3158                         if (defined($stat_real) && $cond_lines > 1) {
3159                                 $stat_real = "[...]\n$stat_real";
3160                         }
3161
3162                         #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";
3163
3164                         if ($check && $s ne '' &&
3165                             (($sindent % 8) != 0 ||
3166                              ($sindent < $indent) ||
3167                              ($sindent > $indent + 8))) {
3168                                 WARN("SUSPECT_CODE_INDENT",
3169                                      "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3170                         }
3171                 }
3172
3173                 # Track the 'values' across context and added lines.
3174                 my $opline = $line; $opline =~ s/^./ /;
3175                 my ($curr_values, $curr_vars) =
3176                                 annotate_values($opline . "\n", $prev_values);
3177                 $curr_values = $prev_values . $curr_values;
3178                 if ($dbg_values) {
3179                         my $outline = $opline; $outline =~ s/\t/ /g;
3180                         print "$linenr > .$outline\n";
3181                         print "$linenr > $curr_values\n";
3182                         print "$linenr >  $curr_vars\n";
3183                 }
3184                 $prev_values = substr($curr_values, -1);
3185
3186 #ignore lines not being added
3187                 next if ($line =~ /^[^\+]/);
3188
3189 # TEST: allow direct testing of the type matcher.
3190                 if ($dbg_type) {
3191                         if ($line =~ /^.\s*$Declare\s*$/) {
3192                                 ERROR("TEST_TYPE",
3193                                       "TEST: is type\n" . $herecurr);
3194                         } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
3195                                 ERROR("TEST_NOT_TYPE",
3196                                       "TEST: is not type ($1 is)\n". $herecurr);
3197                         }
3198                         next;
3199                 }
3200 # TEST: allow direct testing of the attribute matcher.
3201                 if ($dbg_attr) {
3202                         if ($line =~ /^.\s*$Modifier\s*$/) {
3203                                 ERROR("TEST_ATTR",
3204                                       "TEST: is attr\n" . $herecurr);
3205                         } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
3206                                 ERROR("TEST_NOT_ATTR",
3207                                       "TEST: is not attr ($1 is)\n". $herecurr);
3208                         }
3209                         next;
3210                 }
3211
3212 # check for initialisation to aggregates open brace on the next line
3213                 if ($line =~ /^.\s*{/ &&
3214                     $prevline =~ /(?:^|[^=])=\s*$/) {
3215                         if (ERROR("OPEN_BRACE",
3216                                   "that open brace { should be on the previous line\n" . $hereprev) &&
3217                             $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3218                                 fix_delete_line($fixlinenr - 1, $prevrawline);
3219                                 fix_delete_line($fixlinenr, $rawline);
3220                                 my $fixedline = $prevrawline;
3221                                 $fixedline =~ s/\s*=\s*$/ = {/;
3222                                 fix_insert_line($fixlinenr, $fixedline);
3223                                 $fixedline = $line;
3224                                 $fixedline =~ s/^(.\s*){\s*/$1/;
3225                                 fix_insert_line($fixlinenr, $fixedline);
3226                         }
3227                 }
3228
3229 #
3230 # Checks which are anchored on the added line.
3231 #
3232
3233 # check for malformed paths in #include statements (uses RAW line)
3234                 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
3235                         my $path = $1;
3236                         if ($path =~ m{//}) {
3237                                 ERROR("MALFORMED_INCLUDE",
3238                                       "malformed #include filename\n" . $herecurr);
3239                         }
3240                         if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3241                                 ERROR("UAPI_INCLUDE",
3242                                       "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
3243                         }
3244                 }
3245
3246 # no C99 // comments
3247                 if ($line =~ m{//}) {
3248                         if (ERROR("C99_COMMENTS",
3249                                   "do not use C99 // comments\n" . $herecurr) &&
3250                             $fix) {
3251                                 my $line = $fixed[$fixlinenr];
3252                                 if ($line =~ /\/\/(.*)$/) {
3253                                         my $comment = trim($1);
3254                                         $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
3255                                 }
3256                         }
3257                 }
3258                 # Remove C99 comments.
3259                 $line =~ s@//.*@@;
3260                 $opline =~ s@//.*@@;
3261
3262 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3263 # the whole statement.
3264 #print "APW <$lines[$realline_next - 1]>\n";
3265                 if (defined $realline_next &&
3266                     exists $lines[$realline_next - 1] &&
3267                     !defined $suppress_export{$realline_next} &&
3268                     ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3269                      $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3270                         # Handle definitions which produce identifiers with
3271                         # a prefix:
3272                         #   XXX(foo);
3273                         #   EXPORT_SYMBOL(something_foo);
3274                         my $name = $1;
3275                         if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
3276                             $name =~ /^${Ident}_$2/) {
3277 #print "FOO C name<$name>\n";
3278                                 $suppress_export{$realline_next} = 1;
3279
3280                         } elsif ($stat !~ /(?:
3281                                 \n.}\s*$|
3282                                 ^.DEFINE_$Ident\(\Q$name\E\)|
3283                                 ^.DECLARE_$Ident\(\Q$name\E\)|
3284                                 ^.LIST_HEAD\(\Q$name\E\)|
3285                                 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3286                                 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
3287                             )/x) {
3288 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3289                                 $suppress_export{$realline_next} = 2;
3290                         } else {
3291                                 $suppress_export{$realline_next} = 1;
3292                         }
3293                 }
3294                 if (!defined $suppress_export{$linenr} &&
3295                     $prevline =~ /^.\s*$/ &&
3296                     ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3297                      $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3298 #print "FOO B <$lines[$linenr - 1]>\n";
3299                         $suppress_export{$linenr} = 2;
3300                 }
3301                 if (defined $suppress_export{$linenr} &&
3302                     $suppress_export{$linenr} == 2) {
3303                         WARN("EXPORT_SYMBOL",
3304                              "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
3305                 }
3306
3307 # check for global initialisers.
3308                 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*(?:0|NULL|false)\s*;/) {
3309                         if (ERROR("GLOBAL_INITIALISERS",
3310                                   "do not initialise globals to 0 or NULL\n" .
3311                                       $herecurr) &&
3312                             $fix) {
3313                                 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*(0|NULL|false)\s*;/$1;/;
3314                         }
3315                 }
3316 # check for static initialisers.
3317                 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
3318                         if (ERROR("INITIALISED_STATIC",
3319                                   "do not initialise statics to 0 or NULL\n" .
3320                                       $herecurr) &&
3321                             $fix) {
3322                                 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
3323                         }
3324                 }
3325
3326 # check for misordered declarations of char/short/int/long with signed/unsigned
3327                 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3328                         my $tmp = trim($1);
3329                         WARN("MISORDERED_TYPE",
3330                              "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3331                 }
3332
3333 # check for static const char * arrays.
3334                 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
3335                         WARN("STATIC_CONST_CHAR_ARRAY",
3336                              "static const char * array should probably be static const char * const\n" .
3337                                 $herecurr);
3338                }
3339
3340 # check for static char foo[] = "bar" declarations.
3341                 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
3342                         WARN("STATIC_CONST_CHAR_ARRAY",
3343                              "static char array declaration should probably be static const char\n" .
3344                                 $herecurr);
3345                }
3346
3347 # check for const <foo> const where <foo> is not a pointer or array type
3348                 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3349                         my $found = $1;
3350                         if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3351                                 WARN("CONST_CONST",
3352                                      "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3353                         } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3354                                 WARN("CONST_CONST",
3355                                      "'const $found const' should probably be 'const $found'\n" . $herecurr);
3356                         }
3357                 }
3358
3359 # check for non-global char *foo[] = {"bar", ...} declarations.
3360                 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3361                         WARN("STATIC_CONST_CHAR_ARRAY",
3362                              "char * array declaration might be better as static const\n" .
3363                                 $herecurr);
3364                }
3365
3366 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3367                 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3368                         my $array = $1;
3369                         if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3370                                 my $array_div = $1;
3371                                 if (WARN("ARRAY_SIZE",
3372                                          "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3373                                     $fix) {
3374                                         $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3375                                 }
3376                         }
3377                 }
3378
3379 # check for function declarations without arguments like "int foo()"
3380                 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3381                         if (ERROR("FUNCTION_WITHOUT_ARGS",
3382                                   "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3383                             $fix) {
3384                                 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
3385                         }
3386                 }
3387
3388 # check for uses of DEFINE_PCI_DEVICE_TABLE
3389                 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
3390                         if (WARN("DEFINE_PCI_DEVICE_TABLE",
3391                                  "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
3392                             $fix) {
3393                                 $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
3394                         }
3395                 }
3396
3397 # check for new typedefs, only function parameters and sparse annotations
3398 # make sense.
3399                 if ($line =~ /\btypedef\s/ &&
3400                     $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
3401                     $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
3402                     $line !~ /\b$typeTypedefs\b/ &&
3403                     $line !~ /\b__bitwise(?:__|)\b/) {
3404                         WARN("NEW_TYPEDEFS",
3405                              "do not add new typedefs\n" . $herecurr);
3406                 }
3407
3408 # * goes on variable not on type
3409                 # (char*[ const])
3410                 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3411                         #print "AA<$1>\n";
3412                         my ($ident, $from, $to) = ($1, $2, $2);
3413
3414                         # Should start with a space.
3415                         $to =~ s/^(\S)/ $1/;
3416                         # Should not end with a space.
3417                         $to =~ s/\s+$//;
3418                         # '*'s should not have spaces between.
3419                         while ($to =~ s/\*\s+\*/\*\*/) {
3420                         }
3421
3422 ##                      print "1: from<$from> to<$to> ident<$ident>\n";
3423                         if ($from ne $to) {
3424                                 if (ERROR("POINTER_LOCATION",
3425                                           "\"(foo$from)\" should be \"(foo$to)\"\n" .  $herecurr) &&
3426                                     $fix) {
3427                                         my $sub_from = $ident;
3428                                         my $sub_to = $ident;
3429                                         $sub_to =~ s/\Q$from\E/$to/;
3430                                         $fixed[$fixlinenr] =~
3431                                             s@\Q$sub_from\E@$sub_to@;
3432                                 }
3433                         }
3434                 }
3435                 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3436                         #print "BB<$1>\n";
3437                         my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
3438
3439                         # Should start with a space.
3440                         $to =~ s/^(\S)/ $1/;
3441                         # Should not end with a space.
3442                         $to =~ s/\s+$//;
3443                         # '*'s should not have spaces between.
3444                         while ($to =~ s/\*\s+\*/\*\*/) {
3445                         }
3446                         # Modifiers should have spaces.
3447                         $to =~ s/(\b$Modifier$)/$1 /;
3448
3449 ##                      print "2: from<$from> to<$to> ident<$ident>\n";
3450                         if ($from ne $to && $ident !~ /^$Modifier$/) {
3451                                 if (ERROR("POINTER_LOCATION",
3452                                           "\"foo${from}bar\" should be \"foo${to}bar\"\n" .  $herecurr) &&
3453                                     $fix) {
3454
3455                                         my $sub_from = $match;
3456                                         my $sub_to = $match;
3457                                         $sub_to =~ s/\Q$from\E/$to/;
3458                                         $fixed[$fixlinenr] =~
3459                                             s@\Q$sub_from\E@$sub_to@;
3460                                 }
3461                         }
3462                 }
3463
3464 # avoid BUG() or BUG_ON()
3465                 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
3466                         my $msg_type = \&WARN;
3467                         $msg_type = \&CHK if ($file);
3468                         &{$msg_type}("AVOID_BUG",
3469                                      "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3470                 }
3471
3472 # avoid LINUX_VERSION_CODE
3473                 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
3474                         WARN("LINUX_VERSION_CODE",
3475                              "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3476                 }
3477
3478 # check for uses of printk_ratelimit
3479                 if ($line =~ /\bprintk_ratelimit\s*\(/) {
3480                         WARN("PRINTK_RATELIMITED",
3481                              "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
3482                 }
3483
3484 # printk should use KERN_* levels.  Note that follow on printk's on the
3485 # same line do not need a level, so we use the current block context
3486 # to try and find and validate the current printk.  In summary the current
3487 # printk includes all preceding printk's which have no newline on the end.
3488 # we assume the first bad printk is the one to report.
3489                 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
3490                         my $ok = 0;
3491                         for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3492                                 #print "CHECK<$lines[$ln - 1]\n";
3493                                 # we have a preceding printk if it ends
3494                                 # with "\n" ignore it, else it is to blame
3495                                 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3496                                         if ($rawlines[$ln - 1] !~ m{\\n"}) {
3497                                                 $ok = 1;
3498                                         }
3499                                         last;
3500                                 }
3501                         }
3502                         if ($ok == 0) {
3503                                 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3504                                      "printk() should include KERN_ facility level\n" . $herecurr);
3505                         }
3506                 }
3507
3508                 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3509                         my $orig = $1;
3510                         my $level = lc($orig);
3511                         $level = "warn" if ($level eq "warning");
3512                         my $level2 = $level;
3513                         $level2 = "dbg" if ($level eq "debug");
3514                         WARN("PREFER_PR_LEVEL",
3515                              "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(...  to printk(KERN_$orig ...\n" . $herecurr);
3516                 }
3517
3518                 if ($line =~ /\bpr_warning\s*\(/) {
3519                         if (WARN("PREFER_PR_LEVEL",
3520                                  "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3521                             $fix) {
3522                                 $fixed[$fixlinenr] =~
3523                                     s/\bpr_warning\b/pr_warn/;
3524                         }
3525                 }
3526
3527                 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3528                         my $orig = $1;
3529                         my $level = lc($orig);
3530                         $level = "warn" if ($level eq "warning");
3531                         $level = "dbg" if ($level eq "debug");
3532                         WARN("PREFER_DEV_LEVEL",
3533                              "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3534                 }
3535
3536 # ENOSYS means "bad syscall nr" and nothing else.  This will have a small
3537 # number of false positives, but assembly files are not checked, so at
3538 # least the arch entry code will not trigger this warning.
3539                 if ($line =~ /\bENOSYS\b/) {
3540                         WARN("ENOSYS",
3541                              "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3542                 }
3543
3544 # function brace can't be on same line, except for #defines of do while,
3545 # or if closed on same line
3546                 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
3547                     !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
3548                         if (ERROR("OPEN_BRACE",
3549                                   "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3550                             $fix) {
3551                                 fix_delete_line($fixlinenr, $rawline);
3552                                 my $fixed_line = $rawline;
3553                                 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3554                                 my $line1 = $1;
3555                                 my $line2 = $2;
3556                                 fix_insert_line($fixlinenr, ltrim($line1));
3557                                 fix_insert_line($fixlinenr, "\+{");
3558                                 if ($line2 !~ /^\s*$/) {
3559                                         fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3560                                 }
3561                         }
3562                 }
3563
3564 # open braces for enum, union and struct go on the same line.
3565                 if ($line =~ /^.\s*{/ &&
3566                     $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
3567                         if (ERROR("OPEN_BRACE",
3568                                   "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3569                             $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3570                                 fix_delete_line($fixlinenr - 1, $prevrawline);
3571                                 fix_delete_line($fixlinenr, $rawline);
3572                                 my $fixedline = rtrim($prevrawline) . " {";
3573                                 fix_insert_line($fixlinenr, $fixedline);
3574                                 $fixedline = $rawline;
3575                                 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3576                                 if ($fixedline !~ /^\+\s*$/) {
3577                                         fix_insert_line($fixlinenr, $fixedline);
3578                                 }
3579                         }
3580                 }
3581
3582 # missing space after union, struct or enum definition
3583                 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3584                         if (WARN("SPACING",
3585                                  "missing space after $1 definition\n" . $herecurr) &&
3586                             $fix) {
3587                                 $fixed[$fixlinenr] =~
3588                                     s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3589                         }
3590                 }
3591
3592 # Function pointer declarations
3593 # check spacing between type, funcptr, and args
3594 # canonical declaration is "type (*funcptr)(args...)"
3595                 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
3596                         my $declare = $1;
3597                         my $pre_pointer_space = $2;
3598                         my $post_pointer_space = $3;
3599                         my $funcname = $4;
3600                         my $post_funcname_space = $5;
3601                         my $pre_args_space = $6;
3602
3603 # the $Declare variable will capture all spaces after the type
3604 # so check it for a missing trailing missing space but pointer return types
3605 # don't need a space so don't warn for those.
3606                         my $post_declare_space = "";
3607                         if ($declare =~ /(\s+)$/) {
3608                                 $post_declare_space = $1;
3609                                 $declare = rtrim($declare);
3610                         }
3611                         if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
3612                                 WARN("SPACING",
3613                                      "missing space after return type\n" . $herecurr);
3614                                 $post_declare_space = " ";
3615                         }
3616
3617 # unnecessary space "type  (*funcptr)(args...)"
3618 # This test is not currently implemented because these declarations are
3619 # equivalent to
3620 #       int  foo(int bar, ...)
3621 # and this is form shouldn't/doesn't generate a checkpatch warning.
3622 #
3623 #                       elsif ($declare =~ /\s{2,}$/) {
3624 #                               WARN("SPACING",
3625 #                                    "Multiple spaces after return type\n" . $herecurr);
3626 #                       }
3627
3628 # unnecessary space "type ( *funcptr)(args...)"
3629                         if (defined $pre_pointer_space &&
3630                             $pre_pointer_space =~ /^\s/) {
3631                                 WARN("SPACING",
3632                                      "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3633                         }
3634
3635 # unnecessary space "type (* funcptr)(args...)"
3636                         if (defined $post_pointer_space &&
3637                             $post_pointer_space =~ /^\s/) {
3638                                 WARN("SPACING",
3639                                      "Unnecessary space before function pointer name\n" . $herecurr);
3640                         }
3641
3642 # unnecessary space "type (*funcptr )(args...)"
3643                         if (defined $post_funcname_space &&
3644                             $post_funcname_space =~ /^\s/) {
3645                                 WARN("SPACING",
3646                                      "Unnecessary space after function pointer name\n" . $herecurr);
3647                         }
3648
3649 # unnecessary space "type (*funcptr) (args...)"
3650                         if (defined $pre_args_space &&
3651                             $pre_args_space =~ /^\s/) {
3652                                 WARN("SPACING",
3653                                      "Unnecessary space before function pointer arguments\n" . $herecurr);
3654                         }
3655
3656                         if (show_type("SPACING") && $fix) {
3657                                 $fixed[$fixlinenr] =~
3658                                     s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3659                         }
3660                 }
3661
3662 # check for spacing round square brackets; allowed:
3663 #  1. with a type on the left -- int [] a;
3664 #  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3665 #  3. inside a curly brace -- = { [0...10] = 5 }
3666                 while ($line =~ /(.*?\s)\[/g) {
3667                         my ($where, $prefix) = ($-[1], $1);
3668                         if ($prefix !~ /$Type\s+$/ &&
3669                             ($where != 0 || $prefix !~ /^.\s+$/) &&
3670                             $prefix !~ /[{,]\s+$/) {
3671                                 if (ERROR("BRACKET_SPACE",
3672                                           "space prohibited before open square bracket '['\n" . $herecurr) &&
3673                                     $fix) {
3674                                     $fixed[$fixlinenr] =~
3675                                         s/^(\+.*?)\s+\[/$1\[/;
3676                                 }
3677                         }
3678                 }
3679
3680 # check for spaces between functions and their parentheses.
3681                 while ($line =~ /($Ident)\s+\(/g) {
3682                         my $name = $1;
3683                         my $ctx_before = substr($line, 0, $-[1]);
3684                         my $ctx = "$ctx_before$name";
3685
3686                         # Ignore those directives where spaces _are_ permitted.
3687                         if ($name =~ /^(?:
3688                                 if|for|while|switch|return|case|
3689                                 volatile|__volatile__|
3690                                 __attribute__|format|__extension__|
3691                                 asm|__asm__)$/x)
3692                         {
3693                         # cpp #define statements have non-optional spaces, ie
3694                         # if there is a space between the name and the open
3695                         # parenthesis it is simply not a parameter group.
3696                         } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
3697
3698                         # cpp #elif statement condition may start with a (
3699                         } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
3700
3701                         # If this whole things ends with a type its most
3702                         # likely a typedef for a function.
3703                         } elsif ($ctx =~ /$Type$/) {
3704
3705                         } else {
3706                                 if (WARN("SPACING",
3707                                          "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3708                                              $fix) {
3709                                         $fixed[$fixlinenr] =~
3710                                             s/\b$name\s+\(/$name\(/;
3711                                 }
3712                         }
3713                 }
3714
3715 # Check operator spacing.
3716                 if (!($line=~/\#\s*include/)) {
3717                         my $fixed_line = "";
3718                         my $line_fixed = 0;
3719
3720                         my $ops = qr{
3721                                 <<=|>>=|<=|>=|==|!=|
3722                                 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3723                                 =>|->|<<|>>|<|>|=|!|~|
3724                                 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
3725                                 \?:|\?|:
3726                         }x;
3727                         my @elements = split(/($ops|;)/, $opline);
3728
3729 ##                      print("element count: <" . $#elements . ">\n");
3730 ##                      foreach my $el (@elements) {
3731 ##                              print("el: <$el>\n");
3732 ##                      }
3733
3734                         my @fix_elements = ();
3735                         my $off = 0;
3736
3737                         foreach my $el (@elements) {
3738                                 push(@fix_elements, substr($rawline, $off, length($el)));
3739                                 $off += length($el);
3740                         }
3741
3742                         $off = 0;
3743
3744                         my $blank = copy_spacing($opline);
3745                         my $last_after = -1;
3746
3747                         for (my $n = 0; $n < $#elements; $n += 2) {
3748
3749                                 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3750
3751 ##                              print("n: <$n> good: <$good>\n");
3752
3753                                 $off += length($elements[$n]);
3754
3755                                 # Pick up the preceding and succeeding characters.
3756                                 my $ca = substr($opline, 0, $off);
3757                                 my $cc = '';
3758                                 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3759                                         $cc = substr($opline, $off + length($elements[$n + 1]));
3760                                 }
3761                                 my $cb = "$ca$;$cc";
3762
3763                                 my $a = '';
3764                                 $a = 'V' if ($elements[$n] ne '');
3765                                 $a = 'W' if ($elements[$n] =~ /\s$/);
3766                                 $a = 'C' if ($elements[$n] =~ /$;$/);
3767                                 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3768                                 $a = 'O' if ($elements[$n] eq '');
3769                                 $a = 'E' if ($ca =~ /^\s*$/);
3770
3771                                 my $op = $elements[$n + 1];
3772
3773                                 my $c = '';
3774                                 if (defined $elements[$n + 2]) {
3775                                         $c = 'V' if ($elements[$n + 2] ne '');
3776                                         $c = 'W' if ($elements[$n + 2] =~ /^\s/);
3777                                         $c = 'C' if ($elements[$n + 2] =~ /^$;/);
3778                                         $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3779                                         $c = 'O' if ($elements[$n + 2] eq '');
3780                                         $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
3781                                 } else {
3782                                         $c = 'E';
3783                                 }
3784
3785                                 my $ctx = "${a}x${c}";
3786
3787                                 my $at = "(ctx:$ctx)";
3788
3789                                 my $ptr = substr($blank, 0, $off) . "^";
3790                                 my $hereptr = "$hereline$ptr\n";
3791
3792                                 # Pull out the value of this operator.
3793                                 my $op_type = substr($curr_values, $off + 1, 1);
3794
3795                                 # Get the full operator variant.
3796                                 my $opv = $op . substr($curr_vars, $off, 1);
3797
3798                                 # Ignore operators passed as parameters.
3799                                 if ($op_type ne 'V' &&
3800                                     $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
3801
3802 #                               # Ignore comments
3803 #                               } elsif ($op =~ /^$;+$/) {
3804
3805                                 # ; should have either the end of line or a space or \ after it
3806                                 } elsif ($op eq ';') {
3807                                         if ($ctx !~ /.x[WEBC]/ &&
3808                                             $cc !~ /^\\/ && $cc !~ /^;/) {
3809                                                 if (ERROR("SPACING",
3810                                                           "space required after that '$op' $at\n" . $hereptr)) {
3811                                                         $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3812                                                         $line_fixed = 1;
3813                                                 }
3814                                         }
3815
3816                                 # // is a comment
3817                                 } elsif ($op eq '//') {
3818
3819                                 #   :   when part of a bitfield
3820                                 } elsif ($opv eq ':B') {
3821                                         # skip the bitfield test for now
3822
3823                                 # No spaces for:
3824                                 #   ->
3825                                 } elsif ($op eq '->') {
3826                                         if ($ctx =~ /Wx.|.xW/) {
3827                                                 if (ERROR("SPACING",
3828                                                           "spaces prohibited around that '$op' $at\n" . $hereptr)) {
3829                                                         $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3830                                                         if (defined $fix_elements[$n + 2]) {
3831                                                                 $fix_elements[$n + 2] =~ s/^\s+//;
3832                                                         }
3833                                                         $line_fixed = 1;
3834                                                 }
3835                                         }
3836
3837                                 # , must not have a space before and must have a space on the right.
3838                                 } elsif ($op eq ',') {
3839                                         my $rtrim_before = 0;
3840                                         my $space_after = 0;
3841                                         if ($ctx =~ /Wx./) {
3842                                                 if (ERROR("SPACING",
3843                                                           "space prohibited before that '$op' $at\n" . $hereptr)) {
3844                                                         $line_fixed = 1;
3845                                                         $rtrim_before = 1;
3846                                                 }
3847                                         }
3848                                         if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
3849                                                 if (ERROR("SPACING",
3850                                                           "space required after that '$op' $at\n" . $hereptr)) {
3851                                                         $line_fixed = 1;
3852                                                         $last_after = $n;
3853                                                         $space_after = 1;
3854                                                 }
3855                                         }
3856                                         if ($rtrim_before || $space_after) {
3857                                                 if ($rtrim_before) {
3858                                                         $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3859                                                 } else {
3860                                                         $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3861                                                 }
3862                                                 if ($space_after) {
3863                                                         $good .= " ";
3864                                                 }
3865                                         }
3866
3867                                 # '*' as part of a type definition -- reported already.
3868                                 } elsif ($opv eq '*_') {
3869                                         #warn "'*' is part of type\n";
3870
3871                                 # unary operators should have a space before and
3872                                 # none after.  May be left adjacent to another
3873                                 # unary operator, or a cast
3874                                 } elsif ($op eq '!' || $op eq '~' ||
3875                                          $opv eq '*U' || $opv eq '-U' ||
3876                                          $opv eq '&U' || $opv eq '&&U') {
3877                                         if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
3878                                                 if (ERROR("SPACING",
3879                                                           "space required before that '$op' $at\n" . $hereptr)) {
3880                                                         if ($n != $last_after + 2) {
3881                                                                 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3882                                                                 $line_fixed = 1;
3883                                                         }
3884                                                 }
3885                                         }
3886                                         if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
3887                                                 # A unary '*' may be const
3888
3889                                         } elsif ($ctx =~ /.xW/) {
3890                                                 if (ERROR("SPACING",
3891                                                           "space prohibited after that '$op' $at\n" . $hereptr)) {
3892                                                         $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
3893                                                         if (defined $fix_elements[$n + 2]) {
3894                                                                 $fix_elements[$n + 2] =~ s/^\s+//;
3895                                                         }
3896                                                         $line_fixed = 1;
3897                                                 }
3898                                         }
3899
3900                                 # unary ++ and unary -- are allowed no space on one side.
3901                                 } elsif ($op eq '++' or $op eq '--') {
3902                                         if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
3903                                                 if (ERROR("SPACING",
3904                                                           "space required one side of that '$op' $at\n" . $hereptr)) {
3905                                                         $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3906                                                         $line_fixed = 1;
3907                                                 }
3908                                         }
3909                                         if ($ctx =~ /Wx[BE]/ ||
3910                                             ($ctx =~ /Wx./ && $cc =~ /^;/)) {
3911                                                 if (ERROR("SPACING",
3912                                                           "space prohibited before that '$op' $at\n" . $hereptr)) {
3913                                                         $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3914                                                         $line_fixed = 1;
3915                                                 }
3916                                         }
3917                                         if ($ctx =~ /ExW/) {
3918                                                 if (ERROR("SPACING",
3919                                                           "space prohibited after that '$op' $at\n" . $hereptr)) {
3920                                                         $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3921                                                         if (defined $fix_elements[$n + 2]) {
3922                                                                 $fix_elements[$n + 2] =~ s/^\s+//;
3923                                                         }
3924                                                         $line_fixed = 1;
3925                                                 }
3926                                         }
3927
3928                                 # << and >> may either have or not have spaces both sides
3929                                 } elsif ($op eq '<<' or $op eq '>>' or
3930                                          $op eq '&' or $op eq '^' or $op eq '|' or
3931                                          $op eq '+' or $op eq '-' or
3932                                          $op eq '*' or $op eq '/' or
3933                                          $op eq '%')
3934                                 {
3935                                         if ($check) {
3936                                                 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
3937                                                         if (CHK("SPACING",
3938                                                                 "spaces preferred around that '$op' $at\n" . $hereptr)) {
3939                                                                 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3940                                                                 $fix_elements[$n + 2] =~ s/^\s+//;
3941                                                                 $line_fixed = 1;
3942                                                         }
3943                                                 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
3944                                                         if (CHK("SPACING",
3945                                                                 "space preferred before that '$op' $at\n" . $hereptr)) {
3946                                                                 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
3947                                                                 $line_fixed = 1;
3948                                                         }
3949                                                 }
3950                                         } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
3951                                                 if (ERROR("SPACING",
3952                                                           "need consistent spacing around '$op' $at\n" . $hereptr)) {
3953                                                         $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3954                                                         if (defined $fix_elements[$n + 2]) {
3955                                                                 $fix_elements[$n + 2] =~ s/^\s+//;
3956                                                         }
3957                                                         $line_fixed = 1;
3958                                                 }
3959                                         }
3960
3961                                 # A colon needs no spaces before when it is
3962                                 # terminating a case value or a label.
3963                                 } elsif ($opv eq ':C' || $opv eq ':L') {
3964                                         if ($ctx =~ /Wx./) {
3965                                                 if (ERROR("SPACING",
3966                                                           "space prohibited before that '$op' $at\n" . $hereptr)) {
3967                                                         $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3968                                                         $line_fixed = 1;
3969                                                 }
3970                                         }
3971
3972                                 # All the others need spaces both sides.
3973                                 } elsif ($ctx !~ /[EWC]x[CWE]/) {
3974                                         my $ok = 0;
3975
3976                                         # Ignore email addresses <foo@bar>
3977                                         if (($op eq '<' &&
3978                                              $cc =~ /^\S+\@\S+>/) ||
3979                                             ($op eq '>' &&
3980                                              $ca =~ /<\S+\@\S+$/))
3981                                         {
3982                                                 $ok = 1;
3983                                         }
3984
3985                                         # for asm volatile statements
3986                                         # ignore a colon with another
3987                                         # colon immediately before or after
3988                                         if (($op eq ':') &&
3989                                             ($ca =~ /:$/ || $cc =~ /^:/)) {
3990                                                 $ok = 1;
3991                                         }
3992
3993                                         # messages are ERROR, but ?: are CHK
3994                                         if ($ok == 0) {
3995                                                 my $msg_type = \&ERROR;
3996                                                 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
3997
3998                                                 if (&{$msg_type}("SPACING",
3999                                                                  "spaces required around that '$op' $at\n" . $hereptr)) {
4000                                                         $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4001                                                         if (defined $fix_elements[$n + 2]) {
4002                                                                 $fix_elements[$n + 2] =~ s/^\s+//;
4003                                                         }
4004                                                         $line_fixed = 1;
4005                                                 }
4006                                         }
4007                                 }
4008                                 $off += length($elements[$n + 1]);
4009
4010 ##                              print("n: <$n> GOOD: <$good>\n");
4011
4012                                 $fixed_line = $fixed_line . $good;
4013                         }
4014
4015                         if (($#elements % 2) == 0) {
4016                                 $fixed_line = $fixed_line . $fix_elements[$#elements];
4017                         }
4018
4019                         if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4020                                 $fixed[$fixlinenr] = $fixed_line;
4021                         }
4022
4023
4024                 }
4025
4026 # check for whitespace before a non-naked semicolon
4027                 if ($line =~ /^\+.*\S\s+;\s*$/) {
4028                         if (WARN("SPACING",
4029                                  "space prohibited before semicolon\n" . $herecurr) &&
4030                             $fix) {
4031                                 1 while $fixed[$fixlinenr] =~
4032                                     s/^(\+.*\S)\s+;/$1;/;
4033                         }
4034                 }
4035
4036 # check for multiple assignments
4037                 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
4038                         CHK("MULTIPLE_ASSIGNMENTS",
4039                             "multiple assignments should be avoided\n" . $herecurr);
4040                 }
4041
4042 ## # check for multiple declarations, allowing for a function declaration
4043 ## # continuation.
4044 ##              if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4045 ##                  $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4046 ##
4047 ##                      # Remove any bracketed sections to ensure we do not
4048 ##                      # falsly report the parameters of functions.
4049 ##                      my $ln = $line;
4050 ##                      while ($ln =~ s/\([^\(\)]*\)//g) {
4051 ##                      }
4052 ##                      if ($ln =~ /,/) {
4053 ##                              WARN("MULTIPLE_DECLARATION",
4054 ##                                   "declaring multiple variables together should be avoided\n" . $herecurr);
4055 ##                      }
4056 ##              }
4057
4058 #need space before brace following if, while, etc
4059                 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
4060                     $line =~ /do{/) {
4061                         if (ERROR("SPACING",
4062                                   "space required before the open brace '{'\n" . $herecurr) &&
4063                             $fix) {
4064                                 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
4065                         }
4066                 }
4067
4068 ## # check for blank lines before declarations
4069 ##              if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4070 ##                  $prevrawline =~ /^.\s*$/) {
4071 ##                      WARN("SPACING",
4072 ##                           "No blank lines before declarations\n" . $hereprev);
4073 ##              }
4074 ##
4075
4076 # closing brace should have a space following it when it has anything
4077 # on the line
4078                 if ($line =~ /}(?!(?:,|;|\)))\S/) {
4079                         if (ERROR("SPACING",
4080                                   "space required after that close brace '}'\n" . $herecurr) &&
4081                             $fix) {
4082                                 $fixed[$fixlinenr] =~
4083                                     s/}((?!(?:,|;|\)))\S)/} $1/;
4084                         }
4085                 }
4086
4087 # check spacing on square brackets
4088                 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
4089                         if (ERROR("SPACING",
4090                                   "space prohibited after that open square bracket '['\n" . $herecurr) &&
4091                             $fix) {
4092                                 $fixed[$fixlinenr] =~
4093                                     s/\[\s+/\[/;
4094                         }
4095                 }
4096                 if ($line =~ /\s\]/) {
4097                         if (ERROR("SPACING",
4098                                   "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4099                             $fix) {
4100                                 $fixed[$fixlinenr] =~
4101                                     s/\s+\]/\]/;
4102                         }
4103                 }
4104
4105 # check spacing on parentheses
4106                 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4107                     $line !~ /for\s*\(\s+;/) {
4108                         if (ERROR("SPACING",
4109                                   "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4110                             $fix) {
4111                                 $fixed[$fixlinenr] =~
4112                                     s/\(\s+/\(/;
4113                         }
4114                 }
4115                 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
4116                     $line !~ /for\s*\(.*;\s+\)/ &&
4117                     $line !~ /:\s+\)/) {
4118                         if (ERROR("SPACING",
4119                                   "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4120                             $fix) {
4121                                 $fixed[$fixlinenr] =~
4122                                     s/\s+\)/\)/;
4123                         }
4124                 }
4125
4126 # check unnecessary parentheses around addressof/dereference single $Lvals
4127 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4128
4129                 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
4130                         my $var = $1;
4131                         if (CHK("UNNECESSARY_PARENTHESES",
4132                                 "Unnecessary parentheses around $var\n" . $herecurr) &&
4133                             $fix) {
4134                                 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4135                         }
4136                 }
4137
4138 # check for unnecessary parentheses around function pointer uses
4139 # ie: (foo->bar)(); should be foo->bar();
4140 # but not "if (foo->bar) (" to avoid some false positives
4141                 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4142                         my $var = $2;
4143                         if (CHK("UNNECESSARY_PARENTHESES",
4144                                 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4145                             $fix) {
4146                                 my $var2 = deparenthesize($var);
4147                                 $var2 =~ s/\s//g;
4148                                 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4149                         }
4150                 }
4151
4152 #goto labels aren't indented, allow a single space however
4153                 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
4154                    !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
4155                         if (WARN("INDENTED_LABEL",
4156                                  "labels should not be indented\n" . $herecurr) &&
4157                             $fix) {
4158                                 $fixed[$fixlinenr] =~
4159                                     s/^(.)\s+/$1/;
4160                         }
4161                 }
4162
4163 # return is not a function
4164                 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
4165                         my $spacing = $1;
4166                         if ($^V && $^V ge 5.10.0 &&
4167                             $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4168                                 my $value = $1;
4169                                 $value = deparenthesize($value);
4170                                 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4171                                         ERROR("RETURN_PARENTHESES",
4172                                               "return is not a function, parentheses are not required\n" . $herecurr);
4173                                 }
4174                         } elsif ($spacing !~ /\s+/) {
4175                                 ERROR("SPACING",
4176                                       "space required before the open parenthesis '('\n" . $herecurr);
4177                         }
4178                 }
4179
4180 # unnecessary return in a void function
4181 # at end-of-function, with the previous line a single leading tab, then return;
4182 # and the line before that not a goto label target like "out:"
4183                 if ($sline =~ /^[ \+]}\s*$/ &&
4184                     $prevline =~ /^\+\treturn\s*;\s*$/ &&
4185                     $linenr >= 3 &&
4186                     $lines[$linenr - 3] =~ /^[ +]/ &&
4187                     $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
4188                         WARN("RETURN_VOID",
4189                              "void function return statements are not generally useful\n" . $hereprev);
4190                }
4191
4192 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4193                 if ($^V && $^V ge 5.10.0 &&
4194                     $line =~ /\bif\s*((?:\(\s*){2,})/) {
4195                         my $openparens = $1;
4196                         my $count = $openparens =~ tr@\(@\(@;
4197                         my $msg = "";
4198                         if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4199                                 my $comp = $4;  #Not $1 because of $LvalOrFunc
4200                                 $msg = " - maybe == should be = ?" if ($comp eq "==");
4201                                 WARN("UNNECESSARY_PARENTHESES",
4202                                      "Unnecessary parentheses$msg\n" . $herecurr);
4203                         }
4204                 }
4205
4206 # Return of what appears to be an errno should normally be negative
4207                 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
4208                         my $name = $1;
4209                         if ($name ne 'EOF' && $name ne 'ERROR') {
4210                                 WARN("USE_NEGATIVE_ERRNO",
4211                                      "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
4212                         }
4213                 }
4214
4215 # Need a space before open parenthesis after if, while etc
4216                 if ($line =~ /\b(if|while|for|switch)\(/) {
4217                         if (ERROR("SPACING",
4218                                   "space required before the open parenthesis '('\n" . $herecurr) &&
4219                             $fix) {
4220                                 $fixed[$fixlinenr] =~
4221                                     s/\b(if|while|for|switch)\(/$1 \(/;
4222                         }
4223                 }
4224
4225 # Check for illegal assignment in if conditional -- and check for trailing
4226 # statements after the conditional.
4227                 if ($line =~ /do\s*(?!{)/) {
4228                         ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4229                                 ctx_statement_block($linenr, $realcnt, 0)
4230                                         if (!defined $stat);
4231                         my ($stat_next) = ctx_statement_block($line_nr_next,
4232                                                 $remain_next, $off_next);
4233                         $stat_next =~ s/\n./\n /g;
4234                         ##print "stat<$stat> stat_next<$stat_next>\n";
4235
4236                         if ($stat_next =~ /^\s*while\b/) {
4237                                 # If the statement carries leading newlines,
4238                                 # then count those as offsets.
4239                                 my ($whitespace) =
4240                                         ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4241                                 my $offset =
4242                                         statement_rawlines($whitespace) - 1;
4243
4244                                 $suppress_whiletrailers{$line_nr_next +
4245                                                                 $offset} = 1;
4246                         }
4247                 }
4248                 if (!defined $suppress_whiletrailers{$linenr} &&
4249                     defined($stat) && defined($cond) &&
4250                     $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
4251                         my ($s, $c) = ($stat, $cond);
4252
4253                         if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
4254                                 ERROR("ASSIGN_IN_IF",
4255                                       "do not use assignment in if condition\n" . $herecurr);
4256                         }
4257
4258                         # Find out what is on the end of the line after the
4259                         # conditional.
4260                         substr($s, 0, length($c), '');
4261                         $s =~ s/\n.*//g;
4262                         $s =~ s/$;//g;  # Remove any comments
4263                         if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4264                             $c !~ /}\s*while\s*/)
4265                         {
4266                                 # Find out how long the conditional actually is.
4267                                 my @newlines = ($c =~ /\n/gs);
4268                                 my $cond_lines = 1 + $#newlines;
4269                                 my $stat_real = '';
4270
4271                                 $stat_real = raw_line($linenr, $cond_lines)
4272                                                         . "\n" if ($cond_lines);
4273                                 if (defined($stat_real) && $cond_lines > 1) {
4274                                         $stat_real = "[...]\n$stat_real";
4275                                 }
4276
4277                                 ERROR("TRAILING_STATEMENTS",
4278                                       "trailing statements should be on next line\n" . $herecurr . $stat_real);
4279                         }
4280                 }
4281
4282 # Check for bitwise tests written as boolean
4283                 if ($line =~ /
4284                         (?:
4285                                 (?:\[|\(|\&\&|\|\|)
4286                                 \s*0[xX][0-9]+\s*
4287                                 (?:\&\&|\|\|)
4288                         |
4289                                 (?:\&\&|\|\|)
4290                                 \s*0[xX][0-9]+\s*
4291                                 (?:\&\&|\|\||\)|\])
4292                         )/x)
4293                 {
4294                         WARN("HEXADECIMAL_BOOLEAN_TEST",
4295                              "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
4296                 }
4297
4298 # if and else should not have general statements after it
4299                 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4300                         my $s = $1;
4301                         $s =~ s/$;//g;  # Remove any comments
4302                         if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
4303                                 ERROR("TRAILING_STATEMENTS",
4304                                       "trailing statements should be on next line\n" . $herecurr);
4305                         }
4306                 }
4307 # if should not continue a brace
4308                 if ($line =~ /}\s*if\b/) {
4309                         ERROR("TRAILING_STATEMENTS",
4310                               "trailing statements should be on next line (or did you mean 'else if'?)\n" .
4311                                 $herecurr);
4312                 }
4313 # case and default should not have general statements after them
4314                 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4315                     $line !~ /\G(?:
4316                         (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
4317                         \s*return\s+
4318                     )/xg)
4319                 {
4320                         ERROR("TRAILING_STATEMENTS",
4321                               "trailing statements should be on next line\n" . $herecurr);
4322                 }
4323
4324                 # Check for }<nl>else {, these must be at the same
4325                 # indent level to be relevant to each other.
4326                 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4327                     $previndent == $indent) {
4328                         if (ERROR("ELSE_AFTER_BRACE",
4329                                   "else should follow close brace '}'\n" . $hereprev) &&
4330                             $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4331                                 fix_delete_line($fixlinenr - 1, $prevrawline);
4332                                 fix_delete_line($fixlinenr, $rawline);
4333                                 my $fixedline = $prevrawline;
4334                                 $fixedline =~ s/}\s*$//;
4335                                 if ($fixedline !~ /^\+\s*$/) {
4336                                         fix_insert_line($fixlinenr, $fixedline);
4337                                 }
4338                                 $fixedline = $rawline;
4339                                 $fixedline =~ s/^(.\s*)else/$1} else/;
4340                                 fix_insert_line($fixlinenr, $fixedline);
4341                         }
4342                 }
4343
4344                 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4345                     $previndent == $indent) {
4346                         my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4347
4348                         # Find out what is on the end of the line after the
4349                         # conditional.
4350                         substr($s, 0, length($c), '');
4351                         $s =~ s/\n.*//g;
4352
4353                         if ($s =~ /^\s*;/) {
4354                                 if (ERROR("WHILE_AFTER_BRACE",
4355                                           "while should follow close brace '}'\n" . $hereprev) &&
4356                                     $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4357                                         fix_delete_line($fixlinenr - 1, $prevrawline);
4358                                         fix_delete_line($fixlinenr, $rawline);
4359                                         my $fixedline = $prevrawline;
4360                                         my $trailing = $rawline;
4361                                         $trailing =~ s/^\+//;
4362                                         $trailing = trim($trailing);
4363                                         $fixedline =~ s/}\s*$/} $trailing/;
4364                                         fix_insert_line($fixlinenr, $fixedline);
4365                                 }
4366                         }
4367                 }
4368
4369 #Specific variable tests
4370                 while ($line =~ m{($Constant|$Lval)}g) {
4371                         my $var = $1;
4372
4373 #gcc binary extension
4374                         if ($var =~ /^$Binary$/) {
4375                                 if (WARN("GCC_BINARY_CONSTANT",
4376                                          "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4377                                     $fix) {
4378                                         my $hexval = sprintf("0x%x", oct($var));
4379                                         $fixed[$fixlinenr] =~
4380                                             s/\b$var\b/$hexval/;
4381                                 }
4382                         }
4383
4384 #CamelCase
4385                         if ($var !~ /^$Constant$/ &&
4386                             $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
4387 #Ignore Page<foo> variants
4388                             $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
4389 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4390                             $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4391 #Ignore some three character SI units explicitly, like MiB and KHz
4392                             $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
4393                                 while ($var =~ m{($Ident)}g) {
4394                                         my $word = $1;
4395                                         next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
4396                                         if ($check) {
4397                                                 seed_camelcase_includes();
4398                                                 if (!$file && !$camelcase_file_seeded) {
4399                                                         seed_camelcase_file($realfile);
4400                                                         $camelcase_file_seeded = 1;
4401                                                 }
4402                                         }
4403                                         if (!defined $camelcase{$word}) {
4404                                                 $camelcase{$word} = 1;
4405                                                 CHK("CAMELCASE",
4406                                                     "Avoid CamelCase: <$word>\n" . $herecurr);
4407                                         }
4408                                 }
4409                         }
4410                 }
4411
4412 #no spaces allowed after \ in define
4413                 if ($line =~ /\#\s*define.*\\\s+$/) {
4414                         if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4415                                  "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4416                             $fix) {
4417                                 $fixed[$fixlinenr] =~ s/\s+$//;
4418                         }
4419                 }
4420
4421 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4422 # itself <asm/foo.h> (uses RAW line)
4423                 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
4424                         my $file = "$1.h";
4425                         my $checkfile = "include/linux/$file";
4426                         if (-f "$root/$checkfile" &&
4427                             $realfile ne $checkfile &&
4428                             $1 !~ /$allowed_asm_includes/)
4429                         {
4430                                 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4431                                 if ($asminclude > 0) {
4432                                         if ($realfile =~ m{^arch/}) {
4433                                                 CHK("ARCH_INCLUDE_LINUX",
4434                                                     "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4435                                         } else {
4436                                                 WARN("INCLUDE_LINUX",
4437                                                      "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4438                                         }
4439                                 }
4440                         }
4441                 }
4442
4443 # multi-statement macros should be enclosed in a do while loop, grab the
4444 # first statement and ensure its the whole macro if its not enclosed
4445 # in a known good container
4446                 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4447                     $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
4448                         my $ln = $linenr;
4449                         my $cnt = $realcnt;
4450                         my ($off, $dstat, $dcond, $rest);
4451                         my $ctx = '';
4452                         my $has_flow_statement = 0;
4453                         my $has_arg_concat = 0;
4454                         ($dstat, $dcond, $ln, $cnt, $off) =
4455                                 ctx_statement_block($linenr, $realcnt, 0);
4456                         $ctx = $dstat;
4457                         #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4458                         #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4459
4460                         $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
4461                         $has_arg_concat = 1 if ($ctx =~ /\#\#/);
4462
4463                         $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
4464                         $dstat =~ s/$;//g;
4465                         $dstat =~ s/\\\n.//g;
4466                         $dstat =~ s/^\s*//s;
4467                         $dstat =~ s/\s*$//s;
4468
4469                         # Flatten any parentheses and braces
4470                         while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4471                                $dstat =~ s/\{[^\{\}]*\}/1/ ||
4472                                $dstat =~ s/\[[^\[\]]*\]/1/)
4473                         {
4474                         }
4475
4476                         # Flatten any obvious string concatentation.
4477                         while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4478                                $dstat =~ s/$Ident\s*($String)/$1/)
4479                         {
4480                         }
4481
4482                         my $exceptions = qr{
4483                                 $Declare|
4484                                 module_param_named|
4485                                 MODULE_PARM_DESC|
4486                                 DECLARE_PER_CPU|
4487                                 DEFINE_PER_CPU|
4488                                 __typeof__\(|
4489                                 union|
4490                                 struct|
4491                                 \.$Ident\s*=\s*|
4492                                 ^\"|\"$
4493                         }x;
4494                         #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4495                         if ($dstat ne '' &&
4496                             $dstat !~ /^(?:$Ident|-?$Constant),$/ &&                    # 10, // foo(),
4497                             $dstat !~ /^(?:$Ident|-?$Constant);$/ &&                    # foo();
4498                             $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ &&          # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4499                             $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ &&                  # character constants
4500                             $dstat !~ /$exceptions/ &&
4501                             $dstat !~ /^\.$Ident\s*=/ &&                                # .foo =
4502                             $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ &&          # stringification #foo
4503                             $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ &&       # do {...} while (...); // do {...} while (...)
4504                             $dstat !~ /^for\s*$Constant$/ &&                            # for (...)
4505                             $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ &&   # for (...) bar()
4506                             $dstat !~ /^do\s*{/ &&                                      # do {...
4507                             $dstat !~ /^\({/ &&                                         # ({...
4508                             $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
4509                         {
4510                                 $ctx =~ s/\n*$//;
4511                                 my $herectx = $here . "\n";
4512                                 my $cnt = statement_rawlines($ctx);
4513
4514                                 for (my $n = 0; $n < $cnt; $n++) {
4515                                         $herectx .= raw_line($linenr, $n) . "\n";
4516                                 }
4517
4518                                 if ($dstat =~ /;/) {
4519                                         ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4520                                               "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4521                                 } else {
4522                                         ERROR("COMPLEX_MACRO",
4523                                               "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
4524                                 }
4525                         }
4526
4527 # check for macros with flow control, but without ## concatenation
4528 # ## concatenation is commonly a macro that defines a function so ignore those
4529                         if ($has_flow_statement && !$has_arg_concat) {
4530                                 my $herectx = $here . "\n";
4531                                 my $cnt = statement_rawlines($ctx);
4532
4533                                 for (my $n = 0; $n < $cnt; $n++) {
4534                                         $herectx .= raw_line($linenr, $n) . "\n";
4535                                 }
4536                                 WARN("MACRO_WITH_FLOW_CONTROL",
4537                                      "Macros with flow control statements should be avoided\n" . "$herectx");
4538                         }
4539
4540 # check for line continuations outside of #defines, preprocessor #, and asm
4541
4542                 } else {
4543                         if ($prevline !~ /^..*\\$/ &&
4544                             $line !~ /^\+\s*\#.*\\$/ &&         # preprocessor
4545                             $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ &&   # asm
4546                             $line =~ /^\+.*\\$/) {
4547                                 WARN("LINE_CONTINUATIONS",
4548                                      "Avoid unnecessary line continuations\n" . $herecurr);
4549                         }
4550                 }
4551
4552 # do {} while (0) macro tests:
4553 # single-statement macros do not need to be enclosed in do while (0) loop,
4554 # macro should not end with a semicolon
4555                 if ($^V && $^V ge 5.10.0 &&
4556                     $realfile !~ m@/vmlinux.lds.h$@ &&
4557                     $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4558                         my $ln = $linenr;
4559                         my $cnt = $realcnt;
4560                         my ($off, $dstat, $dcond, $rest);
4561                         my $ctx = '';
4562                         ($dstat, $dcond, $ln, $cnt, $off) =
4563                                 ctx_statement_block($linenr, $realcnt, 0);
4564                         $ctx = $dstat;
4565
4566                         $dstat =~ s/\\\n.//g;
4567                         $dstat =~ s/$;/ /g;
4568
4569                         if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4570                                 my $stmts = $2;
4571                                 my $semis = $3;
4572
4573                                 $ctx =~ s/\n*$//;
4574                                 my $cnt = statement_rawlines($ctx);
4575                                 my $herectx = $here . "\n";
4576
4577                                 for (my $n = 0; $n < $cnt; $n++) {
4578                                         $herectx .= raw_line($linenr, $n) . "\n";
4579                                 }
4580
4581                                 if (($stmts =~ tr/;/;/) == 1 &&
4582                                     $stmts !~ /^\s*(if|while|for|switch)\b/) {
4583                                         WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4584                                              "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4585                                 }
4586                                 if (defined $semis && $semis ne "") {
4587                                         WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4588                                              "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4589                                 }
4590                         } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4591                                 $ctx =~ s/\n*$//;
4592                                 my $cnt = statement_rawlines($ctx);
4593                                 my $herectx = $here . "\n";
4594
4595                                 for (my $n = 0; $n < $cnt; $n++) {
4596                                         $herectx .= raw_line($linenr, $n) . "\n";
4597                                 }
4598
4599                                 WARN("TRAILING_SEMICOLON",
4600                                      "macros should not use a trailing semicolon\n" . "$herectx");
4601                         }
4602                 }
4603
4604 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4605 # all assignments may have only one of the following with an assignment:
4606 #       .
4607 #       ALIGN(...)
4608 #       VMLINUX_SYMBOL(...)
4609                 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
4610                         WARN("MISSING_VMLINUX_SYMBOL",
4611                              "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
4612                 }
4613
4614 # check for redundant bracing round if etc
4615                 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4616                         my ($level, $endln, @chunks) =
4617                                 ctx_statement_full($linenr, $realcnt, 1);
4618                         #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
4619                         #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4620                         if ($#chunks > 0 && $level == 0) {
4621                                 my @allowed = ();
4622                                 my $allow = 0;
4623                                 my $seen = 0;
4624                                 my $herectx = $here . "\n";
4625                                 my $ln = $linenr - 1;
4626                                 for my $chunk (@chunks) {
4627                                         my ($cond, $block) = @{$chunk};
4628
4629                                         # If the condition carries leading newlines, then count those as offsets.
4630                                         my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4631                                         my $offset = statement_rawlines($whitespace) - 1;
4632
4633                                         $allowed[$allow] = 0;
4634                                         #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4635
4636                                         # We have looked at and allowed this specific line.
4637                                         $suppress_ifbraces{$ln + $offset} = 1;
4638
4639                                         $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
4640                                         $ln += statement_rawlines($block) - 1;
4641
4642                                         substr($block, 0, length($cond), '');
4643
4644                                         $seen++ if ($block =~ /^\s*{/);
4645
4646                                         #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
4647                                         if (statement_lines($cond) > 1) {
4648                                                 #print "APW: ALLOWED: cond<$cond>\n";
4649                                                 $allowed[$allow] = 1;
4650                                         }
4651                                         if ($block =~/\b(?:if|for|while)\b/) {
4652                                                 #print "APW: ALLOWED: block<$block>\n";
4653                                                 $allowed[$allow] = 1;
4654                                         }
4655                                         if (statement_block_size($block) > 1) {
4656                                                 #print "APW: ALLOWED: lines block<$block>\n";
4657                                                 $allowed[$allow] = 1;
4658                                         }
4659                                         $allow++;
4660                                 }
4661                                 if ($seen) {
4662                                         my $sum_allowed = 0;
4663                                         foreach (@allowed) {
4664                                                 $sum_allowed += $_;
4665                                         }
4666                                         if ($sum_allowed == 0) {
4667                                                 WARN("BRACES",
4668                                                      "braces {} are not necessary for any arm of this statement\n" . $herectx);
4669                                         } elsif ($sum_allowed != $allow &&
4670                                                  $seen != $allow) {
4671                                                 CHK("BRACES",
4672                                                     "braces {} should be used on all arms of this statement\n" . $herectx);
4673                                         }
4674                                 }
4675                         }
4676                 }
4677                 if (!defined $suppress_ifbraces{$linenr - 1} &&
4678                                         $line =~ /\b(if|while|for|else)\b/) {
4679                         my $allowed = 0;
4680
4681                         # Check the pre-context.
4682                         if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
4683                                 #print "APW: ALLOWED: pre<$1>\n";
4684                                 $allowed = 1;
4685                         }
4686
4687                         my ($level, $endln, @chunks) =
4688                                 ctx_statement_full($linenr, $realcnt, $-[0]);
4689
4690                         # Check the condition.
4691                         my ($cond, $block) = @{$chunks[0]};
4692                         #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
4693                         if (defined $cond) {
4694                                 substr($block, 0, length($cond), '');
4695                         }
4696                         if (statement_lines($cond) > 1) {
4697                                 #print "APW: ALLOWED: cond<$cond>\n";
4698                                 $allowed = 1;
4699                         }
4700                         if ($block =~/\b(?:if|for|while)\b/) {
4701                                 #print "APW: ALLOWED: block<$block>\n";
4702                                 $allowed = 1;
4703                         }
4704                         if (statement_block_size($block) > 1) {
4705                                 #print "APW: ALLOWED: lines block<$block>\n";
4706                                 $allowed = 1;
4707                         }
4708                         # Check the post-context.
4709                         if (defined $chunks[1]) {
4710                                 my ($cond, $block) = @{$chunks[1]};
4711                                 if (defined $cond) {
4712                                         substr($block, 0, length($cond), '');
4713                                 }
4714                                 if ($block =~ /^\s*\{/) {
4715                                         #print "APW: ALLOWED: chunk-1 block<$block>\n";
4716                                         $allowed = 1;
4717                                 }
4718                         }
4719                         if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
4720                                 my $herectx = $here . "\n";
4721                                 my $cnt = statement_rawlines($block);
4722
4723                                 for (my $n = 0; $n < $cnt; $n++) {
4724                                         $herectx .= raw_line($linenr, $n) . "\n";
4725                                 }
4726
4727                                 WARN("BRACES",
4728                                      "braces {} are not necessary for single statement blocks\n" . $herectx);
4729                         }
4730                 }
4731
4732 # check for unnecessary blank lines around braces
4733                 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
4734                         if (CHK("BRACES",
4735                                 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
4736                             $fix && $prevrawline =~ /^\+/) {
4737                                 fix_delete_line($fixlinenr - 1, $prevrawline);
4738                         }
4739                 }
4740                 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
4741                         if (CHK("BRACES",
4742                                 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
4743                             $fix) {
4744                                 fix_delete_line($fixlinenr, $rawline);
4745                         }
4746                 }
4747
4748 # no volatiles please
4749                 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
4750                 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
4751                         WARN("VOLATILE",
4752                              "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
4753                 }
4754
4755 # Check for user-visible strings broken across lines, which breaks the ability
4756 # to grep for the string.  Make exceptions when the previous string ends in a
4757 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
4758 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
4759                 if ($line =~ /^\+\s*$String/ &&
4760                     $prevline =~ /"\s*$/ &&
4761                     $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
4762                         if (WARN("SPLIT_STRING",
4763                                  "quoted string split across lines\n" . $hereprev) &&
4764                                      $fix &&
4765                                      $prevrawline =~ /^\+.*"\s*$/ &&
4766                                      $last_coalesced_string_linenr != $linenr - 1) {
4767                                 my $extracted_string = get_quoted_string($line, $rawline);
4768                                 my $comma_close = "";
4769                                 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
4770                                         $comma_close = $1;
4771                                 }
4772
4773                                 fix_delete_line($fixlinenr - 1, $prevrawline);
4774                                 fix_delete_line($fixlinenr, $rawline);
4775                                 my $fixedline = $prevrawline;
4776                                 $fixedline =~ s/"\s*$//;
4777                                 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
4778                                 fix_insert_line($fixlinenr - 1, $fixedline);
4779                                 $fixedline = $rawline;
4780                                 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
4781                                 if ($fixedline !~ /\+\s*$/) {
4782                                         fix_insert_line($fixlinenr, $fixedline);
4783                                 }
4784                                 $last_coalesced_string_linenr = $linenr;
4785                         }
4786                 }
4787
4788 # check for missing a space in a string concatenation
4789                 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
4790                         WARN('MISSING_SPACE',
4791                              "break quoted strings at a space character\n" . $hereprev);
4792                 }
4793
4794 # check for spaces before a quoted newline
4795                 if ($rawline =~ /^.*\".*\s\\n/) {
4796                         if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
4797                                  "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
4798                             $fix) {
4799                                 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
4800                         }
4801
4802                 }
4803
4804 # concatenated string without spaces between elements
4805                 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
4806                         CHK("CONCATENATED_STRING",
4807                             "Concatenated strings should use spaces between elements\n" . $herecurr);
4808                 }
4809
4810 # uncoalesced string fragments
4811                 if ($line =~ /$String\s*"/) {
4812                         WARN("STRING_FRAGMENTS",
4813                              "Consecutive strings are generally better as a single string\n" . $herecurr);
4814                 }
4815
4816 # check for %L{u,d,i} in strings
4817                 my $string;
4818                 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4819                         $string = substr($rawline, $-[1], $+[1] - $-[1]);
4820                         $string =~ s/%%/__/g;
4821                         if ($string =~ /(?<!%)%L[udi]/) {
4822                                 WARN("PRINTF_L",
4823                                      "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
4824                                 last;
4825                         }
4826                 }
4827
4828 # check for line continuations in quoted strings with odd counts of "
4829                 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
4830                         WARN("LINE_CONTINUATIONS",
4831                              "Avoid line continuations in quoted strings\n" . $herecurr);
4832                 }
4833
4834 # warn about #if 0
4835                 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
4836                         CHK("REDUNDANT_CODE",
4837                             "if this code is redundant consider removing it\n" .
4838                                 $herecurr);
4839                 }
4840
4841 # check for needless "if (<foo>) fn(<foo>)" uses
4842                 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
4843                         my $tested = quotemeta($1);
4844                         my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
4845                         if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
4846                                 my $func = $1;
4847                                 if (WARN('NEEDLESS_IF',
4848                                          "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
4849                                     $fix) {
4850                                         my $do_fix = 1;
4851                                         my $leading_tabs = "";
4852                                         my $new_leading_tabs = "";
4853                                         if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
4854                                                 $leading_tabs = $1;
4855                                         } else {
4856                                                 $do_fix = 0;
4857                                         }
4858                                         if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
4859                                                 $new_leading_tabs = $1;
4860                                                 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
4861                                                         $do_fix = 0;
4862                                                 }
4863                                         } else {
4864                                                 $do_fix = 0;
4865                                         }
4866                                         if ($do_fix) {
4867                                                 fix_delete_line($fixlinenr - 1, $prevrawline);
4868                                                 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
4869                                         }
4870                                 }
4871                         }
4872                 }
4873
4874 # check for unnecessary "Out of Memory" messages
4875                 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
4876                     $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
4877                     (defined $1 || defined $3) &&
4878                     $linenr > 3) {
4879                         my $testval = $2;
4880                         my $testline = $lines[$linenr - 3];
4881
4882                         my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
4883 #                       print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
4884
4885                         if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
4886                                 WARN("OOM_MESSAGE",
4887                                      "Possible unnecessary 'out of memory' message\n" . $hereprev);
4888                         }
4889                 }
4890
4891 # check for logging functions with KERN_<LEVEL>
4892                 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
4893                     $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
4894                         my $level = $1;
4895                         if (WARN("UNNECESSARY_KERN_LEVEL",
4896                                  "Possible unnecessary $level\n" . $herecurr) &&
4897                             $fix) {
4898                                 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
4899                         }
4900                 }
4901
4902 # check for mask then right shift without a parentheses
4903                 if ($^V && $^V ge 5.10.0 &&
4904                     $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
4905                     $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
4906                         WARN("MASK_THEN_SHIFT",
4907                              "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
4908                 }
4909
4910 # check for pointer comparisons to NULL
4911                 if ($^V && $^V ge 5.10.0) {
4912                         while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
4913                                 my $val = $1;
4914                                 my $equal = "!";
4915                                 $equal = "" if ($4 eq "!=");
4916                                 if (CHK("COMPARISON_TO_NULL",
4917                                         "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
4918                                             $fix) {
4919                                         $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
4920                                 }
4921                         }
4922                 }
4923
4924 # check for bad placement of section $InitAttribute (e.g.: __initdata)
4925                 if ($line =~ /(\b$InitAttribute\b)/) {
4926                         my $attr = $1;
4927                         if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
4928                                 my $ptr = $1;
4929                                 my $var = $2;
4930                                 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
4931                                       ERROR("MISPLACED_INIT",
4932                                             "$attr should be placed after $var\n" . $herecurr)) ||
4933                                      ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
4934                                       WARN("MISPLACED_INIT",
4935                                            "$attr should be placed after $var\n" . $herecurr))) &&
4936                                     $fix) {
4937                                         $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;
4938                                 }
4939                         }
4940                 }
4941
4942 # check for $InitAttributeData (ie: __initdata) with const
4943                 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
4944                         my $attr = $1;
4945                         $attr =~ /($InitAttributePrefix)(.*)/;
4946                         my $attr_prefix = $1;
4947                         my $attr_type = $2;
4948                         if (ERROR("INIT_ATTRIBUTE",
4949                                   "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
4950                             $fix) {
4951                                 $fixed[$fixlinenr] =~
4952                                     s/$InitAttributeData/${attr_prefix}initconst/;
4953                         }
4954                 }
4955
4956 # check for $InitAttributeConst (ie: __initconst) without const
4957                 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
4958                         my $attr = $1;
4959                         if (ERROR("INIT_ATTRIBUTE",
4960                                   "Use of $attr requires a separate use of const\n" . $herecurr) &&
4961                             $fix) {
4962                                 my $lead = $fixed[$fixlinenr] =~
4963                                     /(^\+\s*(?:static\s+))/;
4964                                 $lead = rtrim($1);
4965                                 $lead = "$lead " if ($lead !~ /^\+$/);
4966                                 $lead = "${lead}const ";
4967                                 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
4968                         }
4969                 }
4970
4971 # check for __read_mostly with const non-pointer (should just be const)
4972                 if ($line =~ /\b__read_mostly\b/ &&
4973                     $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
4974                         if (ERROR("CONST_READ_MOSTLY",
4975                                   "Invalid use of __read_mostly with const type\n" . $herecurr) &&
4976                             $fix) {
4977                                 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
4978                         }
4979                 }
4980
4981 # don't use __constant_<foo> functions outside of include/uapi/
4982                 if ($realfile !~ m@^include/uapi/@ &&
4983                     $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
4984                         my $constant_func = $1;
4985                         my $func = $constant_func;
4986                         $func =~ s/^__constant_//;
4987                         if (WARN("CONSTANT_CONVERSION",
4988                                  "$constant_func should be $func\n" . $herecurr) &&
4989                             $fix) {
4990                                 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
4991                         }
4992                 }
4993
4994 # prefer usleep_range over udelay
4995                 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
4996                         my $delay = $1;
4997                         # ignore udelay's < 10, however
4998                         if (! ($delay < 10) ) {
4999                                 CHK("USLEEP_RANGE",
5000                                     "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5001                         }
5002                         if ($delay > 2000) {
5003                                 WARN("LONG_UDELAY",
5004                                      "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
5005                         }
5006                 }
5007
5008 # warn about unexpectedly long msleep's
5009                 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5010                         if ($1 < 20) {
5011                                 WARN("MSLEEP",
5012                                      "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5013                         }
5014                 }
5015
5016 # check for comparisons of jiffies
5017                 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5018                         WARN("JIFFIES_COMPARISON",
5019                              "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5020                 }
5021
5022 # check for comparisons of get_jiffies_64()
5023                 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5024                         WARN("JIFFIES_COMPARISON",
5025                              "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5026                 }
5027
5028 # warn about #ifdefs in C files
5029 #               if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5030 #                       print "#ifdef in C files should be avoided\n";
5031 #                       print "$herecurr";
5032 #                       $clean = 0;
5033 #               }
5034
5035 # warn about spacing in #ifdefs
5036                 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
5037                         if (ERROR("SPACING",
5038                                   "exactly one space required after that #$1\n" . $herecurr) &&
5039                             $fix) {
5040                                 $fixed[$fixlinenr] =~
5041                                     s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5042                         }
5043
5044                 }
5045
5046 # check for spinlock_t definitions without a comment.
5047                 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5048                     $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
5049                         my $which = $1;
5050                         if (!ctx_has_comment($first_line, $linenr)) {
5051                                 CHK("UNCOMMENTED_DEFINITION",
5052                                     "$1 definition without comment\n" . $herecurr);
5053                         }
5054                 }
5055 # check for memory barriers without a comment.
5056                 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
5057                         if (!ctx_has_comment($first_line, $linenr)) {
5058                                 WARN("MEMORY_BARRIER",
5059                                      "memory barrier without comment\n" . $herecurr);
5060                         }
5061                 }
5062
5063 # check for waitqueue_active without a comment.
5064                 if ($line =~ /\bwaitqueue_active\s*\(/) {
5065                         if (!ctx_has_comment($first_line, $linenr)) {
5066                                 WARN("WAITQUEUE_ACTIVE",
5067                                      "waitqueue_active without comment\n" . $herecurr);
5068                         }
5069                 }
5070
5071 # Check for expedited grace periods that interrupt non-idle non-nohz
5072 # online CPUs.  These expedited can therefore degrade real-time response
5073 # if used carelessly, and should be avoided where not absolutely
5074 # needed.  It is always OK to use synchronize_rcu_expedited() and
5075 # synchronize_sched_expedited() at boot time (before real-time applications
5076 # start) and in error situations where real-time response is compromised in
5077 # any case.  Note that synchronize_srcu_expedited() does -not- interrupt
5078 # other CPUs, so don't warn on uses of synchronize_srcu_expedited().
5079 # Of course, nothing comes for free, and srcu_read_lock() and
5080 # srcu_read_unlock() do contain full memory barriers in payment for
5081 # synchronize_srcu_expedited() non-interruption properties.
5082                 if ($line =~ /\b(synchronize_rcu_expedited|synchronize_sched_expedited)\(/) {
5083                         WARN("EXPEDITED_RCU_GRACE_PERIOD",
5084                              "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr);
5085
5086                 }
5087
5088 # check of hardware specific defines
5089                 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5090                         CHK("ARCH_DEFINES",
5091                             "architecture specific defines should be avoided\n" .  $herecurr);
5092                 }
5093
5094 # Check that the storage class is at the beginning of a declaration
5095                 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
5096                         WARN("STORAGE_CLASS",
5097                              "storage class should be at the beginning of the declaration\n" . $herecurr)
5098                 }
5099
5100 # check the location of the inline attribute, that it is between
5101 # storage class and type.
5102                 if ($line =~ /\b$Type\s+$Inline\b/ ||
5103                     $line =~ /\b$Inline\s+$Storage\b/) {
5104                         ERROR("INLINE_LOCATION",
5105                               "inline keyword should sit between storage class and type\n" . $herecurr);
5106                 }
5107
5108 # Check for __inline__ and __inline, prefer inline
5109                 if ($realfile !~ m@\binclude/uapi/@ &&
5110                     $line =~ /\b(__inline__|__inline)\b/) {
5111                         if (WARN("INLINE",
5112                                  "plain inline is preferred over $1\n" . $herecurr) &&
5113                             $fix) {
5114                                 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
5115
5116                         }
5117                 }
5118
5119 # Check for __attribute__ packed, prefer __packed
5120                 if ($realfile !~ m@\binclude/uapi/@ &&
5121                     $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
5122                         WARN("PREFER_PACKED",
5123                              "__packed is preferred over __attribute__((packed))\n" . $herecurr);
5124                 }
5125
5126 # Check for __attribute__ aligned, prefer __aligned
5127                 if ($realfile !~ m@\binclude/uapi/@ &&
5128                     $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
5129                         WARN("PREFER_ALIGNED",
5130                              "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
5131                 }
5132
5133 # Check for __attribute__ format(printf, prefer __printf
5134                 if ($realfile !~ m@\binclude/uapi/@ &&
5135                     $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
5136                         if (WARN("PREFER_PRINTF",
5137                                  "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5138                             $fix) {
5139                                 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5140
5141                         }
5142                 }
5143
5144 # Check for __attribute__ format(scanf, prefer __scanf
5145                 if ($realfile !~ m@\binclude/uapi/@ &&
5146                     $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
5147                         if (WARN("PREFER_SCANF",
5148                                  "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5149                             $fix) {
5150                                 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5151                         }
5152                 }
5153
5154 # Check for __attribute__ weak, or __weak declarations (may have link issues)
5155                 if ($^V && $^V ge 5.10.0 &&
5156                     $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5157                     ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5158                      $line =~ /\b__weak\b/)) {
5159                         ERROR("WEAK_DECLARATION",
5160                               "Using weak declarations can have unintended link defects\n" . $herecurr);
5161                 }
5162
5163 # check for c99 types like uint8_t used outside of uapi/
5164                 if ($realfile !~ m@\binclude/uapi/@ &&
5165                     $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5166                         my $type = $1;
5167                         if ($type =~ /\b($typeC99Typedefs)\b/) {
5168                                 $type = $1;
5169                                 my $kernel_type = 'u';
5170                                 $kernel_type = 's' if ($type =~ /^_*[si]/);
5171                                 $type =~ /(\d+)/;
5172                                 $kernel_type .= $1;
5173                                 if (CHK("PREFER_KERNEL_TYPES",
5174                                         "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5175                                     $fix) {
5176                                         $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5177                                 }
5178                         }
5179                 }
5180
5181 # check for sizeof(&)
5182                 if ($line =~ /\bsizeof\s*\(\s*\&/) {
5183                         WARN("SIZEOF_ADDRESS",
5184                              "sizeof(& should be avoided\n" . $herecurr);
5185                 }
5186
5187 # check for sizeof without parenthesis
5188                 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
5189                         if (WARN("SIZEOF_PARENTHESIS",
5190                                  "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5191                             $fix) {
5192                                 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5193                         }
5194                 }
5195
5196 # check for struct spinlock declarations
5197                 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5198                         WARN("USE_SPINLOCK_T",
5199                              "struct spinlock should be spinlock_t\n" . $herecurr);
5200                 }
5201
5202 # check for seq_printf uses that could be seq_puts
5203                 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
5204                         my $fmt = get_quoted_string($line, $rawline);
5205                         $fmt =~ s/%%//g;
5206                         if ($fmt !~ /%/) {
5207                                 if (WARN("PREFER_SEQ_PUTS",
5208                                          "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5209                                     $fix) {
5210                                         $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
5211                                 }
5212                         }
5213                 }
5214
5215 # Check for misused memsets
5216                 if ($^V && $^V ge 5.10.0 &&
5217                     defined $stat &&
5218                     $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
5219
5220                         my $ms_addr = $2;
5221                         my $ms_val = $7;
5222                         my $ms_size = $12;
5223
5224                         if ($ms_size =~ /^(0x|)0$/i) {
5225                                 ERROR("MEMSET",
5226                                       "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
5227                         } elsif ($ms_size =~ /^(0x|)1$/i) {
5228                                 WARN("MEMSET",
5229                                      "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5230                         }
5231                 }
5232
5233 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5234                 if ($^V && $^V ge 5.10.0 &&
5235                     defined $stat &&
5236                     $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5237                         if (WARN("PREFER_ETHER_ADDR_COPY",
5238                                  "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5239                             $fix) {
5240                                 $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5241                         }
5242                 }
5243
5244 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5245                 if ($^V && $^V ge 5.10.0 &&
5246                     defined $stat &&
5247                     $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5248                         WARN("PREFER_ETHER_ADDR_EQUAL",
5249                              "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5250                 }
5251
5252 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5253 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5254                 if ($^V && $^V ge 5.10.0 &&
5255                     defined $stat &&
5256                     $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5257
5258                         my $ms_val = $7;
5259
5260                         if ($ms_val =~ /^(?:0x|)0+$/i) {
5261                                 if (WARN("PREFER_ETH_ZERO_ADDR",
5262                                          "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5263                                     $fix) {
5264                                         $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5265                                 }
5266                         } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5267                                 if (WARN("PREFER_ETH_BROADCAST_ADDR",
5268                                          "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5269                                     $fix) {
5270                                         $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5271                                 }
5272                         }
5273                 }
5274
5275 # typecasts on min/max could be min_t/max_t
5276                 if ($^V && $^V ge 5.10.0 &&
5277                     defined $stat &&
5278                     $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
5279                         if (defined $2 || defined $7) {
5280                                 my $call = $1;
5281                                 my $cast1 = deparenthesize($2);
5282                                 my $arg1 = $3;
5283                                 my $cast2 = deparenthesize($7);
5284                                 my $arg2 = $8;
5285                                 my $cast;
5286
5287                                 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
5288                                         $cast = "$cast1 or $cast2";
5289                                 } elsif ($cast1 ne "") {
5290                                         $cast = $cast1;
5291                                 } else {
5292                                         $cast = $cast2;
5293                                 }
5294                                 WARN("MINMAX",
5295                                      "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
5296                         }
5297                 }
5298
5299 # check usleep_range arguments
5300                 if ($^V && $^V ge 5.10.0 &&
5301                     defined $stat &&
5302                     $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5303                         my $min = $1;
5304                         my $max = $7;
5305                         if ($min eq $max) {
5306                                 WARN("USLEEP_RANGE",
5307                                      "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5308                         } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5309                                  $min > $max) {
5310                                 WARN("USLEEP_RANGE",
5311                                      "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5312                         }
5313                 }
5314
5315 # check for naked sscanf
5316                 if ($^V && $^V ge 5.10.0 &&
5317                     defined $stat &&
5318                     $line =~ /\bsscanf\b/ &&
5319                     ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5320                      $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5321                      $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5322                         my $lc = $stat =~ tr@\n@@;
5323                         $lc = $lc + $linenr;
5324                         my $stat_real = raw_line($linenr, 0);
5325                         for (my $count = $linenr + 1; $count <= $lc; $count++) {
5326                                 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5327                         }
5328                         WARN("NAKED_SSCANF",
5329                              "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5330                 }
5331
5332 # check for simple sscanf that should be kstrto<foo>
5333                 if ($^V && $^V ge 5.10.0 &&
5334                     defined $stat &&
5335                     $line =~ /\bsscanf\b/) {
5336                         my $lc = $stat =~ tr@\n@@;
5337                         $lc = $lc + $linenr;
5338                         my $stat_real = raw_line($linenr, 0);
5339                         for (my $count = $linenr + 1; $count <= $lc; $count++) {
5340                                 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5341                         }
5342                         if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5343                                 my $format = $6;
5344                                 my $count = $format =~ tr@%@%@;
5345                                 if ($count == 1 &&
5346                                     $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5347                                         WARN("SSCANF_TO_KSTRTO",
5348                                              "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5349                                 }
5350                         }
5351                 }
5352
5353 # check for new externs in .h files.
5354                 if ($realfile =~ /\.h$/ &&
5355                     $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
5356                         if (CHK("AVOID_EXTERNS",
5357                                 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
5358                             $fix) {
5359                                 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
5360                         }
5361                 }
5362
5363 # check for new externs in .c files.
5364                 if ($realfile =~ /\.c$/ && defined $stat &&
5365                     $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
5366                 {
5367                         my $function_name = $1;
5368                         my $paren_space = $2;
5369
5370                         my $s = $stat;
5371                         if (defined $cond) {
5372                                 substr($s, 0, length($cond), '');
5373                         }
5374                         if ($s =~ /^\s*;/ &&
5375                             $function_name ne 'uninitialized_var')
5376                         {
5377                                 WARN("AVOID_EXTERNS",
5378                                      "externs should be avoided in .c files\n" .  $herecurr);
5379                         }
5380
5381                         if ($paren_space =~ /\n/) {
5382                                 WARN("FUNCTION_ARGUMENTS",
5383                                      "arguments for function declarations should follow identifier\n" . $herecurr);
5384                         }
5385
5386                 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5387                     $stat =~ /^.\s*extern\s+/)
5388                 {
5389                         WARN("AVOID_EXTERNS",
5390                              "externs should be avoided in .c files\n" .  $herecurr);
5391                 }
5392
5393 # checks for new __setup's
5394                 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5395                         my $name = $1;
5396
5397                         if (!grep(/$name/, @setup_docs)) {
5398                                 CHK("UNDOCUMENTED_SETUP",
5399                                     "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
5400                         }
5401                 }
5402
5403 # check for pointless casting of kmalloc return
5404                 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
5405                         WARN("UNNECESSARY_CASTS",
5406                              "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
5407                 }
5408
5409 # alloc style
5410 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5411                 if ($^V && $^V ge 5.10.0 &&
5412                     $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5413                         CHK("ALLOC_SIZEOF_STRUCT",
5414                             "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
5415                 }
5416
5417 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5418                 if ($^V && $^V ge 5.10.0 &&
5419                     $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
5420                         my $oldfunc = $3;
5421                         my $a1 = $4;
5422                         my $a2 = $10;
5423                         my $newfunc = "kmalloc_array";
5424                         $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
5425                         my $r1 = $a1;
5426                         my $r2 = $a2;
5427                         if ($a1 =~ /^sizeof\s*\S/) {
5428                                 $r1 = $a2;
5429                                 $r2 = $a1;
5430                         }
5431                         if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
5432                             !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
5433                                 if (WARN("ALLOC_WITH_MULTIPLY",
5434                                          "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
5435                                     $fix) {
5436                                         $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;
5437
5438                                 }
5439                         }
5440                 }
5441
5442 # check for krealloc arg reuse
5443                 if ($^V && $^V ge 5.10.0 &&
5444                     $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
5445                         WARN("KREALLOC_ARG_REUSE",
5446                              "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
5447                 }
5448
5449 # check for alloc argument mismatch
5450                 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
5451                         WARN("ALLOC_ARRAY_ARGS",
5452                              "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
5453                 }
5454
5455 # check for multiple semicolons
5456                 if ($line =~ /;\s*;\s*$/) {
5457                         if (WARN("ONE_SEMICOLON",
5458                                  "Statements terminations use 1 semicolon\n" . $herecurr) &&
5459                             $fix) {
5460                                 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
5461                         }
5462                 }
5463
5464 # check for #defines like: 1 << <digit> that could be BIT(digit)
5465                 if ($line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
5466                         my $ull = "";
5467                         $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
5468                         if (CHK("BIT_MACRO",
5469                                 "Prefer using the BIT$ull macro\n" . $herecurr) &&
5470                             $fix) {
5471                                 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
5472                         }
5473                 }
5474
5475 # check for case / default statements not preceded by break/fallthrough/switch
5476                 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
5477                         my $has_break = 0;
5478                         my $has_statement = 0;
5479                         my $count = 0;
5480                         my $prevline = $linenr;
5481                         while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
5482                                 $prevline--;
5483                                 my $rline = $rawlines[$prevline - 1];
5484                                 my $fline = $lines[$prevline - 1];
5485                                 last if ($fline =~ /^\@\@/);
5486                                 next if ($fline =~ /^\-/);
5487                                 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
5488                                 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
5489                                 next if ($fline =~ /^.[\s$;]*$/);
5490                                 $has_statement = 1;
5491                                 $count++;
5492                                 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
5493                         }
5494                         if (!$has_break && $has_statement) {
5495                                 WARN("MISSING_BREAK",
5496                                      "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
5497                         }
5498                 }
5499
5500 # check for switch/default statements without a break;
5501                 if ($^V && $^V ge 5.10.0 &&
5502                     defined $stat &&
5503                     $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
5504                         my $ctx = '';
5505                         my $herectx = $here . "\n";
5506                         my $cnt = statement_rawlines($stat);
5507                         for (my $n = 0; $n < $cnt; $n++) {
5508                                 $herectx .= raw_line($linenr, $n) . "\n";
5509                         }
5510                         WARN("DEFAULT_NO_BREAK",
5511                              "switch default: should use break\n" . $herectx);
5512                 }
5513
5514 # check for gcc specific __FUNCTION__
5515                 if ($line =~ /\b__FUNCTION__\b/) {
5516                         if (WARN("USE_FUNC",
5517                                  "__func__ should be used instead of gcc specific __FUNCTION__\n"  . $herecurr) &&
5518                             $fix) {
5519                                 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
5520                         }
5521                 }
5522
5523 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
5524                 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
5525                         ERROR("DATE_TIME",
5526                               "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
5527                 }
5528
5529 # check for use of yield()
5530                 if ($line =~ /\byield\s*\(\s*\)/) {
5531                         WARN("YIELD",
5532                              "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n"  . $herecurr);
5533                 }
5534
5535 # check for comparisons against true and false
5536                 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
5537                         my $lead = $1;
5538                         my $arg = $2;
5539                         my $test = $3;
5540                         my $otype = $4;
5541                         my $trail = $5;
5542                         my $op = "!";
5543
5544                         ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
5545
5546                         my $type = lc($otype);
5547                         if ($type =~ /^(?:true|false)$/) {
5548                                 if (("$test" eq "==" && "$type" eq "true") ||
5549                                     ("$test" eq "!=" && "$type" eq "false")) {
5550                                         $op = "";
5551                                 }
5552
5553                                 CHK("BOOL_COMPARISON",
5554                                     "Using comparison to $otype is error prone\n" . $herecurr);
5555
5556 ## maybe suggesting a correct construct would better
5557 ##                                  "Using comparison to $otype is error prone.  Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5558
5559                         }
5560                 }
5561
5562 # check for semaphores initialized locked
5563                 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
5564                         WARN("CONSIDER_COMPLETION",
5565                              "consider using a completion\n" . $herecurr);
5566                 }
5567
5568 # recommend kstrto* over simple_strto* and strict_strto*
5569                 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
5570                         WARN("CONSIDER_KSTRTO",
5571                              "$1 is obsolete, use k$3 instead\n" . $herecurr);
5572                 }
5573
5574 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
5575                 if ($line =~ /^.\s*__initcall\s*\(/) {
5576                         WARN("USE_DEVICE_INITCALL",
5577                              "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
5578                 }
5579
5580 # check for various structs that are normally const (ops, kgdb, device_tree)
5581                 my $const_structs = qr{
5582                                 acpi_dock_ops|
5583                                 address_space_operations|
5584                                 backlight_ops|
5585                                 block_device_operations|
5586                                 dentry_operations|
5587                                 dev_pm_ops|
5588                                 dma_map_ops|
5589                                 extent_io_ops|
5590                                 file_lock_operations|
5591                                 file_operations|
5592                                 hv_ops|
5593                                 ide_dma_ops|
5594                                 intel_dvo_dev_ops|
5595                                 item_operations|
5596                                 iwl_ops|
5597                                 kgdb_arch|
5598                                 kgdb_io|
5599                                 kset_uevent_ops|
5600                                 lock_manager_operations|
5601                                 microcode_ops|
5602                                 mtrr_ops|
5603                                 neigh_ops|
5604                                 nlmsvc_binding|
5605                                 of_device_id|
5606                                 pci_raw_ops|
5607                                 pipe_buf_operations|
5608                                 platform_hibernation_ops|
5609                                 platform_suspend_ops|
5610                                 proto_ops|
5611                                 rpc_pipe_ops|
5612                                 seq_operations|
5613                                 snd_ac97_build_ops|
5614                                 soc_pcmcia_socket_ops|
5615                                 stacktrace_ops|
5616                                 sysfs_ops|
5617                                 tty_operations|
5618                                 uart_ops|
5619                                 usb_mon_operations|
5620                                 wd_ops}x;
5621                 if ($line !~ /\bconst\b/ &&
5622                     $line =~ /\bstruct\s+($const_structs)\b/) {
5623                         WARN("CONST_STRUCT",
5624                              "struct $1 should normally be const\n" .
5625                                 $herecurr);
5626                 }
5627
5628 # use of NR_CPUS is usually wrong
5629 # ignore definitions of NR_CPUS and usage to define arrays as likely right
5630                 if ($line =~ /\bNR_CPUS\b/ &&
5631                     $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
5632                     $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
5633                     $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
5634                     $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
5635                     $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
5636                 {
5637                         WARN("NR_CPUS",
5638                              "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
5639                 }
5640
5641 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
5642                 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
5643                         ERROR("DEFINE_ARCH_HAS",
5644                               "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
5645                 }
5646
5647 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
5648                 if ($^V && $^V ge 5.10.0 &&
5649                     $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
5650                         WARN("LIKELY_MISUSE",
5651                              "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
5652                 }
5653
5654 # whine mightly about in_atomic
5655                 if ($line =~ /\bin_atomic\s*\(/) {
5656                         if ($realfile =~ m@^drivers/@) {
5657                                 ERROR("IN_ATOMIC",
5658                                       "do not use in_atomic in drivers\n" . $herecurr);
5659                         } elsif ($realfile !~ m@^kernel/@) {
5660                                 WARN("IN_ATOMIC",
5661                                      "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
5662                         }
5663                 }
5664
5665 # check for lockdep_set_novalidate_class
5666                 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
5667                     $line =~ /__lockdep_no_validate__\s*\)/ ) {
5668                         if ($realfile !~ m@^kernel/lockdep@ &&
5669                             $realfile !~ m@^include/linux/lockdep@ &&
5670                             $realfile !~ m@^drivers/base/core@) {
5671                                 ERROR("LOCKDEP",
5672                                       "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
5673                         }
5674                 }
5675
5676                 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
5677                     $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
5678                         WARN("EXPORTED_WORLD_WRITABLE",
5679                              "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5680                 }
5681
5682 # Mode permission misuses where it seems decimal should be octal
5683 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5684                 if ($^V && $^V ge 5.10.0 &&
5685                     $line =~ /$mode_perms_search/) {
5686                         foreach my $entry (@mode_permission_funcs) {
5687                                 my $func = $entry->[0];
5688                                 my $arg_pos = $entry->[1];
5689
5690                                 my $skip_args = "";
5691                                 if ($arg_pos > 1) {
5692                                         $arg_pos--;
5693                                         $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
5694                                 }
5695                                 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
5696                                 if ($line =~ /$test/) {
5697                                         my $val = $1;
5698                                         $val = $6 if ($skip_args ne "");
5699
5700                                         if ($val !~ /^0$/ &&
5701                                             (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
5702                                              length($val) ne 4)) {
5703                                                 ERROR("NON_OCTAL_PERMISSIONS",
5704                                                       "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
5705                                         } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) {
5706                                                 ERROR("EXPORTED_WORLD_WRITABLE",
5707                                                       "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5708                                         }
5709                                 }
5710                         }
5711                 }
5712
5713 # validate content of MODULE_LICENSE against list from include/linux/module.h
5714                 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
5715                         my $extracted_string = get_quoted_string($line, $rawline);
5716                         my $valid_licenses = qr{
5717                                                 GPL|
5718                                                 GPL\ v2|
5719                                                 GPL\ and\ additional\ rights|
5720                                                 Dual\ BSD/GPL|
5721                                                 Dual\ MIT/GPL|
5722                                                 Dual\ MPL/GPL|
5723                                                 Proprietary
5724                                         }x;
5725                         if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
5726                                 WARN("MODULE_LICENSE",
5727                                      "unknown module license " . $extracted_string . "\n" . $herecurr);
5728                         }
5729                 }
5730         }
5731
5732         # If we have no input at all, then there is nothing to report on
5733         # so just keep quiet.
5734         if ($#rawlines == -1) {
5735                 exit(0);
5736         }
5737
5738         # In mailback mode only produce a report in the negative, for
5739         # things that appear to be patches.
5740         if ($mailback && ($clean == 1 || !$is_patch)) {
5741                 exit(0);
5742         }
5743
5744         # This is not a patch, and we are are in 'no-patch' mode so
5745         # just keep quiet.
5746         if (!$chk_patch && !$is_patch) {
5747                 exit(0);
5748         }
5749
5750         if (!$is_patch && $file !~ /cover-letter\.patch$/) {
5751                 ERROR("NOT_UNIFIED_DIFF",
5752                       "Does not appear to be a unified-diff format patch\n");
5753         }
5754         if ($is_patch && $filename ne '-' && $chk_signoff && $signoff == 0) {
5755                 ERROR("MISSING_SIGN_OFF",
5756                       "Missing Signed-off-by: line(s)\n");
5757         }
5758
5759         print report_dump();
5760         if ($summary && !($clean == 1 && $quiet == 1)) {
5761                 print "$filename " if ($summary_file);
5762                 print "total: $cnt_error errors, $cnt_warn warnings, " .
5763                         (($check)? "$cnt_chk checks, " : "") .
5764                         "$cnt_lines lines checked\n";
5765         }
5766
5767         if ($quiet == 0) {
5768                 # If there were whitespace errors which cleanpatch can fix
5769                 # then suggest that.
5770                 if ($rpt_cleaners) {
5771                         $rpt_cleaners = 0;
5772                         print << "EOM"
5773
5774 NOTE: Whitespace errors detected.
5775       You may wish to use scripts/cleanpatch or scripts/cleanfile
5776 EOM
5777                 }
5778         }
5779
5780         if ($clean == 0 && $fix &&
5781             ("@rawlines" ne "@fixed" ||
5782              $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
5783                 my $newfile = $filename;
5784                 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
5785                 my $linecount = 0;
5786                 my $f;
5787
5788                 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
5789
5790                 open($f, '>', $newfile)
5791                     or die "$P: Can't open $newfile for write\n";
5792                 foreach my $fixed_line (@fixed) {
5793                         $linecount++;
5794                         if ($file) {
5795                                 if ($linecount > 3) {
5796                                         $fixed_line =~ s/^\+//;
5797                                         print $f $fixed_line . "\n";
5798                                 }
5799                         } else {
5800                                 print $f $fixed_line . "\n";
5801                         }
5802                 }
5803                 close($f);
5804
5805                 if (!$quiet) {
5806                         print << "EOM";
5807
5808 Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
5809
5810 Do _NOT_ trust the results written to this file.
5811 Do _NOT_ submit these changes without inspecting them for correctness.
5812
5813 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
5814 No warranties, expressed or implied...
5815 EOM
5816                 }
5817         }
5818
5819         if ($quiet == 0) {
5820                 print "\n";
5821                 if ($clean == 1) {
5822                         print "$vname has no obvious style problems and is ready for submission.\n";
5823                 } else {
5824                         print "$vname has style problems, please review.\n";
5825                 }
5826         }
5827         return $clean;
5828 }