LXR linux/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
   8use strict;
   9
  10my $P = $0;
  11$P =~ s@.*/@@g;
  12
  13my $V = '0.32';
  14
  15use Getopt::Long qw(:config no_auto_abbrev);
  16
  17my $quiet = 0;
  18my $tree = 1;
  19my $chk_signoff = 1;
  20my $chk_patch = 1;
  21my $tst_only;
  22my $emacs = 0;
  23my $terse = 0;
  24my $file = 0;
  25my $check = 0;
  26my $summary = 1;
  27my $mailback = 0;
  28my $summary_file = 0;
  29my $show_types = 0;
  30my $root;
  31my %debug;
  32my %ignore_type = ();
  33my @ignore = ();
  34my $help = 0;
  35my $configuration_file = ".checkpatch.conf";
  36
  37sub help {
  38        my ($exitcode) = @_;
  39
  40        print << "EOM";
  41Usage: $P [OPTION]... [FILE]...
  42Version: $V
  43
  44Options:
  45  -q, --quiet                quiet
  46  --no-tree                  run without a kernel tree
  47  --no-signoff               do not check for 'Signed-off-by' line
  48  --patch                    treat FILE as patchfile (default)
  49  --emacs                    emacs compile window format
  50  --terse                    one line per report
  51  -f, --file                 treat FILE as regular source file
  52  --subjective, --strict     enable more subjective tests
  53  --ignore TYPE(,TYPE2...)   ignore various comma separated message types
  54  --show-types               show the message "types" in the output
  55  --root=PATH                PATH to the kernel tree root
  56  --no-summary               suppress the per-file summary
  57  --mailback                 only produce a report in case of warnings/errors
  58  --summary-file             include the filename in summary
  59  --debug KEY=[0|1]          turn on/off debugging of KEY, where KEY is one of
  60                             'values', 'possible', 'type', and 'attr' (default
  61                             is all off)
  62  --test-only=WORD           report only warnings/errors containing WORD
  63                             literally
  64  -h, --help, --version      display this help and exit
  65
  66When FILE is - read standard input.
  67EOM
  68
  69        exit($exitcode);
  70}
  71
  72my $conf = which_conf($configuration_file);
  73if (-f $conf) {
  74        my @conf_args;
  75        open(my $conffile, '<', "$conf")
  76            or warn "$P: Can't find a readable $configuration_file file $!\n";
  77
  78        while (<$conffile>) {
  79                my $line = $_;
  80
  81                $line =~ s/\s*\n?$//g;
  82                $line =~ s/^\s*//g;
  83                $line =~ s/\s+/ /g;
  84
  85                next if ($line =~ m/^\s*#/);
  86                next if ($line =~ m/^\s*$/);
  87
  88                my @words = split(" ", $line);
  89                foreach my $word (@words) {
  90                        last if ($word =~ m/^#/);
  91                        push (@conf_args, $word);
  92                }
  93        }
  94        close($conffile);
  95        unshift(@ARGV, @conf_args) if @conf_args;
  96}
  97
  98GetOptions(
  99        'q|quiet+'      => \$quiet,
 100        'tree!'         => \$tree,
 101        'signoff!'      => \$chk_signoff,
 102        'patch!'        => \$chk_patch,
 103        'emacs!'        => \$emacs,
 104        'terse!'        => \$terse,
 105        'f|file!'       => \$file,
 106        'subjective!'   => \$check,
 107        'strict!'       => \$check,
 108        'ignore=s'      => \@ignore,
 109        'show-types!'   => \$show_types,
 110        'root=s'        => \$root,
 111        'summary!'      => \$summary,
 112        'mailback!'     => \$mailback,
 113        'summary-file!' => \$summary_file,
 114
 115        'debug=s'       => \%debug,
 116        'test-only=s'   => \$tst_only,
 117        'h|help'        => \$help,
 118        'version'       => \$help
 119) or help(1);
 120
 121help(0) if ($help);
 122
 123my $exit = 0;
 124
 125if ($#ARGV < 0) {
 126        print "$P: no input files\n";
 127        exit(1);
 128}
 129
 130@ignore = split(/,/, join(',',@ignore));
 131foreach my $word (@ignore) {
 132        $word =~ s/\s*\n?$//g;
 133        $word =~ s/^\s*//g;
 134        $word =~ s/\s+/ /g;
 135        $word =~ tr/[a-z]/[A-Z]/;
 136
 137        next if ($word =~ m/^\s*#/);
 138        next if ($word =~ m/^\s*$/);
 139
 140        $ignore_type{$word}++;
 141}
 142
 143my $dbg_values = 0;
 144my $dbg_possible = 0;
 145my $dbg_type = 0;
 146my $dbg_attr = 0;
 147for my $key (keys %debug) {
 148        ## no critic
 149        eval "\${dbg_$key} = '$debug{$key}';";
 150        die "$@" if ($@);
 151}
 152
 153my $rpt_cleaners = 0;
 154
 155if ($terse) {
 156        $emacs = 1;
 157        $quiet++;
 158}
 159
 160if ($tree) {
 161        if (defined $root) {
 162                if (!top_of_kernel_tree($root)) {
 163                        die "$P: $root: --root does not point at a valid tree\n";
 164                }
 165        } else {
 166                if (top_of_kernel_tree('.')) {
 167                        $root = '.';
 168                } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
 169                                                top_of_kernel_tree($1)) {
 170                        $root = $1;
 171                }
 172        }
 173
 174        if (!defined $root) {
 175                print "Must be run from the top-level dir. of a kernel tree\n";
 176                exit(2);
 177        }
 178}
 179
 180my $emitted_corrupt = 0;
 181
 182our $Ident      = qr{
 183                        [A-Za-z_][A-Za-z\d_]*
 184                        (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
 185                }x;
 186our $Storage    = qr{extern|static|asmlinkage};
 187our $Sparse     = qr{
 188                        __user|
 189                        __kernel|
 190                        __force|
 191                        __iomem|
 192                        __must_check|
 193                        __init_refok|
 194                        __kprobes|
 195                        __ref|
 196                        __rcu
 197                }x;
 198
 199# Notes to $Attribute:
 200# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
 201our $Attribute  = qr{
 202                        const|
 203                        __percpu|
 204                        __nocast|
 205                        __safe|
 206                        __bitwise__|
 207                        __packed__|
 208                        __packed2__|
 209                        __naked|
 210                        __maybe_unused|
 211                        __always_unused|
 212                        __noreturn|
 213                        __used|
 214                        __cold|
 215                        __noclone|
 216                        __deprecated|
 217                        __read_mostly|
 218                        __kprobes|
 219                        __(?:mem|cpu|dev|)(?:initdata|initconst|init\b)|
 220                        ____cacheline_aligned|
 221                        ____cacheline_aligned_in_smp|
 222                        ____cacheline_internodealigned_in_smp|
 223                        __weak
 224                  }x;
 225our $Modifier;
 226our $Inline     = qr{inline|__always_inline|noinline};
 227our $Member     = qr{->$Ident|\.$Ident|\[[^]]*\]};
 228our $Lval       = qr{$Ident(?:$Member)*};
 229
 230our $Constant   = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
 231our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
 232our $Compare    = qr{<=|>=|==|!=|<|>};
 233our $Operators  = qr{
 234                        <=|>=|==|!=|
 235                        =>|->|<<|>>|<|>|!|~|
 236                        &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
 237                  }x;
 238
 239our $NonptrType;
 240our $Type;
 241our $Declare;
 242
 243our $NON_ASCII_UTF8     = qr{
 244        [\xC2-\xDF][\x80-\xBF]               # non-overlong 2-byte
 245        |  \xE0[\xA0-\xBF][\x80-\xBF]        # excluding overlongs
 246        | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2}  # straight 3-byte
 247        |  \xED[\x80-\x9F][\x80-\xBF]        # excluding surrogates
 248        |  \xF0[\x90-\xBF][\x80-\xBF]{2}     # planes 1-3
 249        | [\xF1-\xF3][\x80-\xBF]{3}          # planes 4-15
 250        |  \xF4[\x80-\x8F][\x80-\xBF]{2}     # plane 16
 251}x;
 252
 253our $UTF8       = qr{
 254        [\x09\x0A\x0D\x20-\x7E]              # ASCII
 255        | $NON_ASCII_UTF8
 256}x;
 257
 258our $typeTypedefs = qr{(?x:
 259        (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
 260        atomic_t
 261)};
 262
 263our $logFunctions = qr{(?x:
 264        printk(?:_ratelimited|_once|)|
 265        [a-z0-9]+_(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
 266        WARN(?:_RATELIMIT|_ONCE|)|
 267        panic|
 268        MODULE_[A-Z_]+
 269)};
 270
 271our $signature_tags = qr{(?xi:
 272        Signed-off-by:|
 273        Acked-by:|
 274        Tested-by:|
 275        Reviewed-by:|
 276        Reported-by:|
 277        To:|
 278        Cc:
 279)};
 280
 281our @typeList = (
 282        qr{void},
 283        qr{(?:unsigned\s+)?char},
 284        qr{(?:unsigned\s+)?short},
 285        qr{(?:unsigned\s+)?int},
 286        qr{(?:unsigned\s+)?long},
 287        qr{(?:unsigned\s+)?long\s+int},
 288        qr{(?:unsigned\s+)?long\s+long},
 289        qr{(?:unsigned\s+)?long\s+long\s+int},
 290        qr{unsigned},
 291        qr{float},
 292        qr{double},
 293        qr{bool},
 294        qr{struct\s+$Ident},
 295        qr{union\s+$Ident},
 296        qr{enum\s+$Ident},
 297        qr{${Ident}_t},
 298        qr{${Ident}_handler},
 299        qr{${Ident}_handler_fn},
 300);
 301our @modifierList = (
 302        qr{fastcall},
 303);
 304
 305our $allowed_asm_includes = qr{(?x:
 306        irq|
 307        memory
 308)};
 309# memory.h: ARM has a custom one
 310
 311sub build_types {
 312        my $mods = "(?x:  \n" . join("|\n  ", @modifierList) . "\n)";
 313        my $all = "(?x:  \n" . join("|\n  ", @typeList) . "\n)";
 314        $Modifier       = qr{(?:$Attribute|$Sparse|$mods)};
 315        $NonptrType     = qr{
 316                        (?:$Modifier\s+|const\s+)*
 317                        (?:
 318                                (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
 319                                (?:$typeTypedefs\b)|
 320                                (?:${all}\b)
 321                        )
 322                        (?:\s+$Modifier|\s+const)*
 323                  }x;
 324        $Type   = qr{
 325                        $NonptrType
 326                        (?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)?
 327                        (?:\s+$Inline|\s+$Modifier)*
 328                  }x;
 329        $Declare        = qr{(?:$Storage\s+)?$Type};
 330}
 331build_types();
 332
 333our $match_balanced_parentheses = qr/(\((?:[^\(\)]+|(-1))*\))/;
 334
 335our $Typecast   = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
 336our $LvalOrFunc = qr{($Lval)\s*($match_balanced_parentheses{0,1})\s*};
 337
 338sub deparenthesize {
 339        my ($string) = @_;
 340        return "" if (!defined($string));
 341        $string =~ s@^\s*\(\s*@@g;
 342        $string =~ s@\s*\)\s*$@@g;
 343        $string =~ s@\s+@ @g;
 344        return $string;
 345}
 346
 347$chk_signoff = 0 if ($file);
 348
 349my @dep_includes = ();
 350my @dep_functions = ();
 351my $removal = "Documentation/feature-removal-schedule.txt";
 352if ($tree && -f "$root/$removal") {
 353        open(my $REMOVE, '<', "$root/$removal") ||
 354                                die "$P: $removal: open failed - $!\n";
 355        while (<$REMOVE>) {
 356                if (/^Check:\s+(.*\S)/) {
 357                        for my $entry (split(/[, ]+/, $1)) {
 358                                if ($entry =~ m@include/(.*)@) {
 359                                        push(@dep_includes, $1);
 360
 361                                } elsif ($entry !~ m@/@) {
 362                                        push(@dep_functions, $entry);
 363                                }
 364                        }
 365                }
 366        }
 367        close($REMOVE);
 368}
 369
 370my @rawlines = ();
 371my @lines = ();
 372my $vname;
 373for my $filename (@ARGV) {
 374        my $FILE;
 375        if ($file) {
 376                open($FILE, '-|', "diff -u /dev/null $filename") ||
 377                        die "$P: $filename: diff failed - $!\n";
 378        } elsif ($filename eq '-') {
 379                open($FILE, '<&STDIN');
 380        } else {
 381                open($FILE, '<', "$filename") ||
 382                        die "$P: $filename: open failed - $!\n";
 383        }
 384        if ($filename eq '-') {
 385                $vname = 'Your patch';
 386        } else {
 387                $vname = $filename;
 388        }
 389        while (<$FILE>) {
 390                chomp;
 391                push(@rawlines, $_);
 392        }
 393        close($FILE);
 394        if (!process($filename)) {
 395                $exit = 1;
 396        }
 397        @rawlines = ();
 398        @lines = ();
 399}
 400
 401exit($exit);
 402
 403sub top_of_kernel_tree {
 404        my ($root) = @_;
 405
 406        my @tree_check = (
 407                "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
 408                "README", "Documentation", "arch", "include", "drivers",
 409                "fs", "init", "ipc", "kernel", "lib", "scripts",
 410        );
 411
 412        foreach my $check (@tree_check) {
 413                if (! -e $root . '/' . $check) {
 414                        return 0;
 415                }
 416        }
 417        return 1;
 418    }
 419
 420sub parse_email {
 421        my ($formatted_email) = @_;
 422
 423        my $name = "";
 424        my $address = "";
 425        my $comment = "";
 426
 427        if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
 428                $name = $1;
 429                $address = $2;
 430                $comment = $3 if defined $3;
 431        } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
 432                $address = $1;
 433                $comment = $2 if defined $2;
 434        } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
 435                $address = $1;
 436                $comment = $2 if defined $2;
 437                $formatted_email =~ s/$address.*$//;
 438                $name = $formatted_email;
 439                $name =~ s/^\s+|\s+$//g;
 440                $name =~ s/^\"|\"$//g;
 441                # If there's a name left after stripping spaces and
 442                # leading quotes, and the address doesn't have both
 443                # leading and trailing angle brackets, the address
 444                # is invalid. ie:
 445                #   "joe smith joe@smith.com" bad
 446                #   "joe smith <joe@smith.com" bad
 447                if ($name ne "" && $address !~ /^<[^>]+>$/) {
 448                        $name = "";
 449                        $address = "";
 450                        $comment = "";
 451                }
 452        }
 453
 454        $name =~ s/^\s+|\s+$//g;
 455        $name =~ s/^\"|\"$//g;
 456        $address =~ s/^\s+|\s+$//g;
 457        $address =~ s/^\<|\>$//g;
 458
 459        if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
 460                $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
 461                $name = "\"$name\"";
 462        }
 463
 464        return ($name, $address, $comment);
 465}
 466
 467sub format_email {
 468        my ($name, $address) = @_;
 469
 470        my $formatted_email;
 471
 472        $name =~ s/^\s+|\s+$//g;
 473        $name =~ s/^\"|\"$//g;
 474        $address =~ s/^\s+|\s+$//g;
 475
 476        if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
 477                $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
 478                $name = "\"$name\"";
 479        }
 480
 481        if ("$name" eq "") {
 482                $formatted_email = "$address";
 483        } else {
 484                $formatted_email = "$name <$address>";
 485        }
 486
 487        return $formatted_email;
 488}
 489
 490sub which_conf {
 491        my ($conf) = @_;
 492
 493        foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
 494                if (-e "$path/$conf") {
 495                        return "$path/$conf";
 496                }
 497        }
 498
 499        return "";
 500}
 501
 502sub expand_tabs {
 503        my ($str) = @_;
 504
 505        my $res = '';
 506        my $n = 0;
 507        for my $c (split(//, $str)) {
 508                if ($c eq "\t") {
 509                        $res .= ' ';
 510                        $n++;
 511                        for (; ($n % 8) != 0; $n++) {
 512                                $res .= ' ';
 513                        }
 514                        next;
 515                }
 516                $res .= $c;
 517                $n++;
 518        }
 519
 520        return $res;
 521}
 522sub copy_spacing {
 523        (my $res = shift) =~ tr/\t/ /c;
 524        return $res;
 525}
 526
 527sub line_stats {
 528        my ($line) = @_;
 529
 530        # Drop the diff line leader and expand tabs
 531        $line =~ s/^.//;
 532        $line = expand_tabs($line);
 533
 534        # Pick the indent from the front of the line.
 535        my ($white) = ($line =~ /^(\s*)/);
 536
 537        return (length($line), length($white));
 538}
 539
 540my $sanitise_quote = '';
 541
 542sub sanitise_line_reset {
 543        my ($in_comment) = @_;
 544
 545        if ($in_comment) {
 546                $sanitise_quote = '*/';
 547        } else {
 548                $sanitise_quote = '';
 549        }
 550}
 551sub sanitise_line {
 552        my ($line) = @_;
 553
 554        my $res = '';
 555        my $l = '';
 556
 557        my $qlen = 0;
 558        my $off = 0;
 559        my $c;
 560
 561        # Always copy over the diff marker.
 562        $res = substr($line, 0, 1);
 563
 564        for ($off = 1; $off < length($line); $off++) {
 565                $c = substr($line, $off, 1);
 566
 567                # Comments we are wacking completly including the begin
 568                # and end, all to $;.
 569                if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
 570                        $sanitise_quote = '*/';
 571
 572                        substr($res, $off, 2, "$;$;");
 573                        $off++;
 574                        next;
 575                }
 576                if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
 577                        $sanitise_quote = '';
 578                        substr($res, $off, 2, "$;$;");
 579                        $off++;
 580                        next;
 581                }
 582                if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
 583                        $sanitise_quote = '//';
 584
 585                        substr($res, $off, 2, $sanitise_quote);
 586                        $off++;
 587                        next;
 588                }
 589
 590                # A \ in a string means ignore the next character.
 591                if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
 592                    $c eq "\\") {
 593                        substr($res, $off, 2, 'XX');
 594                        $off++;
 595                        next;
 596                }
 597                # Regular quotes.
 598                if ($c eq "'" || $c eq '"') {
 599                        if ($sanitise_quote eq '') {
 600                                $sanitise_quote = $c;
 601
 602                                substr($res, $off, 1, $c);
 603                                next;
 604                        } elsif ($sanitise_quote eq $c) {
 605                                $sanitise_quote = '';
 606                        }
 607                }
 608
 609                #print "c<$c> SQ<$sanitise_quote>\n";
 610                if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
 611                        substr($res, $off, 1, $;);
 612                } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
 613                        substr($res, $off, 1, $;);
 614                } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
 615                        substr($res, $off, 1, 'X');
 616                } else {
 617                        substr($res, $off, 1, $c);
 618                }
 619        }
 620
 621        if ($sanitise_quote eq '//') {
 622                $sanitise_quote = '';
 623        }
 624
 625        # The pathname on a #include may be surrounded by '<' and '>'.
 626        if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
 627                my $clean = 'X' x length($1);
 628                $res =~ s@\<.*\>@<$clean>@;
 629
 630        # The whole of a #error is a string.
 631        } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
 632                my $clean = 'X' x length($1);
 633                $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
 634        }
 635
 636        return $res;
 637}
 638
 639sub ctx_statement_block {
 640        my ($linenr, $remain, $off) = @_;
 641        my $line = $linenr - 1;
 642        my $blk = '';
 643        my $soff = $off;
 644        my $coff = $off - 1;
 645        my $coff_set = 0;
 646
 647        my $loff = 0;
 648
 649        my $type = '';
 650        my $level = 0;
 651        my @stack = ();
 652        my $p;
 653        my $c;
 654        my $len = 0;
 655
 656        my $remainder;
 657        while (1) {
 658                @stack = (['', 0]) if ($#stack == -1);
 659
 660                #warn "CSB: blk<$blk> remain<$remain>\n";
 661                # If we are about to drop off the end, pull in more
 662                # context.
 663                if ($off >= $len) {
 664                        for (; $remain > 0; $line++) {
 665                                last if (!defined $lines[$line]);
 666                                next if ($lines[$line] =~ /^-/);
 667                                $remain--;
 668                                $loff = $len;
 669                                $blk .= $lines[$line] . "\n";
 670                                $len = length($blk);
 671                                $line++;
 672                                last;
 673                        }
 674                        # Bail if there is no further context.
 675                        #warn "CSB: blk<$blk> off<$off> len<$len>\n";
 676                        if ($off >= $len) {
 677                                last;
 678                        }
 679                }
 680                $p = $c;
 681                $c = substr($blk, $off, 1);
 682                $remainder = substr($blk, $off);
 683
 684                #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
 685
 686                # Handle nested #if/#else.
 687                if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
 688                        push(@stack, [ $type, $level ]);
 689                } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
 690                        ($type, $level) = @{$stack[$#stack - 1]};
 691                } elsif ($remainder =~ /^#\s*endif\b/) {
 692                        ($type, $level) = @{pop(@stack)};
 693                }
 694
 695                # Statement ends at the ';' or a close '}' at the
 696                # outermost level.
 697                if ($level == 0 && $c eq ';') {
 698                        last;
 699                }
 700
 701                # An else is really a conditional as long as its not else if
 702                if ($level == 0 && $coff_set == 0 &&
 703                                (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
 704                                $remainder =~ /^(else)(?:\s|{)/ &&
 705                                $remainder !~ /^else\s+if\b/) {
 706                        $coff = $off + length($1) - 1;
 707                        $coff_set = 1;
 708                        #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
 709                        #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
 710                }
 711
 712                if (($type eq '' || $type eq '(') && $c eq '(') {
 713                        $level++;
 714                        $type = '(';
 715                }
 716                if ($type eq '(' && $c eq ')') {
 717                        $level--;
 718                        $type = ($level != 0)? '(' : '';
 719
 720                        if ($level == 0 && $coff < $soff) {
 721                                $coff = $off;
 722                                $coff_set = 1;
 723                                #warn "CSB: mark coff<$coff>\n";
 724                        }
 725                }
 726                if (($type eq '' || $type eq '{') && $c eq '{') {
 727                        $level++;
 728                        $type = '{';
 729                }
 730                if ($type eq '{' && $c eq '}') {
 731                        $level--;
 732                        $type = ($level != 0)? '{' : '';
 733
 734                        if ($level == 0) {
 735                                if (substr($blk, $off + 1, 1) eq ';') {
 736                                        $off++;
 737                                }
 738                                last;
 739                        }
 740                }
 741                $off++;
 742        }
 743        # We are truly at the end, so shuffle to the next line.
 744        if ($off == $len) {
 745                $loff = $len + 1;
 746                $line++;
 747                $remain--;
 748        }
 749
 750        my $statement = substr($blk, $soff, $off - $soff + 1);
 751        my $condition = substr($blk, $soff, $coff - $soff + 1);
 752
 753        #warn "STATEMENT<$statement>\n";
 754        #warn "CONDITION<$condition>\n";
 755
 756        #print "coff<$coff> soff<$off> loff<$loff>\n";
 757
 758        return ($statement, $condition,
 759                        $line, $remain + 1, $off - $loff + 1, $level);
 760}
 761
 762sub statement_lines {
 763        my ($stmt) = @_;
 764
 765        # Strip the diff line prefixes and rip blank lines at start and end.
 766        $stmt =~ s/(^|\n)./$1/g;
 767        $stmt =~ s/^\s*//;
 768        $stmt =~ s/\s*$//;
 769
 770        my @stmt_lines = ($stmt =~ /\n/g);
 771
 772        return $#stmt_lines + 2;
 773}
 774
 775sub statement_rawlines {
 776        my ($stmt) = @_;
 777
 778        my @stmt_lines = ($stmt =~ /\n/g);
 779
 780        return $#stmt_lines + 2;
 781}
 782
 783sub statement_block_size {
 784        my ($stmt) = @_;
 785
 786        $stmt =~ s/(^|\n)./$1/g;
 787        $stmt =~ s/^\s*{//;
 788        $stmt =~ s/}\s*$//;
 789        $stmt =~ s/^\s*//;
 790        $stmt =~ s/\s*$//;
 791
 792        my @stmt_lines = ($stmt =~ /\n/g);
 793        my @stmt_statements = ($stmt =~ /;/g);
 794
 795        my $stmt_lines = $#stmt_lines + 2;
 796        my $stmt_statements = $#stmt_statements + 1;
 797
 798        if ($stmt_lines > $stmt_statements) {
 799                return $stmt_lines;
 800        } else {
 801                return $stmt_statements;
 802        }
 803}
 804
 805sub ctx_statement_full {
 806        my ($linenr, $remain, $off) = @_;
 807        my ($statement, $condition, $level);
 808
 809        my (@chunks);
 810
 811        # Grab the first conditional/block pair.
 812        ($statement, $condition, $linenr, $remain, $off, $level) =
 813                                ctx_statement_block($linenr, $remain, $off);
 814        #print "F: c<$condition> s<$statement> remain<$remain>\n";
 815        push(@chunks, [ $condition, $statement ]);
 816        if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
 817                return ($level, $linenr, @chunks);
 818        }
 819
 820        # Pull in the following conditional/block pairs and see if they
 821        # could continue the statement.
 822        for (;;) {
 823                ($statement, $condition, $linenr, $remain, $off, $level) =
 824                                ctx_statement_block($linenr, $remain, $off);
 825                #print "C: c<$condition> s<$statement> remain<$remain>\n";
 826                last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
 827                #print "C: push\n";
 828                push(@chunks, [ $condition, $statement ]);
 829        }
 830
 831        return ($level, $linenr, @chunks);
 832}
 833
 834sub ctx_block_get {
 835        my ($linenr, $remain, $outer, $open, $close, $off) = @_;
 836        my $line;
 837        my $start = $linenr - 1;
 838        my $blk = '';
 839        my @o;
 840        my @c;
 841        my @res = ();
 842
 843        my $level = 0;
 844        my @stack = ($level);
 845        for ($line = $start; $remain > 0; $line++) {
 846                next if ($rawlines[$line] =~ /^-/);
 847                $remain--;
 848
 849                $blk .= $rawlines[$line];
 850
 851                # Handle nested #if/#else.
 852                if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
 853                        push(@stack, $level);
 854                } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
 855                        $level = $stack[$#stack - 1];
 856                } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
 857                        $level = pop(@stack);
 858                }
 859
 860                foreach my $c (split(//, $lines[$line])) {
 861                        ##print "C<$c>L<$level><$open$close>O<$off>\n";
 862                        if ($off > 0) {
 863                                $off--;
 864                                next;
 865                        }
 866
 867                        if ($c eq $close && $level > 0) {
 868                                $level--;
 869                                last if ($level == 0);
 870                        } elsif ($c eq $open) {
 871                                $level++;
 872                        }
 873                }
 874
 875                if (!$outer || $level <= 1) {
 876                        push(@res, $rawlines[$line]);
 877                }
 878
 879                last if ($level == 0);
 880        }
 881
 882        return ($level, @res);
 883}
 884sub ctx_block_outer {
 885        my ($linenr, $remain) = @_;
 886
 887        my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
 888        return @r;
 889}
 890sub ctx_block {
 891        my ($linenr, $remain) = @_;
 892
 893        my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
 894        return @r;
 895}
 896sub ctx_statement {
 897        my ($linenr, $remain, $off) = @_;
 898
 899        my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
 900        return @r;
 901}
 902sub ctx_block_level {
 903        my ($linenr, $remain) = @_;
 904
 905        return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
 906}
 907sub ctx_statement_level {
 908        my ($linenr, $remain, $off) = @_;
 909
 910        return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
 911}
 912
 913sub ctx_locate_comment {
 914        my ($first_line, $end_line) = @_;
 915
 916        # Catch a comment on the end of the line itself.
 917        my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
 918        return $current_comment if (defined $current_comment);
 919
 920        # Look through the context and try and figure out if there is a
 921        # comment.
 922        my $in_comment = 0;
 923        $current_comment = '';
 924        for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
 925                my $line = $rawlines[$linenr - 1];
 926                #warn "           $line\n";
 927                if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
 928                        $in_comment = 1;
 929                }
 930                if ($line =~ m@/\*@) {
 931                        $in_comment = 1;
 932                }
 933                if (!$in_comment && $current_comment ne '') {
 934                        $current_comment = '';
 935                }
 936                $current_comment .= $line . "\n" if ($in_comment);
 937                if ($line =~ m@\*/@) {
 938                        $in_comment = 0;
 939                }
 940        }
 941
 942        chomp($current_comment);
 943        return($current_comment);
 944}
 945sub ctx_has_comment {
 946        my ($first_line, $end_line) = @_;
 947        my $cmt = ctx_locate_comment($first_line, $end_line);
 948
 949        ##print "LINE: $rawlines[$end_line - 1 ]\n";
 950        ##print "CMMT: $cmt\n";
 951
 952        return ($cmt ne '');
 953}
 954
 955sub raw_line {
 956        my ($linenr, $cnt) = @_;
 957
 958        my $offset = $linenr - 1;
 959        $cnt++;
 960
 961        my $line;
 962        while ($cnt) {
 963                $line = $rawlines[$offset++];
 964                next if (defined($line) && $line =~ /^-/);
 965                $cnt--;
 966        }
 967
 968        return $line;
 969}
 970
 971sub cat_vet {
 972        my ($vet) = @_;
 973        my ($res, $coded);
 974
 975        $res = '';
 976        while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
 977                $res .= $1;
 978                if ($2 ne '') {
 979                        $coded = sprintf("^%c", unpack('C', $2) + 64);
 980                        $res .= $coded;
 981                }
 982        }
 983        $res =~ s/$/\$/;
 984
 985        return $res;
 986}
 987
 988my $av_preprocessor = 0;
 989my $av_pending;
 990my @av_paren_type;
 991my $av_pend_colon;
 992
 993sub annotate_reset {
 994        $av_preprocessor = 0;
 995        $av_pending = '_';
 996        @av_paren_type = ('E');
 997        $av_pend_colon = 'O';
 998}
 999
1000sub annotate_values {

1001        my ($stream, $type) = @_;
1002
1003        my $res;
1004        my $var = '_' x length($stream);
1005        my $cur = $stream;
1006
1007        print "$stream\n" if ($dbg_values > 1);
1008
1009        while (length($cur)) {
1010                @av_paren_type = ('E') if ($#av_paren_type < 0);
1011                print " <" . join('', @av_paren_type) .
1012                                "> <$type> <$av_pending>" if ($dbg_values > 1);
1013                if ($cur =~ /^(\s+)/o) {
1014                        print "WS($1)\n" if ($dbg_values > 1);
1015                        if ($1 =~ /\n/ && $av_preprocessor) {
1016                                $type = pop(@av_paren_type);
1017                                $av_preprocessor = 0;
1018                        }
1019
1020                } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1021                        print "CAST($1)\n" if ($dbg_values > 1);
1022                        push(@av_paren_type, $type);
1023                        $type = 'C';
1024
1025                } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1026                        print "DECLARE($1)\n" if ($dbg_values > 1);
1027                        $type = 'T';
1028
1029                } elsif ($cur =~ /^($Modifier)\s*/) {
1030                        print "MODIFIER($1)\n" if ($dbg_values > 1);
1031                        $type = 'T';
1032
1033                } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1034                        print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1035                        $av_preprocessor = 1;
1036                        push(@av_paren_type, $type);
1037                        if ($2 ne '') {
1038                                $av_pending = 'N';
1039                        }
1040                        $type = 'E';
1041
1042                } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1043                        print "UNDEF($1)\n" if ($dbg_values > 1);
1044                        $av_preprocessor = 1;
1045                        push(@av_paren_type, $type);
1046
1047                } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1048                        print "PRE_START($1)\n" if ($dbg_values > 1);
1049                        $av_preprocessor = 1;
1050
1051                        push(@av_paren_type, $type);
1052                        push(@av_paren_type, $type);
1053                        $type = 'E';
1054
1055                } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1056                        print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1057                        $av_preprocessor = 1;
1058
1059                        push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1060
1061                        $type = 'E';
1062
1063                } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1064                        print "PRE_END($1)\n" if ($dbg_values > 1);
1065
1066                        $av_preprocessor = 1;
1067
1068                        # Assume all arms of the conditional end as this
1069                        # one does, and continue as if the #endif was not here.
1070                        pop(@av_paren_type);
1071                        push(@av_paren_type, $type);
1072                        $type = 'E';
1073
1074                } elsif ($cur =~ /^(\\\n)/o) {
1075                        print "PRECONT($1)\n" if ($dbg_values > 1);
1076
1077                } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1078                        print "ATTR($1)\n" if ($dbg_values > 1);
1079                        $av_pending = $type;
1080                        $type = 'N';
1081
1082                } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1083                        print "SIZEOF($1)\n" if ($dbg_values > 1);
1084                        if (defined $2) {
1085                                $av_pending = 'V';
1086                        }
1087                        $type = 'N';
1088
1089                } elsif ($cur =~ /^(if|while|for)\b/o) {
1090                        print "COND($1)\n" if ($dbg_values > 1);
1091                        $av_pending = 'E';
1092                        $type = 'N';
1093
1094                } elsif ($cur =~/^(case)/o) {
1095                        print "CASE($1)\n" if ($dbg_values > 1);
1096                        $av_pend_colon = 'C';
1097                        $type = 'N';
1098
1099                } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1100                        print "KEYWORD($1)\n" if ($dbg_values > 1);
1101                        $type = 'N';
1102
1103                } elsif ($cur =~ /^(\()/o) {
1104                        print "PAREN('$1')\n" if ($dbg_values > 1);
1105                        push(@av_paren_type, $av_pending);
1106                        $av_pending = '_';
1107                        $type = 'N';
1108
1109                } elsif ($cur =~ /^(\))/o) {
1110                        my $new_type = pop(@av_paren_type);
1111                        if ($new_type ne '_') {
1112                                $type = $new_type;
1113                                print "PAREN('$1') -> $type\n"
1114                                                        if ($dbg_values > 1);
1115                        } else {
1116                                print "PAREN('$1')\n" if ($dbg_values > 1);
1117                        }
1118
1119                } elsif ($cur =~ /^($Ident)\s*\(/o) {
1120                        print "FUNC($1)\n" if ($dbg_values > 1);
1121                        $type = 'V';
1122                        $av_pending = 'V';
1123
1124                } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1125                        if (defined $2 && $type eq 'C' || $type eq 'T') {
1126                                $av_pend_colon = 'B';
1127                        } elsif ($type eq 'E') {
1128                                $av_pend_colon = 'L';
1129                        }
1130                        print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1131                        $type = 'V';
1132
1133                } elsif ($cur =~ /^($Ident|$Constant)/o) {
1134                        print "IDENT($1)\n" if ($dbg_values > 1);
1135                        $type = 'V';
1136
1137                } elsif ($cur =~ /^($Assignment)/o) {
1138                        print "ASSIGN($1)\n" if ($dbg_values > 1);
1139                        $type = 'N';
1140
1141                } elsif ($cur =~/^(;|{|})/) {
1142                        print "END($1)\n" if ($dbg_values > 1);
1143                        $type = 'E';
1144                        $av_pend_colon = 'O';
1145
1146                } elsif ($cur =~/^(,)/) {
1147                        print "COMMA($1)\n" if ($dbg_values > 1);
1148                        $type = 'C';
1149
1150                } elsif ($cur =~ /^(\?)/o) {
1151                        print "QUESTION($1)\n" if ($dbg_values > 1);
1152                        $type = 'N';
1153
1154                } elsif ($cur =~ /^(:)/o) {
1155                        print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1156
1157                        substr($var, length($res), 1, $av_pend_colon);
1158                        if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1159                                $type = 'E';
1160                        } else {
1161                                $type = 'N';
1162                        }
1163                        $av_pend_colon = 'O';
1164
1165                } elsif ($cur =~ /^(\[)/o) {
1166                        print "CLOSE($1)\n" if ($dbg_values > 1);
1167                        $type = 'N';
1168
1169                } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1170                        my $variant;
1171
1172                        print "OPV($1)\n" if ($dbg_values > 1);
1173                        if ($type eq 'V') {
1174                                $variant = 'B';
1175                        } else {
1176                                $variant = 'U';
1177                        }
1178
1179                        substr($var, length($res), 1, $variant);
1180                        $type = 'N';
1181
1182                } elsif ($cur =~ /^($Operators)/o) {
1183                        print "OP($1)\n" if ($dbg_values > 1);
1184                        if ($1 ne '++' && $1 ne '--') {
1185                                $type = 'N';
1186                        }
1187
1188                } elsif ($cur =~ /(^.)/o) {
1189                        print "C($1)\n" if ($dbg_values > 1);
1190                }
1191                if (defined $1) {
1192                        $cur = substr($cur, length($1));
1193                        $res .= $type x length($1);
1194                }
1195        }
1196
1197        return ($res, $var);
1198}
1199
1200sub possible {
1201        my ($possible, $line) = @_;
1202        my $notPermitted = qr{(?:
1203                ^(?:
1204                        $Modifier|
1205                        $Storage|
1206                        $Type|
1207                        DEFINE_\S+
1208                )$|
1209                ^(?:
1210                        goto|
1211                        return|
1212                        case|
1213                        else|
1214                        asm|__asm__|
1215                        do
1216                )(?:\s|$)|
1217                ^(?:typedef|struct|enum)\b
1218            )}x;
1219        warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1220        if ($possible !~ $notPermitted) {
1221                # Check for modifiers.
1222                $possible =~ s/\s*$Storage\s*//g;
1223                $possible =~ s/\s*$Sparse\s*//g;
1224                if ($possible =~ /^\s*$/) {
1225
1226                } elsif ($possible =~ /\s/) {
1227                        $possible =~ s/\s*$Type\s*//g;
1228                        for my $modifier (split(' ', $possible)) {
1229                                if ($modifier !~ $notPermitted) {
1230                                        warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1231                                        push(@modifierList, $modifier);
1232                                }
1233                        }
1234
1235                } else {
1236                        warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1237                        push(@typeList, $possible);
1238                }
1239                build_types();
1240        } else {
1241                warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1242        }
1243}
1244
1245my $prefix = '';
1246
1247sub show_type {
1248       return !defined $ignore_type{$_[0]};
1249}
1250
1251sub report {
1252        if (!show_type($_[1]) ||
1253            (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) {
1254                return 0;
1255        }
1256        my $line;
1257        if ($show_types) {
1258                $line = "$prefix$_[0]:$_[1]: $_[2]\n";
1259        } else {
1260                $line = "$prefix$_[0]: $_[2]\n";
1261        }
1262        $line = (split('\n', $line))[0] . "\n" if ($terse);
1263
1264        push(our @report, $line);
1265
1266        return 1;
1267}
1268sub report_dump {
1269        our @report;
1270}
1271
1272sub ERROR {
1273        if (report("ERROR", $_[0], $_[1])) {
1274                our $clean = 0;
1275                our $cnt_error++;
1276        }
1277}
1278sub WARN {
1279        if (report("WARNING", $_[0], $_[1])) {
1280                our $clean = 0;
1281                our $cnt_warn++;
1282        }
1283}
1284sub CHK {
1285        if ($check && report("CHECK", $_[0], $_[1])) {
1286                our $clean = 0;
1287                our $cnt_chk++;
1288        }
1289}
1290
1291sub check_absolute_file {
1292        my ($absolute, $herecurr) = @_;
1293        my $file = $absolute;
1294
1295        ##print "absolute<$absolute>\n";
1296
1297        # See if any suffix of this path is a path within the tree.
1298        while ($file =~ s@^[^/]*/@@) {
1299                if (-f "$root/$file") {
1300                        ##print "file<$file>\n";
1301                        last;
1302                }
1303        }
1304        if (! -f _)  {
1305                return 0;
1306        }
1307
1308        # It is, so see if the prefix is acceptable.
1309        my $prefix = $absolute;
1310        substr($prefix, -length($file)) = '';
1311
1312        ##print "prefix<$prefix>\n";
1313        if ($prefix ne ".../") {
1314                WARN("USE_RELATIVE_PATH",
1315                     "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1316        }
1317}
1318
1319sub process {
1320        my $filename = shift;
1321
1322        my $linenr=0;
1323        my $prevline="";
1324        my $prevrawline="";
1325        my $stashline="";
1326        my $stashrawline="";
1327
1328        my $length;
1329        my $indent;
1330        my $previndent=0;
1331        my $stashindent=0;
1332
1333        our $clean = 1;
1334        my $signoff = 0;
1335        my $is_patch = 0;
1336
1337        my $in_header_lines = 1;
1338        my $in_commit_log = 0;          #Scanning lines before patch
1339
1340        our @report = ();
1341        our $cnt_lines = 0;
1342        our $cnt_error = 0;
1343        our $cnt_warn = 0;
1344        our $cnt_chk = 0;
1345
1346        # Trace the real file/line as we go.
1347        my $realfile = '';
1348        my $realline = 0;
1349        my $realcnt = 0;
1350        my $here = '';
1351        my $in_comment = 0;
1352        my $comment_edge = 0;
1353        my $first_line = 0;
1354        my $p1_prefix = '';
1355
1356        my $prev_values = 'E';
1357
1358        # suppression flags
1359        my %suppress_ifbraces;
1360        my %suppress_whiletrailers;
1361        my %suppress_export;
1362
1363        # Pre-scan the patch sanitizing the lines.
1364        # Pre-scan the patch looking for any __setup documentation.
1365        #
1366        my @setup_docs = ();
1367        my $setup_docs = 0;
1368
1369        sanitise_line_reset();
1370        my $line;
1371        foreach my $rawline (@rawlines) {
1372                $linenr++;
1373                $line = $rawline;
1374
1375                if ($rawline=~/^\+\+\+\s+(\S+)/) {
1376                        $setup_docs = 0;
1377                        if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1378                                $setup_docs = 1;
1379                        }
1380                        #next;
1381                }
1382                if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1383                        $realline=$1-1;
1384                        if (defined $2) {
1385                                $realcnt=$3+1;
1386                        } else {
1387                                $realcnt=1+1;
1388                        }
1389                        $in_comment = 0;
1390
1391                        # Guestimate if this is a continuing comment.  Run
1392                        # the context looking for a comment "edge".  If this
1393                        # edge is a close comment then we must be in a comment
1394                        # at context start.
1395                        my $edge;
1396                        my $cnt = $realcnt;
1397                        for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1398                                next if (defined $rawlines[$ln - 1] &&
1399                                         $rawlines[$ln - 1] =~ /^-/);
1400                                $cnt--;
1401                                #print "RAW<$rawlines[$ln - 1]>\n";
1402                                last if (!defined $rawlines[$ln - 1]);
1403                                if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1404                                    $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1405                                        ($edge) = $1;
1406                                        last;
1407                                }
1408                        }
1409                        if (defined $edge && $edge eq '*/') {
1410                                $in_comment = 1;
1411                        }
1412
1413                        # Guestimate if this is a continuing comment.  If this
1414                        # is the start of a diff block and this line starts
1415                        # ' *' then it is very likely a comment.
1416                        if (!defined $edge &&
1417                            $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1418                        {
1419                                $in_comment = 1;
1420                        }
1421
1422                        ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1423                        sanitise_line_reset($in_comment);
1424
1425                } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1426                        # Standardise the strings and chars within the input to
1427                        # simplify matching -- only bother with positive lines.
1428                        $line = sanitise_line($rawline);
1429                }
1430                push(@lines, $line);
1431
1432                if ($realcnt > 1) {
1433                        $realcnt-- if ($line =~ /^(?:\+| |$)/);
1434                } else {
1435                        $realcnt = 0;
1436                }
1437
1438                #print "==>$rawline\n";
1439                #print "-->$line\n";
1440
1441                if ($setup_docs && $line =~ /^\+/) {
1442                        push(@setup_docs, $line);
1443                }
1444        }
1445
1446        $prefix = '';
1447
1448        $realcnt = 0;
1449        $linenr = 0;
1450        foreach my $line (@lines) {
1451                $linenr++;
1452
1453                my $rawline = $rawlines[$linenr - 1];
1454
1455#extract the line range in the file after the patch is applied
1456                if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1457                        $is_patch = 1;
1458                        $first_line = $linenr + 1;
1459                        $realline=$1-1;
1460                        if (defined $2) {
1461                                $realcnt=$3+1;
1462                        } else {
1463                                $realcnt=1+1;
1464                        }
1465                        annotate_reset();
1466                        $prev_values = 'E';
1467
1468                        %suppress_ifbraces = ();
1469                        %suppress_whiletrailers = ();
1470                        %suppress_export = ();
1471                        next;
1472
1473# track the line number as we move through the hunk, note that
1474# new versions of GNU diff omit the leading space on completely
1475# blank context lines so we need to count that too.
1476                } elsif ($line =~ /^( |\+|$)/) {
1477                        $realline++;
1478                        $realcnt-- if ($realcnt != 0);
1479
1480                        # Measure the line length and indent.
1481                        ($length, $indent) = line_stats($rawline);
1482
1483                        # Track the previous line.
1484                        ($prevline, $stashline) = ($stashline, $line);
1485                        ($previndent, $stashindent) = ($stashindent, $indent);
1486                        ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1487
1488                        #warn "line<$line>\n";
1489
1490                } elsif ($realcnt == 1) {
1491                        $realcnt--;
1492                }
1493
1494                my $hunk_line = ($realcnt != 0);
1495
1496#make up the handle for any error we report on this line
1497                $prefix = "$filename:$realline: " if ($emacs && $file);
1498                $prefix = "$filename:$linenr: " if ($emacs && !$file);
1499
1500                $here = "#$linenr: " if (!$file);
1501                $here = "#$realline: " if ($file);
1502
1503                # extract the filename as it passes
1504                if ($line =~ /^diff --git.*?(\S+)$/) {
1505                        $realfile = $1;
1506                        $realfile =~ s@^([^/]*)/@@;
1507                } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
1508                        $realfile = $1;
1509                        $realfile =~ s@^([^/]*)/@@;
1510
1511                        $p1_prefix = $1;
1512                        if (!$file && $tree && $p1_prefix ne '' &&
1513                            -e "$root/$p1_prefix") {
1514                                WARN("PATCH_PREFIX",
1515                                     "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1516                        }
1517
1518                        if ($realfile =~ m@^include/asm/@) {
1519                                ERROR("MODIFIED_INCLUDE_ASM",
1520                                      "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1521                        }
1522                        next;
1523                }
1524
1525                $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
1526
1527                my $hereline = "$here\n$rawline\n";
1528                my $herecurr = "$here\n$rawline\n";
1529                my $hereprev = "$here\n$prevrawline\n$rawline\n";
1530
1531                $cnt_lines++ if ($realcnt != 0);
1532
1533# Check for incorrect file permissions
1534                if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1535                        my $permhere = $here . "FILE: $realfile\n";
1536                        if ($realfile =~ /(Makefile|Kconfig|\.c|\.h|\.S|\.tmpl)$/) {
1537                                ERROR("EXECUTE_PERMISSIONS",
1538                                      "do not set execute permissions for source files\n" . $permhere);
1539                        }
1540                }
1541
1542# Check the patch for a signoff:
1543                if ($line =~ /^\s*signed-off-by:/i) {
1544                        $signoff++;
1545                        $in_commit_log = 0;
1546                }
1547
1548# Check signature styles
1549                if ($line =~ /^(\s*)($signature_tags)(\s*)(.*)/) {
1550                        my $space_before = $1;
1551                        my $sign_off = $2;
1552                        my $space_after = $3;
1553                        my $email = $4;
1554                        my $ucfirst_sign_off = ucfirst(lc($sign_off));
1555
1556                        if (defined $space_before && $space_before ne "") {
1557                                WARN("BAD_SIGN_OFF",
1558                                     "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr);
1559                        }
1560                        if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
1561                                WARN("BAD_SIGN_OFF",
1562                                     "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr);
1563                        }
1564                        if (!defined $space_after || $space_after ne " ") {
1565                                WARN("BAD_SIGN_OFF",
1566                                     "Use a single space after $ucfirst_sign_off\n" . $herecurr);
1567                        }
1568
1569                        my ($email_name, $email_address, $comment) = parse_email($email);
1570                        my $suggested_email = format_email(($email_name, $email_address));
1571                        if ($suggested_email eq "") {
1572                                ERROR("BAD_SIGN_OFF",
1573                                      "Unrecognized email address: '$email'\n" . $herecurr);
1574                        } else {
1575                                my $dequoted = $suggested_email;
1576                                $dequoted =~ s/^"//;
1577                                $dequoted =~ s/" </ </;
1578                                # Don't force email to have quotes
1579                                # Allow just an angle bracketed address
1580                                if ("$dequoted$comment" ne $email &&
1581                                    "<$email_address>$comment" ne $email &&
1582                                    "$suggested_email$comment" ne $email) {
1583                                        WARN("BAD_SIGN_OFF",
1584                                             "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
1585                                }
1586                        }
1587                }
1588
1589# Check for wrappage within a valid hunk of the file
1590                if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1591                        ERROR("CORRUPTED_PATCH",
1592                              "patch seems to be corrupt (line wrapped?)\n" .
1593                                $herecurr) if (!$emitted_corrupt++);
1594                }
1595
1596# Check for absolute kernel paths.
1597                if ($tree) {
1598                        while ($line =~ m{(?:^|\s)(/\S*)}g) {
1599                                my $file = $1;
1600
1601                                if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1602                                    check_absolute_file($1, $herecurr)) {
1603                                        #
1604                                } else {
1605                                        check_absolute_file($file, $herecurr);
1606                                }
1607                        }
1608                }
1609
1610# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1611                if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1612                    $rawline !~ m/^$UTF8*$/) {
1613                        my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1614
1615                        my $blank = copy_spacing($rawline);
1616                        my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1617                        my $hereptr = "$hereline$ptr\n";
1618
1619                        CHK("INVALID_UTF8",
1620                            "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1621                }
1622
1623# Check if it's the start of a commit log
1624# (not a header line and we haven't seen the patch filename)
1625                if ($in_header_lines && $realfile =~ /^$/ &&
1626                    $rawline !~ /^(commit\b|from\b|\w+:).+$/i) {
1627                        $in_header_lines = 0;
1628                        $in_commit_log = 1;
1629                }
1630
1631# Still not yet in a patch, check for any UTF-8
1632                if ($in_commit_log && $realfile =~ /^$/ &&
1633                    $rawline =~ /$NON_ASCII_UTF8/) {
1634                        CHK("UTF8_BEFORE_PATCH",
1635                            "8-bit UTF-8 used in possible commit log\n" . $herecurr);
1636                }
1637
1638# ignore non-hunk lines and lines being removed
1639                next if (!$hunk_line || $line =~ /^-/);
1640
1641#trailing whitespace
1642                if ($line =~ /^\+.*\015/) {
1643                        my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1644                        ERROR("DOS_LINE_ENDINGS",
1645                              "DOS line endings\n" . $herevet);
1646
1647                } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1648                        my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1649                        ERROR("TRAILING_WHITESPACE",
1650                              "trailing whitespace\n" . $herevet);
1651                        $rpt_cleaners = 1;
1652                }
1653
1654# check for Kconfig help text having a real description
1655# Only applies when adding the entry originally, after that we do not have
1656# sufficient context to determine whether it is indeed long enough.
1657                if ($realfile =~ /Kconfig/ &&
1658                    $line =~ /\+\s*(?:---)?help(?:---)?$/) {
1659                        my $length = 0;
1660                        my $cnt = $realcnt;
1661                        my $ln = $linenr + 1;
1662                        my $f;
1663                        my $is_end = 0;
1664                        while ($cnt > 0 && defined $lines[$ln - 1]) {
1665                                $f = $lines[$ln - 1];
1666                                $cnt-- if ($lines[$ln - 1] !~ /^-/);
1667                                $is_end = $lines[$ln - 1] =~ /^\+/;
1668                                $ln++;
1669
1670                                next if ($f =~ /^-/);
1671                                $f =~ s/^.//;
1672                                $f =~ s/#.*//;
1673                                $f =~ s/^\s+//;
1674                                next if ($f =~ /^$/);
1675                                if ($f =~ /^\s*config\s/) {
1676                                        $is_end = 1;
1677                                        last;
1678                                }
1679                                $length++;
1680                        }
1681                        WARN("CONFIG_DESCRIPTION",
1682                             "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_end && $length < 4);
1683                        #print "is_end<$is_end> length<$length>\n";
1684                }
1685
1686                if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
1687                    ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
1688                        my $flag = $1;
1689                        my $replacement = {
1690                                'EXTRA_AFLAGS' =>   'asflags-y',
1691                                'EXTRA_CFLAGS' =>   'ccflags-y',
1692                                'EXTRA_CPPFLAGS' => 'cppflags-y',
1693                                'EXTRA_LDFLAGS' =>  'ldflags-y',
1694                        };
1695
1696                        WARN("DEPRECATED_VARIABLE",
1697                             "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
1698                }
1699
1700# check we are in a valid source file if not then ignore this hunk
1701                next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1702
1703#80 column limit
1704                if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
1705                    $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1706                    !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
1707                    $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
1708                    $length > 80)
1709                {
1710                        WARN("LONG_LINE",
1711                             "line over 80 characters\n" . $herecurr);
1712                }
1713
1714# check for spaces before a quoted newline
1715                if ($rawline =~ /^.*\".*\s\\n/) {
1716                        WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
1717                             "unnecessary whitespace before a quoted newline\n" . $herecurr);
1718                }
1719
1720# check for adding lines without a newline.
1721                if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1722                        WARN("MISSING_EOF_NEWLINE",
1723                             "adding a line without newline at end of file\n" . $herecurr);
1724                }
1725
1726# Blackfin: use hi/lo macros
1727                if ($realfile =~ m@arch/blackfin/.*\.S$@) {
1728                        if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
1729                                my $herevet = "$here\n" . cat_vet($line) . "\n";
1730                                ERROR("LO_MACRO",
1731                                      "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
1732                        }
1733                        if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
1734                                my $herevet = "$here\n" . cat_vet($line) . "\n";
1735                                ERROR("HI_MACRO",
1736                                      "use the HI() macro, not (... >> 16)\n" . $herevet);
1737                        }
1738                }
1739
1740# check we are in a valid source file C or perl if not then ignore this hunk
1741                next if ($realfile !~ /\.(h|c|pl)$/);
1742
1743# at the beginning of a line any tabs must come first and anything
1744# more than 8 must use tabs.
1745                if ($rawline =~ /^\+\s* \t\s*\S/ ||
1746                    $rawline =~ /^\+\s*        \s*/) {
1747                        my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1748                        ERROR("CODE_INDENT",
1749                              "code indent should use tabs where possible\n" . $herevet);
1750                        $rpt_cleaners = 1;
1751                }
1752
1753# check for space before tabs.
1754                if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
1755                        my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1756                        WARN("SPACE_BEFORE_TAB",
1757                             "please, no space before tabs\n" . $herevet);
1758                }
1759
1760# check for spaces at the beginning of a line.
1761# Exceptions:
1762#  1) within comments
1763#  2) indented preprocessor commands
1764#  3) hanging labels
1765                if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/)  {
1766                        my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1767                        WARN("LEADING_SPACE",
1768                             "please, no spaces at the start of a line\n" . $herevet);
1769                }
1770
1771# check we are in a valid C source file if not then ignore this hunk
1772                next if ($realfile !~ /\.(h|c)$/);
1773
1774# check for RCS/CVS revision markers
1775                if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
1776                        WARN("CVS_KEYWORD",
1777                             "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1778                }
1779
1780# Blackfin: don't use __builtin_bfin_[cs]sync
1781                if ($line =~ /__builtin_bfin_csync/) {
1782                        my $herevet = "$here\n" . cat_vet($line) . "\n";
1783                        ERROR("CSYNC",
1784                              "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
1785                }
1786                if ($line =~ /__builtin_bfin_ssync/) {
1787                        my $herevet = "$here\n" . cat_vet($line) . "\n";
1788                        ERROR("SSYNC",
1789                              "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
1790                }
1791
1792# Check for potential 'bare' types
1793                my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
1794                    $realline_next);
1795                if ($realcnt && $line =~ /.\s*\S/) {
1796                        ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
1797                                ctx_statement_block($linenr, $realcnt, 0);
1798                        $stat =~ s/\n./\n /g;
1799                        $cond =~ s/\n./\n /g;
1800
1801                        # Find the real next line.
1802                        $realline_next = $line_nr_next;
1803                        if (defined $realline_next &&
1804                            (!defined $lines[$realline_next - 1] ||
1805                             substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
1806                                $realline_next++;
1807                        }
1808
1809                        my $s = $stat;
1810                        $s =~ s/{.*$//s;
1811
1812                        # Ignore goto labels.
1813                        if ($s =~ /$Ident:\*$/s) {
1814
1815                        # Ignore functions being called
1816                        } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
1817
1818                        } elsif ($s =~ /^.\s*else\b/s) {
1819
1820                        # declarations always start with types
1821                        } 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) {
1822                                my $type = $1;
1823                                $type =~ s/\s+/ /g;
1824                                possible($type, "A:" . $s);
1825
1826                        # definitions in global scope can only start with types
1827                        } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
1828                                possible($1, "B:" . $s);
1829                        }
1830
1831                        # any (foo ... *) is a pointer cast, and foo is a type
1832                        while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
1833                                possible($1, "C:" . $s);
1834                        }
1835
1836                        # Check for any sort of function declaration.
1837                        # int foo(something bar, other baz);
1838                        # void (*store_gdt)(x86_descr_ptr *);
1839                        if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
1840                                my ($name_len) = length($1);
1841
1842                                my $ctx = $s;
1843                                substr($ctx, 0, $name_len + 1, '');
1844                                $ctx =~ s/\)[^\)]*$//;
1845
1846                                for my $arg (split(/\s*,\s*/, $ctx)) {
1847                                        if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
1848
1849                                                possible($1, "D:" . $s);
1850                                        }
1851                                }
1852                        }
1853
1854                }
1855
1856#
1857# Checks which may be anchored in the context.
1858#
1859
1860# Check for switch () and associated case and default
1861# statements should be at the same indent.
1862                if ($line=~/\bswitch\s*\(.*\)/) {
1863                        my $err = '';
1864                        my $sep = '';
1865                        my @ctx = ctx_block_outer($linenr, $realcnt);
1866                        shift(@ctx);
1867                        for my $ctx (@ctx) {
1868                                my ($clen, $cindent) = line_stats($ctx);
1869                                if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1870                                                        $indent != $cindent) {
1871                                        $err .= "$sep$ctx\n";
1872                                        $sep = '';
1873                                } else {
1874                                        $sep = "[...]\n";
1875                                }
1876                        }
1877                        if ($err ne '') {
1878                                ERROR("SWITCH_CASE_INDENT_LEVEL",
1879                                      "switch and case should be at the same indent\n$hereline$err");
1880                        }
1881                }
1882
1883# if/while/etc brace do not go on next line, unless defining a do while loop,
1884# or if that brace on the next line is for something else
1885                if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
1886                        my $pre_ctx = "$1$2";
1887
1888                        my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
1889                        my $ctx_cnt = $realcnt - $#ctx - 1;
1890                        my $ctx = join("\n", @ctx);
1891
1892                        my $ctx_ln = $linenr;
1893                        my $ctx_skip = $realcnt;
1894
1895                        while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1896                                        defined $lines[$ctx_ln - 1] &&
1897                                        $lines[$ctx_ln - 1] =~ /^-/)) {
1898                                ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1899                                $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
1900                                $ctx_ln++;
1901                        }
1902
1903                        #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1904                        #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
1905
1906                        if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1907                                ERROR("OPEN_BRACE",
1908                                      "that open brace { should be on the previous line\n" .
1909                                        "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
1910                        }
1911                        if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1912                            $ctx =~ /\)\s*\;\s*$/ &&
1913                            defined $lines[$ctx_ln - 1])
1914                        {
1915                                my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1916                                if ($nindent > $indent) {
1917                                        WARN("TRAILING_SEMICOLON",
1918                                             "trailing semicolon indicates no statements, indent implies otherwise\n" .
1919                                                "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
1920                                }
1921                        }
1922                }
1923
1924# Check relative indent for conditionals and blocks.
1925                if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1926                        my ($s, $c) = ($stat, $cond);
1927
1928                        substr($s, 0, length($c), '');
1929
1930                        # Make sure we remove the line prefixes as we have
1931                        # none on the first line, and are going to readd them
1932                        # where necessary.
1933                        $s =~ s/\n./\n/gs;
1934
1935                        # Find out how long the conditional actually is.
1936                        my @newlines = ($c =~ /\n/gs);
1937                        my $cond_lines = 1 + $#newlines;
1938
1939                        # We want to check the first line inside the block
1940                        # starting at the end of the conditional, so remove:
1941                        #  1) any blank line termination
1942                        #  2) any opening brace { on end of the line
1943                        #  3) any do (...) {
1944                        my $continuation = 0;
1945                        my $check = 0;
1946                        $s =~ s/^.*\bdo\b//;
1947                        $s =~ s/^\s*{//;
1948                        if ($s =~ s/^\s*\\//) {
1949                                $continuation = 1;
1950                        }
1951                        if ($s =~ s/^\s*?\n//) {
1952                                $check = 1;
1953                                $cond_lines++;
1954                        }
1955
1956                        # Also ignore a loop construct at the end of a
1957                        # preprocessor statement.
1958                        if (($prevline =~ /^.\s*#\s*define\s/ ||
1959                            $prevline =~ /\\\s*$/) && $continuation == 0) {
1960                                $check = 0;
1961                        }
1962
1963                        my $cond_ptr = -1;
1964                        $continuation = 0;
1965                        while ($cond_ptr != $cond_lines) {
1966                                $cond_ptr = $cond_lines;
1967
1968                                # If we see an #else/#elif then the code
1969                                # is not linear.
1970                                if ($s =~ /^\s*\#\s*(?:else|elif)/) {
1971                                        $check = 0;
1972                                }
1973
1974                                # Ignore:
1975                                #  1) blank lines, they should be at 0,
1976                                #  2) preprocessor lines, and
1977                                #  3) labels.
1978                                if ($continuation ||
1979                                    $s =~ /^\s*?\n/ ||
1980                                    $s =~ /^\s*#\s*?/ ||
1981                                    $s =~ /^\s*$Ident\s*:/) {
1982                                        $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
1983                                        if ($s =~ s/^.*?\n//) {
1984                                                $cond_lines++;
1985                                        }
1986                                }
1987                        }
1988
1989                        my (undef, $sindent) = line_stats("+" . $s);
1990                        my $stat_real = raw_line($linenr, $cond_lines);
1991
1992                        # Check if either of these lines are modified, else
1993                        # this is not this patch's fault.
1994                        if (!defined($stat_real) ||
1995                            $stat !~ /^\+/ && $stat_real !~ /^\+/) {
1996                                $check = 0;
1997                        }
1998                        if (defined($stat_real) && $cond_lines > 1) {
1999                                $stat_real = "[...]\n$stat_real";
2000                        }

2001
2002                        #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";
2003
2004                        if ($check && (($sindent % 8) != 0 ||
2005                            ($sindent <= $indent && $s ne ''))) {
2006                                WARN("SUSPECT_CODE_INDENT",
2007                                     "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
2008                        }
2009                }
2010
2011                # Track the 'values' across context and added lines.
2012                my $opline = $line; $opline =~ s/^./ /;
2013                my ($curr_values, $curr_vars) =
2014                                annotate_values($opline . "\n", $prev_values);
2015                $curr_values = $prev_values . $curr_values;
2016                if ($dbg_values) {
2017                        my $outline = $opline; $outline =~ s/\t/ /g;
2018                        print "$linenr > .$outline\n";
2019                        print "$linenr > $curr_values\n";
2020                        print "$linenr >  $curr_vars\n";
2021                }
2022                $prev_values = substr($curr_values, -1);
2023
2024#ignore lines not being added
2025                if ($line=~/^[^\+]/) {next;}
2026
2027# TEST: allow direct testing of the type matcher.
2028                if ($dbg_type) {
2029                        if ($line =~ /^.\s*$Declare\s*$/) {
2030                                ERROR("TEST_TYPE",
2031                                      "TEST: is type\n" . $herecurr);
2032                        } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
2033                                ERROR("TEST_NOT_TYPE",
2034                                      "TEST: is not type ($1 is)\n". $herecurr);
2035                        }
2036                        next;
2037                }
2038# TEST: allow direct testing of the attribute matcher.
2039                if ($dbg_attr) {
2040                        if ($line =~ /^.\s*$Modifier\s*$/) {
2041                                ERROR("TEST_ATTR",
2042                                      "TEST: is attr\n" . $herecurr);
2043                        } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
2044                                ERROR("TEST_NOT_ATTR",
2045                                      "TEST: is not attr ($1 is)\n". $herecurr);
2046                        }
2047                        next;
2048                }
2049
2050# check for initialisation to aggregates open brace on the next line
2051                if ($line =~ /^.\s*{/ &&
2052                    $prevline =~ /(?:^|[^=])=\s*$/) {
2053                        ERROR("OPEN_BRACE",
2054                              "that open brace { should be on the previous line\n" . $hereprev);
2055                }
2056
2057#
2058# Checks which are anchored on the added line.
2059#
2060
2061# check for malformed paths in #include statements (uses RAW line)
2062                if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
2063                        my $path = $1;
2064                        if ($path =~ m{//}) {
2065                                ERROR("MALFORMED_INCLUDE",
2066                                      "malformed #include filename\n" .
2067                                        $herecurr);
2068                        }
2069                }
2070
2071# no C99 // comments
2072                if ($line =~ m{//}) {
2073                        ERROR("C99_COMMENTS",
2074                              "do not use C99 // comments\n" . $herecurr);
2075                }
2076                # Remove C99 comments.
2077                $line =~ s@//.*@@;
2078                $opline =~ s@//.*@@;
2079
2080# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2081# the whole statement.
2082#print "APW <$lines[$realline_next - 1]>\n";
2083                if (defined $realline_next &&
2084                    exists $lines[$realline_next - 1] &&
2085                    !defined $suppress_export{$realline_next} &&
2086                    ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2087                     $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2088                        # Handle definitions which produce identifiers with
2089                        # a prefix:
2090                        #   XXX(foo);
2091                        #   EXPORT_SYMBOL(something_foo);
2092                        my $name = $1;
2093                        if ($stat =~ /^.([A-Z_]+)\s*\(\s*($Ident)/ &&
2094                            $name =~ /^${Ident}_$2/) {
2095#print "FOO C name<$name>\n";
2096                                $suppress_export{$realline_next} = 1;
2097
2098                        } elsif ($stat !~ /(?:
2099                                \n.}\s*$|
2100                                ^.DEFINE_$Ident\(\Q$name\E\)|
2101                                ^.DECLARE_$Ident\(\Q$name\E\)|
2102                                ^.LIST_HEAD\(\Q$name\E\)|
2103                                ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2104                                \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
2105                            )/x) {
2106#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2107                                $suppress_export{$realline_next} = 2;
2108                        } else {
2109                                $suppress_export{$realline_next} = 1;
2110                        }
2111                }
2112                if (!defined $suppress_export{$linenr} &&
2113                    $prevline =~ /^.\s*$/ &&
2114                    ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2115                     $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2116#print "FOO B <$lines[$linenr - 1]>\n";
2117                        $suppress_export{$linenr} = 2;
2118                }
2119                if (defined $suppress_export{$linenr} &&
2120                    $suppress_export{$linenr} == 2) {
2121                        WARN("EXPORT_SYMBOL",
2122                             "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
2123                }
2124
2125# check for global initialisers.
2126                if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
2127                        ERROR("GLOBAL_INITIALISERS",
2128                              "do not initialise globals to 0 or NULL\n" .
2129                                $herecurr);
2130                }
2131# check for static initialisers.
2132                if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2133                        ERROR("INITIALISED_STATIC",
2134                              "do not initialise statics to 0 or NULL\n" .
2135                                $herecurr);
2136                }
2137
2138# check for static const char * arrays.
2139                if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
2140                        WARN("STATIC_CONST_CHAR_ARRAY",
2141                             "static const char * array should probably be static const char * const\n" .
2142                                $herecurr);
2143               }
2144
2145# check for static char foo[] = "bar" declarations.
2146                if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
2147                        WARN("STATIC_CONST_CHAR_ARRAY",
2148                             "static char array declaration should probably be static const char\n" .
2149                                $herecurr);
2150               }
2151
2152# check for declarations of struct pci_device_id
2153                if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) {
2154                        WARN("DEFINE_PCI_DEVICE_TABLE",
2155                             "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr);
2156                }
2157
2158# check for new typedefs, only function parameters and sparse annotations
2159# make sense.
2160                if ($line =~ /\btypedef\s/ &&
2161                    $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
2162                    $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
2163                    $line !~ /\b$typeTypedefs\b/ &&
2164                    $line !~ /\b__bitwise(?:__|)\b/) {
2165                        WARN("NEW_TYPEDEFS",
2166                             "do not add new typedefs\n" . $herecurr);
2167                }
2168
2169# * goes on variable not on type
2170                # (char*[ const])
2171                if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) {
2172                        my ($from, $to) = ($1, $1);
2173
2174                        # Should start with a space.
2175                        $to =~ s/^(\S)/ $1/;
2176                        # Should not end with a space.
2177                        $to =~ s/\s+$//;
2178                        # '*'s should not have spaces between.
2179                        while ($to =~ s/\*\s+\*/\*\*/) {
2180                        }
2181
2182                        #print "from<$from> to<$to>\n";
2183                        if ($from ne $to) {
2184                                ERROR("POINTER_LOCATION",
2185                                      "\"(foo$from)\" should be \"(foo$to)\"\n" .  $herecurr);
2186                        }
2187                } elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) {
2188                        my ($from, $to, $ident) = ($1, $1, $2);
2189
2190                        # Should start with a space.
2191                        $to =~ s/^(\S)/ $1/;
2192                        # Should not end with a space.
2193                        $to =~ s/\s+$//;
2194                        # '*'s should not have spaces between.
2195                        while ($to =~ s/\*\s+\*/\*\*/) {
2196                        }
2197                        # Modifiers should have spaces.
2198                        $to =~ s/(\b$Modifier$)/$1 /;
2199
2200                        #print "from<$from> to<$to> ident<$ident>\n";
2201                        if ($from ne $to && $ident !~ /^$Modifier$/) {
2202                                ERROR("POINTER_LOCATION",
2203                                      "\"foo${from}bar\" should be \"foo${to}bar\"\n" .  $herecurr);
2204                        }
2205                }
2206
2207# # no BUG() or BUG_ON()
2208#               if ($line =~ /\b(BUG|BUG_ON)\b/) {
2209#                       print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2210#                       print "$herecurr";
2211#                       $clean = 0;
2212#               }
2213
2214                if ($line =~ /\bLINUX_VERSION_CODE\b/) {
2215                        WARN("LINUX_VERSION_CODE",
2216                             "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
2217                }
2218
2219# check for uses of printk_ratelimit
2220                if ($line =~ /\bprintk_ratelimit\s*\(/) {
2221                        WARN("PRINTK_RATELIMITED",
2222"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
2223                }
2224
2225# printk should use KERN_* levels.  Note that follow on printk's on the
2226# same line do not need a level, so we use the current block context
2227# to try and find and validate the current printk.  In summary the current
2228# printk includes all preceding printk's which have no newline on the end.
2229# we assume the first bad printk is the one to report.
2230                if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
2231                        my $ok = 0;
2232                        for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2233                                #print "CHECK<$lines[$ln - 1]\n";
2234                                # we have a preceding printk if it ends
2235                                # with "\n" ignore it, else it is to blame
2236                                if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2237                                        if ($rawlines[$ln - 1] !~ m{\\n"}) {
2238                                                $ok = 1;
2239                                        }
2240                                        last;
2241                                }
2242                        }
2243                        if ($ok == 0) {
2244                                WARN("PRINTK_WITHOUT_KERN_LEVEL",
2245                                     "printk() should include KERN_ facility level\n" . $herecurr);
2246                        }
2247                }
2248
2249# function brace can't be on same line, except for #defines of do while,
2250# or if closed on same line
2251                if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2252                    !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
2253                        ERROR("OPEN_BRACE",
2254                              "open brace '{' following function declarations go on the next line\n" . $herecurr);
2255                }
2256
2257# open braces for enum, union and struct go on the same line.
2258                if ($line =~ /^.\s*{/ &&
2259                    $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
2260                        ERROR("OPEN_BRACE",
2261                              "open brace '{' following $1 go on the same line\n" . $hereprev);
2262                }
2263
2264# missing space after union, struct or enum definition
2265                if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) {
2266                    WARN("SPACING",
2267                         "missing space after $1 definition\n" . $herecurr);
2268                }
2269
2270# check for spacing round square brackets; allowed:
2271#  1. with a type on the left -- int [] a;
2272#  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2273#  3. inside a curly brace -- = { [0...10] = 5 }
2274                while ($line =~ /(.*?\s)\[/g) {
2275                        my ($where, $prefix) = ($-[1], $1);
2276                        if ($prefix !~ /$Type\s+$/ &&
2277                            ($where != 0 || $prefix !~ /^.\s+$/) &&
2278                            $prefix !~ /{\s+$/) {
2279                                ERROR("BRACKET_SPACE",
2280                                      "space prohibited before open square bracket '['\n" . $herecurr);
2281                        }
2282                }
2283
2284# check for spaces between functions and their parentheses.
2285                while ($line =~ /($Ident)\s+\(/g) {
2286                        my $name = $1;
2287                        my $ctx_before = substr($line, 0, $-[1]);
2288                        my $ctx = "$ctx_before$name";
2289
2290                        # Ignore those directives where spaces _are_ permitted.
2291                        if ($name =~ /^(?:
2292                                if|for|while|switch|return|case|
2293                                volatile|__volatile__|
2294                                __attribute__|format|__extension__|
2295                                asm|__asm__)$/x)
2296                        {
2297
2298                        # cpp #define statements have non-optional spaces, ie
2299                        # if there is a space between the name and the open
2300                        # parenthesis it is simply not a parameter group.
2301                        } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
2302
2303                        # cpp #elif statement condition may start with a (
2304                        } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
2305
2306                        # If this whole things ends with a type its most
2307                        # likely a typedef for a function.
2308                        } elsif ($ctx =~ /$Type$/) {
2309
2310                        } else {
2311                                WARN("SPACING",
2312                                     "space prohibited between function name and open parenthesis '('\n" . $herecurr);
2313                        }
2314                }
2315# Check operator spacing.
2316                if (!($line=~/\#\s*include/)) {
2317                        my $ops = qr{
2318                                <<=|>>=|<=|>=|==|!=|
2319                                \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
2320                                =>|->|<<|>>|<|>|=|!|~|
2321                                &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
2322                                \?|:
2323                        }x;
2324                        my @elements = split(/($ops|;)/, $opline);
2325                        my $off = 0;
2326
2327                        my $blank = copy_spacing($opline);
2328
2329                        for (my $n = 0; $n < $#elements; $n += 2) {
2330                                $off += length($elements[$n]);
2331
2332                                # Pick up the preceding and succeeding characters.
2333                                my $ca = substr($opline, 0, $off);
2334                                my $cc = '';
2335                                if (length($opline) >= ($off + length($elements[$n + 1]))) {
2336                                        $cc = substr($opline, $off + length($elements[$n + 1]));
2337                                }
2338                                my $cb = "$ca$;$cc";
2339
2340                                my $a = '';
2341                                $a = 'V' if ($elements[$n] ne '');
2342                                $a = 'W' if ($elements[$n] =~ /\s$/);
2343                                $a = 'C' if ($elements[$n] =~ /$;$/);
2344                                $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
2345                                $a = 'O' if ($elements[$n] eq '');
2346                                $a = 'E' if ($ca =~ /^\s*$/);
2347
2348                                my $op = $elements[$n + 1];
2349
2350                                my $c = '';
2351                                if (defined $elements[$n + 2]) {
2352                                        $c = 'V' if ($elements[$n + 2] ne '');
2353                                        $c = 'W' if ($elements[$n + 2] =~ /^\s/);
2354                                        $c = 'C' if ($elements[$n + 2] =~ /^$;/);
2355                                        $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
2356                                        $c = 'O' if ($elements[$n + 2] eq '');
2357                                        $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
2358                                } else {
2359                                        $c = 'E';
2360                                }
2361
2362                                my $ctx = "${a}x${c}";
2363
2364                                my $at = "(ctx:$ctx)";
2365
2366                                my $ptr = substr($blank, 0, $off) . "^";
2367                                my $hereptr = "$hereline$ptr\n";
2368
2369                                # Pull out the value of this operator.
2370                                my $op_type = substr($curr_values, $off + 1, 1);
2371
2372                                # Get the full operator variant.
2373                                my $opv = $op . substr($curr_vars, $off, 1);
2374
2375                                # Ignore operators passed as parameters.
2376                                if ($op_type ne 'V' &&
2377                                    $ca =~ /\s$/ && $cc =~ /^\s*,/) {
2378
2379#                               # Ignore comments
2380#                               } elsif ($op =~ /^$;+$/) {
2381
2382                                # ; should have either the end of line or a space or \ after it
2383                                } elsif ($op eq ';') {
2384                                        if ($ctx !~ /.x[WEBC]/ &&
2385                                            $cc !~ /^\\/ && $cc !~ /^;/) {
2386                                                ERROR("SPACING",
2387                                                      "space required after that '$op' $at\n" . $hereptr);
2388                                        }
2389
2390                                # // is a comment
2391                                } elsif ($op eq '//') {
2392
2393                                # No spaces for:
2394                                #   ->
2395                                #   :   when part of a bitfield
2396                                } elsif ($op eq '->' || $opv eq ':B') {
2397                                        if ($ctx =~ /Wx.|.xW/) {
2398                                                ERROR("SPACING",
2399                                                      "spaces prohibited around that '$op' $at\n" . $hereptr);
2400                                        }
2401
2402                                # , must have a space on the right.
2403                                } elsif ($op eq ',') {
2404                                        if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
2405                                                ERROR("SPACING",
2406                                                      "space required after that '$op' $at\n" . $hereptr);
2407                                        }
2408
2409                                # '*' as part of a type definition -- reported already.
2410                                } elsif ($opv eq '*_') {
2411                                        #warn "'*' is part of type\n";
2412
2413                                # unary operators should have a space before and
2414                                # none after.  May be left adjacent to another
2415                                # unary operator, or a cast
2416                                } elsif ($op eq '!' || $op eq '~' ||
2417                                         $opv eq '*U' || $opv eq '-U' ||
2418                                         $opv eq '&U' || $opv eq '&&U') {
2419                                        if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
2420                                                ERROR("SPACING",
2421                                                      "space required before that '$op' $at\n" . $hereptr);
2422                                        }
2423                                        if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
2424                                                # A unary '*' may be const
2425
2426                                        } elsif ($ctx =~ /.xW/) {
2427                                                ERROR("SPACING",
2428                                                      "space prohibited after that '$op' $at\n" . $hereptr);
2429                                        }
2430
2431                                # unary ++ and unary -- are allowed no space on one side.
2432                                } elsif ($op eq '++' or $op eq '--') {
2433                                        if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
2434                                                ERROR("SPACING",
2435                                                      "space required one side of that '$op' $at\n" . $hereptr);
2436                                        }
2437                                        if ($ctx =~ /Wx[BE]/ ||
2438                                            ($ctx =~ /Wx./ && $cc =~ /^;/)) {
2439                                                ERROR("SPACING",
2440                                                      "space prohibited before that '$op' $at\n" . $hereptr);
2441                                        }
2442                                        if ($ctx =~ /ExW/) {
2443                                                ERROR("SPACING",
2444                                                      "space prohibited after that '$op' $at\n" . $hereptr);
2445                                        }
2446
2447
2448                                # << and >> may either have or not have spaces both sides
2449                                } elsif ($op eq '<<' or $op eq '>>' or
2450                                         $op eq '&' or $op eq '^' or $op eq '|' or
2451                                         $op eq '+' or $op eq '-' or
2452                                         $op eq '*' or $op eq '/' or
2453                                         $op eq '%')
2454                                {
2455                                        if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
2456                                                ERROR("SPACING",
2457                                                      "need consistent spacing around '$op' $at\n" .
2458                                                        $hereptr);
2459                                        }
2460
2461                                # A colon needs no spaces before when it is
2462                                # terminating a case value or a label.
2463                                } elsif ($opv eq ':C' || $opv eq ':L') {
2464                                        if ($ctx =~ /Wx./) {
2465                                                ERROR("SPACING",
2466                                                      "space prohibited before that '$op' $at\n" . $hereptr);
2467                                        }
2468
2469                                # All the others need spaces both sides.
2470                                } elsif ($ctx !~ /[EWC]x[CWE]/) {
2471                                        my $ok = 0;
2472
2473                                        # Ignore email addresses <foo@bar>
2474                                        if (($op eq '<' &&
2475                                             $cc =~ /^\S+\@\S+>/) ||
2476                                            ($op eq '>' &&
2477                                             $ca =~ /<\S+\@\S+$/))
2478                                        {
2479                                                $ok = 1;
2480                                        }
2481
2482                                        # Ignore ?:
2483                                        if (($opv eq ':O' && $ca =~ /\?$/) ||
2484                                            ($op eq '?' && $cc =~ /^:/)) {
2485                                                $ok = 1;
2486                                        }
2487
2488                                        if ($ok == 0) {
2489                                                ERROR("SPACING",
2490                                                      "spaces required around that '$op' $at\n" . $hereptr);
2491                                        }
2492                                }
2493                                $off += length($elements[$n + 1]);
2494                        }
2495                }
2496
2497# check for multiple assignments
2498                if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
2499                        CHK("MULTIPLE_ASSIGNMENTS",
2500                            "multiple assignments should be avoided\n" . $herecurr);
2501                }
2502
2503## # check for multiple declarations, allowing for a function declaration
2504## # continuation.
2505##              if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
2506##                  $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
2507##
2508##                      # Remove any bracketed sections to ensure we do not
2509##                      # falsly report the parameters of functions.
2510##                      my $ln = $line;
2511##                      while ($ln =~ s/\([^\(\)]*\)//g) {
2512##                      }
2513##                      if ($ln =~ /,/) {
2514##                              WARN("MULTIPLE_DECLARATION",
2515##                                   "declaring multiple variables together should be avoided\n" . $herecurr);
2516##                      }
2517##              }
2518
2519#need space before brace following if, while, etc
2520                if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
2521                    $line =~ /do{/) {
2522                        ERROR("SPACING",
2523                              "space required before the open brace '{'\n" . $herecurr);
2524                }
2525
2526# closing brace should have a space following it when it has anything
2527# on the line
2528                if ($line =~ /}(?!(?:,|;|\)))\S/) {
2529                        ERROR("SPACING",
2530                              "space required after that close brace '}'\n" . $herecurr);
2531                }
2532
2533# check spacing on square brackets
2534                if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
2535                        ERROR("SPACING",
2536                              "space prohibited after that open square bracket '['\n" . $herecurr);
2537                }
2538                if ($line =~ /\s\]/) {
2539                        ERROR("SPACING",
2540                              "space prohibited before that close square bracket ']'\n" . $herecurr);
2541                }
2542
2543# check spacing on parentheses
2544                if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
2545                    $line !~ /for\s*\(\s+;/) {
2546                        ERROR("SPACING",
2547                              "space prohibited after that open parenthesis '('\n" . $herecurr);
2548                }
2549                if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
2550                    $line !~ /for\s*\(.*;\s+\)/ &&
2551                    $line !~ /:\s+\)/) {
2552                        ERROR("SPACING",
2553                              "space prohibited before that close parenthesis ')'\n" . $herecurr);
2554                }
2555
2556#goto labels aren't indented, allow a single space however
2557                if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
2558                   !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
2559                        WARN("INDENTED_LABEL",
2560                             "labels should not be indented\n" . $herecurr);
2561                }
2562
2563# Return is not a function.
2564                if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2565                        my $spacing = $1;
2566                        my $value = $2;
2567
2568                        # Flatten any parentheses
2569                        $value =~ s/\(/ \(/g;
2570                        $value =~ s/\)/\) /g;
2571                        while ($value =~ s/\[[^\{\}]*\]/1/ ||
2572                               $value !~ /(?:$Ident|-?$Constant)\s*
2573                                             $Compare\s*
2574                                             (?:$Ident|-?$Constant)/x &&
2575                               $value =~ s/\([^\(\)]*\)/1/) {
2576                        }
2577#print "value<$value>\n";
2578                        if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
2579                                ERROR("RETURN_PARENTHESES",
2580                                      "return is not a function, parentheses are not required\n" . $herecurr);
2581
2582                        } elsif ($spacing !~ /\s+/) {
2583                                ERROR("SPACING",
2584                                      "space required before the open parenthesis '('\n" . $herecurr);
2585                        }
2586                }
2587# Return of what appears to be an errno should normally be -'ve
2588                if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
2589                        my $name = $1;
2590                        if ($name ne 'EOF' && $name ne 'ERROR') {
2591                                WARN("USE_NEGATIVE_ERRNO",
2592                                     "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
2593                        }
2594                }
2595
2596# typecasts on min/max could be min_t/max_t
2597                if ($line =~ /^\+(?:.*?)\b(min|max)\s*\($Typecast{0,1}($LvalOrFunc)\s*,\s*$Typecast{0,1}($LvalOrFunc)\s*\)/) {
2598                        if (defined $2 || defined $8) {
2599                                my $call = $1;
2600                                my $cast1 = deparenthesize($2);
2601                                my $arg1 = $3;
2602                                my $cast2 = deparenthesize($8);
2603                                my $arg2 = $9;
2604                                my $cast;
2605
2606                                if ($cast1 ne "" && $cast2 ne "") {
2607                                        $cast = "$cast1 or $cast2";
2608                                } elsif ($cast1 ne "") {
2609                                        $cast = $cast1;
2610                                } else {
2611                                        $cast = $cast2;
2612                                }
2613                                WARN("MINMAX",
2614                                     "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . $herecurr);
2615                        }
2616                }
2617
2618# Need a space before open parenthesis after if, while etc
2619                if ($line=~/\b(if|while|for|switch)\(/) {
2620                        ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr);
2621                }
2622
2623# Check for illegal assignment in if conditional -- and check for trailing
2624# statements after the conditional.
2625                if ($line =~ /do\s*(?!{)/) {
2626                        my ($stat_next) = ctx_statement_block($line_nr_next,
2627                                                $remain_next, $off_next);
2628                        $stat_next =~ s/\n./\n /g;
2629                        ##print "stat<$stat> stat_next<$stat_next>\n";
2630
2631                        if ($stat_next =~ /^\s*while\b/) {
2632                                # If the statement carries leading newlines,
2633                                # then count those as offsets.
2634                                my ($whitespace) =
2635                                        ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2636                                my $offset =
2637                                        statement_rawlines($whitespace) - 1;
2638
2639                                $suppress_whiletrailers{$line_nr_next +
2640                                                                $offset} = 1;
2641                        }
2642                }
2643                if (!defined $suppress_whiletrailers{$linenr} &&
2644                    $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
2645                        my ($s, $c) = ($stat, $cond);
2646
2647                        if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
2648                                ERROR("ASSIGN_IN_IF",
2649                                      "do not use assignment in if condition\n" . $herecurr);
2650                        }
2651
2652                        # Find out what is on the end of the line after the
2653                        # conditional.
2654                        substr($s, 0, length($c), '');
2655                        $s =~ s/\n.*//g;
2656                        $s =~ s/$;//g;  # Remove any comments
2657                        if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2658                            $c !~ /}\s*while\s*/)
2659                        {
2660                                # Find out how long the conditional actually is.
2661                                my @newlines = ($c =~ /\n/gs);
2662                                my $cond_lines = 1 + $#newlines;
2663                                my $stat_real = '';
2664
2665                                $stat_real = raw_line($linenr, $cond_lines)
2666                                                        . "\n" if ($cond_lines);
2667                                if (defined($stat_real) && $cond_lines > 1) {
2668                                        $stat_real = "[...]\n$stat_real";
2669                                }
2670
2671                                ERROR("TRAILING_STATEMENTS",
2672                                      "trailing statements should be on next line\n" . $herecurr . $stat_real);
2673                        }
2674                }
2675
2676# Check for bitwise tests written as boolean
2677                if ($line =~ /
2678                        (?:
2679                                (?:\[|\(|\&\&|\|\|)
2680                                \s*0[xX][0-9]+\s*
2681                                (?:\&\&|\|\|)
2682                        |
2683                                (?:\&\&|\|\|)
2684                                \s*0[xX][0-9]+\s*
2685                                (?:\&\&|\|\||\)|\])
2686                        )/x)
2687                {
2688                        WARN("HEXADECIMAL_BOOLEAN_TEST",
2689                             "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2690                }
2691
2692# if and else should not have general statements after it
2693                if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2694                        my $s = $1;
2695                        $s =~ s/$;//g;  # Remove any comments
2696                        if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2697                                ERROR("TRAILING_STATEMENTS",
2698                                      "trailing statements should be on next line\n" . $herecurr);
2699                        }
2700                }
2701# if should not continue a brace
2702                if ($line =~ /}\s*if\b/) {
2703                        ERROR("TRAILING_STATEMENTS",
2704                              "trailing statements should be on next line\n" .
2705                                $herecurr);
2706                }
2707# case and default should not have general statements after them
2708                if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2709                    $line !~ /\G(?:
2710                        (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
2711                        \s*return\s+
2712                    )/xg)
2713                {
2714                        ERROR("TRAILING_STATEMENTS",
2715                              "trailing statements should be on next line\n" . $herecurr);
2716                }
2717
2718                # Check for }<nl>else {, these must be at the same
2719                # indent level to be relevant to each other.
2720                if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2721                                                $previndent == $indent) {
2722                        ERROR("ELSE_AFTER_BRACE",
2723                              "else should follow close brace '}'\n" . $hereprev);
2724                }
2725
2726                if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2727                                                $previndent == $indent) {
2728                        my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2729
2730                        # Find out what is on the end of the line after the
2731                        # conditional.
2732                        substr($s, 0, length($c), '');
2733                        $s =~ s/\n.*//g;
2734
2735                        if ($s =~ /^\s*;/) {
2736                                ERROR("WHILE_AFTER_BRACE",
2737                                      "while should follow close brace '}'\n" . $hereprev);
2738                        }
2739                }
2740
2741#studly caps, commented out until figure out how to distinguish between use of existing and adding new
2742#               if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2743#                   print "No studly caps, use _\n";
2744#                   print "$herecurr";
2745#                   $clean = 0;
2746#               }
2747
2748#no spaces allowed after \ in define
2749                if ($line=~/\#\s*define.*\\\s$/) {
2750                        WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
2751                             "Whitepspace after \\ makes next lines useless\n" . $herecurr);
2752                }
2753
2754#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
2755                if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
2756                        my $file = "$1.h";
2757                        my $checkfile = "include/linux/$file";
2758                        if (-f "$root/$checkfile" &&
2759                            $realfile ne $checkfile &&
2760                            $1 !~ /$allowed_asm_includes/)
2761                        {
2762                                if ($realfile =~ m{^arch/}) {
2763                                        CHK("ARCH_INCLUDE_LINUX",
2764                                            "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2765                                } else {
2766                                        WARN("INCLUDE_LINUX",
2767                                             "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2768                                }
2769                        }
2770                }
2771
2772# multi-statement macros should be enclosed in a do while loop, grab the
2773# first statement and ensure its the whole macro if its not enclosed
2774# in a known good container
2775                if ($realfile !~ m@/vmlinux.lds.h$@ &&
2776                    $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
2777                        my $ln = $linenr;
2778                        my $cnt = $realcnt;
2779                        my ($off, $dstat, $dcond, $rest);
2780                        my $ctx = '';
2781
2782                        my $args = defined($1);
2783
2784                        # Find the end of the macro and limit our statement
2785                        # search to that.
2786                        while ($cnt > 0 && defined $lines[$ln - 1] &&
2787                                $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
2788                        {
2789                                $ctx .= $rawlines[$ln - 1] . "\n";
2790                                $cnt-- if ($lines[$ln - 1] !~ /^-/);
2791                                $ln++;
2792                        }
2793                        $ctx .= $rawlines[$ln - 1];
2794
2795                        ($dstat, $dcond, $ln, $cnt, $off) =
2796                                ctx_statement_block($linenr, $ln - $linenr + 1, 0);
2797                        #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
2798                        #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
2799
2800                        # Extract the remainder of the define (if any) and
2801                        # rip off surrounding spaces, and trailing \'s.
2802                        $rest = '';
2803                        while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
2804                                #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
2805                                if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
2806                                        $rest .= substr($lines[$ln - 1], $off) . "\n";
2807                                        $cnt--;
2808                                }
2809                                $ln++;
2810                                $off = 0;
2811                        }
2812                        $rest =~ s/\\\n.//g;
2813                        $rest =~ s/^\s*//s;
2814                        $rest =~ s/\s*$//s;
2815
2816                        # Clean up the original statement.
2817                        if ($args) {
2818                                substr($dstat, 0, length($dcond), '');
2819                        } else {
2820                                $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
2821                        }
2822                        $dstat =~ s/$;//g;
2823                        $dstat =~ s/\\\n.//g;
2824                        $dstat =~ s/^\s*//s;
2825                        $dstat =~ s/\s*$//s;
2826
2827                        # Flatten any parentheses and braces
2828                        while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2829                               $dstat =~ s/\{[^\{\}]*\}/1/ ||
2830                               $dstat =~ s/\[[^\{\}]*\]/1/)
2831                        {
2832                        }
2833
2834                        my $exceptions = qr{
2835                                $Declare|
2836                                module_param_named|
2837                                MODULE_PARAM_DESC|
2838                                DECLARE_PER_CPU|
2839                                DEFINE_PER_CPU|
2840                                __typeof__\(|
2841                                union|
2842                                struct|
2843                                \.$Ident\s*=\s*|
2844                                ^\"|\"$
2845                        }x;
2846                        #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
2847                        if ($rest ne '' && $rest ne ',') {
2848                                if ($rest !~ /while\s*\(/ &&
2849                                    $dstat !~ /$exceptions/)
2850                                {
2851                                        ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
2852                                              "Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
2853                                }
2854
2855                        } elsif ($ctx !~ /;/) {
2856                                if ($dstat ne '' &&
2857                                    $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2858                                    $dstat !~ /$exceptions/ &&
2859                                    $dstat !~ /^\.$Ident\s*=/ &&
2860                                    $dstat =~ /$Operators/)
2861                                {
2862                                        ERROR("COMPLEX_MACRO",
2863                                              "Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
2864                                }
2865                        }
2866                }
2867
2868# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
2869# all assignments may have only one of the following with an assignment:
2870#       .
2871#       ALIGN(...)
2872#       VMLINUX_SYMBOL(...)
2873                if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
2874                        WARN("MISSING_VMLINUX_SYMBOL",
2875                             "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
2876                }
2877
2878# check for redundant bracing round if etc
2879                if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2880                        my ($level, $endln, @chunks) =
2881                                ctx_statement_full($linenr, $realcnt, 1);
2882                        #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
2883                        #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2884                        if ($#chunks > 0 && $level == 0) {
2885                                my $allowed = 0;
2886                                my $seen = 0;
2887                                my $herectx = $here . "\n";
2888                                my $ln = $linenr - 1;
2889                                for my $chunk (@chunks) {
2890                                        my ($cond, $block) = @{$chunk};
2891
2892                                        # If the condition carries leading newlines, then count those as offsets.
2893                                        my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2894                                        my $offset = statement_rawlines($whitespace) - 1;
2895
2896                                        #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2897
2898                                        # We have looked at and allowed this specific line.
2899                                        $suppress_ifbraces{$ln + $offset} = 1;
2900
2901                                        $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
2902                                        $ln += statement_rawlines($block) - 1;
2903
2904                                        substr($block, 0, length($cond), '');
2905
2906                                        $seen++ if ($block =~ /^\s*{/);
2907
2908                                        #print "cond<$cond> block<$block> allowed<$allowed>\n";
2909                                        if (statement_lines($cond) > 1) {
2910                                                #print "APW: ALLOWED: cond<$cond>\n";
2911                                                $allowed = 1;
2912                                        }
2913                                        if ($block =~/\b(?:if|for|while)\b/) {
2914                                                #print "APW: ALLOWED: block<$block>\n";
2915                                                $allowed = 1;
2916                                        }
2917                                        if (statement_block_size($block) > 1) {
2918                                                #print "APW: ALLOWED: lines block<$block>\n";
2919                                                $allowed = 1;
2920                                        }
2921                                }
2922                                if ($seen && !$allowed) {
2923                                        WARN("BRACES",
2924                                             "braces {} are not necessary for any arm of this statement\n" . $herectx);
2925                                }
2926                        }
2927                }
2928                if (!defined $suppress_ifbraces{$linenr - 1} &&
2929                                        $line =~ /\b(if|while|for|else)\b/) {
2930                        my $allowed = 0;
2931
2932                        # Check the pre-context.
2933                        if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2934                                #print "APW: ALLOWED: pre<$1>\n";
2935                                $allowed = 1;
2936                        }
2937
2938                        my ($level, $endln, @chunks) =
2939                                ctx_statement_full($linenr, $realcnt, $-[0]);
2940
2941                        # Check the condition.
2942                        my ($cond, $block) = @{$chunks[0]};
2943                        #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
2944                        if (defined $cond) {
2945                                substr($block, 0, length($cond), '');
2946                        }
2947                        if (statement_lines($cond) > 1) {
2948                                #print "APW: ALLOWED: cond<$cond>\n";
2949                                $allowed = 1;
2950                        }
2951                        if ($block =~/\b(?:if|for|while)\b/) {
2952                                #print "APW: ALLOWED: block<$block>\n";
2953                                $allowed = 1;
2954                        }
2955                        if (statement_block_size($block) > 1) {
2956                                #print "APW: ALLOWED: lines block<$block>\n";
2957                                $allowed = 1;
2958                        }
2959                        # Check the post-context.
2960                        if (defined $chunks[1]) {
2961                                my ($cond, $block) = @{$chunks[1]};
2962                                if (defined $cond) {
2963                                        substr($block, 0, length($cond), '');
2964                                }
2965                                if ($block =~ /^\s*\{/) {
2966                                        #print "APW: ALLOWED: chunk-1 block<$block>\n";
2967                                        $allowed = 1;
2968                                }
2969                        }
2970                        if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
2971                                my $herectx = $here . "\n";
2972                                my $cnt = statement_rawlines($block);
2973
2974                                for (my $n = 0; $n < $cnt; $n++) {
2975                                        $herectx .= raw_line($linenr, $n) . "\n";
2976                                }
2977
2978                                WARN("BRACES",
2979                                     "braces {} are not necessary for single statement blocks\n" . $herectx);
2980                        }
2981                }
2982
2983# don't include deprecated include files (uses RAW line)
2984                for my $inc (@dep_includes) {
2985                        if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
2986                                ERROR("DEPRECATED_INCLUDE",
2987                                      "Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2988                        }
2989                }
2990
2991# don't use deprecated functions
2992                for my $func (@dep_functions) {
2993                        if ($line =~ /\b$func\b/) {
2994                                ERROR("DEPRECATED_FUNCTION",
2995                                      "Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2996                        }
2997                }
2998
2999# no volatiles please
3000                my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};

3001                if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
3002                        WARN("VOLATILE",
3003                             "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
3004                }
3005
3006# warn about #if 0
3007                if ($line =~ /^.\s*\#\s*if\s+0\b/) {
3008                        CHK("REDUNDANT_CODE",
3009                            "if this code is redundant consider removing it\n" .
3010                                $herecurr);
3011                }
3012
3013# check for needless kfree() checks
3014                if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
3015                        my $expr = $1;
3016                        if ($line =~ /\bkfree\(\Q$expr\E\);/) {
3017                                WARN("NEEDLESS_KFREE",
3018                                     "kfree(NULL) is safe this check is probably not required\n" . $hereprev);
3019                        }
3020                }
3021# check for needless usb_free_urb() checks
3022                if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
3023                        my $expr = $1;
3024                        if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
3025                                WARN("NEEDLESS_USB_FREE_URB",
3026                                     "usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
3027                        }
3028                }
3029
3030# prefer usleep_range over udelay
3031                if ($line =~ /\budelay\s*\(\s*(\w+)\s*\)/) {
3032                        # ignore udelay's < 10, however
3033                        if (! (($1 =~ /(\d+)/) && ($1 < 10)) ) {
3034                                CHK("USLEEP_RANGE",
3035                                    "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
3036                        }
3037                }
3038
3039# warn about unexpectedly long msleep's
3040                if ($line =~ /\bmsleep\s*\((\d+)\);/) {
3041                        if ($1 < 20) {
3042                                WARN("MSLEEP",
3043                                     "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
3044                        }
3045                }
3046
3047# warn about #ifdefs in C files
3048#               if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
3049#                       print "#ifdef in C files should be avoided\n";
3050#                       print "$herecurr";
3051#                       $clean = 0;
3052#               }
3053
3054# warn about spacing in #ifdefs
3055                if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
3056                        ERROR("SPACING",
3057                              "exactly one space required after that #$1\n" . $herecurr);
3058                }
3059
3060# check for spinlock_t definitions without a comment.
3061                if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
3062                    $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
3063                        my $which = $1;
3064                        if (!ctx_has_comment($first_line, $linenr)) {
3065                                CHK("UNCOMMENTED_DEFINITION",
3066                                    "$1 definition without comment\n" . $herecurr);
3067                        }
3068                }
3069# check for memory barriers without a comment.
3070                if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
3071                        if (!ctx_has_comment($first_line, $linenr)) {
3072                                CHK("MEMORY_BARRIER",
3073                                    "memory barrier without comment\n" . $herecurr);
3074                        }
3075                }
3076# check of hardware specific defines
3077                if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
3078                        CHK("ARCH_DEFINES",
3079                            "architecture specific defines should be avoided\n" .  $herecurr);
3080                }
3081
3082# Check that the storage class is at the beginning of a declaration
3083                if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
3084                        WARN("STORAGE_CLASS",
3085                             "storage class should be at the beginning of the declaration\n" . $herecurr)
3086                }
3087
3088# check the location of the inline attribute, that it is between
3089# storage class and type.
3090                if ($line =~ /\b$Type\s+$Inline\b/ ||
3091                    $line =~ /\b$Inline\s+$Storage\b/) {
3092                        ERROR("INLINE_LOCATION",
3093                              "inline keyword should sit between storage class and type\n" . $herecurr);
3094                }
3095
3096# Check for __inline__ and __inline, prefer inline
3097                if ($line =~ /\b(__inline__|__inline)\b/) {
3098                        WARN("INLINE",
3099                             "plain inline is preferred over $1\n" . $herecurr);
3100                }
3101
3102# Check for __attribute__ packed, prefer __packed
3103                if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
3104                        WARN("PREFER_PACKED",
3105                             "__packed is preferred over __attribute__((packed))\n" . $herecurr);
3106                }
3107
3108# Check for __attribute__ aligned, prefer __aligned
3109                if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
3110                        WARN("PREFER_ALIGNED",
3111                             "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
3112                }
3113
3114# check for sizeof(&)
3115                if ($line =~ /\bsizeof\s*\(\s*\&/) {
3116                        WARN("SIZEOF_ADDRESS",
3117                             "sizeof(& should be avoided\n" . $herecurr);
3118                }
3119
3120# check for line continuations in quoted strings with odd counts of "
3121                if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
3122                        WARN("LINE_CONTINUATIONS",
3123                             "Avoid line continuations in quoted strings\n" . $herecurr);
3124                }
3125
3126# check for new externs in .c files.
3127                if ($realfile =~ /\.c$/ && defined $stat &&
3128                    $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
3129                {
3130                        my $function_name = $1;
3131                        my $paren_space = $2;
3132
3133                        my $s = $stat;
3134                        if (defined $cond) {
3135                                substr($s, 0, length($cond), '');
3136                        }
3137                        if ($s =~ /^\s*;/ &&
3138                            $function_name ne 'uninitialized_var')
3139                        {
3140                                WARN("AVOID_EXTERNS",
3141                                     "externs should be avoided in .c files\n" .  $herecurr);
3142                        }
3143
3144                        if ($paren_space =~ /\n/) {
3145                                WARN("FUNCTION_ARGUMENTS",
3146                                     "arguments for function declarations should follow identifier\n" . $herecurr);
3147                        }
3148
3149                } elsif ($realfile =~ /\.c$/ && defined $stat &&
3150                    $stat =~ /^.\s*extern\s+/)
3151                {
3152                        WARN("AVOID_EXTERNS",
3153                             "externs should be avoided in .c files\n" .  $herecurr);
3154                }
3155
3156# checks for new __setup's
3157                if ($rawline =~ /\b__setup\("([^"]*)"/) {
3158                        my $name = $1;
3159
3160                        if (!grep(/$name/, @setup_docs)) {
3161                                CHK("UNDOCUMENTED_SETUP",
3162                                    "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
3163                        }
3164                }
3165
3166# check for pointless casting of kmalloc return
3167                if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
3168                        WARN("UNNECESSARY_CASTS",
3169                             "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
3170                }
3171
3172# check for multiple semicolons
3173                if ($line =~ /;\s*;\s*$/) {
3174                    WARN("ONE_SEMICOLON",
3175                         "Statements terminations use 1 semicolon\n" . $herecurr);
3176                }
3177
3178# check for gcc specific __FUNCTION__
3179                if ($line =~ /__FUNCTION__/) {
3180                        WARN("USE_FUNC",
3181                             "__func__ should be used instead of gcc specific __FUNCTION__\n"  . $herecurr);
3182                }
3183
3184# check for semaphores initialized locked
3185                if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
3186                        WARN("CONSIDER_COMPLETION",
3187                             "consider using a completion\n" . $herecurr);
3188
3189                }
3190# recommend kstrto* over simple_strto* and strict_strto*
3191                if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
3192                        WARN("CONSIDER_KSTRTO",
3193                             "$1 is obsolete, use k$3 instead\n" . $herecurr);
3194                }
3195# check for __initcall(), use device_initcall() explicitly please
3196                if ($line =~ /^.\s*__initcall\s*\(/) {
3197                        WARN("USE_DEVICE_INITCALL",
3198                             "please use device_initcall() instead of __initcall()\n" . $herecurr);
3199                }
3200# check for various ops structs, ensure they are const.
3201                my $struct_ops = qr{acpi_dock_ops|
3202                                address_space_operations|
3203                                backlight_ops|
3204                                block_device_operations|
3205                                dentry_operations|
3206                                dev_pm_ops|
3207                                dma_map_ops|
3208                                extent_io_ops|
3209                                file_lock_operations|
3210                                file_operations|
3211                                hv_ops|
3212                                ide_dma_ops|
3213                                intel_dvo_dev_ops|
3214                                item_operations|
3215                                iwl_ops|
3216                                kgdb_arch|
3217                                kgdb_io|
3218                                kset_uevent_ops|
3219                                lock_manager_operations|
3220                                microcode_ops|
3221                                mtrr_ops|
3222                                neigh_ops|
3223                                nlmsvc_binding|
3224                                pci_raw_ops|
3225                                pipe_buf_operations|
3226                                platform_hibernation_ops|
3227                                platform_suspend_ops|
3228                                proto_ops|
3229                                rpc_pipe_ops|
3230                                seq_operations|
3231                                snd_ac97_build_ops|
3232                                soc_pcmcia_socket_ops|
3233                                stacktrace_ops|
3234                                sysfs_ops|
3235                                tty_operations|
3236                                usb_mon_operations|
3237                                wd_ops}x;
3238                if ($line !~ /\bconst\b/ &&
3239                    $line =~ /\bstruct\s+($struct_ops)\b/) {
3240                        WARN("CONST_STRUCT",
3241                             "struct $1 should normally be const\n" .
3242                                $herecurr);
3243                }
3244
3245# use of NR_CPUS is usually wrong
3246# ignore definitions of NR_CPUS and usage to define arrays as likely right
3247                if ($line =~ /\bNR_CPUS\b/ &&
3248                    $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
3249                    $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
3250                    $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
3251                    $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
3252                    $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
3253                {
3254                        WARN("NR_CPUS",
3255                             "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
3256                }
3257
3258# check for %L{u,d,i} in strings
3259                my $string;
3260                while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
3261                        $string = substr($rawline, $-[1], $+[1] - $-[1]);
3262                        $string =~ s/%%/__/g;
3263                        if ($string =~ /(?<!%)%L[udi]/) {
3264                                WARN("PRINTF_L",
3265                                     "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
3266                                last;
3267                        }
3268                }
3269
3270# whine mightly about in_atomic
3271                if ($line =~ /\bin_atomic\s*\(/) {
3272                        if ($realfile =~ m@^drivers/@) {
3273                                ERROR("IN_ATOMIC",
3274                                      "do not use in_atomic in drivers\n" . $herecurr);
3275                        } elsif ($realfile !~ m@^kernel/@) {
3276                                WARN("IN_ATOMIC",
3277                                     "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
3278                        }
3279                }
3280
3281# check for lockdep_set_novalidate_class
3282                if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
3283                    $line =~ /__lockdep_no_validate__\s*\)/ ) {
3284                        if ($realfile !~ m@^kernel/lockdep@ &&
3285                            $realfile !~ m@^include/linux/lockdep@ &&
3286                            $realfile !~ m@^drivers/base/core@) {
3287                                ERROR("LOCKDEP",
3288                                      "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
3289                        }
3290                }
3291
3292                if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
3293                    $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
3294                        WARN("EXPORTED_WORLD_WRITABLE",
3295                             "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
3296                }
3297
3298                # Check for memset with swapped arguments
3299                if ($line =~ /memset.*\,(\ |)(0x|)0(\ |0|)\);/) {
3300                        ERROR("MEMSET",
3301                              "memset size is 3rd argument, not the second.\n" . $herecurr);
3302                }
3303        }
3304
3305        # If we have no input at all, then there is nothing to report on
3306        # so just keep quiet.
3307        if ($#rawlines == -1) {
3308                exit(0);
3309        }
3310
3311        # In mailback mode only produce a report in the negative, for
3312        # things that appear to be patches.
3313        if ($mailback && ($clean == 1 || !$is_patch)) {
3314                exit(0);
3315        }
3316
3317        # This is not a patch, and we are are in 'no-patch' mode so
3318        # just keep quiet.
3319        if (!$chk_patch && !$is_patch) {
3320                exit(0);
3321        }
3322
3323        if (!$is_patch) {
3324                ERROR("NOT_UNIFIED_DIFF",
3325                      "Does not appear to be a unified-diff format patch\n");
3326        }
3327        if ($is_patch && $chk_signoff && $signoff == 0) {
3328                ERROR("MISSING_SIGN_OFF",
3329                      "Missing Signed-off-by: line(s)\n");
3330        }
3331
3332        print report_dump();
3333        if ($summary && !($clean == 1 && $quiet == 1)) {
3334                print "$filename " if ($summary_file);
3335                print "total: $cnt_error errors, $cnt_warn warnings, " .
3336                        (($check)? "$cnt_chk checks, " : "") .
3337                        "$cnt_lines lines checked\n";
3338                print "\n" if ($quiet == 0);
3339        }
3340
3341        if ($quiet == 0) {
3342                # If there were whitespace errors which cleanpatch can fix
3343                # then suggest that.
3344                if ($rpt_cleaners) {
3345                        print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
3346                        print "      scripts/cleanfile\n\n";
3347                        $rpt_cleaners = 0;
3348                }
3349        }
3350
3351        if (keys %ignore_type) {
3352            print "NOTE: Ignored message types:";
3353            foreach my $ignore (sort keys %ignore_type) {
3354                print " $ignore";
3355            }
3356            print "\n";
3357            print "\n" if ($quiet == 0);
3358        }
3359
3360        if ($clean == 1 && $quiet == 0) {
3361                print "$vname has no obvious style problems and is ready for submission.\n"
3362        }
3363        if ($clean == 0 && $quiet == 0) {
3364                print << "EOM";
3365$vname has style problems, please review.
3366
3367If any of these errors are false positives, please report
3368them to the maintainer, see CHECKPATCH in MAINTAINERS.
3369EOM
3370        }
3371
3372        return $clean;
3373}
3374