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";
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)|
117 ____cacheline_aligned|
118 ____cacheline_aligned_in_smp|
119 ____cacheline_internodealigned_in_smp
122 our $Inline = qr{inline|__always_inline|noinline};
123 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
124 our $Lval = qr{$Ident(?:$Member)*};
126 our $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
127 our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
131 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
139 [\x09\x0A\x0D\x20-\x7E] # ASCII
140 | [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
141 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
142 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
143 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
144 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
145 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
146 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
151 qr{(?:unsigned\s+)?char},
152 qr{(?:unsigned\s+)?short},
153 qr{(?:unsigned\s+)?int},
154 qr{(?:unsigned\s+)?long},
155 qr{(?:unsigned\s+)?long\s+int},
156 qr{(?:unsigned\s+)?long\s+long},
157 qr{(?:unsigned\s+)?long\s+long\s+int},
162 qr{(?:__)?(?:u|s|be|le)(?:8|16|32|64)},
167 qr{${Ident}_handler},
168 qr{${Ident}_handler_fn},
170 our @modifierList = (
175 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
176 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
177 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
179 (?:$Modifier\s+|const\s+)*
181 (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
184 (?:\s+$Modifier|\s+const)*
188 (?:\s*\*+\s*const|\s*\*+|(?:\s*\[\s*\])+)?
189 (?:\s+$Inline|\s+$Modifier)*
191 $Declare = qr{(?:$Storage\s+)?$Type};
195 $chk_signoff = 0 if ($file);
197 my @dep_includes = ();
198 my @dep_functions = ();
199 my $removal = "Documentation/feature-removal-schedule.txt";
200 if ($tree && -f "$root/$removal") {
201 open(REMOVE, "<$root/$removal") ||
202 die "$P: $removal: open failed - $!\n";
204 if (/^Check:\s+(.*\S)/) {
205 for my $entry (split(/[, ]+/, $1)) {
206 if ($entry =~ m@include/(.*)@) {
207 push(@dep_includes, $1);
209 } elsif ($entry !~ m@/@) {
210 push(@dep_functions, $entry);
220 for my $filename (@ARGV) {
222 open(FILE, "diff -u /dev/null $filename|") ||
223 die "$P: $filename: diff failed - $!\n";
225 open(FILE, "<$filename") ||
226 die "$P: $filename: open failed - $!\n";
228 if ($filename eq '-') {
229 $vname = 'Your patch';
238 if (!process($filename)) {
247 sub top_of_kernel_tree {
251 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
252 "README", "Documentation", "arch", "include", "drivers",
253 "fs", "init", "ipc", "kernel", "lib", "scripts",
256 foreach my $check (@tree_check) {
257 if (! -e $root . '/' . $check) {
269 for my $c (split(//, $str)) {
273 for (; ($n % 8) != 0; $n++) {
285 (my $res = shift) =~ tr/\t/ /c;
292 # Drop the diff line leader and expand tabs
294 $line = expand_tabs($line);
296 # Pick the indent from the front of the line.
297 my ($white) = ($line =~ /^(\s*)/);
299 return (length($line), length($white));
302 my $sanitise_quote = '';
304 sub sanitise_line_reset {
305 my ($in_comment) = @_;
308 $sanitise_quote = '*/';
310 $sanitise_quote = '';
323 # Always copy over the diff marker.
324 $res = substr($line, 0, 1);
326 for ($off = 1; $off < length($line); $off++) {
327 $c = substr($line, $off, 1);
329 # Comments we are wacking completly including the begin
330 # and end, all to $;.
331 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
332 $sanitise_quote = '*/';
334 substr($res, $off, 2, "$;$;");
338 if (substr($line, $off, 2) eq '*/') {
339 $sanitise_quote = '';
340 substr($res, $off, 2, "$;$;");
345 # A \ in a string means ignore the next character.
346 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
348 substr($res, $off, 2, 'XX');
353 if ($c eq "'" || $c eq '"') {
354 if ($sanitise_quote eq '') {
355 $sanitise_quote = $c;
357 substr($res, $off, 1, $c);
359 } elsif ($sanitise_quote eq $c) {
360 $sanitise_quote = '';
364 #print "SQ:$sanitise_quote\n";
365 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
366 substr($res, $off, 1, $;);
367 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
368 substr($res, $off, 1, 'X');
370 substr($res, $off, 1, $c);
374 # The pathname on a #include may be surrounded by '<' and '>'.
375 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
376 my $clean = 'X' x length($1);
377 $res =~ s@\<.*\>@<$clean>@;
379 # The whole of a #error is a string.
380 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
381 my $clean = 'X' x length($1);
382 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
388 sub ctx_statement_block {
389 my ($linenr, $remain, $off) = @_;
390 my $line = $linenr - 1;
406 #warn "CSB: blk<$blk> remain<$remain>\n";
407 # If we are about to drop off the end, pull in more
410 for (; $remain > 0; $line++) {
411 next if ($lines[$line] =~ /^-/);
414 $blk .= $lines[$line] . "\n";
419 # Bail if there is no further context.
420 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
426 $c = substr($blk, $off, 1);
427 $remainder = substr($blk, $off);
429 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
430 # Statement ends at the ';' or a close '}' at the
432 if ($level == 0 && $c eq ';') {
436 # An else is really a conditional as long as its not else if
437 if ($level == 0 && $coff_set == 0 &&
438 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
439 $remainder =~ /^(else)(?:\s|{)/ &&
440 $remainder !~ /^else\s+if\b/) {
441 $coff = $off + length($1) - 1;
443 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
444 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
447 if (($type eq '' || $type eq '(') && $c eq '(') {
451 if ($type eq '(' && $c eq ')') {
453 $type = ($level != 0)? '(' : '';
455 if ($level == 0 && $coff < $soff) {
458 #warn "CSB: mark coff<$coff>\n";
461 if (($type eq '' || $type eq '{') && $c eq '{') {
465 if ($type eq '{' && $c eq '}') {
467 $type = ($level != 0)? '{' : '';
475 # We are truly at the end, so shuffle to the next line.
482 my $statement = substr($blk, $soff, $off - $soff + 1);
483 my $condition = substr($blk, $soff, $coff - $soff + 1);
485 #warn "STATEMENT<$statement>\n";
486 #warn "CONDITION<$condition>\n";
488 #print "coff<$coff> soff<$off> loff<$loff>\n";
490 return ($statement, $condition,
491 $line, $remain + 1, $off - $loff + 1, $level);
494 sub statement_lines {
497 # Strip the diff line prefixes and rip blank lines at start and end.
498 $stmt =~ s/(^|\n)./$1/g;
502 my @stmt_lines = ($stmt =~ /\n/g);
504 return $#stmt_lines + 2;
507 sub statement_rawlines {
510 my @stmt_lines = ($stmt =~ /\n/g);
512 return $#stmt_lines + 2;
515 sub statement_block_size {
518 $stmt =~ s/(^|\n)./$1/g;
524 my @stmt_lines = ($stmt =~ /\n/g);
525 my @stmt_statements = ($stmt =~ /;/g);
527 my $stmt_lines = $#stmt_lines + 2;
528 my $stmt_statements = $#stmt_statements + 1;
530 if ($stmt_lines > $stmt_statements) {
533 return $stmt_statements;
537 sub ctx_statement_full {
538 my ($linenr, $remain, $off) = @_;
539 my ($statement, $condition, $level);
543 # Grab the first conditional/block pair.
544 ($statement, $condition, $linenr, $remain, $off, $level) =
545 ctx_statement_block($linenr, $remain, $off);
546 #print "F: c<$condition> s<$statement> remain<$remain>\n";
547 push(@chunks, [ $condition, $statement ]);
548 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
549 return ($level, $linenr, @chunks);
552 # Pull in the following conditional/block pairs and see if they
553 # could continue the statement.
555 ($statement, $condition, $linenr, $remain, $off, $level) =
556 ctx_statement_block($linenr, $remain, $off);
557 #print "C: c<$condition> s<$statement> remain<$remain>\n";
558 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
560 push(@chunks, [ $condition, $statement ]);
563 return ($level, $linenr, @chunks);
567 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
569 my $start = $linenr - 1;
576 for ($line = $start; $remain > 0; $line++) {
577 next if ($rawlines[$line] =~ /^-/);
580 $blk .= $rawlines[$line];
581 foreach my $c (split(//, $rawlines[$line])) {
582 ##print "C<$c>L<$level><$open$close>O<$off>\n";
588 if ($c eq $close && $level > 0) {
590 last if ($level == 0);
591 } elsif ($c eq $open) {
596 if (!$outer || $level <= 1) {
597 push(@res, $rawlines[$line]);
600 last if ($level == 0);
603 return ($level, @res);
605 sub ctx_block_outer {
606 my ($linenr, $remain) = @_;
608 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
612 my ($linenr, $remain) = @_;
614 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
618 my ($linenr, $remain, $off) = @_;
620 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
623 sub ctx_block_level {
624 my ($linenr, $remain) = @_;
626 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
628 sub ctx_statement_level {
629 my ($linenr, $remain, $off) = @_;
631 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
634 sub ctx_locate_comment {
635 my ($first_line, $end_line) = @_;
637 # Catch a comment on the end of the line itself.
638 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
639 return $current_comment if (defined $current_comment);
641 # Look through the context and try and figure out if there is a
644 $current_comment = '';
645 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
646 my $line = $rawlines[$linenr - 1];
648 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
651 if ($line =~ m@/\*@) {
654 if (!$in_comment && $current_comment ne '') {
655 $current_comment = '';
657 $current_comment .= $line . "\n" if ($in_comment);
658 if ($line =~ m@\*/@) {
663 chomp($current_comment);
664 return($current_comment);
666 sub ctx_has_comment {
667 my ($first_line, $end_line) = @_;
668 my $cmt = ctx_locate_comment($first_line, $end_line);
670 ##print "LINE: $rawlines[$end_line - 1 ]\n";
671 ##print "CMMT: $cmt\n";
681 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
684 $coded = sprintf("^%c", unpack('C', $2) + 64);
693 my $av_preprocessor = 0;
699 $av_preprocessor = 0;
701 @av_paren_type = ('E');
702 $av_pend_colon = 'O';
705 sub annotate_values {
706 my ($stream, $type) = @_;
709 my $var = '_' x length($stream);
712 print "$stream\n" if ($dbg_values > 1);
714 while (length($cur)) {
715 @av_paren_type = ('E') if ($#av_paren_type < 0);
716 print " <" . join('', @av_paren_type) .
717 "> <$type> <$av_pending>" if ($dbg_values > 1);
718 if ($cur =~ /^(\s+)/o) {
719 print "WS($1)\n" if ($dbg_values > 1);
720 if ($1 =~ /\n/ && $av_preprocessor) {
721 $type = pop(@av_paren_type);
722 $av_preprocessor = 0;
725 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\()/) {
726 print "DECLARE($1)\n" if ($dbg_values > 1);
729 } elsif ($cur =~ /^($Modifier)\s*/) {
730 print "MODIFIER($1)\n" if ($dbg_values > 1);
733 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
734 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
735 $av_preprocessor = 1;
736 push(@av_paren_type, $type);
742 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
743 print "UNDEF($1)\n" if ($dbg_values > 1);
744 $av_preprocessor = 1;
745 push(@av_paren_type, $type);
747 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
748 print "PRE_START($1)\n" if ($dbg_values > 1);
749 $av_preprocessor = 1;
751 push(@av_paren_type, $type);
752 push(@av_paren_type, $type);
755 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
756 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
757 $av_preprocessor = 1;
759 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
763 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
764 print "PRE_END($1)\n" if ($dbg_values > 1);
766 $av_preprocessor = 1;
768 # Assume all arms of the conditional end as this
769 # one does, and continue as if the #endif was not here.
771 push(@av_paren_type, $type);
774 } elsif ($cur =~ /^(\\\n)/o) {
775 print "PRECONT($1)\n" if ($dbg_values > 1);
777 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
778 print "ATTR($1)\n" if ($dbg_values > 1);
782 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
783 print "SIZEOF($1)\n" if ($dbg_values > 1);
789 } elsif ($cur =~ /^(if|while|for)\b/o) {
790 print "COND($1)\n" if ($dbg_values > 1);
794 } elsif ($cur =~/^(case)/o) {
795 print "CASE($1)\n" if ($dbg_values > 1);
796 $av_pend_colon = 'C';
799 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
800 print "KEYWORD($1)\n" if ($dbg_values > 1);
803 } elsif ($cur =~ /^(\()/o) {
804 print "PAREN('$1')\n" if ($dbg_values > 1);
805 push(@av_paren_type, $av_pending);
809 } elsif ($cur =~ /^(\))/o) {
810 my $new_type = pop(@av_paren_type);
811 if ($new_type ne '_') {
813 print "PAREN('$1') -> $type\n"
814 if ($dbg_values > 1);
816 print "PAREN('$1')\n" if ($dbg_values > 1);
819 } elsif ($cur =~ /^($Ident)\s*\(/o) {
820 print "FUNC($1)\n" if ($dbg_values > 1);
824 } elsif ($cur =~ /^($Ident\s*):/) {
826 $av_pend_colon = 'L';
827 } elsif ($type eq 'T') {
828 $av_pend_colon = 'B';
830 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
833 } elsif ($cur =~ /^($Ident|$Constant)/o) {
834 print "IDENT($1)\n" if ($dbg_values > 1);
837 } elsif ($cur =~ /^($Assignment)/o) {
838 print "ASSIGN($1)\n" if ($dbg_values > 1);
841 } elsif ($cur =~/^(;|{|})/) {
842 print "END($1)\n" if ($dbg_values > 1);
844 $av_pend_colon = 'O';
846 } elsif ($cur =~ /^(\?)/o) {
847 print "QUESTION($1)\n" if ($dbg_values > 1);
850 } elsif ($cur =~ /^(:)/o) {
851 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
853 substr($var, length($res), 1, $av_pend_colon);
854 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
859 $av_pend_colon = 'O';
861 } elsif ($cur =~ /^(;|\[)/o) {
862 print "CLOSE($1)\n" if ($dbg_values > 1);
865 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
868 print "OPV($1)\n" if ($dbg_values > 1);
875 substr($var, length($res), 1, $variant);
878 } elsif ($cur =~ /^($Operators)/o) {
879 print "OP($1)\n" if ($dbg_values > 1);
880 if ($1 ne '++' && $1 ne '--') {
884 } elsif ($cur =~ /(^.)/o) {
885 print "C($1)\n" if ($dbg_values > 1);
888 $cur = substr($cur, length($1));
889 $res .= $type x length($1);
897 my ($possible, $line) = @_;
899 print "CHECK<$possible> ($line)\n" if ($dbg_possible > 1);
900 if ($possible !~ /^(?:$Modifier|$Storage|$Type|DEFINE_\S+)$/ &&
901 $possible ne 'goto' && $possible ne 'return' &&
902 $possible ne 'case' && $possible ne 'else' &&
903 $possible ne 'asm' && $possible ne '__asm__' &&
904 $possible !~ /^(typedef|struct|enum)\b/) {
905 # Check for modifiers.
906 $possible =~ s/\s*$Storage\s*//g;
907 $possible =~ s/\s*$Sparse\s*//g;
908 if ($possible =~ /^\s*$/) {
910 } elsif ($possible =~ /\s/) {
911 $possible =~ s/\s*$Type\s*//g;
912 for my $modifier (split(' ', $possible)) {
913 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
914 push(@modifierList, $modifier);
918 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
919 push(@typeList, $possible);
928 if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
931 my $line = $prefix . $_[0];
933 $line = (split('\n', $line))[0] . "\n" if ($terse);
935 push(our @report, $line);
943 if (report("ERROR: $_[0]\n")) {
949 if (report("WARNING: $_[0]\n")) {
955 if ($check && report("CHECK: $_[0]\n")) {
962 my $filename = shift;
985 # Trace the real file/line as we go.
991 my $comment_edge = 0;
994 my $prev_values = 'E';
997 my %suppress_ifbraces;
999 # Pre-scan the patch sanitizing the lines.
1000 # Pre-scan the patch looking for any __setup documentation.
1002 my @setup_docs = ();
1005 sanitise_line_reset();
1007 foreach my $rawline (@rawlines) {
1011 if ($rawline=~/^\+\+\+\s+(\S+)/) {
1013 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1018 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1027 # Guestimate if this is a continuing comment. Run
1028 # the context looking for a comment "edge". If this
1029 # edge is a close comment then we must be in a comment
1032 for (my $ln = $linenr + 1; $ln < ($linenr + $realcnt); $ln++) {
1033 next if ($line =~ /^-/);
1034 ($edge) = ($rawlines[$ln - 1] =~ m@(/\*|\*/)@);
1035 last if (defined $edge);
1037 if (defined $edge && $edge eq '*/') {
1041 # Guestimate if this is a continuing comment. If this
1042 # is the start of a diff block and this line starts
1043 # ' *' then it is very likely a comment.
1044 if (!defined $edge &&
1045 $rawlines[$linenr] =~ m@^.\s* \*(?:\s|$)@)
1050 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1051 sanitise_line_reset($in_comment);
1053 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1054 # Standardise the strings and chars within the input to
1055 # simplify matching -- only bother with positive lines.
1056 $line = sanitise_line($rawline);
1058 push(@lines, $line);
1061 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1066 #print "==>$rawline\n";
1067 #print "-->$line\n";
1069 if ($setup_docs && $line =~ /^\+/) {
1070 push(@setup_docs, $line);
1078 foreach my $line (@lines) {
1081 my $rawline = $rawlines[$linenr - 1];
1083 #extract the line range in the file after the patch is applied
1084 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1086 $first_line = $linenr + 1;
1096 %suppress_ifbraces = ();
1099 # track the line number as we move through the hunk, note that
1100 # new versions of GNU diff omit the leading space on completely
1101 # blank context lines so we need to count that too.
1102 } elsif ($line =~ /^( |\+|$)/) {
1104 $realcnt-- if ($realcnt != 0);
1106 # Measure the line length and indent.
1107 ($length, $indent) = line_stats($rawline);
1109 # Track the previous line.
1110 ($prevline, $stashline) = ($stashline, $line);
1111 ($previndent, $stashindent) = ($stashindent, $indent);
1112 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1114 #warn "line<$line>\n";
1116 } elsif ($realcnt == 1) {
1120 #make up the handle for any error we report on this line
1121 $prefix = "$filename:$realline: " if ($emacs && $file);
1122 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1124 $here = "#$linenr: " if (!$file);
1125 $here = "#$realline: " if ($file);
1127 # extract the filename as it passes
1128 if ($line=~/^\+\+\+\s+(\S+)/) {
1130 $realfile =~ s@^[^/]*/@@;
1132 if ($realfile =~ m@include/asm/@) {
1133 ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1138 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
1140 my $hereline = "$here\n$rawline\n";
1141 my $herecurr = "$here\n$rawline\n";
1142 my $hereprev = "$here\n$prevrawline\n$rawline\n";
1144 $cnt_lines++ if ($realcnt != 0);
1146 #check the patch for a signoff:
1147 if ($line =~ /^\s*signed-off-by:/i) {
1148 # This is a signoff, if ugly, so do not double report.
1150 if (!($line =~ /^\s*Signed-off-by:/)) {
1151 WARN("Signed-off-by: is the preferred form\n" .
1154 if ($line =~ /^\s*signed-off-by:\S/i) {
1155 WARN("space required after Signed-off-by:\n" .
1160 # Check for wrappage within a valid hunk of the file
1161 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1162 ERROR("patch seems to be corrupt (line wrapped?)\n" .
1163 $herecurr) if (!$emitted_corrupt++);
1166 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1167 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1168 $rawline !~ m/^$UTF8*$/) {
1169 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1171 my $blank = copy_spacing($rawline);
1172 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1173 my $hereptr = "$hereline$ptr\n";
1175 ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1178 #ignore lines being removed
1179 if ($line=~/^-/) {next;}
1181 # check we are in a valid source file if not then ignore this hunk
1182 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1184 #trailing whitespace
1185 if ($line =~ /^\+.*\015/) {
1186 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1187 ERROR("DOS line endings\n" . $herevet);
1189 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1190 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1191 ERROR("trailing whitespace\n" . $herevet);
1194 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
1195 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1196 $line !~ /^\+\s*printk\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ &&
1199 WARN("line over 80 characters\n" . $herecurr);
1202 # check for adding lines without a newline.
1203 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1204 WARN("adding a line without newline at end of file\n" . $herecurr);
1207 # check we are in a valid source file *.[hc] if not then ignore this hunk
1208 next if ($realfile !~ /\.[hc]$/);
1210 # at the beginning of a line any tabs must come first and anything
1211 # more than 8 must use tabs.
1212 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1213 $rawline =~ /^\+\s* \s*/) {
1214 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1215 ERROR("code indent should use tabs where possible\n" . $herevet);
1218 # check for RCS/CVS revision markers
1219 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
1220 WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1223 # Check for potential 'bare' types
1224 my ($stat, $cond, $line_nr_next, $remain_next);
1225 if ($realcnt && $line =~ /.\s*\S/) {
1226 ($stat, $cond, $line_nr_next, $remain_next) =
1227 ctx_statement_block($linenr, $realcnt, 0);
1228 $stat =~ s/\n./\n /g;
1229 $cond =~ s/\n./\n /g;
1234 # Ignore goto labels.
1235 if ($s =~ /$Ident:\*$/s) {
1237 # Ignore functions being called
1238 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
1240 # declarations always start with types
1241 } 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) {
1244 possible($type, "A:" . $s);
1246 # definitions in global scope can only start with types
1247 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b/s) {
1248 possible($1, "B:" . $s);
1251 # any (foo ... *) is a pointer cast, and foo is a type
1252 while ($s =~ /\(($Ident)(?:\s+$Sparse)*\s*\*+\s*\)/sg) {
1253 possible($1, "C:" . $s);
1256 # Check for any sort of function declaration.
1257 # int foo(something bar, other baz);
1258 # void (*store_gdt)(x86_descr_ptr *);
1259 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
1260 my ($name_len) = length($1);
1263 substr($ctx, 0, $name_len + 1, '');
1264 $ctx =~ s/\)[^\)]*$//;
1266 for my $arg (split(/\s*,\s*/, $ctx)) {
1267 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
1269 possible($1, "D:" . $s);
1277 # Checks which may be anchored in the context.
1280 # Check for switch () and associated case and default
1281 # statements should be at the same indent.
1282 if ($line=~/\bswitch\s*\(.*\)/) {
1285 my @ctx = ctx_block_outer($linenr, $realcnt);
1287 for my $ctx (@ctx) {
1288 my ($clen, $cindent) = line_stats($ctx);
1289 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1290 $indent != $cindent) {
1291 $err .= "$sep$ctx\n";
1298 ERROR("switch and case should be at the same indent\n$hereline$err");
1301 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
1303 (?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
1307 ERROR("trailing statements should be on next line\n" . $herecurr);
1310 # if/while/etc brace do not go on next line, unless defining a do while loop,
1311 # or if that brace on the next line is for something else
1312 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
1313 my $pre_ctx = "$1$2";
1315 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
1316 my $ctx_cnt = $realcnt - $#ctx - 1;
1317 my $ctx = join("\n", @ctx);
1319 my $ctx_ln = $linenr;
1320 my $ctx_skip = $realcnt;
1322 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1323 defined $lines[$ctx_ln - 1] &&
1324 $lines[$ctx_ln - 1] =~ /^-/)) {
1325 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1326 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
1330 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1331 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
1333 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1334 ERROR("that open brace { should be on the previous line\n" .
1335 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1337 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1338 $ctx =~ /\)\s*\;\s*$/ &&
1339 defined $lines[$ctx_ln - 1])
1341 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1342 if ($nindent > $indent) {
1343 WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
1344 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1349 # Track the 'values' across context and added lines.
1350 my $opline = $line; $opline =~ s/^./ /;
1351 my ($curr_values, $curr_vars) =
1352 annotate_values($opline . "\n", $prev_values);
1353 $curr_values = $prev_values . $curr_values;
1355 my $outline = $opline; $outline =~ s/\t/ /g;
1356 print "$linenr > .$outline\n";
1357 print "$linenr > $curr_values\n";
1358 print "$linenr > $curr_vars\n";
1360 $prev_values = substr($curr_values, -1);
1362 #ignore lines not being added
1363 if ($line=~/^[^\+]/) {next;}
1365 # TEST: allow direct testing of the type matcher.
1367 if ($line =~ /^.\s*$Declare\s*$/) {
1368 ERROR("TEST: is type\n" . $herecurr);
1369 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
1370 ERROR("TEST: is not type ($1 is)\n". $herecurr);
1374 # TEST: allow direct testing of the attribute matcher.
1376 if ($line =~ /^.\s*$Attribute\s*$/) {
1377 ERROR("TEST: is attr\n" . $herecurr);
1378 } elsif ($dbg_attr > 1 && $line =~ /^.+($Attribute)/) {
1379 ERROR("TEST: is not attr ($1 is)\n". $herecurr);
1384 # check for initialisation to aggregates open brace on the next line
1385 if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ &&
1386 $line =~ /^.\s*{/) {
1387 ERROR("that open brace { should be on the previous line\n" . $hereprev);
1391 # Checks which are anchored on the added line.
1394 # check for malformed paths in #include statements (uses RAW line)
1395 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
1397 if ($path =~ m{//}) {
1398 ERROR("malformed #include filename\n" .
1403 # no C99 // comments
1404 if ($line =~ m{//}) {
1405 ERROR("do not use C99 // comments\n" . $herecurr);
1407 # Remove C99 comments.
1409 $opline =~ s@//.*@@;
1411 #EXPORT_SYMBOL should immediately follow its function closing }.
1412 if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) ||
1413 ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1415 if (($prevline !~ /^}/) &&
1416 ($prevline !~ /^\+}/) &&
1417 ($prevline !~ /^ }/) &&
1418 ($prevline !~ /^.DECLARE_$Ident\(\Q$name\E\)/) &&
1419 ($prevline !~ /^.LIST_HEAD\(\Q$name\E\)/) &&
1420 ($prevline !~ /^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(/) &&
1421 ($prevline !~ /\b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[)/)) {
1422 WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
1426 # check for external initialisers.
1427 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
1428 ERROR("do not initialise externals to 0 or NULL\n" .
1431 # check for static initialisers.
1432 if ($line =~ /\s*static\s.*=\s*(0|NULL|false)\s*;/) {
1433 ERROR("do not initialise statics to 0 or NULL\n" .
1437 # check for new typedefs, only function parameters and sparse annotations
1439 if ($line =~ /\btypedef\s/ &&
1440 $line !~ /\btypedef\s+$Type\s+\(\s*\*?$Ident\s*\)\s*\(/ &&
1441 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
1442 $line !~ /\b__bitwise(?:__|)\b/) {
1443 WARN("do not add new typedefs\n" . $herecurr);
1446 # * goes on variable not on type
1447 if ($line =~ m{\($NonptrType(\*+)(?:\s+const)?\)}) {
1448 ERROR("\"(foo$1)\" should be \"(foo $1)\"\n" .
1451 } elsif ($line =~ m{\($NonptrType\s+(\*+)(?!\s+const)\s+\)}) {
1452 ERROR("\"(foo $1 )\" should be \"(foo $1)\"\n" .
1455 } elsif ($line =~ m{\b$NonptrType(\*+)(?:\s+(?:$Attribute|$Sparse))?\s+[A-Za-z\d_]+}) {
1456 ERROR("\"foo$1 bar\" should be \"foo $1bar\"\n" .
1459 } elsif ($line =~ m{\b$NonptrType\s+(\*+)(?!\s+(?:$Attribute|$Sparse))\s+[A-Za-z\d_]+}) {
1460 ERROR("\"foo $1 bar\" should be \"foo $1bar\"\n" .
1464 # # no BUG() or BUG_ON()
1465 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
1466 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
1467 # print "$herecurr";
1471 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
1472 WARN("LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
1475 # printk should use KERN_* levels. Note that follow on printk's on the
1476 # same line do not need a level, so we use the current block context
1477 # to try and find and validate the current printk. In summary the current
1478 # printk includes all preceeding printk's which have no newline on the end.
1479 # we assume the first bad printk is the one to report.
1480 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
1482 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
1483 #print "CHECK<$lines[$ln - 1]\n";
1484 # we have a preceeding printk if it ends
1485 # with "\n" ignore it, else it is to blame
1486 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
1487 if ($rawlines[$ln - 1] !~ m{\\n"}) {
1494 WARN("printk() should include KERN_ facility level\n" . $herecurr);
1498 # function brace can't be on same line, except for #defines of do while,
1499 # or if closed on same line
1500 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
1501 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
1502 ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
1505 # open braces for enum, union and struct go on the same line.
1506 if ($line =~ /^.\s*{/ &&
1507 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1508 ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
1511 # check for spacing round square brackets; allowed:
1512 # 1. with a type on the left -- int [] a;
1513 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
1514 # 3. inside a curly brace -- = { [0...10] = 5 }
1515 while ($line =~ /(.*?\s)\[/g) {
1516 my ($where, $prefix) = ($-[1], $1);
1517 if ($prefix !~ /$Type\s+$/ &&
1518 ($where != 0 || $prefix !~ /^.\s+$/) &&
1519 $prefix !~ /{\s+$/) {
1520 ERROR("space prohibited before open square bracket '['\n" . $herecurr);
1524 # check for spaces between functions and their parentheses.
1525 while ($line =~ /($Ident)\s+\(/g) {
1527 my $ctx_before = substr($line, 0, $-[1]);
1528 my $ctx = "$ctx_before$name";
1530 # Ignore those directives where spaces _are_ permitted.
1532 if|for|while|switch|return|case|
1533 volatile|__volatile__|
1534 __attribute__|format|__extension__|
1538 # cpp #define statements have non-optional spaces, ie
1539 # if there is a space between the name and the open
1540 # parenthesis it is simply not a parameter group.
1541 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
1543 # cpp #elif statement condition may start with a (
1544 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
1546 # If this whole things ends with a type its most
1547 # likely a typedef for a function.
1548 } elsif ($ctx =~ /$Type$/) {
1551 WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
1554 # Check operator spacing.
1555 if (!($line=~/\#\s*include/)) {
1557 <<=|>>=|<=|>=|==|!=|
1558 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
1559 =>|->|<<|>>|<|>|=|!|~|
1560 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
1563 my @elements = split(/($ops|;)/, $opline);
1566 my $blank = copy_spacing($opline);
1568 for (my $n = 0; $n < $#elements; $n += 2) {
1569 $off += length($elements[$n]);
1571 # Pick up the preceeding and succeeding characters.
1572 my $ca = substr($opline, 0, $off);
1574 if (length($opline) >= ($off + length($elements[$n + 1]))) {
1575 $cc = substr($opline, $off + length($elements[$n + 1]));
1577 my $cb = "$ca$;$cc";
1580 $a = 'V' if ($elements[$n] ne '');
1581 $a = 'W' if ($elements[$n] =~ /\s$/);
1582 $a = 'C' if ($elements[$n] =~ /$;$/);
1583 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
1584 $a = 'O' if ($elements[$n] eq '');
1585 $a = 'E' if ($ca =~ /^\s*$/);
1587 my $op = $elements[$n + 1];
1590 if (defined $elements[$n + 2]) {
1591 $c = 'V' if ($elements[$n + 2] ne '');
1592 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
1593 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
1594 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
1595 $c = 'O' if ($elements[$n + 2] eq '');
1596 $c = 'E' if ($elements[$n + 2] =~ /\s*\\$/);
1601 my $ctx = "${a}x${c}";
1603 my $at = "(ctx:$ctx)";
1605 my $ptr = substr($blank, 0, $off) . "^";
1606 my $hereptr = "$hereline$ptr\n";
1608 # Pull out the value of this operator.
1609 my $op_type = substr($curr_values, $off + 1, 1);
1611 # Get the full operator variant.
1612 my $opv = $op . substr($curr_vars, $off, 1);
1614 # Ignore operators passed as parameters.
1615 if ($op_type ne 'V' &&
1616 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
1619 # } elsif ($op =~ /^$;+$/) {
1621 # ; should have either the end of line or a space or \ after it
1622 } elsif ($op eq ';') {
1623 if ($ctx !~ /.x[WEBC]/ &&
1624 $cc !~ /^\\/ && $cc !~ /^;/) {
1625 ERROR("space required after that '$op' $at\n" . $hereptr);
1629 } elsif ($op eq '//') {
1633 # : when part of a bitfield
1634 } elsif ($op eq '->' || $opv eq ':B') {
1635 if ($ctx =~ /Wx.|.xW/) {
1636 ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
1639 # , must have a space on the right.
1640 } elsif ($op eq ',') {
1641 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
1642 ERROR("space required after that '$op' $at\n" . $hereptr);
1645 # '*' as part of a type definition -- reported already.
1646 } elsif ($opv eq '*_') {
1647 #warn "'*' is part of type\n";
1649 # unary operators should have a space before and
1650 # none after. May be left adjacent to another
1651 # unary operator, or a cast
1652 } elsif ($op eq '!' || $op eq '~' ||
1653 $opv eq '*U' || $opv eq '-U' ||
1654 $opv eq '&U' || $opv eq '&&U') {
1655 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
1656 ERROR("space required before that '$op' $at\n" . $hereptr);
1658 if ($op eq '*' && $cc =~/\s*const\b/) {
1659 # A unary '*' may be const
1661 } elsif ($ctx =~ /.xW/) {
1662 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1665 # unary ++ and unary -- are allowed no space on one side.
1666 } elsif ($op eq '++' or $op eq '--') {
1667 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
1668 ERROR("space required one side of that '$op' $at\n" . $hereptr);
1670 if ($ctx =~ /Wx[BE]/ ||
1671 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
1672 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
1674 if ($ctx =~ /ExW/) {
1675 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1679 # << and >> may either have or not have spaces both sides
1680 } elsif ($op eq '<<' or $op eq '>>' or
1681 $op eq '&' or $op eq '^' or $op eq '|' or
1682 $op eq '+' or $op eq '-' or
1683 $op eq '*' or $op eq '/' or
1686 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
1687 ERROR("need consistent spacing around '$op' $at\n" .
1691 # A colon needs no spaces before when it is
1692 # terminating a case value or a label.
1693 } elsif ($opv eq ':C' || $opv eq ':L') {
1694 if ($ctx =~ /Wx./) {
1695 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
1698 # All the others need spaces both sides.
1699 } elsif ($ctx !~ /[EWC]x[CWE]/) {
1702 # Ignore email addresses <foo@bar>
1704 $cc =~ /^\S+\@\S+>/) ||
1706 $ca =~ /<\S+\@\S+$/))
1712 if (($opv eq ':O' && $ca =~ /\?$/) ||
1713 ($op eq '?' && $cc =~ /^:/)) {
1718 ERROR("spaces required around that '$op' $at\n" . $hereptr);
1721 $off += length($elements[$n + 1]);
1725 # check for multiple assignments
1726 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
1727 CHK("multiple assignments should be avoided\n" . $herecurr);
1730 ## # check for multiple declarations, allowing for a function declaration
1732 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
1733 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
1735 ## # Remove any bracketed sections to ensure we do not
1736 ## # falsly report the parameters of functions.
1738 ## while ($ln =~ s/\([^\(\)]*\)//g) {
1740 ## if ($ln =~ /,/) {
1741 ## WARN("declaring multiple variables together should be avoided\n" . $herecurr);
1745 #need space before brace following if, while, etc
1746 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
1748 ERROR("space required before the open brace '{'\n" . $herecurr);
1751 # closing brace should have a space following it when it has anything
1753 if ($line =~ /}(?!(?:,|;|\)))\S/) {
1754 ERROR("space required after that close brace '}'\n" . $herecurr);
1757 # check spacing on square brackets
1758 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
1759 ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
1761 if ($line =~ /\s\]/) {
1762 ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
1765 # check spacing on parentheses
1766 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
1767 $line !~ /for\s*\(\s+;/) {
1768 ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
1770 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
1771 $line !~ /for\s*\(.*;\s+\)/ &&
1772 $line !~ /:\s+\)/) {
1773 ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
1776 #goto labels aren't indented, allow a single space however
1777 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
1778 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
1779 WARN("labels should not be indented\n" . $herecurr);
1782 # Return is not a function.
1783 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
1787 # Flatten any parentheses and braces
1788 $value =~ s/\)\(/\) \(/g;
1789 while ($value =~ s/\([^\(\)]*\)/1/) {
1792 if ($value =~ /^(?:$Ident|-?$Constant)$/) {
1793 ERROR("return is not a function, parentheses are not required\n" . $herecurr);
1795 } elsif ($spacing !~ /\s+/) {
1796 ERROR("space required before the open parenthesis '('\n" . $herecurr);
1800 # Need a space before open parenthesis after if, while etc
1801 if ($line=~/\b(if|while|for|switch)\(/) {
1802 ERROR("space required before the open parenthesis '('\n" . $herecurr);
1805 # Check for illegal assignment in if conditional -- and check for trailing
1806 # statements after the conditional.
1807 if ($line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
1808 my ($s, $c) = ($stat, $cond);
1810 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/) {
1811 ERROR("do not use assignment in if condition\n" . $herecurr);
1814 # Find out what is on the end of the line after the
1816 substr($s, 0, length($c), '');
1818 $s =~ s/$;//g; # Remove any comments
1819 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
1820 $c !~ /}\s*while\s*/)
1822 ERROR("trailing statements should be on next line\n" . $herecurr);
1826 # Check relative indent for conditionals and blocks.
1827 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1828 my ($s, $c) = ($stat, $cond);
1830 substr($s, 0, length($c), '');
1832 # Make sure we remove the line prefixes as we have
1833 # none on the first line, and are going to readd them
1837 # We want to check the first line inside the block
1838 # starting at the end of the conditional, so remove:
1839 # 1) any blank line termination
1840 # 2) any opening brace { on end of the line
1842 my $continuation = 0;
1844 $s =~ s/^.*\bdo\b//;
1846 if ($s =~ s/^\s*\\//) {
1849 if ($s =~ s/^\s*\n//) {
1853 # Also ignore a loop construct at the end of a
1854 # preprocessor statement.
1855 if (($prevline =~ /^.\s*#\s*define\s/ ||
1856 $prevline =~ /\\\s*$/) && $continuation == 0) {
1860 # Ignore the current line if its is a preprocessor
1862 if ($s =~ /^\s*#\s*/) {
1866 # Ignore the current line if it is label.
1867 if ($s =~ /^\s*$Ident\s*:/) {
1871 my (undef, $sindent) = line_stats("+" . $s);
1873 ##print "line<$line> prevline<$prevline> indent<$indent> sindent<$sindent> check<$check> continuation<$continuation> s<$s>\n";
1875 if ($check && (($sindent % 8) != 0 ||
1876 ($sindent <= $indent && $s ne ''))) {
1877 WARN("suspect code indent for conditional statements\n" . $herecurr);
1881 # Check for bitwise tests written as boolean
1893 WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
1896 # if and else should not have general statements after it
1897 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
1899 $s =~ s/$;//g; # Remove any comments
1900 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
1901 ERROR("trailing statements should be on next line\n" . $herecurr);
1905 # Check for }<nl>else {, these must be at the same
1906 # indent level to be relevant to each other.
1907 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
1908 $previndent == $indent) {
1909 ERROR("else should follow close brace '}'\n" . $hereprev);
1912 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
1913 $previndent == $indent) {
1914 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
1916 # Find out what is on the end of the line after the
1918 substr($s, 0, length($c), '');
1921 if ($s =~ /^\s*;/) {
1922 ERROR("while should follow close brace '}'\n" . $hereprev);
1926 #studly caps, commented out until figure out how to distinguish between use of existing and adding new
1927 # if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
1928 # print "No studly caps, use _\n";
1929 # print "$herecurr";
1933 #no spaces allowed after \ in define
1934 if ($line=~/\#\s*define.*\\\s$/) {
1935 WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
1938 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
1939 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
1940 my $checkfile = "include/linux/$1.h";
1941 if (-f "$root/$checkfile" && $realfile ne $checkfile &&
1944 WARN("Use #include <linux/$1.h> instead of <asm/$1.h>\n" .
1949 # multi-statement macros should be enclosed in a do while loop, grab the
1950 # first statement and ensure its the whole macro if its not enclosed
1951 # in a known good container
1952 if ($realfile !~ m@/vmlinux.lds.h$@ &&
1953 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
1956 my ($off, $dstat, $dcond, $rest);
1959 my $args = defined($1);
1961 # Find the end of the macro and limit our statement
1963 while ($cnt > 0 && defined $lines[$ln - 1] &&
1964 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
1966 $ctx .= $rawlines[$ln - 1] . "\n";
1967 $cnt-- if ($lines[$ln - 1] !~ /^-/);
1970 $ctx .= $rawlines[$ln - 1];
1972 ($dstat, $dcond, $ln, $cnt, $off) =
1973 ctx_statement_block($linenr, $ln - $linenr + 1, 0);
1974 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
1975 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
1977 # Extract the remainder of the define (if any) and
1978 # rip off surrounding spaces, and trailing \'s.
1980 while ($off != 0 || ($cnt > 0 && $rest =~ /(?:^|\\)\s*$/)) {
1981 #print "ADDING $off <" . substr($lines[$ln - 1], $off) . ">\n";
1982 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
1983 $rest .= substr($lines[$ln - 1], $off) . "\n";
1989 $rest =~ s/\\\n.//g;
1993 # Clean up the original statement.
1995 substr($dstat, 0, length($dcond), '');
1997 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
2000 $dstat =~ s/\\\n.//g;
2001 $dstat =~ s/^\s*//s;
2002 $dstat =~ s/\s*$//s;
2004 # Flatten any parentheses and braces
2005 while ($dstat =~ s/\([^\(\)]*\)/1/) {
2007 while ($dstat =~ s/\{[^\{\}]*\}/1/) {
2010 my $exceptions = qr{
2018 #print "REST<$rest>\n";
2020 if ($rest !~ /while\s*\(/ &&
2021 $dstat !~ /$exceptions/)
2023 ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
2026 } elsif ($ctx !~ /;/) {
2028 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2029 $dstat !~ /$exceptions/ &&
2030 $dstat =~ /$Operators/)
2032 ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
2037 # check for redundant bracing round if etc
2038 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2039 my ($level, $endln, @chunks) =
2040 ctx_statement_full($linenr, $realcnt, 1);
2041 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
2042 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2043 if ($#chunks > 0 && $level == 0) {
2046 my $herectx = $here . "\n";
2047 my $ln = $linenr - 1;
2048 for my $chunk (@chunks) {
2049 my ($cond, $block) = @{$chunk};
2051 # If the condition carries leading newlines, then count those as offsets.
2052 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2053 my $offset = statement_rawlines($whitespace) - 1;
2055 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2057 # We have looked at and allowed this specific line.
2058 $suppress_ifbraces{$ln + $offset} = 1;
2060 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
2061 $ln += statement_rawlines($block) - 1;
2063 substr($block, 0, length($cond), '');
2065 $seen++ if ($block =~ /^\s*{/);
2067 #print "cond<$cond> block<$block> allowed<$allowed>\n";
2068 if (statement_lines($cond) > 1) {
2069 #print "APW: ALLOWED: cond<$cond>\n";
2072 if ($block =~/\b(?:if|for|while)\b/) {
2073 #print "APW: ALLOWED: block<$block>\n";
2076 if (statement_block_size($block) > 1) {
2077 #print "APW: ALLOWED: lines block<$block>\n";
2081 if ($seen && !$allowed) {
2082 WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
2086 if (!defined $suppress_ifbraces{$linenr - 1} &&
2087 $line =~ /\b(if|while|for|else)\b/) {
2090 # Check the pre-context.
2091 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2092 #print "APW: ALLOWED: pre<$1>\n";
2096 my ($level, $endln, @chunks) =
2097 ctx_statement_full($linenr, $realcnt, $-[0]);
2099 # Check the condition.
2100 my ($cond, $block) = @{$chunks[0]};
2101 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
2102 if (defined $cond) {
2103 substr($block, 0, length($cond), '');
2105 if (statement_lines($cond) > 1) {
2106 #print "APW: ALLOWED: cond<$cond>\n";
2109 if ($block =~/\b(?:if|for|while)\b/) {
2110 #print "APW: ALLOWED: block<$block>\n";
2113 if (statement_block_size($block) > 1) {
2114 #print "APW: ALLOWED: lines block<$block>\n";
2117 # Check the post-context.
2118 if (defined $chunks[1]) {
2119 my ($cond, $block) = @{$chunks[1]};
2120 if (defined $cond) {
2121 substr($block, 0, length($cond), '');
2123 if ($block =~ /^\s*\{/) {
2124 #print "APW: ALLOWED: chunk-1 block<$block>\n";
2128 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
2129 my $herectx = $here . "\n";;
2130 my $end = $linenr + statement_rawlines($block) - 1;
2132 for (my $ln = $linenr - 1; $ln < $end; $ln++) {
2133 $herectx .= $rawlines[$ln] . "\n";;
2136 WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
2140 # don't include deprecated include files (uses RAW line)
2141 for my $inc (@dep_includes) {
2142 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
2143 ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2147 # don't use deprecated functions
2148 for my $func (@dep_functions) {
2149 if ($line =~ /\b$func\b/) {
2150 ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2154 # no volatiles please
2155 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2156 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
2157 WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
2160 # SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
2161 if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
2162 ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
2166 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
2167 CHK("if this code is redundant consider removing it\n" .
2171 # check for needless kfree() checks
2172 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2174 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
2175 WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
2178 # check for needless usb_free_urb() checks
2179 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2181 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
2182 WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
2186 # warn about #ifdefs in C files
2187 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
2188 # print "#ifdef in C files should be avoided\n";
2189 # print "$herecurr";
2193 # warn about spacing in #ifdefs
2194 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
2195 ERROR("exactly one space required after that #$1\n" . $herecurr);
2198 # check for spinlock_t definitions without a comment.
2199 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
2200 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
2202 if (!ctx_has_comment($first_line, $linenr)) {
2203 CHK("$1 definition without comment\n" . $herecurr);
2206 # check for memory barriers without a comment.
2207 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2208 if (!ctx_has_comment($first_line, $linenr)) {
2209 CHK("memory barrier without comment\n" . $herecurr);
2212 # check of hardware specific defines
2213 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
2214 CHK("architecture specific defines should be avoided\n" . $herecurr);
2217 # check the location of the inline attribute, that it is between
2218 # storage class and type.
2219 if ($line =~ /\b$Type\s+$Inline\b/ ||
2220 $line =~ /\b$Inline\s+$Storage\b/) {
2221 ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
2224 # Check for __inline__ and __inline, prefer inline
2225 if ($line =~ /\b(__inline__|__inline)\b/) {
2226 WARN("plain inline is preferred over $1\n" . $herecurr);
2229 # check for new externs in .c files.
2230 if ($realfile =~ /\.c$/ && defined $stat &&
2231 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
2233 my $function_name = $1;
2234 my $paren_space = $2;
2237 if (defined $cond) {
2238 substr($s, 0, length($cond), '');
2240 if ($s =~ /^\s*;/ &&
2241 $function_name ne 'uninitialized_var')
2243 WARN("externs should be avoided in .c files\n" . $herecurr);
2246 if ($paren_space =~ /\n/) {
2247 WARN("arguments for function declarations should follow identifier\n" . $herecurr);
2250 } elsif ($realfile =~ /\.c$/ && defined $stat &&
2251 $stat =~ /^.\s*extern\s+/)
2253 WARN("externs should be avoided in .c files\n" . $herecurr);
2256 # checks for new __setup's
2257 if ($rawline =~ /\b__setup\("([^"]*)"/) {
2260 if (!grep(/$name/, @setup_docs)) {
2261 CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
2265 # check for pointless casting of kmalloc return
2266 if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
2267 WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
2270 # check for gcc specific __FUNCTION__
2271 if ($line =~ /__FUNCTION__/) {
2272 WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
2275 # check for semaphores used as mutexes
2276 if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
2277 WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
2279 # check for semaphores used as mutexes
2280 if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
2281 WARN("consider using a completion\n" . $herecurr);
2283 # recommend strict_strto* over simple_strto*
2284 if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2285 WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
2287 # check for __initcall(), use device_initcall() explicitly please
2288 if ($line =~ /^.\s*__initcall\s*\(/) {
2289 WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
2292 # use of NR_CPUS is usually wrong
2293 # ignore definitions of NR_CPUS and usage to define arrays as likely right
2294 if ($line =~ /\bNR_CPUS\b/ &&
2295 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
2296 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
2297 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
2298 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
2299 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
2301 WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
2304 # check for %L{u,d,i} in strings
2306 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2307 $string = substr($rawline, $-[1], $+[1] - $-[1]);
2308 if ($string =~ /(?<!%)%L[udi]/) {
2309 WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2315 # If we have no input at all, then there is nothing to report on
2316 # so just keep quiet.
2317 if ($#rawlines == -1) {
2321 # In mailback mode only produce a report in the negative, for
2322 # things that appear to be patches.
2323 if ($mailback && ($clean == 1 || !$is_patch)) {
2327 # This is not a patch, and we are are in 'no-patch' mode so
2329 if (!$chk_patch && !$is_patch) {
2334 ERROR("Does not appear to be a unified-diff format patch\n");
2336 if ($is_patch && $chk_signoff && $signoff == 0) {
2337 ERROR("Missing Signed-off-by: line(s)\n");
2340 print report_dump();
2341 if ($summary && !($clean == 1 && $quiet == 1)) {
2342 print "$filename " if ($summary_file);
2343 print "total: $cnt_error errors, $cnt_warn warnings, " .
2344 (($check)? "$cnt_chk checks, " : "") .
2345 "$cnt_lines lines checked\n";
2346 print "\n" if ($quiet == 0);
2349 if ($clean == 1 && $quiet == 0) {
2350 print "$vname has no obvious style problems and is ready for submission.\n"
2352 if ($clean == 0 && $quiet == 0) {
2353 print "$vname has style problems, please review. If any of these errors\n";
2354 print "are false positives report them to the maintainer, see\n";
2355 print "CHECKPATCH in MAINTAINERS.\n";