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);
31 'q|quiet+' => \$quiet,
33 'signoff!' => \$chk_signoff,
34 'patch!' => \$chk_patch,
38 'subjective!' => \$check,
41 'summary!' => \$summary,
42 'mailback!' => \$mailback,
43 'summary-file!' => \$summary_file,
46 'test-only=s' => \$tst_only,
52 print "usage: $P [options] patchfile\n";
53 print "version: $V\n";
54 print "options: -q => quiet\n";
55 print " --no-tree => run without a kernel tree\n";
56 print " --terse => one line per report\n";
57 print " --emacs => emacs compile window format\n";
58 print " --file => check a source file\n";
59 print " --strict => enable more subjective tests\n";
60 print " --root => path to the kernel tree root\n";
61 print " --no-summary => suppress the per-file summary\n";
62 print " --summary-file => include the filename in summary\n";
69 for my $key (keys %debug) {
70 eval "\${dbg_$key} = '$debug{$key}';"
80 if (!top_of_kernel_tree($root)) {
81 die "$P: $root: --root does not point at a valid tree\n";
84 if (top_of_kernel_tree('.')) {
86 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
87 top_of_kernel_tree($1)) {
93 print "Must be run from the top-level dir. of a kernel tree\n";
98 my $emitted_corrupt = 0;
100 our $Ident = qr{[A-Za-z_][A-Za-z\d_]*};
101 our $Storage = qr{extern|static|asmlinkage};
115 __(?:mem|cpu|dev|)(?:initdata|init)
118 our $Inline = qr{inline|__always_inline|noinline};
119 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
120 our $Lval = qr{$Ident(?:$Member)*};
122 our $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
123 our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
127 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
135 [\x09\x0A\x0D\x20-\x7E] # ASCII
136 | [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
137 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
138 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
139 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
140 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
141 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
142 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
147 qr{(?:unsigned\s+)?char},
148 qr{(?:unsigned\s+)?short},
149 qr{(?:unsigned\s+)?int},
150 qr{(?:unsigned\s+)?long},
151 qr{(?:unsigned\s+)?long\s+int},
152 qr{(?:unsigned\s+)?long\s+long},
153 qr{(?:unsigned\s+)?long\s+long\s+int},
158 qr{(?:__)?(?:u|s|be|le)(?:8|16|32|64)},
163 qr{${Ident}_handler},
164 qr{${Ident}_handler_fn},
166 our @modifierList = (
171 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
172 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
173 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
175 (?:$Modifier\s+|const\s+)*
177 (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
180 (?:\s+$Modifier|\s+const)*
184 (?:\s*\*+\s*const|\s*\*+|(?:\s*\[\s*\])+)?
185 (?:\s+$Inline|\s+$Modifier)*
187 $Declare = qr{(?:$Storage\s+)?$Type};
191 $chk_signoff = 0 if ($file);
193 my @dep_includes = ();
194 my @dep_functions = ();
195 my $removal = "Documentation/feature-removal-schedule.txt";
196 if ($tree && -f "$root/$removal") {
197 open(REMOVE, "<$root/$removal") ||
198 die "$P: $removal: open failed - $!\n";
200 if (/^Check:\s+(.*\S)/) {
201 for my $entry (split(/[, ]+/, $1)) {
202 if ($entry =~ m@include/(.*)@) {
203 push(@dep_includes, $1);
205 } elsif ($entry !~ m@/@) {
206 push(@dep_functions, $entry);
216 for my $filename (@ARGV) {
218 open(FILE, "diff -u /dev/null $filename|") ||
219 die "$P: $filename: diff failed - $!\n";
221 open(FILE, "<$filename") ||
222 die "$P: $filename: open failed - $!\n";
224 if ($filename eq '-') {
225 $vname = 'Your patch';
234 if (!process($filename)) {
243 sub top_of_kernel_tree {
247 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
248 "README", "Documentation", "arch", "include", "drivers",
249 "fs", "init", "ipc", "kernel", "lib", "scripts",
252 foreach my $check (@tree_check) {
253 if (! -e $root . '/' . $check) {
265 for my $c (split(//, $str)) {
269 for (; ($n % 8) != 0; $n++) {
281 (my $res = shift) =~ tr/\t/ /c;
288 # Drop the diff line leader and expand tabs
290 $line = expand_tabs($line);
292 # Pick the indent from the front of the line.
293 my ($white) = ($line =~ /^(\s*)/);
295 return (length($line), length($white));
298 my $sanitise_quote = '';
300 sub sanitise_line_reset {
301 my ($in_comment) = @_;
304 $sanitise_quote = '*/';
306 $sanitise_quote = '';
319 # Always copy over the diff marker.
320 $res = substr($line, 0, 1);
322 for ($off = 1; $off < length($line); $off++) {
323 $c = substr($line, $off, 1);
325 # Comments we are wacking completly including the begin
326 # and end, all to $;.
327 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
328 $sanitise_quote = '*/';
330 substr($res, $off, 2, "$;$;");
334 if (substr($line, $off, 2) eq '*/') {
335 $sanitise_quote = '';
336 substr($res, $off, 2, "$;$;");
341 # A \ in a string means ignore the next character.
342 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
344 substr($res, $off, 2, 'XX');
349 if ($c eq "'" || $c eq '"') {
350 if ($sanitise_quote eq '') {
351 $sanitise_quote = $c;
353 substr($res, $off, 1, $c);
355 } elsif ($sanitise_quote eq $c) {
356 $sanitise_quote = '';
360 #print "SQ:$sanitise_quote\n";
361 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
362 substr($res, $off, 1, $;);
363 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
364 substr($res, $off, 1, 'X');
366 substr($res, $off, 1, $c);
370 # The pathname on a #include may be surrounded by '<' and '>'.
371 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
372 my $clean = 'X' x length($1);
373 $res =~ s@\<.*\>@<$clean>@;
375 # The whole of a #error is a string.
376 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
377 my $clean = 'X' x length($1);
378 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
384 sub ctx_statement_block {
385 my ($linenr, $remain, $off) = @_;
386 my $line = $linenr - 1;
402 #warn "CSB: blk<$blk> remain<$remain>\n";
403 # If we are about to drop off the end, pull in more
406 for (; $remain > 0; $line++) {
407 next if ($lines[$line] =~ /^-/);
410 $blk .= $lines[$line] . "\n";
415 # Bail if there is no further context.
416 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
422 $c = substr($blk, $off, 1);
423 $remainder = substr($blk, $off);
425 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
426 # Statement ends at the ';' or a close '}' at the
428 if ($level == 0 && $c eq ';') {
432 # An else is really a conditional as long as its not else if
433 if ($level == 0 && $coff_set == 0 &&
434 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
435 $remainder =~ /^(else)(?:\s|{)/ &&
436 $remainder !~ /^else\s+if\b/) {
437 $coff = $off + length($1) - 1;
439 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
440 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
443 if (($type eq '' || $type eq '(') && $c eq '(') {
447 if ($type eq '(' && $c eq ')') {
449 $type = ($level != 0)? '(' : '';
451 if ($level == 0 && $coff < $soff) {
454 #warn "CSB: mark coff<$coff>\n";
457 if (($type eq '' || $type eq '{') && $c eq '{') {
461 if ($type eq '{' && $c eq '}') {
463 $type = ($level != 0)? '{' : '';
471 # We are truly at the end, so shuffle to the next line.
478 my $statement = substr($blk, $soff, $off - $soff + 1);
479 my $condition = substr($blk, $soff, $coff - $soff + 1);
481 #warn "STATEMENT<$statement>\n";
482 #warn "CONDITION<$condition>\n";
484 #print "coff<$coff> soff<$off> loff<$loff>\n";
486 return ($statement, $condition,
487 $line, $remain + 1, $off - $loff + 1, $level);
490 sub statement_lines {
493 # Strip the diff line prefixes and rip blank lines at start and end.
494 $stmt =~ s/(^|\n)./$1/g;
498 my @stmt_lines = ($stmt =~ /\n/g);
500 return $#stmt_lines + 2;
503 sub statement_rawlines {
506 my @stmt_lines = ($stmt =~ /\n/g);
508 return $#stmt_lines + 2;
511 sub statement_block_size {
514 $stmt =~ s/(^|\n)./$1/g;
520 my @stmt_lines = ($stmt =~ /\n/g);
521 my @stmt_statements = ($stmt =~ /;/g);
523 my $stmt_lines = $#stmt_lines + 2;
524 my $stmt_statements = $#stmt_statements + 1;
526 if ($stmt_lines > $stmt_statements) {
529 return $stmt_statements;
533 sub ctx_statement_full {
534 my ($linenr, $remain, $off) = @_;
535 my ($statement, $condition, $level);
539 # Grab the first conditional/block pair.
540 ($statement, $condition, $linenr, $remain, $off, $level) =
541 ctx_statement_block($linenr, $remain, $off);
542 #print "F: c<$condition> s<$statement> remain<$remain>\n";
543 push(@chunks, [ $condition, $statement ]);
544 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
545 return ($level, $linenr, @chunks);
548 # Pull in the following conditional/block pairs and see if they
549 # could continue the statement.
551 ($statement, $condition, $linenr, $remain, $off, $level) =
552 ctx_statement_block($linenr, $remain, $off);
553 #print "C: c<$condition> s<$statement> remain<$remain>\n";
554 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
556 push(@chunks, [ $condition, $statement ]);
559 return ($level, $linenr, @chunks);
563 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
565 my $start = $linenr - 1;
572 for ($line = $start; $remain > 0; $line++) {
573 next if ($rawlines[$line] =~ /^-/);
576 $blk .= $rawlines[$line];
577 foreach my $c (split(//, $rawlines[$line])) {
578 ##print "C<$c>L<$level><$open$close>O<$off>\n";
584 if ($c eq $close && $level > 0) {
586 last if ($level == 0);
587 } elsif ($c eq $open) {
592 if (!$outer || $level <= 1) {
593 push(@res, $rawlines[$line]);
596 last if ($level == 0);
599 return ($level, @res);
601 sub ctx_block_outer {
602 my ($linenr, $remain) = @_;
604 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
608 my ($linenr, $remain) = @_;
610 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
614 my ($linenr, $remain, $off) = @_;
616 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
619 sub ctx_block_level {
620 my ($linenr, $remain) = @_;
622 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
624 sub ctx_statement_level {
625 my ($linenr, $remain, $off) = @_;
627 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
630 sub ctx_locate_comment {
631 my ($first_line, $end_line) = @_;
633 # Catch a comment on the end of the line itself.
634 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
635 return $current_comment if (defined $current_comment);
637 # Look through the context and try and figure out if there is a
640 $current_comment = '';
641 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
642 my $line = $rawlines[$linenr - 1];
644 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
647 if ($line =~ m@/\*@) {
650 if (!$in_comment && $current_comment ne '') {
651 $current_comment = '';
653 $current_comment .= $line . "\n" if ($in_comment);
654 if ($line =~ m@\*/@) {
659 chomp($current_comment);
660 return($current_comment);
662 sub ctx_has_comment {
663 my ($first_line, $end_line) = @_;
664 my $cmt = ctx_locate_comment($first_line, $end_line);
666 ##print "LINE: $rawlines[$end_line - 1 ]\n";
667 ##print "CMMT: $cmt\n";
677 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
680 $coded = sprintf("^%c", unpack('C', $2) + 64);
689 my $av_preprocessor = 0;
695 $av_preprocessor = 0;
697 @av_paren_type = ('E');
698 $av_pend_colon = 'O';
701 sub annotate_values {
702 my ($stream, $type) = @_;
705 my $var = '_' x length($stream);
708 print "$stream\n" if ($dbg_values > 1);
710 while (length($cur)) {
711 @av_paren_type = ('E') if ($#av_paren_type < 0);
712 print " <" . join('', @av_paren_type) .
713 "> <$type> <$av_pending>" if ($dbg_values > 1);
714 if ($cur =~ /^(\s+)/o) {
715 print "WS($1)\n" if ($dbg_values > 1);
716 if ($1 =~ /\n/ && $av_preprocessor) {
717 $type = pop(@av_paren_type);
718 $av_preprocessor = 0;
721 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\()/) {
722 print "DECLARE($1)\n" if ($dbg_values > 1);
725 } elsif ($cur =~ /^($Modifier)\s*/) {
726 print "MODIFIER($1)\n" if ($dbg_values > 1);
729 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
730 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
731 $av_preprocessor = 1;
732 push(@av_paren_type, $type);
738 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
739 print "UNDEF($1)\n" if ($dbg_values > 1);
740 $av_preprocessor = 1;
741 push(@av_paren_type, $type);
743 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
744 print "PRE_START($1)\n" if ($dbg_values > 1);
745 $av_preprocessor = 1;
747 push(@av_paren_type, $type);
748 push(@av_paren_type, $type);
751 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
752 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
753 $av_preprocessor = 1;
755 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
759 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
760 print "PRE_END($1)\n" if ($dbg_values > 1);
762 $av_preprocessor = 1;
764 # Assume all arms of the conditional end as this
765 # one does, and continue as if the #endif was not here.
767 push(@av_paren_type, $type);
770 } elsif ($cur =~ /^(\\\n)/o) {
771 print "PRECONT($1)\n" if ($dbg_values > 1);
773 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
774 print "ATTR($1)\n" if ($dbg_values > 1);
778 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
779 print "SIZEOF($1)\n" if ($dbg_values > 1);
785 } elsif ($cur =~ /^(if|while|typeof|__typeof__|for)\b/o) {
786 print "COND($1)\n" if ($dbg_values > 1);
790 } elsif ($cur =~/^(case)/o) {
791 print "CASE($1)\n" if ($dbg_values > 1);
792 $av_pend_colon = 'C';
795 } elsif ($cur =~/^(return|else|goto)/o) {
796 print "KEYWORD($1)\n" if ($dbg_values > 1);
799 } elsif ($cur =~ /^(\()/o) {
800 print "PAREN('$1')\n" if ($dbg_values > 1);
801 push(@av_paren_type, $av_pending);
805 } elsif ($cur =~ /^(\))/o) {
806 my $new_type = pop(@av_paren_type);
807 if ($new_type ne '_') {
809 print "PAREN('$1') -> $type\n"
810 if ($dbg_values > 1);
812 print "PAREN('$1')\n" if ($dbg_values > 1);
815 } elsif ($cur =~ /^($Ident)\s*\(/o) {
816 print "FUNC($1)\n" if ($dbg_values > 1);
820 } elsif ($cur =~ /^($Ident\s*):/) {
822 $av_pend_colon = 'L';
823 } elsif ($type eq 'T') {
824 $av_pend_colon = 'B';
826 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
829 } elsif ($cur =~ /^($Ident|$Constant)/o) {
830 print "IDENT($1)\n" if ($dbg_values > 1);
833 } elsif ($cur =~ /^($Assignment)/o) {
834 print "ASSIGN($1)\n" if ($dbg_values > 1);
837 } elsif ($cur =~/^(;|{|})/) {
838 print "END($1)\n" if ($dbg_values > 1);
840 $av_pend_colon = 'O';
842 } elsif ($cur =~ /^(\?)/o) {
843 print "QUESTION($1)\n" if ($dbg_values > 1);
846 } elsif ($cur =~ /^(:)/o) {
847 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
849 substr($var, length($res), 1, $av_pend_colon);
850 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
855 $av_pend_colon = 'O';
857 } elsif ($cur =~ /^(;|\[)/o) {
858 print "CLOSE($1)\n" if ($dbg_values > 1);
861 } elsif ($cur =~ /^($Operators)/o) {
862 print "OP($1)\n" if ($dbg_values > 1);
863 if ($1 ne '++' && $1 ne '--') {
867 } elsif ($cur =~ /(^.)/o) {
868 print "C($1)\n" if ($dbg_values > 1);
871 $cur = substr($cur, length($1));
872 $res .= $type x length($1);
880 my ($possible, $line) = @_;
882 print "CHECK<$possible> ($line)\n" if ($dbg_possible > 1);
883 if ($possible !~ /^(?:$Modifier|$Storage|$Type|DEFINE_\S+)$/ &&
884 $possible ne 'goto' && $possible ne 'return' &&
885 $possible ne 'case' && $possible ne 'else' &&
886 $possible ne 'asm' && $possible ne '__asm__' &&
887 $possible !~ /^(typedef|struct|enum)\b/) {
888 # Check for modifiers.
889 $possible =~ s/\s*$Storage\s*//g;
890 $possible =~ s/\s*$Sparse\s*//g;
891 if ($possible =~ /^\s*$/) {
893 } elsif ($possible =~ /\s/) {
894 $possible =~ s/\s*$Type\s*//g;
895 for my $modifier (split(' ', $possible)) {
896 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
897 push(@modifierList, $modifier);
901 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
902 push(@typeList, $possible);
911 if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
914 my $line = $prefix . $_[0];
916 $line = (split('\n', $line))[0] . "\n" if ($terse);
918 push(our @report, $line);
926 if (report("ERROR: $_[0]\n")) {
932 if (report("WARNING: $_[0]\n")) {
938 if ($check && report("CHECK: $_[0]\n")) {
945 my $filename = shift;
968 # Trace the real file/line as we go.
974 my $comment_edge = 0;
977 my $prev_values = 'E';
980 my %suppress_ifbraces;
982 # Pre-scan the patch sanitizing the lines.
983 # Pre-scan the patch looking for any __setup documentation.
988 sanitise_line_reset();
990 foreach my $rawline (@rawlines) {
994 if ($rawline=~/^\+\+\+\s+(\S+)/) {
996 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1001 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1010 # Guestimate if this is a continuing comment. Run
1011 # the context looking for a comment "edge". If this
1012 # edge is a close comment then we must be in a comment
1015 for (my $ln = $linenr + 1; $ln < ($linenr + $realcnt); $ln++) {
1016 next if ($line =~ /^-/);
1017 ($edge) = ($rawlines[$ln - 1] =~ m@(/\*|\*/)@);
1018 last if (defined $edge);
1020 if (defined $edge && $edge eq '*/') {
1024 # Guestimate if this is a continuing comment. If this
1025 # is the start of a diff block and this line starts
1026 # ' *' then it is very likely a comment.
1027 if (!defined $edge &&
1028 $rawlines[$linenr] =~ m@^.\s* \*(?:\s|$)@)
1033 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1034 sanitise_line_reset($in_comment);
1036 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1037 # Standardise the strings and chars within the input to
1038 # simplify matching -- only bother with positive lines.
1039 $line = sanitise_line($rawline);
1041 push(@lines, $line);
1044 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1049 #print "==>$rawline\n";
1050 #print "-->$line\n";
1052 if ($setup_docs && $line =~ /^\+/) {
1053 push(@setup_docs, $line);
1061 foreach my $line (@lines) {
1064 my $rawline = $rawlines[$linenr - 1];
1066 #extract the line range in the file after the patch is applied
1067 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1069 $first_line = $linenr + 1;
1079 %suppress_ifbraces = ();
1082 # track the line number as we move through the hunk, note that
1083 # new versions of GNU diff omit the leading space on completely
1084 # blank context lines so we need to count that too.
1085 } elsif ($line =~ /^( |\+|$)/) {
1087 $realcnt-- if ($realcnt != 0);
1089 # Measure the line length and indent.
1090 ($length, $indent) = line_stats($rawline);
1092 # Track the previous line.
1093 ($prevline, $stashline) = ($stashline, $line);
1094 ($previndent, $stashindent) = ($stashindent, $indent);
1095 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1097 #warn "line<$line>\n";
1099 } elsif ($realcnt == 1) {
1103 #make up the handle for any error we report on this line
1104 $prefix = "$filename:$realline: " if ($emacs && $file);
1105 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1107 $here = "#$linenr: " if (!$file);
1108 $here = "#$realline: " if ($file);
1110 # extract the filename as it passes
1111 if ($line=~/^\+\+\+\s+(\S+)/) {
1113 $realfile =~ s@^[^/]*/@@;
1115 if ($realfile =~ m@include/asm/@) {
1116 ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1121 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
1123 my $hereline = "$here\n$rawline\n";
1124 my $herecurr = "$here\n$rawline\n";
1125 my $hereprev = "$here\n$prevrawline\n$rawline\n";
1127 $cnt_lines++ if ($realcnt != 0);
1129 #check the patch for a signoff:
1130 if ($line =~ /^\s*signed-off-by:/i) {
1131 # This is a signoff, if ugly, so do not double report.
1133 if (!($line =~ /^\s*Signed-off-by:/)) {
1134 WARN("Signed-off-by: is the preferred form\n" .
1137 if ($line =~ /^\s*signed-off-by:\S/i) {
1138 WARN("space required after Signed-off-by:\n" .
1143 # Check for wrappage within a valid hunk of the file
1144 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1145 ERROR("patch seems to be corrupt (line wrapped?)\n" .
1146 $herecurr) if (!$emitted_corrupt++);
1149 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1150 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1151 $rawline !~ m/^$UTF8*$/) {
1152 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1154 my $blank = copy_spacing($rawline);
1155 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1156 my $hereptr = "$hereline$ptr\n";
1158 ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1161 #ignore lines being removed
1162 if ($line=~/^-/) {next;}
1164 # check we are in a valid source file if not then ignore this hunk
1165 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1167 #trailing whitespace
1168 if ($line =~ /^\+.*\015/) {
1169 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1170 ERROR("DOS line endings\n" . $herevet);
1172 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1173 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1174 ERROR("trailing whitespace\n" . $herevet);
1177 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
1178 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1179 $line !~ /^\+\s*printk\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ &&
1182 WARN("line over 80 characters\n" . $herecurr);
1185 # check for adding lines without a newline.
1186 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1187 WARN("adding a line without newline at end of file\n" . $herecurr);
1190 # check we are in a valid source file *.[hc] if not then ignore this hunk
1191 next if ($realfile !~ /\.[hc]$/);
1193 # at the beginning of a line any tabs must come first and anything
1194 # more than 8 must use tabs.
1195 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1196 $rawline =~ /^\+\s* \s*/) {
1197 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1198 ERROR("code indent should use tabs where possible\n" . $herevet);
1201 # check for RCS/CVS revision markers
1202 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
1203 WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1206 # Check for potential 'bare' types
1207 my ($stat, $cond, $line_nr_next, $remain_next);
1208 if ($realcnt && $line =~ /.\s*\S/) {
1209 ($stat, $cond, $line_nr_next, $remain_next) =
1210 ctx_statement_block($linenr, $realcnt, 0);
1211 $stat =~ s/\n./\n /g;
1212 $cond =~ s/\n./\n /g;
1217 # Ignore goto labels.
1218 if ($s =~ /$Ident:\*$/s) {
1220 # Ignore functions being called
1221 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
1223 # declarations always start with types
1224 } 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) {
1227 possible($type, "A:" . $s);
1229 # definitions in global scope can only start with types
1230 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b/s) {
1231 possible($1, "B:" . $s);
1234 # any (foo ... *) is a pointer cast, and foo is a type
1235 while ($s =~ /\(($Ident)(?:\s+$Sparse)*\s*\*+\s*\)/sg) {
1236 possible($1, "C:" . $s);
1239 # Check for any sort of function declaration.
1240 # int foo(something bar, other baz);
1241 # void (*store_gdt)(x86_descr_ptr *);
1242 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
1243 my ($name_len) = length($1);
1246 substr($ctx, 0, $name_len + 1, '');
1247 $ctx =~ s/\)[^\)]*$//;
1249 for my $arg (split(/\s*,\s*/, $ctx)) {
1250 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
1252 possible($1, "D:" . $s);
1260 # Checks which may be anchored in the context.
1263 # Check for switch () and associated case and default
1264 # statements should be at the same indent.
1265 if ($line=~/\bswitch\s*\(.*\)/) {
1268 my @ctx = ctx_block_outer($linenr, $realcnt);
1270 for my $ctx (@ctx) {
1271 my ($clen, $cindent) = line_stats($ctx);
1272 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1273 $indent != $cindent) {
1274 $err .= "$sep$ctx\n";
1281 ERROR("switch and case should be at the same indent\n$hereline$err");
1284 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
1285 $line !~ /\G(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$/g) {
1286 ERROR("trailing statements should be on next line\n" . $herecurr);
1289 # if/while/etc brace do not go on next line, unless defining a do while loop,
1290 # or if that brace on the next line is for something else
1291 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
1292 my $pre_ctx = "$1$2";
1294 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
1295 my $ctx_cnt = $realcnt - $#ctx - 1;
1296 my $ctx = join("\n", @ctx);
1298 my $ctx_ln = $linenr;
1299 my $ctx_skip = $realcnt;
1301 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1302 defined $lines[$ctx_ln - 1] &&
1303 $lines[$ctx_ln - 1] =~ /^-/)) {
1304 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1305 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
1309 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1310 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
1312 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1313 ERROR("that open brace { should be on the previous line\n" .
1314 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1316 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1317 $ctx =~ /\)\s*\;\s*$/ &&
1318 defined $lines[$ctx_ln - 1])
1320 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1321 if ($nindent > $indent) {
1322 WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
1323 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1328 # Track the 'values' across context and added lines.
1329 my $opline = $line; $opline =~ s/^./ /;
1330 my ($curr_values, $curr_vars) =
1331 annotate_values($opline . "\n", $prev_values);
1332 $curr_values = $prev_values . $curr_values;
1334 my $outline = $opline; $outline =~ s/\t/ /g;
1335 print "$linenr > .$outline\n";
1336 print "$linenr > $curr_values\n";
1337 print "$linenr > $curr_vars\n";
1339 $prev_values = substr($curr_values, -1);
1341 #ignore lines not being added
1342 if ($line=~/^[^\+]/) {next;}
1344 # TEST: allow direct testing of the type matcher.
1346 if ($line =~ /^.\s*$Declare\s*$/) {
1347 ERROR("TEST: is type\n" . $herecurr);
1348 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
1349 ERROR("TEST: is not type ($1 is)\n". $herecurr);
1354 # check for initialisation to aggregates open brace on the next line
1355 if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ &&
1356 $line =~ /^.\s*{/) {
1357 ERROR("that open brace { should be on the previous line\n" . $hereprev);
1361 # Checks which are anchored on the added line.
1364 # check for malformed paths in #include statements (uses RAW line)
1365 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
1367 if ($path =~ m{//}) {
1368 ERROR("malformed #include filename\n" .
1373 # no C99 // comments
1374 if ($line =~ m{//}) {
1375 ERROR("do not use C99 // comments\n" . $herecurr);
1377 # Remove C99 comments.
1379 $opline =~ s@//.*@@;
1381 #EXPORT_SYMBOL should immediately follow its function closing }.
1382 if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) ||
1383 ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1385 if (($prevline !~ /^}/) &&
1386 ($prevline !~ /^\+}/) &&
1387 ($prevline !~ /^ }/) &&
1388 ($prevline !~ /^.DECLARE_$Ident\(\Q$name\E\)/) &&
1389 ($prevline !~ /^.LIST_HEAD\(\Q$name\E\)/) &&
1390 ($prevline !~ /^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(/) &&
1391 ($prevline !~ /\b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[)/)) {
1392 WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
1396 # check for external initialisers.
1397 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
1398 ERROR("do not initialise externals to 0 or NULL\n" .
1401 # check for static initialisers.
1402 if ($line =~ /\s*static\s.*=\s*(0|NULL|false)\s*;/) {
1403 ERROR("do not initialise statics to 0 or NULL\n" .
1407 # check for new typedefs, only function parameters and sparse annotations
1409 if ($line =~ /\btypedef\s/ &&
1410 $line !~ /\btypedef\s+$Type\s+\(\s*\*?$Ident\s*\)\s*\(/ &&
1411 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
1412 $line !~ /\b__bitwise(?:__|)\b/) {
1413 WARN("do not add new typedefs\n" . $herecurr);
1416 # * goes on variable not on type
1417 if ($line =~ m{\($NonptrType(\*+)(?:\s+const)?\)}) {
1418 ERROR("\"(foo$1)\" should be \"(foo $1)\"\n" .
1421 } elsif ($line =~ m{\($NonptrType\s+(\*+)(?!\s+const)\s+\)}) {
1422 ERROR("\"(foo $1 )\" should be \"(foo $1)\"\n" .
1425 } elsif ($line =~ m{$NonptrType(\*+)(?:\s+(?:$Attribute|$Sparse))?\s+[A-Za-z\d_]+}) {
1426 ERROR("\"foo$1 bar\" should be \"foo $1bar\"\n" .
1429 } elsif ($line =~ m{$NonptrType\s+(\*+)(?!\s+(?:$Attribute|$Sparse))\s+[A-Za-z\d_]+}) {
1430 ERROR("\"foo $1 bar\" should be \"foo $1bar\"\n" .
1434 # # no BUG() or BUG_ON()
1435 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
1436 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
1437 # print "$herecurr";
1441 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
1442 WARN("LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
1445 # printk should use KERN_* levels. Note that follow on printk's on the
1446 # same line do not need a level, so we use the current block context
1447 # to try and find and validate the current printk. In summary the current
1448 # printk includes all preceeding printk's which have no newline on the end.
1449 # we assume the first bad printk is the one to report.
1450 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
1452 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
1453 #print "CHECK<$lines[$ln - 1]\n";
1454 # we have a preceeding printk if it ends
1455 # with "\n" ignore it, else it is to blame
1456 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
1457 if ($rawlines[$ln - 1] !~ m{\\n"}) {
1464 WARN("printk() should include KERN_ facility level\n" . $herecurr);
1468 # function brace can't be on same line, except for #defines of do while,
1469 # or if closed on same line
1470 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
1471 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
1472 ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
1475 # open braces for enum, union and struct go on the same line.
1476 if ($line =~ /^.\s*{/ &&
1477 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1478 ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
1481 # check for spacing round square brackets; allowed:
1482 # 1. with a type on the left -- int [] a;
1483 # 2. at the beginning of a line for slice initialisers -- [0..10] = 5,
1484 while ($line =~ /(.*?\s)\[/g) {
1485 my ($where, $prefix) = ($-[1], $1);
1486 if ($prefix !~ /$Type\s+$/ &&
1487 ($where != 0 || $prefix !~ /^.\s+$/)) {
1488 ERROR("space prohibited before open square bracket '['\n" . $herecurr);
1492 # check for spaces between functions and their parentheses.
1493 while ($line =~ /($Ident)\s+\(/g) {
1495 my $ctx_before = substr($line, 0, $-[1]);
1496 my $ctx = "$ctx_before$name";
1498 # Ignore those directives where spaces _are_ permitted.
1500 if|for|while|switch|return|case|
1501 volatile|__volatile__|
1502 __attribute__|format|__extension__|
1506 # cpp #define statements have non-optional spaces, ie
1507 # if there is a space between the name and the open
1508 # parenthesis it is simply not a parameter group.
1509 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
1511 # cpp #elif statement condition may start with a (
1512 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
1514 # If this whole things ends with a type its most
1515 # likely a typedef for a function.
1516 } elsif ($ctx =~ /$Type$/) {
1519 WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
1522 # Check operator spacing.
1523 if (!($line=~/\#\s*include/)) {
1525 <<=|>>=|<=|>=|==|!=|
1526 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
1527 =>|->|<<|>>|<|>|=|!|~|
1528 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
1531 my @elements = split(/($ops|;)/, $opline);
1534 my $blank = copy_spacing($opline);
1536 for (my $n = 0; $n < $#elements; $n += 2) {
1537 $off += length($elements[$n]);
1539 # Pick up the preceeding and succeeding characters.
1540 my $ca = substr($opline, 0, $off);
1542 if (length($opline) >= ($off + length($elements[$n + 1]))) {
1543 $cc = substr($opline, $off + length($elements[$n + 1]));
1545 my $cb = "$ca$;$cc";
1548 $a = 'V' if ($elements[$n] ne '');
1549 $a = 'W' if ($elements[$n] =~ /\s$/);
1550 $a = 'C' if ($elements[$n] =~ /$;$/);
1551 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
1552 $a = 'O' if ($elements[$n] eq '');
1553 $a = 'E' if ($ca =~ /^\s*$/);
1555 my $op = $elements[$n + 1];
1558 if (defined $elements[$n + 2]) {
1559 $c = 'V' if ($elements[$n + 2] ne '');
1560 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
1561 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
1562 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
1563 $c = 'O' if ($elements[$n + 2] eq '');
1564 $c = 'E' if ($elements[$n + 2] =~ /\s*\\$/);
1569 my $ctx = "${a}x${c}";
1571 my $at = "(ctx:$ctx)";
1573 my $ptr = substr($blank, 0, $off) . "^";
1574 my $hereptr = "$hereline$ptr\n";
1576 # Classify operators into binary, unary, or
1577 # definitions (* only) where they have more
1579 my $op_type = substr($curr_values, $off + 1, 1);
1580 my $op_left = substr($curr_values, $off, 1);
1582 if ($op_type eq 'T') {
1584 } elsif ($op_left eq 'V') {
1589 #if ($op eq '-' || $op eq '&' || $op eq '*') {
1590 # print "UNARY: <$op_left$op_type $is_unary $a:$op:$c> <$ca:$op:$cc> <$unary_ctx>\n";
1593 # Get the full operator variant.
1594 my $opv = $op . substr($curr_vars, $off, 1);
1596 # Ignore operators passed as parameters.
1597 if ($op_type ne 'V' &&
1598 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
1601 # } elsif ($op =~ /^$;+$/) {
1603 # ; should have either the end of line or a space or \ after it
1604 } elsif ($op eq ';') {
1605 if ($ctx !~ /.x[WEBC]/ &&
1606 $cc !~ /^\\/ && $cc !~ /^;/) {
1607 ERROR("space required after that '$op' $at\n" . $hereptr);
1611 } elsif ($op eq '//') {
1615 # : when part of a bitfield
1616 } elsif ($op eq '->' || $opv eq ':B') {
1617 if ($ctx =~ /Wx.|.xW/) {
1618 ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
1621 # , must have a space on the right.
1622 } elsif ($op eq ',') {
1623 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
1624 ERROR("space required after that '$op' $at\n" . $hereptr);
1627 # '*' as part of a type definition -- reported already.
1628 } elsif ($op eq '*' && $is_unary == 2) {
1629 #warn "'*' is part of type\n";
1631 # unary operators should have a space before and
1632 # none after. May be left adjacent to another
1633 # unary operator, or a cast
1634 } elsif ($op eq '!' || $op eq '~' ||
1635 ($is_unary && ($op eq '*' || $op eq '-' || $op eq '&'))) {
1636 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
1637 ERROR("space required before that '$op' $at\n" . $hereptr);
1639 if ($op eq '*' && $cc =~/\s*const\b/) {
1640 # A unary '*' may be const
1642 } elsif ($ctx =~ /.xW/) {
1643 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1646 # unary ++ and unary -- are allowed no space on one side.
1647 } elsif ($op eq '++' or $op eq '--') {
1648 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
1649 ERROR("space required one side of that '$op' $at\n" . $hereptr);
1651 if ($ctx =~ /Wx[BE]/ ||
1652 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
1653 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
1655 if ($ctx =~ /ExW/) {
1656 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1660 # << and >> may either have or not have spaces both sides
1661 } elsif ($op eq '<<' or $op eq '>>' or
1662 $op eq '&' or $op eq '^' or $op eq '|' or
1663 $op eq '+' or $op eq '-' or
1664 $op eq '*' or $op eq '/' or
1667 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
1668 ERROR("need consistent spacing around '$op' $at\n" .
1672 # A colon needs no spaces before when it is
1673 # terminating a case value or a label.
1674 } elsif ($opv eq ':C' || $opv eq ':L') {
1675 if ($ctx =~ /Wx./) {
1676 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
1679 # All the others need spaces both sides.
1680 } elsif ($ctx !~ /[EWC]x[CWE]/) {
1683 # Ignore email addresses <foo@bar>
1685 $cc =~ /^\S+\@\S+>/) ||
1687 $ca =~ /<\S+\@\S+$/))
1693 if (($opv eq ':O' && $ca =~ /\?$/) ||
1694 ($op eq '?' && $cc =~ /^:/)) {
1699 ERROR("spaces required around that '$op' $at\n" . $hereptr);
1702 $off += length($elements[$n + 1]);
1706 # check for multiple assignments
1707 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
1708 CHK("multiple assignments should be avoided\n" . $herecurr);
1711 ## # check for multiple declarations, allowing for a function declaration
1713 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
1714 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
1716 ## # Remove any bracketed sections to ensure we do not
1717 ## # falsly report the parameters of functions.
1719 ## while ($ln =~ s/\([^\(\)]*\)//g) {
1721 ## if ($ln =~ /,/) {
1722 ## WARN("declaring multiple variables together should be avoided\n" . $herecurr);
1726 #need space before brace following if, while, etc
1727 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
1729 ERROR("space required before the open brace '{'\n" . $herecurr);
1732 # closing brace should have a space following it when it has anything
1734 if ($line =~ /}(?!(?:,|;|\)))\S/) {
1735 ERROR("space required after that close brace '}'\n" . $herecurr);
1738 # check spacing on square brackets
1739 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
1740 ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
1742 if ($line =~ /\s\]/) {
1743 ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
1746 # check spacing on parentheses
1747 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
1748 $line !~ /for\s*\(\s+;/) {
1749 ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
1751 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
1752 $line !~ /for\s*\(.*;\s+\)/ &&
1753 $line !~ /:\s+\)/) {
1754 ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
1757 #goto labels aren't indented, allow a single space however
1758 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
1759 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
1760 WARN("labels should not be indented\n" . $herecurr);
1763 # Return is not a function.
1764 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
1768 # Flatten any parentheses and braces
1769 $value =~ s/\)\(/\) \(/g;
1770 while ($value =~ s/\([^\(\)]*\)/1/) {
1773 if ($value =~ /^(?:$Ident|-?$Constant)$/) {
1774 ERROR("return is not a function, parentheses are not required\n" . $herecurr);
1776 } elsif ($spacing !~ /\s+/) {
1777 ERROR("space required before the open parenthesis '('\n" . $herecurr);
1781 # Need a space before open parenthesis after if, while etc
1782 if ($line=~/\b(if|while|for|switch)\(/) {
1783 ERROR("space required before the open parenthesis '('\n" . $herecurr);
1786 # Check for illegal assignment in if conditional -- and check for trailing
1787 # statements after the conditional.
1788 if ($line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
1789 my ($s, $c) = ($stat, $cond);
1791 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/) {
1792 ERROR("do not use assignment in if condition\n" . $herecurr);
1795 # Find out what is on the end of the line after the
1797 substr($s, 0, length($c), '');
1799 $s =~ s/$;//g; # Remove any comments
1800 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
1801 $c !~ /}\s*while\s*/)
1803 ERROR("trailing statements should be on next line\n" . $herecurr);
1807 # Check relative indent for conditionals and blocks.
1808 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1809 my ($s, $c) = ($stat, $cond);
1811 substr($s, 0, length($c), '');
1813 # Make sure we remove the line prefixes as we have
1814 # none on the first line, and are going to readd them
1818 # We want to check the first line inside the block
1819 # starting at the end of the conditional, so remove:
1820 # 1) any blank line termination
1821 # 2) any opening brace { on end of the line
1823 my $continuation = 0;
1825 $s =~ s/^.*\bdo\b//;
1827 if ($s =~ s/^\s*\\//) {
1830 if ($s =~ s/^\s*\n//) {
1834 # Also ignore a loop construct at the end of a
1835 # preprocessor statement.
1836 if (($prevline =~ /^.\s*#\s*define\s/ ||
1837 $prevline =~ /\\\s*$/) && $continuation == 0) {
1841 # Ignore the current line if its is a preprocessor
1843 if ($s =~ /^\s*#\s*/) {
1847 my (undef, $sindent) = line_stats("+" . $s);
1849 ##print "line<$line> prevline<$prevline> indent<$indent> sindent<$sindent> check<$check> continuation<$continuation> s<$s>\n";
1851 if ($check && (($sindent % 8) != 0 ||
1852 ($sindent <= $indent && $s ne ''))) {
1853 WARN("suspect code indent for conditional statements\n" . $herecurr);
1857 # Check for bitwise tests written as boolean
1869 WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
1872 # if and else should not have general statements after it
1873 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
1875 $s =~ s/$;//g; # Remove any comments
1876 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
1877 ERROR("trailing statements should be on next line\n" . $herecurr);
1881 # Check for }<nl>else {, these must be at the same
1882 # indent level to be relevant to each other.
1883 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
1884 $previndent == $indent) {
1885 ERROR("else should follow close brace '}'\n" . $hereprev);
1888 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
1889 $previndent == $indent) {
1890 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
1892 # Find out what is on the end of the line after the
1894 substr($s, 0, length($c), '');
1897 if ($s =~ /^\s*;/) {
1898 ERROR("while should follow close brace '}'\n" . $hereprev);
1902 #studly caps, commented out until figure out how to distinguish between use of existing and adding new
1903 # if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
1904 # print "No studly caps, use _\n";
1905 # print "$herecurr";
1909 #no spaces allowed after \ in define
1910 if ($line=~/\#\s*define.*\\\s$/) {
1911 WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
1914 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
1915 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
1916 my $checkfile = "include/linux/$1.h";
1917 if (-f "$root/$checkfile" && $realfile ne $checkfile &&
1920 WARN("Use #include <linux/$1.h> instead of <asm/$1.h>\n" .
1925 # multi-statement macros should be enclosed in a do while loop, grab the
1926 # first statement and ensure its the whole macro if its not enclosed
1927 # in a known good container
1928 if ($realfile !~ m@/vmlinux.lds.h$@ &&
1929 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
1932 my ($off, $dstat, $dcond, $rest);
1935 my $args = defined($1);
1937 # Find the end of the macro and limit our statement
1939 while ($cnt > 0 && defined $lines[$ln - 1] &&
1940 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
1942 $ctx .= $rawlines[$ln - 1] . "\n";
1943 $cnt-- if ($lines[$ln - 1] !~ /^-/);
1946 $ctx .= $rawlines[$ln - 1];
1948 ($dstat, $dcond, $ln, $cnt, $off) =
1949 ctx_statement_block($linenr, $ln - $linenr + 1, 0);
1950 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
1951 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
1953 # Extract the remainder of the define (if any) and
1954 # rip off surrounding spaces, and trailing \'s.
1956 while ($off != 0 || ($cnt > 0 && $rest =~ /(?:^|\\)\s*$/)) {
1957 #print "ADDING $off <" . substr($lines[$ln - 1], $off) . ">\n";
1958 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
1959 $rest .= substr($lines[$ln - 1], $off) . "\n";
1965 $rest =~ s/\\\n.//g;
1969 # Clean up the original statement.
1971 substr($dstat, 0, length($dcond), '');
1973 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
1975 $dstat =~ s/\\\n.//g;
1976 $dstat =~ s/^\s*//s;
1977 $dstat =~ s/\s*$//s;
1979 # Flatten any parentheses and braces
1980 while ($dstat =~ s/\([^\(\)]*\)/1/) {
1982 while ($dstat =~ s/\{[^\{\}]*\}/1/) {
1985 my $exceptions = qr{
1993 #print "REST<$rest>\n";
1995 if ($rest !~ /while\s*\(/ &&
1996 $dstat !~ /$exceptions/)
1998 ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
2001 } elsif ($ctx !~ /;/) {
2003 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2004 $dstat !~ /$exceptions/ &&
2005 $dstat =~ /$Operators/)
2007 ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
2012 # check for redundant bracing round if etc
2013 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2014 my ($level, $endln, @chunks) =
2015 ctx_statement_full($linenr, $realcnt, 1);
2016 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
2017 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2018 if ($#chunks > 0 && $level == 0) {
2021 my $herectx = $here . "\n";
2022 my $ln = $linenr - 1;
2023 for my $chunk (@chunks) {
2024 my ($cond, $block) = @{$chunk};
2026 # If the condition carries leading newlines, then count those as offsets.
2027 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2028 my $offset = statement_rawlines($whitespace) - 1;
2030 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2032 # We have looked at and allowed this specific line.
2033 $suppress_ifbraces{$ln + $offset} = 1;
2035 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
2036 $ln += statement_rawlines($block) - 1;
2038 substr($block, 0, length($cond), '');
2040 $seen++ if ($block =~ /^\s*{/);
2042 #print "cond<$cond> block<$block> allowed<$allowed>\n";
2043 if (statement_lines($cond) > 1) {
2044 #print "APW: ALLOWED: cond<$cond>\n";
2047 if ($block =~/\b(?:if|for|while)\b/) {
2048 #print "APW: ALLOWED: block<$block>\n";
2051 if (statement_block_size($block) > 1) {
2052 #print "APW: ALLOWED: lines block<$block>\n";
2056 if ($seen && !$allowed) {
2057 WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
2061 if (!defined $suppress_ifbraces{$linenr - 1} &&
2062 $line =~ /\b(if|while|for|else)\b/) {
2065 # Check the pre-context.
2066 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2067 #print "APW: ALLOWED: pre<$1>\n";
2071 my ($level, $endln, @chunks) =
2072 ctx_statement_full($linenr, $realcnt, $-[0]);
2074 # Check the condition.
2075 my ($cond, $block) = @{$chunks[0]};
2076 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
2077 if (defined $cond) {
2078 substr($block, 0, length($cond), '');
2080 if (statement_lines($cond) > 1) {
2081 #print "APW: ALLOWED: cond<$cond>\n";
2084 if ($block =~/\b(?:if|for|while)\b/) {
2085 #print "APW: ALLOWED: block<$block>\n";
2088 if (statement_block_size($block) > 1) {
2089 #print "APW: ALLOWED: lines block<$block>\n";
2092 # Check the post-context.
2093 if (defined $chunks[1]) {
2094 my ($cond, $block) = @{$chunks[1]};
2095 if (defined $cond) {
2096 substr($block, 0, length($cond), '');
2098 if ($block =~ /^\s*\{/) {
2099 #print "APW: ALLOWED: chunk-1 block<$block>\n";
2103 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
2104 my $herectx = $here . "\n";;
2105 my $end = $linenr + statement_rawlines($block) - 1;
2107 for (my $ln = $linenr - 1; $ln < $end; $ln++) {
2108 $herectx .= $rawlines[$ln] . "\n";;
2111 WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
2115 # don't include deprecated include files (uses RAW line)
2116 for my $inc (@dep_includes) {
2117 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
2118 ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2122 # don't use deprecated functions
2123 for my $func (@dep_functions) {
2124 if ($line =~ /\b$func\b/) {
2125 ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2129 # no volatiles please
2130 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2131 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
2132 WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
2135 # SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
2136 if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
2137 ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
2141 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
2142 CHK("if this code is redundant consider removing it\n" .
2146 # check for needless kfree() checks
2147 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2149 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
2150 WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
2153 # check for needless usb_free_urb() checks
2154 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2156 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
2157 WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
2161 # warn about #ifdefs in C files
2162 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
2163 # print "#ifdef in C files should be avoided\n";
2164 # print "$herecurr";
2168 # warn about spacing in #ifdefs
2169 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
2170 ERROR("exactly one space required after that #$1\n" . $herecurr);
2173 # check for spinlock_t definitions without a comment.
2174 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
2175 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
2177 if (!ctx_has_comment($first_line, $linenr)) {
2178 CHK("$1 definition without comment\n" . $herecurr);
2181 # check for memory barriers without a comment.
2182 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2183 if (!ctx_has_comment($first_line, $linenr)) {
2184 CHK("memory barrier without comment\n" . $herecurr);
2187 # check of hardware specific defines
2188 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
2189 CHK("architecture specific defines should be avoided\n" . $herecurr);
2192 # check the location of the inline attribute, that it is between
2193 # storage class and type.
2194 if ($line =~ /\b$Type\s+$Inline\b/ ||
2195 $line =~ /\b$Inline\s+$Storage\b/) {
2196 ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
2199 # Check for __inline__ and __inline, prefer inline
2200 if ($line =~ /\b(__inline__|__inline)\b/) {
2201 WARN("plain inline is preferred over $1\n" . $herecurr);
2204 # check for new externs in .c files.
2205 if ($realfile =~ /\.c$/ && defined $stat &&
2206 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
2208 my $function_name = $1;
2209 my $paren_space = $2;
2212 if (defined $cond) {
2213 substr($s, 0, length($cond), '');
2215 if ($s =~ /^\s*;/ &&
2216 $function_name ne 'uninitialized_var')
2218 WARN("externs should be avoided in .c files\n" . $herecurr);
2221 if ($paren_space =~ /\n/) {
2222 WARN("arguments for function declarations should follow identifier\n" . $herecurr);
2225 } elsif ($realfile =~ /\.c$/ && defined $stat &&
2226 $stat =~ /^.\s*extern\s+/)
2228 WARN("externs should be avoided in .c files\n" . $herecurr);
2231 # checks for new __setup's
2232 if ($rawline =~ /\b__setup\("([^"]*)"/) {
2235 if (!grep(/$name/, @setup_docs)) {
2236 CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
2240 # check for pointless casting of kmalloc return
2241 if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
2242 WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
2245 # check for gcc specific __FUNCTION__
2246 if ($line =~ /__FUNCTION__/) {
2247 WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
2250 # check for semaphores used as mutexes
2251 if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
2252 WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
2254 # check for semaphores used as mutexes
2255 if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
2256 WARN("consider using a completion\n" . $herecurr);
2258 # recommend strict_strto* over simple_strto*
2259 if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2260 WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
2262 # check for __initcall(), use device_initcall() explicitly please
2263 if ($line =~ /^.\s*__initcall\s*\(/) {
2264 WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
2267 # use of NR_CPUS is usually wrong
2268 # ignore definitions of NR_CPUS and usage to define arrays as likely right
2269 if ($line =~ /\bNR_CPUS\b/ &&
2270 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
2271 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
2272 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
2273 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
2274 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
2276 WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
2279 # check for %L{u,d,i} in strings
2281 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2282 $string = substr($rawline, $-[1], $+[1] - $-[1]);
2283 if ($string =~ /(?<!%)%L[udi]/) {
2284 WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2290 # If we have no input at all, then there is nothing to report on
2291 # so just keep quiet.
2292 if ($#rawlines == -1) {
2296 # In mailback mode only produce a report in the negative, for
2297 # things that appear to be patches.
2298 if ($mailback && ($clean == 1 || !$is_patch)) {
2302 # This is not a patch, and we are are in 'no-patch' mode so
2304 if (!$chk_patch && !$is_patch) {
2309 ERROR("Does not appear to be a unified-diff format patch\n");
2311 if ($is_patch && $chk_signoff && $signoff == 0) {
2312 ERROR("Missing Signed-off-by: line(s)\n");
2315 print report_dump();
2316 if ($summary && !($clean == 1 && $quiet == 1)) {
2317 print "$filename " if ($summary_file);
2318 print "total: $cnt_error errors, $cnt_warn warnings, " .
2319 (($check)? "$cnt_chk checks, " : "") .
2320 "$cnt_lines lines checked\n";
2321 print "\n" if ($quiet == 0);
2324 if ($clean == 1 && $quiet == 0) {
2325 print "$vname has no obvious style problems and is ready for submission.\n"
2327 if ($clean == 0 && $quiet == 0) {
2328 print "$vname has style problems, please review. If any of these errors\n";
2329 print "are false positives report them to the maintainer, see\n";
2330 print "CHECKPATCH in MAINTAINERS.\n";