2 # (c) 2001, Dave Jones. <davej@codemonkey.org.uk> (the file handling bit)
3 # (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
4 # (c) 2007, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite, etc)
5 # Licensed under the terms of the GNU GPL License version 2
14 use Getopt::Long qw(:config no_auto_abbrev);
32 'q|quiet+' => \$quiet,
34 'signoff!' => \$chk_signoff,
35 'patch!' => \$chk_patch,
39 'subjective!' => \$check,
42 'summary!' => \$summary,
43 'mailback!' => \$mailback,
44 'summary-file!' => \$summary_file,
47 'test-type!' => \$tst_type,
48 'test-only=s' => \$tst_only,
54 print "usage: $P [options] patchfile\n";
55 print "version: $V\n";
56 print "options: -q => quiet\n";
57 print " --no-tree => run without a kernel tree\n";
58 print " --terse => one line per report\n";
59 print " --emacs => emacs compile window format\n";
60 print " --file => check a source file\n";
61 print " --strict => enable more subjective tests\n";
62 print " --root => path to the kernel tree root\n";
63 print " --no-summary => suppress the per-file summary\n";
64 print " --summary-file => include the filename in summary\n";
70 for my $key (keys %debug) {
71 eval "\${dbg_$key} = '$debug{$key}';"
81 if (!top_of_kernel_tree($root)) {
82 die "$P: $root: --root does not point at a valid tree\n";
85 if (top_of_kernel_tree('.')) {
87 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
88 top_of_kernel_tree($1)) {
94 print "Must be run from the top-level dir. of a kernel tree\n";
99 my $emitted_corrupt = 0;
101 our $Ident = qr{[A-Za-z_][A-Za-z\d_]*};
102 our $Storage = qr{extern|static|asmlinkage};
116 __(?:mem|cpu|dev|)(?:initdata|init)
119 our $Inline = qr{inline|__always_inline|noinline};
120 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
121 our $Lval = qr{$Ident(?:$Member)*};
123 our $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
124 our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
128 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
136 [\x09\x0A\x0D\x20-\x7E] # ASCII
137 | [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
138 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
139 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
140 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
141 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
142 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
143 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
148 qr{(?:unsigned\s+)?char},
149 qr{(?:unsigned\s+)?short},
150 qr{(?:unsigned\s+)?int},
151 qr{(?:unsigned\s+)?long},
152 qr{(?:unsigned\s+)?long\s+int},
153 qr{(?:unsigned\s+)?long\s+long},
154 qr{(?:unsigned\s+)?long\s+long\s+int},
159 qr{(?:__)?(?:u|s|be|le)(?:8|16|32|64)},
164 qr{${Ident}_handler},
165 qr{${Ident}_handler_fn},
167 our @modifierList = (
172 my $mods = "(?: \n" . join("|\n ", @modifierList) . "\n)";
173 my $all = "(?: \n" . join("|\n ", @typeList) . "\n)";
174 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
179 (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
182 (?:\s+$Modifier|\s+const)*
186 (?:\s*\*+\s*const|\s*\*+|(?:\s*\[\s*\])+)?
187 (?:\s+$Inline|\s+$Modifier)*
189 $Declare = qr{(?:$Storage\s+)?$Type};
193 $chk_signoff = 0 if ($file);
195 my @dep_includes = ();
196 my @dep_functions = ();
197 my $removal = "Documentation/feature-removal-schedule.txt";
198 if ($tree && -f "$root/$removal") {
199 open(REMOVE, "<$root/$removal") ||
200 die "$P: $removal: open failed - $!\n";
202 if (/^Check:\s+(.*\S)/) {
203 for my $entry (split(/[, ]+/, $1)) {
204 if ($entry =~ m@include/(.*)@) {
205 push(@dep_includes, $1);
207 } elsif ($entry !~ m@/@) {
208 push(@dep_functions, $entry);
218 for my $filename (@ARGV) {
220 open(FILE, "diff -u /dev/null $filename|") ||
221 die "$P: $filename: diff failed - $!\n";
223 open(FILE, "<$filename") ||
224 die "$P: $filename: open failed - $!\n";
226 if ($filename eq '-') {
227 $vname = 'Your patch';
236 if (!process($filename)) {
245 sub top_of_kernel_tree {
249 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
250 "README", "Documentation", "arch", "include", "drivers",
251 "fs", "init", "ipc", "kernel", "lib", "scripts",
254 foreach my $check (@tree_check) {
255 if (! -e $root . '/' . $check) {
267 for my $c (split(//, $str)) {
271 for (; ($n % 8) != 0; $n++) {
283 (my $res = shift) =~ tr/\t/ /c;
290 # Drop the diff line leader and expand tabs
292 $line = expand_tabs($line);
294 # Pick the indent from the front of the line.
295 my ($white) = ($line =~ /^(\s*)/);
297 return (length($line), length($white));
300 my $sanitise_quote = '';
302 sub sanitise_line_reset {
303 my ($in_comment) = @_;
306 $sanitise_quote = '*/';
308 $sanitise_quote = '';
321 # Always copy over the diff marker.
322 $res = substr($line, 0, 1);
324 for ($off = 1; $off < length($line); $off++) {
325 $c = substr($line, $off, 1);
327 # Comments we are wacking completly including the begin
328 # and end, all to $;.
329 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
330 $sanitise_quote = '*/';
332 substr($res, $off, 2, "$;$;");
336 if (substr($line, $off, 2) eq '*/') {
337 $sanitise_quote = '';
338 substr($res, $off, 2, "$;$;");
343 # A \ in a string means ignore the next character.
344 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
346 substr($res, $off, 2, 'XX');
351 if ($c eq "'" || $c eq '"') {
352 if ($sanitise_quote eq '') {
353 $sanitise_quote = $c;
355 substr($res, $off, 1, $c);
357 } elsif ($sanitise_quote eq $c) {
358 $sanitise_quote = '';
362 #print "SQ:$sanitise_quote\n";
363 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
364 substr($res, $off, 1, $;);
365 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
366 substr($res, $off, 1, 'X');
368 substr($res, $off, 1, $c);
372 # The pathname on a #include may be surrounded by '<' and '>'.
373 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
374 my $clean = 'X' x length($1);
375 $res =~ s@\<.*\>@<$clean>@;
377 # The whole of a #error is a string.
378 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
379 my $clean = 'X' x length($1);
380 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
386 sub ctx_statement_block {
387 my ($linenr, $remain, $off) = @_;
388 my $line = $linenr - 1;
404 #warn "CSB: blk<$blk> remain<$remain>\n";
405 # If we are about to drop off the end, pull in more
408 for (; $remain > 0; $line++) {
409 next if ($lines[$line] =~ /^-/);
412 $blk .= $lines[$line] . "\n";
417 # Bail if there is no further context.
418 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
424 $c = substr($blk, $off, 1);
425 $remainder = substr($blk, $off);
427 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
428 # Statement ends at the ';' or a close '}' at the
430 if ($level == 0 && $c eq ';') {
434 # An else is really a conditional as long as its not else if
435 if ($level == 0 && $coff_set == 0 &&
436 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
437 $remainder =~ /^(else)(?:\s|{)/ &&
438 $remainder !~ /^else\s+if\b/) {
439 $coff = $off + length($1) - 1;
441 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
442 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
445 if (($type eq '' || $type eq '(') && $c eq '(') {
449 if ($type eq '(' && $c eq ')') {
451 $type = ($level != 0)? '(' : '';
453 if ($level == 0 && $coff < $soff) {
456 #warn "CSB: mark coff<$coff>\n";
459 if (($type eq '' || $type eq '{') && $c eq '{') {
463 if ($type eq '{' && $c eq '}') {
465 $type = ($level != 0)? '{' : '';
473 # We are truly at the end, so shuffle to the next line.
480 my $statement = substr($blk, $soff, $off - $soff + 1);
481 my $condition = substr($blk, $soff, $coff - $soff + 1);
483 #warn "STATEMENT<$statement>\n";
484 #warn "CONDITION<$condition>\n";
486 #print "coff<$coff> soff<$off> loff<$loff>\n";
488 return ($statement, $condition,
489 $line, $remain + 1, $off - $loff + 1, $level);
492 sub statement_lines {
495 # Strip the diff line prefixes and rip blank lines at start and end.
496 $stmt =~ s/(^|\n)./$1/g;
500 my @stmt_lines = ($stmt =~ /\n/g);
502 return $#stmt_lines + 2;
505 sub statement_rawlines {
508 my @stmt_lines = ($stmt =~ /\n/g);
510 return $#stmt_lines + 2;
513 sub statement_block_size {
516 $stmt =~ s/(^|\n)./$1/g;
522 my @stmt_lines = ($stmt =~ /\n/g);
523 my @stmt_statements = ($stmt =~ /;/g);
525 my $stmt_lines = $#stmt_lines + 2;
526 my $stmt_statements = $#stmt_statements + 1;
528 if ($stmt_lines > $stmt_statements) {
531 return $stmt_statements;
535 sub ctx_statement_full {
536 my ($linenr, $remain, $off) = @_;
537 my ($statement, $condition, $level);
541 # Grab the first conditional/block pair.
542 ($statement, $condition, $linenr, $remain, $off, $level) =
543 ctx_statement_block($linenr, $remain, $off);
544 #print "F: c<$condition> s<$statement> remain<$remain>\n";
545 push(@chunks, [ $condition, $statement ]);
546 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
547 return ($level, $linenr, @chunks);
550 # Pull in the following conditional/block pairs and see if they
551 # could continue the statement.
553 ($statement, $condition, $linenr, $remain, $off, $level) =
554 ctx_statement_block($linenr, $remain, $off);
555 #print "C: c<$condition> s<$statement> remain<$remain>\n";
556 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
558 push(@chunks, [ $condition, $statement ]);
561 return ($level, $linenr, @chunks);
565 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
567 my $start = $linenr - 1;
574 for ($line = $start; $remain > 0; $line++) {
575 next if ($rawlines[$line] =~ /^-/);
578 $blk .= $rawlines[$line];
579 foreach my $c (split(//, $rawlines[$line])) {
580 ##print "C<$c>L<$level><$open$close>O<$off>\n";
586 if ($c eq $close && $level > 0) {
588 last if ($level == 0);
589 } elsif ($c eq $open) {
594 if (!$outer || $level <= 1) {
595 push(@res, $rawlines[$line]);
598 last if ($level == 0);
601 return ($level, @res);
603 sub ctx_block_outer {
604 my ($linenr, $remain) = @_;
606 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
610 my ($linenr, $remain) = @_;
612 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
616 my ($linenr, $remain, $off) = @_;
618 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
621 sub ctx_block_level {
622 my ($linenr, $remain) = @_;
624 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
626 sub ctx_statement_level {
627 my ($linenr, $remain, $off) = @_;
629 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
632 sub ctx_locate_comment {
633 my ($first_line, $end_line) = @_;
635 # Catch a comment on the end of the line itself.
636 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
637 return $current_comment if (defined $current_comment);
639 # Look through the context and try and figure out if there is a
642 $current_comment = '';
643 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
644 my $line = $rawlines[$linenr - 1];
646 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
649 if ($line =~ m@/\*@) {
652 if (!$in_comment && $current_comment ne '') {
653 $current_comment = '';
655 $current_comment .= $line . "\n" if ($in_comment);
656 if ($line =~ m@\*/@) {
661 chomp($current_comment);
662 return($current_comment);
664 sub ctx_has_comment {
665 my ($first_line, $end_line) = @_;
666 my $cmt = ctx_locate_comment($first_line, $end_line);
668 ##print "LINE: $rawlines[$end_line - 1 ]\n";
669 ##print "CMMT: $cmt\n";
679 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
682 $coded = sprintf("^%c", unpack('C', $2) + 64);
691 my $av_preprocessor = 0;
696 $av_preprocessor = 0;
698 @av_paren_type = ('E');
701 sub annotate_values {
702 my ($stream, $type) = @_;
707 print "$stream\n" if ($dbg_values > 1);
709 while (length($cur)) {
710 @av_paren_type = ('E') if ($#av_paren_type < 0);
711 print " <" . join('', @av_paren_type) .
712 "> <$type> <$av_pending>" if ($dbg_values > 1);
713 if ($cur =~ /^(\s+)/o) {
714 print "WS($1)\n" if ($dbg_values > 1);
715 if ($1 =~ /\n/ && $av_preprocessor) {
716 $type = pop(@av_paren_type);
717 $av_preprocessor = 0;
720 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\))/) {
721 print "DECLARE($1)\n" if ($dbg_values > 1);
724 } elsif ($cur =~ /^($Modifier)\s*/) {
725 print "MODIFIER($1)\n" if ($dbg_values > 1);
728 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
729 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
730 $av_preprocessor = 1;
731 push(@av_paren_type, $type);
737 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
738 print "UNDEF($1)\n" if ($dbg_values > 1);
739 $av_preprocessor = 1;
740 push(@av_paren_type, $type);
742 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
743 print "PRE_START($1)\n" if ($dbg_values > 1);
744 $av_preprocessor = 1;
746 push(@av_paren_type, $type);
747 push(@av_paren_type, $type);
750 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
751 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
752 $av_preprocessor = 1;
754 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
758 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
759 print "PRE_END($1)\n" if ($dbg_values > 1);
761 $av_preprocessor = 1;
763 # Assume all arms of the conditional end as this
764 # one does, and continue as if the #endif was not here.
766 push(@av_paren_type, $type);
769 } elsif ($cur =~ /^(\\\n)/o) {
770 print "PRECONT($1)\n" if ($dbg_values > 1);
772 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
773 print "ATTR($1)\n" if ($dbg_values > 1);
777 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
778 print "SIZEOF($1)\n" if ($dbg_values > 1);
784 } elsif ($cur =~ /^(if|while|typeof|__typeof__|for)\b/o) {
785 print "COND($1)\n" if ($dbg_values > 1);
789 } elsif ($cur =~/^(return|case|else|goto)/o) {
790 print "KEYWORD($1)\n" if ($dbg_values > 1);
793 } elsif ($cur =~ /^(\()/o) {
794 print "PAREN('$1')\n" if ($dbg_values > 1);
795 push(@av_paren_type, $av_pending);
799 } elsif ($cur =~ /^(\))/o) {
800 my $new_type = pop(@av_paren_type);
801 if ($new_type ne '_') {
803 print "PAREN('$1') -> $type\n"
804 if ($dbg_values > 1);
806 print "PAREN('$1')\n" if ($dbg_values > 1);
809 } elsif ($cur =~ /^($Ident)\s*\(/o) {
810 print "FUNC($1)\n" if ($dbg_values > 1);
814 } elsif ($cur =~ /^($Ident|$Constant)/o) {
815 print "IDENT($1)\n" if ($dbg_values > 1);
818 } elsif ($cur =~ /^($Assignment)/o) {
819 print "ASSIGN($1)\n" if ($dbg_values > 1);
822 } elsif ($cur =~/^(;|{|})/) {
823 print "END($1)\n" if ($dbg_values > 1);
826 } elsif ($cur =~ /^(;|\?|:|\[)/o) {
827 print "CLOSE($1)\n" if ($dbg_values > 1);
830 } elsif ($cur =~ /^($Operators)/o) {
831 print "OP($1)\n" if ($dbg_values > 1);
832 if ($1 ne '++' && $1 ne '--') {
836 } elsif ($cur =~ /(^.)/o) {
837 print "C($1)\n" if ($dbg_values > 1);
840 $cur = substr($cur, length($1));
841 $res .= $type x length($1);
849 my ($possible, $line) = @_;
851 print "CHECK<$possible> ($line)\n" if ($dbg_possible > 1);
852 if ($possible !~ /^(?:$Storage|$Type|DEFINE_\S+)$/ &&
853 $possible ne 'goto' && $possible ne 'return' &&
854 $possible ne 'case' && $possible ne 'else' &&
855 $possible ne 'asm' && $possible ne '__asm__' &&
856 $possible !~ /^(typedef|struct|enum)\b/) {
857 # Check for modifiers.
858 $possible =~ s/\s*$Storage\s*//g;
859 $possible =~ s/\s*$Sparse\s*//g;
860 if ($possible =~ /^\s*$/) {
862 } elsif ($possible =~ /\s/) {
863 $possible =~ s/\s*$Type\s*//g;
864 warn "MODIFIER: $possible ($line)\n" if ($dbg_possible);
865 push(@modifierList, $possible);
868 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
869 push(@typeList, $possible);
878 if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
881 my $line = $prefix . $_[0];
883 $line = (split('\n', $line))[0] . "\n" if ($terse);
885 push(our @report, $line);
893 if (report("ERROR: $_[0]\n")) {
899 if (report("WARNING: $_[0]\n")) {
905 if ($check && report("CHECK: $_[0]\n")) {
912 my $filename = shift;
935 # Trace the real file/line as we go.
941 my $comment_edge = 0;
944 my $prev_values = 'E';
947 my %suppress_ifbraces;
949 # Pre-scan the patch sanitizing the lines.
950 # Pre-scan the patch looking for any __setup documentation.
955 sanitise_line_reset();
957 foreach my $rawline (@rawlines) {
961 if ($rawline=~/^\+\+\+\s+(\S+)/) {
963 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
968 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
977 # Guestimate if this is a continuing comment. Run
978 # the context looking for a comment "edge". If this
979 # edge is a close comment then we must be in a comment
982 for (my $ln = $linenr + 1; $ln < ($linenr + $realcnt); $ln++) {
983 next if ($line =~ /^-/);
984 ($edge) = ($rawlines[$ln - 1] =~ m@(/\*|\*/)@);
985 last if (defined $edge);
987 if (defined $edge && $edge eq '*/') {
991 # Guestimate if this is a continuing comment. If this
992 # is the start of a diff block and this line starts
993 # ' *' then it is very likely a comment.
994 if (!defined $edge &&
995 $rawlines[$linenr] =~ m@^.\s* \*(?:\s|$)@)
1000 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1001 sanitise_line_reset($in_comment);
1003 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1004 # Standardise the strings and chars within the input to
1005 # simplify matching -- only bother with positive lines.
1006 $line = sanitise_line($rawline);
1008 push(@lines, $line);
1011 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1016 #print "==>$rawline\n";
1017 #print "-->$line\n";
1019 if ($setup_docs && $line =~ /^\+/) {
1020 push(@setup_docs, $line);
1028 foreach my $line (@lines) {
1031 my $rawline = $rawlines[$linenr - 1];
1033 #extract the line range in the file after the patch is applied
1034 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1036 $first_line = $linenr + 1;
1046 %suppress_ifbraces = ();
1049 # track the line number as we move through the hunk, note that
1050 # new versions of GNU diff omit the leading space on completely
1051 # blank context lines so we need to count that too.
1052 } elsif ($line =~ /^( |\+|$)/) {
1054 $realcnt-- if ($realcnt != 0);
1056 # Measure the line length and indent.
1057 ($length, $indent) = line_stats($rawline);
1059 # Track the previous line.
1060 ($prevline, $stashline) = ($stashline, $line);
1061 ($previndent, $stashindent) = ($stashindent, $indent);
1062 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1064 #warn "line<$line>\n";
1066 } elsif ($realcnt == 1) {
1070 #make up the handle for any error we report on this line
1071 $prefix = "$filename:$realline: " if ($emacs && $file);
1072 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1074 $here = "#$linenr: " if (!$file);
1075 $here = "#$realline: " if ($file);
1077 # extract the filename as it passes
1078 if ($line=~/^\+\+\+\s+(\S+)/) {
1080 $realfile =~ s@^[^/]*/@@;
1082 if ($realfile =~ m@include/asm/@) {
1083 ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1088 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
1090 my $hereline = "$here\n$rawline\n";
1091 my $herecurr = "$here\n$rawline\n";
1092 my $hereprev = "$here\n$prevrawline\n$rawline\n";
1094 $cnt_lines++ if ($realcnt != 0);
1096 #check the patch for a signoff:
1097 if ($line =~ /^\s*signed-off-by:/i) {
1098 # This is a signoff, if ugly, so do not double report.
1100 if (!($line =~ /^\s*Signed-off-by:/)) {
1101 WARN("Signed-off-by: is the preferred form\n" .
1104 if ($line =~ /^\s*signed-off-by:\S/i) {
1105 WARN("space required after Signed-off-by:\n" .
1110 # Check for wrappage within a valid hunk of the file
1111 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1112 ERROR("patch seems to be corrupt (line wrapped?)\n" .
1113 $herecurr) if (!$emitted_corrupt++);
1116 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1117 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1118 $rawline !~ m/^$UTF8*$/) {
1119 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1121 my $blank = copy_spacing($rawline);
1122 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1123 my $hereptr = "$hereline$ptr\n";
1125 ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1128 #ignore lines being removed
1129 if ($line=~/^-/) {next;}
1131 # check we are in a valid source file if not then ignore this hunk
1132 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1134 #trailing whitespace
1135 if ($line =~ /^\+.*\015/) {
1136 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1137 ERROR("DOS line endings\n" . $herevet);
1139 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1140 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1141 ERROR("trailing whitespace\n" . $herevet);
1144 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
1145 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1146 $line !~ /^\+\s*printk\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ &&
1149 WARN("line over 80 characters\n" . $herecurr);
1152 # check for adding lines without a newline.
1153 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1154 WARN("adding a line without newline at end of file\n" . $herecurr);
1157 # check we are in a valid source file *.[hc] if not then ignore this hunk
1158 next if ($realfile !~ /\.[hc]$/);
1160 # at the beginning of a line any tabs must come first and anything
1161 # more than 8 must use tabs.
1162 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1163 $rawline =~ /^\+\s* \s*/) {
1164 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1165 ERROR("code indent should use tabs where possible\n" . $herevet);
1168 # check for RCS/CVS revision markers
1169 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
1170 WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1173 # Check for potential 'bare' types
1174 my ($stat, $cond, $line_nr_next, $remain_next);
1175 if ($realcnt && $line =~ /.\s*\S/) {
1176 ($stat, $cond, $line_nr_next, $remain_next) =
1177 ctx_statement_block($linenr, $realcnt, 0);
1178 $stat =~ s/\n./\n /g;
1179 $cond =~ s/\n./\n /g;
1184 # Ignore goto labels.
1185 if ($s =~ /$Ident:\*$/s) {
1187 # Ignore functions being called
1188 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
1190 # declarations always start with types
1191 } elsif ($prev_values eq 'E' && $s =~ /^.\s*(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?((?:\s*$Ident)+)\b(?:\s+$Sparse)?\s*\**\s*(?:$Ident|\(\*[^\)]*\))\s*(?:;|=|,|\()/s) {
1194 possible($type, "A:" . $s);
1196 # definitions in global scope can only start with types
1197 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b/s) {
1198 possible($1, "B:" . $s);
1201 # any (foo ... *) is a pointer cast, and foo is a type
1202 while ($s =~ /\(($Ident)(?:\s+$Sparse)*\s*\*+\s*\)/sg) {
1203 possible($1, "C:" . $s);
1206 # Check for any sort of function declaration.
1207 # int foo(something bar, other baz);
1208 # void (*store_gdt)(x86_descr_ptr *);
1209 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
1210 my ($name_len) = length($1);
1213 substr($ctx, 0, $name_len + 1, '');
1214 $ctx =~ s/\)[^\)]*$//;
1216 for my $arg (split(/\s*,\s*/, $ctx)) {
1217 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
1219 possible($1, "D:" . $s);
1227 # Checks which may be anchored in the context.
1230 # Check for switch () and associated case and default
1231 # statements should be at the same indent.
1232 if ($line=~/\bswitch\s*\(.*\)/) {
1235 my @ctx = ctx_block_outer($linenr, $realcnt);
1237 for my $ctx (@ctx) {
1238 my ($clen, $cindent) = line_stats($ctx);
1239 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1240 $indent != $cindent) {
1241 $err .= "$sep$ctx\n";
1248 ERROR("switch and case should be at the same indent\n$hereline$err");
1251 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
1252 $line !~ /\G(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$/g) {
1253 ERROR("trailing statements should be on next line\n" . $herecurr);
1256 # if/while/etc brace do not go on next line, unless defining a do while loop,
1257 # or if that brace on the next line is for something else
1258 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
1259 my $pre_ctx = "$1$2";
1261 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
1262 my $ctx_cnt = $realcnt - $#ctx - 1;
1263 my $ctx = join("\n", @ctx);
1265 my $ctx_ln = $linenr;
1266 my $ctx_skip = $realcnt;
1268 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1269 defined $lines[$ctx_ln - 1] &&
1270 $lines[$ctx_ln - 1] =~ /^-/)) {
1271 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1272 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
1276 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1277 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
1279 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1280 ERROR("that open brace { should be on the previous line\n" .
1281 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1283 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1284 $ctx =~ /\)\s*\;\s*$/ &&
1285 defined $lines[$ctx_ln - 1])
1287 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1288 if ($nindent > $indent) {
1289 WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
1290 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1295 # Track the 'values' across context and added lines.
1296 my $opline = $line; $opline =~ s/^./ /;
1297 my $curr_values = annotate_values($opline . "\n", $prev_values);
1298 $curr_values = $prev_values . $curr_values;
1300 my $outline = $opline; $outline =~ s/\t/ /g;
1301 print "$linenr > .$outline\n";
1302 print "$linenr > $curr_values\n";
1304 $prev_values = substr($curr_values, -1);
1306 #ignore lines not being added
1307 if ($line=~/^[^\+]/) {next;}
1309 # TEST: allow direct testing of the type matcher.
1310 if ($tst_type && $line =~ /^.$Declare$/) {
1311 ERROR("TEST: is type $Declare\n" . $herecurr);
1315 # check for initialisation to aggregates open brace on the next line
1316 if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ &&
1317 $line =~ /^.\s*{/) {
1318 ERROR("that open brace { should be on the previous line\n" . $hereprev);
1322 # Checks which are anchored on the added line.
1325 # check for malformed paths in #include statements (uses RAW line)
1326 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
1328 if ($path =~ m{//}) {
1329 ERROR("malformed #include filename\n" .
1334 # no C99 // comments
1335 if ($line =~ m{//}) {
1336 ERROR("do not use C99 // comments\n" . $herecurr);
1338 # Remove C99 comments.
1340 $opline =~ s@//.*@@;
1342 #EXPORT_SYMBOL should immediately follow its function closing }.
1343 if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) ||
1344 ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1346 if (($prevline !~ /^}/) &&
1347 ($prevline !~ /^\+}/) &&
1348 ($prevline !~ /^ }/) &&
1349 ($prevline !~ /^.DECLARE_$Ident\(\Q$name\E\)/) &&
1350 ($prevline !~ /^.LIST_HEAD\(\Q$name\E\)/) &&
1351 ($prevline !~ /^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(/) &&
1352 ($prevline !~ /\b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[)/)) {
1353 WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
1357 # check for external initialisers.
1358 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
1359 ERROR("do not initialise externals to 0 or NULL\n" .
1362 # check for static initialisers.
1363 if ($line =~ /\s*static\s.*=\s*(0|NULL|false)\s*;/) {
1364 ERROR("do not initialise statics to 0 or NULL\n" .
1368 # check for new typedefs, only function parameters and sparse annotations
1370 if ($line =~ /\btypedef\s/ &&
1371 $line !~ /\btypedef\s+$Type\s+\(\s*\*?$Ident\s*\)\s*\(/ &&
1372 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
1373 $line !~ /\b__bitwise(?:__|)\b/) {
1374 WARN("do not add new typedefs\n" . $herecurr);
1377 # * goes on variable not on type
1378 if ($line =~ m{\($NonptrType(\*+)(?:\s+const)?\)}) {
1379 ERROR("\"(foo$1)\" should be \"(foo $1)\"\n" .
1382 } elsif ($line =~ m{\($NonptrType\s+(\*+)(?!\s+const)\s+\)}) {
1383 ERROR("\"(foo $1 )\" should be \"(foo $1)\"\n" .
1386 } elsif ($line =~ m{$NonptrType(\*+)(?:\s+(?:$Attribute|$Sparse))?\s+[A-Za-z\d_]+}) {
1387 ERROR("\"foo$1 bar\" should be \"foo $1bar\"\n" .
1390 } elsif ($line =~ m{$NonptrType\s+(\*+)(?!\s+(?:$Attribute|$Sparse))\s+[A-Za-z\d_]+}) {
1391 ERROR("\"foo $1 bar\" should be \"foo $1bar\"\n" .
1395 # # no BUG() or BUG_ON()
1396 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
1397 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
1398 # print "$herecurr";
1402 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
1403 WARN("LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
1406 # printk should use KERN_* levels. Note that follow on printk's on the
1407 # same line do not need a level, so we use the current block context
1408 # to try and find and validate the current printk. In summary the current
1409 # printk includes all preceeding printk's which have no newline on the end.
1410 # we assume the first bad printk is the one to report.
1411 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
1413 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
1414 #print "CHECK<$lines[$ln - 1]\n";
1415 # we have a preceeding printk if it ends
1416 # with "\n" ignore it, else it is to blame
1417 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
1418 if ($rawlines[$ln - 1] !~ m{\\n"}) {
1425 WARN("printk() should include KERN_ facility level\n" . $herecurr);
1429 # function brace can't be on same line, except for #defines of do while,
1430 # or if closed on same line
1431 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
1432 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
1433 ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
1436 # open braces for enum, union and struct go on the same line.
1437 if ($line =~ /^.\s*{/ &&
1438 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1439 ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
1442 # check for spacing round square brackets; allowed:
1443 # 1. with a type on the left -- int [] a;
1444 # 2. at the beginning of a line for slice initialisers -- [0..10] = 5,
1445 while ($line =~ /(.*?\s)\[/g) {
1446 my ($where, $prefix) = ($-[1], $1);
1447 if ($prefix !~ /$Type\s+$/ &&
1448 ($where != 0 || $prefix !~ /^.\s+$/)) {
1449 ERROR("space prohibited before open square bracket '['\n" . $herecurr);
1453 # check for spaces between functions and their parentheses.
1454 while ($line =~ /($Ident)\s+\(/g) {
1456 my $ctx_before = substr($line, 0, $-[1]);
1457 my $ctx = "$ctx_before$name";
1459 # Ignore those directives where spaces _are_ permitted.
1461 if|for|while|switch|return|case|
1462 volatile|__volatile__|
1463 __attribute__|format|__extension__|
1467 # cpp #define statements have non-optional spaces, ie
1468 # if there is a space between the name and the open
1469 # parenthesis it is simply not a parameter group.
1470 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
1472 # cpp #elif statement condition may start with a (
1473 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
1475 # If this whole things ends with a type its most
1476 # likely a typedef for a function.
1477 } elsif ($ctx =~ /$Type$/) {
1480 WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
1483 # Check operator spacing.
1484 if (!($line=~/\#\s*include/)) {
1486 <<=|>>=|<=|>=|==|!=|
1487 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
1488 =>|->|<<|>>|<|>|=|!|~|
1489 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
1491 my @elements = split(/($ops|;)/, $opline);
1494 my $blank = copy_spacing($opline);
1496 for (my $n = 0; $n < $#elements; $n += 2) {
1497 $off += length($elements[$n]);
1499 # Pick up the preceeding and succeeding characters.
1500 my $ca = substr($opline, 0, $off);
1502 if (length($opline) >= ($off + length($elements[$n + 1]))) {
1503 $cc = substr($opline, $off + length($elements[$n + 1]));
1505 my $cb = "$ca$;$cc";
1508 $a = 'V' if ($elements[$n] ne '');
1509 $a = 'W' if ($elements[$n] =~ /\s$/);
1510 $a = 'C' if ($elements[$n] =~ /$;$/);
1511 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
1512 $a = 'O' if ($elements[$n] eq '');
1513 $a = 'E' if ($ca =~ /^\s*$/);
1515 my $op = $elements[$n + 1];
1518 if (defined $elements[$n + 2]) {
1519 $c = 'V' if ($elements[$n + 2] ne '');
1520 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
1521 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
1522 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
1523 $c = 'O' if ($elements[$n + 2] eq '');
1524 $c = 'E' if ($elements[$n + 2] =~ /\s*\\$/);
1529 my $ctx = "${a}x${c}";
1531 my $at = "(ctx:$ctx)";
1533 my $ptr = substr($blank, 0, $off) . "^";
1534 my $hereptr = "$hereline$ptr\n";
1536 # Classify operators into binary, unary, or
1537 # definitions (* only) where they have more
1539 my $op_type = substr($curr_values, $off + 1, 1);
1540 my $op_left = substr($curr_values, $off, 1);
1542 if ($op_type eq 'T') {
1544 } elsif ($op_left eq 'V') {
1549 #if ($op eq '-' || $op eq '&' || $op eq '*') {
1550 # print "UNARY: <$op_left$op_type $is_unary $a:$op:$c> <$ca:$op:$cc> <$unary_ctx>\n";
1553 # Ignore operators passed as parameters.
1554 if ($op_type ne 'V' &&
1555 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
1558 # } elsif ($op =~ /^$;+$/) {
1560 # ; should have either the end of line or a space or \ after it
1561 } elsif ($op eq ';') {
1562 if ($ctx !~ /.x[WEBC]/ &&
1563 $cc !~ /^\\/ && $cc !~ /^;/) {
1564 ERROR("space required after that '$op' $at\n" . $hereptr);
1568 } elsif ($op eq '//') {
1570 # -> should have no spaces
1571 } elsif ($op eq '->') {
1572 if ($ctx =~ /Wx.|.xW/) {
1573 ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
1576 # , must have a space on the right.
1577 } elsif ($op eq ',') {
1578 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
1579 ERROR("space required after that '$op' $at\n" . $hereptr);
1582 # '*' as part of a type definition -- reported already.
1583 } elsif ($op eq '*' && $is_unary == 2) {
1584 #warn "'*' is part of type\n";
1586 # unary operators should have a space before and
1587 # none after. May be left adjacent to another
1588 # unary operator, or a cast
1589 } elsif ($op eq '!' || $op eq '~' ||
1590 ($is_unary && ($op eq '*' || $op eq '-' || $op eq '&'))) {
1591 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
1592 ERROR("space required before that '$op' $at\n" . $hereptr);
1594 if ($op eq '*' && $cc =~/\s*const\b/) {
1595 # A unary '*' may be const
1597 } elsif ($ctx =~ /.xW/) {
1598 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1601 # unary ++ and unary -- are allowed no space on one side.
1602 } elsif ($op eq '++' or $op eq '--') {
1603 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
1604 ERROR("space required one side of that '$op' $at\n" . $hereptr);
1606 if ($ctx =~ /Wx[BE]/ ||
1607 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
1608 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
1610 if ($ctx =~ /ExW/) {
1611 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1615 # << and >> may either have or not have spaces both sides
1616 } elsif ($op eq '<<' or $op eq '>>' or
1617 $op eq '&' or $op eq '^' or $op eq '|' or
1618 $op eq '+' or $op eq '-' or
1619 $op eq '*' or $op eq '/' or
1622 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
1623 ERROR("need consistent spacing around '$op' $at\n" .
1627 # All the others need spaces both sides.
1628 } elsif ($ctx !~ /[EWC]x[CWE]/) {
1629 # Ignore email addresses <foo@bar>
1630 if (!($op eq '<' && $cb =~ /$;\S+\@\S+>/) &&
1631 !($op eq '>' && $cb =~ /<\S+\@\S+$;/)) {
1632 ERROR("spaces required around that '$op' $at\n" . $hereptr);
1635 $off += length($elements[$n + 1]);
1639 # check for multiple assignments
1640 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
1641 CHK("multiple assignments should be avoided\n" . $herecurr);
1644 ## # check for multiple declarations, allowing for a function declaration
1646 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
1647 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
1649 ## # Remove any bracketed sections to ensure we do not
1650 ## # falsly report the parameters of functions.
1652 ## while ($ln =~ s/\([^\(\)]*\)//g) {
1654 ## if ($ln =~ /,/) {
1655 ## WARN("declaring multiple variables together should be avoided\n" . $herecurr);
1659 #need space before brace following if, while, etc
1660 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
1662 ERROR("space required before the open brace '{'\n" . $herecurr);
1665 # closing brace should have a space following it when it has anything
1667 if ($line =~ /}(?!(?:,|;|\)))\S/) {
1668 ERROR("space required after that close brace '}'\n" . $herecurr);
1671 # check spacing on square brackets
1672 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
1673 ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
1675 if ($line =~ /\s\]/) {
1676 ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
1679 # check spacing on parentheses
1680 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
1681 $line !~ /for\s*\(\s+;/) {
1682 ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
1684 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
1685 $line !~ /for\s*\(.*;\s+\)/ &&
1686 $line !~ /:\s+\)/) {
1687 ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
1690 #goto labels aren't indented, allow a single space however
1691 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
1692 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
1693 WARN("labels should not be indented\n" . $herecurr);
1696 # Return is not a function.
1697 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
1701 # Flatten any parentheses and braces
1702 $value =~ s/\)\(/\) \(/g;
1703 while ($value =~ s/\([^\(\)]*\)/1/) {
1706 if ($value =~ /^(?:$Ident|-?$Constant)$/) {
1707 ERROR("return is not a function, parentheses are not required\n" . $herecurr);
1709 } elsif ($spacing !~ /\s+/) {
1710 ERROR("space required before the open parenthesis '('\n" . $herecurr);
1714 # Need a space before open parenthesis after if, while etc
1715 if ($line=~/\b(if|while|for|switch)\(/) {
1716 ERROR("space required before the open parenthesis '('\n" . $herecurr);
1719 # Check for illegal assignment in if conditional -- and check for trailing
1720 # statements after the conditional.
1721 if ($line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
1722 my ($s, $c) = ($stat, $cond);
1724 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/) {
1725 ERROR("do not use assignment in if condition\n" . $herecurr);
1728 # Find out what is on the end of the line after the
1730 substr($s, 0, length($c), '');
1732 $s =~ s/$;//g; # Remove any comments
1733 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
1734 $c !~ /}\s*while\s*/)
1736 ERROR("trailing statements should be on next line\n" . $herecurr);
1740 # Check relative indent for conditionals and blocks.
1741 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1742 my ($s, $c) = ($stat, $cond);
1744 substr($s, 0, length($c), '');
1746 # Make sure we remove the line prefixes as we have
1747 # none on the first line, and are going to readd them
1751 # We want to check the first line inside the block
1752 # starting at the end of the conditional, so remove:
1753 # 1) any blank line termination
1754 # 2) any opening brace { on end of the line
1756 my $continuation = 0;
1758 $s =~ s/^.*\bdo\b//;
1760 if ($s =~ s/^\s*\\//) {
1763 if ($s =~ s/^\s*\n//) {
1767 # Also ignore a loop construct at the end of a
1768 # preprocessor statement.
1769 if (($prevline =~ /^.\s*#\s*define\s/ ||
1770 $prevline =~ /\\\s*$/) && $continuation == 0) {
1774 # Ignore the current line if its is a preprocessor
1776 if ($s =~ /^\s*#\s*/) {
1780 my (undef, $sindent) = line_stats("+" . $s);
1782 ##print "line<$line> prevline<$prevline> indent<$indent> sindent<$sindent> check<$check> continuation<$continuation> s<$s>\n";
1784 if ($check && (($sindent % 8) != 0 ||
1785 ($sindent <= $indent && $s ne ''))) {
1786 WARN("suspect code indent for conditional statements\n" . $herecurr);
1790 # Check for bitwise tests written as boolean
1802 WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
1805 # if and else should not have general statements after it
1806 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
1808 $s =~ s/$;//g; # Remove any comments
1809 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
1810 ERROR("trailing statements should be on next line\n" . $herecurr);
1814 # Check for }<nl>else {, these must be at the same
1815 # indent level to be relevant to each other.
1816 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
1817 $previndent == $indent) {
1818 ERROR("else should follow close brace '}'\n" . $hereprev);
1821 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
1822 $previndent == $indent) {
1823 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
1825 # Find out what is on the end of the line after the
1827 substr($s, 0, length($c), '');
1830 if ($s =~ /^\s*;/) {
1831 ERROR("while should follow close brace '}'\n" . $hereprev);
1835 #studly caps, commented out until figure out how to distinguish between use of existing and adding new
1836 # if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
1837 # print "No studly caps, use _\n";
1838 # print "$herecurr";
1842 #no spaces allowed after \ in define
1843 if ($line=~/\#\s*define.*\\\s$/) {
1844 WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
1847 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
1848 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
1849 my $checkfile = "include/linux/$1.h";
1850 if (-f "$root/$checkfile" && $realfile ne $checkfile &&
1853 WARN("Use #include <linux/$1.h> instead of <asm/$1.h>\n" .
1858 # multi-statement macros should be enclosed in a do while loop, grab the
1859 # first statement and ensure its the whole macro if its not enclosed
1860 # in a known good container
1861 if ($line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
1864 my ($off, $dstat, $dcond, $rest);
1867 my $args = defined($1);
1869 # Find the end of the macro and limit our statement
1871 while ($cnt > 0 && defined $lines[$ln - 1] &&
1872 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
1874 $ctx .= $rawlines[$ln - 1] . "\n";
1875 $cnt-- if ($lines[$ln - 1] !~ /^-/);
1878 $ctx .= $rawlines[$ln - 1];
1880 ($dstat, $dcond, $ln, $cnt, $off) =
1881 ctx_statement_block($linenr, $ln - $linenr + 1, 0);
1882 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
1883 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
1885 # Extract the remainder of the define (if any) and
1886 # rip off surrounding spaces, and trailing \'s.
1888 while ($off != 0 || ($cnt > 0 && $rest =~ /(?:^|\\)\s*$/)) {
1889 #print "ADDING $off <" . substr($lines[$ln - 1], $off) . ">\n";
1890 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
1891 $rest .= substr($lines[$ln - 1], $off) . "\n";
1897 $rest =~ s/\\\n.//g;
1901 # Clean up the original statement.
1903 substr($dstat, 0, length($dcond), '');
1905 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
1907 $dstat =~ s/\\\n.//g;
1908 $dstat =~ s/^\s*//s;
1909 $dstat =~ s/\s*$//s;
1911 # Flatten any parentheses and braces
1912 while ($dstat =~ s/\([^\(\)]*\)/1/) {
1914 while ($dstat =~ s/\{[^\{\}]*\}/1/) {
1917 my $exceptions = qr{
1925 #print "REST<$rest>\n";
1927 if ($rest !~ /while\s*\(/ &&
1928 $dstat !~ /$exceptions/)
1930 ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
1933 } elsif ($ctx !~ /;/) {
1935 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
1936 $dstat !~ /$exceptions/ &&
1937 $dstat =~ /$Operators/)
1939 ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
1944 # check for redundant bracing round if etc
1945 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
1946 my ($level, $endln, @chunks) =
1947 ctx_statement_full($linenr, $realcnt, 1);
1948 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
1949 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
1950 if ($#chunks > 0 && $level == 0) {
1953 my $herectx = $here . "\n";
1954 my $ln = $linenr - 1;
1955 for my $chunk (@chunks) {
1956 my ($cond, $block) = @{$chunk};
1958 # If the condition carries leading newlines, then count those as offsets.
1959 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
1960 my $offset = statement_rawlines($whitespace) - 1;
1962 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
1964 # We have looked at and allowed this specific line.
1965 $suppress_ifbraces{$ln + $offset} = 1;
1967 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
1968 $ln += statement_rawlines($block) - 1;
1970 substr($block, 0, length($cond), '');
1972 $seen++ if ($block =~ /^\s*{/);
1974 #print "cond<$cond> block<$block> allowed<$allowed>\n";
1975 if (statement_lines($cond) > 1) {
1976 #print "APW: ALLOWED: cond<$cond>\n";
1979 if ($block =~/\b(?:if|for|while)\b/) {
1980 #print "APW: ALLOWED: block<$block>\n";
1983 if (statement_block_size($block) > 1) {
1984 #print "APW: ALLOWED: lines block<$block>\n";
1988 if ($seen && !$allowed) {
1989 WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
1993 if (!defined $suppress_ifbraces{$linenr - 1} &&
1994 $line =~ /\b(if|while|for|else)\b/) {
1997 # Check the pre-context.
1998 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
1999 #print "APW: ALLOWED: pre<$1>\n";
2003 my ($level, $endln, @chunks) =
2004 ctx_statement_full($linenr, $realcnt, $-[0]);
2006 # Check the condition.
2007 my ($cond, $block) = @{$chunks[0]};
2008 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
2009 if (defined $cond) {
2010 substr($block, 0, length($cond), '');
2012 if (statement_lines($cond) > 1) {
2013 #print "APW: ALLOWED: cond<$cond>\n";
2016 if ($block =~/\b(?:if|for|while)\b/) {
2017 #print "APW: ALLOWED: block<$block>\n";
2020 if (statement_block_size($block) > 1) {
2021 #print "APW: ALLOWED: lines block<$block>\n";
2024 # Check the post-context.
2025 if (defined $chunks[1]) {
2026 my ($cond, $block) = @{$chunks[1]};
2027 if (defined $cond) {
2028 substr($block, 0, length($cond), '');
2030 if ($block =~ /^\s*\{/) {
2031 #print "APW: ALLOWED: chunk-1 block<$block>\n";
2035 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
2036 my $herectx = $here . "\n";;
2037 my $end = $linenr + statement_rawlines($block) - 1;
2039 for (my $ln = $linenr - 1; $ln < $end; $ln++) {
2040 $herectx .= $rawlines[$ln] . "\n";;
2043 WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
2047 # don't include deprecated include files (uses RAW line)
2048 for my $inc (@dep_includes) {
2049 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
2050 ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2054 # don't use deprecated functions
2055 for my $func (@dep_functions) {
2056 if ($line =~ /\b$func\b/) {
2057 ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2061 # no volatiles please
2062 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2063 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
2064 WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
2067 # SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
2068 if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
2069 ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
2073 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
2074 CHK("if this code is redundant consider removing it\n" .
2078 # check for needless kfree() checks
2079 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2081 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
2082 WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
2085 # check for needless usb_free_urb() checks
2086 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2088 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
2089 WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
2093 # warn about #ifdefs in C files
2094 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
2095 # print "#ifdef in C files should be avoided\n";
2096 # print "$herecurr";
2100 # warn about spacing in #ifdefs
2101 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
2102 ERROR("exactly one space required after that #$1\n" . $herecurr);
2105 # check for spinlock_t definitions without a comment.
2106 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
2107 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
2109 if (!ctx_has_comment($first_line, $linenr)) {
2110 CHK("$1 definition without comment\n" . $herecurr);
2113 # check for memory barriers without a comment.
2114 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2115 if (!ctx_has_comment($first_line, $linenr)) {
2116 CHK("memory barrier without comment\n" . $herecurr);
2119 # check of hardware specific defines
2120 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
2121 CHK("architecture specific defines should be avoided\n" . $herecurr);
2124 # check the location of the inline attribute, that it is between
2125 # storage class and type.
2126 if ($line =~ /\b$Type\s+$Inline\b/ ||
2127 $line =~ /\b$Inline\s+$Storage\b/) {
2128 ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
2131 # Check for __inline__ and __inline, prefer inline
2132 if ($line =~ /\b(__inline__|__inline)\b/) {
2133 WARN("plain inline is preferred over $1\n" . $herecurr);
2136 # check for new externs in .c files.
2137 if ($realfile =~ /\.c$/ && defined $stat &&
2138 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
2140 my $function_name = $1;
2141 my $paren_space = $2;
2144 if (defined $cond) {
2145 substr($s, 0, length($cond), '');
2147 if ($s =~ /^\s*;/ &&
2148 $function_name ne 'uninitialized_var')
2150 WARN("externs should be avoided in .c files\n" . $herecurr);
2153 if ($paren_space =~ /\n/) {
2154 WARN("arguments for function declarations should follow identifier\n" . $herecurr);
2157 } elsif ($realfile =~ /\.c$/ && defined $stat &&
2158 $stat =~ /^.\s*extern\s+/)
2160 WARN("externs should be avoided in .c files\n" . $herecurr);
2163 # checks for new __setup's
2164 if ($rawline =~ /\b__setup\("([^"]*)"/) {
2167 if (!grep(/$name/, @setup_docs)) {
2168 CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
2172 # check for pointless casting of kmalloc return
2173 if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
2174 WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
2177 # check for gcc specific __FUNCTION__
2178 if ($line =~ /__FUNCTION__/) {
2179 WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
2182 # check for semaphores used as mutexes
2183 if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
2184 WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
2186 # check for semaphores used as mutexes
2187 if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
2188 WARN("consider using a completion\n" . $herecurr);
2190 # recommend strict_strto* over simple_strto*
2191 if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2192 WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
2194 # check for __initcall(), use device_initcall() explicitly please
2195 if ($line =~ /^.\s*__initcall\s*\(/) {
2196 WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
2199 # use of NR_CPUS is usually wrong
2200 # ignore definitions of NR_CPUS and usage to define arrays as likely right
2201 if ($line =~ /\bNR_CPUS\b/ &&
2202 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
2203 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
2204 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
2205 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
2206 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
2208 WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
2211 # check for %L{u,d,i} in strings
2213 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2214 $string = substr($rawline, $-[1], $+[1] - $-[1]);
2215 if ($string =~ /(?<!%)%L[udi]/) {
2216 WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2222 # If we have no input at all, then there is nothing to report on
2223 # so just keep quiet.
2224 if ($#rawlines == -1) {
2228 # In mailback mode only produce a report in the negative, for
2229 # things that appear to be patches.
2230 if ($mailback && ($clean == 1 || !$is_patch)) {
2234 # This is not a patch, and we are are in 'no-patch' mode so
2236 if (!$chk_patch && !$is_patch) {
2241 ERROR("Does not appear to be a unified-diff format patch\n");
2243 if ($is_patch && $chk_signoff && $signoff == 0) {
2244 ERROR("Missing Signed-off-by: line(s)\n");
2247 print report_dump();
2248 if ($summary && !($clean == 1 && $quiet == 1)) {
2249 print "$filename " if ($summary_file);
2250 print "total: $cnt_error errors, $cnt_warn warnings, " .
2251 (($check)? "$cnt_chk checks, " : "") .
2252 "$cnt_lines lines checked\n";
2253 print "\n" if ($quiet == 0);
2256 if ($clean == 1 && $quiet == 0) {
2257 print "$vname has no obvious style problems and is ready for submission.\n"
2259 if ($clean == 0 && $quiet == 0) {
2260 print "$vname has style problems, please review. If any of these errors\n";
2261 print "are false positives report them to the maintainer, see\n";
2262 print "CHECKPATCH in MAINTAINERS.\n";