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 = (
228 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
229 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
230 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
232 (?
:$Modifier\s
+|const\s
+)*
234 (?
:typeof
|__typeof__
)\s
*\
(\s
*\
**\s
*$Ident\s
*\
)|
238 (?
:\s
+$Modifier|\s
+const
)*
242 (?
:[\s\
*]+\s
*const
|[\s\
*]+|(?
:\s
*\
[\s
*\
])+)?
243 (?
:\s
+$Inline|\s
+$Modifier)*
245 $Declare = qr{(?:$Storage\s+)?$Type};
249 $chk_signoff = 0 if ($file);
251 my @dep_includes = ();
252 my @dep_functions = ();
253 my $removal = "Documentation/feature-removal-schedule.txt";
254 if ($tree && -f
"$root/$removal") {
255 open(my $REMOVE, '<', "$root/$removal") ||
256 die "$P: $removal: open failed - $!\n";
258 if (/^Check:\s+(.*\S)/) {
259 for my $entry (split(/[, ]+/, $1)) {
260 if ($entry =~ m
@include/(.*)@
) {
261 push(@dep_includes, $1);
263 } elsif ($entry !~ m@
/@
) {
264 push(@dep_functions, $entry);
275 for my $filename (@ARGV) {
278 open($FILE, '-|', "diff -u /dev/null $filename") ||
279 die "$P: $filename: diff failed - $!\n";
280 } elsif ($filename eq '-') {
281 open($FILE, '<&STDIN');
283 open($FILE, '<', "$filename") ||
284 die "$P: $filename: open failed - $!\n";
286 if ($filename eq '-') {
287 $vname = 'Your patch';
296 if (!process
($filename)) {
305 sub top_of_kernel_tree
{
309 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
310 "README", "Documentation", "arch", "include", "drivers",
311 "fs", "init", "ipc", "kernel", "lib", "scripts",
314 foreach my $check (@tree_check) {
315 if (! -e
$root . '/' . $check) {
327 for my $c (split(//, $str)) {
331 for (; ($n % 8) != 0; $n++) {
343 (my $res = shift) =~ tr/\t/ /c;
350 # Drop the diff line leader and expand tabs
352 $line = expand_tabs
($line);
354 # Pick the indent from the front of the line.
355 my ($white) = ($line =~ /^(\s*)/);
357 return (length($line), length($white));
360 my $sanitise_quote = '';
362 sub sanitise_line_reset
{
363 my ($in_comment) = @_;
366 $sanitise_quote = '*/';
368 $sanitise_quote = '';
381 # Always copy over the diff marker.
382 $res = substr($line, 0, 1);
384 for ($off = 1; $off < length($line); $off++) {
385 $c = substr($line, $off, 1);
387 # Comments we are wacking completly including the begin
388 # and end, all to $;.
389 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
390 $sanitise_quote = '*/';
392 substr($res, $off, 2, "$;$;");
396 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
397 $sanitise_quote = '';
398 substr($res, $off, 2, "$;$;");
402 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
403 $sanitise_quote = '//';
405 substr($res, $off, 2, $sanitise_quote);
410 # A \ in a string means ignore the next character.
411 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
413 substr($res, $off, 2, 'XX');
418 if ($c eq "'" || $c eq '"') {
419 if ($sanitise_quote eq '') {
420 $sanitise_quote = $c;
422 substr($res, $off, 1, $c);
424 } elsif ($sanitise_quote eq $c) {
425 $sanitise_quote = '';
429 #print "c<$c> SQ<$sanitise_quote>\n";
430 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
431 substr($res, $off, 1, $;);
432 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
433 substr($res, $off, 1, $;);
434 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
435 substr($res, $off, 1, 'X');
437 substr($res, $off, 1, $c);
441 if ($sanitise_quote eq '//') {
442 $sanitise_quote = '';
445 # The pathname on a #include may be surrounded by '<' and '>'.
446 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
447 my $clean = 'X' x
length($1);
448 $res =~ s@\
<.*\
>@
<$clean>@
;
450 # The whole of a #error is a string.
451 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
452 my $clean = 'X' x
length($1);
453 $res =~ s@
(\#\s
*(?
:error
|warning
)\s
+).*@
$1$clean@
;
459 sub ctx_statement_block
{
460 my ($linenr, $remain, $off) = @_;
461 my $line = $linenr - 1;
478 @stack = (['', 0]) if ($#stack == -1);
480 #warn "CSB: blk<$blk> remain<$remain>\n";
481 # If we are about to drop off the end, pull in more
484 for (; $remain > 0; $line++) {
485 last if (!defined $lines[$line]);
486 next if ($lines[$line] =~ /^-/);
489 $blk .= $lines[$line] . "\n";
494 # Bail if there is no further context.
495 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
501 $c = substr($blk, $off, 1);
502 $remainder = substr($blk, $off);
504 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
506 # Handle nested #if/#else.
507 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
508 push(@stack, [ $type, $level ]);
509 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
510 ($type, $level) = @
{$stack[$#stack - 1]};
511 } elsif ($remainder =~ /^#\s*endif\b/) {
512 ($type, $level) = @
{pop(@stack)};
515 # Statement ends at the ';' or a close '}' at the
517 if ($level == 0 && $c eq ';') {
521 # An else is really a conditional as long as its not else if
522 if ($level == 0 && $coff_set == 0 &&
523 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
524 $remainder =~ /^(else)(?:\s|{)/ &&
525 $remainder !~ /^else\s+if\b/) {
526 $coff = $off + length($1) - 1;
528 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
529 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
532 if (($type eq '' || $type eq '(') && $c eq '(') {
536 if ($type eq '(' && $c eq ')') {
538 $type = ($level != 0)?
'(' : '';
540 if ($level == 0 && $coff < $soff) {
543 #warn "CSB: mark coff<$coff>\n";
546 if (($type eq '' || $type eq '{') && $c eq '{') {
550 if ($type eq '{' && $c eq '}') {
552 $type = ($level != 0)?
'{' : '';
560 # We are truly at the end, so shuffle to the next line.
567 my $statement = substr($blk, $soff, $off - $soff + 1);
568 my $condition = substr($blk, $soff, $coff - $soff + 1);
570 #warn "STATEMENT<$statement>\n";
571 #warn "CONDITION<$condition>\n";
573 #print "coff<$coff> soff<$off> loff<$loff>\n";
575 return ($statement, $condition,
576 $line, $remain + 1, $off - $loff + 1, $level);
579 sub statement_lines
{
582 # Strip the diff line prefixes and rip blank lines at start and end.
583 $stmt =~ s/(^|\n)./$1/g;
587 my @stmt_lines = ($stmt =~ /\n/g);
589 return $#stmt_lines + 2;
592 sub statement_rawlines
{
595 my @stmt_lines = ($stmt =~ /\n/g);
597 return $#stmt_lines + 2;
600 sub statement_block_size
{
603 $stmt =~ s/(^|\n)./$1/g;
609 my @stmt_lines = ($stmt =~ /\n/g);
610 my @stmt_statements = ($stmt =~ /;/g);
612 my $stmt_lines = $#stmt_lines + 2;
613 my $stmt_statements = $#stmt_statements + 1;
615 if ($stmt_lines > $stmt_statements) {
618 return $stmt_statements;
622 sub ctx_statement_full
{
623 my ($linenr, $remain, $off) = @_;
624 my ($statement, $condition, $level);
628 # Grab the first conditional/block pair.
629 ($statement, $condition, $linenr, $remain, $off, $level) =
630 ctx_statement_block
($linenr, $remain, $off);
631 #print "F: c<$condition> s<$statement> remain<$remain>\n";
632 push(@chunks, [ $condition, $statement ]);
633 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
634 return ($level, $linenr, @chunks);
637 # Pull in the following conditional/block pairs and see if they
638 # could continue the statement.
640 ($statement, $condition, $linenr, $remain, $off, $level) =
641 ctx_statement_block
($linenr, $remain, $off);
642 #print "C: c<$condition> s<$statement> remain<$remain>\n";
643 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
645 push(@chunks, [ $condition, $statement ]);
648 return ($level, $linenr, @chunks);
652 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
654 my $start = $linenr - 1;
661 my @stack = ($level);
662 for ($line = $start; $remain > 0; $line++) {
663 next if ($rawlines[$line] =~ /^-/);
666 $blk .= $rawlines[$line];
668 # Handle nested #if/#else.
669 if ($rawlines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
670 push(@stack, $level);
671 } elsif ($rawlines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
672 $level = $stack[$#stack - 1];
673 } elsif ($rawlines[$line] =~ /^.\s*#\s*endif\b/) {
674 $level = pop(@stack);
677 foreach my $c (split(//, $rawlines[$line])) {
678 ##print "C<$c>L<$level><$open$close>O<$off>\n";
684 if ($c eq $close && $level > 0) {
686 last if ($level == 0);
687 } elsif ($c eq $open) {
692 if (!$outer || $level <= 1) {
693 push(@res, $rawlines[$line]);
696 last if ($level == 0);
699 return ($level, @res);
701 sub ctx_block_outer
{
702 my ($linenr, $remain) = @_;
704 my ($level, @r) = ctx_block_get
($linenr, $remain, 1, '{', '}', 0);
708 my ($linenr, $remain) = @_;
710 my ($level, @r) = ctx_block_get
($linenr, $remain, 0, '{', '}', 0);
714 my ($linenr, $remain, $off) = @_;
716 my ($level, @r) = ctx_block_get
($linenr, $remain, 0, '(', ')', $off);
719 sub ctx_block_level
{
720 my ($linenr, $remain) = @_;
722 return ctx_block_get
($linenr, $remain, 0, '{', '}', 0);
724 sub ctx_statement_level
{
725 my ($linenr, $remain, $off) = @_;
727 return ctx_block_get
($linenr, $remain, 0, '(', ')', $off);
730 sub ctx_locate_comment
{
731 my ($first_line, $end_line) = @_;
733 # Catch a comment on the end of the line itself.
734 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@
.*(/\*.*\*/)\s
*(?
:\\\s
*)?
$@
);
735 return $current_comment if (defined $current_comment);
737 # Look through the context and try and figure out if there is a
740 $current_comment = '';
741 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
742 my $line = $rawlines[$linenr - 1];
744 if ($linenr == $first_line and $line =~ m@
^.\s
*\
*@
) {
747 if ($line =~ m@
/\
*@
) {
750 if (!$in_comment && $current_comment ne '') {
751 $current_comment = '';
753 $current_comment .= $line . "\n" if ($in_comment);
754 if ($line =~ m@\
*/@
) {
759 chomp($current_comment);
760 return($current_comment);
762 sub ctx_has_comment
{
763 my ($first_line, $end_line) = @_;
764 my $cmt = ctx_locate_comment
($first_line, $end_line);
766 ##print "LINE: $rawlines[$end_line - 1 ]\n";
767 ##print "CMMT: $cmt\n";
773 my ($linenr, $cnt) = @_;
775 my $offset = $linenr - 1;
780 $line = $rawlines[$offset++];
781 next if (defined($line) && $line =~ /^-/);
793 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
796 $coded = sprintf("^%c", unpack('C', $2) + 64);
805 my $av_preprocessor = 0;
811 $av_preprocessor = 0;
813 @av_paren_type = ('E');
814 $av_pend_colon = 'O';
817 sub annotate_values
{
818 my ($stream, $type) = @_;
821 my $var = '_' x
length($stream);
824 print "$stream\n" if ($dbg_values > 1);
826 while (length($cur)) {
827 @av_paren_type = ('E') if ($#av_paren_type < 0);
828 print " <" . join('', @av_paren_type) .
829 "> <$type> <$av_pending>" if ($dbg_values > 1);
830 if ($cur =~ /^(\s+)/o) {
831 print "WS($1)\n" if ($dbg_values > 1);
832 if ($1 =~ /\n/ && $av_preprocessor) {
833 $type = pop(@av_paren_type);
834 $av_preprocessor = 0;
837 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\()/) {
838 print "DECLARE($1)\n" if ($dbg_values > 1);
841 } elsif ($cur =~ /^($Modifier)\s*/) {
842 print "MODIFIER($1)\n" if ($dbg_values > 1);
845 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
846 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
847 $av_preprocessor = 1;
848 push(@av_paren_type, $type);
854 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
855 print "UNDEF($1)\n" if ($dbg_values > 1);
856 $av_preprocessor = 1;
857 push(@av_paren_type, $type);
859 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
860 print "PRE_START($1)\n" if ($dbg_values > 1);
861 $av_preprocessor = 1;
863 push(@av_paren_type, $type);
864 push(@av_paren_type, $type);
867 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
868 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
869 $av_preprocessor = 1;
871 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
875 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
876 print "PRE_END($1)\n" if ($dbg_values > 1);
878 $av_preprocessor = 1;
880 # Assume all arms of the conditional end as this
881 # one does, and continue as if the #endif was not here.
883 push(@av_paren_type, $type);
886 } elsif ($cur =~ /^(\\\n)/o) {
887 print "PRECONT($1)\n" if ($dbg_values > 1);
889 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
890 print "ATTR($1)\n" if ($dbg_values > 1);
894 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
895 print "SIZEOF($1)\n" if ($dbg_values > 1);
901 } elsif ($cur =~ /^(if|while|for)\b/o) {
902 print "COND($1)\n" if ($dbg_values > 1);
906 } elsif ($cur =~/^(case)/o) {
907 print "CASE($1)\n" if ($dbg_values > 1);
908 $av_pend_colon = 'C';
911 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
912 print "KEYWORD($1)\n" if ($dbg_values > 1);
915 } elsif ($cur =~ /^(\()/o) {
916 print "PAREN('$1')\n" if ($dbg_values > 1);
917 push(@av_paren_type, $av_pending);
921 } elsif ($cur =~ /^(\))/o) {
922 my $new_type = pop(@av_paren_type);
923 if ($new_type ne '_') {
925 print "PAREN('$1') -> $type\n"
926 if ($dbg_values > 1);
928 print "PAREN('$1')\n" if ($dbg_values > 1);
931 } elsif ($cur =~ /^($Ident)\s*\(/o) {
932 print "FUNC($1)\n" if ($dbg_values > 1);
936 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
937 if (defined $2 && $type eq 'C' || $type eq 'T') {
938 $av_pend_colon = 'B';
939 } elsif ($type eq 'E') {
940 $av_pend_colon = 'L';
942 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
945 } elsif ($cur =~ /^($Ident|$Constant)/o) {
946 print "IDENT($1)\n" if ($dbg_values > 1);
949 } elsif ($cur =~ /^($Assignment)/o) {
950 print "ASSIGN($1)\n" if ($dbg_values > 1);
953 } elsif ($cur =~/^(;|{|})/) {
954 print "END($1)\n" if ($dbg_values > 1);
956 $av_pend_colon = 'O';
958 } elsif ($cur =~/^(,)/) {
959 print "COMMA($1)\n" if ($dbg_values > 1);
962 } elsif ($cur =~ /^(\?)/o) {
963 print "QUESTION($1)\n" if ($dbg_values > 1);
966 } elsif ($cur =~ /^(:)/o) {
967 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
969 substr($var, length($res), 1, $av_pend_colon);
970 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
975 $av_pend_colon = 'O';
977 } elsif ($cur =~ /^(\[)/o) {
978 print "CLOSE($1)\n" if ($dbg_values > 1);
981 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
984 print "OPV($1)\n" if ($dbg_values > 1);
991 substr($var, length($res), 1, $variant);
994 } elsif ($cur =~ /^($Operators)/o) {
995 print "OP($1)\n" if ($dbg_values > 1);
996 if ($1 ne '++' && $1 ne '--') {
1000 } elsif ($cur =~ /(^.)/o) {
1001 print "C($1)\n" if ($dbg_values > 1);
1004 $cur = substr($cur, length($1));
1005 $res .= $type x
length($1);
1009 return ($res, $var);
1013 my ($possible, $line) = @_;
1014 my $notPermitted = qr{(?
:
1029 ^(?
:typedef
|struct
|enum
)\b
1031 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1032 if ($possible !~ $notPermitted) {
1033 # Check for modifiers.
1034 $possible =~ s/\s*$Storage\s*//g;
1035 $possible =~ s/\s*$Sparse\s*//g;
1036 if ($possible =~ /^\s*$/) {
1038 } elsif ($possible =~ /\s/) {
1039 $possible =~ s/\s*$Type\s*//g;
1040 for my $modifier (split(' ', $possible)) {
1041 if ($modifier !~ $notPermitted) {
1042 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1043 push(@modifierList, $modifier);
1048 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1049 push(@typeList, $possible);
1053 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1060 if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
1063 my $line = $prefix . $_[0];
1065 $line = (split('\n', $line))[0] . "\n" if ($terse);
1067 push(our @report, $line);
1075 if (report
("ERROR: $_[0]\n")) {
1081 if (report
("WARNING: $_[0]\n")) {
1087 if ($check && report
("CHECK: $_[0]\n")) {
1093 sub check_absolute_file
{
1094 my ($absolute, $herecurr) = @_;
1095 my $file = $absolute;
1097 ##print "absolute<$absolute>\n";
1099 # See if any suffix of this path is a path within the tree.
1100 while ($file =~ s@
^[^/]*/@@
) {
1101 if (-f
"$root/$file") {
1102 ##print "file<$file>\n";
1110 # It is, so see if the prefix is acceptable.
1111 my $prefix = $absolute;
1112 substr($prefix, -length($file)) = '';
1114 ##print "prefix<$prefix>\n";
1115 if ($prefix ne ".../") {
1116 WARN
("use relative pathname instead of absolute in changelog text\n" . $herecurr);
1121 my $filename = shift;
1127 my $stashrawline="";
1144 # Trace the real file/line as we go.
1150 my $comment_edge = 0;
1154 my $prev_values = 'E';
1157 my %suppress_ifbraces;
1158 my %suppress_whiletrailers;
1159 my %suppress_export;
1161 # Pre-scan the patch sanitizing the lines.
1162 # Pre-scan the patch looking for any __setup documentation.
1164 my @setup_docs = ();
1167 sanitise_line_reset
();
1169 foreach my $rawline (@rawlines) {
1173 if ($rawline=~/^\+\+\+\s+(\S+)/) {
1175 if ($1 =~ m
@Documentation/kernel
-parameters
.txt
$@
) {
1180 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1189 # Guestimate if this is a continuing comment. Run
1190 # the context looking for a comment "edge". If this
1191 # edge is a close comment then we must be in a comment
1195 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1196 next if (defined $rawlines[$ln - 1] &&
1197 $rawlines[$ln - 1] =~ /^-/);
1199 #print "RAW<$rawlines[$ln - 1]>\n";
1200 last if (!defined $rawlines[$ln - 1]);
1201 if ($rawlines[$ln - 1] =~ m@
(/\*|\*/)@
&&
1202 $rawlines[$ln - 1] !~ m@
"[^"]*(?
:/\*|\*/)[^"]*"@
) {
1207 if (defined $edge && $edge eq '*/') {
1211 # Guestimate if this is a continuing comment. If this
1212 # is the start of a diff block and this line starts
1213 # ' *' then it is very likely a comment.
1214 if (!defined $edge &&
1215 $rawlines[$linenr] =~ m@
^.\s
*(?
:\
*\
*+| \
*)(?
:\s
|$)@
)
1220 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1221 sanitise_line_reset
($in_comment);
1223 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1224 # Standardise the strings and chars within the input to
1225 # simplify matching -- only bother with positive lines.
1226 $line = sanitise_line
($rawline);
1228 push(@lines, $line);
1231 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1236 #print "==>$rawline\n";
1237 #print "-->$line\n";
1239 if ($setup_docs && $line =~ /^\+/) {
1240 push(@setup_docs, $line);
1248 foreach my $line (@lines) {
1251 my $rawline = $rawlines[$linenr - 1];
1253 #extract the line range in the file after the patch is applied
1254 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1256 $first_line = $linenr + 1;
1266 %suppress_ifbraces = ();
1267 %suppress_whiletrailers = ();
1268 %suppress_export = ();
1271 # track the line number as we move through the hunk, note that
1272 # new versions of GNU diff omit the leading space on completely
1273 # blank context lines so we need to count that too.
1274 } elsif ($line =~ /^( |\+|$)/) {
1276 $realcnt-- if ($realcnt != 0);
1278 # Measure the line length and indent.
1279 ($length, $indent) = line_stats
($rawline);
1281 # Track the previous line.
1282 ($prevline, $stashline) = ($stashline, $line);
1283 ($previndent, $stashindent) = ($stashindent, $indent);
1284 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1286 #warn "line<$line>\n";
1288 } elsif ($realcnt == 1) {
1292 my $hunk_line = ($realcnt != 0);
1294 #make up the handle for any error we report on this line
1295 $prefix = "$filename:$realline: " if ($emacs && $file);
1296 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1298 $here = "#$linenr: " if (!$file);
1299 $here = "#$realline: " if ($file);
1301 # extract the filename as it passes
1302 if ($line=~/^\+\+\+\s+(\S+)/) {
1304 $realfile =~ s@
^([^/]*)/@@
;
1307 if (!$file && $tree && $p1_prefix ne '' &&
1308 -e
"$root/$p1_prefix") {
1309 WARN
("patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1312 if ($realfile =~ m@
^include
/asm/@
) {
1313 ERROR
("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1318 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
1320 my $hereline = "$here\n$rawline\n";
1321 my $herecurr = "$here\n$rawline\n";
1322 my $hereprev = "$here\n$prevrawline\n$rawline\n";
1324 $cnt_lines++ if ($realcnt != 0);
1326 #check the patch for a signoff:
1327 if ($line =~ /^\s*signed-off-by:/i) {
1328 # This is a signoff, if ugly, so do not double report.
1330 if (!($line =~ /^\s*Signed-off-by:/)) {
1331 WARN
("Signed-off-by: is the preferred form\n" .
1334 if ($line =~ /^\s*signed-off-by:\S/i) {
1335 WARN
("space required after Signed-off-by:\n" .
1340 # Check for wrappage within a valid hunk of the file
1341 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1342 ERROR
("patch seems to be corrupt (line wrapped?)\n" .
1343 $herecurr) if (!$emitted_corrupt++);
1346 # Check for absolute kernel paths.
1348 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1351 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1352 check_absolute_file
($1, $herecurr)) {
1355 check_absolute_file
($file, $herecurr);
1360 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1361 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1362 $rawline !~ m/^$UTF8*$/) {
1363 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1365 my $blank = copy_spacing
($rawline);
1366 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1367 my $hereptr = "$hereline$ptr\n";
1369 ERROR
("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1372 # ignore non-hunk lines and lines being removed
1373 next if (!$hunk_line || $line =~ /^-/);
1375 #trailing whitespace
1376 if ($line =~ /^\+.*\015/) {
1377 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
1378 ERROR
("DOS line endings\n" . $herevet);
1380 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1381 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
1382 ERROR
("trailing whitespace\n" . $herevet);
1385 # check we are in a valid source file if not then ignore this hunk
1386 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1389 if ($line =~ /^\+/ && $prevrawline !~ /\/\
*\
*/ &&
1390 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1391 $line !~ /^\+\s*$logFunctions\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ &&
1394 WARN
("line over 80 characters\n" . $herecurr);
1397 # check for adding lines without a newline.
1398 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1399 WARN
("adding a line without newline at end of file\n" . $herecurr);
1402 # Blackfin: use hi/lo macros
1403 if ($realfile =~ m
@arch/blackfin/.*\
.S
$@
) {
1404 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
1405 my $herevet = "$here\n" . cat_vet
($line) . "\n";
1406 ERROR
("use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
1408 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
1409 my $herevet = "$here\n" . cat_vet
($line) . "\n";
1410 ERROR
("use the HI() macro, not (... >> 16)\n" . $herevet);
1414 # check we are in a valid source file C or perl if not then ignore this hunk
1415 next if ($realfile !~ /\.(h|c|pl)$/);
1417 # at the beginning of a line any tabs must come first and anything
1418 # more than 8 must use tabs.
1419 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1420 $rawline =~ /^\+\s* \s*/) {
1421 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
1422 ERROR
("code indent should use tabs where possible\n" . $herevet);
1425 # check for space before tabs.
1426 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
1427 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
1428 WARN
("please, no space before tabs\n" . $herevet);
1431 # check we are in a valid C source file if not then ignore this hunk
1432 next if ($realfile !~ /\.(h|c)$/);
1434 # check for RCS/CVS revision markers
1435 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
1436 WARN
("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1439 # Blackfin: don't use __builtin_bfin_[cs]sync
1440 if ($line =~ /__builtin_bfin_csync/) {
1441 my $herevet = "$here\n" . cat_vet
($line) . "\n";
1442 ERROR
("use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
1444 if ($line =~ /__builtin_bfin_ssync/) {
1445 my $herevet = "$here\n" . cat_vet
($line) . "\n";
1446 ERROR
("use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
1449 # Check for potential 'bare' types
1450 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
1452 if ($realcnt && $line =~ /.\s*\S/) {
1453 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
1454 ctx_statement_block
($linenr, $realcnt, 0);
1455 $stat =~ s/\n./\n /g;
1456 $cond =~ s/\n./\n /g;
1458 # Find the real next line.
1459 $realline_next = $line_nr_next;
1460 if (defined $realline_next &&
1461 (!defined $lines[$realline_next - 1] ||
1462 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
1469 # Ignore goto labels.
1470 if ($s =~ /$Ident:\*$/s) {
1472 # Ignore functions being called
1473 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
1475 } elsif ($s =~ /^.\s*else\b/s) {
1477 # declarations always start with types
1478 } 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) {
1481 possible
($type, "A:" . $s);
1483 # definitions in global scope can only start with types
1484 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
1485 possible
($1, "B:" . $s);
1488 # any (foo ... *) is a pointer cast, and foo is a type
1489 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
1490 possible
($1, "C:" . $s);
1493 # Check for any sort of function declaration.
1494 # int foo(something bar, other baz);
1495 # void (*store_gdt)(x86_descr_ptr *);
1496 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
1497 my ($name_len) = length($1);
1500 substr($ctx, 0, $name_len + 1, '');
1501 $ctx =~ s/\)[^\)]*$//;
1503 for my $arg (split(/\s*,\s*/, $ctx)) {
1504 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
1506 possible
($1, "D:" . $s);
1514 # Checks which may be anchored in the context.
1517 # Check for switch () and associated case and default
1518 # statements should be at the same indent.
1519 if ($line=~/\bswitch\s*\(.*\)/) {
1522 my @ctx = ctx_block_outer
($linenr, $realcnt);
1524 for my $ctx (@ctx) {
1525 my ($clen, $cindent) = line_stats
($ctx);
1526 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1527 $indent != $cindent) {
1528 $err .= "$sep$ctx\n";
1535 ERROR
("switch and case should be at the same indent\n$hereline$err");
1539 # if/while/etc brace do not go on next line, unless defining a do while loop,
1540 # or if that brace on the next line is for something else
1541 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
1542 my $pre_ctx = "$1$2";
1544 my ($level, @ctx) = ctx_statement_level
($linenr, $realcnt, 0);
1545 my $ctx_cnt = $realcnt - $#ctx - 1;
1546 my $ctx = join("\n", @ctx);
1548 my $ctx_ln = $linenr;
1549 my $ctx_skip = $realcnt;
1551 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1552 defined $lines[$ctx_ln - 1] &&
1553 $lines[$ctx_ln - 1] =~ /^-/)) {
1554 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1555 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
1559 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1560 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
1562 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1563 ERROR
("that open brace { should be on the previous line\n" .
1564 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1566 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1567 $ctx =~ /\)\s*\;\s*$/ &&
1568 defined $lines[$ctx_ln - 1])
1570 my ($nlength, $nindent) = line_stats
($lines[$ctx_ln - 1]);
1571 if ($nindent > $indent) {
1572 WARN
("trailing semicolon indicates no statements, indent implies otherwise\n" .
1573 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1578 # Check relative indent for conditionals and blocks.
1579 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1580 my ($s, $c) = ($stat, $cond);
1582 substr($s, 0, length($c), '');
1584 # Make sure we remove the line prefixes as we have
1585 # none on the first line, and are going to readd them
1589 # Find out how long the conditional actually is.
1590 my @newlines = ($c =~ /\n/gs);
1591 my $cond_lines = 1 + $#newlines;
1593 # We want to check the first line inside the block
1594 # starting at the end of the conditional, so remove:
1595 # 1) any blank line termination
1596 # 2) any opening brace { on end of the line
1598 my $continuation = 0;
1600 $s =~ s/^.*\bdo\b//;
1602 if ($s =~ s/^\s*\\//) {
1605 if ($s =~ s/^\s*?\n//) {
1610 # Also ignore a loop construct at the end of a
1611 # preprocessor statement.
1612 if (($prevline =~ /^.\s*#\s*define\s/ ||
1613 $prevline =~ /\\\s*$/) && $continuation == 0) {
1619 while ($cond_ptr != $cond_lines) {
1620 $cond_ptr = $cond_lines;
1622 # If we see an #else/#elif then the code
1624 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
1629 # 1) blank lines, they should be at 0,
1630 # 2) preprocessor lines, and
1632 if ($continuation ||
1634 $s =~ /^\s*#\s*?/ ||
1635 $s =~ /^\s*$Ident\s*:/) {
1636 $continuation = ($s =~ /^.*?\\\n/) ?
1 : 0;
1637 if ($s =~ s/^.*?\n//) {
1643 my (undef, $sindent) = line_stats
("+" . $s);
1644 my $stat_real = raw_line
($linenr, $cond_lines);
1646 # Check if either of these lines are modified, else
1647 # this is not this patch's fault.
1648 if (!defined($stat_real) ||
1649 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
1652 if (defined($stat_real) && $cond_lines > 1) {
1653 $stat_real = "[...]\n$stat_real";
1656 #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";
1658 if ($check && (($sindent % 8) != 0 ||
1659 ($sindent <= $indent && $s ne ''))) {
1660 WARN
("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
1664 # Track the 'values' across context and added lines.
1665 my $opline = $line; $opline =~ s/^./ /;
1666 my ($curr_values, $curr_vars) =
1667 annotate_values
($opline . "\n", $prev_values);
1668 $curr_values = $prev_values . $curr_values;
1670 my $outline = $opline; $outline =~ s/\t/ /g;
1671 print "$linenr > .$outline\n";
1672 print "$linenr > $curr_values\n";
1673 print "$linenr > $curr_vars\n";
1675 $prev_values = substr($curr_values, -1);
1677 #ignore lines not being added
1678 if ($line=~/^[^\+]/) {next;}
1680 # TEST: allow direct testing of the type matcher.
1682 if ($line =~ /^.\s*$Declare\s*$/) {
1683 ERROR
("TEST: is type\n" . $herecurr);
1684 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
1685 ERROR
("TEST: is not type ($1 is)\n". $herecurr);
1689 # TEST: allow direct testing of the attribute matcher.
1691 if ($line =~ /^.\s*$Modifier\s*$/) {
1692 ERROR
("TEST: is attr\n" . $herecurr);
1693 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
1694 ERROR
("TEST: is not attr ($1 is)\n". $herecurr);
1699 # check for initialisation to aggregates open brace on the next line
1700 if ($line =~ /^.\s*{/ &&
1701 $prevline =~ /(?:^|[^=])=\s*$/) {
1702 ERROR
("that open brace { should be on the previous line\n" . $hereprev);
1706 # Checks which are anchored on the added line.
1709 # check for malformed paths in #include statements (uses RAW line)
1710 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
1712 if ($path =~ m{//}) {
1713 ERROR
("malformed #include filename\n" .
1718 # no C99 // comments
1719 if ($line =~ m{//}) {
1720 ERROR
("do not use C99 // comments\n" . $herecurr);
1722 # Remove C99 comments.
1724 $opline =~ s@
//.*@@
;
1726 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
1727 # the whole statement.
1728 #print "APW <$lines[$realline_next - 1]>\n";
1729 if (defined $realline_next &&
1730 exists $lines[$realline_next - 1] &&
1731 !defined $suppress_export{$realline_next} &&
1732 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
1733 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1737 ^.DEFINE_
$Ident\
(\Q
$name\E\
)|
1738 ^.DECLARE_
$Ident\
(\Q
$name\E\
)|
1739 ^.LIST_HEAD\
(\Q
$name\E\
)|
1740 ^.(?
:$Storage\s
+)?
$Type\s
*\
(\s
*\
*\s
*\Q
$name\E\s
*\
)\s
*\
(|
1741 \b\Q
$name\E
(?
:\s
+$Attribute)*\s
*(?
:;|=|\
[|\
()
1743 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
1744 $suppress_export{$realline_next} = 2;
1746 $suppress_export{$realline_next} = 1;
1749 if (!defined $suppress_export{$linenr} &&
1750 $prevline =~ /^.\s*$/ &&
1751 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
1752 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1753 #print "FOO B <$lines[$linenr - 1]>\n";
1754 $suppress_export{$linenr} = 2;
1756 if (defined $suppress_export{$linenr} &&
1757 $suppress_export{$linenr} == 2) {
1758 WARN
("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
1761 # check for external initialisers.
1762 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
1763 ERROR
("do not initialise externals to 0 or NULL\n" .
1766 # check for static initialisers.
1767 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
1768 ERROR
("do not initialise statics to 0 or NULL\n" .
1772 # check for new typedefs, only function parameters and sparse annotations
1774 if ($line =~ /\btypedef\s/ &&
1775 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
1776 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
1777 $line !~ /\b$typeTypedefs\b/ &&
1778 $line !~ /\b__bitwise(?:__|)\b/) {
1779 WARN
("do not add new typedefs\n" . $herecurr);
1782 # * goes on variable not on type
1784 if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) {
1785 my ($from, $to) = ($1, $1);
1787 # Should start with a space.
1788 $to =~ s/^(\S)/ $1/;
1789 # Should not end with a space.
1791 # '*'s should not have spaces between.
1792 while ($to =~ s/\*\s+\*/\*\*/) {
1795 #print "from<$from> to<$to>\n";
1797 ERROR
("\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr);
1799 } elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) {
1800 my ($from, $to, $ident) = ($1, $1, $2);
1802 # Should start with a space.
1803 $to =~ s/^(\S)/ $1/;
1804 # Should not end with a space.
1806 # '*'s should not have spaces between.
1807 while ($to =~ s/\*\s+\*/\*\*/) {
1809 # Modifiers should have spaces.
1810 $to =~ s/(\b$Modifier$)/$1 /;
1812 #print "from<$from> to<$to> ident<$ident>\n";
1813 if ($from ne $to && $ident !~ /^$Modifier$/) {
1814 ERROR
("\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr);
1818 # # no BUG() or BUG_ON()
1819 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
1820 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
1821 # print "$herecurr";
1825 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
1826 WARN
("LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
1829 # printk should use KERN_* levels. Note that follow on printk's on the
1830 # same line do not need a level, so we use the current block context
1831 # to try and find and validate the current printk. In summary the current
1832 # printk includes all preceeding printk's which have no newline on the end.
1833 # we assume the first bad printk is the one to report.
1834 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
1836 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
1837 #print "CHECK<$lines[$ln - 1]\n";
1838 # we have a preceeding printk if it ends
1839 # with "\n" ignore it, else it is to blame
1840 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
1841 if ($rawlines[$ln - 1] !~ m{\\n"}) {
1848 WARN
("printk() should include KERN_ facility level\n" . $herecurr);
1852 # function brace can't be on same line, except for #defines of do while,
1853 # or if closed on same line
1854 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
1855 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
1856 ERROR
("open brace '{' following function declarations go on the next line\n" . $herecurr);
1859 # open braces for enum, union and struct go on the same line.
1860 if ($line =~ /^.\s*{/ &&
1861 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1862 ERROR
("open brace '{' following $1 go on the same line\n" . $hereprev);
1865 # check for spacing round square brackets; allowed:
1866 # 1. with a type on the left -- int [] a;
1867 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
1868 # 3. inside a curly brace -- = { [0...10] = 5 }
1869 while ($line =~ /(.*?\s)\[/g) {
1870 my ($where, $prefix) = ($-[1], $1);
1871 if ($prefix !~ /$Type\s+$/ &&
1872 ($where != 0 || $prefix !~ /^.\s+$/) &&
1873 $prefix !~ /{\s+$/) {
1874 ERROR
("space prohibited before open square bracket '['\n" . $herecurr);
1878 # check for spaces between functions and their parentheses.
1879 while ($line =~ /($Ident)\s+\(/g) {
1881 my $ctx_before = substr($line, 0, $-[1]);
1882 my $ctx = "$ctx_before$name";
1884 # Ignore those directives where spaces _are_ permitted.
1886 if|for|while|switch
|return|case
|
1887 volatile
|__volatile__
|
1888 __attribute__
|format
|__extension__
|
1892 # cpp #define statements have non-optional spaces, ie
1893 # if there is a space between the name and the open
1894 # parenthesis it is simply not a parameter group.
1895 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
1897 # cpp #elif statement condition may start with a (
1898 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
1900 # If this whole things ends with a type its most
1901 # likely a typedef for a function.
1902 } elsif ($ctx =~ /$Type$/) {
1905 WARN
("space prohibited between function name and open parenthesis '('\n" . $herecurr);
1908 # Check operator spacing.
1909 if (!($line=~/\#\s*include/)) {
1911 <<=|>>=|<=|>=|==|!=|
1912 \
+=|-=|\
*=|\
/=|%=|\
^=|\
|=|&=|
1913 =>|->|<<|>>|<|>|=|!|~|
1914 &&|\
|\
||,|\
^|\
+\
+|--|&|\
||\
+|-|\
*|\
/|%|
1917 my @elements = split(/($ops|;)/, $opline);
1920 my $blank = copy_spacing
($opline);
1922 for (my $n = 0; $n < $#elements; $n += 2) {
1923 $off += length($elements[$n]);
1925 # Pick up the preceeding and succeeding characters.
1926 my $ca = substr($opline, 0, $off);
1928 if (length($opline) >= ($off + length($elements[$n + 1]))) {
1929 $cc = substr($opline, $off + length($elements[$n + 1]));
1931 my $cb = "$ca$;$cc";
1934 $a = 'V' if ($elements[$n] ne '');
1935 $a = 'W' if ($elements[$n] =~ /\s$/);
1936 $a = 'C' if ($elements[$n] =~ /$;$/);
1937 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
1938 $a = 'O' if ($elements[$n] eq '');
1939 $a = 'E' if ($ca =~ /^\s*$/);
1941 my $op = $elements[$n + 1];
1944 if (defined $elements[$n + 2]) {
1945 $c = 'V' if ($elements[$n + 2] ne '');
1946 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
1947 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
1948 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
1949 $c = 'O' if ($elements[$n + 2] eq '');
1950 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
1955 my $ctx = "${a}x${c}";
1957 my $at = "(ctx:$ctx)";
1959 my $ptr = substr($blank, 0, $off) . "^";
1960 my $hereptr = "$hereline$ptr\n";
1962 # Pull out the value of this operator.
1963 my $op_type = substr($curr_values, $off + 1, 1);
1965 # Get the full operator variant.
1966 my $opv = $op . substr($curr_vars, $off, 1);
1968 # Ignore operators passed as parameters.
1969 if ($op_type ne 'V' &&
1970 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
1973 # } elsif ($op =~ /^$;+$/) {
1975 # ; should have either the end of line or a space or \ after it
1976 } elsif ($op eq ';') {
1977 if ($ctx !~ /.x[WEBC]/ &&
1978 $cc !~ /^\\/ && $cc !~ /^;/) {
1979 ERROR
("space required after that '$op' $at\n" . $hereptr);
1983 } elsif ($op eq '//') {
1987 # : when part of a bitfield
1988 } elsif ($op eq '->' || $opv eq ':B') {
1989 if ($ctx =~ /Wx.|.xW/) {
1990 ERROR
("spaces prohibited around that '$op' $at\n" . $hereptr);
1993 # , must have a space on the right.
1994 } elsif ($op eq ',') {
1995 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
1996 ERROR
("space required after that '$op' $at\n" . $hereptr);
1999 # '*' as part of a type definition -- reported already.
2000 } elsif ($opv eq '*_') {
2001 #warn "'*' is part of type\n";
2003 # unary operators should have a space before and
2004 # none after. May be left adjacent to another
2005 # unary operator, or a cast
2006 } elsif ($op eq '!' || $op eq '~' ||
2007 $opv eq '*U' || $opv eq '-U' ||
2008 $opv eq '&U' || $opv eq '&&U') {
2009 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
2010 ERROR
("space required before that '$op' $at\n" . $hereptr);
2012 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
2013 # A unary '*' may be const
2015 } elsif ($ctx =~ /.xW/) {
2016 ERROR
("space prohibited after that '$op' $at\n" . $hereptr);
2019 # unary ++ and unary -- are allowed no space on one side.
2020 } elsif ($op eq '++' or $op eq '--') {
2021 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
2022 ERROR
("space required one side of that '$op' $at\n" . $hereptr);
2024 if ($ctx =~ /Wx[BE]/ ||
2025 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
2026 ERROR
("space prohibited before that '$op' $at\n" . $hereptr);
2028 if ($ctx =~ /ExW/) {
2029 ERROR
("space prohibited after that '$op' $at\n" . $hereptr);
2033 # << and >> may either have or not have spaces both sides
2034 } elsif ($op eq '<<' or $op eq '>>' or
2035 $op eq '&' or $op eq '^' or $op eq '|' or
2036 $op eq '+' or $op eq '-' or
2037 $op eq '*' or $op eq '/' or
2040 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
2041 ERROR
("need consistent spacing around '$op' $at\n" .
2045 # A colon needs no spaces before when it is
2046 # terminating a case value or a label.
2047 } elsif ($opv eq ':C' || $opv eq ':L') {
2048 if ($ctx =~ /Wx./) {
2049 ERROR
("space prohibited before that '$op' $at\n" . $hereptr);
2052 # All the others need spaces both sides.
2053 } elsif ($ctx !~ /[EWC]x[CWE]/) {
2056 # Ignore email addresses <foo@bar>
2058 $cc =~ /^\S+\@\S+>/) ||
2060 $ca =~ /<\S+\@\S+$/))
2066 if (($opv eq ':O' && $ca =~ /\?$/) ||
2067 ($op eq '?' && $cc =~ /^:/)) {
2072 ERROR
("spaces required around that '$op' $at\n" . $hereptr);
2075 $off += length($elements[$n + 1]);
2079 # check for multiple assignments
2080 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
2081 CHK
("multiple assignments should be avoided\n" . $herecurr);
2084 ## # check for multiple declarations, allowing for a function declaration
2086 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
2087 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
2089 ## # Remove any bracketed sections to ensure we do not
2090 ## # falsly report the parameters of functions.
2092 ## while ($ln =~ s/\([^\(\)]*\)//g) {
2094 ## if ($ln =~ /,/) {
2095 ## WARN("declaring multiple variables together should be avoided\n" . $herecurr);
2099 #need space before brace following if, while, etc
2100 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
2102 ERROR
("space required before the open brace '{'\n" . $herecurr);
2105 # closing brace should have a space following it when it has anything
2107 if ($line =~ /}(?!(?:,|;|\)))\S/) {
2108 ERROR
("space required after that close brace '}'\n" . $herecurr);
2111 # check spacing on square brackets
2112 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
2113 ERROR
("space prohibited after that open square bracket '['\n" . $herecurr);
2115 if ($line =~ /\s\]/) {
2116 ERROR
("space prohibited before that close square bracket ']'\n" . $herecurr);
2119 # check spacing on parentheses
2120 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
2121 $line !~ /for\s*\(\s+;/) {
2122 ERROR
("space prohibited after that open parenthesis '('\n" . $herecurr);
2124 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
2125 $line !~ /for\s*\(.*;\s+\)/ &&
2126 $line !~ /:\s+\)/) {
2127 ERROR
("space prohibited before that close parenthesis ')'\n" . $herecurr);
2130 #goto labels aren't indented, allow a single space however
2131 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
2132 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
2133 WARN
("labels should not be indented\n" . $herecurr);
2136 # Return is not a function.
2137 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2141 # Flatten any parentheses
2142 $value =~ s/\)\(/\) \(/g;
2143 while ($value =~ s/\[[^\{\}]*\]/1/ ||
2144 $value !~ /(?
:$Ident|-?
$Constant)\s
*
2146 (?
:$Ident|-?
$Constant)/x
&&
2147 $value =~ s/\([^\(\)]*\)/1/) {
2150 if ($value =~ /^(?:$Ident|-?$Constant)$/) {
2151 ERROR
("return is not a function, parentheses are not required\n" . $herecurr);
2153 } elsif ($spacing !~ /\s+/) {
2154 ERROR
("space required before the open parenthesis '('\n" . $herecurr);
2158 # Need a space before open parenthesis after if, while etc
2159 if ($line=~/\b(if|while|for|switch)\(/) {
2160 ERROR
("space required before the open parenthesis '('\n" . $herecurr);
2163 # Check for illegal assignment in if conditional -- and check for trailing
2164 # statements after the conditional.
2165 if ($line =~ /do\s*(?!{)/) {
2166 my ($stat_next) = ctx_statement_block
($line_nr_next,
2167 $remain_next, $off_next);
2168 $stat_next =~ s/\n./\n /g;
2169 ##print "stat<$stat> stat_next<$stat_next>\n";
2171 if ($stat_next =~ /^\s*while\b/) {
2172 # If the statement carries leading newlines,
2173 # then count those as offsets.
2175 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2177 statement_rawlines
($whitespace) - 1;
2179 $suppress_whiletrailers{$line_nr_next +
2183 if (!defined $suppress_whiletrailers{$linenr} &&
2184 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
2185 my ($s, $c) = ($stat, $cond);
2187 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
2188 ERROR
("do not use assignment in if condition\n" . $herecurr);
2191 # Find out what is on the end of the line after the
2193 substr($s, 0, length($c), '');
2195 $s =~ s/$;//g; # Remove any comments
2196 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2197 $c !~ /}\s*while\s*/)
2199 # Find out how long the conditional actually is.
2200 my @newlines = ($c =~ /\n/gs);
2201 my $cond_lines = 1 + $#newlines;
2204 $stat_real = raw_line
($linenr, $cond_lines)
2205 . "\n" if ($cond_lines);
2206 if (defined($stat_real) && $cond_lines > 1) {
2207 $stat_real = "[...]\n$stat_real";
2210 ERROR
("trailing statements should be on next line\n" . $herecurr . $stat_real);
2214 # Check for bitwise tests written as boolean
2226 WARN
("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2229 # if and else should not have general statements after it
2230 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2232 $s =~ s/$;//g; # Remove any comments
2233 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2234 ERROR
("trailing statements should be on next line\n" . $herecurr);
2237 # if should not continue a brace
2238 if ($line =~ /}\s*if\b/) {
2239 ERROR
("trailing statements should be on next line\n" .
2242 # case and default should not have general statements after them
2243 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2245 (?
:\s
*$;*)(?
:\s
*{)?
(?
:\s
*$;*)(?
:\s
*\\)?\s
*$|
2249 ERROR
("trailing statements should be on next line\n" . $herecurr);
2252 # Check for }<nl>else {, these must be at the same
2253 # indent level to be relevant to each other.
2254 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2255 $previndent == $indent) {
2256 ERROR
("else should follow close brace '}'\n" . $hereprev);
2259 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2260 $previndent == $indent) {
2261 my ($s, $c) = ctx_statement_block
($linenr, $realcnt, 0);
2263 # Find out what is on the end of the line after the
2265 substr($s, 0, length($c), '');
2268 if ($s =~ /^\s*;/) {
2269 ERROR
("while should follow close brace '}'\n" . $hereprev);
2273 #studly caps, commented out until figure out how to distinguish between use of existing and adding new
2274 # if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2275 # print "No studly caps, use _\n";
2276 # print "$herecurr";
2280 #no spaces allowed after \ in define
2281 if ($line=~/\#\s*define.*\\\s$/) {
2282 WARN
("Whitepspace after \\ makes next lines useless\n" . $herecurr);
2285 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
2286 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
2288 my $checkfile = "include/linux/$file";
2289 if (-f
"$root/$checkfile" &&
2290 $realfile ne $checkfile &&
2293 if ($realfile =~ m{^arch/}) {
2294 CHK
("Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2296 WARN
("Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2301 # multi-statement macros should be enclosed in a do while loop, grab the
2302 # first statement and ensure its the whole macro if its not enclosed
2303 # in a known good container
2304 if ($realfile !~ m@
/vmlinux
.lds
.h
$@
&&
2305 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
2308 my ($off, $dstat, $dcond, $rest);
2311 my $args = defined($1);
2313 # Find the end of the macro and limit our statement
2315 while ($cnt > 0 && defined $lines[$ln - 1] &&
2316 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
2318 $ctx .= $rawlines[$ln - 1] . "\n";
2319 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2322 $ctx .= $rawlines[$ln - 1];
2324 ($dstat, $dcond, $ln, $cnt, $off) =
2325 ctx_statement_block
($linenr, $ln - $linenr + 1, 0);
2326 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
2327 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
2329 # Extract the remainder of the define (if any) and
2330 # rip off surrounding spaces, and trailing \'s.
2332 while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
2333 #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
2334 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
2335 $rest .= substr($lines[$ln - 1], $off) . "\n";
2341 $rest =~ s/\\\n.//g;
2345 # Clean up the original statement.
2347 substr($dstat, 0, length($dcond), '');
2349 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
2352 $dstat =~ s/\\\n.//g;
2353 $dstat =~ s/^\s*//s;
2354 $dstat =~ s/\s*$//s;
2356 # Flatten any parentheses and braces
2357 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2358 $dstat =~ s/\{[^\{\}]*\}/1/ ||
2359 $dstat =~ s/\[[^\{\}]*\]/1/)
2363 my $exceptions = qr{
2375 #print "REST<$rest> dstat<$dstat>\n";
2377 if ($rest !~ /while\s*\(/ &&
2378 $dstat !~ /$exceptions/)
2380 ERROR
("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
2383 } elsif ($ctx !~ /;/) {
2385 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2386 $dstat !~ /$exceptions/ &&
2387 $dstat !~ /^\.$Ident\s*=/ &&
2388 $dstat =~ /$Operators/)
2390 ERROR
("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
2395 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
2396 # all assignments may have only one of the following with an assignment:
2399 # VMLINUX_SYMBOL(...)
2400 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
2401 WARN
("vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
2404 # check for redundant bracing round if etc
2405 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2406 my ($level, $endln, @chunks) =
2407 ctx_statement_full
($linenr, $realcnt, 1);
2408 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
2409 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2410 if ($#chunks > 0 && $level == 0) {
2413 my $herectx = $here . "\n";
2414 my $ln = $linenr - 1;
2415 for my $chunk (@chunks) {
2416 my ($cond, $block) = @
{$chunk};
2418 # If the condition carries leading newlines, then count those as offsets.
2419 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2420 my $offset = statement_rawlines
($whitespace) - 1;
2422 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2424 # We have looked at and allowed this specific line.
2425 $suppress_ifbraces{$ln + $offset} = 1;
2427 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
2428 $ln += statement_rawlines
($block) - 1;
2430 substr($block, 0, length($cond), '');
2432 $seen++ if ($block =~ /^\s*{/);
2434 #print "cond<$cond> block<$block> allowed<$allowed>\n";
2435 if (statement_lines
($cond) > 1) {
2436 #print "APW: ALLOWED: cond<$cond>\n";
2439 if ($block =~/\b(?:if|for|while)\b/) {
2440 #print "APW: ALLOWED: block<$block>\n";
2443 if (statement_block_size
($block) > 1) {
2444 #print "APW: ALLOWED: lines block<$block>\n";
2448 if ($seen && !$allowed) {
2449 WARN
("braces {} are not necessary for any arm of this statement\n" . $herectx);
2453 if (!defined $suppress_ifbraces{$linenr - 1} &&
2454 $line =~ /\b(if|while|for|else)\b/) {
2457 # Check the pre-context.
2458 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2459 #print "APW: ALLOWED: pre<$1>\n";
2463 my ($level, $endln, @chunks) =
2464 ctx_statement_full
($linenr, $realcnt, $-[0]);
2466 # Check the condition.
2467 my ($cond, $block) = @
{$chunks[0]};
2468 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
2469 if (defined $cond) {
2470 substr($block, 0, length($cond), '');
2472 if (statement_lines
($cond) > 1) {
2473 #print "APW: ALLOWED: cond<$cond>\n";
2476 if ($block =~/\b(?:if|for|while)\b/) {
2477 #print "APW: ALLOWED: block<$block>\n";
2480 if (statement_block_size
($block) > 1) {
2481 #print "APW: ALLOWED: lines block<$block>\n";
2484 # Check the post-context.
2485 if (defined $chunks[1]) {
2486 my ($cond, $block) = @
{$chunks[1]};
2487 if (defined $cond) {
2488 substr($block, 0, length($cond), '');
2490 if ($block =~ /^\s*\{/) {
2491 #print "APW: ALLOWED: chunk-1 block<$block>\n";
2495 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
2496 my $herectx = $here . "\n";;
2497 my $cnt = statement_rawlines
($block);
2499 for (my $n = 0; $n < $cnt; $n++) {
2500 $herectx .= raw_line
($linenr, $n) . "\n";;
2503 WARN
("braces {} are not necessary for single statement blocks\n" . $herectx);
2507 # don't include deprecated include files (uses RAW line)
2508 for my $inc (@dep_includes) {
2509 if ($rawline =~ m@
^.\s
*\#\s
*include\s
*\
<$inc>@
) {
2510 ERROR
("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2514 # don't use deprecated functions
2515 for my $func (@dep_functions) {
2516 if ($line =~ /\b$func\b/) {
2517 ERROR
("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2521 # no volatiles please
2522 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2523 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
2524 WARN
("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
2527 # SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
2528 if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
2529 ERROR
("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
2533 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
2534 CHK
("if this code is redundant consider removing it\n" .
2538 # check for needless kfree() checks
2539 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2541 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
2542 WARN
("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
2545 # check for needless usb_free_urb() checks
2546 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2548 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
2549 WARN
("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
2553 # warn about #ifdefs in C files
2554 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
2555 # print "#ifdef in C files should be avoided\n";
2556 # print "$herecurr";
2560 # warn about spacing in #ifdefs
2561 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
2562 ERROR
("exactly one space required after that #$1\n" . $herecurr);
2565 # check for spinlock_t definitions without a comment.
2566 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
2567 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
2569 if (!ctx_has_comment
($first_line, $linenr)) {
2570 CHK
("$1 definition without comment\n" . $herecurr);
2573 # check for memory barriers without a comment.
2574 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2575 if (!ctx_has_comment
($first_line, $linenr)) {
2576 CHK
("memory barrier without comment\n" . $herecurr);
2579 # check of hardware specific defines
2580 if ($line =~ m@
^.\s
*\#\s
*if.*\b(__i386__
|__powerpc64__
|__sun__
|__s390x__
)\b@
&& $realfile !~ m
@include/asm
-@
) {
2581 CHK
("architecture specific defines should be avoided\n" . $herecurr);
2584 # check the location of the inline attribute, that it is between
2585 # storage class and type.
2586 if ($line =~ /\b$Type\s+$Inline\b/ ||
2587 $line =~ /\b$Inline\s+$Storage\b/) {
2588 ERROR
("inline keyword should sit between storage class and type\n" . $herecurr);
2591 # Check for __inline__ and __inline, prefer inline
2592 if ($line =~ /\b(__inline__|__inline)\b/) {
2593 WARN
("plain inline is preferred over $1\n" . $herecurr);
2596 # check for sizeof(&)
2597 if ($line =~ /\bsizeof\s*\(\s*\&/) {
2598 WARN
("sizeof(& should be avoided\n" . $herecurr);
2601 # check for new externs in .c files.
2602 if ($realfile =~ /\.c$/ && defined $stat &&
2603 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
2605 my $function_name = $1;
2606 my $paren_space = $2;
2609 if (defined $cond) {
2610 substr($s, 0, length($cond), '');
2612 if ($s =~ /^\s*;/ &&
2613 $function_name ne 'uninitialized_var')
2615 WARN
("externs should be avoided in .c files\n" . $herecurr);
2618 if ($paren_space =~ /\n/) {
2619 WARN
("arguments for function declarations should follow identifier\n" . $herecurr);
2622 } elsif ($realfile =~ /\.c$/ && defined $stat &&
2623 $stat =~ /^.\s*extern\s+/)
2625 WARN
("externs should be avoided in .c files\n" . $herecurr);
2628 # checks for new __setup's
2629 if ($rawline =~ /\b__setup\("([^"]*)"/) {
2632 if (!grep(/$name/, @setup_docs)) {
2633 CHK
("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
2637 # check for pointless casting of kmalloc return
2638 if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
2639 WARN
("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
2642 # check for gcc specific __FUNCTION__
2643 if ($line =~ /__FUNCTION__/) {
2644 WARN
("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
2647 # check for semaphores used as mutexes
2648 if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
2649 WARN
("mutexes are preferred for single holder semaphores\n" . $herecurr);
2651 # check for semaphores used as mutexes
2652 if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
2653 WARN
("consider using a completion\n" . $herecurr);
2655 # recommend strict_strto* over simple_strto*
2656 if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2657 WARN
("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
2659 # check for __initcall(), use device_initcall() explicitly please
2660 if ($line =~ /^.\s*__initcall\s*\(/) {
2661 WARN
("please use device_initcall() instead of __initcall()\n" . $herecurr);
2663 # check for various ops structs, ensure they are const.
2664 my $struct_ops = qr{acpi_dock_ops
|
2665 address_space_operations
|
2667 block_device_operations
|
2672 file_lock_operations
|
2682 lock_manager_operations
|
2688 pipe_buf_operations
|
2689 platform_hibernation_ops
|
2690 platform_suspend_ops
|
2695 soc_pcmcia_socket_ops
|
2701 if ($line !~ /\bconst\b/ &&
2702 $line =~ /\bstruct\s+($struct_ops)\b/) {
2703 WARN
("struct $1 should normally be const\n" .
2707 # use of NR_CPUS is usually wrong
2708 # ignore definitions of NR_CPUS and usage to define arrays as likely right
2709 if ($line =~ /\bNR_CPUS\b/ &&
2710 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
2711 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
2712 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
2713 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
2714 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
2716 WARN
("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
2719 # check for %L{u,d,i} in strings
2721 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2722 $string = substr($rawline, $-[1], $+[1] - $-[1]);
2723 $string =~ s/%%/__/g;
2724 if ($string =~ /(?<!%)%L[udi]/) {
2725 WARN
("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2730 # whine mightly about in_atomic
2731 if ($line =~ /\bin_atomic\s*\(/) {
2732 if ($realfile =~ m@
^drivers
/@
) {
2733 ERROR
("do not use in_atomic in drivers\n" . $herecurr);
2734 } elsif ($realfile !~ m@
^kernel
/@
) {
2735 WARN
("use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
2740 # If we have no input at all, then there is nothing to report on
2741 # so just keep quiet.
2742 if ($#rawlines == -1) {
2746 # In mailback mode only produce a report in the negative, for
2747 # things that appear to be patches.
2748 if ($mailback && ($clean == 1 || !$is_patch)) {
2752 # This is not a patch, and we are are in 'no-patch' mode so
2754 if (!$chk_patch && !$is_patch) {
2759 ERROR
("Does not appear to be a unified-diff format patch\n");
2761 if ($is_patch && $chk_signoff && $signoff == 0) {
2762 ERROR
("Missing Signed-off-by: line(s)\n");
2765 print report_dump
();
2766 if ($summary && !($clean == 1 && $quiet == 1)) {
2767 print "$filename " if ($summary_file);
2768 print "total: $cnt_error errors, $cnt_warn warnings, " .
2769 (($check)?
"$cnt_chk checks, " : "") .
2770 "$cnt_lines lines checked\n";
2771 print "\n" if ($quiet == 0);
2774 if ($clean == 1 && $quiet == 0) {
2775 print "$vname has no obvious style problems and is ready for submission.\n"
2777 if ($clean == 0 && $quiet == 0) {
2778 print "$vname has style problems, please review. If any of these errors\n";
2779 print "are false positives report them to the maintainer, see\n";
2780 print "CHECKPATCH in MAINTAINERS.\n";