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