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