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