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,2009, 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}';";
113 if (!top_of_kernel_tree
($root)) {
114 die "$P: $root: --root does not point at a valid tree\n";
117 if (top_of_kernel_tree
('.')) {
119 } elsif ($0 =~ m@
(.*)/scripts/[^/]*$@
&&
120 top_of_kernel_tree
($1)) {
125 if (!defined $root) {
126 print "Must be run from the top-level dir. of a kernel tree\n";
131 my $emitted_corrupt = 0;
134 [A
-Za
-z_
][A
-Za
-z\d_
]*
135 (?
:\s
*\#\#\s
*[A
-Za
-z_
][A
-Za
-z\d_
]*)*
137 our $Storage = qr{extern|static|asmlinkage};
149 # Notes to $Attribute:
150 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
155 __
(?
:mem
|cpu
|dev
|)(?
:initdata
|initconst
|init
\b)|
156 ____cacheline_aligned
|
157 ____cacheline_aligned_in_smp
|
158 ____cacheline_internodealigned_in_smp
|
162 our $Inline = qr{inline|__always_inline|noinline};
163 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
164 our $Lval = qr{$Ident(?:$Member)*};
166 our $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
167 our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
168 our $Compare = qr{<=|>=|==|!=|<|>};
172 &&|\
|\
||,|\
^|\
+\
+|--|&|\
||\
+|-|\
*|\
/|%
180 [\x09\x0A\x0D\x20-\x7E] # ASCII
181 | [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
182 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
183 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
184 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
185 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
186 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
187 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
190 our $typeTypedefs = qr{(?x
:
191 (?
:__
)?
(?
:u
|s
|be
|le)(?
:8|16|32|64)|
195 our $logFunctions = qr{(?x
:
197 pr_
(debug
|dbg
|vdbg
|devel
|info
|warning
|err
|notice
|alert
|crit
|emerg
|cont
)|
198 dev_
(printk
|dbg
|vdbg
|info
|warn|err
|notice
|alert
|crit
|emerg
|WARN
)|
205 qr{(?:unsigned\s+)?char},
206 qr{(?:unsigned\s+)?short},
207 qr{(?:unsigned\s+)?int},
208 qr{(?:unsigned\s+)?long},
209 qr{(?:unsigned\s+)?long\s+int},
210 qr{(?:unsigned\s+)?long\s+long},
211 qr{(?:unsigned\s+)?long\s+long\s+int},
220 qr{${Ident}_handler
},
221 qr{${Ident}_handler_fn
},
223 our @modifierList = (
227 our $allowed_asm_includes = qr{(?x
:
231 # memory.h: ARM has a custom one
234 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
235 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
236 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
238 (?
:$Modifier\s
+|const\s
+)*
240 (?
:typeof
|__typeof__
)\s
*\
(\s
*\
**\s
*$Ident\s
*\
)|
244 (?
:\s
+$Modifier|\s
+const
)*
248 (?
:[\s\
*]+\s
*const
|[\s\
*]+|(?
:\s
*\
[\s
*\
])+)?
249 (?
:\s
+$Inline|\s
+$Modifier)*
251 $Declare = qr{(?:$Storage\s+)?$Type};
255 $chk_signoff = 0 if ($file);
257 my @dep_includes = ();
258 my @dep_functions = ();
259 my $removal = "Documentation/feature-removal-schedule.txt";
260 if ($tree && -f
"$root/$removal") {
261 open(my $REMOVE, '<', "$root/$removal") ||
262 die "$P: $removal: open failed - $!\n";
264 if (/^Check:\s+(.*\S)/) {
265 for my $entry (split(/[, ]+/, $1)) {
266 if ($entry =~ m
@include/(.*)@
) {
267 push(@dep_includes, $1);
269 } elsif ($entry !~ m@
/@
) {
270 push(@dep_functions, $entry);
281 for my $filename (@ARGV) {
284 open($FILE, '-|', "diff -u /dev/null $filename") ||
285 die "$P: $filename: diff failed - $!\n";
286 } elsif ($filename eq '-') {
287 open($FILE, '<&STDIN');
289 open($FILE, '<', "$filename") ||
290 die "$P: $filename: open failed - $!\n";
292 if ($filename eq '-') {
293 $vname = 'Your patch';
302 if (!process
($filename)) {
311 sub top_of_kernel_tree
{
315 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
316 "README", "Documentation", "arch", "include", "drivers",
317 "fs", "init", "ipc", "kernel", "lib", "scripts",
320 foreach my $check (@tree_check) {
321 if (! -e
$root . '/' . $check) {
333 for my $c (split(//, $str)) {
337 for (; ($n % 8) != 0; $n++) {
349 (my $res = shift) =~ tr/\t/ /c;
356 # Drop the diff line leader and expand tabs
358 $line = expand_tabs
($line);
360 # Pick the indent from the front of the line.
361 my ($white) = ($line =~ /^(\s*)/);
363 return (length($line), length($white));
366 my $sanitise_quote = '';
368 sub sanitise_line_reset
{
369 my ($in_comment) = @_;
372 $sanitise_quote = '*/';
374 $sanitise_quote = '';
387 # Always copy over the diff marker.
388 $res = substr($line, 0, 1);
390 for ($off = 1; $off < length($line); $off++) {
391 $c = substr($line, $off, 1);
393 # Comments we are wacking completly including the begin
394 # and end, all to $;.
395 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
396 $sanitise_quote = '*/';
398 substr($res, $off, 2, "$;$;");
402 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
403 $sanitise_quote = '';
404 substr($res, $off, 2, "$;$;");
408 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
409 $sanitise_quote = '//';
411 substr($res, $off, 2, $sanitise_quote);
416 # A \ in a string means ignore the next character.
417 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
419 substr($res, $off, 2, 'XX');
424 if ($c eq "'" || $c eq '"') {
425 if ($sanitise_quote eq '') {
426 $sanitise_quote = $c;
428 substr($res, $off, 1, $c);
430 } elsif ($sanitise_quote eq $c) {
431 $sanitise_quote = '';
435 #print "c<$c> SQ<$sanitise_quote>\n";
436 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
437 substr($res, $off, 1, $;);
438 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
439 substr($res, $off, 1, $;);
440 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
441 substr($res, $off, 1, 'X');
443 substr($res, $off, 1, $c);
447 if ($sanitise_quote eq '//') {
448 $sanitise_quote = '';
451 # The pathname on a #include may be surrounded by '<' and '>'.
452 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
453 my $clean = 'X' x
length($1);
454 $res =~ s@\
<.*\
>@
<$clean>@
;
456 # The whole of a #error is a string.
457 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
458 my $clean = 'X' x
length($1);
459 $res =~ s@
(\#\s
*(?
:error
|warning
)\s
+).*@
$1$clean@
;
465 sub ctx_statement_block
{
466 my ($linenr, $remain, $off) = @_;
467 my $line = $linenr - 1;
484 @stack = (['', 0]) if ($#stack == -1);
486 #warn "CSB: blk<$blk> remain<$remain>\n";
487 # If we are about to drop off the end, pull in more
490 for (; $remain > 0; $line++) {
491 last if (!defined $lines[$line]);
492 next if ($lines[$line] =~ /^-/);
495 $blk .= $lines[$line] . "\n";
500 # Bail if there is no further context.
501 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
507 $c = substr($blk, $off, 1);
508 $remainder = substr($blk, $off);
510 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
512 # Handle nested #if/#else.
513 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
514 push(@stack, [ $type, $level ]);
515 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
516 ($type, $level) = @
{$stack[$#stack - 1]};
517 } elsif ($remainder =~ /^#\s*endif\b/) {
518 ($type, $level) = @
{pop(@stack)};
521 # Statement ends at the ';' or a close '}' at the
523 if ($level == 0 && $c eq ';') {
527 # An else is really a conditional as long as its not else if
528 if ($level == 0 && $coff_set == 0 &&
529 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
530 $remainder =~ /^(else)(?:\s|{)/ &&
531 $remainder !~ /^else\s+if\b/) {
532 $coff = $off + length($1) - 1;
534 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
535 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
538 if (($type eq '' || $type eq '(') && $c eq '(') {
542 if ($type eq '(' && $c eq ')') {
544 $type = ($level != 0)?
'(' : '';
546 if ($level == 0 && $coff < $soff) {
549 #warn "CSB: mark coff<$coff>\n";
552 if (($type eq '' || $type eq '{') && $c eq '{') {
556 if ($type eq '{' && $c eq '}') {
558 $type = ($level != 0)?
'{' : '';
566 # We are truly at the end, so shuffle to the next line.
573 my $statement = substr($blk, $soff, $off - $soff + 1);
574 my $condition = substr($blk, $soff, $coff - $soff + 1);
576 #warn "STATEMENT<$statement>\n";
577 #warn "CONDITION<$condition>\n";
579 #print "coff<$coff> soff<$off> loff<$loff>\n";
581 return ($statement, $condition,
582 $line, $remain + 1, $off - $loff + 1, $level);
585 sub statement_lines
{
588 # Strip the diff line prefixes and rip blank lines at start and end.
589 $stmt =~ s/(^|\n)./$1/g;
593 my @stmt_lines = ($stmt =~ /\n/g);
595 return $#stmt_lines + 2;
598 sub statement_rawlines
{
601 my @stmt_lines = ($stmt =~ /\n/g);
603 return $#stmt_lines + 2;
606 sub statement_block_size
{
609 $stmt =~ s/(^|\n)./$1/g;
615 my @stmt_lines = ($stmt =~ /\n/g);
616 my @stmt_statements = ($stmt =~ /;/g);
618 my $stmt_lines = $#stmt_lines + 2;
619 my $stmt_statements = $#stmt_statements + 1;
621 if ($stmt_lines > $stmt_statements) {
624 return $stmt_statements;
628 sub ctx_statement_full
{
629 my ($linenr, $remain, $off) = @_;
630 my ($statement, $condition, $level);
634 # Grab the first conditional/block pair.
635 ($statement, $condition, $linenr, $remain, $off, $level) =
636 ctx_statement_block
($linenr, $remain, $off);
637 #print "F: c<$condition> s<$statement> remain<$remain>\n";
638 push(@chunks, [ $condition, $statement ]);
639 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
640 return ($level, $linenr, @chunks);
643 # Pull in the following conditional/block pairs and see if they
644 # could continue the statement.
646 ($statement, $condition, $linenr, $remain, $off, $level) =
647 ctx_statement_block
($linenr, $remain, $off);
648 #print "C: c<$condition> s<$statement> remain<$remain>\n";
649 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
651 push(@chunks, [ $condition, $statement ]);
654 return ($level, $linenr, @chunks);
658 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
660 my $start = $linenr - 1;
667 my @stack = ($level);
668 for ($line = $start; $remain > 0; $line++) {
669 next if ($rawlines[$line] =~ /^-/);
672 $blk .= $rawlines[$line];
674 # Handle nested #if/#else.
675 if ($rawlines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
676 push(@stack, $level);
677 } elsif ($rawlines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
678 $level = $stack[$#stack - 1];
679 } elsif ($rawlines[$line] =~ /^.\s*#\s*endif\b/) {
680 $level = pop(@stack);
683 foreach my $c (split(//, $rawlines[$line])) {
684 ##print "C<$c>L<$level><$open$close>O<$off>\n";
690 if ($c eq $close && $level > 0) {
692 last if ($level == 0);
693 } elsif ($c eq $open) {
698 if (!$outer || $level <= 1) {
699 push(@res, $rawlines[$line]);
702 last if ($level == 0);
705 return ($level, @res);
707 sub ctx_block_outer
{
708 my ($linenr, $remain) = @_;
710 my ($level, @r) = ctx_block_get
($linenr, $remain, 1, '{', '}', 0);
714 my ($linenr, $remain) = @_;
716 my ($level, @r) = ctx_block_get
($linenr, $remain, 0, '{', '}', 0);
720 my ($linenr, $remain, $off) = @_;
722 my ($level, @r) = ctx_block_get
($linenr, $remain, 0, '(', ')', $off);
725 sub ctx_block_level
{
726 my ($linenr, $remain) = @_;
728 return ctx_block_get
($linenr, $remain, 0, '{', '}', 0);
730 sub ctx_statement_level
{
731 my ($linenr, $remain, $off) = @_;
733 return ctx_block_get
($linenr, $remain, 0, '(', ')', $off);
736 sub ctx_locate_comment
{
737 my ($first_line, $end_line) = @_;
739 # Catch a comment on the end of the line itself.
740 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@
.*(/\*.*\*/)\s
*(?
:\\\s
*)?
$@
);
741 return $current_comment if (defined $current_comment);
743 # Look through the context and try and figure out if there is a
746 $current_comment = '';
747 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
748 my $line = $rawlines[$linenr - 1];
750 if ($linenr == $first_line and $line =~ m@
^.\s
*\
*@
) {
753 if ($line =~ m@
/\
*@
) {
756 if (!$in_comment && $current_comment ne '') {
757 $current_comment = '';
759 $current_comment .= $line . "\n" if ($in_comment);
760 if ($line =~ m@\
*/@
) {
765 chomp($current_comment);
766 return($current_comment);
768 sub ctx_has_comment
{
769 my ($first_line, $end_line) = @_;
770 my $cmt = ctx_locate_comment
($first_line, $end_line);
772 ##print "LINE: $rawlines[$end_line - 1 ]\n";
773 ##print "CMMT: $cmt\n";
779 my ($linenr, $cnt) = @_;
781 my $offset = $linenr - 1;
786 $line = $rawlines[$offset++];
787 next if (defined($line) && $line =~ /^-/);
799 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
802 $coded = sprintf("^%c", unpack('C', $2) + 64);
811 my $av_preprocessor = 0;
817 $av_preprocessor = 0;
819 @av_paren_type = ('E');
820 $av_pend_colon = 'O';
823 sub annotate_values
{
824 my ($stream, $type) = @_;
827 my $var = '_' x
length($stream);
830 print "$stream\n" if ($dbg_values > 1);
832 while (length($cur)) {
833 @av_paren_type = ('E') if ($#av_paren_type < 0);
834 print " <" . join('', @av_paren_type) .
835 "> <$type> <$av_pending>" if ($dbg_values > 1);
836 if ($cur =~ /^(\s+)/o) {
837 print "WS($1)\n" if ($dbg_values > 1);
838 if ($1 =~ /\n/ && $av_preprocessor) {
839 $type = pop(@av_paren_type);
840 $av_preprocessor = 0;
843 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\()/) {
844 print "DECLARE($1)\n" if ($dbg_values > 1);
847 } elsif ($cur =~ /^($Modifier)\s*/) {
848 print "MODIFIER($1)\n" if ($dbg_values > 1);
851 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
852 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
853 $av_preprocessor = 1;
854 push(@av_paren_type, $type);
860 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
861 print "UNDEF($1)\n" if ($dbg_values > 1);
862 $av_preprocessor = 1;
863 push(@av_paren_type, $type);
865 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
866 print "PRE_START($1)\n" if ($dbg_values > 1);
867 $av_preprocessor = 1;
869 push(@av_paren_type, $type);
870 push(@av_paren_type, $type);
873 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
874 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
875 $av_preprocessor = 1;
877 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
881 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
882 print "PRE_END($1)\n" if ($dbg_values > 1);
884 $av_preprocessor = 1;
886 # Assume all arms of the conditional end as this
887 # one does, and continue as if the #endif was not here.
889 push(@av_paren_type, $type);
892 } elsif ($cur =~ /^(\\\n)/o) {
893 print "PRECONT($1)\n" if ($dbg_values > 1);
895 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
896 print "ATTR($1)\n" if ($dbg_values > 1);
900 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
901 print "SIZEOF($1)\n" if ($dbg_values > 1);
907 } elsif ($cur =~ /^(if|while|for)\b/o) {
908 print "COND($1)\n" if ($dbg_values > 1);
912 } elsif ($cur =~/^(case)/o) {
913 print "CASE($1)\n" if ($dbg_values > 1);
914 $av_pend_colon = 'C';
917 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
918 print "KEYWORD($1)\n" if ($dbg_values > 1);
921 } elsif ($cur =~ /^(\()/o) {
922 print "PAREN('$1')\n" if ($dbg_values > 1);
923 push(@av_paren_type, $av_pending);
927 } elsif ($cur =~ /^(\))/o) {
928 my $new_type = pop(@av_paren_type);
929 if ($new_type ne '_') {
931 print "PAREN('$1') -> $type\n"
932 if ($dbg_values > 1);
934 print "PAREN('$1')\n" if ($dbg_values > 1);
937 } elsif ($cur =~ /^($Ident)\s*\(/o) {
938 print "FUNC($1)\n" if ($dbg_values > 1);
942 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
943 if (defined $2 && $type eq 'C' || $type eq 'T') {
944 $av_pend_colon = 'B';
945 } elsif ($type eq 'E') {
946 $av_pend_colon = 'L';
948 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
951 } elsif ($cur =~ /^($Ident|$Constant)/o) {
952 print "IDENT($1)\n" if ($dbg_values > 1);
955 } elsif ($cur =~ /^($Assignment)/o) {
956 print "ASSIGN($1)\n" if ($dbg_values > 1);
959 } elsif ($cur =~/^(;|{|})/) {
960 print "END($1)\n" if ($dbg_values > 1);
962 $av_pend_colon = 'O';
964 } elsif ($cur =~/^(,)/) {
965 print "COMMA($1)\n" if ($dbg_values > 1);
968 } elsif ($cur =~ /^(\?)/o) {
969 print "QUESTION($1)\n" if ($dbg_values > 1);
972 } elsif ($cur =~ /^(:)/o) {
973 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
975 substr($var, length($res), 1, $av_pend_colon);
976 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
981 $av_pend_colon = 'O';
983 } elsif ($cur =~ /^(\[)/o) {
984 print "CLOSE($1)\n" if ($dbg_values > 1);
987 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
990 print "OPV($1)\n" if ($dbg_values > 1);
997 substr($var, length($res), 1, $variant);
1000 } elsif ($cur =~ /^($Operators)/o) {
1001 print "OP($1)\n" if ($dbg_values > 1);
1002 if ($1 ne '++' && $1 ne '--') {
1006 } elsif ($cur =~ /(^.)/o) {
1007 print "C($1)\n" if ($dbg_values > 1);
1010 $cur = substr($cur, length($1));
1011 $res .= $type x
length($1);
1015 return ($res, $var);
1019 my ($possible, $line) = @_;
1020 my $notPermitted = qr{(?
:
1035 ^(?
:typedef
|struct
|enum
)\b
1037 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1038 if ($possible !~ $notPermitted) {
1039 # Check for modifiers.
1040 $possible =~ s/\s*$Storage\s*//g;
1041 $possible =~ s/\s*$Sparse\s*//g;
1042 if ($possible =~ /^\s*$/) {
1044 } elsif ($possible =~ /\s/) {
1045 $possible =~ s/\s*$Type\s*//g;
1046 for my $modifier (split(' ', $possible)) {
1047 if ($modifier !~ $notPermitted) {
1048 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1049 push(@modifierList, $modifier);
1054 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1055 push(@typeList, $possible);
1059 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1066 if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
1069 my $line = $prefix . $_[0];
1071 $line = (split('\n', $line))[0] . "\n" if ($terse);
1073 push(our @report, $line);
1081 if (report
("ERROR: $_[0]\n")) {
1087 if (report
("WARNING: $_[0]\n")) {
1093 if ($check && report
("CHECK: $_[0]\n")) {
1099 sub check_absolute_file
{
1100 my ($absolute, $herecurr) = @_;
1101 my $file = $absolute;
1103 ##print "absolute<$absolute>\n";
1105 # See if any suffix of this path is a path within the tree.
1106 while ($file =~ s@
^[^/]*/@@
) {
1107 if (-f
"$root/$file") {
1108 ##print "file<$file>\n";
1116 # It is, so see if the prefix is acceptable.
1117 my $prefix = $absolute;
1118 substr($prefix, -length($file)) = '';
1120 ##print "prefix<$prefix>\n";
1121 if ($prefix ne ".../") {
1122 WARN
("use relative pathname instead of absolute in changelog text\n" . $herecurr);
1127 my $filename = shift;
1133 my $stashrawline="";
1150 # Trace the real file/line as we go.
1156 my $comment_edge = 0;
1160 my $prev_values = 'E';
1163 my %suppress_ifbraces;
1164 my %suppress_whiletrailers;
1165 my %suppress_export;
1167 # Pre-scan the patch sanitizing the lines.
1168 # Pre-scan the patch looking for any __setup documentation.
1170 my @setup_docs = ();
1173 sanitise_line_reset
();
1175 foreach my $rawline (@rawlines) {
1179 if ($rawline=~/^\+\+\+\s+(\S+)/) {
1181 if ($1 =~ m
@Documentation/kernel
-parameters
.txt
$@
) {
1186 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1195 # Guestimate if this is a continuing comment. Run
1196 # the context looking for a comment "edge". If this
1197 # edge is a close comment then we must be in a comment
1201 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1202 next if (defined $rawlines[$ln - 1] &&
1203 $rawlines[$ln - 1] =~ /^-/);
1205 #print "RAW<$rawlines[$ln - 1]>\n";
1206 last if (!defined $rawlines[$ln - 1]);
1207 if ($rawlines[$ln - 1] =~ m@
(/\*|\*/)@
&&
1208 $rawlines[$ln - 1] !~ m@
"[^"]*(?
:/\*|\*/)[^"]*"@
) {
1213 if (defined $edge && $edge eq '*/') {
1217 # Guestimate if this is a continuing comment. If this
1218 # is the start of a diff block and this line starts
1219 # ' *' then it is very likely a comment.
1220 if (!defined $edge &&
1221 $rawlines[$linenr] =~ m@
^.\s
*(?
:\
*\
*+| \
*)(?
:\s
|$)@
)
1226 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1227 sanitise_line_reset
($in_comment);
1229 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1230 # Standardise the strings and chars within the input to
1231 # simplify matching -- only bother with positive lines.
1232 $line = sanitise_line
($rawline);
1234 push(@lines, $line);
1237 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1242 #print "==>$rawline\n";
1243 #print "-->$line\n";
1245 if ($setup_docs && $line =~ /^\+/) {
1246 push(@setup_docs, $line);
1254 foreach my $line (@lines) {
1257 my $rawline = $rawlines[$linenr - 1];
1259 #extract the line range in the file after the patch is applied
1260 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1262 $first_line = $linenr + 1;
1272 %suppress_ifbraces = ();
1273 %suppress_whiletrailers = ();
1274 %suppress_export = ();
1277 # track the line number as we move through the hunk, note that
1278 # new versions of GNU diff omit the leading space on completely
1279 # blank context lines so we need to count that too.
1280 } elsif ($line =~ /^( |\+|$)/) {
1282 $realcnt-- if ($realcnt != 0);
1284 # Measure the line length and indent.
1285 ($length, $indent) = line_stats
($rawline);
1287 # Track the previous line.
1288 ($prevline, $stashline) = ($stashline, $line);
1289 ($previndent, $stashindent) = ($stashindent, $indent);
1290 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1292 #warn "line<$line>\n";
1294 } elsif ($realcnt == 1) {
1298 my $hunk_line = ($realcnt != 0);
1300 #make up the handle for any error we report on this line
1301 $prefix = "$filename:$realline: " if ($emacs && $file);
1302 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1304 $here = "#$linenr: " if (!$file);
1305 $here = "#$realline: " if ($file);
1307 # extract the filename as it passes
1308 if ($line=~/^\+\+\+\s+(\S+)/) {
1310 $realfile =~ s@
^([^/]*)/@@
;
1313 if (!$file && $tree && $p1_prefix ne '' &&
1314 -e
"$root/$p1_prefix") {
1315 WARN
("patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1318 if ($realfile =~ m@
^include
/asm/@
) {
1319 ERROR
("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1324 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
1326 my $hereline = "$here\n$rawline\n";
1327 my $herecurr = "$here\n$rawline\n";
1328 my $hereprev = "$here\n$prevrawline\n$rawline\n";
1330 $cnt_lines++ if ($realcnt != 0);
1332 #check the patch for a signoff:
1333 if ($line =~ /^\s*signed-off-by:/i) {
1334 # This is a signoff, if ugly, so do not double report.
1336 if (!($line =~ /^\s*Signed-off-by:/)) {
1337 WARN
("Signed-off-by: is the preferred form\n" .
1340 if ($line =~ /^\s*signed-off-by:\S/i) {
1341 WARN
("space required after Signed-off-by:\n" .
1346 # Check for wrappage within a valid hunk of the file
1347 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1348 ERROR
("patch seems to be corrupt (line wrapped?)\n" .
1349 $herecurr) if (!$emitted_corrupt++);
1352 # Check for absolute kernel paths.
1354 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1357 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1358 check_absolute_file
($1, $herecurr)) {
1361 check_absolute_file
($file, $herecurr);
1366 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1367 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1368 $rawline !~ m/^$UTF8*$/) {
1369 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1371 my $blank = copy_spacing
($rawline);
1372 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1373 my $hereptr = "$hereline$ptr\n";
1375 ERROR
("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1378 # ignore non-hunk lines and lines being removed
1379 next if (!$hunk_line || $line =~ /^-/);
1381 #trailing whitespace
1382 if ($line =~ /^\+.*\015/) {
1383 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
1384 ERROR
("DOS line endings\n" . $herevet);
1386 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1387 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
1388 ERROR
("trailing whitespace\n" . $herevet);
1391 # check for Kconfig help text having a real description
1392 if ($realfile =~ /Kconfig/ &&
1393 $line =~ /\+?\s*(---)?help(---)?$/) {
1395 for (my $l = $linenr; defined($lines[$l]); $l++) {
1399 next if ($f =~ /^$/);
1400 last if ($f =~ /^\s*config\s/);
1403 WARN
("please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($length < 4);
1406 # check we are in a valid source file if not then ignore this hunk
1407 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1410 if ($line =~ /^\+/ && $prevrawline !~ /\/\
*\
*/ &&
1411 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1412 $line !~ /^\+\s*$logFunctions\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ &&
1415 WARN
("line over 80 characters\n" . $herecurr);
1418 # check for spaces before a quoted newline
1419 if ($rawline =~ /^.*\".*\s\\n/) {
1420 WARN
("unnecessary whitespace before a quoted newline\n" . $herecurr);
1423 # check for adding lines without a newline.
1424 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1425 WARN
("adding a line without newline at end of file\n" . $herecurr);
1428 # Blackfin: use hi/lo macros
1429 if ($realfile =~ m
@arch/blackfin/.*\
.S
$@
) {
1430 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
1431 my $herevet = "$here\n" . cat_vet
($line) . "\n";
1432 ERROR
("use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
1434 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
1435 my $herevet = "$here\n" . cat_vet
($line) . "\n";
1436 ERROR
("use the HI() macro, not (... >> 16)\n" . $herevet);
1440 # check we are in a valid source file C or perl if not then ignore this hunk
1441 next if ($realfile !~ /\.(h|c|pl)$/);
1443 # at the beginning of a line any tabs must come first and anything
1444 # more than 8 must use tabs.
1445 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1446 $rawline =~ /^\+\s* \s*/) {
1447 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
1448 ERROR
("code indent should use tabs where possible\n" . $herevet);
1451 # check for space before tabs.
1452 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
1453 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
1454 WARN
("please, no space before tabs\n" . $herevet);
1457 # check for spaces at the beginning of a line.
1458 if ($rawline =~ /^\+ / && $rawline !~ /\+ +\*/) {
1459 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
1460 WARN
("please, no space for starting a line, \
1461 excluding comments\n" . $herevet);
1464 # check we are in a valid C source file if not then ignore this hunk
1465 next if ($realfile !~ /\.(h|c)$/);
1467 # check for RCS/CVS revision markers
1468 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
1469 WARN
("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1472 # Blackfin: don't use __builtin_bfin_[cs]sync
1473 if ($line =~ /__builtin_bfin_csync/) {
1474 my $herevet = "$here\n" . cat_vet
($line) . "\n";
1475 ERROR
("use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
1477 if ($line =~ /__builtin_bfin_ssync/) {
1478 my $herevet = "$here\n" . cat_vet
($line) . "\n";
1479 ERROR
("use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
1482 # Check for potential 'bare' types
1483 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
1485 if ($realcnt && $line =~ /.\s*\S/) {
1486 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
1487 ctx_statement_block
($linenr, $realcnt, 0);
1488 $stat =~ s/\n./\n /g;
1489 $cond =~ s/\n./\n /g;
1491 # Find the real next line.
1492 $realline_next = $line_nr_next;
1493 if (defined $realline_next &&
1494 (!defined $lines[$realline_next - 1] ||
1495 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
1502 # Ignore goto labels.
1503 if ($s =~ /$Ident:\*$/s) {
1505 # Ignore functions being called
1506 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
1508 } elsif ($s =~ /^.\s*else\b/s) {
1510 # declarations always start with types
1511 } 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) {
1514 possible
($type, "A:" . $s);
1516 # definitions in global scope can only start with types
1517 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
1518 possible
($1, "B:" . $s);
1521 # any (foo ... *) is a pointer cast, and foo is a type
1522 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
1523 possible
($1, "C:" . $s);
1526 # Check for any sort of function declaration.
1527 # int foo(something bar, other baz);
1528 # void (*store_gdt)(x86_descr_ptr *);
1529 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
1530 my ($name_len) = length($1);
1533 substr($ctx, 0, $name_len + 1, '');
1534 $ctx =~ s/\)[^\)]*$//;
1536 for my $arg (split(/\s*,\s*/, $ctx)) {
1537 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
1539 possible
($1, "D:" . $s);
1547 # Checks which may be anchored in the context.
1550 # Check for switch () and associated case and default
1551 # statements should be at the same indent.
1552 if ($line=~/\bswitch\s*\(.*\)/) {
1555 my @ctx = ctx_block_outer
($linenr, $realcnt);
1557 for my $ctx (@ctx) {
1558 my ($clen, $cindent) = line_stats
($ctx);
1559 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1560 $indent != $cindent) {
1561 $err .= "$sep$ctx\n";
1568 ERROR
("switch and case should be at the same indent\n$hereline$err");
1572 # if/while/etc brace do not go on next line, unless defining a do while loop,
1573 # or if that brace on the next line is for something else
1574 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
1575 my $pre_ctx = "$1$2";
1577 my ($level, @ctx) = ctx_statement_level
($linenr, $realcnt, 0);
1578 my $ctx_cnt = $realcnt - $#ctx - 1;
1579 my $ctx = join("\n", @ctx);
1581 my $ctx_ln = $linenr;
1582 my $ctx_skip = $realcnt;
1584 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1585 defined $lines[$ctx_ln - 1] &&
1586 $lines[$ctx_ln - 1] =~ /^-/)) {
1587 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1588 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
1592 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1593 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
1595 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1596 ERROR
("that open brace { should be on the previous line\n" .
1597 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1599 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1600 $ctx =~ /\)\s*\;\s*$/ &&
1601 defined $lines[$ctx_ln - 1])
1603 my ($nlength, $nindent) = line_stats
($lines[$ctx_ln - 1]);
1604 if ($nindent > $indent) {
1605 WARN
("trailing semicolon indicates no statements, indent implies otherwise\n" .
1606 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1611 # Check relative indent for conditionals and blocks.
1612 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1613 my ($s, $c) = ($stat, $cond);
1615 substr($s, 0, length($c), '');
1617 # Make sure we remove the line prefixes as we have
1618 # none on the first line, and are going to readd them
1622 # Find out how long the conditional actually is.
1623 my @newlines = ($c =~ /\n/gs);
1624 my $cond_lines = 1 + $#newlines;
1626 # We want to check the first line inside the block
1627 # starting at the end of the conditional, so remove:
1628 # 1) any blank line termination
1629 # 2) any opening brace { on end of the line
1631 my $continuation = 0;
1633 $s =~ s/^.*\bdo\b//;
1635 if ($s =~ s/^\s*\\//) {
1638 if ($s =~ s/^\s*?\n//) {
1643 # Also ignore a loop construct at the end of a
1644 # preprocessor statement.
1645 if (($prevline =~ /^.\s*#\s*define\s/ ||
1646 $prevline =~ /\\\s*$/) && $continuation == 0) {
1652 while ($cond_ptr != $cond_lines) {
1653 $cond_ptr = $cond_lines;
1655 # If we see an #else/#elif then the code
1657 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
1662 # 1) blank lines, they should be at 0,
1663 # 2) preprocessor lines, and
1665 if ($continuation ||
1667 $s =~ /^\s*#\s*?/ ||
1668 $s =~ /^\s*$Ident\s*:/) {
1669 $continuation = ($s =~ /^.*?\\\n/) ?
1 : 0;
1670 if ($s =~ s/^.*?\n//) {
1676 my (undef, $sindent) = line_stats
("+" . $s);
1677 my $stat_real = raw_line
($linenr, $cond_lines);
1679 # Check if either of these lines are modified, else
1680 # this is not this patch's fault.
1681 if (!defined($stat_real) ||
1682 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
1685 if (defined($stat_real) && $cond_lines > 1) {
1686 $stat_real = "[...]\n$stat_real";
1689 #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";
1691 if ($check && (($sindent % 8) != 0 ||
1692 ($sindent <= $indent && $s ne ''))) {
1693 WARN
("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
1697 # Track the 'values' across context and added lines.
1698 my $opline = $line; $opline =~ s/^./ /;
1699 my ($curr_values, $curr_vars) =
1700 annotate_values
($opline . "\n", $prev_values);
1701 $curr_values = $prev_values . $curr_values;
1703 my $outline = $opline; $outline =~ s/\t/ /g;
1704 print "$linenr > .$outline\n";
1705 print "$linenr > $curr_values\n";
1706 print "$linenr > $curr_vars\n";
1708 $prev_values = substr($curr_values, -1);
1710 #ignore lines not being added
1711 if ($line=~/^[^\+]/) {next;}
1713 # TEST: allow direct testing of the type matcher.
1715 if ($line =~ /^.\s*$Declare\s*$/) {
1716 ERROR
("TEST: is type\n" . $herecurr);
1717 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
1718 ERROR
("TEST: is not type ($1 is)\n". $herecurr);
1722 # TEST: allow direct testing of the attribute matcher.
1724 if ($line =~ /^.\s*$Modifier\s*$/) {
1725 ERROR
("TEST: is attr\n" . $herecurr);
1726 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
1727 ERROR
("TEST: is not attr ($1 is)\n". $herecurr);
1732 # check for initialisation to aggregates open brace on the next line
1733 if ($line =~ /^.\s*{/ &&
1734 $prevline =~ /(?:^|[^=])=\s*$/) {
1735 ERROR
("that open brace { should be on the previous line\n" . $hereprev);
1739 # Checks which are anchored on the added line.
1742 # check for malformed paths in #include statements (uses RAW line)
1743 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
1745 if ($path =~ m{//}) {
1746 ERROR
("malformed #include filename\n" .
1751 # no C99 // comments
1752 if ($line =~ m{//}) {
1753 ERROR
("do not use C99 // comments\n" . $herecurr);
1755 # Remove C99 comments.
1757 $opline =~ s@
//.*@@
;
1759 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
1760 # the whole statement.
1761 #print "APW <$lines[$realline_next - 1]>\n";
1762 if (defined $realline_next &&
1763 exists $lines[$realline_next - 1] &&
1764 !defined $suppress_export{$realline_next} &&
1765 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
1766 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1770 ^.DEFINE_
$Ident\
(\Q
$name\E\
)|
1771 ^.DECLARE_
$Ident\
(\Q
$name\E\
)|
1772 ^.LIST_HEAD\
(\Q
$name\E\
)|
1773 ^.(?
:$Storage\s
+)?
$Type\s
*\
(\s
*\
*\s
*\Q
$name\E\s
*\
)\s
*\
(|
1774 \b\Q
$name\E
(?
:\s
+$Attribute)*\s
*(?
:;|=|\
[|\
()
1776 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
1777 $suppress_export{$realline_next} = 2;
1779 $suppress_export{$realline_next} = 1;
1782 if (!defined $suppress_export{$linenr} &&
1783 $prevline =~ /^.\s*$/ &&
1784 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
1785 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1786 #print "FOO B <$lines[$linenr - 1]>\n";
1787 $suppress_export{$linenr} = 2;
1789 if (defined $suppress_export{$linenr} &&
1790 $suppress_export{$linenr} == 2) {
1791 WARN
("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
1794 # check for external initialisers.
1795 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
1796 ERROR
("do not initialise externals to 0 or NULL\n" .
1799 # check for static initialisers.
1800 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
1801 ERROR
("do not initialise statics to 0 or NULL\n" .
1805 # check for new typedefs, only function parameters and sparse annotations
1807 if ($line =~ /\btypedef\s/ &&
1808 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
1809 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
1810 $line !~ /\b$typeTypedefs\b/ &&
1811 $line !~ /\b__bitwise(?:__|)\b/) {
1812 WARN
("do not add new typedefs\n" . $herecurr);
1815 # * goes on variable not on type
1817 if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) {
1818 my ($from, $to) = ($1, $1);
1820 # Should start with a space.
1821 $to =~ s/^(\S)/ $1/;
1822 # Should not end with a space.
1824 # '*'s should not have spaces between.
1825 while ($to =~ s/\*\s+\*/\*\*/) {
1828 #print "from<$from> to<$to>\n";
1830 ERROR
("\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr);
1832 } elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) {
1833 my ($from, $to, $ident) = ($1, $1, $2);
1835 # Should start with a space.
1836 $to =~ s/^(\S)/ $1/;
1837 # Should not end with a space.
1839 # '*'s should not have spaces between.
1840 while ($to =~ s/\*\s+\*/\*\*/) {
1842 # Modifiers should have spaces.
1843 $to =~ s/(\b$Modifier$)/$1 /;
1845 #print "from<$from> to<$to> ident<$ident>\n";
1846 if ($from ne $to && $ident !~ /^$Modifier$/) {
1847 ERROR
("\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr);
1851 # # no BUG() or BUG_ON()
1852 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
1853 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
1854 # print "$herecurr";
1858 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
1859 WARN
("LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
1862 # printk should use KERN_* levels. Note that follow on printk's on the
1863 # same line do not need a level, so we use the current block context
1864 # to try and find and validate the current printk. In summary the current
1865 # printk includes all preceeding printk's which have no newline on the end.
1866 # we assume the first bad printk is the one to report.
1867 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
1869 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
1870 #print "CHECK<$lines[$ln - 1]\n";
1871 # we have a preceeding printk if it ends
1872 # with "\n" ignore it, else it is to blame
1873 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
1874 if ($rawlines[$ln - 1] !~ m{\\n"}) {
1881 WARN
("printk() should include KERN_ facility level\n" . $herecurr);
1885 # function brace can't be on same line, except for #defines of do while,
1886 # or if closed on same line
1887 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
1888 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
1889 ERROR
("open brace '{' following function declarations go on the next line\n" . $herecurr);
1892 # open braces for enum, union and struct go on the same line.
1893 if ($line =~ /^.\s*{/ &&
1894 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1895 ERROR
("open brace '{' following $1 go on the same line\n" . $hereprev);
1898 # check for spacing round square brackets; allowed:
1899 # 1. with a type on the left -- int [] a;
1900 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
1901 # 3. inside a curly brace -- = { [0...10] = 5 }
1902 while ($line =~ /(.*?\s)\[/g) {
1903 my ($where, $prefix) = ($-[1], $1);
1904 if ($prefix !~ /$Type\s+$/ &&
1905 ($where != 0 || $prefix !~ /^.\s+$/) &&
1906 $prefix !~ /{\s+$/) {
1907 ERROR
("space prohibited before open square bracket '['\n" . $herecurr);
1911 # check for spaces between functions and their parentheses.
1912 while ($line =~ /($Ident)\s+\(/g) {
1914 my $ctx_before = substr($line, 0, $-[1]);
1915 my $ctx = "$ctx_before$name";
1917 # Ignore those directives where spaces _are_ permitted.
1919 if|for|while|switch
|return|case
|
1920 volatile
|__volatile__
|
1921 __attribute__
|format
|__extension__
|
1925 # cpp #define statements have non-optional spaces, ie
1926 # if there is a space between the name and the open
1927 # parenthesis it is simply not a parameter group.
1928 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
1930 # cpp #elif statement condition may start with a (
1931 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
1933 # If this whole things ends with a type its most
1934 # likely a typedef for a function.
1935 } elsif ($ctx =~ /$Type$/) {
1938 WARN
("space prohibited between function name and open parenthesis '('\n" . $herecurr);
1941 # Check operator spacing.
1942 if (!($line=~/\#\s*include/)) {
1944 <<=|>>=|<=|>=|==|!=|
1945 \
+=|-=|\
*=|\
/=|%=|\
^=|\
|=|&=|
1946 =>|->|<<|>>|<|>|=|!|~|
1947 &&|\
|\
||,|\
^|\
+\
+|--|&|\
||\
+|-|\
*|\
/|%|
1950 my @elements = split(/($ops|;)/, $opline);
1953 my $blank = copy_spacing
($opline);
1955 for (my $n = 0; $n < $#elements; $n += 2) {
1956 $off += length($elements[$n]);
1958 # Pick up the preceeding and succeeding characters.
1959 my $ca = substr($opline, 0, $off);
1961 if (length($opline) >= ($off + length($elements[$n + 1]))) {
1962 $cc = substr($opline, $off + length($elements[$n + 1]));
1964 my $cb = "$ca$;$cc";
1967 $a = 'V' if ($elements[$n] ne '');
1968 $a = 'W' if ($elements[$n] =~ /\s$/);
1969 $a = 'C' if ($elements[$n] =~ /$;$/);
1970 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
1971 $a = 'O' if ($elements[$n] eq '');
1972 $a = 'E' if ($ca =~ /^\s*$/);
1974 my $op = $elements[$n + 1];
1977 if (defined $elements[$n + 2]) {
1978 $c = 'V' if ($elements[$n + 2] ne '');
1979 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
1980 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
1981 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
1982 $c = 'O' if ($elements[$n + 2] eq '');
1983 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
1988 my $ctx = "${a}x${c}";
1990 my $at = "(ctx:$ctx)";
1992 my $ptr = substr($blank, 0, $off) . "^";
1993 my $hereptr = "$hereline$ptr\n";
1995 # Pull out the value of this operator.
1996 my $op_type = substr($curr_values, $off + 1, 1);
1998 # Get the full operator variant.
1999 my $opv = $op . substr($curr_vars, $off, 1);
2001 # Ignore operators passed as parameters.
2002 if ($op_type ne 'V' &&
2003 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
2006 # } elsif ($op =~ /^$;+$/) {
2008 # ; should have either the end of line or a space or \ after it
2009 } elsif ($op eq ';') {
2010 if ($ctx !~ /.x[WEBC]/ &&
2011 $cc !~ /^\\/ && $cc !~ /^;/) {
2012 ERROR
("space required after that '$op' $at\n" . $hereptr);
2016 } elsif ($op eq '//') {
2020 # : when part of a bitfield
2021 } elsif ($op eq '->' || $opv eq ':B') {
2022 if ($ctx =~ /Wx.|.xW/) {
2023 ERROR
("spaces prohibited around that '$op' $at\n" . $hereptr);
2026 # , must have a space on the right.
2027 } elsif ($op eq ',') {
2028 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
2029 ERROR
("space required after that '$op' $at\n" . $hereptr);
2032 # '*' as part of a type definition -- reported already.
2033 } elsif ($opv eq '*_') {
2034 #warn "'*' is part of type\n";
2036 # unary operators should have a space before and
2037 # none after. May be left adjacent to another
2038 # unary operator, or a cast
2039 } elsif ($op eq '!' || $op eq '~' ||
2040 $opv eq '*U' || $opv eq '-U' ||
2041 $opv eq '&U' || $opv eq '&&U') {
2042 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
2043 ERROR
("space required before that '$op' $at\n" . $hereptr);
2045 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
2046 # A unary '*' may be const
2048 } elsif ($ctx =~ /.xW/) {
2049 ERROR
("space prohibited after that '$op' $at\n" . $hereptr);
2052 # unary ++ and unary -- are allowed no space on one side.
2053 } elsif ($op eq '++' or $op eq '--') {
2054 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
2055 ERROR
("space required one side of that '$op' $at\n" . $hereptr);
2057 if ($ctx =~ /Wx[BE]/ ||
2058 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
2059 ERROR
("space prohibited before that '$op' $at\n" . $hereptr);
2061 if ($ctx =~ /ExW/) {
2062 ERROR
("space prohibited after that '$op' $at\n" . $hereptr);
2066 # << and >> may either have or not have spaces both sides
2067 } elsif ($op eq '<<' or $op eq '>>' or
2068 $op eq '&' or $op eq '^' or $op eq '|' or
2069 $op eq '+' or $op eq '-' or
2070 $op eq '*' or $op eq '/' or
2073 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
2074 ERROR
("need consistent spacing around '$op' $at\n" .
2078 # A colon needs no spaces before when it is
2079 # terminating a case value or a label.
2080 } elsif ($opv eq ':C' || $opv eq ':L') {
2081 if ($ctx =~ /Wx./) {
2082 ERROR
("space prohibited before that '$op' $at\n" . $hereptr);
2085 # All the others need spaces both sides.
2086 } elsif ($ctx !~ /[EWC]x[CWE]/) {
2089 # Ignore email addresses <foo@bar>
2091 $cc =~ /^\S+\@\S+>/) ||
2093 $ca =~ /<\S+\@\S+$/))
2099 if (($opv eq ':O' && $ca =~ /\?$/) ||
2100 ($op eq '?' && $cc =~ /^:/)) {
2105 ERROR
("spaces required around that '$op' $at\n" . $hereptr);
2108 $off += length($elements[$n + 1]);
2112 # check for multiple assignments
2113 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
2114 CHK
("multiple assignments should be avoided\n" . $herecurr);
2117 ## # check for multiple declarations, allowing for a function declaration
2119 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
2120 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
2122 ## # Remove any bracketed sections to ensure we do not
2123 ## # falsly report the parameters of functions.
2125 ## while ($ln =~ s/\([^\(\)]*\)//g) {
2127 ## if ($ln =~ /,/) {
2128 ## WARN("declaring multiple variables together should be avoided\n" . $herecurr);
2132 #need space before brace following if, while, etc
2133 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
2135 ERROR
("space required before the open brace '{'\n" . $herecurr);
2138 # closing brace should have a space following it when it has anything
2140 if ($line =~ /}(?!(?:,|;|\)))\S/) {
2141 ERROR
("space required after that close brace '}'\n" . $herecurr);
2144 # check spacing on square brackets
2145 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
2146 ERROR
("space prohibited after that open square bracket '['\n" . $herecurr);
2148 if ($line =~ /\s\]/) {
2149 ERROR
("space prohibited before that close square bracket ']'\n" . $herecurr);
2152 # check spacing on parentheses
2153 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
2154 $line !~ /for\s*\(\s+;/) {
2155 ERROR
("space prohibited after that open parenthesis '('\n" . $herecurr);
2157 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
2158 $line !~ /for\s*\(.*;\s+\)/ &&
2159 $line !~ /:\s+\)/) {
2160 ERROR
("space prohibited before that close parenthesis ')'\n" . $herecurr);
2163 #goto labels aren't indented, allow a single space however
2164 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
2165 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
2166 WARN
("labels should not be indented\n" . $herecurr);
2169 # Return is not a function.
2170 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2174 # Flatten any parentheses
2175 $value =~ s/\)\(/\) \(/g;
2176 while ($value =~ s/\[[^\{\}]*\]/1/ ||
2177 $value !~ /(?
:$Ident|-?
$Constant)\s
*
2179 (?
:$Ident|-?
$Constant)/x
&&
2180 $value =~ s/\([^\(\)]*\)/1/) {
2183 if ($value =~ /^(?:$Ident|-?$Constant)$/) {
2184 ERROR
("return is not a function, parentheses are not required\n" . $herecurr);
2186 } elsif ($spacing !~ /\s+/) {
2187 ERROR
("space required before the open parenthesis '('\n" . $herecurr);
2191 # Need a space before open parenthesis after if, while etc
2192 if ($line=~/\b(if|while|for|switch)\(/) {
2193 ERROR
("space required before the open parenthesis '('\n" . $herecurr);
2196 # Check for illegal assignment in if conditional -- and check for trailing
2197 # statements after the conditional.
2198 if ($line =~ /do\s*(?!{)/) {
2199 my ($stat_next) = ctx_statement_block
($line_nr_next,
2200 $remain_next, $off_next);
2201 $stat_next =~ s/\n./\n /g;
2202 ##print "stat<$stat> stat_next<$stat_next>\n";
2204 if ($stat_next =~ /^\s*while\b/) {
2205 # If the statement carries leading newlines,
2206 # then count those as offsets.
2208 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2210 statement_rawlines
($whitespace) - 1;
2212 $suppress_whiletrailers{$line_nr_next +
2216 if (!defined $suppress_whiletrailers{$linenr} &&
2217 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
2218 my ($s, $c) = ($stat, $cond);
2220 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
2221 ERROR
("do not use assignment in if condition\n" . $herecurr);
2224 # Find out what is on the end of the line after the
2226 substr($s, 0, length($c), '');
2228 $s =~ s/$;//g; # Remove any comments
2229 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2230 $c !~ /}\s*while\s*/)
2232 # Find out how long the conditional actually is.
2233 my @newlines = ($c =~ /\n/gs);
2234 my $cond_lines = 1 + $#newlines;
2237 $stat_real = raw_line
($linenr, $cond_lines)
2238 . "\n" if ($cond_lines);
2239 if (defined($stat_real) && $cond_lines > 1) {
2240 $stat_real = "[...]\n$stat_real";
2243 ERROR
("trailing statements should be on next line\n" . $herecurr . $stat_real);
2247 # Check for bitwise tests written as boolean
2259 WARN
("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2262 # if and else should not have general statements after it
2263 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2265 $s =~ s/$;//g; # Remove any comments
2266 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2267 ERROR
("trailing statements should be on next line\n" . $herecurr);
2270 # if should not continue a brace
2271 if ($line =~ /}\s*if\b/) {
2272 ERROR
("trailing statements should be on next line\n" .
2275 # case and default should not have general statements after them
2276 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2278 (?
:\s
*$;*)(?
:\s
*{)?
(?
:\s
*$;*)(?
:\s
*\\)?\s
*$|
2282 ERROR
("trailing statements should be on next line\n" . $herecurr);
2285 # Check for }<nl>else {, these must be at the same
2286 # indent level to be relevant to each other.
2287 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2288 $previndent == $indent) {
2289 ERROR
("else should follow close brace '}'\n" . $hereprev);
2292 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2293 $previndent == $indent) {
2294 my ($s, $c) = ctx_statement_block
($linenr, $realcnt, 0);
2296 # Find out what is on the end of the line after the
2298 substr($s, 0, length($c), '');
2301 if ($s =~ /^\s*;/) {
2302 ERROR
("while should follow close brace '}'\n" . $hereprev);
2306 #studly caps, commented out until figure out how to distinguish between use of existing and adding new
2307 # if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2308 # print "No studly caps, use _\n";
2309 # print "$herecurr";
2313 #no spaces allowed after \ in define
2314 if ($line=~/\#\s*define.*\\\s$/) {
2315 WARN
("Whitepspace after \\ makes next lines useless\n" . $herecurr);
2318 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
2319 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
2321 my $checkfile = "include/linux/$file";
2322 if (-f
"$root/$checkfile" &&
2323 $realfile ne $checkfile &&
2324 $1 !~ /$allowed_asm_includes/)
2326 if ($realfile =~ m{^arch/}) {
2327 CHK
("Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2329 WARN
("Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2334 # multi-statement macros should be enclosed in a do while loop, grab the
2335 # first statement and ensure its the whole macro if its not enclosed
2336 # in a known good container
2337 if ($realfile !~ m@
/vmlinux
.lds
.h
$@
&&
2338 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
2341 my ($off, $dstat, $dcond, $rest);
2344 my $args = defined($1);
2346 # Find the end of the macro and limit our statement
2348 while ($cnt > 0 && defined $lines[$ln - 1] &&
2349 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
2351 $ctx .= $rawlines[$ln - 1] . "\n";
2352 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2355 $ctx .= $rawlines[$ln - 1];
2357 ($dstat, $dcond, $ln, $cnt, $off) =
2358 ctx_statement_block
($linenr, $ln - $linenr + 1, 0);
2359 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
2360 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
2362 # Extract the remainder of the define (if any) and
2363 # rip off surrounding spaces, and trailing \'s.
2365 while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
2366 #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
2367 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
2368 $rest .= substr($lines[$ln - 1], $off) . "\n";
2374 $rest =~ s/\\\n.//g;
2378 # Clean up the original statement.
2380 substr($dstat, 0, length($dcond), '');
2382 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
2385 $dstat =~ s/\\\n.//g;
2386 $dstat =~ s/^\s*//s;
2387 $dstat =~ s/\s*$//s;
2389 # Flatten any parentheses and braces
2390 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2391 $dstat =~ s/\{[^\{\}]*\}/1/ ||
2392 $dstat =~ s/\[[^\{\}]*\]/1/)
2396 my $exceptions = qr{
2408 #print "REST<$rest> dstat<$dstat>\n";
2410 if ($rest !~ /while\s*\(/ &&
2411 $dstat !~ /$exceptions/)
2413 ERROR
("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
2416 } elsif ($ctx !~ /;/) {
2418 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2419 $dstat !~ /$exceptions/ &&
2420 $dstat !~ /^\.$Ident\s*=/ &&
2421 $dstat =~ /$Operators/)
2423 ERROR
("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
2428 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
2429 # all assignments may have only one of the following with an assignment:
2432 # VMLINUX_SYMBOL(...)
2433 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
2434 WARN
("vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
2437 # check for redundant bracing round if etc
2438 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2439 my ($level, $endln, @chunks) =
2440 ctx_statement_full
($linenr, $realcnt, 1);
2441 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
2442 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2443 if ($#chunks > 0 && $level == 0) {
2446 my $herectx = $here . "\n";
2447 my $ln = $linenr - 1;
2448 for my $chunk (@chunks) {
2449 my ($cond, $block) = @
{$chunk};
2451 # If the condition carries leading newlines, then count those as offsets.
2452 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2453 my $offset = statement_rawlines
($whitespace) - 1;
2455 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2457 # We have looked at and allowed this specific line.
2458 $suppress_ifbraces{$ln + $offset} = 1;
2460 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
2461 $ln += statement_rawlines
($block) - 1;
2463 substr($block, 0, length($cond), '');
2465 $seen++ if ($block =~ /^\s*{/);
2467 #print "cond<$cond> block<$block> allowed<$allowed>\n";
2468 if (statement_lines
($cond) > 1) {
2469 #print "APW: ALLOWED: cond<$cond>\n";
2472 if ($block =~/\b(?:if|for|while)\b/) {
2473 #print "APW: ALLOWED: block<$block>\n";
2476 if (statement_block_size
($block) > 1) {
2477 #print "APW: ALLOWED: lines block<$block>\n";
2481 if ($seen && !$allowed) {
2482 WARN
("braces {} are not necessary for any arm of this statement\n" . $herectx);
2486 if (!defined $suppress_ifbraces{$linenr - 1} &&
2487 $line =~ /\b(if|while|for|else)\b/) {
2490 # Check the pre-context.
2491 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2492 #print "APW: ALLOWED: pre<$1>\n";
2496 my ($level, $endln, @chunks) =
2497 ctx_statement_full
($linenr, $realcnt, $-[0]);
2499 # Check the condition.
2500 my ($cond, $block) = @
{$chunks[0]};
2501 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
2502 if (defined $cond) {
2503 substr($block, 0, length($cond), '');
2505 if (statement_lines
($cond) > 1) {
2506 #print "APW: ALLOWED: cond<$cond>\n";
2509 if ($block =~/\b(?:if|for|while)\b/) {
2510 #print "APW: ALLOWED: block<$block>\n";
2513 if (statement_block_size
($block) > 1) {
2514 #print "APW: ALLOWED: lines block<$block>\n";
2517 # Check the post-context.
2518 if (defined $chunks[1]) {
2519 my ($cond, $block) = @
{$chunks[1]};
2520 if (defined $cond) {
2521 substr($block, 0, length($cond), '');
2523 if ($block =~ /^\s*\{/) {
2524 #print "APW: ALLOWED: chunk-1 block<$block>\n";
2528 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
2529 my $herectx = $here . "\n";;
2530 my $cnt = statement_rawlines
($block);
2532 for (my $n = 0; $n < $cnt; $n++) {
2533 $herectx .= raw_line
($linenr, $n) . "\n";;
2536 WARN
("braces {} are not necessary for single statement blocks\n" . $herectx);
2540 # don't include deprecated include files (uses RAW line)
2541 for my $inc (@dep_includes) {
2542 if ($rawline =~ m@
^.\s
*\#\s
*include\s
*\
<$inc>@
) {
2543 ERROR
("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2547 # don't use deprecated functions
2548 for my $func (@dep_functions) {
2549 if ($line =~ /\b$func\b/) {
2550 ERROR
("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2554 # no volatiles please
2555 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2556 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
2557 WARN
("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
2560 # SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
2561 if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
2562 ERROR
("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
2566 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
2567 CHK
("if this code is redundant consider removing it\n" .
2571 # check for needless kfree() checks
2572 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2574 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
2575 WARN
("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
2578 # check for needless usb_free_urb() checks
2579 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2581 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
2582 WARN
("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
2586 # warn about #ifdefs in C files
2587 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
2588 # print "#ifdef in C files should be avoided\n";
2589 # print "$herecurr";
2593 # warn about spacing in #ifdefs
2594 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
2595 ERROR
("exactly one space required after that #$1\n" . $herecurr);
2598 # check for spinlock_t definitions without a comment.
2599 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
2600 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
2602 if (!ctx_has_comment
($first_line, $linenr)) {
2603 CHK
("$1 definition without comment\n" . $herecurr);
2606 # check for memory barriers without a comment.
2607 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2608 if (!ctx_has_comment
($first_line, $linenr)) {
2609 CHK
("memory barrier without comment\n" . $herecurr);
2612 # check of hardware specific defines
2613 if ($line =~ m@
^.\s
*\#\s
*if.*\b(__i386__
|__powerpc64__
|__sun__
|__s390x__
)\b@
&& $realfile !~ m
@include/asm
-@
) {
2614 CHK
("architecture specific defines should be avoided\n" . $herecurr);
2617 # Check that the storage class is at the beginning of a declaration
2618 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
2619 WARN
("storage class should be at the beginning of the declaration\n" . $herecurr)
2622 # check the location of the inline attribute, that it is between
2623 # storage class and type.
2624 if ($line =~ /\b$Type\s+$Inline\b/ ||
2625 $line =~ /\b$Inline\s+$Storage\b/) {
2626 ERROR
("inline keyword should sit between storage class and type\n" . $herecurr);
2629 # Check for __inline__ and __inline, prefer inline
2630 if ($line =~ /\b(__inline__|__inline)\b/) {
2631 WARN
("plain inline is preferred over $1\n" . $herecurr);
2634 # check for sizeof(&)
2635 if ($line =~ /\bsizeof\s*\(\s*\&/) {
2636 WARN
("sizeof(& should be avoided\n" . $herecurr);
2639 # check for new externs in .c files.
2640 if ($realfile =~ /\.c$/ && defined $stat &&
2641 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
2643 my $function_name = $1;
2644 my $paren_space = $2;
2647 if (defined $cond) {
2648 substr($s, 0, length($cond), '');
2650 if ($s =~ /^\s*;/ &&
2651 $function_name ne 'uninitialized_var')
2653 WARN
("externs should be avoided in .c files\n" . $herecurr);
2656 if ($paren_space =~ /\n/) {
2657 WARN
("arguments for function declarations should follow identifier\n" . $herecurr);
2660 } elsif ($realfile =~ /\.c$/ && defined $stat &&
2661 $stat =~ /^.\s*extern\s+/)
2663 WARN
("externs should be avoided in .c files\n" . $herecurr);
2666 # checks for new __setup's
2667 if ($rawline =~ /\b__setup\("([^"]*)"/) {
2670 if (!grep(/$name/, @setup_docs)) {
2671 CHK
("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
2675 # check for pointless casting of kmalloc return
2676 if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
2677 WARN
("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
2680 # check for gcc specific __FUNCTION__
2681 if ($line =~ /__FUNCTION__/) {
2682 WARN
("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
2685 # check for semaphores used as mutexes
2686 if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
2687 WARN
("mutexes are preferred for single holder semaphores\n" . $herecurr);
2689 # check for semaphores used as mutexes
2690 if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
2691 WARN
("consider using a completion\n" . $herecurr);
2694 # recommend strict_strto* over simple_strto*
2695 if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2696 WARN
("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
2698 # check for __initcall(), use device_initcall() explicitly please
2699 if ($line =~ /^.\s*__initcall\s*\(/) {
2700 WARN
("please use device_initcall() instead of __initcall()\n" . $herecurr);
2702 # check for various ops structs, ensure they are const.
2703 my $struct_ops = qr{acpi_dock_ops
|
2704 address_space_operations
|
2706 block_device_operations
|
2711 file_lock_operations
|
2721 lock_manager_operations
|
2727 pipe_buf_operations
|
2728 platform_hibernation_ops
|
2729 platform_suspend_ops
|
2734 soc_pcmcia_socket_ops
|
2740 if ($line !~ /\bconst\b/ &&
2741 $line =~ /\bstruct\s+($struct_ops)\b/) {
2742 WARN
("struct $1 should normally be const\n" .
2746 # use of NR_CPUS is usually wrong
2747 # ignore definitions of NR_CPUS and usage to define arrays as likely right
2748 if ($line =~ /\bNR_CPUS\b/ &&
2749 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
2750 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
2751 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
2752 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
2753 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
2755 WARN
("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
2758 # check for %L{u,d,i} in strings
2760 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2761 $string = substr($rawline, $-[1], $+[1] - $-[1]);
2762 $string =~ s/%%/__/g;
2763 if ($string =~ /(?<!%)%L[udi]/) {
2764 WARN
("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2769 # whine mightly about in_atomic
2770 if ($line =~ /\bin_atomic\s*\(/) {
2771 if ($realfile =~ m@
^drivers
/@
) {
2772 ERROR
("do not use in_atomic in drivers\n" . $herecurr);
2773 } elsif ($realfile !~ m@
^kernel
/@
) {
2774 WARN
("use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
2778 # check for lockdep_set_novalidate_class
2779 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
2780 $line =~ /__lockdep_no_validate__\s*\)/ ) {
2781 if ($realfile !~ m@
^kernel
/lockdep@
&&
2782 $realfile !~ m@
^include
/linux/lockdep@
&&
2783 $realfile !~ m@
^drivers
/base/core@
) {
2784 ERROR
("lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
2789 # If we have no input at all, then there is nothing to report on
2790 # so just keep quiet.
2791 if ($#rawlines == -1) {
2795 # In mailback mode only produce a report in the negative, for
2796 # things that appear to be patches.
2797 if ($mailback && ($clean == 1 || !$is_patch)) {
2801 # This is not a patch, and we are are in 'no-patch' mode so
2803 if (!$chk_patch && !$is_patch) {
2808 ERROR
("Does not appear to be a unified-diff format patch\n");
2810 if ($is_patch && $chk_signoff && $signoff == 0) {
2811 ERROR
("Missing Signed-off-by: line(s)\n");
2814 print report_dump
();
2815 if ($summary && !($clean == 1 && $quiet == 1)) {
2816 print "$filename " if ($summary_file);
2817 print "total: $cnt_error errors, $cnt_warn warnings, " .
2818 (($check)?
"$cnt_chk checks, " : "") .
2819 "$cnt_lines lines checked\n";
2820 print "\n" if ($quiet == 0);
2823 if ($clean == 1 && $quiet == 0) {
2824 print "$vname has no obvious style problems and is ready for submission.\n"
2826 if ($clean == 0 && $quiet == 0) {
2827 print "$vname has style problems, please review. If any of these errors\n";
2828 print "are false positives report them to the maintainer, see\n";
2829 print "CHECKPATCH in MAINTAINERS.\n";