Root/scripts/checkpatch.pl

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

Archive Download this file



interactive