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}';";
106 my $rpt_cleaners = 0;
115 if (!top_of_kernel_tree
($root)) {
116 die "$P: $root: --root does not point at a valid tree\n";
119 if (top_of_kernel_tree
('.')) {
121 } elsif ($0 =~ m@
(.*)/scripts/[^/]*$@
&&
122 top_of_kernel_tree
($1)) {
127 if (!defined $root) {
128 print "Must be run from the top-level dir. of a kernel tree\n";
133 my $emitted_corrupt = 0;
136 [A
-Za
-z_
][A
-Za
-z\d_
]*
137 (?
:\s
*\#\#\s
*[A
-Za
-z_
][A
-Za
-z\d_
]*)*
139 our $Storage = qr{extern|static|asmlinkage};
151 # Notes to $Attribute:
152 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
157 __
(?
:mem
|cpu
|dev
|)(?
:initdata
|initconst
|init
\b)|
158 ____cacheline_aligned
|
159 ____cacheline_aligned_in_smp
|
160 ____cacheline_internodealigned_in_smp
|
164 our $Inline = qr{inline|__always_inline|noinline};
165 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
166 our $Lval = qr{$Ident(?:$Member)*};
168 our $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
169 our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
170 our $Compare = qr{<=|>=|==|!=|<|>};
174 &&|\
|\
||,|\
^|\
+\
+|--|&|\
||\
+|-|\
*|\
/|%
182 [\x09\x0A\x0D\x20-\x7E] # ASCII
183 | [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
184 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
185 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
186 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
187 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
188 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
189 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
192 our $typeTypedefs = qr{(?x
:
193 (?
:__
)?
(?
:u
|s
|be
|le)(?
:8|16|32|64)|
197 our $logFunctions = qr{(?x
:
199 pr_
(debug
|dbg
|vdbg
|devel
|info
|warning
|err
|notice
|alert
|crit
|emerg
|cont
)|
200 (dev
|netdev
|netif
)_
(printk
|dbg
|vdbg
|info
|warn|err
|notice
|alert
|crit
|emerg
|WARN
)|
207 qr{(?:unsigned\s+)?char},
208 qr{(?:unsigned\s+)?short},
209 qr{(?:unsigned\s+)?int},
210 qr{(?:unsigned\s+)?long},
211 qr{(?:unsigned\s+)?long\s+int},
212 qr{(?:unsigned\s+)?long\s+long},
213 qr{(?:unsigned\s+)?long\s+long\s+int},
222 qr{${Ident}_handler
},
223 qr{${Ident}_handler_fn
},
225 our @modifierList = (
229 our $allowed_asm_includes = qr{(?x
:
233 # memory.h: ARM has a custom one
236 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
237 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
238 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
240 (?
:$Modifier\s
+|const\s
+)*
242 (?
:typeof
|__typeof__
)\s
*\
(\s
*\
**\s
*$Ident\s
*\
)|
246 (?
:\s
+$Modifier|\s
+const
)*
250 (?
:[\s\
*]+\s
*const
|[\s\
*]+|(?
:\s
*\
[\s
*\
])+)?
251 (?
:\s
+$Inline|\s
+$Modifier)*
253 $Declare = qr{(?:$Storage\s+)?$Type};
257 $chk_signoff = 0 if ($file);
259 my @dep_includes = ();
260 my @dep_functions = ();
261 my $removal = "Documentation/feature-removal-schedule.txt";
262 if ($tree && -f
"$root/$removal") {
263 open(my $REMOVE, '<', "$root/$removal") ||
264 die "$P: $removal: open failed - $!\n";
266 if (/^Check:\s+(.*\S)/) {
267 for my $entry (split(/[, ]+/, $1)) {
268 if ($entry =~ m
@include/(.*)@
) {
269 push(@dep_includes, $1);
271 } elsif ($entry !~ m@
/@
) {
272 push(@dep_functions, $entry);
283 for my $filename (@ARGV) {
286 open($FILE, '-|', "diff -u /dev/null $filename") ||
287 die "$P: $filename: diff failed - $!\n";
288 } elsif ($filename eq '-') {
289 open($FILE, '<&STDIN');
291 open($FILE, '<', "$filename") ||
292 die "$P: $filename: open failed - $!\n";
294 if ($filename eq '-') {
295 $vname = 'Your patch';
304 if (!process
($filename)) {
313 sub top_of_kernel_tree
{
317 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
318 "README", "Documentation", "arch", "include", "drivers",
319 "fs", "init", "ipc", "kernel", "lib", "scripts",
322 foreach my $check (@tree_check) {
323 if (! -e
$root . '/' . $check) {
335 for my $c (split(//, $str)) {
339 for (; ($n % 8) != 0; $n++) {
351 (my $res = shift) =~ tr/\t/ /c;
358 # Drop the diff line leader and expand tabs
360 $line = expand_tabs
($line);
362 # Pick the indent from the front of the line.
363 my ($white) = ($line =~ /^(\s*)/);
365 return (length($line), length($white));
368 my $sanitise_quote = '';
370 sub sanitise_line_reset
{
371 my ($in_comment) = @_;
374 $sanitise_quote = '*/';
376 $sanitise_quote = '';
389 # Always copy over the diff marker.
390 $res = substr($line, 0, 1);
392 for ($off = 1; $off < length($line); $off++) {
393 $c = substr($line, $off, 1);
395 # Comments we are wacking completly including the begin
396 # and end, all to $;.
397 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
398 $sanitise_quote = '*/';
400 substr($res, $off, 2, "$;$;");
404 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
405 $sanitise_quote = '';
406 substr($res, $off, 2, "$;$;");
410 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
411 $sanitise_quote = '//';
413 substr($res, $off, 2, $sanitise_quote);
418 # A \ in a string means ignore the next character.
419 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
421 substr($res, $off, 2, 'XX');
426 if ($c eq "'" || $c eq '"') {
427 if ($sanitise_quote eq '') {
428 $sanitise_quote = $c;
430 substr($res, $off, 1, $c);
432 } elsif ($sanitise_quote eq $c) {
433 $sanitise_quote = '';
437 #print "c<$c> SQ<$sanitise_quote>\n";
438 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
439 substr($res, $off, 1, $;);
440 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
441 substr($res, $off, 1, $;);
442 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
443 substr($res, $off, 1, 'X');
445 substr($res, $off, 1, $c);
449 if ($sanitise_quote eq '//') {
450 $sanitise_quote = '';
453 # The pathname on a #include may be surrounded by '<' and '>'.
454 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
455 my $clean = 'X' x
length($1);
456 $res =~ s@\
<.*\
>@
<$clean>@
;
458 # The whole of a #error is a string.
459 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
460 my $clean = 'X' x
length($1);
461 $res =~ s@
(\#\s
*(?
:error
|warning
)\s
+).*@
$1$clean@
;
467 sub ctx_statement_block
{
468 my ($linenr, $remain, $off) = @_;
469 my $line = $linenr - 1;
486 @stack = (['', 0]) if ($#stack == -1);
488 #warn "CSB: blk<$blk> remain<$remain>\n";
489 # If we are about to drop off the end, pull in more
492 for (; $remain > 0; $line++) {
493 last if (!defined $lines[$line]);
494 next if ($lines[$line] =~ /^-/);
497 $blk .= $lines[$line] . "\n";
502 # Bail if there is no further context.
503 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
509 $c = substr($blk, $off, 1);
510 $remainder = substr($blk, $off);
512 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
514 # Handle nested #if/#else.
515 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
516 push(@stack, [ $type, $level ]);
517 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
518 ($type, $level) = @
{$stack[$#stack - 1]};
519 } elsif ($remainder =~ /^#\s*endif\b/) {
520 ($type, $level) = @
{pop(@stack)};
523 # Statement ends at the ';' or a close '}' at the
525 if ($level == 0 && $c eq ';') {
529 # An else is really a conditional as long as its not else if
530 if ($level == 0 && $coff_set == 0 &&
531 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
532 $remainder =~ /^(else)(?:\s|{)/ &&
533 $remainder !~ /^else\s+if\b/) {
534 $coff = $off + length($1) - 1;
536 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
537 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
540 if (($type eq '' || $type eq '(') && $c eq '(') {
544 if ($type eq '(' && $c eq ')') {
546 $type = ($level != 0)?
'(' : '';
548 if ($level == 0 && $coff < $soff) {
551 #warn "CSB: mark coff<$coff>\n";
554 if (($type eq '' || $type eq '{') && $c eq '{') {
558 if ($type eq '{' && $c eq '}') {
560 $type = ($level != 0)?
'{' : '';
563 if (substr($blk, $off + 1, 1) eq ';') {
571 # We are truly at the end, so shuffle to the next line.
578 my $statement = substr($blk, $soff, $off - $soff + 1);
579 my $condition = substr($blk, $soff, $coff - $soff + 1);
581 #warn "STATEMENT<$statement>\n";
582 #warn "CONDITION<$condition>\n";
584 #print "coff<$coff> soff<$off> loff<$loff>\n";
586 return ($statement, $condition,
587 $line, $remain + 1, $off - $loff + 1, $level);
590 sub statement_lines
{
593 # Strip the diff line prefixes and rip blank lines at start and end.
594 $stmt =~ s/(^|\n)./$1/g;
598 my @stmt_lines = ($stmt =~ /\n/g);
600 return $#stmt_lines + 2;
603 sub statement_rawlines
{
606 my @stmt_lines = ($stmt =~ /\n/g);
608 return $#stmt_lines + 2;
611 sub statement_block_size
{
614 $stmt =~ s/(^|\n)./$1/g;
620 my @stmt_lines = ($stmt =~ /\n/g);
621 my @stmt_statements = ($stmt =~ /;/g);
623 my $stmt_lines = $#stmt_lines + 2;
624 my $stmt_statements = $#stmt_statements + 1;
626 if ($stmt_lines > $stmt_statements) {
629 return $stmt_statements;
633 sub ctx_statement_full
{
634 my ($linenr, $remain, $off) = @_;
635 my ($statement, $condition, $level);
639 # Grab the first conditional/block pair.
640 ($statement, $condition, $linenr, $remain, $off, $level) =
641 ctx_statement_block
($linenr, $remain, $off);
642 #print "F: c<$condition> s<$statement> remain<$remain>\n";
643 push(@chunks, [ $condition, $statement ]);
644 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
645 return ($level, $linenr, @chunks);
648 # Pull in the following conditional/block pairs and see if they
649 # could continue the statement.
651 ($statement, $condition, $linenr, $remain, $off, $level) =
652 ctx_statement_block
($linenr, $remain, $off);
653 #print "C: c<$condition> s<$statement> remain<$remain>\n";
654 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
656 push(@chunks, [ $condition, $statement ]);
659 return ($level, $linenr, @chunks);
663 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
665 my $start = $linenr - 1;
672 my @stack = ($level);
673 for ($line = $start; $remain > 0; $line++) {
674 next if ($rawlines[$line] =~ /^-/);
677 $blk .= $rawlines[$line];
679 # Handle nested #if/#else.
680 if ($rawlines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
681 push(@stack, $level);
682 } elsif ($rawlines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
683 $level = $stack[$#stack - 1];
684 } elsif ($rawlines[$line] =~ /^.\s*#\s*endif\b/) {
685 $level = pop(@stack);
688 foreach my $c (split(//, $rawlines[$line])) {
689 ##print "C<$c>L<$level><$open$close>O<$off>\n";
695 if ($c eq $close && $level > 0) {
697 last if ($level == 0);
698 } elsif ($c eq $open) {
703 if (!$outer || $level <= 1) {
704 push(@res, $rawlines[$line]);
707 last if ($level == 0);
710 return ($level, @res);
712 sub ctx_block_outer
{
713 my ($linenr, $remain) = @_;
715 my ($level, @r) = ctx_block_get
($linenr, $remain, 1, '{', '}', 0);
719 my ($linenr, $remain) = @_;
721 my ($level, @r) = ctx_block_get
($linenr, $remain, 0, '{', '}', 0);
725 my ($linenr, $remain, $off) = @_;
727 my ($level, @r) = ctx_block_get
($linenr, $remain, 0, '(', ')', $off);
730 sub ctx_block_level
{
731 my ($linenr, $remain) = @_;
733 return ctx_block_get
($linenr, $remain, 0, '{', '}', 0);
735 sub ctx_statement_level
{
736 my ($linenr, $remain, $off) = @_;
738 return ctx_block_get
($linenr, $remain, 0, '(', ')', $off);
741 sub ctx_locate_comment
{
742 my ($first_line, $end_line) = @_;
744 # Catch a comment on the end of the line itself.
745 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@
.*(/\*.*\*/)\s
*(?
:\\\s
*)?
$@
);
746 return $current_comment if (defined $current_comment);
748 # Look through the context and try and figure out if there is a
751 $current_comment = '';
752 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
753 my $line = $rawlines[$linenr - 1];
755 if ($linenr == $first_line and $line =~ m@
^.\s
*\
*@
) {
758 if ($line =~ m@
/\
*@
) {
761 if (!$in_comment && $current_comment ne '') {
762 $current_comment = '';
764 $current_comment .= $line . "\n" if ($in_comment);
765 if ($line =~ m@\
*/@
) {
770 chomp($current_comment);
771 return($current_comment);
773 sub ctx_has_comment
{
774 my ($first_line, $end_line) = @_;
775 my $cmt = ctx_locate_comment
($first_line, $end_line);
777 ##print "LINE: $rawlines[$end_line - 1 ]\n";
778 ##print "CMMT: $cmt\n";
784 my ($linenr, $cnt) = @_;
786 my $offset = $linenr - 1;
791 $line = $rawlines[$offset++];
792 next if (defined($line) && $line =~ /^-/);
804 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
807 $coded = sprintf("^%c", unpack('C', $2) + 64);
816 my $av_preprocessor = 0;
822 $av_preprocessor = 0;
824 @av_paren_type = ('E');
825 $av_pend_colon = 'O';
828 sub annotate_values
{
829 my ($stream, $type) = @_;
832 my $var = '_' x
length($stream);
835 print "$stream\n" if ($dbg_values > 1);
837 while (length($cur)) {
838 @av_paren_type = ('E') if ($#av_paren_type < 0);
839 print " <" . join('', @av_paren_type) .
840 "> <$type> <$av_pending>" if ($dbg_values > 1);
841 if ($cur =~ /^(\s+)/o) {
842 print "WS($1)\n" if ($dbg_values > 1);
843 if ($1 =~ /\n/ && $av_preprocessor) {
844 $type = pop(@av_paren_type);
845 $av_preprocessor = 0;
848 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/) {
849 print "CAST($1)\n" if ($dbg_values > 1);
850 push(@av_paren_type, $type);
853 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
854 print "DECLARE($1)\n" if ($dbg_values > 1);
857 } elsif ($cur =~ /^($Modifier)\s*/) {
858 print "MODIFIER($1)\n" if ($dbg_values > 1);
861 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
862 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
863 $av_preprocessor = 1;
864 push(@av_paren_type, $type);
870 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
871 print "UNDEF($1)\n" if ($dbg_values > 1);
872 $av_preprocessor = 1;
873 push(@av_paren_type, $type);
875 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
876 print "PRE_START($1)\n" if ($dbg_values > 1);
877 $av_preprocessor = 1;
879 push(@av_paren_type, $type);
880 push(@av_paren_type, $type);
883 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
884 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
885 $av_preprocessor = 1;
887 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
891 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
892 print "PRE_END($1)\n" if ($dbg_values > 1);
894 $av_preprocessor = 1;
896 # Assume all arms of the conditional end as this
897 # one does, and continue as if the #endif was not here.
899 push(@av_paren_type, $type);
902 } elsif ($cur =~ /^(\\\n)/o) {
903 print "PRECONT($1)\n" if ($dbg_values > 1);
905 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
906 print "ATTR($1)\n" if ($dbg_values > 1);
910 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
911 print "SIZEOF($1)\n" if ($dbg_values > 1);
917 } elsif ($cur =~ /^(if|while|for)\b/o) {
918 print "COND($1)\n" if ($dbg_values > 1);
922 } elsif ($cur =~/^(case)/o) {
923 print "CASE($1)\n" if ($dbg_values > 1);
924 $av_pend_colon = 'C';
927 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
928 print "KEYWORD($1)\n" if ($dbg_values > 1);
931 } elsif ($cur =~ /^(\()/o) {
932 print "PAREN('$1')\n" if ($dbg_values > 1);
933 push(@av_paren_type, $av_pending);
937 } elsif ($cur =~ /^(\))/o) {
938 my $new_type = pop(@av_paren_type);
939 if ($new_type ne '_') {
941 print "PAREN('$1') -> $type\n"
942 if ($dbg_values > 1);
944 print "PAREN('$1')\n" if ($dbg_values > 1);
947 } elsif ($cur =~ /^($Ident)\s*\(/o) {
948 print "FUNC($1)\n" if ($dbg_values > 1);
952 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
953 if (defined $2 && $type eq 'C' || $type eq 'T') {
954 $av_pend_colon = 'B';
955 } elsif ($type eq 'E') {
956 $av_pend_colon = 'L';
958 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
961 } elsif ($cur =~ /^($Ident|$Constant)/o) {
962 print "IDENT($1)\n" if ($dbg_values > 1);
965 } elsif ($cur =~ /^($Assignment)/o) {
966 print "ASSIGN($1)\n" if ($dbg_values > 1);
969 } elsif ($cur =~/^(;|{|})/) {
970 print "END($1)\n" if ($dbg_values > 1);
972 $av_pend_colon = 'O';
974 } elsif ($cur =~/^(,)/) {
975 print "COMMA($1)\n" if ($dbg_values > 1);
978 } elsif ($cur =~ /^(\?)/o) {
979 print "QUESTION($1)\n" if ($dbg_values > 1);
982 } elsif ($cur =~ /^(:)/o) {
983 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
985 substr($var, length($res), 1, $av_pend_colon);
986 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
991 $av_pend_colon = 'O';
993 } elsif ($cur =~ /^(\[)/o) {
994 print "CLOSE($1)\n" if ($dbg_values > 1);
997 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1000 print "OPV($1)\n" if ($dbg_values > 1);
1007 substr($var, length($res), 1, $variant);
1010 } elsif ($cur =~ /^($Operators)/o) {
1011 print "OP($1)\n" if ($dbg_values > 1);
1012 if ($1 ne '++' && $1 ne '--') {
1016 } elsif ($cur =~ /(^.)/o) {
1017 print "C($1)\n" if ($dbg_values > 1);
1020 $cur = substr($cur, length($1));
1021 $res .= $type x
length($1);
1025 return ($res, $var);
1029 my ($possible, $line) = @_;
1030 my $notPermitted = qr{(?
:
1045 ^(?
:typedef
|struct
|enum
)\b
1047 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1048 if ($possible !~ $notPermitted) {
1049 # Check for modifiers.
1050 $possible =~ s/\s*$Storage\s*//g;
1051 $possible =~ s/\s*$Sparse\s*//g;
1052 if ($possible =~ /^\s*$/) {
1054 } elsif ($possible =~ /\s/) {
1055 $possible =~ s/\s*$Type\s*//g;
1056 for my $modifier (split(' ', $possible)) {
1057 if ($modifier !~ $notPermitted) {
1058 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1059 push(@modifierList, $modifier);
1064 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1065 push(@typeList, $possible);
1069 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1076 if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
1079 my $line = $prefix . $_[0];
1081 $line = (split('\n', $line))[0] . "\n" if ($terse);
1083 push(our @report, $line);
1091 if (report
("ERROR: $_[0]\n")) {
1097 if (report
("WARNING: $_[0]\n")) {
1103 if ($check && report
("CHECK: $_[0]\n")) {
1109 sub check_absolute_file
{
1110 my ($absolute, $herecurr) = @_;
1111 my $file = $absolute;
1113 ##print "absolute<$absolute>\n";
1115 # See if any suffix of this path is a path within the tree.
1116 while ($file =~ s@
^[^/]*/@@
) {
1117 if (-f
"$root/$file") {
1118 ##print "file<$file>\n";
1126 # It is, so see if the prefix is acceptable.
1127 my $prefix = $absolute;
1128 substr($prefix, -length($file)) = '';
1130 ##print "prefix<$prefix>\n";
1131 if ($prefix ne ".../") {
1132 WARN
("use relative pathname instead of absolute in changelog text\n" . $herecurr);
1137 my $filename = shift;
1143 my $stashrawline="";
1160 # Trace the real file/line as we go.
1166 my $comment_edge = 0;
1170 my $prev_values = 'E';
1173 my %suppress_ifbraces;
1174 my %suppress_whiletrailers;
1175 my %suppress_export;
1177 # Pre-scan the patch sanitizing the lines.
1178 # Pre-scan the patch looking for any __setup documentation.
1180 my @setup_docs = ();
1183 sanitise_line_reset
();
1185 foreach my $rawline (@rawlines) {
1189 if ($rawline=~/^\+\+\+\s+(\S+)/) {
1191 if ($1 =~ m
@Documentation/kernel
-parameters
.txt
$@
) {
1196 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1205 # Guestimate if this is a continuing comment. Run
1206 # the context looking for a comment "edge". If this
1207 # edge is a close comment then we must be in a comment
1211 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1212 next if (defined $rawlines[$ln - 1] &&
1213 $rawlines[$ln - 1] =~ /^-/);
1215 #print "RAW<$rawlines[$ln - 1]>\n";
1216 last if (!defined $rawlines[$ln - 1]);
1217 if ($rawlines[$ln - 1] =~ m@
(/\*|\*/)@
&&
1218 $rawlines[$ln - 1] !~ m@
"[^"]*(?
:/\*|\*/)[^"]*"@
) {
1223 if (defined $edge && $edge eq '*/') {
1227 # Guestimate if this is a continuing comment. If this
1228 # is the start of a diff block and this line starts
1229 # ' *' then it is very likely a comment.
1230 if (!defined $edge &&
1231 $rawlines[$linenr] =~ m@
^.\s
*(?
:\
*\
*+| \
*)(?
:\s
|$)@
)
1236 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1237 sanitise_line_reset
($in_comment);
1239 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1240 # Standardise the strings and chars within the input to
1241 # simplify matching -- only bother with positive lines.
1242 $line = sanitise_line
($rawline);
1244 push(@lines, $line);
1247 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1252 #print "==>$rawline\n";
1253 #print "-->$line\n";
1255 if ($setup_docs && $line =~ /^\+/) {
1256 push(@setup_docs, $line);
1264 foreach my $line (@lines) {
1267 my $rawline = $rawlines[$linenr - 1];
1269 #extract the line range in the file after the patch is applied
1270 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1272 $first_line = $linenr + 1;
1282 %suppress_ifbraces = ();
1283 %suppress_whiletrailers = ();
1284 %suppress_export = ();
1287 # track the line number as we move through the hunk, note that
1288 # new versions of GNU diff omit the leading space on completely
1289 # blank context lines so we need to count that too.
1290 } elsif ($line =~ /^( |\+|$)/) {
1292 $realcnt-- if ($realcnt != 0);
1294 # Measure the line length and indent.
1295 ($length, $indent) = line_stats
($rawline);
1297 # Track the previous line.
1298 ($prevline, $stashline) = ($stashline, $line);
1299 ($previndent, $stashindent) = ($stashindent, $indent);
1300 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1302 #warn "line<$line>\n";
1304 } elsif ($realcnt == 1) {
1308 my $hunk_line = ($realcnt != 0);
1310 #make up the handle for any error we report on this line
1311 $prefix = "$filename:$realline: " if ($emacs && $file);
1312 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1314 $here = "#$linenr: " if (!$file);
1315 $here = "#$realline: " if ($file);
1317 # extract the filename as it passes
1318 if ($line=~/^\+\+\+\s+(\S+)/) {
1320 $realfile =~ s@
^([^/]*)/@@
;
1323 if (!$file && $tree && $p1_prefix ne '' &&
1324 -e
"$root/$p1_prefix") {
1325 WARN
("patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1328 if ($realfile =~ m@
^include
/asm/@
) {
1329 ERROR
("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1334 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
1336 my $hereline = "$here\n$rawline\n";
1337 my $herecurr = "$here\n$rawline\n";
1338 my $hereprev = "$here\n$prevrawline\n$rawline\n";
1340 $cnt_lines++ if ($realcnt != 0);
1342 #check the patch for a signoff:
1343 if ($line =~ /^\s*signed-off-by:/i) {
1344 # This is a signoff, if ugly, so do not double report.
1346 if (!($line =~ /^\s*Signed-off-by:/)) {
1347 WARN
("Signed-off-by: is the preferred form\n" .
1350 if ($line =~ /^\s*signed-off-by:\S/i) {
1351 WARN
("space required after Signed-off-by:\n" .
1356 # Check for wrappage within a valid hunk of the file
1357 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1358 ERROR
("patch seems to be corrupt (line wrapped?)\n" .
1359 $herecurr) if (!$emitted_corrupt++);
1362 # Check for absolute kernel paths.
1364 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1367 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1368 check_absolute_file
($1, $herecurr)) {
1371 check_absolute_file
($file, $herecurr);
1376 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1377 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1378 $rawline !~ m/^$UTF8*$/) {
1379 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1381 my $blank = copy_spacing
($rawline);
1382 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1383 my $hereptr = "$hereline$ptr\n";
1385 ERROR
("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1388 # ignore non-hunk lines and lines being removed
1389 next if (!$hunk_line || $line =~ /^-/);
1391 #trailing whitespace
1392 if ($line =~ /^\+.*\015/) {
1393 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
1394 ERROR
("DOS line endings\n" . $herevet);
1396 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1397 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
1398 ERROR
("trailing whitespace\n" . $herevet);
1402 # check for Kconfig help text having a real description
1403 if ($realfile =~ /Kconfig/ &&
1404 $line =~ /\+?\s*(---)?help(---)?$/) {
1406 for (my $l = $linenr; defined($lines[$l]); $l++) {
1410 next if ($f =~ /^$/);
1411 last if ($f =~ /^\s*config\s/);
1414 WARN
("please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($length < 4);
1417 # check we are in a valid source file if not then ignore this hunk
1418 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1421 if ($line =~ /^\+/ && $prevrawline !~ /\/\
*\
*/ &&
1422 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1423 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ ||
1424 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
1427 WARN
("line over 80 characters\n" . $herecurr);
1430 # check for spaces before a quoted newline
1431 if ($rawline =~ /^.*\".*\s\\n/) {
1432 WARN
("unnecessary whitespace before a quoted newline\n" . $herecurr);
1435 # check for adding lines without a newline.
1436 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1437 WARN
("adding a line without newline at end of file\n" . $herecurr);
1440 # Blackfin: use hi/lo macros
1441 if ($realfile =~ m
@arch/blackfin/.*\
.S
$@
) {
1442 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
1443 my $herevet = "$here\n" . cat_vet
($line) . "\n";
1444 ERROR
("use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
1446 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
1447 my $herevet = "$here\n" . cat_vet
($line) . "\n";
1448 ERROR
("use the HI() macro, not (... >> 16)\n" . $herevet);
1452 # check we are in a valid source file C or perl if not then ignore this hunk
1453 next if ($realfile !~ /\.(h|c|pl)$/);
1455 # at the beginning of a line any tabs must come first and anything
1456 # more than 8 must use tabs.
1457 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1458 $rawline =~ /^\+\s* \s*/) {
1459 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
1460 ERROR
("code indent should use tabs where possible\n" . $herevet);
1464 # check for space before tabs.
1465 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
1466 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
1467 WARN
("please, no space before tabs\n" . $herevet);
1470 # check for spaces at the beginning of a line.
1472 # 1) within comments
1473 # 2) indented preprocessor commands
1475 if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/) {
1476 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
1477 WARN
("please, no spaces at the start of a line\n" . $herevet);
1480 # check we are in a valid C source file if not then ignore this hunk
1481 next if ($realfile !~ /\.(h|c)$/);
1483 # check for RCS/CVS revision markers
1484 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
1485 WARN
("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1488 # Blackfin: don't use __builtin_bfin_[cs]sync
1489 if ($line =~ /__builtin_bfin_csync/) {
1490 my $herevet = "$here\n" . cat_vet
($line) . "\n";
1491 ERROR
("use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
1493 if ($line =~ /__builtin_bfin_ssync/) {
1494 my $herevet = "$here\n" . cat_vet
($line) . "\n";
1495 ERROR
("use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
1498 # Check for potential 'bare' types
1499 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
1501 if ($realcnt && $line =~ /.\s*\S/) {
1502 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
1503 ctx_statement_block
($linenr, $realcnt, 0);
1504 $stat =~ s/\n./\n /g;
1505 $cond =~ s/\n./\n /g;
1507 # Find the real next line.
1508 $realline_next = $line_nr_next;
1509 if (defined $realline_next &&
1510 (!defined $lines[$realline_next - 1] ||
1511 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
1518 # Ignore goto labels.
1519 if ($s =~ /$Ident:\*$/s) {
1521 # Ignore functions being called
1522 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
1524 } elsif ($s =~ /^.\s*else\b/s) {
1526 # declarations always start with types
1527 } 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) {
1530 possible
($type, "A:" . $s);
1532 # definitions in global scope can only start with types
1533 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
1534 possible
($1, "B:" . $s);
1537 # any (foo ... *) is a pointer cast, and foo is a type
1538 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
1539 possible
($1, "C:" . $s);
1542 # Check for any sort of function declaration.
1543 # int foo(something bar, other baz);
1544 # void (*store_gdt)(x86_descr_ptr *);
1545 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
1546 my ($name_len) = length($1);
1549 substr($ctx, 0, $name_len + 1, '');
1550 $ctx =~ s/\)[^\)]*$//;
1552 for my $arg (split(/\s*,\s*/, $ctx)) {
1553 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
1555 possible
($1, "D:" . $s);
1563 # Checks which may be anchored in the context.
1566 # Check for switch () and associated case and default
1567 # statements should be at the same indent.
1568 if ($line=~/\bswitch\s*\(.*\)/) {
1571 my @ctx = ctx_block_outer
($linenr, $realcnt);
1573 for my $ctx (@ctx) {
1574 my ($clen, $cindent) = line_stats
($ctx);
1575 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1576 $indent != $cindent) {
1577 $err .= "$sep$ctx\n";
1584 ERROR
("switch and case should be at the same indent\n$hereline$err");
1588 # if/while/etc brace do not go on next line, unless defining a do while loop,
1589 # or if that brace on the next line is for something else
1590 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
1591 my $pre_ctx = "$1$2";
1593 my ($level, @ctx) = ctx_statement_level
($linenr, $realcnt, 0);
1594 my $ctx_cnt = $realcnt - $#ctx - 1;
1595 my $ctx = join("\n", @ctx);
1597 my $ctx_ln = $linenr;
1598 my $ctx_skip = $realcnt;
1600 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1601 defined $lines[$ctx_ln - 1] &&
1602 $lines[$ctx_ln - 1] =~ /^-/)) {
1603 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1604 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
1608 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1609 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
1611 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1612 ERROR
("that open brace { should be on the previous line\n" .
1613 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1615 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1616 $ctx =~ /\)\s*\;\s*$/ &&
1617 defined $lines[$ctx_ln - 1])
1619 my ($nlength, $nindent) = line_stats
($lines[$ctx_ln - 1]);
1620 if ($nindent > $indent) {
1621 WARN
("trailing semicolon indicates no statements, indent implies otherwise\n" .
1622 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1627 # Check relative indent for conditionals and blocks.
1628 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1629 my ($s, $c) = ($stat, $cond);
1631 substr($s, 0, length($c), '');
1633 # Make sure we remove the line prefixes as we have
1634 # none on the first line, and are going to readd them
1638 # Find out how long the conditional actually is.
1639 my @newlines = ($c =~ /\n/gs);
1640 my $cond_lines = 1 + $#newlines;
1642 # We want to check the first line inside the block
1643 # starting at the end of the conditional, so remove:
1644 # 1) any blank line termination
1645 # 2) any opening brace { on end of the line
1647 my $continuation = 0;
1649 $s =~ s/^.*\bdo\b//;
1651 if ($s =~ s/^\s*\\//) {
1654 if ($s =~ s/^\s*?\n//) {
1659 # Also ignore a loop construct at the end of a
1660 # preprocessor statement.
1661 if (($prevline =~ /^.\s*#\s*define\s/ ||
1662 $prevline =~ /\\\s*$/) && $continuation == 0) {
1668 while ($cond_ptr != $cond_lines) {
1669 $cond_ptr = $cond_lines;
1671 # If we see an #else/#elif then the code
1673 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
1678 # 1) blank lines, they should be at 0,
1679 # 2) preprocessor lines, and
1681 if ($continuation ||
1683 $s =~ /^\s*#\s*?/ ||
1684 $s =~ /^\s*$Ident\s*:/) {
1685 $continuation = ($s =~ /^.*?\\\n/) ?
1 : 0;
1686 if ($s =~ s/^.*?\n//) {
1692 my (undef, $sindent) = line_stats
("+" . $s);
1693 my $stat_real = raw_line
($linenr, $cond_lines);
1695 # Check if either of these lines are modified, else
1696 # this is not this patch's fault.
1697 if (!defined($stat_real) ||
1698 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
1701 if (defined($stat_real) && $cond_lines > 1) {
1702 $stat_real = "[...]\n$stat_real";
1705 #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";
1707 if ($check && (($sindent % 8) != 0 ||
1708 ($sindent <= $indent && $s ne ''))) {
1709 WARN
("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
1713 # Track the 'values' across context and added lines.
1714 my $opline = $line; $opline =~ s/^./ /;
1715 my ($curr_values, $curr_vars) =
1716 annotate_values
($opline . "\n", $prev_values);
1717 $curr_values = $prev_values . $curr_values;
1719 my $outline = $opline; $outline =~ s/\t/ /g;
1720 print "$linenr > .$outline\n";
1721 print "$linenr > $curr_values\n";
1722 print "$linenr > $curr_vars\n";
1724 $prev_values = substr($curr_values, -1);
1726 #ignore lines not being added
1727 if ($line=~/^[^\+]/) {next;}
1729 # TEST: allow direct testing of the type matcher.
1731 if ($line =~ /^.\s*$Declare\s*$/) {
1732 ERROR
("TEST: is type\n" . $herecurr);
1733 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
1734 ERROR
("TEST: is not type ($1 is)\n". $herecurr);
1738 # TEST: allow direct testing of the attribute matcher.
1740 if ($line =~ /^.\s*$Modifier\s*$/) {
1741 ERROR
("TEST: is attr\n" . $herecurr);
1742 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
1743 ERROR
("TEST: is not attr ($1 is)\n". $herecurr);
1748 # check for initialisation to aggregates open brace on the next line
1749 if ($line =~ /^.\s*{/ &&
1750 $prevline =~ /(?:^|[^=])=\s*$/) {
1751 ERROR
("that open brace { should be on the previous line\n" . $hereprev);
1755 # Checks which are anchored on the added line.
1758 # check for malformed paths in #include statements (uses RAW line)
1759 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
1761 if ($path =~ m{//}) {
1762 ERROR
("malformed #include filename\n" .
1767 # no C99 // comments
1768 if ($line =~ m{//}) {
1769 ERROR
("do not use C99 // comments\n" . $herecurr);
1771 # Remove C99 comments.
1773 $opline =~ s@
//.*@@
;
1775 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
1776 # the whole statement.
1777 #print "APW <$lines[$realline_next - 1]>\n";
1778 if (defined $realline_next &&
1779 exists $lines[$realline_next - 1] &&
1780 !defined $suppress_export{$realline_next} &&
1781 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
1782 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1786 ^.DEFINE_
$Ident\
(\Q
$name\E\
)|
1787 ^.DECLARE_
$Ident\
(\Q
$name\E\
)|
1788 ^.LIST_HEAD\
(\Q
$name\E\
)|
1789 ^.(?
:$Storage\s
+)?
$Type\s
*\
(\s
*\
*\s
*\Q
$name\E\s
*\
)\s
*\
(|
1790 \b\Q
$name\E
(?
:\s
+$Attribute)*\s
*(?
:;|=|\
[|\
()
1792 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
1793 $suppress_export{$realline_next} = 2;
1795 $suppress_export{$realline_next} = 1;
1798 if (!defined $suppress_export{$linenr} &&
1799 $prevline =~ /^.\s*$/ &&
1800 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
1801 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1802 #print "FOO B <$lines[$linenr - 1]>\n";
1803 $suppress_export{$linenr} = 2;
1805 if (defined $suppress_export{$linenr} &&
1806 $suppress_export{$linenr} == 2) {
1807 WARN
("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
1810 # check for global initialisers.
1811 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
1812 ERROR
("do not initialise globals to 0 or NULL\n" .
1815 # check for static initialisers.
1816 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
1817 ERROR
("do not initialise statics to 0 or NULL\n" .
1821 # check for new typedefs, only function parameters and sparse annotations
1823 if ($line =~ /\btypedef\s/ &&
1824 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
1825 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
1826 $line !~ /\b$typeTypedefs\b/ &&
1827 $line !~ /\b__bitwise(?:__|)\b/) {
1828 WARN
("do not add new typedefs\n" . $herecurr);
1831 # * goes on variable not on type
1833 if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) {
1834 my ($from, $to) = ($1, $1);
1836 # Should start with a space.
1837 $to =~ s/^(\S)/ $1/;
1838 # Should not end with a space.
1840 # '*'s should not have spaces between.
1841 while ($to =~ s/\*\s+\*/\*\*/) {
1844 #print "from<$from> to<$to>\n";
1846 ERROR
("\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr);
1848 } elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) {
1849 my ($from, $to, $ident) = ($1, $1, $2);
1851 # Should start with a space.
1852 $to =~ s/^(\S)/ $1/;
1853 # Should not end with a space.
1855 # '*'s should not have spaces between.
1856 while ($to =~ s/\*\s+\*/\*\*/) {
1858 # Modifiers should have spaces.
1859 $to =~ s/(\b$Modifier$)/$1 /;
1861 #print "from<$from> to<$to> ident<$ident>\n";
1862 if ($from ne $to && $ident !~ /^$Modifier$/) {
1863 ERROR
("\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr);
1867 # # no BUG() or BUG_ON()
1868 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
1869 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
1870 # print "$herecurr";
1874 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
1875 WARN
("LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
1878 # printk should use KERN_* levels. Note that follow on printk's on the
1879 # same line do not need a level, so we use the current block context
1880 # to try and find and validate the current printk. In summary the current
1881 # printk includes all preceeding printk's which have no newline on the end.
1882 # we assume the first bad printk is the one to report.
1883 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
1885 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
1886 #print "CHECK<$lines[$ln - 1]\n";
1887 # we have a preceeding printk if it ends
1888 # with "\n" ignore it, else it is to blame
1889 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
1890 if ($rawlines[$ln - 1] !~ m{\\n"}) {
1897 WARN
("printk() should include KERN_ facility level\n" . $herecurr);
1901 # function brace can't be on same line, except for #defines of do while,
1902 # or if closed on same line
1903 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
1904 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
1905 ERROR
("open brace '{' following function declarations go on the next line\n" . $herecurr);
1908 # missing space after union or struct definition
1909 if ($rawline =~ /^\+\s*(union|struct)\s+$Ident[=\{]/) {
1910 WARN
("Missing space after struct or union definition\n" . $herecurr);
1913 # missing space after enum definition
1914 if ($rawline =~ /^\+\s*enum\{/) {
1915 WARN
("Missing space after enum definition\n" . $herecurr);
1918 # open braces for enum, union and struct go on the same line.
1919 if ($line =~ /^.\s*{/ &&
1920 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1921 ERROR
("open brace '{' following $1 go on the same line\n" . $hereprev);
1924 # check for spacing round square brackets; allowed:
1925 # 1. with a type on the left -- int [] a;
1926 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
1927 # 3. inside a curly brace -- = { [0...10] = 5 }
1928 while ($line =~ /(.*?\s)\[/g) {
1929 my ($where, $prefix) = ($-[1], $1);
1930 if ($prefix !~ /$Type\s+$/ &&
1931 ($where != 0 || $prefix !~ /^.\s+$/) &&
1932 $prefix !~ /{\s+$/) {
1933 ERROR
("space prohibited before open square bracket '['\n" . $herecurr);
1937 # check for spaces between functions and their parentheses.
1938 while ($line =~ /($Ident)\s+\(/g) {
1940 my $ctx_before = substr($line, 0, $-[1]);
1941 my $ctx = "$ctx_before$name";
1943 # Ignore those directives where spaces _are_ permitted.
1945 if|for|while|switch
|return|case
|
1946 volatile
|__volatile__
|
1947 __attribute__
|format
|__extension__
|
1951 # cpp #define statements have non-optional spaces, ie
1952 # if there is a space between the name and the open
1953 # parenthesis it is simply not a parameter group.
1954 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
1956 # cpp #elif statement condition may start with a (
1957 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
1959 # If this whole things ends with a type its most
1960 # likely a typedef for a function.
1961 } elsif ($ctx =~ /$Type$/) {
1964 WARN
("space prohibited between function name and open parenthesis '('\n" . $herecurr);
1967 # Check operator spacing.
1968 if (!($line=~/\#\s*include/)) {
1970 <<=|>>=|<=|>=|==|!=|
1971 \
+=|-=|\
*=|\
/=|%=|\
^=|\
|=|&=|
1972 =>|->|<<|>>|<|>|=|!|~|
1973 &&|\
|\
||,|\
^|\
+\
+|--|&|\
||\
+|-|\
*|\
/|%|
1976 my @elements = split(/($ops|;)/, $opline);
1979 my $blank = copy_spacing
($opline);
1981 for (my $n = 0; $n < $#elements; $n += 2) {
1982 $off += length($elements[$n]);
1984 # Pick up the preceeding and succeeding characters.
1985 my $ca = substr($opline, 0, $off);
1987 if (length($opline) >= ($off + length($elements[$n + 1]))) {
1988 $cc = substr($opline, $off + length($elements[$n + 1]));
1990 my $cb = "$ca$;$cc";
1993 $a = 'V' if ($elements[$n] ne '');
1994 $a = 'W' if ($elements[$n] =~ /\s$/);
1995 $a = 'C' if ($elements[$n] =~ /$;$/);
1996 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
1997 $a = 'O' if ($elements[$n] eq '');
1998 $a = 'E' if ($ca =~ /^\s*$/);
2000 my $op = $elements[$n + 1];
2003 if (defined $elements[$n + 2]) {
2004 $c = 'V' if ($elements[$n + 2] ne '');
2005 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
2006 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
2007 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
2008 $c = 'O' if ($elements[$n + 2] eq '');
2009 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
2014 my $ctx = "${a}x${c}";
2016 my $at = "(ctx:$ctx)";
2018 my $ptr = substr($blank, 0, $off) . "^";
2019 my $hereptr = "$hereline$ptr\n";
2021 # Pull out the value of this operator.
2022 my $op_type = substr($curr_values, $off + 1, 1);
2024 # Get the full operator variant.
2025 my $opv = $op . substr($curr_vars, $off, 1);
2027 # Ignore operators passed as parameters.
2028 if ($op_type ne 'V' &&
2029 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
2032 # } elsif ($op =~ /^$;+$/) {
2034 # ; should have either the end of line or a space or \ after it
2035 } elsif ($op eq ';') {
2036 if ($ctx !~ /.x[WEBC]/ &&
2037 $cc !~ /^\\/ && $cc !~ /^;/) {
2038 ERROR
("space required after that '$op' $at\n" . $hereptr);
2042 } elsif ($op eq '//') {
2046 # : when part of a bitfield
2047 } elsif ($op eq '->' || $opv eq ':B') {
2048 if ($ctx =~ /Wx.|.xW/) {
2049 ERROR
("spaces prohibited around that '$op' $at\n" . $hereptr);
2052 # , must have a space on the right.
2053 } elsif ($op eq ',') {
2054 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
2055 ERROR
("space required after that '$op' $at\n" . $hereptr);
2058 # '*' as part of a type definition -- reported already.
2059 } elsif ($opv eq '*_') {
2060 #warn "'*' is part of type\n";
2062 # unary operators should have a space before and
2063 # none after. May be left adjacent to another
2064 # unary operator, or a cast
2065 } elsif ($op eq '!' || $op eq '~' ||
2066 $opv eq '*U' || $opv eq '-U' ||
2067 $opv eq '&U' || $opv eq '&&U') {
2068 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
2069 ERROR
("space required before that '$op' $at\n" . $hereptr);
2071 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
2072 # A unary '*' may be const
2074 } elsif ($ctx =~ /.xW/) {
2075 ERROR
("space prohibited after that '$op' $at\n" . $hereptr);
2078 # unary ++ and unary -- are allowed no space on one side.
2079 } elsif ($op eq '++' or $op eq '--') {
2080 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
2081 ERROR
("space required one side of that '$op' $at\n" . $hereptr);
2083 if ($ctx =~ /Wx[BE]/ ||
2084 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
2085 ERROR
("space prohibited before that '$op' $at\n" . $hereptr);
2087 if ($ctx =~ /ExW/) {
2088 ERROR
("space prohibited after that '$op' $at\n" . $hereptr);
2092 # << and >> may either have or not have spaces both sides
2093 } elsif ($op eq '<<' or $op eq '>>' or
2094 $op eq '&' or $op eq '^' or $op eq '|' or
2095 $op eq '+' or $op eq '-' or
2096 $op eq '*' or $op eq '/' or
2099 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
2100 ERROR
("need consistent spacing around '$op' $at\n" .
2104 # A colon needs no spaces before when it is
2105 # terminating a case value or a label.
2106 } elsif ($opv eq ':C' || $opv eq ':L') {
2107 if ($ctx =~ /Wx./) {
2108 ERROR
("space prohibited before that '$op' $at\n" . $hereptr);
2111 # All the others need spaces both sides.
2112 } elsif ($ctx !~ /[EWC]x[CWE]/) {
2115 # Ignore email addresses <foo@bar>
2117 $cc =~ /^\S+\@\S+>/) ||
2119 $ca =~ /<\S+\@\S+$/))
2125 if (($opv eq ':O' && $ca =~ /\?$/) ||
2126 ($op eq '?' && $cc =~ /^:/)) {
2131 ERROR
("spaces required around that '$op' $at\n" . $hereptr);
2134 $off += length($elements[$n + 1]);
2138 # check for multiple assignments
2139 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
2140 CHK
("multiple assignments should be avoided\n" . $herecurr);
2143 ## # check for multiple declarations, allowing for a function declaration
2145 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
2146 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
2148 ## # Remove any bracketed sections to ensure we do not
2149 ## # falsly report the parameters of functions.
2151 ## while ($ln =~ s/\([^\(\)]*\)//g) {
2153 ## if ($ln =~ /,/) {
2154 ## WARN("declaring multiple variables together should be avoided\n" . $herecurr);
2158 #need space before brace following if, while, etc
2159 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
2161 ERROR
("space required before the open brace '{'\n" . $herecurr);
2164 # closing brace should have a space following it when it has anything
2166 if ($line =~ /}(?!(?:,|;|\)))\S/) {
2167 ERROR
("space required after that close brace '}'\n" . $herecurr);
2170 # check spacing on square brackets
2171 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
2172 ERROR
("space prohibited after that open square bracket '['\n" . $herecurr);
2174 if ($line =~ /\s\]/) {
2175 ERROR
("space prohibited before that close square bracket ']'\n" . $herecurr);
2178 # check spacing on parentheses
2179 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
2180 $line !~ /for\s*\(\s+;/) {
2181 ERROR
("space prohibited after that open parenthesis '('\n" . $herecurr);
2183 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
2184 $line !~ /for\s*\(.*;\s+\)/ &&
2185 $line !~ /:\s+\)/) {
2186 ERROR
("space prohibited before that close parenthesis ')'\n" . $herecurr);
2189 #goto labels aren't indented, allow a single space however
2190 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
2191 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
2192 WARN
("labels should not be indented\n" . $herecurr);
2195 # Return is not a function.
2196 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2200 # Flatten any parentheses
2201 $value =~ s/\(/ \(/g;
2202 $value =~ s/\)/\) /g;
2203 while ($value =~ s/\[[^\{\}]*\]/1/ ||
2204 $value !~ /(?
:$Ident|-?
$Constant)\s
*
2206 (?
:$Ident|-?
$Constant)/x
&&
2207 $value =~ s/\([^\(\)]*\)/1/) {
2209 #print "value<$value>\n";
2210 if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
2211 ERROR
("return is not a function, parentheses are not required\n" . $herecurr);
2213 } elsif ($spacing !~ /\s+/) {
2214 ERROR
("space required before the open parenthesis '('\n" . $herecurr);
2217 # Return of what appears to be an errno should normally be -'ve
2218 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
2220 if ($name ne 'EOF' && $name ne 'ERROR') {
2221 WARN
("return of an errno should typically be -ve (return -$1)\n" . $herecurr);
2225 # Need a space before open parenthesis after if, while etc
2226 if ($line=~/\b(if|while|for|switch)\(/) {
2227 ERROR
("space required before the open parenthesis '('\n" . $herecurr);
2230 # Check for illegal assignment in if conditional -- and check for trailing
2231 # statements after the conditional.
2232 if ($line =~ /do\s*(?!{)/) {
2233 my ($stat_next) = ctx_statement_block
($line_nr_next,
2234 $remain_next, $off_next);
2235 $stat_next =~ s/\n./\n /g;
2236 ##print "stat<$stat> stat_next<$stat_next>\n";
2238 if ($stat_next =~ /^\s*while\b/) {
2239 # If the statement carries leading newlines,
2240 # then count those as offsets.
2242 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2244 statement_rawlines
($whitespace) - 1;
2246 $suppress_whiletrailers{$line_nr_next +
2250 if (!defined $suppress_whiletrailers{$linenr} &&
2251 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
2252 my ($s, $c) = ($stat, $cond);
2254 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
2255 ERROR
("do not use assignment in if condition\n" . $herecurr);
2258 # Find out what is on the end of the line after the
2260 substr($s, 0, length($c), '');
2262 $s =~ s/$;//g; # Remove any comments
2263 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2264 $c !~ /}\s*while\s*/)
2266 # Find out how long the conditional actually is.
2267 my @newlines = ($c =~ /\n/gs);
2268 my $cond_lines = 1 + $#newlines;
2271 $stat_real = raw_line
($linenr, $cond_lines)
2272 . "\n" if ($cond_lines);
2273 if (defined($stat_real) && $cond_lines > 1) {
2274 $stat_real = "[...]\n$stat_real";
2277 ERROR
("trailing statements should be on next line\n" . $herecurr . $stat_real);
2281 # Check for bitwise tests written as boolean
2293 WARN
("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2296 # if and else should not have general statements after it
2297 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2299 $s =~ s/$;//g; # Remove any comments
2300 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2301 ERROR
("trailing statements should be on next line\n" . $herecurr);
2304 # if should not continue a brace
2305 if ($line =~ /}\s*if\b/) {
2306 ERROR
("trailing statements should be on next line\n" .
2309 # case and default should not have general statements after them
2310 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2312 (?
:\s
*$;*)(?
:\s
*{)?
(?
:\s
*$;*)(?
:\s
*\\)?\s
*$|
2316 ERROR
("trailing statements should be on next line\n" . $herecurr);
2319 # Check for }<nl>else {, these must be at the same
2320 # indent level to be relevant to each other.
2321 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2322 $previndent == $indent) {
2323 ERROR
("else should follow close brace '}'\n" . $hereprev);
2326 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2327 $previndent == $indent) {
2328 my ($s, $c) = ctx_statement_block
($linenr, $realcnt, 0);
2330 # Find out what is on the end of the line after the
2332 substr($s, 0, length($c), '');
2335 if ($s =~ /^\s*;/) {
2336 ERROR
("while should follow close brace '}'\n" . $hereprev);
2340 #studly caps, commented out until figure out how to distinguish between use of existing and adding new
2341 # if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2342 # print "No studly caps, use _\n";
2343 # print "$herecurr";
2347 #no spaces allowed after \ in define
2348 if ($line=~/\#\s*define.*\\\s$/) {
2349 WARN
("Whitepspace after \\ makes next lines useless\n" . $herecurr);
2352 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
2353 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
2355 my $checkfile = "include/linux/$file";
2356 if (-f
"$root/$checkfile" &&
2357 $realfile ne $checkfile &&
2358 $1 !~ /$allowed_asm_includes/)
2360 if ($realfile =~ m{^arch/}) {
2361 CHK
("Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2363 WARN
("Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2368 # multi-statement macros should be enclosed in a do while loop, grab the
2369 # first statement and ensure its the whole macro if its not enclosed
2370 # in a known good container
2371 if ($realfile !~ m@
/vmlinux
.lds
.h
$@
&&
2372 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
2375 my ($off, $dstat, $dcond, $rest);
2378 my $args = defined($1);
2380 # Find the end of the macro and limit our statement
2382 while ($cnt > 0 && defined $lines[$ln - 1] &&
2383 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
2385 $ctx .= $rawlines[$ln - 1] . "\n";
2386 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2389 $ctx .= $rawlines[$ln - 1];
2391 ($dstat, $dcond, $ln, $cnt, $off) =
2392 ctx_statement_block
($linenr, $ln - $linenr + 1, 0);
2393 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
2394 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
2396 # Extract the remainder of the define (if any) and
2397 # rip off surrounding spaces, and trailing \'s.
2399 while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
2400 #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
2401 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
2402 $rest .= substr($lines[$ln - 1], $off) . "\n";
2408 $rest =~ s/\\\n.//g;
2412 # Clean up the original statement.
2414 substr($dstat, 0, length($dcond), '');
2416 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
2419 $dstat =~ s/\\\n.//g;
2420 $dstat =~ s/^\s*//s;
2421 $dstat =~ s/\s*$//s;
2423 # Flatten any parentheses and braces
2424 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2425 $dstat =~ s/\{[^\{\}]*\}/1/ ||
2426 $dstat =~ s/\[[^\{\}]*\]/1/)
2430 my $exceptions = qr{
2442 #print "REST<$rest> dstat<$dstat>\n";
2444 if ($rest !~ /while\s*\(/ &&
2445 $dstat !~ /$exceptions/)
2447 ERROR
("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
2450 } elsif ($ctx !~ /;/) {
2452 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2453 $dstat !~ /$exceptions/ &&
2454 $dstat !~ /^\.$Ident\s*=/ &&
2455 $dstat =~ /$Operators/)
2457 ERROR
("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
2462 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
2463 # all assignments may have only one of the following with an assignment:
2466 # VMLINUX_SYMBOL(...)
2467 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
2468 WARN
("vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
2471 # check for redundant bracing round if etc
2472 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2473 my ($level, $endln, @chunks) =
2474 ctx_statement_full
($linenr, $realcnt, 1);
2475 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
2476 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2477 if ($#chunks > 0 && $level == 0) {
2480 my $herectx = $here . "\n";
2481 my $ln = $linenr - 1;
2482 for my $chunk (@chunks) {
2483 my ($cond, $block) = @
{$chunk};
2485 # If the condition carries leading newlines, then count those as offsets.
2486 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2487 my $offset = statement_rawlines
($whitespace) - 1;
2489 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2491 # We have looked at and allowed this specific line.
2492 $suppress_ifbraces{$ln + $offset} = 1;
2494 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
2495 $ln += statement_rawlines
($block) - 1;
2497 substr($block, 0, length($cond), '');
2499 $seen++ if ($block =~ /^\s*{/);
2501 #print "cond<$cond> block<$block> allowed<$allowed>\n";
2502 if (statement_lines
($cond) > 1) {
2503 #print "APW: ALLOWED: cond<$cond>\n";
2506 if ($block =~/\b(?:if|for|while)\b/) {
2507 #print "APW: ALLOWED: block<$block>\n";
2510 if (statement_block_size
($block) > 1) {
2511 #print "APW: ALLOWED: lines block<$block>\n";
2515 if ($seen && !$allowed) {
2516 WARN
("braces {} are not necessary for any arm of this statement\n" . $herectx);
2520 if (!defined $suppress_ifbraces{$linenr - 1} &&
2521 $line =~ /\b(if|while|for|else)\b/) {
2524 # Check the pre-context.
2525 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2526 #print "APW: ALLOWED: pre<$1>\n";
2530 my ($level, $endln, @chunks) =
2531 ctx_statement_full
($linenr, $realcnt, $-[0]);
2533 # Check the condition.
2534 my ($cond, $block) = @
{$chunks[0]};
2535 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
2536 if (defined $cond) {
2537 substr($block, 0, length($cond), '');
2539 if (statement_lines
($cond) > 1) {
2540 #print "APW: ALLOWED: cond<$cond>\n";
2543 if ($block =~/\b(?:if|for|while)\b/) {
2544 #print "APW: ALLOWED: block<$block>\n";
2547 if (statement_block_size
($block) > 1) {
2548 #print "APW: ALLOWED: lines block<$block>\n";
2551 # Check the post-context.
2552 if (defined $chunks[1]) {
2553 my ($cond, $block) = @
{$chunks[1]};
2554 if (defined $cond) {
2555 substr($block, 0, length($cond), '');
2557 if ($block =~ /^\s*\{/) {
2558 #print "APW: ALLOWED: chunk-1 block<$block>\n";
2562 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
2563 my $herectx = $here . "\n";;
2564 my $cnt = statement_rawlines
($block);
2566 for (my $n = 0; $n < $cnt; $n++) {
2567 $herectx .= raw_line
($linenr, $n) . "\n";;
2570 WARN
("braces {} are not necessary for single statement blocks\n" . $herectx);
2574 # don't include deprecated include files (uses RAW line)
2575 for my $inc (@dep_includes) {
2576 if ($rawline =~ m@
^.\s
*\#\s
*include\s
*\
<$inc>@
) {
2577 ERROR
("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2581 # don't use deprecated functions
2582 for my $func (@dep_functions) {
2583 if ($line =~ /\b$func\b/) {
2584 ERROR
("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2588 # no volatiles please
2589 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2590 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
2591 WARN
("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
2594 # SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
2595 if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
2596 ERROR
("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
2600 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
2601 CHK
("if this code is redundant consider removing it\n" .
2605 # check for needless kfree() checks
2606 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2608 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
2609 WARN
("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
2612 # check for needless usb_free_urb() checks
2613 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2615 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
2616 WARN
("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
2620 # prefer usleep_range over udelay
2621 if ($line =~ /\budelay\s*\(\s*(\w+)\s*\)/) {
2622 # ignore udelay's < 10, however
2623 if (! (($1 =~ /(\d+)/) && ($1 < 10)) ) {
2624 CHK
("usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
2628 # warn about unexpectedly long msleep's
2629 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
2631 WARN
("msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
2635 # warn about #ifdefs in C files
2636 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
2637 # print "#ifdef in C files should be avoided\n";
2638 # print "$herecurr";
2642 # warn about spacing in #ifdefs
2643 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
2644 ERROR
("exactly one space required after that #$1\n" . $herecurr);
2647 # check for spinlock_t definitions without a comment.
2648 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
2649 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
2651 if (!ctx_has_comment
($first_line, $linenr)) {
2652 CHK
("$1 definition without comment\n" . $herecurr);
2655 # check for memory barriers without a comment.
2656 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2657 if (!ctx_has_comment
($first_line, $linenr)) {
2658 CHK
("memory barrier without comment\n" . $herecurr);
2661 # check of hardware specific defines
2662 if ($line =~ m@
^.\s
*\#\s
*if.*\b(__i386__
|__powerpc64__
|__sun__
|__s390x__
)\b@
&& $realfile !~ m
@include/asm
-@
) {
2663 CHK
("architecture specific defines should be avoided\n" . $herecurr);
2666 # Check that the storage class is at the beginning of a declaration
2667 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
2668 WARN
("storage class should be at the beginning of the declaration\n" . $herecurr)
2671 # check the location of the inline attribute, that it is between
2672 # storage class and type.
2673 if ($line =~ /\b$Type\s+$Inline\b/ ||
2674 $line =~ /\b$Inline\s+$Storage\b/) {
2675 ERROR
("inline keyword should sit between storage class and type\n" . $herecurr);
2678 # Check for __inline__ and __inline, prefer inline
2679 if ($line =~ /\b(__inline__|__inline)\b/) {
2680 WARN
("plain inline is preferred over $1\n" . $herecurr);
2683 # check for sizeof(&)
2684 if ($line =~ /\bsizeof\s*\(\s*\&/) {
2685 WARN
("sizeof(& should be avoided\n" . $herecurr);
2688 # check for new externs in .c files.
2689 if ($realfile =~ /\.c$/ && defined $stat &&
2690 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
2692 my $function_name = $1;
2693 my $paren_space = $2;
2696 if (defined $cond) {
2697 substr($s, 0, length($cond), '');
2699 if ($s =~ /^\s*;/ &&
2700 $function_name ne 'uninitialized_var')
2702 WARN
("externs should be avoided in .c files\n" . $herecurr);
2705 if ($paren_space =~ /\n/) {
2706 WARN
("arguments for function declarations should follow identifier\n" . $herecurr);
2709 } elsif ($realfile =~ /\.c$/ && defined $stat &&
2710 $stat =~ /^.\s*extern\s+/)
2712 WARN
("externs should be avoided in .c files\n" . $herecurr);
2715 # checks for new __setup's
2716 if ($rawline =~ /\b__setup\("([^"]*)"/) {
2719 if (!grep(/$name/, @setup_docs)) {
2720 CHK
("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
2724 # check for pointless casting of kmalloc return
2725 if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
2726 WARN
("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
2729 # check for gcc specific __FUNCTION__
2730 if ($line =~ /__FUNCTION__/) {
2731 WARN
("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
2734 # check for semaphores used as mutexes
2735 if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
2736 WARN
("mutexes are preferred for single holder semaphores\n" . $herecurr);
2738 # check for semaphores used as mutexes
2739 if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
2740 WARN
("consider using a completion\n" . $herecurr);
2743 # recommend strict_strto* over simple_strto*
2744 if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2745 WARN
("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
2747 # check for __initcall(), use device_initcall() explicitly please
2748 if ($line =~ /^.\s*__initcall\s*\(/) {
2749 WARN
("please use device_initcall() instead of __initcall()\n" . $herecurr);
2751 # check for various ops structs, ensure they are const.
2752 my $struct_ops = qr{acpi_dock_ops
|
2753 address_space_operations
|
2755 block_device_operations
|
2760 file_lock_operations
|
2770 lock_manager_operations
|
2776 pipe_buf_operations
|
2777 platform_hibernation_ops
|
2778 platform_suspend_ops
|
2783 soc_pcmcia_socket_ops
|
2789 if ($line !~ /\bconst\b/ &&
2790 $line =~ /\bstruct\s+($struct_ops)\b/) {
2791 WARN
("struct $1 should normally be const\n" .
2795 # use of NR_CPUS is usually wrong
2796 # ignore definitions of NR_CPUS and usage to define arrays as likely right
2797 if ($line =~ /\bNR_CPUS\b/ &&
2798 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
2799 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
2800 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
2801 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
2802 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
2804 WARN
("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
2807 # check for %L{u,d,i} in strings
2809 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2810 $string = substr($rawline, $-[1], $+[1] - $-[1]);
2811 $string =~ s/%%/__/g;
2812 if ($string =~ /(?<!%)%L[udi]/) {
2813 WARN
("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2818 # whine mightly about in_atomic
2819 if ($line =~ /\bin_atomic\s*\(/) {
2820 if ($realfile =~ m@
^drivers
/@
) {
2821 ERROR
("do not use in_atomic in drivers\n" . $herecurr);
2822 } elsif ($realfile !~ m@
^kernel
/@
) {
2823 WARN
("use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
2827 # check for lockdep_set_novalidate_class
2828 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
2829 $line =~ /__lockdep_no_validate__\s*\)/ ) {
2830 if ($realfile !~ m@
^kernel
/lockdep@
&&
2831 $realfile !~ m@
^include
/linux/lockdep@
&&
2832 $realfile !~ m@
^drivers
/base/core@
) {
2833 ERROR
("lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
2838 # If we have no input at all, then there is nothing to report on
2839 # so just keep quiet.
2840 if ($#rawlines == -1) {
2844 # In mailback mode only produce a report in the negative, for
2845 # things that appear to be patches.
2846 if ($mailback && ($clean == 1 || !$is_patch)) {
2850 # This is not a patch, and we are are in 'no-patch' mode so
2852 if (!$chk_patch && !$is_patch) {
2857 ERROR
("Does not appear to be a unified-diff format patch\n");
2859 if ($is_patch && $chk_signoff && $signoff == 0) {
2860 ERROR
("Missing Signed-off-by: line(s)\n");
2863 print report_dump
();
2864 if ($summary && !($clean == 1 && $quiet == 1)) {
2865 print "$filename " if ($summary_file);
2866 print "total: $cnt_error errors, $cnt_warn warnings, " .
2867 (($check)?
"$cnt_chk checks, " : "") .
2868 "$cnt_lines lines checked\n";
2869 print "\n" if ($quiet == 0);
2873 # If there were whitespace errors which cleanpatch can fix
2874 # then suggest that.
2875 if ($rpt_cleaners) {
2876 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
2877 print " scripts/cleanfile\n\n";
2881 if ($clean == 1 && $quiet == 0) {
2882 print "$vname has no obvious style problems and is ready for submission.\n"
2884 if ($clean == 0 && $quiet == 0) {
2885 print "$vname has style problems, please review. If any of these errors\n";
2886 print "are false positives report them to the maintainer, see\n";
2887 print "CHECKPATCH in MAINTAINERS.\n";