contrib/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 # Based on linux/scripts/checkpatch.pl from 2.6.38 but uses Lustre
   9 # specific deprecated symbol/functions/include lists rather than
  10 # Documentation/feature-removal-schedule.txt.
  11
  12 use strict;
  13
  14 my $P = $0;
  15 $P =~ s@.*/@@g;
  16
  17 my $V = '0.32';
  18
  19 use Getopt::Long qw(:config no_auto_abbrev);
  20
  21 my $quiet = 0;
  22 my $tree = 0;
  23 my $chk_signoff = 0;
  24 my $chk_patch = 1;
  25 my $tst_only;
  26 my $emacs = 0;
  27 my $terse = 0;
  28 my $file = 0;
  29 my $check = 0;
  30 my $summary = 1;
  31 my $mailback = 0;
  32 my $summary_file = 0;
  33 my $show_types = 0;
  34 my $root;
  35 my %debug;
  36 my %ignore_type = ();
  37 my @ignore = ();
  38 my $help = 0;
  39 my $configuration_file = ".checkpatch.conf";
  40
  41 sub help {
  42         my ($exitcode) = @_;
  43
  44         print << "EOM";
  45 Usage: $P [OPTION]... [FILE]...
  46 Version: $V
  47
  48 Options:
  49   -q, --quiet                quiet
  50   --no-tree                  run without a kernel tree
  51   --no-signoff               do not check for 'Signed-off-by' line
  52   --patch                    treat FILE as patchfile (default)
  53   --emacs                    emacs compile window format
  54   --terse                    one line per report
  55   -f, --file                 treat FILE as regular source file
  56   --subjective, --strict     enable more subjective tests
  57   --ignore TYPE(,TYPE2...)   ignore various comma separated message types
  58   --show-types               show the message "types" in the output
  59   --root=PATH                PATH to the kernel tree root
  60   --no-summary               suppress the per-file summary
  61   --mailback                 only produce a report in case of warnings/errors
  62   --summary-file             include the filename in summary
  63   --debug KEY=[0|1]          turn on/off debugging of KEY, where KEY is one of
  64                              'values', 'possible', 'type', and 'attr' (default
  65                              is all off)
  66   --test-only=WORD           report only warnings/errors containing WORD
  67                              literally
  68   -h, --help, --version      display this help and exit
  69
  70 When FILE is - read standard input.
  71 EOM
  72
  73         exit($exitcode);
  74 }
  75
  76 my $conf = which_conf($configuration_file);
  77 if (-f $conf) {
  78         my @conf_args;
  79         open(my $conffile, '<', "$conf")
  80             or warn "$P: Can't find a readable $configuration_file file $!\n";
  81
  82         while (<$conffile>) {
  83                 my $line = $_;
  84
  85                 $line =~ s/\s*\n?$//g;
  86                 $line =~ s/^\s*//g;
  87                 $line =~ s/\s+/ /g;
  88
  89                 next if ($line =~ m/^\s*#/);
  90                 next if ($line =~ m/^\s*$/);
  91
  92                 my @words = split(" ", $line);
  93                 foreach my $word (@words) {
  94                         last if ($word =~ m/^#/);
  95                         push (@conf_args, $word);
  96                 }
  97         }
  98         close($conffile);
  99         unshift(@ARGV, @conf_args) if @conf_args;
 100 }
 101
 102 GetOptions(
 103         'q|quiet+'      => \$quiet,
 104         'tree!'         => \$tree,
 105         'signoff!'      => \$chk_signoff,
 106         'patch!'        => \$chk_patch,
 107         'emacs!'        => \$emacs,
 108         'terse!'        => \$terse,
 109         'f|file!'       => \$file,
 110         'subjective!'   => \$check,
 111         'strict!'       => \$check,
 112         'ignore=s'      => \@ignore,
 113         'show-types!'   => \$show_types,
 114         'root=s'        => \$root,
 115         'summary!'      => \$summary,
 116         'mailback!'     => \$mailback,
 117         'summary-file!' => \$summary_file,
 118
 119         'debug=s'       => \%debug,
 120         'test-only=s'   => \$tst_only,
 121         'h|help'        => \$help,
 122         'version'       => \$help
 123 ) or help(1);
 124
 125 help(0) if ($help);
 126
 127 my $exit = 0;
 128
 129 if ($#ARGV < 0) {
 130         print "$P: no input files\n";
 131         exit(1);
 132 }
 133
 134 @ignore = split(/,/, join(',',@ignore));
 135 foreach my $word (@ignore) {
 136         $word =~ s/\s*\n?$//g;
 137         $word =~ s/^\s*//g;
 138         $word =~ s/\s+/ /g;
 139         $word =~ tr/[a-z]/[A-Z]/;
 140
 141         next if ($word =~ m/^\s*#/);
 142         next if ($word =~ m/^\s*$/);
 143
 144         $ignore_type{$word}++;
 145 }
 146
 147 my $dbg_values = 0;
 148 my $dbg_possible = 0;
 149 my $dbg_type = 0;
 150 my $dbg_attr = 0;
 151 for my $key (keys %debug) {
 152         ## no critic
 153         eval "\${dbg_$key} = '$debug{$key}';";
 154         die "$@" if ($@);
 155 }
 156
 157 my $rpt_cleaners = 0;
 158
 159 if ($terse) {
 160         $emacs = 1;
 161         $quiet++;
 162 }
 163
 164 if ($tree) {
 165         if (defined $root) {
 166                 if (!top_of_kernel_tree($root)) {
 167                         die "$P: $root: --root does not point at a valid tree\n";
 168                 }
 169         } else {
 170                 if (top_of_kernel_tree('.')) {
 171                         $root = '.';
 172                 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
 173                                                 top_of_kernel_tree($1)) {
 174                         $root = $1;
 175                 }
 176         }
 177
 178         if (!defined $root) {
 179                 print "Must be run from the top-level dir. of a kernel tree\n";
 180                 exit(2);
 181         }
 182 }
 183
 184 my $emitted_corrupt = 0;
 185
 186 our $Ident      = qr{
 187                         [A-Za-z_][A-Za-z\d_]*
 188                         (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
 189                 }x;
 190 our $Storage    = qr{extern|static|asmlinkage};
 191 our $Sparse     = qr{
 192                         __user|
 193                         __kernel|
 194                         __force|
 195                         __iomem|
 196                         __must_check|
 197                         __init_refok|
 198                         __kprobes|
 199                         __ref|
 200                         __rcu
 201                 }x;
 202
 203 # Notes to $Attribute:
 204 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
 205 our $Attribute  = qr{
 206                         const|
 207                         __percpu|
 208                         __nocast|
 209                         __safe|
 210                         __bitwise__|
 211                         __packed__|
 212                         __packed2__|
 213                         __naked|
 214                         __maybe_unused|
 215                         __always_unused|
 216                         __noreturn|
 217                         __used|
 218                         __cold|
 219                         __noclone|
 220                         __deprecated|
 221                         __read_mostly|
 222                         __kprobes|
 223                         __(?:mem|cpu|dev|)(?:initdata|initconst|init\b)|
 224                         ____cacheline_aligned|
 225                         ____cacheline_aligned_in_smp|
 226                         ____cacheline_internodealigned_in_smp|
 227                         __weak
 228                   }x;
 229 our $Modifier;
 230 our $Inline     = qr{inline|__always_inline|noinline};
 231 our $Member     = qr{->$Ident|\.$Ident|\[[^]]*\]};
 232 our $Lval       = qr{$Ident(?:$Member)*};
 233
 234 our $Constant   = qr{(?i:(?:[0-9]+|0x[0-9a-f]+)[ul]*)};
 235 our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
 236 our $Compare    = qr{<=|>=|==|!=|<|>};
 237 our $Operators  = qr{
 238                         <=|>=|==|!=|
 239                         =>|->|<<|>>|<|>|!|~|
 240                         &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
 241                   }x;
 242
 243 our $NonptrType;
 244 our $Type;
 245 our $Declare;
 246
 247 our $NON_ASCII_UTF8     = qr{
 248         [\xC2-\xDF][\x80-\xBF]               # non-overlong 2-byte
 249         |  \xE0[\xA0-\xBF][\x80-\xBF]        # excluding overlongs
 250         | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2}  # straight 3-byte
 251         |  \xED[\x80-\x9F][\x80-\xBF]        # excluding surrogates
 252         |  \xF0[\x90-\xBF][\x80-\xBF]{2}     # planes 1-3
 253         | [\xF1-\xF3][\x80-\xBF]{3}          # planes 4-15
 254         |  \xF4[\x80-\x8F][\x80-\xBF]{2}     # plane 16
 255 }x;
 256
 257 our $UTF8       = qr{
 258         [\x09\x0A\x0D\x20-\x7E]              # ASCII
 259         | $NON_ASCII_UTF8
 260 }x;
 261
 262 our $typeTypedefs = qr{(?x:
 263         (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
 264         atomic_t
 265 )};
 266
 267 our $logFunctions = qr{(?x:
 268         printk(?:_ratelimited|_once|)|
 269         [a-z0-9]+_(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
 270         WARN(?:_RATELIMIT|_ONCE|)|
 271         panic|
 272         MODULE_[A-Z_]+
 273 )};
 274
 275 our $signature_tags = qr{(?xi:
 276         Signed-off-by:|
 277         Acked-by:|
 278         Tested-by:|
 279         Reviewed-by:|
 280         Reported-by:|
 281         To:|
 282         Cc:
 283 )};
 284
 285 our @typeList = (
 286         qr{void},
 287         qr{(?:unsigned\s+)?char},
 288         qr{(?:unsigned\s+)?short},
 289         qr{(?:unsigned\s+)?int},
 290         qr{(?:unsigned\s+)?long},
 291         qr{(?:unsigned\s+)?long\s+int},
 292         qr{(?:unsigned\s+)?long\s+long},
 293         qr{(?:unsigned\s+)?long\s+long\s+int},
 294         qr{unsigned},
 295         qr{float},
 296         qr{double},
 297         qr{bool},
 298         qr{struct\s+$Ident},
 299         qr{union\s+$Ident},
 300         qr{enum\s+$Ident},
 301         qr{${Ident}_t},
 302         qr{${Ident}_handler},
 303         qr{${Ident}_handler_fn},
 304 );
 305 our @modifierList = (
 306         qr{fastcall},
 307 );
 308
 309 our $allowed_asm_includes = qr{(?x:
 310         irq|
 311         memory
 312 )};
 313 # memory.h: ARM has a custom one
 314
 315 sub build_types {
 316         my $mods = "(?x:  \n" . join("|\n  ", @modifierList) . "\n)";
 317         my $all = "(?x:  \n" . join("|\n  ", @typeList) . "\n)";
 318         $Modifier       = qr{(?:$Attribute|$Sparse|$mods)};
 319         $NonptrType     = qr{
 320                         (?:$Modifier\s+|const\s+)*
 321                         (?:
 322                                 (?:typeof|__typeof__)\s*\([^\)]*\)|
 323                                 (?:$typeTypedefs\b)|
 324                                 (?:${all}\b)
 325                         )
 326                         (?:\s+$Modifier|\s+const)*
 327                   }x;
 328         $Type   = qr{
 329                         $NonptrType
 330                         (?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)?
 331                         (?:\s+$Inline|\s+$Modifier)*
 332                   }x;
 333         $Declare        = qr{(?:$Storage\s+)?$Type};
 334 }
 335 build_types();
 336
 337 our $match_balanced_parentheses = qr/(\((?:[^\(\)]+|(-1))*\))/;
 338
 339 our $Typecast   = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
 340 our $LvalOrFunc = qr{($Lval)\s*($match_balanced_parentheses{0,1})\s*};
 341 our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
 342
 343 sub deparenthesize {
 344         my ($string) = @_;
 345         return "" if (!defined($string));
 346         $string =~ s@^\s*\(\s*@@g;
 347         $string =~ s@\s*\)\s*$@@g;
 348         $string =~ s@\s+@ @g;
 349         return $string;
 350 }
 351
 352 $chk_signoff = 0 if ($file);
 353
 354 my %dep_includes = (
 355         'asm/types.h',                  'linux/types.h',
 356         'asm/uaccess.h',                'linux/uaccess.h',
 357 );
 358
 359 my %dep_functions = (
 360         'alloca',                       'malloc',
 361         'CFS_ATOMIC_INIT',              'ATOMIC_INIT',
 362         'cfs_atomic_add',               'atomic_add',
 363         'cfs_atomic_add_return',        'atomic_add_return',
 364         'cfs_atomic_add_unless',        'atomic_add_unless',
 365         'cfs_atomic_cmpxchg',           'atomic_cmpxchg',
 366         'cfs_atomic_dec',               'atomic_dec',
 367         'cfs_atomic_dec_and_lock',      'atomic_dec_and_lock',
 368         'cfs_atomic_dec_and_test',      'atomic_dec_and_test',
 369         'cfs_atomic_dec_return',        'atomic_dec_return',
 370         'cfs_atomic_inc',               'atomic_inc',
 371         'cfs_atomic_inc_and_test',      'atomic_inc_and_test',
 372         'cfs_atomic_inc_not_zero',      'atomic_inc_not_zero',
 373         'cfs_atomic_inc_return',        'atomic_inc_return',
 374         'cfs_atomic_read',              'atomic_read',
 375         'cfs_atomic_set',               'atomic_set',
 376         'cfs_atomic_sub',               'atomic_sub',
 377         'cfs_atomic_sub_and_test',      'atomic_sub_and_test',
 378         'cfs_atomic_sub_return',        'atomic_sub_return',
 379         'cfs_atomic_t',                 'atomic_t',
 380
 381         'CFS_HLIST_HEAD',               'HLIST_HEAD',
 382         'CFS_HLIST_HEAD_INIT',          'HLIST_HEAD_INIT',
 383         'CFS_INIT_HLIST_HEAD',          'INIT_HLIST_HEAD',
 384         'CFS_INIT_HLIST_NODE',          'INIT_HLIST_NODE',
 385         'cfs_hlist_add_after',          'hlist_add_after',
 386         'cfs_hlist_add_before',         'hlist_add_before',
 387         'cfs_hlist_add_head',           'hlist_add_head',
 388         'cfs_hlist_del',                'hlist_del',
 389         'cfs_hlist_del_init',           'hlist_del_init',
 390         'cfs_hlist_empty',              'hlist_empty',
 391         'cfs_hlist_entry',              'hlist_entry',
 392         'cfs_hlist_for_each',           'hlist_for_each',
 393         'cfs_hlist_for_each_safe',      'hlist_for_each_safe',
 394         'cfs_hlist_head_t',             'struct hlist_head',
 395         'cfs_hlist_node_t',             'struct hlist_node',
 396         'cfs_hlist_unhashed',           'hlist_unhashed',
 397
 398         'cfs_inode_t',                  'struct inode',
 399
 400         'CFS_INIT_LIST_HEAD',           'INIT_LIST_HEAD',
 401         'CFS_LIST_HEAD',                'struct list_head foo = LIST_HEAD_INIT(foo);',
 402         'CFS_LIST_HEAD_INIT',           'LIST_HEAD_INIT',
 403         'cfs_list_add',                 'list_add',
 404         'cfs_list_add_tail',            'list_add_tail',
 405         'cfs_list_del',                 'list_del',
 406         'cfs_list_del_init',            'list_del_init',
 407         'cfs_list_empty',               'list_empty',
 408         'cfs_list_empty_careful',       'list_empty_careful',
 409         'cfs_list_entry',               'list_entry',
 410         'cfs_list_for_each',            'list_for_each',
 411         'cfs_list_for_each_entry',      'list_for_each_entry',
 412         'cfs_list_for_each_entry_continue',
 413                                         'list_for_each_entry_continue',
 414         'cfs_list_for_each_entry_reverse',
 415                                         'list_for_each_entry_reverse',
 416         'cfs_list_for_each_entry_safe',
 417                                         'list_for_each_entry_safe',
 418         'cfs_list_for_each_entry_safe_from',
 419                                         'list_for_each_entry_safe_from',
 420         'cfs_list_for_each_entry_safe_reverse',
 421                                         'list_for_each_entry_safe_reverse',
 422         'cfs_list_for_each_entry_safe_typed',
 423                                         'list_for_each_entry_safe_typed',
 424         'cfs_list_for_each_entry_typed',
 425                                         'list_for_each_entry_typed',
 426         'cfs_list_for_each_prev',       'list_for_each_prev',
 427         'cfs_list_for_each_safe',       'list_for_each_safe',
 428         'cfs_list_move',                'list_move',
 429         'cfs_list_move_tail',           'list_move_tail',
 430         'cfs_list_splice',              'list_splice',
 431         'cfs_list_splice_init',         'list_splice_init',
 432         'cfs_list_splice_tail',         'list_splice_tail',
 433         'cfs_list_t',                   'struct list_head',
 434
 435         'CFS_PAGE_MASK',                'PAGE_CACHE_MASK or PAGE_MASK',
 436         'CFS_PAGE_SIZE',                'PAGE_CACHE_SIZE or PAGE_SIZE',
 437
 438         'cfs_proc_dir_entry_t',         'struct proc_dir_entry',
 439
 440         'cfs_rcu_head_t',               'struct rcu_head',
 441
 442         'cfs_hash_lock_t',              'union cfs_hash_lock',
 443         'cfs_hash_bucket_t',            'struct cfs_hash_bucket',
 444         'cfs_hash_bd_t',                'struct cfs_hash_bd',
 445         'cfs_hash_t',                   'struct cfs_hash',
 446         'cfs_hash_lock_ops_t',          'struct cfs_hash_lock_ops',
 447         'cfs_hash_hlist_ops_t',         'struct cfs_hash_hlist_ops',
 448         'cfs_hash_ops_t',               'struct cfs_hash_ops',
 449         'cfs_hash_head_t',              'struct cfs_hash_head',
 450         'cfs_hash_head_dep_t',          'struct cfs_hash_head_dep',
 451         'cfs_hash_dhead_t',             'struct cfs_hash_dhead',
 452         'cfs_hash_dhead_dep_t',         'struct cfs_hash_dhead_dep',
 453         'cfs_hash_lookup_intent_t',     'enum cfs_hash_lookup_intent',
 454         'cfs_hash_cond_arg_t',          'struct cfs_hash_cond_arg',
 455
 456         'ldlm_appetite_t',              'enum ldlm_appetite',
 457         'ldlm_cancel_flags_t',          'enum ldlm_cancel_flags',
 458         'ldlm_error_t',                 'enum ldlm_error',
 459         'ldlm_ns_hash_def_t',           'struct ldlm_ns_hash_def',
 460         'ldlm_mode_t',                  'enum ldlm_mode',
 461         'ldlm_ns_type_t',               'enum ldlm_ns_type',
 462         'ldlm_policy_data_t',           'enum ldlm_policy_data',
 463         'ldlm_policy_res_t',            'enum ldlm_policy_res',
 464         'ldlm_side_t',                  'enum ldlm_side',
 465         'ldlm_type_t',                  'enum ldlm_type',
 466         'ldlm_wire_policy_data_t',      'union ldlm_wire_policy_data',
 467
 468         'LPROCFS',                      'CONFIG_PROC_FS',
 469         'mktemp',                       'mkstemp',
 470         'sprintf',                      'snprintf',
 471         'strcpy',                       'strncpy',
 472         'strcat',                       'strncat',
 473         'tempnam',                      'mkstemp',
 474         'f_dentry',                     'f_path.dentry',
 475         '= seq_printf',                 'seq_printf',
 476         'return seq_printf',            'seq_printf',
 477 );
 478
 479 my @rawlines = ();
 480 my @lines = ();
 481 my $vname;
 482 for my $filename (@ARGV) {
 483         my $FILE;
 484         if ($file) {
 485                 open($FILE, '-|', "diff -u /dev/null $filename") ||
 486                         die "$P: $filename: diff failed - $!\n";
 487         } elsif ($filename eq '-') {
 488                 open($FILE, '<&STDIN');
 489         } else {
 490                 open($FILE, '<', "$filename") ||
 491                         die "$P: $filename: open failed - $!\n";
 492         }
 493         if ($filename eq '-') {
 494                 $vname = 'Your patch';
 495         } else {
 496                 $vname = $filename;
 497         }
 498         while (<$FILE>) {
 499                 chomp;
 500                 push(@rawlines, $_);
 501         }
 502         close($FILE);
 503         if (!process($filename)) {
 504                 $exit = 1;
 505         }
 506         @rawlines = ();
 507         @lines = ();
 508 }
 509
 510 exit($exit);
 511
 512 sub top_of_kernel_tree {
 513         my ($root) = @_;
 514
 515         my @tree_check = (
 516                 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
 517                 "README", "Documentation", "arch", "include", "drivers",
 518                 "fs", "init", "ipc", "kernel", "lib", "scripts",
 519         );
 520
 521         foreach my $check (@tree_check) {
 522                 if (! -e $root . '/' . $check) {
 523                         return 0;
 524                 }
 525         }
 526         return 1;
 527     }
 528
 529 sub parse_email {
 530         my ($formatted_email) = @_;
 531
 532         my $name = "";
 533         my $address = "";
 534         my $comment = "";
 535
 536         if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
 537                 $name = $1;
 538                 $address = $2;
 539                 $comment = $3 if defined $3;
 540         } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
 541                 $address = $1;
 542                 $comment = $2 if defined $2;
 543         } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
 544                 $address = $1;
 545                 $comment = $2 if defined $2;
 546                 $formatted_email =~ s/$address.*$//;
 547                 $name = $formatted_email;
 548                 $name =~ s/^\s+|\s+$//g;
 549                 $name =~ s/^\"|\"$//g;
 550                 # If there's a name left after stripping spaces and
 551                 # leading quotes, and the address doesn't have both
 552                 # leading and trailing angle brackets, the address
 553                 # is invalid. ie:
 554                 #   "joe smith joe@smith.com" bad
 555                 #   "joe smith <joe@smith.com" bad
 556                 if ($name ne "" && $address !~ /^<[^>]+>$/) {
 557                         $name = "";
 558                         $address = "";
 559                         $comment = "";
 560                 }
 561         }
 562
 563         $name =~ s/^\s+|\s+$//g;
 564         $name =~ s/^\"|\"$//g;
 565         $address =~ s/^\s+|\s+$//g;
 566         $address =~ s/^\<|\>$//g;
 567
 568         if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
 569                 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
 570                 $name = "\"$name\"";
 571         }
 572
 573         return ($name, $address, $comment);
 574 }
 575
 576 sub format_email {
 577         my ($name, $address) = @_;
 578
 579         my $formatted_email;
 580
 581         $name =~ s/^\s+|\s+$//g;
 582         $name =~ s/^\"|\"$//g;
 583         $address =~ s/^\s+|\s+$//g;
 584
 585         if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
 586                 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
 587                 $name = "\"$name\"";
 588         }
 589
 590         if ("$name" eq "") {
 591                 $formatted_email = "$address";
 592         } else {
 593                 $formatted_email = "$name <$address>";
 594         }
 595
 596         return $formatted_email;
 597 }
 598
 599 sub which_conf {
 600         my ($conf) = @_;
 601
 602         foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
 603                 if (-e "$path/$conf") {
 604                         return "$path/$conf";
 605                 }
 606         }
 607
 608         return "";
 609 }
 610
 611 sub expand_tabs {
 612         my ($str) = @_;
 613
 614         my $res = '';
 615         my $n = 0;
 616         for my $c (split(//, $str)) {
 617                 if ($c eq "\t") {
 618                         $res .= ' ';
 619                         $n++;
 620                         for (; ($n % 8) != 0; $n++) {
 621                                 $res .= ' ';
 622                         }
 623                         next;
 624                 }
 625                 $res .= $c;
 626                 $n++;
 627         }
 628
 629         return $res;
 630 }
 631 sub copy_spacing {
 632         (my $res = shift) =~ tr/\t/ /c;
 633         return $res;
 634 }
 635
 636 sub line_stats {
 637         my ($line) = @_;
 638
 639         # Drop the diff line leader and expand tabs
 640         $line =~ s/^.//;
 641         $line = expand_tabs($line);
 642
 643         # Pick the indent from the front of the line.
 644         my ($white) = ($line =~ /^(\s*)/);
 645
 646         return (length($line), length($white));
 647 }
 648
 649 my $sanitise_quote = '';
 650
 651 sub sanitise_line_reset {
 652         my ($in_comment) = @_;
 653
 654         if ($in_comment) {
 655                 $sanitise_quote = '*/';
 656         } else {
 657                 $sanitise_quote = '';
 658         }
 659 }
 660 sub sanitise_line {
 661         my ($line) = @_;
 662
 663         my $res = '';
 664         my $l = '';
 665
 666         my $qlen = 0;
 667         my $off = 0;
 668         my $c;
 669
 670         # Always copy over the diff marker.
 671         $res = substr($line, 0, 1);
 672
 673         for ($off = 1; $off < length($line); $off++) {
 674                 $c = substr($line, $off, 1);
 675
 676                 # Comments we are wacking completly including the begin
 677                 # and end, all to $;.
 678                 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
 679                         $sanitise_quote = '*/';
 680
 681                         substr($res, $off, 2, "$;$;");
 682                         $off++;
 683                         next;
 684                 }
 685                 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
 686                         $sanitise_quote = '';
 687                         substr($res, $off, 2, "$;$;");
 688                         $off++;
 689                         next;
 690                 }
 691                 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
 692                         $sanitise_quote = '//';
 693
 694                         substr($res, $off, 2, $sanitise_quote);
 695                         $off++;
 696                         next;
 697                 }
 698
 699                 # A \ in a string means ignore the next character.
 700                 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
 701                     $c eq "\\") {
 702                         substr($res, $off, 2, 'XX');
 703                         $off++;
 704                         next;
 705                 }
 706                 # Regular quotes.
 707                 if ($c eq "'" || $c eq '"') {
 708                         if ($sanitise_quote eq '') {
 709                                 $sanitise_quote = $c;
 710
 711                                 substr($res, $off, 1, $c);
 712                                 next;
 713                         } elsif ($sanitise_quote eq $c) {
 714                                 $sanitise_quote = '';
 715                         }
 716                 }
 717
 718                 #print "c<$c> SQ<$sanitise_quote>\n";
 719                 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
 720                         substr($res, $off, 1, $;);
 721                 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
 722                         substr($res, $off, 1, $;);
 723                 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
 724                         substr($res, $off, 1, 'X');
 725                 } else {
 726                         substr($res, $off, 1, $c);
 727                 }
 728         }
 729
 730         if ($sanitise_quote eq '//') {
 731                 $sanitise_quote = '';
 732         }
 733
 734         # The pathname on a #include may be surrounded by '<' and '>'.
 735         if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
 736                 my $clean = 'X' x length($1);
 737                 $res =~ s@\<.*\>@<$clean>@;
 738
 739         # The whole of a #error is a string.
 740         } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
 741                 my $clean = 'X' x length($1);
 742                 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
 743         }
 744
 745         return $res;
 746 }
 747
 748 sub ctx_statement_block {
 749         my ($linenr, $remain, $off) = @_;
 750         my $line = $linenr - 1;
 751         my $blk = '';
 752         my $soff = $off;
 753         my $coff = $off - 1;
 754         my $coff_set = 0;
 755
 756         my $loff = 0;
 757
 758         my $type = '';
 759         my $level = 0;
 760         my @stack = ();
 761         my $p;
 762         my $c;
 763         my $len = 0;
 764
 765         my $remainder;
 766         while (1) {
 767                 @stack = (['', 0]) if ($#stack == -1);
 768
 769                 #warn "CSB: blk<$blk> remain<$remain>\n";
 770                 # If we are about to drop off the end, pull in more
 771                 # context.
 772                 if ($off >= $len) {
 773                         for (; $remain > 0; $line++) {
 774                                 last if (!defined $lines[$line]);
 775                                 next if ($lines[$line] =~ /^-/);
 776                                 $remain--;
 777                                 $loff = $len;
 778                                 $blk .= $lines[$line] . "\n";
 779                                 $len = length($blk);
 780                                 $line++;
 781                                 last;
 782                         }
 783                         # Bail if there is no further context.
 784                         #warn "CSB: blk<$blk> off<$off> len<$len>\n";
 785                         if ($off >= $len) {
 786                                 last;
 787                         }
 788                         if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
 789                                 $level++;
 790                                 $type = '#';
 791                         }
 792                 }
 793                 $p = $c;
 794                 $c = substr($blk, $off, 1);
 795                 $remainder = substr($blk, $off);
 796
 797                 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
 798
 799                 # Handle nested #if/#else.
 800                 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
 801                         push(@stack, [ $type, $level ]);
 802                 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
 803                         ($type, $level) = @{$stack[$#stack - 1]};
 804                 } elsif ($remainder =~ /^#\s*endif\b/) {
 805                         ($type, $level) = @{pop(@stack)};
 806                 }
 807
 808                 # Statement ends at the ';' or a close '}' at the
 809                 # outermost level.
 810                 if ($level == 0 && $c eq ';') {
 811                         last;
 812                 }
 813
 814                 # An else is really a conditional as long as its not else if
 815                 if ($level == 0 && $coff_set == 0 &&
 816                                 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
 817                                 $remainder =~ /^(else)(?:\s|{)/ &&
 818                                 $remainder !~ /^else\s+if\b/) {
 819                         $coff = $off + length($1) - 1;
 820                         $coff_set = 1;
 821                         #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
 822                         #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
 823                 }
 824
 825                 if (($type eq '' || $type eq '(') && $c eq '(') {
 826                         $level++;
 827                         $type = '(';
 828                 }
 829                 if ($type eq '(' && $c eq ')') {
 830                         $level--;
 831                         $type = ($level != 0)? '(' : '';
 832
 833                         if ($level == 0 && $coff < $soff) {
 834                                 $coff = $off;
 835                                 $coff_set = 1;
 836                                 #warn "CSB: mark coff<$coff>\n";
 837                         }
 838                 }
 839                 if (($type eq '' || $type eq '{') && $c eq '{') {
 840                         $level++;
 841                         $type = '{';
 842                 }
 843                 if ($type eq '{' && $c eq '}') {
 844                         $level--;
 845                         $type = ($level != 0)? '{' : '';
 846
 847                         if ($level == 0) {
 848                                 if (substr($blk, $off + 1, 1) eq ';') {
 849                                         $off++;
 850                                 }
 851                                 last;
 852                         }
 853                 }
 854                 # Preprocessor commands end at the newline unless escaped.
 855                 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
 856                         $level--;
 857                         $type = '';
 858                         $off++;
 859                         last;
 860                 }
 861                 $off++;
 862         }
 863         # We are truly at the end, so shuffle to the next line.
 864         if ($off == $len) {
 865                 $loff = $len + 1;
 866                 $line++;
 867                 $remain--;
 868         }
 869
 870         my $statement = substr($blk, $soff, $off - $soff + 1);
 871         my $condition = substr($blk, $soff, $coff - $soff + 1);
 872
 873         #warn "STATEMENT<$statement>\n";
 874         #warn "CONDITION<$condition>\n";
 875
 876         #print "coff<$coff> soff<$off> loff<$loff>\n";
 877
 878         return ($statement, $condition,
 879                         $line, $remain + 1, $off - $loff + 1, $level);
 880 }
 881
 882 sub statement_lines {
 883         my ($stmt) = @_;
 884
 885         # Strip the diff line prefixes and rip blank lines at start and end.
 886         $stmt =~ s/(^|\n)./$1/g;
 887         $stmt =~ s/^\s*//;
 888         $stmt =~ s/\s*$//;
 889
 890         my @stmt_lines = ($stmt =~ /\n/g);
 891
 892         return $#stmt_lines + 2;
 893 }
 894
 895 sub statement_rawlines {
 896         my ($stmt) = @_;
 897
 898         my @stmt_lines = ($stmt =~ /\n/g);
 899
 900         return $#stmt_lines + 2;
 901 }
 902
 903 sub statement_block_size {
 904         my ($stmt) = @_;
 905
 906         $stmt =~ s/(^|\n)./$1/g;
 907         $stmt =~ s/^\s*{//;
 908         $stmt =~ s/}\s*$//;
 909         $stmt =~ s/^\s*//;
 910         $stmt =~ s/\s*$//;
 911
 912         my @stmt_lines = ($stmt =~ /\n/g);
 913         my @stmt_statements = ($stmt =~ /;/g);
 914
 915         my $stmt_lines = $#stmt_lines + 2;
 916         my $stmt_statements = $#stmt_statements + 1;
 917
 918         if ($stmt_lines > $stmt_statements) {
 919                 return $stmt_lines;
 920         } else {
 921                 return $stmt_statements;
 922         }
 923 }
 924
 925 sub ctx_statement_full {
 926         my ($linenr, $remain, $off) = @_;
 927         my ($statement, $condition, $level);
 928
 929         my (@chunks);
 930
 931         # Grab the first conditional/block pair.
 932         ($statement, $condition, $linenr, $remain, $off, $level) =
 933                                 ctx_statement_block($linenr, $remain, $off);
 934         #print "F: c<$condition> s<$statement> remain<$remain>\n";
 935         push(@chunks, [ $condition, $statement ]);
 936         if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
 937                 return ($level, $linenr, @chunks);
 938         }
 939
 940         # Pull in the following conditional/block pairs and see if they
 941         # could continue the statement.
 942         for (;;) {
 943                 ($statement, $condition, $linenr, $remain, $off, $level) =
 944                                 ctx_statement_block($linenr, $remain, $off);
 945                 #print "C: c<$condition> s<$statement> remain<$remain>\n";
 946                 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
 947                 #print "C: push\n";
 948                 push(@chunks, [ $condition, $statement ]);
 949         }
 950
 951         return ($level, $linenr, @chunks);
 952 }
 953
 954 sub ctx_block_get {
 955         my ($linenr, $remain, $outer, $open, $close, $off) = @_;
 956         my $line;
 957         my $start = $linenr - 1;
 958         my $blk = '';
 959         my @o;
 960         my @c;
 961         my @res = ();
 962
 963         my $level = 0;
 964         my @stack = ($level);
 965         for ($line = $start; $remain > 0; $line++) {
 966                 next if ($rawlines[$line] =~ /^-/);
 967                 $remain--;
 968
 969                 $blk .= $rawlines[$line];
 970
 971                 # Handle nested #if/#else.
 972                 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
 973                         push(@stack, $level);
 974                 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
 975                         $level = $stack[$#stack - 1];
 976                 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
 977                         $level = pop(@stack);
 978                 }
 979
 980                 foreach my $c (split(//, $lines[$line])) {
 981                         ##print "C<$c>L<$level><$open$close>O<$off>\n";
 982                         if ($off > 0) {
 983                                 $off--;
 984                                 next;
 985                         }
 986
 987                         if ($c eq $close && $level > 0) {
 988                                 $level--;
 989                                 last if ($level == 0);
 990                         } elsif ($c eq $open) {
 991                                 $level++;
 992                         }
 993                 }
 994
 995                 if (!$outer || $level <= 1) {
 996                         push(@res, $rawlines[$line]);
 997                 }
 998
 999                 last if ($level == 0);
1000         }
1001
1002         return ($level, @res);
1003 }
1004 sub ctx_block_outer {
1005         my ($linenr, $remain) = @_;
1006
1007         my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1008         return @r;
1009 }
1010 sub ctx_block {
1011         my ($linenr, $remain) = @_;
1012
1013         my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1014         return @r;
1015 }
1016 sub ctx_statement {
1017         my ($linenr, $remain, $off) = @_;
1018
1019         my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1020         return @r;
1021 }
1022 sub ctx_block_level {
1023         my ($linenr, $remain) = @_;
1024
1025         return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1026 }
1027 sub ctx_statement_level {
1028         my ($linenr, $remain, $off) = @_;
1029
1030         return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1031 }
1032
1033 sub ctx_locate_comment {
1034         my ($first_line, $end_line) = @_;
1035
1036         # Catch a comment on the end of the line itself.
1037         my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1038         return $current_comment if (defined $current_comment);
1039
1040         # Look through the context and try and figure out if there is a
1041         # comment.
1042         my $in_comment = 0;
1043         $current_comment = '';
1044         for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1045                 my $line = $rawlines[$linenr - 1];
1046                 #warn "           $line\n";
1047                 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1048                         $in_comment = 1;
1049                 }
1050                 if ($line =~ m@/\*@) {
1051                         $in_comment = 1;
1052                 }
1053                 if (!$in_comment && $current_comment ne '') {
1054                         $current_comment = '';
1055                 }
1056                 $current_comment .= $line . "\n" if ($in_comment);
1057                 if ($line =~ m@\*/@) {
1058                         $in_comment = 0;
1059                 }
1060         }
1061
1062         chomp($current_comment);
1063         return($current_comment);
1064 }
1065 sub ctx_has_comment {
1066         my ($first_line, $end_line) = @_;
1067         my $cmt = ctx_locate_comment($first_line, $end_line);
1068
1069         ##print "LINE: $rawlines[$end_line - 1 ]\n";
1070         ##print "CMMT: $cmt\n";
1071
1072         return ($cmt ne '');
1073 }
1074
1075 sub raw_line {
1076         my ($linenr, $cnt) = @_;
1077
1078         my $offset = $linenr - 1;
1079         $cnt++;
1080
1081         my $line;
1082         while ($cnt) {
1083                 $line = $rawlines[$offset++];
1084                 next if (defined($line) && $line =~ /^-/);
1085                 $cnt--;
1086         }
1087
1088         return $line;
1089 }
1090
1091 sub cat_vet {
1092         my ($vet) = @_;
1093         my ($res, $coded);
1094
1095         $res = '';
1096         while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1097                 $res .= $1;
1098                 if ($2 ne '') {
1099                         $coded = sprintf("^%c", unpack('C', $2) + 64);
1100                         $res .= $coded;
1101                 }
1102         }
1103         $res =~ s/$/\$/;
1104
1105         return $res;
1106 }
1107
1108 my $av_preprocessor = 0;
1109 my $av_pending;
1110 my @av_paren_type;
1111 my $av_pend_colon;
1112
1113 sub annotate_reset {
1114         $av_preprocessor = 0;
1115         $av_pending = '_';
1116         @av_paren_type = ('E');
1117         $av_pend_colon = 'O';
1118 }
1119
1120 sub annotate_values {
1121         my ($stream, $type) = @_;
1122
1123         my $res;
1124         my $var = '_' x length($stream);
1125         my $cur = $stream;
1126
1127         print "$stream\n" if ($dbg_values > 1);
1128
1129         while (length($cur)) {
1130                 @av_paren_type = ('E') if ($#av_paren_type < 0);
1131                 print " <" . join('', @av_paren_type) .
1132                                 "> <$type> <$av_pending>" if ($dbg_values > 1);
1133                 if ($cur =~ /^(\s+)/o) {
1134                         print "WS($1)\n" if ($dbg_values > 1);
1135                         if ($1 =~ /\n/ && $av_preprocessor) {
1136                                 $type = pop(@av_paren_type);
1137                                 $av_preprocessor = 0;
1138                         }
1139
1140                 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1141                         print "CAST($1)\n" if ($dbg_values > 1);
1142                         push(@av_paren_type, $type);
1143                         $type = 'c';
1144
1145                 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1146                         print "DECLARE($1)\n" if ($dbg_values > 1);
1147                         $type = 'T';
1148
1149                 } elsif ($cur =~ /^($Modifier)\s*/) {
1150                         print "MODIFIER($1)\n" if ($dbg_values > 1);
1151                         $type = 'T';
1152
1153                 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1154                         print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1155                         $av_preprocessor = 1;
1156                         push(@av_paren_type, $type);
1157                         if ($2 ne '') {
1158                                 $av_pending = 'N';
1159                         }
1160                         $type = 'E';
1161
1162                 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1163                         print "UNDEF($1)\n" if ($dbg_values > 1);
1164                         $av_preprocessor = 1;
1165                         push(@av_paren_type, $type);
1166
1167                 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1168                         print "PRE_START($1)\n" if ($dbg_values > 1);
1169                         $av_preprocessor = 1;
1170
1171                         push(@av_paren_type, $type);
1172                         push(@av_paren_type, $type);
1173                         $type = 'E';
1174
1175                 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1176                         print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1177                         $av_preprocessor = 1;
1178
1179                         push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1180
1181                         $type = 'E';
1182
1183                 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1184                         print "PRE_END($1)\n" if ($dbg_values > 1);
1185
1186                         $av_preprocessor = 1;
1187
1188                         # Assume all arms of the conditional end as this
1189                         # one does, and continue as if the #endif was not here.
1190                         pop(@av_paren_type);
1191                         push(@av_paren_type, $type);
1192                         $type = 'E';
1193
1194                 } elsif ($cur =~ /^(\\\n)/o) {
1195                         print "PRECONT($1)\n" if ($dbg_values > 1);
1196
1197                 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1198                         print "ATTR($1)\n" if ($dbg_values > 1);
1199                         $av_pending = $type;
1200                         $type = 'N';
1201
1202                 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1203                         print "SIZEOF($1)\n" if ($dbg_values > 1);
1204                         if (defined $2) {
1205                                 $av_pending = 'V';
1206                         }
1207                         $type = 'N';
1208
1209                 } elsif ($cur =~ /^(if|while|for)\b/o) {
1210                         print "COND($1)\n" if ($dbg_values > 1);
1211                         $av_pending = 'E';
1212                         $type = 'N';
1213
1214                 } elsif ($cur =~/^(case)/o) {
1215                         print "CASE($1)\n" if ($dbg_values > 1);
1216                         $av_pend_colon = 'C';
1217                         $type = 'N';
1218
1219                 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1220                         print "KEYWORD($1)\n" if ($dbg_values > 1);
1221                         $type = 'N';
1222
1223                 } elsif ($cur =~ /^(\()/o) {
1224                         print "PAREN('$1')\n" if ($dbg_values > 1);
1225                         push(@av_paren_type, $av_pending);
1226                         $av_pending = '_';
1227                         $type = 'N';
1228
1229                 } elsif ($cur =~ /^(\))/o) {
1230                         my $new_type = pop(@av_paren_type);
1231                         if ($new_type ne '_') {
1232                                 $type = $new_type;
1233                                 print "PAREN('$1') -> $type\n"
1234                                                         if ($dbg_values > 1);
1235                         } else {
1236                                 print "PAREN('$1')\n" if ($dbg_values > 1);
1237                         }
1238
1239                 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1240                         print "FUNC($1)\n" if ($dbg_values > 1);
1241                         $type = 'V';
1242                         $av_pending = 'V';
1243
1244                 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1245                         if (defined $2 && $type eq 'C' || $type eq 'T') {
1246                                 $av_pend_colon = 'B';
1247                         } elsif ($type eq 'E') {
1248                                 $av_pend_colon = 'L';
1249                         }
1250                         print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1251                         $type = 'V';
1252
1253                 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1254                         print "IDENT($1)\n" if ($dbg_values > 1);
1255                         $type = 'V';
1256
1257                 } elsif ($cur =~ /^($Assignment)/o) {
1258                         print "ASSIGN($1)\n" if ($dbg_values > 1);
1259                         $type = 'N';
1260
1261                 } elsif ($cur =~/^(;|{|})/) {
1262                         print "END($1)\n" if ($dbg_values > 1);
1263                         $type = 'E';
1264                         $av_pend_colon = 'O';
1265
1266                 } elsif ($cur =~/^(,)/) {
1267                         print "COMMA($1)\n" if ($dbg_values > 1);
1268                         $type = 'C';
1269
1270                 } elsif ($cur =~ /^(\?)/o) {
1271                         print "QUESTION($1)\n" if ($dbg_values > 1);
1272                         $type = 'N';
1273
1274                 } elsif ($cur =~ /^(:)/o) {
1275                         print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1276
1277                         substr($var, length($res), 1, $av_pend_colon);
1278                         if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1279                                 $type = 'E';
1280                         } else {
1281                                 $type = 'N';
1282                         }
1283                         $av_pend_colon = 'O';
1284
1285                 } elsif ($cur =~ /^(\[)/o) {
1286                         print "CLOSE($1)\n" if ($dbg_values > 1);
1287                         $type = 'N';
1288
1289                 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1290                         my $variant;
1291
1292                         print "OPV($1)\n" if ($dbg_values > 1);
1293                         if ($type eq 'V') {
1294                                 $variant = 'B';
1295                         } else {
1296                                 $variant = 'U';
1297                         }
1298
1299                         substr($var, length($res), 1, $variant);
1300                         $type = 'N';
1301
1302                 } elsif ($cur =~ /^($Operators)/o) {
1303                         print "OP($1)\n" if ($dbg_values > 1);
1304                         if ($1 ne '++' && $1 ne '--') {
1305                                 $type = 'N';
1306                         }
1307
1308                 } elsif ($cur =~ /(^.)/o) {
1309                         print "C($1)\n" if ($dbg_values > 1);
1310                 }
1311                 if (defined $1) {
1312                         $cur = substr($cur, length($1));
1313                         $res .= $type x length($1);
1314                 }
1315         }
1316
1317         return ($res, $var);
1318 }
1319
1320 sub possible {
1321         my ($possible, $line) = @_;
1322         my $notPermitted = qr{(?:
1323                 ^(?:
1324                         $Modifier|
1325                         $Storage|
1326                         $Type|
1327                         DEFINE_\S+
1328                 )$|
1329                 ^(?:
1330                         goto|
1331                         return|
1332                         case|
1333                         else|
1334                         asm|__asm__|
1335                         do|
1336                         \#|
1337                         \#\#|
1338                 )(?:\s|$)|
1339                 ^(?:typedef|struct|enum)\b
1340             )}x;
1341         warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1342         if ($possible !~ $notPermitted) {
1343                 # Check for modifiers.
1344                 $possible =~ s/\s*$Storage\s*//g;
1345                 $possible =~ s/\s*$Sparse\s*//g;
1346                 if ($possible =~ /^\s*$/) {
1347
1348                 } elsif ($possible =~ /\s/) {
1349                         $possible =~ s/\s*$Type\s*//g;
1350                         for my $modifier (split(' ', $possible)) {
1351                                 if ($modifier !~ $notPermitted) {
1352                                         warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1353                                         push(@modifierList, $modifier);
1354                                 }
1355                         }
1356
1357                 } else {
1358                         warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1359                         push(@typeList, $possible);
1360                 }
1361                 build_types();
1362         } else {
1363                 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1364         }
1365 }
1366
1367 my $prefix = '';
1368
1369 sub show_type {
1370        return !defined $ignore_type{$_[0]};
1371 }
1372
1373 sub report {
1374         if (!show_type($_[1]) ||
1375             (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) {
1376                 return 0;
1377         }
1378         my $line;
1379         if ($show_types) {
1380                 $line = "$prefix$_[0]:$_[1]: $_[2]\n";
1381         } else {
1382                 $line = "$prefix$_[0]: $_[2]\n";
1383         }
1384         $line = (split('\n', $line))[0] . "\n" if ($terse);
1385
1386         push(our @report, $line);
1387
1388         return 1;
1389 }
1390 sub report_dump {
1391         our @report;
1392 }
1393
1394 sub ERROR {
1395         if (report("ERROR", $_[0], $_[1])) {
1396                 our $clean = 0;
1397                 our $cnt_error++;
1398         }
1399 }
1400 sub WARN {
1401         if (report("WARNING", $_[0], $_[1])) {
1402                 our $clean = 0;
1403                 our $cnt_warn++;
1404         }
1405 }
1406 sub CHK {
1407         if ($check && report("CHECK", $_[0], $_[1])) {
1408                 our $clean = 0;
1409                 our $cnt_chk++;
1410         }
1411 }
1412
1413 sub check_absolute_file {
1414         my ($absolute, $herecurr) = @_;
1415         my $file = $absolute;
1416
1417         ##print "absolute<$absolute>\n";
1418
1419         # See if any suffix of this path is a path within the tree.
1420         while ($file =~ s@^[^/]*/@@) {
1421                 if (-f "$root/$file") {
1422                         ##print "file<$file>\n";
1423                         last;
1424                 }
1425         }
1426         if (! -f _)  {
1427                 return 0;
1428         }
1429
1430         # It is, so see if the prefix is acceptable.
1431         my $prefix = $absolute;
1432         substr($prefix, -length($file)) = '';
1433
1434         ##print "prefix<$prefix>\n";
1435         if ($prefix ne ".../") {
1436                 WARN("USE_RELATIVE_PATH",
1437                      "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1438         }
1439 }
1440
1441 sub process {
1442         my $filename = shift;
1443
1444         my $linenr=0;
1445         my $prevline="";
1446         my $prevrawline="";
1447         my $stashline="";
1448         my $stashrawline="";
1449
1450         my $length;
1451         my $indent;
1452         my $previndent=0;
1453         my $stashindent=0;
1454
1455         our $clean = 1;
1456         my $signoff = 0;
1457         my $is_patch = 0;
1458
1459         my $in_header_lines = 1;
1460         my $in_commit_log = 0;          #Scanning lines before patch
1461
1462         our @report = ();
1463         our $cnt_lines = 0;
1464         our $cnt_error = 0;
1465         our $cnt_warn = 0;
1466         our $cnt_chk = 0;
1467
1468         # Trace the real file/line as we go.
1469         my $realfile = '';
1470         my $realline = 0;
1471         my $realcnt = 0;
1472         my $here = '';
1473         my $in_comment = 0;
1474         my $comment_edge = 0;
1475         my $first_line = 0;
1476         my $p1_prefix = '';
1477
1478         my $prev_values = 'E';
1479
1480         # suppression flags
1481         my %suppress_ifbraces;
1482         my %suppress_whiletrailers;
1483         my %suppress_export;
1484         my $suppress_statement = 0;
1485
1486         # Pre-scan the patch sanitizing the lines.
1487         # Pre-scan the patch looking for any __setup documentation.
1488         #
1489         my @setup_docs = ();
1490         my $setup_docs = 0;
1491
1492         sanitise_line_reset();
1493         my $line;
1494         foreach my $rawline (@rawlines) {
1495                 $linenr++;
1496                 $line = $rawline;
1497
1498                 if ($rawline=~/^\+\+\+\s+(\S+)/) {
1499                         $setup_docs = 0;
1500                         if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1501                                 $setup_docs = 1;
1502                         }
1503                         #next;
1504                 }
1505                 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1506                         $realline=$1-1;
1507                         if (defined $2) {
1508                                 $realcnt=$3+1;
1509                         } else {
1510                                 $realcnt=1+1;
1511                         }
1512                         $in_comment = 0;
1513
1514                         # Guestimate if this is a continuing comment.  Run
1515                         # the context looking for a comment "edge".  If this
1516                         # edge is a close comment then we must be in a comment
1517                         # at context start.
1518                         my $edge;
1519                         my $cnt = $realcnt;
1520                         for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1521                                 next if (defined $rawlines[$ln - 1] &&
1522                                          $rawlines[$ln - 1] =~ /^-/);
1523                                 $cnt--;
1524                                 #print "RAW<$rawlines[$ln - 1]>\n";
1525                                 last if (!defined $rawlines[$ln - 1]);
1526                                 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1527                                     $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1528                                         ($edge) = $1;
1529                                         last;
1530                                 }
1531                         }
1532                         if (defined $edge && $edge eq '*/') {
1533                                 $in_comment = 1;
1534                         }
1535
1536                         # Guestimate if this is a continuing comment.  If this
1537                         # is the start of a diff block and this line starts
1538                         # ' *' then it is very likely a comment.
1539                         if (!defined $edge &&
1540                             $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1541                         {
1542                                 $in_comment = 1;
1543                         }
1544
1545                         ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1546                         sanitise_line_reset($in_comment);
1547
1548                 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1549                         # Standardise the strings and chars within the input to
1550                         # simplify matching -- only bother with positive lines.
1551                         $line = sanitise_line($rawline);
1552                 }
1553                 push(@lines, $line);
1554
1555                 if ($realcnt > 1) {
1556                         $realcnt-- if ($line =~ /^(?:\+| |$)/);
1557                 } else {
1558                         $realcnt = 0;
1559                 }
1560
1561                 #print "==>$rawline\n";
1562                 #print "-->$line\n";
1563
1564                 if ($setup_docs && $line =~ /^\+/) {
1565                         push(@setup_docs, $line);
1566                 }
1567         }
1568
1569         $prefix = '';
1570
1571         $realcnt = 0;
1572         $linenr = 0;
1573         foreach my $line (@lines) {
1574                 $linenr++;
1575
1576                 my $rawline = $rawlines[$linenr - 1];
1577
1578 #extract the line range in the file after the patch is applied
1579                 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1580                         $is_patch = 1;
1581                         $first_line = $linenr + 1;
1582                         $realline=$1-1;
1583                         if (defined $2) {
1584                                 $realcnt=$3+1;
1585                         } else {
1586                                 $realcnt=1+1;
1587                         }
1588                         annotate_reset();
1589                         $prev_values = 'E';
1590
1591                         %suppress_ifbraces = ();
1592                         %suppress_whiletrailers = ();
1593                         %suppress_export = ();
1594                         $suppress_statement = 0;
1595                         next;
1596
1597 # track the line number as we move through the hunk, note that
1598 # new versions of GNU diff omit the leading space on completely
1599 # blank context lines so we need to count that too.
1600                 } elsif ($line =~ /^( |\+|$)/) {
1601                         $realline++;
1602                         $realcnt-- if ($realcnt != 0);
1603
1604                         # Measure the line length and indent.
1605                         ($length, $indent) = line_stats($rawline);
1606
1607                         # Track the previous line.
1608                         ($prevline, $stashline) = ($stashline, $line);
1609                         ($previndent, $stashindent) = ($stashindent, $indent);
1610                         ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1611
1612                         #warn "line<$line>\n";
1613
1614                 } elsif ($realcnt == 1) {
1615                         $realcnt--;
1616                 }
1617
1618                 my $hunk_line = ($realcnt != 0);
1619
1620 #make up the handle for any error we report on this line
1621                 $prefix = "$filename:$realline: " if ($emacs && $file);
1622                 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1623
1624                 $here = "#$linenr: " if (!$file);
1625                 $here = "#$realline: " if ($file);
1626
1627                 # extract the filename as it passes
1628                 if ($line =~ /^diff --git.*?(\S+)$/) {
1629                         $realfile = $1;
1630                         $realfile =~ s@^([^/]*)/@@;
1631                         $in_commit_log = 0;
1632                 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
1633                         $realfile = $1;
1634                         $realfile =~ s@^([^/]*)/@@;
1635                         $in_commit_log = 0;
1636
1637                         $p1_prefix = $1;
1638                         if (!$file && $tree && $p1_prefix ne '' &&
1639                             -e "$root/$p1_prefix") {
1640                                 WARN("PATCH_PREFIX",
1641                                      "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1642                         }
1643
1644                         if ($realfile =~ m@^include/asm/@) {
1645                                 ERROR("MODIFIED_INCLUDE_ASM",
1646                                       "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1647                         }
1648                         next;
1649                 }
1650
1651                 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
1652
1653                 my $hereline = "$here\n$rawline\n";
1654                 my $herecurr = "$here\n$rawline\n";
1655                 my $hereprev = "$here\n$prevrawline\n$rawline\n";
1656
1657                 $cnt_lines++ if ($realcnt != 0);
1658
1659 # Check for incorrect file permissions
1660                 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1661                         my $permhere = $here . "FILE: $realfile\n";
1662                         if ($realfile =~ /(Makefile|Kconfig|\.c|\.h|\.S|\.tmpl)$/) {
1663                                 ERROR("EXECUTE_PERMISSIONS",
1664                                       "do not set execute permissions for source files\n" . $permhere);
1665                         }
1666                 }
1667
1668 # Check the patch for a signoff:
1669                 if ($line =~ /^\s*signed-off-by:/i) {
1670                         $signoff++;
1671                         $in_commit_log = 0;
1672                 }
1673
1674 # Check signature styles
1675                 if (!$in_header_lines &&
1676                     $line =~ /^(\s*)($signature_tags)(\s*)(.*)/) {
1677                         my $space_before = $1;
1678                         my $sign_off = $2;
1679                         my $space_after = $3;
1680                         my $email = $4;
1681                         my $ucfirst_sign_off = ucfirst(lc($sign_off));
1682
1683                         if (defined $space_before && $space_before ne "") {
1684                                 WARN("BAD_SIGN_OFF",
1685                                      "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr);
1686                         }
1687                         if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
1688                                 WARN("BAD_SIGN_OFF",
1689                                      "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr);
1690                         }
1691                         if (!defined $space_after || $space_after ne " ") {
1692                                 WARN("BAD_SIGN_OFF",
1693                                      "Use a single space after $ucfirst_sign_off\n" . $herecurr);
1694                         }
1695
1696                         my ($email_name, $email_address, $comment) = parse_email($email);
1697                         my $suggested_email = format_email(($email_name, $email_address));
1698                         if ($suggested_email eq "") {
1699                                 ERROR("BAD_SIGN_OFF",
1700                                       "Unrecognized email address: '$email'\n" . $herecurr);
1701                         } else {
1702                                 my $dequoted = $suggested_email;
1703                                 $dequoted =~ s/^"//;
1704                                 $dequoted =~ s/" </ </;
1705                                 # Don't force email to have quotes
1706                                 # Allow just an angle bracketed address
1707                                 if ("$dequoted$comment" ne $email &&
1708                                     "<$email_address>$comment" ne $email &&
1709                                     "$suggested_email$comment" ne $email) {
1710                                         WARN("BAD_SIGN_OFF",
1711                                              "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
1712                                 }
1713                         }
1714                 }
1715
1716 # Check for wrappage within a valid hunk of the file
1717                 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1718                         ERROR("CORRUPTED_PATCH",
1719                               "patch seems to be corrupt (line wrapped?)\n" .
1720                                 $herecurr) if (!$emitted_corrupt++);
1721                 }
1722
1723 # Check for absolute kernel paths.
1724                 if ($tree) {
1725                         while ($line =~ m{(?:^|\s)(/\S*)}g) {
1726                                 my $file = $1;
1727
1728                                 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1729                                     check_absolute_file($1, $herecurr)) {
1730                                         #
1731                                 } else {
1732                                         check_absolute_file($file, $herecurr);
1733                                 }
1734                         }
1735                 }
1736
1737 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1738                 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1739                     $rawline !~ m/^$UTF8*$/) {
1740                         my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1741
1742                         my $blank = copy_spacing($rawline);
1743                         my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1744                         my $hereptr = "$hereline$ptr\n";
1745
1746                         CHK("INVALID_UTF8",
1747                             "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1748                 }
1749
1750 # Check if it's the start of a commit log
1751 # (not a header line and we haven't seen the patch filename)
1752                 if ($in_header_lines && $realfile =~ /^$/ &&
1753                     $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
1754                         $in_header_lines = 0;
1755                         $in_commit_log = 1;
1756                 }
1757
1758 # Still not yet in a patch, check for any UTF-8
1759                 if ($in_commit_log && $realfile =~ /^$/ &&
1760                     $rawline =~ /$NON_ASCII_UTF8/) {
1761                         CHK("UTF8_BEFORE_PATCH",
1762                             "8-bit UTF-8 used in possible commit log\n" . $herecurr);
1763                 }
1764
1765 # ignore non-hunk lines and lines being removed
1766                 next if (!$hunk_line || $line =~ /^-/);
1767
1768 #trailing whitespace
1769                 if ($line =~ /^\+.*\015/) {
1770                         my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1771                         ERROR("DOS_LINE_ENDINGS",
1772                               "DOS line endings\n" . $herevet);
1773
1774                 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1775                         my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1776                         ERROR("TRAILING_WHITESPACE",
1777                               "trailing whitespace\n" . $herevet);
1778                         $rpt_cleaners = 1;
1779                 }
1780
1781 # check for Kconfig help text having a real description
1782 # Only applies when adding the entry originally, after that we do not have
1783 # sufficient context to determine whether it is indeed long enough.
1784                 if ($realfile =~ /Kconfig/ &&
1785                     $line =~ /.\s*config\s+/) {
1786                         my $length = 0;
1787                         my $cnt = $realcnt;
1788                         my $ln = $linenr + 1;
1789                         my $f;
1790                         my $is_start = 0;
1791                         my $is_end = 0;
1792                         for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
1793                                 $f = $lines[$ln - 1];
1794                                 $cnt-- if ($lines[$ln - 1] !~ /^-/);
1795                                 $is_end = $lines[$ln - 1] =~ /^\+/;
1796
1797                                 next if ($f =~ /^-/);
1798
1799                                 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
1800                                         $is_start = 1;
1801                                 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
1802                                         $length = -1;
1803                                 }
1804
1805                                 $f =~ s/^.//;
1806                                 $f =~ s/#.*//;
1807                                 $f =~ s/^\s+//;
1808                                 next if ($f =~ /^$/);
1809                                 if ($f =~ /^\s*config\s/) {
1810                                         $is_end = 1;
1811                                         last;
1812                                 }
1813                                 $length++;
1814                         }
1815                         WARN("CONFIG_DESCRIPTION",
1816                              "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
1817                         #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
1818                 }
1819
1820                 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
1821                     ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
1822                         my $flag = $1;
1823                         my $replacement = {
1824                                 'EXTRA_AFLAGS' =>   'asflags-y',
1825                                 'EXTRA_CFLAGS' =>   'ccflags-y',
1826                                 'EXTRA_CPPFLAGS' => 'cppflags-y',
1827                                 'EXTRA_LDFLAGS' =>  'ldflags-y',
1828                         };
1829
1830                         WARN("DEPRECATED_VARIABLE",
1831                              "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
1832                 }
1833
1834 # check we are in a valid source file if not then ignore this hunk
1835                 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1836
1837 #80 column limit
1838                 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
1839                     $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1840                     !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
1841                     $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
1842                     $length > 80)
1843                 {
1844                         WARN("LONG_LINE",
1845                              "line over 80 characters\n" . $herecurr);
1846                 }
1847
1848 # check for spaces before a quoted newline
1849                 if ($rawline =~ /^.*\".*\s\\n/) {
1850                         WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
1851                              "unnecessary whitespace before a quoted newline\n" . $herecurr);
1852                 }
1853
1854 # check for adding lines without a newline.
1855                 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1856                         WARN("MISSING_EOF_NEWLINE",
1857                              "adding a line without newline at end of file\n" . $herecurr);
1858                 }
1859
1860 # Blackfin: use hi/lo macros
1861                 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
1862                         if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
1863                                 my $herevet = "$here\n" . cat_vet($line) . "\n";
1864                                 ERROR("LO_MACRO",
1865                                       "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
1866                         }
1867                         if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
1868                                 my $herevet = "$here\n" . cat_vet($line) . "\n";
1869                                 ERROR("HI_MACRO",
1870                                       "use the HI() macro, not (... >> 16)\n" . $herevet);
1871                         }
1872                 }
1873
1874 # check we are in a valid source file C, perl or bash script
1875 # if not then ignore this hunk
1876                 next if ($realfile !~ /\.(h|c|pl|sh)$/);
1877
1878 # at the beginning of a line any tabs must come first and anything
1879 # more than 8 must use tabs.
1880                 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1881                     $rawline =~ /^\+\s*        \s*/) {
1882                         my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1883                         ERROR("CODE_INDENT",
1884                               "code indent should use tabs where possible\n" . $herevet);
1885                         $rpt_cleaners = 1;
1886                 }
1887
1888 # check for space before tabs.
1889                 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
1890                         my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1891                         WARN("SPACE_BEFORE_TAB",
1892                              "please, no space before tabs\n" . $herevet);
1893                 }
1894
1895 # check for spaces at the beginning of a line.
1896 # Exceptions:
1897 #  1) within comments
1898 #  2) indented preprocessor commands
1899 #  3) hanging labels
1900                 if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/)  {
1901                         my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1902                         WARN("LEADING_SPACE",
1903                              "please, no spaces at the start of a line\n" . $herevet);
1904                 }
1905
1906 # check we are in a valid C source file if not then ignore this hunk
1907                 next if ($realfile !~ /\.(h|c)$/);
1908
1909 # check for RCS/CVS revision markers
1910                 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
1911                         WARN("CVS_KEYWORD",
1912                              "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1913                 }
1914
1915 # Blackfin: don't use __builtin_bfin_[cs]sync
1916                 if ($line =~ /__builtin_bfin_csync/) {
1917                         my $herevet = "$here\n" . cat_vet($line) . "\n";
1918                         ERROR("CSYNC",
1919                               "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
1920                 }
1921                 if ($line =~ /__builtin_bfin_ssync/) {
1922                         my $herevet = "$here\n" . cat_vet($line) . "\n";
1923                         ERROR("SSYNC",
1924                               "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
1925                 }
1926
1927 # Check for potential 'bare' types
1928                 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
1929                     $realline_next);
1930 #print "LINE<$line>\n";
1931                 if ($linenr >= $suppress_statement &&
1932                     $realcnt && $line =~ /.\s*\S/) {
1933                         ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
1934                                 ctx_statement_block($linenr, $realcnt, 0);
1935                         $stat =~ s/\n./\n /g;
1936                         $cond =~ s/\n./\n /g;
1937
1938 #print "linenr<$linenr> <$stat>\n";
1939                         # If this statement has no statement boundaries within
1940                         # it there is no point in retrying a statement scan
1941                         # until we hit end of it.
1942                         my $frag = $stat; $frag =~ s/;+\s*$//;
1943                         if ($frag !~ /(?:{|;)/) {
1944 #print "skip<$line_nr_next>\n";
1945                                 $suppress_statement = $line_nr_next;
1946                         }
1947
1948                         # Find the real next line.
1949                         $realline_next = $line_nr_next;
1950                         if (defined $realline_next &&
1951                             (!defined $lines[$realline_next - 1] ||
1952                              substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
1953                                 $realline_next++;
1954                         }
1955
1956                         my $s = $stat;
1957                         $s =~ s/{.*$//s;
1958
1959                         # Ignore goto labels.
1960                         if ($s =~ /$Ident:\*$/s) {
1961
1962                         # Ignore functions being called
1963                         } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
1964
1965                         } elsif ($s =~ /^.\s*else\b/s) {
1966
1967                         # declarations always start with types
1968                         } 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) {
1969                                 my $type = $1;
1970                                 $type =~ s/\s+/ /g;
1971                                 possible($type, "A:" . $s);
1972
1973                         # definitions in global scope can only start with types
1974                         } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
1975                                 possible($1, "B:" . $s);
1976                         }
1977
1978                         # any (foo ... *) is a pointer cast, and foo is a type
1979                         while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
1980                                 possible($1, "C:" . $s);
1981                         }
1982
1983                         # Check for any sort of function declaration.
1984                         # int foo(something bar, other baz);
1985                         # void (*store_gdt)(x86_descr_ptr *);
1986                         if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
1987                                 my ($name_len) = length($1);
1988
1989                                 my $ctx = $s;
1990                                 substr($ctx, 0, $name_len + 1, '');
1991                                 $ctx =~ s/\)[^\)]*$//;
1992
1993                                 for my $arg (split(/\s*,\s*/, $ctx)) {
1994                                         if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
1995
1996                                                 possible($1, "D:" . $s);
1997                                         }
1998                                 }
1999                         }
2000
2001                 }
2002
2003 #
2004 # Checks which may be anchored in the context.
2005 #
2006
2007 # Check for switch () and associated case and default
2008 # statements should be at the same indent.
2009                 if ($line=~/\bswitch\s*\(.*\)/) {
2010                         my $err = '';
2011                         my $sep = '';
2012                         my @ctx = ctx_block_outer($linenr, $realcnt);
2013                         shift(@ctx);
2014                         for my $ctx (@ctx) {
2015                                 my ($clen, $cindent) = line_stats($ctx);
2016                                 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2017                                                         $indent != $cindent) {
2018                                         $err .= "$sep$ctx\n";
2019                                         $sep = '';
2020                                 } else {
2021                                         $sep = "[...]\n";
2022                                 }
2023                         }
2024                         if ($err ne '') {
2025                                 ERROR("SWITCH_CASE_INDENT_LEVEL",
2026                                       "switch and case should be at the same indent\n$hereline$err");
2027                         }
2028                 }
2029
2030 # if/while/etc brace do not go on next line, unless defining a do while loop,
2031 # or if that brace on the next line is for something else
2032                 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
2033                         my $pre_ctx = "$1$2";
2034
2035                         my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
2036
2037                         if ($line =~ /^\+\t{6,}/) {
2038                                 WARN("DEEP_INDENTATION",
2039                                      "Too many leading tabs - consider code refactoring\n" . $herecurr);
2040                         }
2041
2042                         my $ctx_cnt = $realcnt - $#ctx - 1;
2043                         my $ctx = join("\n", @ctx);
2044
2045                         my $ctx_ln = $linenr;
2046                         my $ctx_skip = $realcnt;
2047
2048                         while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2049                                         defined $lines[$ctx_ln - 1] &&
2050                                         $lines[$ctx_ln - 1] =~ /^-/)) {
2051                                 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2052                                 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
2053                                 $ctx_ln++;
2054                         }
2055
2056                         #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2057                         #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
2058
2059                         if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
2060                                 ERROR("OPEN_BRACE",
2061                                       "that open brace { should be on the previous line\n" .
2062                                         "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2063                         }
2064                         if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2065                             $ctx =~ /\)\s*\;\s*$/ &&
2066                             defined $lines[$ctx_ln - 1])
2067                         {
2068                                 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2069                                 if ($nindent > $indent) {
2070                                         WARN("TRAILING_SEMICOLON",
2071                                              "trailing semicolon indicates no statements, indent implies otherwise\n" .
2072                                                 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2073                                 }
2074                         }
2075                 }
2076
2077 # Check relative indent for conditionals and blocks.
2078                 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2079                         ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2080                                 ctx_statement_block($linenr, $realcnt, 0)
2081                                         if (!defined $stat);
2082                         my ($s, $c) = ($stat, $cond);
2083
2084                         substr($s, 0, length($c), '');
2085
2086                         # Make sure we remove the line prefixes as we have
2087                         # none on the first line, and are going to readd them
2088                         # where necessary.
2089                         $s =~ s/\n./\n/gs;
2090
2091                         # Find out how long the conditional actually is.
2092                         my @newlines = ($c =~ /\n/gs);
2093                         my $cond_lines = 1 + $#newlines;
2094
2095                         # We want to check the first line inside the block
2096                         # starting at the end of the conditional, so remove:
2097                         #  1) any blank line termination
2098                         #  2) any opening brace { on end of the line
2099                         #  3) any do (...) {
2100                         my $continuation = 0;
2101                         my $check = 0;
2102                         $s =~ s/^.*\bdo\b//;
2103                         $s =~ s/^\s*{//;
2104                         if ($s =~ s/^\s*\\//) {
2105                                 $continuation = 1;
2106                         }
2107                         if ($s =~ s/^\s*?\n//) {
2108                                 $check = 1;
2109                                 $cond_lines++;
2110                         }
2111
2112                         # Also ignore a loop construct at the end of a
2113                         # preprocessor statement.
2114                         if (($prevline =~ /^.\s*#\s*define\s/ ||
2115                             $prevline =~ /\\\s*$/) && $continuation == 0) {
2116                                 $check = 0;
2117                         }
2118
2119                         my $cond_ptr = -1;
2120                         $continuation = 0;
2121                         while ($cond_ptr != $cond_lines) {
2122                                 $cond_ptr = $cond_lines;
2123
2124                                 # If we see an #else/#elif then the code
2125                                 # is not linear.
2126                                 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2127                                         $check = 0;
2128                                 }
2129
2130                                 # Ignore:
2131                                 #  1) blank lines, they should be at 0,
2132                                 #  2) preprocessor lines, and
2133                                 #  3) labels.
2134                                 if ($continuation ||
2135                                     $s =~ /^\s*?\n/ ||
2136                                     $s =~ /^\s*#\s*?/ ||
2137                                     $s =~ /^\s*$Ident\s*:/) {
2138                                         $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
2139                                         if ($s =~ s/^.*?\n//) {
2140                                                 $cond_lines++;
2141                                         }
2142                                 }
2143                         }
2144
2145                         my (undef, $sindent) = line_stats("+" . $s);
2146                         my $stat_real = raw_line($linenr, $cond_lines);
2147
2148                         # Check if either of these lines are modified, else
2149                         # this is not this patch's fault.
2150                         if (!defined($stat_real) ||
2151                             $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2152                                 $check = 0;
2153                         }
2154                         if (defined($stat_real) && $cond_lines > 1) {
2155                                 $stat_real = "[...]\n$stat_real";
2156                         }
2157
2158                         #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";
2159
2160                         if ($check && (($sindent % 8) != 0 ||
2161                             ($sindent <= $indent && $s ne ''))) {
2162                                 WARN("SUSPECT_CODE_INDENT",
2163                                      "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
2164                         }
2165                 }
2166
2167                 # Track the 'values' across context and added lines.
2168                 my $opline = $line; $opline =~ s/^./ /;
2169                 my ($curr_values, $curr_vars) =
2170                                 annotate_values($opline . "\n", $prev_values);
2171                 $curr_values = $prev_values . $curr_values;
2172                 if ($dbg_values) {
2173                         my $outline = $opline; $outline =~ s/\t/ /g;
2174                         print "$linenr > .$outline\n";
2175                         print "$linenr > $curr_values\n";
2176                         print "$linenr >  $curr_vars\n";
2177                 }
2178                 $prev_values = substr($curr_values, -1);
2179
2180 #ignore lines not being added
2181                 if ($line=~/^[^\+]/) {next;}
2182
2183 # TEST: allow direct testing of the type matcher.
2184                 if ($dbg_type) {
2185                         if ($line =~ /^.\s*$Declare\s*$/) {
2186                                 ERROR("TEST_TYPE",
2187                                       "TEST: is type\n" . $herecurr);
2188                         } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
2189                                 ERROR("TEST_NOT_TYPE",
2190                                       "TEST: is not type ($1 is)\n". $herecurr);
2191                         }
2192                         next;
2193                 }
2194 # TEST: allow direct testing of the attribute matcher.
2195                 if ($dbg_attr) {
2196                         if ($line =~ /^.\s*$Modifier\s*$/) {
2197                                 ERROR("TEST_ATTR",
2198                                       "TEST: is attr\n" . $herecurr);
2199                         } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
2200                                 ERROR("TEST_NOT_ATTR",
2201                                       "TEST: is not attr ($1 is)\n". $herecurr);
2202                         }
2203                         next;
2204                 }
2205
2206 # check for initialisation to aggregates open brace on the next line
2207                 if ($line =~ /^.\s*{/ &&
2208                     $prevline =~ /(?:^|[^=])=\s*$/) {
2209                         ERROR("OPEN_BRACE",
2210                               "that open brace { should be on the previous line\n" . $hereprev);
2211                 }
2212
2213 #
2214 # Checks which are anchored on the added line.
2215 #
2216
2217 # check for malformed paths in #include statements (uses RAW line)
2218                 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
2219                         my $path = $1;
2220                         if ($path =~ m{//}) {
2221                                 ERROR("MALFORMED_INCLUDE",
2222                                       "malformed #include filename\n" .
2223                                         $herecurr);
2224                         }
2225                 }
2226
2227 # no C99 // comments
2228                 if ($line =~ m{//}) {
2229                         ERROR("C99_COMMENTS",
2230                               "do not use C99 // comments\n" . $herecurr);
2231                 }
2232                 # Remove C99 comments.
2233                 $line =~ s@//.*@@;
2234                 $opline =~ s@//.*@@;
2235
2236 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2237 # the whole statement.
2238 #print "APW <$lines[$realline_next - 1]>\n";
2239                 if (defined $realline_next &&
2240                     exists $lines[$realline_next - 1] &&
2241                     !defined $suppress_export{$realline_next} &&
2242                     ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2243                      $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2244                         # Handle definitions which produce identifiers with
2245                         # a prefix:
2246                         #   XXX(foo);
2247                         #   EXPORT_SYMBOL(something_foo);
2248                         my $name = $1;
2249                         if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
2250                             $name =~ /^${Ident}_$2/) {
2251 #print "FOO C name<$name>\n";
2252                                 $suppress_export{$realline_next} = 1;
2253
2254                         } elsif ($stat !~ /(?:
2255                                 \n.}\s*$|
2256                                 ^.DEFINE_$Ident\(\Q$name\E\)|
2257                                 ^.DECLARE_$Ident\(\Q$name\E\)|
2258                                 ^.LIST_HEAD\(\Q$name\E\)|
2259                                 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2260                                 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
2261                             )/x) {
2262 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2263                                 $suppress_export{$realline_next} = 2;
2264                         } else {
2265                                 $suppress_export{$realline_next} = 1;
2266                         }
2267                 }
2268                 if (!defined $suppress_export{$linenr} &&
2269                     $prevline =~ /^.\s*$/ &&
2270                     ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2271                      $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2272 #print "FOO B <$lines[$linenr - 1]>\n";
2273                         $suppress_export{$linenr} = 2;
2274                 }
2275                 if (defined $suppress_export{$linenr} &&
2276                     $suppress_export{$linenr} == 2) {
2277                         WARN("EXPORT_SYMBOL",
2278                              "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
2279                 }
2280
2281 # check for global initialisers.
2282                 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
2283                         ERROR("GLOBAL_INITIALISERS",
2284                               "do not initialise globals to 0 or NULL\n" .
2285                                 $herecurr);
2286                 }
2287 # check for static initialisers.
2288                 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2289                         ERROR("INITIALISED_STATIC",
2290                               "do not initialise statics to 0 or NULL\n" .
2291                                 $herecurr);
2292                 }
2293
2294 # check for static const char * arrays.
2295                 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
2296                         WARN("STATIC_CONST_CHAR_ARRAY",
2297                              "static const char * array should probably be static const char * const\n" .
2298                                 $herecurr);
2299                }
2300
2301 # check for static char foo[] = "bar" declarations.
2302                 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
2303                         WARN("STATIC_CONST_CHAR_ARRAY",
2304                              "static char array declaration should probably be static const char\n" .
2305                                 $herecurr);
2306                }
2307
2308 # check for declarations of struct pci_device_id
2309                 if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) {
2310                         WARN("DEFINE_PCI_DEVICE_TABLE",
2311                              "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr);
2312                 }
2313
2314 # check for new typedefs, only function parameters and sparse annotations
2315 # make sense.
2316                 if ($line =~ /\btypedef\s/ &&
2317                     $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
2318                     $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
2319                     $line !~ /\b$typeTypedefs\b/ &&
2320                     $line !~ /\b__bitwise(?:__|)\b/) {
2321                         WARN("NEW_TYPEDEFS",
2322                              "do not add new typedefs\n" . $herecurr);
2323                 }
2324
2325 # * goes on variable not on type
2326                 # (char*[ const])
2327                 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2328                         #print "AA<$1>\n";
2329                         my ($from, $to) = ($2, $2);
2330
2331                         # Should start with a space.
2332                         $to =~ s/^(\S)/ $1/;
2333                         # Should not end with a space.
2334                         $to =~ s/\s+$//;
2335                         # '*'s should not have spaces between.
2336                         while ($to =~ s/\*\s+\*/\*\*/) {
2337                         }
2338
2339                         #print "from<$from> to<$to>\n";
2340                         if ($from ne $to) {
2341                                 ERROR("POINTER_LOCATION",
2342                                       "\"(foo$from)\" should be \"(foo$to)\"\n" .  $herecurr);
2343                         }
2344                 }
2345                 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2346                         #print "BB<$1>\n";
2347                         my ($from, $to, $ident) = ($2, $2, $3);
2348
2349                         # Should start with a space.
2350                         $to =~ s/^(\S)/ $1/;
2351                         # Should not end with a space.
2352                         $to =~ s/\s+$//;
2353                         # '*'s should not have spaces between.
2354                         while ($to =~ s/\*\s+\*/\*\*/) {
2355                         }
2356                         # Modifiers should have spaces.
2357                         $to =~ s/(\b$Modifier$)/$1 /;
2358
2359                         #print "from<$from> to<$to> ident<$ident>\n";
2360                         if ($from ne $to && $ident !~ /^$Modifier$/) {
2361                                 ERROR("POINTER_LOCATION",
2362                                       "\"foo${from}bar\" should be \"foo${to}bar\"\n" .  $herecurr);
2363                         }
2364                 }
2365
2366 # # no BUG() or BUG_ON()
2367 #               if ($line =~ /\b(BUG|BUG_ON)\b/) {
2368 #                       print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2369 #                       print "$herecurr";
2370 #                       $clean = 0;
2371 #               }
2372
2373                 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
2374                         WARN("LINUX_VERSION_CODE",
2375                              "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
2376                 }
2377
2378 # check for uses of printk_ratelimit
2379                 if ($line =~ /\bprintk_ratelimit\s*\(/) {
2380                         WARN("PRINTK_RATELIMITED",
2381 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
2382                 }
2383
2384 # printk should use KERN_* levels.  Note that follow on printk's on the
2385 # same line do not need a level, so we use the current block context
2386 # to try and find and validate the current printk.  In summary the current
2387 # printk includes all preceding printk's which have no newline on the end.
2388 # we assume the first bad printk is the one to report.
2389                 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
2390                         my $ok = 0;
2391                         for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2392                                 #print "CHECK<$lines[$ln - 1]\n";
2393                                 # we have a preceding printk if it ends
2394                                 # with "\n" ignore it, else it is to blame
2395                                 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2396                                         if ($rawlines[$ln - 1] !~ m{\\n"}) {
2397                                                 $ok = 1;
2398                                         }
2399                                         last;
2400                                 }
2401                         }
2402                         if ($ok == 0) {
2403                                 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2404                                      "printk() should include KERN_ facility level\n" . $herecurr);
2405                         }
2406                 }
2407
2408 # function brace can't be on same line, except for #defines of do while,
2409 # or if closed on same line
2410                 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2411                     !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
2412                         ERROR("OPEN_BRACE",
2413                               "open brace '{' following function declarations go on the next line\n" . $herecurr);
2414                 }
2415
2416 # open braces for enum, union and struct go on the same line.
2417                 if ($line =~ /^.\s*{/ &&
2418                     $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
2419                         ERROR("OPEN_BRACE",
2420                               "open brace '{' following $1 go on the same line\n" . $hereprev);
2421                 }
2422
2423 # missing space after union, struct or enum definition
2424                 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) {
2425                     WARN("SPACING",
2426                          "missing space after $1 definition\n" . $herecurr);
2427                 }
2428
2429 # check for spacing round square brackets; allowed:
2430 #  1. with a type on the left -- int [] a;
2431 #  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2432 #  3. inside a curly brace -- = { [0...10] = 5 }
2433                 while ($line =~ /(.*?\s)\[/g) {
2434                         my ($where, $prefix) = ($-[1], $1);
2435                         if ($prefix !~ /$Type\s+$/ &&
2436                             ($where != 0 || $prefix !~ /^.\s+$/) &&
2437                             $prefix !~ /{\s+$/) {
2438                                 ERROR("BRACKET_SPACE",
2439                                       "space prohibited before open square bracket '['\n" . $herecurr);
2440                         }
2441                 }
2442
2443 # check for spaces between functions and their parentheses.
2444                 while ($line =~ /($Ident)\s+\(/g) {
2445                         my $name = $1;
2446                         my $ctx_before = substr($line, 0, $-[1]);
2447                         my $ctx = "$ctx_before$name";
2448
2449                         # Ignore those directives where spaces _are_ permitted.
2450                         if ($name =~ /^(?:
2451                                 if|for|while|switch|return|case|
2452                                 volatile|__volatile__|
2453                                 __attribute__|format|__extension__|
2454                                 asm|__asm__)$/x)
2455                         {
2456
2457                         # cpp #define statements have non-optional spaces, ie
2458                         # if there is a space between the name and the open
2459                         # parenthesis it is simply not a parameter group.
2460                         } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
2461
2462                         # cpp #elif statement condition may start with a (
2463                         } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
2464
2465                         # If this whole things ends with a type its most
2466                         # likely a typedef for a function.
2467                         } elsif ($ctx =~ /$Type$/) {
2468
2469                         } else {
2470                                 WARN("SPACING",
2471                                      "space prohibited between function name and open parenthesis '('\n" . $herecurr);
2472                         }
2473                 }
2474 # Check operator spacing.
2475                 if (!($line=~/\#\s*include/)) {
2476                         my $ops = qr{
2477                                 <<=|>>=|<=|>=|==|!=|
2478                                 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
2479                                 =>|->|<<|>>|<|>|=|!|~|
2480                                 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
2481                                 \?|:
2482                         }x;
2483                         my @elements = split(/($ops|;)/, $opline);
2484                         my $off = 0;
2485
2486                         my $blank = copy_spacing($opline);
2487
2488                         for (my $n = 0; $n < $#elements; $n += 2) {
2489                                 $off += length($elements[$n]);
2490
2491                                 # Pick up the preceding and succeeding characters.
2492                                 my $ca = substr($opline, 0, $off);
2493                                 my $cc = '';
2494                                 if (length($opline) >= ($off + length($elements[$n + 1]))) {
2495                                         $cc = substr($opline, $off + length($elements[$n + 1]));
2496                                 }
2497                                 my $cb = "$ca$;$cc";
2498
2499                                 my $a = '';
2500                                 $a = 'V' if ($elements[$n] ne '');
2501                                 $a = 'W' if ($elements[$n] =~ /\s$/);
2502                                 $a = 'C' if ($elements[$n] =~ /$;$/);
2503                                 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
2504                                 $a = 'O' if ($elements[$n] eq '');
2505                                 $a = 'E' if ($ca =~ /^\s*$/);
2506
2507                                 my $op = $elements[$n + 1];
2508
2509                                 my $c = '';
2510                                 if (defined $elements[$n + 2]) {
2511                                         $c = 'V' if ($elements[$n + 2] ne '');
2512                                         $c = 'W' if ($elements[$n + 2] =~ /^\s/);
2513                                         $c = 'C' if ($elements[$n + 2] =~ /^$;/);
2514                                         $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
2515                                         $c = 'O' if ($elements[$n + 2] eq '');
2516                                         $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
2517                                 } else {
2518                                         $c = 'E';
2519                                 }
2520
2521                                 my $ctx = "${a}x${c}";
2522
2523                                 my $at = "(ctx:$ctx)";
2524
2525                                 my $ptr = substr($blank, 0, $off) . "^";
2526                                 my $hereptr = "$hereline$ptr\n";
2527
2528                                 # Pull out the value of this operator.
2529                                 my $op_type = substr($curr_values, $off + 1, 1);
2530
2531                                 # Get the full operator variant.
2532                                 my $opv = $op . substr($curr_vars, $off, 1);
2533
2534                                 # Ignore operators passed as parameters.
2535                                 if ($op_type ne 'V' &&
2536                                     $ca =~ /\s$/ && $cc =~ /^\s*,/) {
2537
2538 #                               # Ignore comments
2539 #                               } elsif ($op =~ /^$;+$/) {
2540
2541                                 # ; should have either the end of line or a space or \ after it
2542                                 } elsif ($op eq ';') {
2543                                         if ($ctx !~ /.x[WEBC]/ &&
2544                                             $cc !~ /^\\/ && $cc !~ /^;/) {
2545                                                 ERROR("SPACING",
2546                                                       "space required after that '$op' $at\n" . $hereptr);
2547                                         }
2548
2549                                 # // is a comment
2550                                 } elsif ($op eq '//') {
2551
2552                                 # No spaces for:
2553                                 #   ->
2554                                 #   :   when part of a bitfield
2555                                 } elsif ($op eq '->' || $opv eq ':B') {
2556                                         if ($ctx =~ /Wx.|.xW/) {
2557                                                 ERROR("SPACING",
2558                                                       "spaces prohibited around that '$op' $at\n" . $hereptr);
2559                                         }
2560
2561                                 # , must have a space on the right.
2562                                 } elsif ($op eq ',') {
2563                                         if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
2564                                                 ERROR("SPACING",
2565                                                       "space required after that '$op' $at\n" . $hereptr);
2566                                         }
2567
2568                                 # '*' as part of a type definition -- reported already.
2569                                 } elsif ($opv eq '*_') {
2570                                         #warn "'*' is part of type\n";
2571
2572                                 # unary operators should have a space before and
2573                                 # none after.  May be left adjacent to another
2574                                 # unary operator, or a cast
2575                                 } elsif ($op eq '!' || $op eq '~' ||
2576                                          $opv eq '*U' || $opv eq '-U' ||
2577                                          $opv eq '&U' || $opv eq '&&U') {
2578                                         if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
2579                                                 ERROR("SPACING",
2580                                                       "space required before that '$op' $at\n" . $hereptr);
2581                                         }
2582                                         if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
2583                                                 # A unary '*' may be const
2584
2585                                         } elsif ($ctx =~ /.xW/) {
2586                                                 ERROR("SPACING",
2587                                                       "space prohibited after that '$op' $at\n" . $hereptr);
2588                                         }
2589
2590                                 # unary ++ and unary -- are allowed no space on one side.
2591                                 } elsif ($op eq '++' or $op eq '--') {
2592                                         if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
2593                                                 ERROR("SPACING",
2594                                                       "space required one side of that '$op' $at\n" . $hereptr);
2595                                         }
2596                                         if ($ctx =~ /Wx[BE]/ ||
2597                                             ($ctx =~ /Wx./ && $cc =~ /^;/)) {
2598                                                 ERROR("SPACING",
2599                                                       "space prohibited before that '$op' $at\n" . $hereptr);
2600                                         }
2601                                         if ($ctx =~ /ExW/) {
2602                                                 ERROR("SPACING",
2603                                                       "space prohibited after that '$op' $at\n" . $hereptr);
2604                                         }
2605
2606
2607                                 # << and >> may either have or not have spaces both sides
2608                                 } elsif ($op eq '<<' or $op eq '>>' or
2609                                          $op eq '&' or $op eq '^' or $op eq '|' or
2610                                          $op eq '+' or $op eq '-' or
2611                                          $op eq '*' or $op eq '/' or
2612                                          $op eq '%')
2613                                 {
2614                                         if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
2615                                                 ERROR("SPACING",
2616                                                       "need consistent spacing around '$op' $at\n" .
2617                                                         $hereptr);
2618                                         }
2619
2620                                 # A colon needs no spaces before when it is
2621                                 # terminating a case value or a label.
2622                                 } elsif ($opv eq ':C' || $opv eq ':L') {
2623                                         if ($ctx =~ /Wx./) {
2624                                                 ERROR("SPACING",
2625                                                       "space prohibited before that '$op' $at\n" . $hereptr);
2626                                         }
2627
2628                                 # All the others need spaces both sides.
2629                                 } elsif ($ctx !~ /[EWC]x[CWE]/) {
2630                                         my $ok = 0;
2631
2632                                         # Ignore email addresses <foo@bar>
2633                                         if (($op eq '<' &&
2634                                              $cc =~ /^\S+\@\S+>/) ||
2635                                             ($op eq '>' &&
2636                                              $ca =~ /<\S+\@\S+$/))
2637                                         {
2638                                                 $ok = 1;
2639                                         }
2640
2641                                         # Ignore ?:
2642                                         if (($opv eq ':O' && $ca =~ /\?$/) ||
2643                                             ($op eq '?' && $cc =~ /^:/)) {
2644                                                 $ok = 1;
2645                                         }
2646
2647                                         if ($ok == 0) {
2648                                                 ERROR("SPACING",
2649                                                       "spaces required around that '$op' $at\n" . $hereptr);
2650                                         }
2651                                 }
2652                                 $off += length($elements[$n + 1]);
2653                         }
2654                 }
2655
2656 # check for multiple assignments
2657                 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
2658                         CHK("MULTIPLE_ASSIGNMENTS",
2659                             "multiple assignments should be avoided\n" . $herecurr);
2660                 }
2661
2662 ## # check for multiple declarations, allowing for a function declaration
2663 ## # continuation.
2664 ##              if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
2665 ##                  $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
2666 ##
2667 ##                      # Remove any bracketed sections to ensure we do not
2668 ##                      # falsly report the parameters of functions.
2669 ##                      my $ln = $line;
2670 ##                      while ($ln =~ s/\([^\(\)]*\)//g) {
2671 ##                      }
2672 ##                      if ($ln =~ /,/) {
2673 ##                              WARN("MULTIPLE_DECLARATION",
2674 ##                                   "declaring multiple variables together should be avoided\n" . $herecurr);
2675 ##                      }
2676 ##              }
2677
2678 #need space before brace following if, while, etc
2679                 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
2680                     $line =~ /do{/) {
2681                         ERROR("SPACING",
2682                               "space required before the open brace '{'\n" . $herecurr);
2683                 }
2684
2685 # closing brace should have a space following it when it has anything
2686 # on the line
2687                 if ($line =~ /}(?!(?:,|;|\)))\S/) {
2688                         ERROR("SPACING",
2689                               "space required after that close brace '}'\n" . $herecurr);
2690                 }
2691
2692 # check spacing on square brackets
2693                 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
2694                         ERROR("SPACING",
2695                               "space prohibited after that open square bracket '['\n" . $herecurr);
2696                 }
2697                 if ($line =~ /\s\]/) {
2698                         ERROR("SPACING",
2699                               "space prohibited before that close square bracket ']'\n" . $herecurr);
2700                 }
2701
2702 # check spacing on parentheses
2703                 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
2704                     $line !~ /for\s*\(\s+;/) {
2705                         ERROR("SPACING",
2706                               "space prohibited after that open parenthesis '('\n" . $herecurr);
2707                 }
2708                 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
2709                     $line !~ /for\s*\(.*;\s+\)/ &&
2710                     $line !~ /:\s+\)/) {
2711                         ERROR("SPACING",
2712                               "space prohibited before that close parenthesis ')'\n" . $herecurr);
2713                 }
2714
2715 #goto labels aren't indented, allow a single space however
2716                 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
2717                    !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
2718                         WARN("INDENTED_LABEL",
2719                              "labels should not be indented\n" . $herecurr);
2720                 }
2721
2722 # Return is not a function.
2723                 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2724                         my $spacing = $1;
2725                         my $value = $2;
2726
2727                         # Flatten any parentheses
2728                         $value =~ s/\(/ \(/g;
2729                         $value =~ s/\)/\) /g;
2730                         while ($value =~ s/\[[^\[\]]*\]/1/ ||
2731                                $value !~ /(?:$Ident|-?$Constant)\s*
2732                                              $Compare\s*
2733                                              (?:$Ident|-?$Constant)/x &&
2734                                $value =~ s/\([^\(\)]*\)/1/) {
2735                         }
2736 #print "value<$value>\n";
2737                         if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
2738                                 ERROR("RETURN_PARENTHESES",
2739                                       "return is not a function, parentheses are not required\n" . $herecurr);
2740
2741                         } elsif ($spacing !~ /\s+/) {
2742                                 ERROR("SPACING",
2743                                       "space required before the open parenthesis '('\n" . $herecurr);
2744                         }
2745                 }
2746 # Return of what appears to be an errno should normally be -'ve
2747                 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
2748                         my $name = $1;
2749                         if ($name ne 'EOF' && $name ne 'ERROR') {
2750                                 WARN("USE_NEGATIVE_ERRNO",
2751                                      "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
2752                         }
2753                 }
2754
2755 # Need a space before open parenthesis after if, while etc
2756                 if ($line=~/\b(if|while|for|switch)\(/) {
2757                         ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr);
2758                 }
2759
2760 # Check for illegal assignment in if conditional -- and check for trailing
2761 # statements after the conditional.
2762                 if ($line =~ /do\s*(?!{)/) {
2763                         ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2764                                 ctx_statement_block($linenr, $realcnt, 0)
2765                                         if (!defined $stat);
2766                         my ($stat_next) = ctx_statement_block($line_nr_next,
2767                                                 $remain_next, $off_next);
2768                         $stat_next =~ s/\n./\n /g;
2769                         ##print "stat<$stat> stat_next<$stat_next>\n";
2770
2771                         if ($stat_next =~ /^\s*while\b/) {
2772                                 # If the statement carries leading newlines,
2773                                 # then count those as offsets.
2774                                 my ($whitespace) =
2775                                         ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2776                                 my $offset =
2777                                         statement_rawlines($whitespace) - 1;
2778
2779                                 $suppress_whiletrailers{$line_nr_next +
2780                                                                 $offset} = 1;
2781                         }
2782                 }
2783                 if (!defined $suppress_whiletrailers{$linenr} &&
2784                     $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
2785                         my ($s, $c) = ($stat, $cond);
2786
2787                         if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
2788                                 ERROR("ASSIGN_IN_IF",
2789                                       "do not use assignment in if condition\n" . $herecurr);
2790                         }
2791
2792                         # Find out what is on the end of the line after the
2793                         # conditional.
2794                         substr($s, 0, length($c), '');
2795                         $s =~ s/\n.*//g;
2796                         $s =~ s/$;//g;  # Remove any comments
2797                         if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2798                             $c !~ /}\s*while\s*/)
2799                         {
2800                                 # Find out how long the conditional actually is.
2801                                 my @newlines = ($c =~ /\n/gs);
2802                                 my $cond_lines = 1 + $#newlines;
2803                                 my $stat_real = '';
2804
2805                                 $stat_real = raw_line($linenr, $cond_lines)
2806                                                         . "\n" if ($cond_lines);
2807                                 if (defined($stat_real) && $cond_lines > 1) {
2808                                         $stat_real = "[...]\n$stat_real";
2809                                 }
2810
2811                                 ERROR("TRAILING_STATEMENTS",
2812                                       "trailing statements should be on next line\n" . $herecurr . $stat_real);
2813                         }
2814                 }
2815
2816 # Check for bitwise tests written as boolean
2817                 if ($line =~ /
2818                         (?:
2819                                 (?:\[|\(|\&\&|\|\|)
2820                                 \s*0[xX][0-9]+\s*
2821                                 (?:\&\&|\|\|)
2822                         |
2823                                 (?:\&\&|\|\|)
2824                                 \s*0[xX][0-9]+\s*
2825                                 (?:\&\&|\|\||\)|\])
2826                         )/x)
2827                 {
2828                         WARN("HEXADECIMAL_BOOLEAN_TEST",
2829                              "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2830                 }
2831
2832 # if and else should not have general statements after it
2833                 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2834                         my $s = $1;
2835                         $s =~ s/$;//g;  # Remove any comments
2836                         if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2837                                 ERROR("TRAILING_STATEMENTS",
2838                                       "trailing statements should be on next line\n" . $herecurr);
2839                         }
2840                 }
2841 # if should not continue a brace
2842                 if ($line =~ /}\s*if\b/) {
2843                         ERROR("TRAILING_STATEMENTS",
2844                               "trailing statements should be on next line\n" .
2845                                 $herecurr);
2846                 }
2847 # case and default should not have general statements after them
2848                 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2849                     $line !~ /\G(?:
2850                         (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
2851                         \s*return\s+
2852                     )/xg)
2853                 {
2854                         ERROR("TRAILING_STATEMENTS",
2855                               "trailing statements should be on next line\n" . $herecurr);
2856                 }
2857
2858                 # Check for }<nl>else {, these must be at the same
2859                 # indent level to be relevant to each other.
2860                 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2861                                                 $previndent == $indent) {
2862                         ERROR("ELSE_AFTER_BRACE",
2863                               "else should follow close brace '}'\n" . $hereprev);
2864                 }
2865
2866                 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2867                                                 $previndent == $indent) {
2868                         my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2869
2870                         # Find out what is on the end of the line after the
2871                         # conditional.
2872                         substr($s, 0, length($c), '');
2873                         $s =~ s/\n.*//g;
2874
2875                         if ($s =~ /^\s*;/) {
2876                                 ERROR("WHILE_AFTER_BRACE",
2877                                       "while should follow close brace '}'\n" . $hereprev);
2878                         }
2879                 }
2880
2881 #studly caps, commented out until figure out how to distinguish between use of existing and adding new
2882 #               if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2883 #                   print "No studly caps, use _\n";
2884 #                   print "$herecurr";
2885 #                   $clean = 0;
2886 #               }
2887
2888 #no spaces allowed after \ in define
2889                 if ($line=~/\#\s*define.*\\\s$/) {
2890                         WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
2891                              "Whitepspace after \\ makes next lines useless\n" . $herecurr);
2892                 }
2893
2894 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
2895                 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
2896                         my $file = "$1.h";
2897                         my $checkfile = "include/linux/$file";
2898                         if (-f "$root/$checkfile" &&
2899                             $realfile ne $checkfile &&
2900                             $1 !~ /$allowed_asm_includes/)
2901                         {
2902                                 if ($realfile =~ m{^arch/}) {
2903                                         CHK("ARCH_INCLUDE_LINUX",
2904                                             "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2905                                 } else {
2906                                         WARN("INCLUDE_LINUX",
2907                                              "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2908                                 }
2909                         }
2910                 }
2911
2912 # multi-statement macros should be enclosed in a do while loop, grab the
2913 # first statement and ensure its the whole macro if its not enclosed
2914 # in a known good container
2915                 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2916                     $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
2917                         my $ln = $linenr;
2918                         my $cnt = $realcnt;
2919                         my ($off, $dstat, $dcond, $rest);
2920                         my $ctx = '';
2921                         ($dstat, $dcond, $ln, $cnt, $off) =
2922                                 ctx_statement_block($linenr, $realcnt, 0);
2923                         $ctx = $dstat;
2924                         #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
2925                         #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
2926
2927                         $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
2928                         $dstat =~ s/$;//g;
2929                         $dstat =~ s/\\\n.//g;
2930                         $dstat =~ s/^\s*//s;
2931                         $dstat =~ s/\s*$//s;
2932
2933                         # Flatten any parentheses and braces
2934                         while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2935                                $dstat =~ s/\{[^\{\}]*\}/1/ ||
2936                                $dstat =~ s/\[[^\[\]]*\]/1/)
2937                         {
2938                         }
2939
2940                         my $exceptions = qr{
2941                                 $Declare|
2942                                 module_param_named|
2943                                 MODULE_PARAM_DESC|
2944                                 DECLARE_PER_CPU|
2945                                 DEFINE_PER_CPU|
2946                                 __typeof__\(|
2947                                 union|
2948                                 struct|
2949                                 \.$Ident\s*=\s*|
2950                                 ^\"|\"$
2951                         }x;
2952                         #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
2953                         if ($dstat ne '' &&
2954                             $dstat !~ /^(?:$Ident|-?$Constant),$/ &&                    # 10, // foo(),
2955                             $dstat !~ /^(?:$Ident|-?$Constant);$/ &&                    # foo();
2956                             $dstat !~ /^(?:$Ident|-?$Constant)$/ &&                     # 10 // foo()
2957                             $dstat !~ /$exceptions/ &&
2958                             $dstat !~ /^\.$Ident\s*=/ &&                                # .foo =
2959                             $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ &&       # do {...} while (...); // do {...} while (...)
2960                             $dstat !~ /^for\s*$Constant$/ &&                            # for (...)
2961                             $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ &&   # for (...) bar()
2962                             $dstat !~ /^do\s*{/ &&                                      # do {...
2963                             $dstat !~ /^\({/)                                           # ({...
2964                         {
2965                                 $ctx =~ s/\n*$//;
2966                                 my $herectx = $here . "\n";
2967                                 my $cnt = statement_rawlines($ctx);
2968
2969                                 for (my $n = 0; $n < $cnt; $n++) {
2970                                         $herectx .= raw_line($linenr, $n) . "\n";
2971                                 }
2972
2973                                 if ($dstat =~ /;/) {
2974                                         ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
2975                                               "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
2976                                 } else {
2977                                         ERROR("COMPLEX_MACRO",
2978                                               "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
2979                                 }
2980                         }
2981                 }
2982
2983 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
2984 # all assignments may have only one of the following with an assignment:
2985 #       .
2986 #       ALIGN(...)
2987 #       VMLINUX_SYMBOL(...)
2988                 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
2989                         WARN("MISSING_VMLINUX_SYMBOL",
2990                              "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
2991                 }
2992
2993 # check for redundant bracing round if etc
2994                 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2995                         my ($level, $endln, @chunks) =
2996                                 ctx_statement_full($linenr, $realcnt, 1);
2997                         #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
2998                         #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2999                         if ($#chunks > 0 && $level == 0) {
3000                                 my $allowed = 0;
3001                                 my $seen = 0;
3002                                 my $herectx = $here . "\n";
3003                                 my $ln = $linenr - 1;
3004                                 for my $chunk (@chunks) {
3005                                         my ($cond, $block) = @{$chunk};
3006
3007                                         # If the condition carries leading newlines, then count those as offsets.
3008                                         my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
3009                                         my $offset = statement_rawlines($whitespace) - 1;
3010
3011                                         #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3012
3013                                         # We have looked at and allowed this specific line.
3014                                         $suppress_ifbraces{$ln + $offset} = 1;
3015
3016                                         $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
3017                                         $ln += statement_rawlines($block) - 1;
3018
3019                                         substr($block, 0, length($cond), '');
3020
3021                                         $seen++ if ($block =~ /^\s*{/);
3022
3023                                         #print "cond<$cond> block<$block> allowed<$allowed>\n";
3024                                         if (statement_lines($cond) > 1) {
3025                                                 #print "APW: ALLOWED: cond<$cond>\n";
3026                                                 $allowed = 1;
3027                                         }
3028                                         if ($block =~/\b(?:if|for|while)\b/) {
3029                                                 #print "APW: ALLOWED: block<$block>\n";
3030                                                 $allowed = 1;
3031                                         }
3032                                         if (statement_block_size($block) > 1) {
3033                                                 #print "APW: ALLOWED: lines block<$block>\n";
3034                                                 $allowed = 1;
3035                                         }
3036                                 }
3037                                 if ($seen && !$allowed) {
3038                                         WARN("BRACES",
3039                                              "braces {} are not necessary for any arm of this statement\n" . $herectx);
3040                                 }
3041                         }
3042                 }
3043                 if (!defined $suppress_ifbraces{$linenr - 1} &&
3044                                         $line =~ /\b(if|while|for|else)\b/) {
3045                         my $allowed = 0;
3046
3047                         # Check the pre-context.
3048                         if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
3049                                 #print "APW: ALLOWED: pre<$1>\n";
3050                                 $allowed = 1;
3051                         }
3052
3053                         my ($level, $endln, @chunks) =
3054                                 ctx_statement_full($linenr, $realcnt, $-[0]);
3055
3056                         # Check the condition.
3057                         my ($cond, $block) = @{$chunks[0]};
3058                         #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
3059                         if (defined $cond) {
3060                                 substr($block, 0, length($cond), '');
3061                         }
3062                         if (statement_lines($cond) > 1) {
3063                                 #print "APW: ALLOWED: cond<$cond>\n";
3064                                 $allowed = 1;
3065                         }
3066                         if ($block =~/\b(?:if|for|while)\b/) {
3067                                 #print "APW: ALLOWED: block<$block>\n";
3068                                 $allowed = 1;
3069                         }
3070                         if (statement_block_size($block) > 1) {
3071                                 #print "APW: ALLOWED: lines block<$block>\n";
3072                                 $allowed = 1;
3073                         }
3074                         # Check the post-context.
3075                         if (defined $chunks[1]) {
3076                                 my ($cond, $block) = @{$chunks[1]};
3077                                 if (defined $cond) {
3078                                         substr($block, 0, length($cond), '');
3079                                 }
3080                                 if ($block =~ /^\s*\{/) {
3081                                         #print "APW: ALLOWED: chunk-1 block<$block>\n";
3082                                         $allowed = 1;
3083                                 }
3084                         }
3085                         if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
3086                                 my $herectx = $here . "\n";
3087                                 my $cnt = statement_rawlines($block);
3088
3089                                 for (my $n = 0; $n < $cnt; $n++) {
3090                                         $herectx .= raw_line($linenr, $n) . "\n";
3091                                 }
3092
3093                                 WARN("BRACES",
3094                                      "braces {} are not necessary for single statement blocks\n" . $herectx);
3095                         }
3096                 }
3097
3098 # don't include deprecated include files (uses RAW line)
3099                 for my $inc (keys %dep_includes) {
3100                         if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
3101                                 ERROR("DEPRECATED_INCLUDE",
3102                                       "Don't use <$inc>, include " .
3103                                       "$dep_includes{$inc} instead\n" .
3104                                       $herecurr);
3105                         }
3106                 }
3107
3108 # don't use deprecated functions
3109                 for my $func (keys %dep_functions) {
3110                         if ($line =~ /\b$func\b/) {
3111                                 ERROR("DEPRECATED_FUNCTION",
3112                                       "$func is deprecated, " .
3113                                       "use $dep_functions{$func} instead\n" .
3114                                       $herecurr);
3115                         }
3116                 }
3117
3118 # try to replace assertions with error handling
3119                 if ($line =~ /\bLASSERTF?\s*\(/) {
3120                     WARN("LASSERT",
3121                          "try to replace assertions with error handling\n" .
3122                          $herecurr);
3123                 }
3124
3125 # avoid new console messages
3126                 if ($line =~ /\bLCONSOLE[A-Z_]*\s*\(/) {
3127                     WARN("LCONSOLE",
3128                          "avoid adding new console messages\n" .
3129                          $herecurr);
3130                 }
3131
3132 # minimize new CERROR messages
3133                 if ($line =~ /\bC(EMERG|ERROR|NETERR|WARN)\s*\(/) {
3134                     WARN("LCONSOLE",
3135                          "think hard before adding new CERROR messages\n" .
3136                          $herecurr);
3137                 }
3138
3139 # no volatiles please
3140                 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
3141                 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
3142                         WARN("VOLATILE",
3143                              "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
3144                 }
3145
3146 # warn about #if 0
3147                 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
3148                         CHK("REDUNDANT_CODE",
3149                             "if this code is redundant consider removing it\n" .
3150                                 $herecurr);
3151                 }
3152
3153 # check for needless kfree() checks
3154                 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
3155                         my $expr = $1;
3156                         if ($line =~ /\bkfree\(\Q$expr\E\);/) {
3157                                 WARN("NEEDLESS_KFREE",
3158                                      "kfree(NULL) is safe this check is probably not required\n" . $hereprev);
3159                         }
3160                 }
3161 # check for needless usb_free_urb() checks
3162                 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
3163                         my $expr = $1;
3164                         if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
3165                                 WARN("NEEDLESS_USB_FREE_URB",
3166                                      "usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
3167                         }
3168                 }
3169
3170 # prefer usleep_range over udelay
3171                 if ($line =~ /\budelay\s*\(\s*(\w+)\s*\)/) {
3172                         # ignore udelay's < 10, however
3173                         if (! (($1 =~ /(\d+)/) && ($1 < 10)) ) {
3174                                 CHK("USLEEP_RANGE",
3175                                     "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
3176                         }
3177                 }
3178
3179 # warn about unexpectedly long msleep's
3180                 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
3181                         if ($1 < 20) {
3182                                 WARN("MSLEEP",
3183                                      "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
3184                         }
3185                 }
3186
3187 # warn about #ifdefs in C files
3188 #               if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
3189 #                       print "#ifdef in C files should be avoided\n";
3190 #                       print "$herecurr";
3191 #                       $clean = 0;
3192 #               }
3193
3194 # warn about spacing in #ifdefs
3195                 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
3196                         ERROR("SPACING",
3197                               "exactly one space required after that #$1\n" . $herecurr);
3198                 }
3199
3200 # check for spinlock_t definitions without a comment.
3201                 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
3202                     $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
3203                         my $which = $1;
3204                         if (!ctx_has_comment($first_line, $linenr)) {
3205                                 CHK("UNCOMMENTED_DEFINITION",
3206                                     "$1 definition without comment\n" . $herecurr);
3207                         }
3208                 }
3209 # check for memory barriers without a comment.
3210                 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
3211                         if (!ctx_has_comment($first_line, $linenr)) {
3212                                 CHK("MEMORY_BARRIER",
3213                                     "memory barrier without comment\n" . $herecurr);
3214                         }
3215                 }
3216 # check of hardware specific defines
3217                 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
3218                         CHK("ARCH_DEFINES",
3219                             "architecture specific defines should be avoided\n" .  $herecurr);
3220                 }
3221
3222 # Check that the storage class is at the beginning of a declaration
3223                 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
3224                         WARN("STORAGE_CLASS",
3225                              "storage class should be at the beginning of the declaration\n" . $herecurr)
3226                 }
3227
3228 # check the location of the inline attribute, that it is between
3229 # storage class and type.
3230                 if ($line =~ /\b$Type\s+$Inline\b/ ||
3231                     $line =~ /\b$Inline\s+$Storage\b/) {
3232                         ERROR("INLINE_LOCATION",
3233                               "inline keyword should sit between storage class and type\n" . $herecurr);
3234                 }
3235
3236 # Check for __inline__ and __inline, prefer inline
3237                 if ($line =~ /\b(__inline__|__inline)\b/) {
3238                         WARN("INLINE",
3239                              "plain inline is preferred over $1\n" . $herecurr);
3240                 }
3241
3242 # Check for __attribute__ packed, prefer __packed
3243                 if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
3244                         WARN("PREFER_PACKED",
3245                              "__packed is preferred over __attribute__((packed))\n" . $herecurr);
3246                 }
3247
3248 # Check for __attribute__ aligned, prefer __aligned
3249                 if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
3250                         WARN("PREFER_ALIGNED",
3251                              "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
3252                 }
3253
3254 # Check for __attribute__ format(printf, prefer __printf
3255                 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
3256                         WARN("PREFER_PRINTF",
3257                              "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr);
3258                 }
3259
3260 # check for sizeof(&)
3261                 if ($line =~ /\bsizeof\s*\(\s*\&/) {
3262                         WARN("SIZEOF_ADDRESS",
3263                              "sizeof(& should be avoided\n" . $herecurr);
3264                 }
3265
3266 # check for line continuations in quoted strings with odd counts of "
3267                 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
3268                         WARN("LINE_CONTINUATIONS",
3269                              "Avoid line continuations in quoted strings\n" . $herecurr);
3270                 }
3271
3272 # Check for misused memsets
3273                 if (defined $stat &&
3274                     $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
3275
3276                         my $ms_addr = $2;
3277                         my $ms_val = $8;
3278                         my $ms_size = $14;
3279
3280                         if ($ms_size =~ /^(0x|)0$/i) {
3281                                 ERROR("MEMSET",
3282                                       "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
3283                         } elsif ($ms_size =~ /^(0x|)1$/i) {
3284                                 WARN("MEMSET",
3285                                      "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
3286                         }
3287                 }
3288
3289 # typecasts on min/max could be min_t/max_t
3290                 if (defined $stat &&
3291                     $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
3292                         if (defined $2 || defined $8) {
3293                                 my $call = $1;
3294                                 my $cast1 = deparenthesize($2);
3295                                 my $arg1 = $3;
3296                                 my $cast2 = deparenthesize($8);
3297                                 my $arg2 = $9;
3298                                 my $cast;
3299
3300                                 if ($cast1 ne "" && $cast2 ne "") {
3301                                         $cast = "$cast1 or $cast2";
3302                                 } elsif ($cast1 ne "") {
3303                                         $cast = $cast1;
3304                                 } else {
3305                                         $cast = $cast2;
3306                                 }
3307                                 WARN("MINMAX",
3308                                      "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
3309                         }
3310                 }
3311
3312 # check for new externs in .c files.
3313                 if ($realfile =~ /\.c$/ && defined $stat &&
3314                     $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
3315                 {
3316                         my $function_name = $1;
3317                         my $paren_space = $2;
3318
3319                         my $s = $stat;
3320                         if (defined $cond) {
3321                                 substr($s, 0, length($cond), '');
3322                         }
3323                         if ($s =~ /^\s*;/ &&
3324                             $function_name ne 'uninitialized_var')
3325                         {
3326                                 WARN("AVOID_EXTERNS",
3327                                      "externs should be avoided in .c files\n" .  $herecurr);
3328                         }
3329
3330                         if ($paren_space =~ /\n/) {
3331                                 WARN("FUNCTION_ARGUMENTS",
3332                                      "arguments for function declarations should follow identifier\n" . $herecurr);
3333                         }
3334
3335                 } elsif ($realfile =~ /\.c$/ && defined $stat &&
3336                     $stat =~ /^.\s*extern\s+/)
3337                 {
3338                         WARN("AVOID_EXTERNS",
3339                              "externs should be avoided in .c files\n" .  $herecurr);
3340                 }
3341
3342 # checks for new __setup's
3343                 if ($rawline =~ /\b__setup\("([^"]*)"/) {
3344                         my $name = $1;
3345
3346                         if (!grep(/$name/, @setup_docs)) {
3347                                 CHK("UNDOCUMENTED_SETUP",
3348                                     "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
3349                         }
3350                 }
3351
3352 # check for pointless casting of kmalloc return
3353                 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
3354                         WARN("UNNECESSARY_CASTS",
3355                              "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
3356                 }
3357
3358 # check for multiple semicolons
3359                 if ($line =~ /;\s*;\s*$/) {
3360                     WARN("ONE_SEMICOLON",
3361                          "Statements terminations use 1 semicolon\n" . $herecurr);
3362                 }
3363
3364 # check for gcc specific __FUNCTION__
3365                 if ($line =~ /__FUNCTION__/) {
3366                         WARN("USE_FUNC",
3367                              "__func__ should be used instead of gcc specific __FUNCTION__\n"  . $herecurr);
3368                 }
3369
3370 # check for semaphores initialized locked
3371                 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
3372                         WARN("CONSIDER_COMPLETION",
3373                              "consider using a completion\n" . $herecurr);
3374
3375                 }
3376 # recommend kstrto* over simple_strto* and strict_strto*
3377                 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
3378                         WARN("CONSIDER_KSTRTO",
3379                              "$1 is obsolete, use k$3 instead\n" . $herecurr);
3380                 }
3381 # check for __initcall(), use device_initcall() explicitly please
3382                 if ($line =~ /^.\s*__initcall\s*\(/) {
3383                         WARN("USE_DEVICE_INITCALL",
3384                              "please use device_initcall() instead of __initcall()\n" . $herecurr);
3385                 }
3386 # check for various ops structs, ensure they are const.
3387                 my $struct_ops = qr{acpi_dock_ops|
3388                                 address_space_operations|
3389                                 backlight_ops|
3390                                 block_device_operations|
3391                                 dentry_operations|
3392                                 dev_pm_ops|
3393                                 dma_map_ops|
3394                                 extent_io_ops|
3395                                 file_lock_operations|
3396                                 file_operations|
3397                                 hv_ops|
3398                                 ide_dma_ops|
3399                                 intel_dvo_dev_ops|
3400                                 item_operations|
3401                                 iwl_ops|
3402                                 kgdb_arch|
3403                                 kgdb_io|
3404                                 kset_uevent_ops|
3405                                 lock_manager_operations|
3406                                 microcode_ops|
3407                                 mtrr_ops|
3408                                 neigh_ops|
3409                                 nlmsvc_binding|
3410                                 pci_raw_ops|
3411                                 pipe_buf_operations|
3412                                 platform_hibernation_ops|
3413                                 platform_suspend_ops|
3414                                 proto_ops|
3415                                 rpc_pipe_ops|
3416                                 seq_operations|
3417                                 snd_ac97_build_ops|
3418                                 soc_pcmcia_socket_ops|
3419                                 stacktrace_ops|
3420                                 sysfs_ops|
3421                                 tty_operations|
3422                                 usb_mon_operations|
3423                                 wd_ops}x;
3424                 if ($line !~ /\bconst\b/ &&
3425                     $line =~ /\bstruct\s+($struct_ops)\b/) {
3426                         WARN("CONST_STRUCT",
3427                              "struct $1 should normally be const\n" .
3428                                 $herecurr);
3429                 }
3430
3431 # use of NR_CPUS is usually wrong
3432 # ignore definitions of NR_CPUS and usage to define arrays as likely right
3433                 if ($line =~ /\bNR_CPUS\b/ &&
3434                     $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
3435                     $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
3436                     $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
3437                     $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
3438                     $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
3439                 {
3440                         WARN("NR_CPUS",
3441                              "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
3442                 }
3443
3444 # check for %L{u,d,i} in strings
3445                 my $string;
3446                 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
3447                         $string = substr($rawline, $-[1], $+[1] - $-[1]);
3448                         $string =~ s/%%/__/g;
3449                         if ($string =~ /(?<!%)%L[udi]/) {
3450                                 WARN("PRINTF_L",
3451                                      "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
3452                                 last;
3453                         }
3454                 }
3455
3456 # whine mightly about in_atomic
3457                 if ($line =~ /\bin_atomic\s*\(/) {
3458                         if ($realfile =~ m@^drivers/@) {
3459                                 ERROR("IN_ATOMIC",
3460                                       "do not use in_atomic in drivers\n" . $herecurr);
3461                         } elsif ($realfile !~ m@^kernel/@) {
3462                                 WARN("IN_ATOMIC",
3463                                      "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
3464                         }
3465                 }
3466
3467 # check for lockdep_set_novalidate_class
3468                 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
3469                     $line =~ /__lockdep_no_validate__\s*\)/ ) {
3470                         if ($realfile !~ m@^kernel/lockdep@ &&
3471                             $realfile !~ m@^include/linux/lockdep@ &&
3472                             $realfile !~ m@^drivers/base/core@) {
3473                                 ERROR("LOCKDEP",
3474                                       "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
3475                         }
3476                 }
3477
3478                 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
3479                     $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
3480                         WARN("EXPORTED_WORLD_WRITABLE",
3481                              "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
3482                 }
3483
3484                 if ($rawline =~ /version 3/) {
3485                         WARN("GPLV3",
3486                              "using GPLv3 is usually wrong\n" . $herecurr);
3487                 }
3488         }
3489
3490         # If we have no input at all, then there is nothing to report on
3491         # so just keep quiet.
3492         if ($#rawlines == -1) {
3493                 exit(0);
3494         }
3495
3496         # In mailback mode only produce a report in the negative, for
3497         # things that appear to be patches.
3498         if ($mailback && ($clean == 1 || !$is_patch)) {
3499                 exit(0);
3500         }
3501
3502         # This is not a patch, and we are are in 'no-patch' mode so
3503         # just keep quiet.
3504         if (!$chk_patch && !$is_patch) {
3505                 exit(0);
3506         }
3507
3508         if (!$is_patch) {
3509                 ERROR("NOT_UNIFIED_DIFF",
3510                       "Does not appear to be a unified-diff format patch\n");
3511         }
3512         if ($is_patch && $chk_signoff && $signoff == 0) {
3513                 ERROR("MISSING_SIGN_OFF",
3514                       "Missing Signed-off-by: line(s)\n");
3515         }
3516
3517         print report_dump();
3518         if ($summary && !($clean == 1 && $quiet == 1)) {
3519                 print "$filename " if ($summary_file);
3520                 print "total: $cnt_error errors, $cnt_warn warnings, " .
3521                         (($check)? "$cnt_chk checks, " : "") .
3522                         "$cnt_lines lines checked\n";
3523                 print "\n" if ($quiet == 0);
3524         }
3525
3526         if ($quiet == 0) {
3527                 # If there were whitespace errors which cleanpatch can fix
3528                 # then suggest that.
3529                 if ($rpt_cleaners) {
3530                         print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
3531                         print "      scripts/cleanfile\n\n";
3532                         $rpt_cleaners = 0;
3533                 }
3534         }
3535
3536         if (keys %ignore_type) {
3537             print "NOTE: Ignored message types:";
3538             foreach my $ignore (sort keys %ignore_type) {
3539                 print " $ignore";
3540             }
3541             print "\n";
3542             print "\n" if ($quiet == 0);
3543         }
3544
3545         if ($clean == 1 && $quiet == 0) {
3546                 print "$vname has no obvious style problems and is ready for submission.\n"
3547         }
3548         if ($clean == 0 && $quiet == 0) {
3549                 print << "EOM";
3550 $vname has style problems, please review.
3551
3552 If any of these errors are false positives, please report
3553 them to the maintainer, see CHECKPATCH in MAINTAINERS.
3554 EOM
3555         }
3556
3557         return $clean;
3558 }