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
15
use Getopt::Long qw(:config no_auto_abbrev);
37
Usage: $P [OPTION]... [FILE]...
42
--no-tree run without a kernel tree
43
--no-signoff do not check for 'Signed-off-by' line
44
--patch treat FILE as patchfile (default)
45
--emacs emacs compile window format
46
--terse one line per report
47
-f, --file treat FILE as regular source file
48
--subjective, --strict enable more subjective tests
49
--root=PATH PATH to the kernel tree root
50
--no-summary suppress the per-file summary
51
--mailback only produce a report in case of warnings/errors
52
--summary-file include the filename in summary
53
--debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
54
'values', 'possible', 'type', and 'attr' (default
56
--test-only=WORD report only warnings/errors containing WORD
58
-h, --help, --version display this help and exit
60
When FILE is - read standard input.
67
'q|quiet+' => \$quiet,
69
'signoff!' => \$chk_signoff,
70
'patch!' => \$chk_patch,
74
'subjective!' => \$check,
77
'summary!' => \$summary,
78
'mailback!' => \$mailback,
79
'summary-file!' => \$summary_file,
82
'test-only=s' => \$tst_only,
92
print "$P: no input files\n";
100
for my $key (keys %debug) {
102
eval "\${dbg_$key} = '$debug{$key}';";
106
my $rpt_cleaners = 0;
115
if (!top_of_kernel_tree($root)) {
116
die "$P: $root: --root does not point at a valid tree\n";
119
if (top_of_kernel_tree('.')) {
121
} elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
122
top_of_kernel_tree($1)) {
127
if (!defined $root) {
128
print "Must be run from the top-level dir. of a kernel tree\n";
133
my $emitted_corrupt = 0;
136
[A-Za-z_][A-Za-z\d_]*
137
(?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
139
our $Storage = qr{extern|static|asmlinkage};
151
# Notes to $Attribute:
152
# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
171
__(?:mem|cpu|dev|)(?:initdata|initconst|init\b)|
172
____cacheline_aligned|
173
____cacheline_aligned_in_smp|
174
____cacheline_internodealigned_in_smp|
178
our $Inline = qr{inline|__always_inline|noinline};
179
our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
180
our $Lval = qr{$Ident(?:$Member)*};
182
our $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
183
our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
184
our $Compare = qr{<=|>=|==|!=|<|>};
188
&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
196
[\x09\x0A\x0D\x20-\x7E] # ASCII
197
| [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
198
| \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
199
| [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
200
| \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
201
| \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
202
| [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
203
| \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
206
our $typeTypedefs = qr{(?x:
207
(?:__)?(?:u|s|be|le)(?:8|16|32|64)|
211
our $logFunctions = qr{(?x:
213
pr_(debug|dbg|vdbg|devel|info|warning|err|notice|alert|crit|emerg|cont)|
214
(dev|netdev|netif)_(printk|dbg|vdbg|info|warn|err|notice|alert|crit|emerg|WARN)|
221
qr{(?:unsigned\s+)?char},
222
qr{(?:unsigned\s+)?short},
223
qr{(?:unsigned\s+)?int},
224
qr{(?:unsigned\s+)?long},
225
qr{(?:unsigned\s+)?long\s+int},
226
qr{(?:unsigned\s+)?long\s+long},
227
qr{(?:unsigned\s+)?long\s+long\s+int},
236
qr{${Ident}_handler},
237
qr{${Ident}_handler_fn},
239
our @modifierList = (
243
our $allowed_asm_includes = qr{(?x:
247
# memory.h: ARM has a custom one
250
my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
251
my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
252
$Modifier = qr{(?:$Attribute|$Sparse|$mods)};
254
(?:$Modifier\s+|const\s+)*
256
(?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
260
(?:\s+$Modifier|\s+const)*
264
(?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)?
265
(?:\s+$Inline|\s+$Modifier)*
267
$Declare = qr{(?:$Storage\s+)?$Type};
271
$chk_signoff = 0 if ($file);
273
my @dep_includes = ();
274
my @dep_functions = ();
275
my $removal = "Documentation/feature-removal-schedule.txt";
276
if ($tree && -f "$root/$removal") {
277
open(my $REMOVE, '<', "$root/$removal") ||
278
die "$P: $removal: open failed - $!\n";
280
if (/^Check:\s+(.*\S)/) {
281
for my $entry (split(/[, ]+/, $1)) {
282
if ($entry =~ m@include/(.*)@) {
283
push(@dep_includes, $1);
285
} elsif ($entry !~ m@/@) {
286
push(@dep_functions, $entry);
297
for my $filename (@ARGV) {
300
open($FILE, '-|', "diff -u /dev/null $filename") ||
301
die "$P: $filename: diff failed - $!\n";
302
} elsif ($filename eq '-') {
303
open($FILE, '<&STDIN');
305
open($FILE, '<', "$filename") ||
306
die "$P: $filename: open failed - $!\n";
308
if ($filename eq '-') {
309
$vname = 'Your patch';
318
if (!process($filename)) {
327
sub top_of_kernel_tree {
331
"COPYING", "MAINTAINERS", "Makefile",
332
"README", "docs", "VERSION",
336
foreach my $check (@tree_check) {
337
if (! -e $root . '/' . $check) {
349
for my $c (split(//, $str)) {
353
for (; ($n % 8) != 0; $n++) {
365
(my $res = shift) =~ tr/\t/ /c;
372
# Drop the diff line leader and expand tabs
374
$line = expand_tabs($line);
376
# Pick the indent from the front of the line.
377
my ($white) = ($line =~ /^(\s*)/);
379
return (length($line), length($white));
382
my $sanitise_quote = '';
384
sub sanitise_line_reset {
385
my ($in_comment) = @_;
388
$sanitise_quote = '*/';
390
$sanitise_quote = '';
403
# Always copy over the diff marker.
404
$res = substr($line, 0, 1);
406
for ($off = 1; $off < length($line); $off++) {
407
$c = substr($line, $off, 1);
409
# Comments we are wacking completly including the begin
410
# and end, all to $;.
411
if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
412
$sanitise_quote = '*/';
414
substr($res, $off, 2, "$;$;");
418
if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
419
$sanitise_quote = '';
420
substr($res, $off, 2, "$;$;");
424
if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
425
$sanitise_quote = '//';
427
substr($res, $off, 2, $sanitise_quote);
432
# A \ in a string means ignore the next character.
433
if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
435
substr($res, $off, 2, 'XX');
440
if ($c eq "'" || $c eq '"') {
441
if ($sanitise_quote eq '') {
442
$sanitise_quote = $c;
444
substr($res, $off, 1, $c);
446
} elsif ($sanitise_quote eq $c) {
447
$sanitise_quote = '';
451
#print "c<$c> SQ<$sanitise_quote>\n";
452
if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
453
substr($res, $off, 1, $;);
454
} elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
455
substr($res, $off, 1, $;);
456
} elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
457
substr($res, $off, 1, 'X');
459
substr($res, $off, 1, $c);
463
if ($sanitise_quote eq '//') {
464
$sanitise_quote = '';
467
# The pathname on a #include may be surrounded by '<' and '>'.
468
if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
469
my $clean = 'X' x length($1);
470
$res =~ s@\<.*\>@<$clean>@;
472
# The whole of a #error is a string.
473
} elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
474
my $clean = 'X' x length($1);
475
$res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
481
sub ctx_statement_block {
482
my ($linenr, $remain, $off) = @_;
483
my $line = $linenr - 1;
500
@stack = (['', 0]) if ($#stack == -1);
502
#warn "CSB: blk<$blk> remain<$remain>\n";
503
# If we are about to drop off the end, pull in more
506
for (; $remain > 0; $line++) {
507
last if (!defined $lines[$line]);
508
next if ($lines[$line] =~ /^-/);
511
$blk .= $lines[$line] . "\n";
516
# Bail if there is no further context.
517
#warn "CSB: blk<$blk> off<$off> len<$len>\n";
523
$c = substr($blk, $off, 1);
524
$remainder = substr($blk, $off);
526
#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
528
# Handle nested #if/#else.
529
if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
530
push(@stack, [ $type, $level ]);
531
} elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
532
($type, $level) = @{$stack[$#stack - 1]};
533
} elsif ($remainder =~ /^#\s*endif\b/) {
534
($type, $level) = @{pop(@stack)};
537
# Statement ends at the ';' or a close '}' at the
539
if ($level == 0 && $c eq ';') {
543
# An else is really a conditional as long as its not else if
544
if ($level == 0 && $coff_set == 0 &&
545
(!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
546
$remainder =~ /^(else)(?:\s|{)/ &&
547
$remainder !~ /^else\s+if\b/) {
548
$coff = $off + length($1) - 1;
550
#warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
551
#warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
554
if (($type eq '' || $type eq '(') && $c eq '(') {
558
if ($type eq '(' && $c eq ')') {
560
$type = ($level != 0)? '(' : '';
562
if ($level == 0 && $coff < $soff) {
565
#warn "CSB: mark coff<$coff>\n";
568
if (($type eq '' || $type eq '{') && $c eq '{') {
572
if ($type eq '{' && $c eq '}') {
574
$type = ($level != 0)? '{' : '';
577
if (substr($blk, $off + 1, 1) eq ';') {
585
# We are truly at the end, so shuffle to the next line.
592
my $statement = substr($blk, $soff, $off - $soff + 1);
593
my $condition = substr($blk, $soff, $coff - $soff + 1);
595
#warn "STATEMENT<$statement>\n";
596
#warn "CONDITION<$condition>\n";
598
#print "coff<$coff> soff<$off> loff<$loff>\n";
600
return ($statement, $condition,
601
$line, $remain + 1, $off - $loff + 1, $level);
604
sub statement_lines {
607
# Strip the diff line prefixes and rip blank lines at start and end.
608
$stmt =~ s/(^|\n)./$1/g;
612
my @stmt_lines = ($stmt =~ /\n/g);
614
return $#stmt_lines + 2;
617
sub statement_rawlines {
620
my @stmt_lines = ($stmt =~ /\n/g);
622
return $#stmt_lines + 2;
625
sub statement_block_size {
628
$stmt =~ s/(^|\n)./$1/g;
634
my @stmt_lines = ($stmt =~ /\n/g);
635
my @stmt_statements = ($stmt =~ /;/g);
637
my $stmt_lines = $#stmt_lines + 2;
638
my $stmt_statements = $#stmt_statements + 1;
640
if ($stmt_lines > $stmt_statements) {
643
return $stmt_statements;
647
sub ctx_statement_full {
648
my ($linenr, $remain, $off) = @_;
649
my ($statement, $condition, $level);
653
# Grab the first conditional/block pair.
654
($statement, $condition, $linenr, $remain, $off, $level) =
655
ctx_statement_block($linenr, $remain, $off);
656
#print "F: c<$condition> s<$statement> remain<$remain>\n";
657
push(@chunks, [ $condition, $statement ]);
658
if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
659
return ($level, $linenr, @chunks);
662
# Pull in the following conditional/block pairs and see if they
663
# could continue the statement.
665
($statement, $condition, $linenr, $remain, $off, $level) =
666
ctx_statement_block($linenr, $remain, $off);
667
#print "C: c<$condition> s<$statement> remain<$remain>\n";
668
last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
670
push(@chunks, [ $condition, $statement ]);
673
return ($level, $linenr, @chunks);
677
my ($linenr, $remain, $outer, $open, $close, $off) = @_;
679
my $start = $linenr - 1;
686
my @stack = ($level);
687
for ($line = $start; $remain > 0; $line++) {
688
next if ($rawlines[$line] =~ /^-/);
691
$blk .= $rawlines[$line];
693
# Handle nested #if/#else.
694
if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
695
push(@stack, $level);
696
} elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
697
$level = $stack[$#stack - 1];
698
} elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
699
$level = pop(@stack);
702
foreach my $c (split(//, $lines[$line])) {
703
##print "C<$c>L<$level><$open$close>O<$off>\n";
709
if ($c eq $close && $level > 0) {
711
last if ($level == 0);
712
} elsif ($c eq $open) {
717
if (!$outer || $level <= 1) {
718
push(@res, $rawlines[$line]);
721
last if ($level == 0);
724
return ($level, @res);
726
sub ctx_block_outer {
727
my ($linenr, $remain) = @_;
729
my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
733
my ($linenr, $remain) = @_;
735
my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
739
my ($linenr, $remain, $off) = @_;
741
my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
744
sub ctx_block_level {
745
my ($linenr, $remain) = @_;
747
return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
749
sub ctx_statement_level {
750
my ($linenr, $remain, $off) = @_;
752
return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
755
sub ctx_locate_comment {
756
my ($first_line, $end_line) = @_;
758
# Catch a comment on the end of the line itself.
759
my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
760
return $current_comment if (defined $current_comment);
762
# Look through the context and try and figure out if there is a
765
$current_comment = '';
766
for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
767
my $line = $rawlines[$linenr - 1];
769
if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
772
if ($line =~ m@/\*@) {
775
if (!$in_comment && $current_comment ne '') {
776
$current_comment = '';
778
$current_comment .= $line . "\n" if ($in_comment);
779
if ($line =~ m@\*/@) {
784
chomp($current_comment);
785
return($current_comment);
787
sub ctx_has_comment {
788
my ($first_line, $end_line) = @_;
789
my $cmt = ctx_locate_comment($first_line, $end_line);
791
##print "LINE: $rawlines[$end_line - 1 ]\n";
792
##print "CMMT: $cmt\n";
798
my ($linenr, $cnt) = @_;
800
my $offset = $linenr - 1;
805
$line = $rawlines[$offset++];
806
next if (defined($line) && $line =~ /^-/);
818
while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
821
$coded = sprintf("^%c", unpack('C', $2) + 64);
830
my $av_preprocessor = 0;
836
$av_preprocessor = 0;
838
@av_paren_type = ('E');
839
$av_pend_colon = 'O';
842
sub annotate_values {
843
my ($stream, $type) = @_;
846
my $var = '_' x length($stream);
849
print "$stream\n" if ($dbg_values > 1);
851
while (length($cur)) {
852
@av_paren_type = ('E') if ($#av_paren_type < 0);
853
print " <" . join('', @av_paren_type) .
854
"> <$type> <$av_pending>" if ($dbg_values > 1);
855
if ($cur =~ /^(\s+)/o) {
856
print "WS($1)\n" if ($dbg_values > 1);
857
if ($1 =~ /\n/ && $av_preprocessor) {
858
$type = pop(@av_paren_type);
859
$av_preprocessor = 0;
862
} elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
863
print "CAST($1)\n" if ($dbg_values > 1);
864
push(@av_paren_type, $type);
867
} elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
868
print "DECLARE($1)\n" if ($dbg_values > 1);
871
} elsif ($cur =~ /^($Modifier)\s*/) {
872
print "MODIFIER($1)\n" if ($dbg_values > 1);
875
} elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
876
print "DEFINE($1,$2)\n" if ($dbg_values > 1);
877
$av_preprocessor = 1;
878
push(@av_paren_type, $type);
884
} elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
885
print "UNDEF($1)\n" if ($dbg_values > 1);
886
$av_preprocessor = 1;
887
push(@av_paren_type, $type);
889
} elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
890
print "PRE_START($1)\n" if ($dbg_values > 1);
891
$av_preprocessor = 1;
893
push(@av_paren_type, $type);
894
push(@av_paren_type, $type);
897
} elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
898
print "PRE_RESTART($1)\n" if ($dbg_values > 1);
899
$av_preprocessor = 1;
901
push(@av_paren_type, $av_paren_type[$#av_paren_type]);
905
} elsif ($cur =~ /^(\#\s*(?:endif))/o) {
906
print "PRE_END($1)\n" if ($dbg_values > 1);
908
$av_preprocessor = 1;
910
# Assume all arms of the conditional end as this
911
# one does, and continue as if the #endif was not here.
913
push(@av_paren_type, $type);
916
} elsif ($cur =~ /^(\\\n)/o) {
917
print "PRECONT($1)\n" if ($dbg_values > 1);
919
} elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
920
print "ATTR($1)\n" if ($dbg_values > 1);
924
} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
925
print "SIZEOF($1)\n" if ($dbg_values > 1);
931
} elsif ($cur =~ /^(if|while|for)\b/o) {
932
print "COND($1)\n" if ($dbg_values > 1);
936
} elsif ($cur =~/^(case)/o) {
937
print "CASE($1)\n" if ($dbg_values > 1);
938
$av_pend_colon = 'C';
941
} elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
942
print "KEYWORD($1)\n" if ($dbg_values > 1);
945
} elsif ($cur =~ /^(\()/o) {
946
print "PAREN('$1')\n" if ($dbg_values > 1);
947
push(@av_paren_type, $av_pending);
951
} elsif ($cur =~ /^(\))/o) {
952
my $new_type = pop(@av_paren_type);
953
if ($new_type ne '_') {
955
print "PAREN('$1') -> $type\n"
956
if ($dbg_values > 1);
958
print "PAREN('$1')\n" if ($dbg_values > 1);
961
} elsif ($cur =~ /^($Ident)\s*\(/o) {
962
print "FUNC($1)\n" if ($dbg_values > 1);
966
} elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
967
if (defined $2 && $type eq 'C' || $type eq 'T') {
968
$av_pend_colon = 'B';
969
} elsif ($type eq 'E') {
970
$av_pend_colon = 'L';
972
print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
975
} elsif ($cur =~ /^($Ident|$Constant)/o) {
976
print "IDENT($1)\n" if ($dbg_values > 1);
979
} elsif ($cur =~ /^($Assignment)/o) {
980
print "ASSIGN($1)\n" if ($dbg_values > 1);
983
} elsif ($cur =~/^(;|{|})/) {
984
print "END($1)\n" if ($dbg_values > 1);
986
$av_pend_colon = 'O';
988
} elsif ($cur =~/^(,)/) {
989
print "COMMA($1)\n" if ($dbg_values > 1);
992
} elsif ($cur =~ /^(\?)/o) {
993
print "QUESTION($1)\n" if ($dbg_values > 1);
996
} elsif ($cur =~ /^(:)/o) {
997
print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
999
substr($var, length($res), 1, $av_pend_colon);
1000
if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1005
$av_pend_colon = 'O';
1007
} elsif ($cur =~ /^(\[)/o) {
1008
print "CLOSE($1)\n" if ($dbg_values > 1);
1011
} elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1014
print "OPV($1)\n" if ($dbg_values > 1);
1021
substr($var, length($res), 1, $variant);
1024
} elsif ($cur =~ /^($Operators)/o) {
1025
print "OP($1)\n" if ($dbg_values > 1);
1026
if ($1 ne '++' && $1 ne '--') {
1030
} elsif ($cur =~ /(^.)/o) {
1031
print "C($1)\n" if ($dbg_values > 1);
1034
$cur = substr($cur, length($1));
1035
$res .= $type x length($1);
1039
return ($res, $var);
1043
my ($possible, $line) = @_;
1044
my $notPermitted = qr{(?:
1059
^(?:typedef|struct|enum)\b
1061
warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1062
if ($possible !~ $notPermitted) {
1063
# Check for modifiers.
1064
$possible =~ s/\s*$Storage\s*//g;
1065
$possible =~ s/\s*$Sparse\s*//g;
1066
if ($possible =~ /^\s*$/) {
1068
} elsif ($possible =~ /\s/) {
1069
$possible =~ s/\s*$Type\s*//g;
1070
for my $modifier (split(' ', $possible)) {
1071
if ($modifier !~ $notPermitted) {
1072
warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1073
push(@modifierList, $modifier);
1078
warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1079
push(@typeList, $possible);
1083
warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1090
if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
1093
my $line = $prefix . $_[0];
1095
$line = (split('\n', $line))[0] . "\n" if ($terse);
1097
push(our @report, $line);
1105
if (report("ERROR: $_[0]\n")) {
1111
if (report("WARNING: $_[0]\n")) {
1117
if ($check && report("CHECK: $_[0]\n")) {
1123
sub check_absolute_file {
1124
my ($absolute, $herecurr) = @_;
1125
my $file = $absolute;
1127
##print "absolute<$absolute>\n";
1129
# See if any suffix of this path is a path within the tree.
1130
while ($file =~ s@^[^/]*/@@) {
1131
if (-f "$root/$file") {
1132
##print "file<$file>\n";
1140
# It is, so see if the prefix is acceptable.
1141
my $prefix = $absolute;
1142
substr($prefix, -length($file)) = '';
1144
##print "prefix<$prefix>\n";
1145
if ($prefix ne ".../") {
1146
WARN("use relative pathname instead of absolute in changelog text\n" . $herecurr);
1151
my $filename = shift;
1157
my $stashrawline="";
1174
# Trace the real file/line as we go.
1180
my $comment_edge = 0;
1184
my $prev_values = 'E';
1187
my %suppress_ifbraces;
1188
my %suppress_whiletrailers;
1189
my %suppress_export;
1191
# Pre-scan the patch sanitizing the lines.
1192
# Pre-scan the patch looking for any __setup documentation.
1194
my @setup_docs = ();
1197
sanitise_line_reset();
1199
foreach my $rawline (@rawlines) {
1203
if ($rawline=~/^\+\+\+\s+(\S+)/) {
1205
if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1210
if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1219
# Guestimate if this is a continuing comment. Run
1220
# the context looking for a comment "edge". If this
1221
# edge is a close comment then we must be in a comment
1225
for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1226
next if (defined $rawlines[$ln - 1] &&
1227
$rawlines[$ln - 1] =~ /^-/);
1229
#print "RAW<$rawlines[$ln - 1]>\n";
1230
last if (!defined $rawlines[$ln - 1]);
1231
if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1232
$rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1237
if (defined $edge && $edge eq '*/') {
1241
# Guestimate if this is a continuing comment. If this
1242
# is the start of a diff block and this line starts
1243
# ' *' then it is very likely a comment.
1244
if (!defined $edge &&
1245
$rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1250
##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1251
sanitise_line_reset($in_comment);
1253
} elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1254
# Standardise the strings and chars within the input to
1255
# simplify matching -- only bother with positive lines.
1256
$line = sanitise_line($rawline);
1258
push(@lines, $line);
1261
$realcnt-- if ($line =~ /^(?:\+| |$)/);
1266
#print "==>$rawline\n";
1267
#print "-->$line\n";
1269
if ($setup_docs && $line =~ /^\+/) {
1270
push(@setup_docs, $line);
1278
foreach my $line (@lines) {
1281
my $rawline = $rawlines[$linenr - 1];
1283
#extract the line range in the file after the patch is applied
1284
if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1286
$first_line = $linenr + 1;
1296
%suppress_ifbraces = ();
1297
%suppress_whiletrailers = ();
1298
%suppress_export = ();
1301
# track the line number as we move through the hunk, note that
1302
# new versions of GNU diff omit the leading space on completely
1303
# blank context lines so we need to count that too.
1304
} elsif ($line =~ /^( |\+|$)/) {
1306
$realcnt-- if ($realcnt != 0);
1308
# Measure the line length and indent.
1309
($length, $indent) = line_stats($rawline);
1311
# Track the previous line.
1312
($prevline, $stashline) = ($stashline, $line);
1313
($previndent, $stashindent) = ($stashindent, $indent);
1314
($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1316
#warn "line<$line>\n";
1318
} elsif ($realcnt == 1) {
1322
my $hunk_line = ($realcnt != 0);
1324
#make up the handle for any error we report on this line
1325
$prefix = "$filename:$realline: " if ($emacs && $file);
1326
$prefix = "$filename:$linenr: " if ($emacs && !$file);
1328
$here = "#$linenr: " if (!$file);
1329
$here = "#$realline: " if ($file);
1331
# extract the filename as it passes
1332
if ($line =~ /^diff --git.*?(\S+)$/) {
1334
$realfile =~ s@^([^/]*)/@@;
1336
} elsif ($line =~ /^\+\+\+\s+(\S+)/) {
1338
$realfile =~ s@^([^/]*)/@@;
1341
if (!$file && $tree && $p1_prefix ne '' &&
1342
-e "$root/$p1_prefix") {
1343
WARN("patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1346
if ($realfile =~ m@^include/asm/@) {
1347
ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1352
$here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
1354
my $hereline = "$here\n$rawline\n";
1355
my $herecurr = "$here\n$rawline\n";
1356
my $hereprev = "$here\n$prevrawline\n$rawline\n";
1358
$cnt_lines++ if ($realcnt != 0);
1360
# Check for incorrect file permissions
1361
if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1362
my $permhere = $here . "FILE: $realfile\n";
1363
if ($realfile =~ /(Makefile|Kconfig|\.c|\.h|\.S|\.tmpl)$/) {
1364
ERROR("do not set execute permissions for source files\n" . $permhere);
1368
#check the patch for a signoff:
1369
if ($line =~ /^\s*signed-off-by:/i) {
1370
# This is a signoff, if ugly, so do not double report.
1372
if (!($line =~ /^\s*Signed-off-by:/)) {
1373
WARN("Signed-off-by: is the preferred form\n" .
1376
if ($line =~ /^\s*signed-off-by:\S/i) {
1377
WARN("space required after Signed-off-by:\n" .
1382
# Check for wrappage within a valid hunk of the file
1383
if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1384
ERROR("patch seems to be corrupt (line wrapped?)\n" .
1385
$herecurr) if (!$emitted_corrupt++);
1388
# Check for absolute kernel paths.
1390
while ($line =~ m{(?:^|\s)(/\S*)}g) {
1393
if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1394
check_absolute_file($1, $herecurr)) {
1397
check_absolute_file($file, $herecurr);
1402
# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1403
if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1404
$rawline !~ m/^$UTF8*$/) {
1405
my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1407
my $blank = copy_spacing($rawline);
1408
my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1409
my $hereptr = "$hereline$ptr\n";
1411
ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1414
# ignore non-hunk lines and lines being removed
1415
next if (!$hunk_line || $line =~ /^-/);
1417
#trailing whitespace
1418
if ($line =~ /^\+.*\015/) {
1419
my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1420
ERROR("DOS line endings\n" . $herevet);
1422
} elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1423
my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1424
ERROR("trailing whitespace\n" . $herevet);
1428
# check for Kconfig help text having a real description
1429
# Only applies when adding the entry originally, after that we do not have
1430
# sufficient context to determine whether it is indeed long enough.
1431
if ($realfile =~ /Kconfig/ &&
1432
$line =~ /\+\s*(?:---)?help(?:---)?$/) {
1435
my $ln = $linenr + 1;
1438
while ($cnt > 0 && defined $lines[$ln - 1]) {
1439
$f = $lines[$ln - 1];
1440
$cnt-- if ($lines[$ln - 1] !~ /^-/);
1441
$is_end = $lines[$ln - 1] =~ /^\+/;
1444
next if ($f =~ /^-/);
1448
next if ($f =~ /^$/);
1449
if ($f =~ /^\s*config\s/) {
1455
WARN("please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_end && $length < 4);
1456
#print "is_end<$is_end> length<$length>\n";
1459
# check we are in a valid source file if not then ignore this hunk
1460
next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1463
if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
1464
$rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1465
!($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ ||
1466
$line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
1469
WARN("line over 80 characters\n" . $herecurr);
1472
# check for spaces before a quoted newline
1473
if ($rawline =~ /^.*\".*\s\\n/) {
1474
WARN("unnecessary whitespace before a quoted newline\n" . $herecurr);
1477
# check for adding lines without a newline.
1478
if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1479
WARN("adding a line without newline at end of file\n" . $herecurr);
1482
# Blackfin: use hi/lo macros
1483
if ($realfile =~ m@arch/blackfin/.*\.S$@) {
1484
if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
1485
my $herevet = "$here\n" . cat_vet($line) . "\n";
1486
ERROR("use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
1488
if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
1489
my $herevet = "$here\n" . cat_vet($line) . "\n";
1490
ERROR("use the HI() macro, not (... >> 16)\n" . $herevet);
1494
# check we are in a valid source file C or perl if not then ignore this hunk
1495
next if ($realfile !~ /\.(h|c|pl)$/);
1497
# in QEMU, no tabs are allowed
1498
if ($rawline =~ /^\+.*\t/) {
1499
my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1500
ERROR("code indent should never use tabs\n" . $herevet);
1504
# check we are in a valid C source file if not then ignore this hunk
1505
next if ($realfile !~ /\.(h|c)$/);
1507
# check for RCS/CVS revision markers
1508
if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
1509
WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1512
# Blackfin: don't use __builtin_bfin_[cs]sync
1513
if ($line =~ /__builtin_bfin_csync/) {
1514
my $herevet = "$here\n" . cat_vet($line) . "\n";
1515
ERROR("use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
1517
if ($line =~ /__builtin_bfin_ssync/) {
1518
my $herevet = "$here\n" . cat_vet($line) . "\n";
1519
ERROR("use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
1522
# Check for potential 'bare' types
1523
my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
1525
if ($realcnt && $line =~ /.\s*\S/) {
1526
($stat, $cond, $line_nr_next, $remain_next, $off_next) =
1527
ctx_statement_block($linenr, $realcnt, 0);
1528
$stat =~ s/\n./\n /g;
1529
$cond =~ s/\n./\n /g;
1531
# Find the real next line.
1532
$realline_next = $line_nr_next;
1533
if (defined $realline_next &&
1534
(!defined $lines[$realline_next - 1] ||
1535
substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
1542
# Ignore goto labels.
1543
if ($s =~ /$Ident:\*$/s) {
1545
# Ignore functions being called
1546
} elsif ($s =~ /^.\s*$Ident\s*\(/s) {
1548
} elsif ($s =~ /^.\s*else\b/s) {
1550
# declarations always start with types
1551
} 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) {
1554
possible($type, "A:" . $s);
1556
# definitions in global scope can only start with types
1557
} elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
1558
possible($1, "B:" . $s);
1561
# any (foo ... *) is a pointer cast, and foo is a type
1562
while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
1563
possible($1, "C:" . $s);
1566
# Check for any sort of function declaration.
1567
# int foo(something bar, other baz);
1568
# void (*store_gdt)(x86_descr_ptr *);
1569
if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
1570
my ($name_len) = length($1);
1573
substr($ctx, 0, $name_len + 1, '');
1574
$ctx =~ s/\)[^\)]*$//;
1576
for my $arg (split(/\s*,\s*/, $ctx)) {
1577
if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
1579
possible($1, "D:" . $s);
1587
# Checks which may be anchored in the context.
1590
# Check for switch () and associated case and default
1591
# statements should be at the same indent.
1592
if ($line=~/\bswitch\s*\(.*\)/) {
1595
my @ctx = ctx_block_outer($linenr, $realcnt);
1597
for my $ctx (@ctx) {
1598
my ($clen, $cindent) = line_stats($ctx);
1599
if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1600
$indent != $cindent) {
1601
$err .= "$sep$ctx\n";
1608
ERROR("switch and case should be at the same indent\n$hereline$err");
1612
# if/while/etc brace do not go on next line, unless defining a do while loop,
1613
# or if that brace on the next line is for something else
1614
if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
1615
my $pre_ctx = "$1$2";
1617
my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
1618
my $ctx_cnt = $realcnt - $#ctx - 1;
1619
my $ctx = join("\n", @ctx);
1621
my $ctx_ln = $linenr;
1622
my $ctx_skip = $realcnt;
1624
while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1625
defined $lines[$ctx_ln - 1] &&
1626
$lines[$ctx_ln - 1] =~ /^-/)) {
1627
##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1628
$ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
1632
#print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1633
#print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
1635
if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1636
ERROR("that open brace { should be on the previous line\n" .
1637
"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
1639
if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1640
$ctx =~ /\)\s*\;\s*$/ &&
1641
defined $lines[$ctx_ln - 1])
1643
my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1644
if ($nindent > $indent) {
1645
WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
1646
"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
1651
# Check relative indent for conditionals and blocks.
1652
if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1653
my ($s, $c) = ($stat, $cond);
1655
substr($s, 0, length($c), '');
1657
# Make sure we remove the line prefixes as we have
1658
# none on the first line, and are going to readd them
1662
# Find out how long the conditional actually is.
1663
my @newlines = ($c =~ /\n/gs);
1664
my $cond_lines = 1 + $#newlines;
1666
# We want to check the first line inside the block
1667
# starting at the end of the conditional, so remove:
1668
# 1) any blank line termination
1669
# 2) any opening brace { on end of the line
1671
my $continuation = 0;
1673
$s =~ s/^.*\bdo\b//;
1675
if ($s =~ s/^\s*\\//) {
1678
if ($s =~ s/^\s*?\n//) {
1683
# Also ignore a loop construct at the end of a
1684
# preprocessor statement.
1685
if (($prevline =~ /^.\s*#\s*define\s/ ||
1686
$prevline =~ /\\\s*$/) && $continuation == 0) {
1692
while ($cond_ptr != $cond_lines) {
1693
$cond_ptr = $cond_lines;
1695
# If we see an #else/#elif then the code
1697
if ($s =~ /^\s*\#\s*(?:else|elif)/) {
1702
# 1) blank lines, they should be at 0,
1703
# 2) preprocessor lines, and
1705
if ($continuation ||
1707
$s =~ /^\s*#\s*?/ ||
1708
$s =~ /^\s*$Ident\s*:/) {
1709
$continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
1710
if ($s =~ s/^.*?\n//) {
1716
my (undef, $sindent) = line_stats("+" . $s);
1717
my $stat_real = raw_line($linenr, $cond_lines);
1719
# Check if either of these lines are modified, else
1720
# this is not this patch's fault.
1721
if (!defined($stat_real) ||
1722
$stat !~ /^\+/ && $stat_real !~ /^\+/) {
1725
if (defined($stat_real) && $cond_lines > 1) {
1726
$stat_real = "[...]\n$stat_real";
1729
#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";
1731
if ($check && (($sindent % 4) != 0 ||
1732
($sindent <= $indent && $s ne ''))) {
1733
WARN("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
1737
# Track the 'values' across context and added lines.
1738
my $opline = $line; $opline =~ s/^./ /;
1739
my ($curr_values, $curr_vars) =
1740
annotate_values($opline . "\n", $prev_values);
1741
$curr_values = $prev_values . $curr_values;
1743
my $outline = $opline; $outline =~ s/\t/ /g;
1744
print "$linenr > .$outline\n";
1745
print "$linenr > $curr_values\n";
1746
print "$linenr > $curr_vars\n";
1748
$prev_values = substr($curr_values, -1);
1750
#ignore lines not being added
1751
if ($line=~/^[^\+]/) {next;}
1753
# TEST: allow direct testing of the type matcher.
1755
if ($line =~ /^.\s*$Declare\s*$/) {
1756
ERROR("TEST: is type\n" . $herecurr);
1757
} elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
1758
ERROR("TEST: is not type ($1 is)\n". $herecurr);
1762
# TEST: allow direct testing of the attribute matcher.
1764
if ($line =~ /^.\s*$Modifier\s*$/) {
1765
ERROR("TEST: is attr\n" . $herecurr);
1766
} elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
1767
ERROR("TEST: is not attr ($1 is)\n". $herecurr);
1772
# check for initialisation to aggregates open brace on the next line
1773
if ($line =~ /^.\s*{/ &&
1774
$prevline =~ /(?:^|[^=])=\s*$/) {
1775
ERROR("that open brace { should be on the previous line\n" . $hereprev);
1779
# Checks which are anchored on the added line.
1782
# check for malformed paths in #include statements (uses RAW line)
1783
if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
1785
if ($path =~ m{//}) {
1786
ERROR("malformed #include filename\n" .
1791
# no C99 // comments
1792
if ($line =~ m{//}) {
1793
ERROR("do not use C99 // comments\n" . $herecurr);
1795
# Remove C99 comments.
1797
$opline =~ s@//.*@@;
1799
# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
1800
# the whole statement.
1801
#print "APW <$lines[$realline_next - 1]>\n";
1802
if (defined $realline_next &&
1803
exists $lines[$realline_next - 1] &&
1804
!defined $suppress_export{$realline_next} &&
1805
($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
1806
$lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1807
# Handle definitions which produce identifiers with
1810
# EXPORT_SYMBOL(something_foo);
1812
if ($stat =~ /^.([A-Z_]+)\s*\(\s*($Ident)/ &&
1813
$name =~ /^${Ident}_$2/) {
1814
#print "FOO C name<$name>\n";
1815
$suppress_export{$realline_next} = 1;
1817
} elsif ($stat !~ /(?:
1819
^.DEFINE_$Ident\(\Q$name\E\)|
1820
^.DECLARE_$Ident\(\Q$name\E\)|
1821
^.LIST_HEAD\(\Q$name\E\)|
1822
^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
1823
\b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
1825
#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
1826
$suppress_export{$realline_next} = 2;
1828
$suppress_export{$realline_next} = 1;
1831
if (!defined $suppress_export{$linenr} &&
1832
$prevline =~ /^.\s*$/ &&
1833
($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
1834
$line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1835
#print "FOO B <$lines[$linenr - 1]>\n";
1836
$suppress_export{$linenr} = 2;
1838
if (defined $suppress_export{$linenr} &&
1839
$suppress_export{$linenr} == 2) {
1840
WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
1843
# check for global initialisers.
1844
if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
1845
ERROR("do not initialise globals to 0 or NULL\n" .
1848
# check for static initialisers.
1849
if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
1850
ERROR("do not initialise statics to 0 or NULL\n" .
1854
# * goes on variable not on type
1856
if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) {
1857
my ($from, $to) = ($1, $1);
1859
# Should start with a space.
1860
$to =~ s/^(\S)/ $1/;
1861
# Should not end with a space.
1863
# '*'s should not have spaces between.
1864
while ($to =~ s/\*\s+\*/\*\*/) {
1867
#print "from<$from> to<$to>\n";
1869
ERROR("\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr);
1871
} elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) {
1872
my ($from, $to, $ident) = ($1, $1, $2);
1874
# Should start with a space.
1875
$to =~ s/^(\S)/ $1/;
1876
# Should not end with a space.
1878
# '*'s should not have spaces between.
1879
while ($to =~ s/\*\s+\*/\*\*/) {
1881
# Modifiers should have spaces.
1882
$to =~ s/(\b$Modifier$)/$1 /;
1884
#print "from<$from> to<$to> ident<$ident>\n";
1885
if ($from ne $to && $ident !~ /^$Modifier$/) {
1886
ERROR("\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr);
1890
# # no BUG() or BUG_ON()
1891
# if ($line =~ /\b(BUG|BUG_ON)\b/) {
1892
# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
1893
# print "$herecurr";
1897
if ($line =~ /\bLINUX_VERSION_CODE\b/) {
1898
WARN("LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
1901
# printk should use KERN_* levels. Note that follow on printk's on the
1902
# same line do not need a level, so we use the current block context
1903
# to try and find and validate the current printk. In summary the current
1904
# printk includes all preceeding printk's which have no newline on the end.
1905
# we assume the first bad printk is the one to report.
1906
if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
1908
for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
1909
#print "CHECK<$lines[$ln - 1]\n";
1910
# we have a preceeding printk if it ends
1911
# with "\n" ignore it, else it is to blame
1912
if ($lines[$ln - 1] =~ m{\bprintk\(}) {
1913
if ($rawlines[$ln - 1] !~ m{\\n"}) {
1920
WARN("printk() should include KERN_ facility level\n" . $herecurr);
1924
# function brace can't be on same line, except for #defines of do while,
1925
# or if closed on same line
1926
if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
1927
!($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
1928
ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
1931
# open braces for enum, union and struct go on the same line.
1932
if ($line =~ /^.\s*{/ &&
1933
$prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1934
ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
1937
# missing space after union, struct or enum definition
1938
if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) {
1939
WARN("missing space after $1 definition\n" . $herecurr);
1942
# check for spacing round square brackets; allowed:
1943
# 1. with a type on the left -- int [] a;
1944
# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
1945
# 3. inside a curly brace -- = { [0...10] = 5 }
1946
while ($line =~ /(.*?\s)\[/g) {
1947
my ($where, $prefix) = ($-[1], $1);
1948
if ($prefix !~ /$Type\s+$/ &&
1949
($where != 0 || $prefix !~ /^.\s+$/) &&
1950
$prefix !~ /{\s+$/) {
1951
ERROR("space prohibited before open square bracket '['\n" . $herecurr);
1955
# check for spaces between functions and their parentheses.
1956
while ($line =~ /($Ident)\s+\(/g) {
1958
my $ctx_before = substr($line, 0, $-[1]);
1959
my $ctx = "$ctx_before$name";
1961
# Ignore those directives where spaces _are_ permitted.
1963
if|for|while|switch|return|case|
1964
volatile|__volatile__|
1965
__attribute__|format|__extension__|
1969
# cpp #define statements have non-optional spaces, ie
1970
# if there is a space between the name and the open
1971
# parenthesis it is simply not a parameter group.
1972
} elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
1974
# cpp #elif statement condition may start with a (
1975
} elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
1977
# If this whole things ends with a type its most
1978
# likely a typedef for a function.
1979
} elsif ($ctx =~ /$Type$/) {
1982
WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
1985
# Check operator spacing.
1986
if (!($line=~/\#\s*include/)) {
1988
<<=|>>=|<=|>=|==|!=|
1989
\+=|-=|\*=|\/=|%=|\^=|\|=|&=|
1990
=>|->|<<|>>|<|>|=|!|~|
1991
&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
1994
my @elements = split(/($ops|;)/, $opline);
1997
my $blank = copy_spacing($opline);
1999
for (my $n = 0; $n < $#elements; $n += 2) {
2000
$off += length($elements[$n]);
2002
# Pick up the preceeding and succeeding characters.
2003
my $ca = substr($opline, 0, $off);
2005
if (length($opline) >= ($off + length($elements[$n + 1]))) {
2006
$cc = substr($opline, $off + length($elements[$n + 1]));
2008
my $cb = "$ca$;$cc";
2011
$a = 'V' if ($elements[$n] ne '');
2012
$a = 'W' if ($elements[$n] =~ /\s$/);
2013
$a = 'C' if ($elements[$n] =~ /$;$/);
2014
$a = 'B' if ($elements[$n] =~ /(\[|\()$/);
2015
$a = 'O' if ($elements[$n] eq '');
2016
$a = 'E' if ($ca =~ /^\s*$/);
2018
my $op = $elements[$n + 1];
2021
if (defined $elements[$n + 2]) {
2022
$c = 'V' if ($elements[$n + 2] ne '');
2023
$c = 'W' if ($elements[$n + 2] =~ /^\s/);
2024
$c = 'C' if ($elements[$n + 2] =~ /^$;/);
2025
$c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
2026
$c = 'O' if ($elements[$n + 2] eq '');
2027
$c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
2032
my $ctx = "${a}x${c}";
2034
my $at = "(ctx:$ctx)";
2036
my $ptr = substr($blank, 0, $off) . "^";
2037
my $hereptr = "$hereline$ptr\n";
2039
# Pull out the value of this operator.
2040
my $op_type = substr($curr_values, $off + 1, 1);
2042
# Get the full operator variant.
2043
my $opv = $op . substr($curr_vars, $off, 1);
2045
# Ignore operators passed as parameters.
2046
if ($op_type ne 'V' &&
2047
$ca =~ /\s$/ && $cc =~ /^\s*,/) {
2050
# } elsif ($op =~ /^$;+$/) {
2052
# ; should have either the end of line or a space or \ after it
2053
} elsif ($op eq ';') {
2054
if ($ctx !~ /.x[WEBC]/ &&
2055
$cc !~ /^\\/ && $cc !~ /^;/) {
2056
ERROR("space required after that '$op' $at\n" . $hereptr);
2060
} elsif ($op eq '//') {
2064
# : when part of a bitfield
2065
} elsif ($op eq '->' || $opv eq ':B') {
2066
if ($ctx =~ /Wx.|.xW/) {
2067
ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
2070
# , must have a space on the right.
2071
# not required when having a single },{ on one line
2072
} elsif ($op eq ',') {
2073
if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/ &&
2074
($elements[$n] . $elements[$n + 2]) !~ " *}{") {
2075
ERROR("space required after that '$op' $at\n" . $hereptr);
2078
# '*' as part of a type definition -- reported already.
2079
} elsif ($opv eq '*_') {
2080
#warn "'*' is part of type\n";
2082
# unary operators should have a space before and
2083
# none after. May be left adjacent to another
2084
# unary operator, or a cast
2085
} elsif ($op eq '!' || $op eq '~' ||
2086
$opv eq '*U' || $opv eq '-U' ||
2087
$opv eq '&U' || $opv eq '&&U') {
2088
if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
2089
ERROR("space required before that '$op' $at\n" . $hereptr);
2091
if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
2092
# A unary '*' may be const
2094
} elsif ($ctx =~ /.xW/) {
2095
ERROR("space prohibited after that '$op' $at\n" . $hereptr);
2098
# unary ++ and unary -- are allowed no space on one side.
2099
} elsif ($op eq '++' or $op eq '--') {
2100
if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
2101
ERROR("space required one side of that '$op' $at\n" . $hereptr);
2103
if ($ctx =~ /Wx[BE]/ ||
2104
($ctx =~ /Wx./ && $cc =~ /^;/)) {
2105
ERROR("space prohibited before that '$op' $at\n" . $hereptr);
2107
if ($ctx =~ /ExW/) {
2108
ERROR("space prohibited after that '$op' $at\n" . $hereptr);
2112
# << and >> may either have or not have spaces both sides
2113
} elsif ($op eq '<<' or $op eq '>>' or
2114
$op eq '&' or $op eq '^' or $op eq '|' or
2115
$op eq '+' or $op eq '-' or
2116
$op eq '*' or $op eq '/' or
2119
if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
2120
ERROR("need consistent spacing around '$op' $at\n" .
2124
# A colon needs no spaces before when it is
2125
# terminating a case value or a label.
2126
} elsif ($opv eq ':C' || $opv eq ':L') {
2127
if ($ctx =~ /Wx./) {
2128
ERROR("space prohibited before that '$op' $at\n" . $hereptr);
2131
# All the others need spaces both sides.
2132
} elsif ($ctx !~ /[EWC]x[CWE]/) {
2135
# Ignore email addresses <foo@bar>
2137
$cc =~ /^\S+\@\S+>/) ||
2139
$ca =~ /<\S+\@\S+$/))
2145
if (($opv eq ':O' && $ca =~ /\?$/) ||
2146
($op eq '?' && $cc =~ /^:/)) {
2151
ERROR("spaces required around that '$op' $at\n" . $hereptr);
2154
$off += length($elements[$n + 1]);
2158
# check for multiple assignments
2159
if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
2160
CHK("multiple assignments should be avoided\n" . $herecurr);
2163
## # check for multiple declarations, allowing for a function declaration
2165
## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
2166
## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
2168
## # Remove any bracketed sections to ensure we do not
2169
## # falsly report the parameters of functions.
2171
## while ($ln =~ s/\([^\(\)]*\)//g) {
2173
## if ($ln =~ /,/) {
2174
## WARN("declaring multiple variables together should be avoided\n" . $herecurr);
2178
#need space before brace following if, while, etc
2179
if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
2181
ERROR("space required before the open brace '{'\n" . $herecurr);
2184
# closing brace should have a space following it when it has anything
2186
if ($line =~ /}(?!(?:,|;|\)))\S/) {
2187
ERROR("space required after that close brace '}'\n" . $herecurr);
2190
# check spacing on square brackets
2191
if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
2192
ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
2194
if ($line =~ /\s\]/) {
2195
ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
2198
# check spacing on parentheses
2199
if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
2200
$line !~ /for\s*\(\s+;/) {
2201
ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
2203
if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
2204
$line !~ /for\s*\(.*;\s+\)/ &&
2205
$line !~ /:\s+\)/) {
2206
ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
2209
# Return is not a function.
2210
if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2214
# Flatten any parentheses
2215
$value =~ s/\(/ \(/g;
2216
$value =~ s/\)/\) /g;
2217
while ($value =~ s/\[[^\{\}]*\]/1/ ||
2218
$value !~ /(?:$Ident|-?$Constant)\s*
2220
(?:$Ident|-?$Constant)/x &&
2221
$value =~ s/\([^\(\)]*\)/1/) {
2223
#print "value<$value>\n";
2224
if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
2225
ERROR("return is not a function, parentheses are not required\n" . $herecurr);
2227
} elsif ($spacing !~ /\s+/) {
2228
ERROR("space required before the open parenthesis '('\n" . $herecurr);
2231
# Return of what appears to be an errno should normally be -'ve
2232
if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
2234
if ($name ne 'EOF' && $name ne 'ERROR') {
2235
CHK("return of an errno should typically be -ve (return -$1)\n" . $herecurr);
2239
# Need a space before open parenthesis after if, while etc
2240
if ($line=~/\b(if|while|for|switch)\(/) {
2241
ERROR("space required before the open parenthesis '('\n" . $herecurr);
2244
# Check for illegal assignment in if conditional -- and check for trailing
2245
# statements after the conditional.
2246
if ($line =~ /do\s*(?!{)/) {
2247
my ($stat_next) = ctx_statement_block($line_nr_next,
2248
$remain_next, $off_next);
2249
$stat_next =~ s/\n./\n /g;
2250
##print "stat<$stat> stat_next<$stat_next>\n";
2252
if ($stat_next =~ /^\s*while\b/) {
2253
# If the statement carries leading newlines,
2254
# then count those as offsets.
2256
($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2258
statement_rawlines($whitespace) - 1;
2260
$suppress_whiletrailers{$line_nr_next +
2264
if (!defined $suppress_whiletrailers{$linenr} &&
2265
$line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
2266
my ($s, $c) = ($stat, $cond);
2268
if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
2269
ERROR("do not use assignment in if condition\n" . $herecurr);
2272
# Find out what is on the end of the line after the
2274
substr($s, 0, length($c), '');
2276
$s =~ s/$;//g; # Remove any comments
2277
if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2278
$c !~ /}\s*while\s*/)
2280
# Find out how long the conditional actually is.
2281
my @newlines = ($c =~ /\n/gs);
2282
my $cond_lines = 1 + $#newlines;
2285
$stat_real = raw_line($linenr, $cond_lines)
2286
. "\n" if ($cond_lines);
2287
if (defined($stat_real) && $cond_lines > 1) {
2288
$stat_real = "[...]\n$stat_real";
2291
ERROR("trailing statements should be on next line\n" . $herecurr . $stat_real);
2295
# Check for bitwise tests written as boolean
2307
WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2310
# if and else should not have general statements after it
2311
if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2313
$s =~ s/$;//g; # Remove any comments
2314
if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2315
ERROR("trailing statements should be on next line\n" . $herecurr);
2318
# if should not continue a brace
2319
if ($line =~ /}\s*if\b/) {
2320
ERROR("trailing statements should be on next line\n" .
2323
# case and default should not have general statements after them
2324
if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2326
(?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
2330
ERROR("trailing statements should be on next line\n" . $herecurr);
2333
# Check for }<nl>else {, these must be at the same
2334
# indent level to be relevant to each other.
2335
if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2336
$previndent == $indent) {
2337
ERROR("else should follow close brace '}'\n" . $hereprev);
2340
if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2341
$previndent == $indent) {
2342
my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2344
# Find out what is on the end of the line after the
2346
substr($s, 0, length($c), '');
2349
if ($s =~ /^\s*;/) {
2350
ERROR("while should follow close brace '}'\n" . $hereprev);
2354
#studly caps, commented out until figure out how to distinguish between use of existing and adding new
2355
# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2356
# print "No studly caps, use _\n";
2357
# print "$herecurr";
2361
#no spaces allowed after \ in define
2362
if ($line=~/\#\s*define.*\\\s$/) {
2363
WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
2366
#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
2367
if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
2369
my $checkfile = "include/linux/$file";
2370
if (-f "$root/$checkfile" &&
2371
$realfile ne $checkfile &&
2372
$1 !~ /$allowed_asm_includes/)
2374
if ($realfile =~ m{^arch/}) {
2375
CHK("Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2377
WARN("Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2382
# multi-statement macros should be enclosed in a do while loop, grab the
2383
# first statement and ensure its the whole macro if its not enclosed
2384
# in a known good container
2385
if ($realfile !~ m@/vmlinux.lds.h$@ &&
2386
$line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
2389
my ($off, $dstat, $dcond, $rest);
2392
my $args = defined($1);
2394
# Find the end of the macro and limit our statement
2396
while ($cnt > 0 && defined $lines[$ln - 1] &&
2397
$lines[$ln - 1] =~ /^(?:-|..*\\$)/)
2399
$ctx .= $rawlines[$ln - 1] . "\n";
2400
$cnt-- if ($lines[$ln - 1] !~ /^-/);
2403
$ctx .= $rawlines[$ln - 1];
2405
($dstat, $dcond, $ln, $cnt, $off) =
2406
ctx_statement_block($linenr, $ln - $linenr + 1, 0);
2407
#print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
2408
#print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
2410
# Extract the remainder of the define (if any) and
2411
# rip off surrounding spaces, and trailing \'s.
2413
while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
2414
#print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
2415
if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
2416
$rest .= substr($lines[$ln - 1], $off) . "\n";
2422
$rest =~ s/\\\n.//g;
2426
# Clean up the original statement.
2428
substr($dstat, 0, length($dcond), '');
2430
$dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
2433
$dstat =~ s/\\\n.//g;
2434
$dstat =~ s/^\s*//s;
2435
$dstat =~ s/\s*$//s;
2437
# Flatten any parentheses and braces
2438
while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2439
$dstat =~ s/\{[^\{\}]*\}/1/ ||
2440
$dstat =~ s/\[[^\{\}]*\]/1/)
2444
my $exceptions = qr{
2456
#print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
2457
if ($rest ne '' && $rest ne ',') {
2458
if ($rest !~ /while\s*\(/ &&
2459
$dstat !~ /$exceptions/)
2461
ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
2464
} elsif ($ctx !~ /;/) {
2466
$dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2467
$dstat !~ /$exceptions/ &&
2468
$dstat !~ /^\.$Ident\s*=/ &&
2469
$dstat =~ /$Operators/)
2471
ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
2476
# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
2477
# all assignments may have only one of the following with an assignment:
2480
# VMLINUX_SYMBOL(...)
2481
if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
2482
WARN("vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
2485
# check for missing bracing round if etc
2486
if ($line =~ /(^.*)\bif\b/ && $line !~ /\#\s*if/) {
2487
my ($level, $endln, @chunks) =
2488
ctx_statement_full($linenr, $realcnt, 1);
2489
#print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
2490
#print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2491
if ($#chunks >= 0 && $level == 0) {
2494
my $herectx = $here . "\n";
2495
my $ln = $linenr - 1;
2496
for my $chunk (@chunks) {
2497
my ($cond, $block) = @{$chunk};
2499
# If the condition carries leading newlines, then count those as offsets.
2500
my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2501
my $offset = statement_rawlines($whitespace) - 1;
2503
#print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2505
# We have looked at and allowed this specific line.
2506
$suppress_ifbraces{$ln + $offset} = 1;
2508
$herectx .= "$rawlines[$ln + $offset]\n[...]\n";
2509
$ln += statement_rawlines($block) - 1;
2511
substr($block, 0, length($cond), '');
2513
$seen++ if ($block =~ /^\s*{/);
2515
#print "cond<$cond> block<$block> allowed<$allowed>\n";
2516
if (statement_lines($cond) > 1) {
2517
#print "APW: ALLOWED: cond<$cond>\n";
2520
if ($block =~/\b(?:if|for|while)\b/) {
2521
#print "APW: ALLOWED: block<$block>\n";
2524
if (statement_block_size($block) > 1) {
2525
#print "APW: ALLOWED: lines block<$block>\n";
2529
if ($seen != ($#chunks + 1)) {
2530
WARN("braces {} are necessary for all arms of this statement\n" . $herectx);
2534
if (!defined $suppress_ifbraces{$linenr - 1} &&
2535
$line =~ /\b(if|while|for|else)\b/ &&
2536
$line !~ /\#\s*if/ &&
2537
$line !~ /\#\s*else/) {
2540
# Check the pre-context.
2541
if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2542
#print "APW: ALLOWED: pre<$1>\n";
2546
my ($level, $endln, @chunks) =
2547
ctx_statement_full($linenr, $realcnt, $-[0]);
2549
# Check the condition.
2550
my ($cond, $block) = @{$chunks[0]};
2551
#print "CHECKING<$linenr> cond<$cond> block<$block>\n";
2552
if (defined $cond) {
2553
substr($block, 0, length($cond), '');
2555
if (statement_lines($cond) > 1) {
2556
#print "APW: ALLOWED: cond<$cond>\n";
2559
if ($block =~/\b(?:if|for|while)\b/) {
2560
#print "APW: ALLOWED: block<$block>\n";
2563
if (statement_block_size($block) > 1) {
2564
#print "APW: ALLOWED: lines block<$block>\n";
2567
# Check the post-context.
2568
if (defined $chunks[1]) {
2569
my ($cond, $block) = @{$chunks[1]};
2570
if (defined $cond) {
2571
substr($block, 0, length($cond), '');
2573
if ($block =~ /^\s*\{/) {
2574
#print "APW: ALLOWED: chunk-1 block<$block>\n";
2578
if ($level == 0 && $block !~ /^\s*\{/ && !$allowed) {
2579
my $herectx = $here . "\n";;
2580
my $cnt = statement_rawlines($block);
2582
for (my $n = 0; $n < $cnt; $n++) {
2583
$herectx .= raw_line($linenr, $n) . "\n";;
2586
WARN("braces {} are necessary even for single statement blocks\n" . $herectx);
2590
# don't include deprecated include files (uses RAW line)
2591
for my $inc (@dep_includes) {
2592
if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
2593
ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2597
# don't use deprecated functions
2598
for my $func (@dep_functions) {
2599
if ($line =~ /\b$func\b/) {
2600
ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2604
# no volatiles please
2605
my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2606
if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
2607
WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
2610
# SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
2611
if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
2612
ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
2616
if ($line =~ /^.\s*\#\s*if\s+0\b/) {
2617
CHK("if this code is redundant consider removing it\n" .
2621
# check for needless kfree() checks
2622
if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2624
if ($line =~ /\bkfree\(\Q$expr\E\);/) {
2625
WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
2628
# check for needless usb_free_urb() checks
2629
if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2631
if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
2632
WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
2636
# prefer usleep_range over udelay
2637
if ($line =~ /\budelay\s*\(\s*(\w+)\s*\)/) {
2638
# ignore udelay's < 10, however
2639
if (! (($1 =~ /(\d+)/) && ($1 < 10)) ) {
2640
CHK("usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
2644
# warn about unexpectedly long msleep's
2645
if ($line =~ /\bmsleep\s*\((\d+)\);/) {
2647
WARN("msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
2651
# warn about #ifdefs in C files
2652
# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
2653
# print "#ifdef in C files should be avoided\n";
2654
# print "$herecurr";
2658
# warn about spacing in #ifdefs
2659
if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
2660
ERROR("exactly one space required after that #$1\n" . $herecurr);
2663
# check for spinlock_t definitions without a comment.
2664
if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
2665
$line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
2667
if (!ctx_has_comment($first_line, $linenr)) {
2668
CHK("$1 definition without comment\n" . $herecurr);
2671
# check for memory barriers without a comment.
2672
if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2673
if (!ctx_has_comment($first_line, $linenr)) {
2674
CHK("memory barrier without comment\n" . $herecurr);
2677
# check of hardware specific defines
2678
if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
2679
CHK("architecture specific defines should be avoided\n" . $herecurr);
2682
# Check that the storage class is at the beginning of a declaration
2683
if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
2684
WARN("storage class should be at the beginning of the declaration\n" . $herecurr)
2687
# check the location of the inline attribute, that it is between
2688
# storage class and type.
2689
if ($line =~ /\b$Type\s+$Inline\b/ ||
2690
$line =~ /\b$Inline\s+$Storage\b/) {
2691
ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
2694
# Check for __inline__ and __inline, prefer inline
2695
if ($line =~ /\b(__inline__|__inline)\b/) {
2696
WARN("plain inline is preferred over $1\n" . $herecurr);
2699
# check for sizeof(&)
2700
if ($line =~ /\bsizeof\s*\(\s*\&/) {
2701
WARN("sizeof(& should be avoided\n" . $herecurr);
2704
# check for new externs in .c files.
2705
if ($realfile =~ /\.c$/ && defined $stat &&
2706
$stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
2708
my $function_name = $1;
2709
my $paren_space = $2;
2712
if (defined $cond) {
2713
substr($s, 0, length($cond), '');
2715
if ($s =~ /^\s*;/ &&
2716
$function_name ne 'uninitialized_var')
2718
WARN("externs should be avoided in .c files\n" . $herecurr);
2721
if ($paren_space =~ /\n/) {
2722
WARN("arguments for function declarations should follow identifier\n" . $herecurr);
2725
} elsif ($realfile =~ /\.c$/ && defined $stat &&
2726
$stat =~ /^.\s*extern\s+/)
2728
WARN("externs should be avoided in .c files\n" . $herecurr);
2731
# checks for new __setup's
2732
if ($rawline =~ /\b__setup\("([^"]*)"/) {
2735
if (!grep(/$name/, @setup_docs)) {
2736
CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
2740
# check for pointless casting of kmalloc return
2741
if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
2742
WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
2745
# check for gcc specific __FUNCTION__
2746
if ($line =~ /__FUNCTION__/) {
2747
WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
2750
# check for semaphores used as mutexes
2751
if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
2752
WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
2754
# check for semaphores used as mutexes
2755
if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
2756
WARN("consider using a completion\n" . $herecurr);
2759
# recommend strict_strto* over simple_strto*
2760
if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2761
WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
2763
# check for __initcall(), use device_initcall() explicitly please
2764
if ($line =~ /^.\s*__initcall\s*\(/) {
2765
WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
2767
# check for various ops structs, ensure they are const.
2768
my $struct_ops = qr{acpi_dock_ops|
2769
address_space_operations|
2771
block_device_operations|
2776
file_lock_operations|
2786
lock_manager_operations|
2792
pipe_buf_operations|
2793
platform_hibernation_ops|
2794
platform_suspend_ops|
2799
soc_pcmcia_socket_ops|
2805
if ($line !~ /\bconst\b/ &&
2806
$line =~ /\bstruct\s+($struct_ops)\b/) {
2807
WARN("struct $1 should normally be const\n" .
2811
# use of NR_CPUS is usually wrong
2812
# ignore definitions of NR_CPUS and usage to define arrays as likely right
2813
if ($line =~ /\bNR_CPUS\b/ &&
2814
$line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
2815
$line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
2816
$line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
2817
$line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
2818
$line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
2820
WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
2823
# check for %L{u,d,i} in strings
2825
while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2826
$string = substr($rawline, $-[1], $+[1] - $-[1]);
2827
$string =~ s/%%/__/g;
2828
if ($string =~ /(?<!%)%L[udi]/) {
2829
WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2834
# whine mightly about in_atomic
2835
if ($line =~ /\bin_atomic\s*\(/) {
2836
if ($realfile =~ m@^drivers/@) {
2837
ERROR("do not use in_atomic in drivers\n" . $herecurr);
2838
} elsif ($realfile !~ m@^kernel/@) {
2839
WARN("use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
2843
# check for lockdep_set_novalidate_class
2844
if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
2845
$line =~ /__lockdep_no_validate__\s*\)/ ) {
2846
if ($realfile !~ m@^kernel/lockdep@ &&
2847
$realfile !~ m@^include/linux/lockdep@ &&
2848
$realfile !~ m@^drivers/base/core@) {
2849
ERROR("lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
2854
# If we have no input at all, then there is nothing to report on
2855
# so just keep quiet.
2856
if ($#rawlines == -1) {
2860
# In mailback mode only produce a report in the negative, for
2861
# things that appear to be patches.
2862
if ($mailback && ($clean == 1 || !$is_patch)) {
2866
# This is not a patch, and we are are in 'no-patch' mode so
2868
if (!$chk_patch && !$is_patch) {
2873
ERROR("Does not appear to be a unified-diff format patch\n");
2875
if ($is_patch && $chk_signoff && $signoff == 0) {
2876
ERROR("Missing Signed-off-by: line(s)\n");
2879
print report_dump();
2880
if ($summary && !($clean == 1 && $quiet == 1)) {
2881
print "$filename " if ($summary_file);
2882
print "total: $cnt_error errors, $cnt_warn warnings, " .
2883
(($check)? "$cnt_chk checks, " : "") .
2884
"$cnt_lines lines checked\n";
2885
print "\n" if ($quiet == 0);
2889
# If there were whitespace errors which cleanpatch can fix
2890
# then suggest that.
2891
# if ($rpt_cleaners) {
2892
# print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
2893
# print " scripts/cleanfile\n\n";
2897
if ($clean == 1 && $quiet == 0) {
2898
print "$vname has no obvious style problems and is ready for submission.\n"
2900
if ($clean == 0 && $quiet == 0) {
2901
print "$vname has style problems, please review. If any of these errors\n";
2902
print "are false positives report them to the maintainer, see\n";
2903
print "CHECKPATCH in MAINTAINERS.\n";
added
removed
scripts/checkpatch.pl
