2 # (c) 2001, Dave Jones. <davej@redhat.com> (the file handling bit)
3 # (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
4 # (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
5 # (c) 2008, Andy Whitcroft <apw@canonical.com>
6 # Licensed under the terms of the GNU GPL License version 2
15 use Getopt::Long qw(:config no_auto_abbrev);
32 'q|quiet+' => \$quiet,
34 'signoff!' => \$chk_signoff,
35 'patch!' => \$chk_patch,
39 'subjective!' => \$check,
42 'summary!' => \$summary,
43 'mailback!' => \$mailback,
44 'summary-file!' => \$summary_file,
47 'test-only=s' => \$tst_only,
53 print "usage: $P [options] patchfile\n";
54 print "version: $V\n";
55 print "options: -q => quiet\n";
56 print " --no-tree => run without a kernel tree\n";
57 print " --terse => one line per report\n";
58 print " --emacs => emacs compile window format\n";
59 print " --file => check a source file\n";
60 print " --strict => enable more subjective tests\n";
61 print " --root => path to the kernel tree root\n";
62 print " --no-summary => suppress the per-file summary\n";
63 print " --summary-file => include the filename in summary\n";
71 for my $key (keys %debug) {
73 eval "\${dbg_$key} = '$debug{$key}';";
84 if (!top_of_kernel_tree($root)) {
85 die "$P: $root: --root does not point at a valid tree\n";
88 if (top_of_kernel_tree('.')) {
90 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
91 top_of_kernel_tree($1)) {
97 print "Must be run from the top-level dir. of a kernel tree\n";
102 my $emitted_corrupt = 0;
104 our $Ident = qr{[A-Za-z_][A-Za-z\d_]*};
105 our $Storage = qr{extern|static|asmlinkage};
120 __(?:mem|cpu|dev|)(?:initdata|init)|
121 ____cacheline_aligned|
122 ____cacheline_aligned_in_smp|
123 ____cacheline_internodealigned_in_smp|
127 our $Inline = qr{inline|__always_inline|noinline};
128 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
129 our $Lval = qr{$Ident(?:$Member)*};
131 our $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
132 our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
133 our $Compare = qr{<=|>=|==|!=|<|>};
137 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
145 [\x09\x0A\x0D\x20-\x7E] # ASCII
146 | [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
147 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
148 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
149 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
150 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
151 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
152 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
155 our $typeTypedefs = qr{(?x:
156 (?:__)?(?:u|s|be|le)(?:\d|\d\d)|
162 qr{(?:unsigned\s+)?char},
163 qr{(?:unsigned\s+)?short},
164 qr{(?:unsigned\s+)?int},
165 qr{(?:unsigned\s+)?long},
166 qr{(?:unsigned\s+)?long\s+int},
167 qr{(?:unsigned\s+)?long\s+long},
168 qr{(?:unsigned\s+)?long\s+long\s+int},
177 qr{${Ident}_handler},
178 qr{${Ident}_handler_fn},
180 our @modifierList = (
185 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
186 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
187 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
189 (?:$Modifier\s+|const\s+)*
191 (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
195 (?:\s+$Modifier|\s+const)*
199 (?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)?
200 (?:\s+$Inline|\s+$Modifier)*
202 $Declare = qr{(?:$Storage\s+)?$Type};
206 $chk_signoff = 0 if ($file);
208 my @dep_includes = ();
209 my @dep_functions = ();
210 my $removal = "Documentation/feature-removal-schedule.txt";
211 if ($tree && -f "$root/$removal") {
212 open(my $REMOVE, '<', "$root/$removal") ||
213 die "$P: $removal: open failed - $!\n";
215 if (/^Check:\s+(.*\S)/) {
216 for my $entry (split(/[, ]+/, $1)) {
217 if ($entry =~ m@include/(.*)@) {
218 push(@dep_includes, $1);
220 } elsif ($entry !~ m@/@) {
221 push(@dep_functions, $entry);
232 for my $filename (@ARGV) {
235 open($FILE, '-|', "diff -u /dev/null $filename") ||
236 die "$P: $filename: diff failed - $!\n";
237 } elsif ($filename eq '-') {
238 open($FILE, '<&STDIN');
240 open($FILE, '<', "$filename") ||
241 die "$P: $filename: open failed - $!\n";
243 if ($filename eq '-') {
244 $vname = 'Your patch';
253 if (!process($filename)) {
262 sub top_of_kernel_tree {
266 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
267 "README", "Documentation", "arch", "include", "drivers",
268 "fs", "init", "ipc", "kernel", "lib", "scripts",
271 foreach my $check (@tree_check) {
272 if (! -e $root . '/' . $check) {
284 for my $c (split(//, $str)) {
288 for (; ($n % 8) != 0; $n++) {
300 (my $res = shift) =~ tr/\t/ /c;
307 # Drop the diff line leader and expand tabs
309 $line = expand_tabs($line);
311 # Pick the indent from the front of the line.
312 my ($white) = ($line =~ /^(\s*)/);
314 return (length($line), length($white));
317 my $sanitise_quote = '';
319 sub sanitise_line_reset {
320 my ($in_comment) = @_;
323 $sanitise_quote = '*/';
325 $sanitise_quote = '';
338 # Always copy over the diff marker.
339 $res = substr($line, 0, 1);
341 for ($off = 1; $off < length($line); $off++) {
342 $c = substr($line, $off, 1);
344 # Comments we are wacking completly including the begin
345 # and end, all to $;.
346 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
347 $sanitise_quote = '*/';
349 substr($res, $off, 2, "$;$;");
353 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
354 $sanitise_quote = '';
355 substr($res, $off, 2, "$;$;");
359 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
360 $sanitise_quote = '//';
362 substr($res, $off, 2, $sanitise_quote);
367 # A \ in a string means ignore the next character.
368 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
370 substr($res, $off, 2, 'XX');
375 if ($c eq "'" || $c eq '"') {
376 if ($sanitise_quote eq '') {
377 $sanitise_quote = $c;
379 substr($res, $off, 1, $c);
381 } elsif ($sanitise_quote eq $c) {
382 $sanitise_quote = '';
386 #print "c<$c> SQ<$sanitise_quote>\n";
387 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
388 substr($res, $off, 1, $;);
389 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
390 substr($res, $off, 1, $;);
391 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
392 substr($res, $off, 1, 'X');
394 substr($res, $off, 1, $c);
398 if ($sanitise_quote eq '//') {
399 $sanitise_quote = '';
402 # The pathname on a #include may be surrounded by '<' and '>'.
403 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
404 my $clean = 'X' x length($1);
405 $res =~ s@\<.*\>@<$clean>@;
407 # The whole of a #error is a string.
408 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
409 my $clean = 'X' x length($1);
410 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
416 sub ctx_statement_block {
417 my ($linenr, $remain, $off) = @_;
418 my $line = $linenr - 1;
435 @stack = (['', 0]) if ($#stack == -1);
437 #warn "CSB: blk<$blk> remain<$remain>\n";
438 # If we are about to drop off the end, pull in more
441 for (; $remain > 0; $line++) {
442 last if (!defined $lines[$line]);
443 next if ($lines[$line] =~ /^-/);
446 $blk .= $lines[$line] . "\n";
451 # Bail if there is no further context.
452 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
458 $c = substr($blk, $off, 1);
459 $remainder = substr($blk, $off);
461 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
463 # Handle nested #if/#else.
464 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
465 push(@stack, [ $type, $level ]);
466 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
467 ($type, $level) = @{$stack[$#stack - 1]};
468 } elsif ($remainder =~ /^#\s*endif\b/) {
469 ($type, $level) = @{pop(@stack)};
472 # Statement ends at the ';' or a close '}' at the
474 if ($level == 0 && $c eq ';') {
478 # An else is really a conditional as long as its not else if
479 if ($level == 0 && $coff_set == 0 &&
480 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
481 $remainder =~ /^(else)(?:\s|{)/ &&
482 $remainder !~ /^else\s+if\b/) {
483 $coff = $off + length($1) - 1;
485 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
486 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
489 if (($type eq '' || $type eq '(') && $c eq '(') {
493 if ($type eq '(' && $c eq ')') {
495 $type = ($level != 0)? '(' : '';
497 if ($level == 0 && $coff < $soff) {
500 #warn "CSB: mark coff<$coff>\n";
503 if (($type eq '' || $type eq '{') && $c eq '{') {
507 if ($type eq '{' && $c eq '}') {
509 $type = ($level != 0)? '{' : '';
517 # We are truly at the end, so shuffle to the next line.
524 my $statement = substr($blk, $soff, $off - $soff + 1);
525 my $condition = substr($blk, $soff, $coff - $soff + 1);
527 #warn "STATEMENT<$statement>\n";
528 #warn "CONDITION<$condition>\n";
530 #print "coff<$coff> soff<$off> loff<$loff>\n";
532 return ($statement, $condition,
533 $line, $remain + 1, $off - $loff + 1, $level);
536 sub statement_lines {
539 # Strip the diff line prefixes and rip blank lines at start and end.
540 $stmt =~ s/(^|\n)./$1/g;
544 my @stmt_lines = ($stmt =~ /\n/g);
546 return $#stmt_lines + 2;
549 sub statement_rawlines {
552 my @stmt_lines = ($stmt =~ /\n/g);
554 return $#stmt_lines + 2;
557 sub statement_block_size {
560 $stmt =~ s/(^|\n)./$1/g;
566 my @stmt_lines = ($stmt =~ /\n/g);
567 my @stmt_statements = ($stmt =~ /;/g);
569 my $stmt_lines = $#stmt_lines + 2;
570 my $stmt_statements = $#stmt_statements + 1;
572 if ($stmt_lines > $stmt_statements) {
575 return $stmt_statements;
579 sub ctx_statement_full {
580 my ($linenr, $remain, $off) = @_;
581 my ($statement, $condition, $level);
585 # Grab the first conditional/block pair.
586 ($statement, $condition, $linenr, $remain, $off, $level) =
587 ctx_statement_block($linenr, $remain, $off);
588 #print "F: c<$condition> s<$statement> remain<$remain>\n";
589 push(@chunks, [ $condition, $statement ]);
590 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
591 return ($level, $linenr, @chunks);
594 # Pull in the following conditional/block pairs and see if they
595 # could continue the statement.
597 ($statement, $condition, $linenr, $remain, $off, $level) =
598 ctx_statement_block($linenr, $remain, $off);
599 #print "C: c<$condition> s<$statement> remain<$remain>\n";
600 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
602 push(@chunks, [ $condition, $statement ]);
605 return ($level, $linenr, @chunks);
609 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
611 my $start = $linenr - 1;
618 my @stack = ($level);
619 for ($line = $start; $remain > 0; $line++) {
620 next if ($rawlines[$line] =~ /^-/);
623 $blk .= $rawlines[$line];
625 # Handle nested #if/#else.
626 if ($rawlines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
627 push(@stack, $level);
628 } elsif ($rawlines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
629 $level = $stack[$#stack - 1];
630 } elsif ($rawlines[$line] =~ /^.\s*#\s*endif\b/) {
631 $level = pop(@stack);
634 foreach my $c (split(//, $rawlines[$line])) {
635 ##print "C<$c>L<$level><$open$close>O<$off>\n";
641 if ($c eq $close && $level > 0) {
643 last if ($level == 0);
644 } elsif ($c eq $open) {
649 if (!$outer || $level <= 1) {
650 push(@res, $rawlines[$line]);
653 last if ($level == 0);
656 return ($level, @res);
658 sub ctx_block_outer {
659 my ($linenr, $remain) = @_;
661 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
665 my ($linenr, $remain) = @_;
667 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
671 my ($linenr, $remain, $off) = @_;
673 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
676 sub ctx_block_level {
677 my ($linenr, $remain) = @_;
679 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
681 sub ctx_statement_level {
682 my ($linenr, $remain, $off) = @_;
684 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
687 sub ctx_locate_comment {
688 my ($first_line, $end_line) = @_;
690 # Catch a comment on the end of the line itself.
691 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
692 return $current_comment if (defined $current_comment);
694 # Look through the context and try and figure out if there is a
697 $current_comment = '';
698 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
699 my $line = $rawlines[$linenr - 1];
701 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
704 if ($line =~ m@/\*@) {
707 if (!$in_comment && $current_comment ne '') {
708 $current_comment = '';
710 $current_comment .= $line . "\n" if ($in_comment);
711 if ($line =~ m@\*/@) {
716 chomp($current_comment);
717 return($current_comment);
719 sub ctx_has_comment {
720 my ($first_line, $end_line) = @_;
721 my $cmt = ctx_locate_comment($first_line, $end_line);
723 ##print "LINE: $rawlines[$end_line - 1 ]\n";
724 ##print "CMMT: $cmt\n";
730 my ($linenr, $cnt) = @_;
732 my $offset = $linenr - 1;
737 $line = $rawlines[$offset++];
738 next if (defined($line) && $line =~ /^-/);
750 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
753 $coded = sprintf("^%c", unpack('C', $2) + 64);
762 my $av_preprocessor = 0;
768 $av_preprocessor = 0;
770 @av_paren_type = ('E');
771 $av_pend_colon = 'O';
774 sub annotate_values {
775 my ($stream, $type) = @_;
778 my $var = '_' x length($stream);
781 print "$stream\n" if ($dbg_values > 1);
783 while (length($cur)) {
784 @av_paren_type = ('E') if ($#av_paren_type < 0);
785 print " <" . join('', @av_paren_type) .
786 "> <$type> <$av_pending>" if ($dbg_values > 1);
787 if ($cur =~ /^(\s+)/o) {
788 print "WS($1)\n" if ($dbg_values > 1);
789 if ($1 =~ /\n/ && $av_preprocessor) {
790 $type = pop(@av_paren_type);
791 $av_preprocessor = 0;
794 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\()/) {
795 print "DECLARE($1)\n" if ($dbg_values > 1);
798 } elsif ($cur =~ /^($Modifier)\s*/) {
799 print "MODIFIER($1)\n" if ($dbg_values > 1);
802 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
803 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
804 $av_preprocessor = 1;
805 push(@av_paren_type, $type);
811 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
812 print "UNDEF($1)\n" if ($dbg_values > 1);
813 $av_preprocessor = 1;
814 push(@av_paren_type, $type);
816 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
817 print "PRE_START($1)\n" if ($dbg_values > 1);
818 $av_preprocessor = 1;
820 push(@av_paren_type, $type);
821 push(@av_paren_type, $type);
824 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
825 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
826 $av_preprocessor = 1;
828 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
832 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
833 print "PRE_END($1)\n" if ($dbg_values > 1);
835 $av_preprocessor = 1;
837 # Assume all arms of the conditional end as this
838 # one does, and continue as if the #endif was not here.
840 push(@av_paren_type, $type);
843 } elsif ($cur =~ /^(\\\n)/o) {
844 print "PRECONT($1)\n" if ($dbg_values > 1);
846 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
847 print "ATTR($1)\n" if ($dbg_values > 1);
851 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
852 print "SIZEOF($1)\n" if ($dbg_values > 1);
858 } elsif ($cur =~ /^(if|while|for)\b/o) {
859 print "COND($1)\n" if ($dbg_values > 1);
863 } elsif ($cur =~/^(case)/o) {
864 print "CASE($1)\n" if ($dbg_values > 1);
865 $av_pend_colon = 'C';
868 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
869 print "KEYWORD($1)\n" if ($dbg_values > 1);
872 } elsif ($cur =~ /^(\()/o) {
873 print "PAREN('$1')\n" if ($dbg_values > 1);
874 push(@av_paren_type, $av_pending);
878 } elsif ($cur =~ /^(\))/o) {
879 my $new_type = pop(@av_paren_type);
880 if ($new_type ne '_') {
882 print "PAREN('$1') -> $type\n"
883 if ($dbg_values > 1);
885 print "PAREN('$1')\n" if ($dbg_values > 1);
888 } elsif ($cur =~ /^($Ident)\s*\(/o) {
889 print "FUNC($1)\n" if ($dbg_values > 1);
893 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
894 if (defined $2 && $type eq 'C' || $type eq 'T') {
895 $av_pend_colon = 'B';
896 } elsif ($type eq 'E') {
897 $av_pend_colon = 'L';
899 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
902 } elsif ($cur =~ /^($Ident|$Constant)/o) {
903 print "IDENT($1)\n" if ($dbg_values > 1);
906 } elsif ($cur =~ /^($Assignment)/o) {
907 print "ASSIGN($1)\n" if ($dbg_values > 1);
910 } elsif ($cur =~/^(;|{|})/) {
911 print "END($1)\n" if ($dbg_values > 1);
913 $av_pend_colon = 'O';
915 } elsif ($cur =~/^(,)/) {
916 print "COMMA($1)\n" if ($dbg_values > 1);
919 } elsif ($cur =~ /^(\?)/o) {
920 print "QUESTION($1)\n" if ($dbg_values > 1);
923 } elsif ($cur =~ /^(:)/o) {
924 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
926 substr($var, length($res), 1, $av_pend_colon);
927 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
932 $av_pend_colon = 'O';
934 } elsif ($cur =~ /^(\[)/o) {
935 print "CLOSE($1)\n" if ($dbg_values > 1);
938 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
941 print "OPV($1)\n" if ($dbg_values > 1);
948 substr($var, length($res), 1, $variant);
951 } elsif ($cur =~ /^($Operators)/o) {
952 print "OP($1)\n" if ($dbg_values > 1);
953 if ($1 ne '++' && $1 ne '--') {
957 } elsif ($cur =~ /(^.)/o) {
958 print "C($1)\n" if ($dbg_values > 1);
961 $cur = substr($cur, length($1));
962 $res .= $type x length($1);
970 my ($possible, $line) = @_;
972 print "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
973 if ($possible !~ /(?:
986 ^(?:typedef|struct|enum)\b
988 # Check for modifiers.
989 $possible =~ s/\s*$Storage\s*//g;
990 $possible =~ s/\s*$Sparse\s*//g;
991 if ($possible =~ /^\s*$/) {
993 } elsif ($possible =~ /\s/) {
994 $possible =~ s/\s*$Type\s*//g;
995 for my $modifier (split(' ', $possible)) {
996 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
997 push(@modifierList, $modifier);
1001 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1002 push(@typeList, $possible);
1006 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1013 if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
1016 my $line = $prefix . $_[0];
1018 $line = (split('\n', $line))[0] . "\n" if ($terse);
1020 push(our @report, $line);
1028 if (report("ERROR: $_[0]\n")) {
1034 if (report("WARNING: $_[0]\n")) {
1040 if ($check && report("CHECK: $_[0]\n")) {
1046 sub check_absolute_file {
1047 my ($absolute, $herecurr) = @_;
1048 my $file = $absolute;
1050 ##print "absolute<$absolute>\n";
1052 # See if any suffix of this path is a path within the tree.
1053 while ($file =~ s@^[^/]*/@@) {
1054 if (-f "$root/$file") {
1055 ##print "file<$file>\n";
1063 # It is, so see if the prefix is acceptable.
1064 my $prefix = $absolute;
1065 substr($prefix, -length($file)) = '';
1067 ##print "prefix<$prefix>\n";
1068 if ($prefix ne ".../") {
1069 WARN("use relative pathname instead of absolute in changelog text\n" . $herecurr);
1074 my $filename = shift;
1080 my $stashrawline="";
1097 # Trace the real file/line as we go.
1103 my $comment_edge = 0;
1107 my $prev_values = 'E';
1110 my %suppress_ifbraces;
1111 my %suppress_whiletrailers;
1113 # Pre-scan the patch sanitizing the lines.
1114 # Pre-scan the patch looking for any __setup documentation.
1116 my @setup_docs = ();
1119 sanitise_line_reset();
1121 foreach my $rawline (@rawlines) {
1125 if ($rawline=~/^\+\+\+\s+(\S+)/) {
1127 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1132 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1141 # Guestimate if this is a continuing comment. Run
1142 # the context looking for a comment "edge". If this
1143 # edge is a close comment then we must be in a comment
1147 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1148 next if (defined $rawlines[$ln - 1] &&
1149 $rawlines[$ln - 1] =~ /^-/);
1151 #print "RAW<$rawlines[$ln - 1]>\n";
1152 last if (!defined $rawlines[$ln - 1]);
1153 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1154 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1159 if (defined $edge && $edge eq '*/') {
1163 # Guestimate if this is a continuing comment. If this
1164 # is the start of a diff block and this line starts
1165 # ' *' then it is very likely a comment.
1166 if (!defined $edge &&
1167 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1172 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1173 sanitise_line_reset($in_comment);
1175 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1176 # Standardise the strings and chars within the input to
1177 # simplify matching -- only bother with positive lines.
1178 $line = sanitise_line($rawline);
1180 push(@lines, $line);
1183 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1188 #print "==>$rawline\n";
1189 #print "-->$line\n";
1191 if ($setup_docs && $line =~ /^\+/) {
1192 push(@setup_docs, $line);
1200 foreach my $line (@lines) {
1203 my $rawline = $rawlines[$linenr - 1];
1204 my $hunk_line = ($realcnt != 0);
1206 #extract the line range in the file after the patch is applied
1207 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1209 $first_line = $linenr + 1;
1219 %suppress_ifbraces = ();
1220 %suppress_whiletrailers = ();
1223 # track the line number as we move through the hunk, note that
1224 # new versions of GNU diff omit the leading space on completely
1225 # blank context lines so we need to count that too.
1226 } elsif ($line =~ /^( |\+|$)/) {
1228 $realcnt-- if ($realcnt != 0);
1230 # Measure the line length and indent.
1231 ($length, $indent) = line_stats($rawline);
1233 # Track the previous line.
1234 ($prevline, $stashline) = ($stashline, $line);
1235 ($previndent, $stashindent) = ($stashindent, $indent);
1236 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1238 #warn "line<$line>\n";
1240 } elsif ($realcnt == 1) {
1244 #make up the handle for any error we report on this line
1245 $prefix = "$filename:$realline: " if ($emacs && $file);
1246 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1248 $here = "#$linenr: " if (!$file);
1249 $here = "#$realline: " if ($file);
1251 # extract the filename as it passes
1252 if ($line=~/^\+\+\+\s+(\S+)/) {
1254 $realfile =~ s@^([^/]*)/@@;
1257 if (!$file && $tree && $p1_prefix ne '' &&
1258 -e "$root/$p1_prefix") {
1259 WARN("patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1262 if ($realfile =~ m@^include/asm/@) {
1263 ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1268 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
1270 my $hereline = "$here\n$rawline\n";
1271 my $herecurr = "$here\n$rawline\n";
1272 my $hereprev = "$here\n$prevrawline\n$rawline\n";
1274 $cnt_lines++ if ($realcnt != 0);
1276 #check the patch for a signoff:
1277 if ($line =~ /^\s*signed-off-by:/i) {
1278 # This is a signoff, if ugly, so do not double report.
1280 if (!($line =~ /^\s*Signed-off-by:/)) {
1281 WARN("Signed-off-by: is the preferred form\n" .
1284 if ($line =~ /^\s*signed-off-by:\S/i) {
1285 WARN("space required after Signed-off-by:\n" .
1290 # Check for wrappage within a valid hunk of the file
1291 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1292 ERROR("patch seems to be corrupt (line wrapped?)\n" .
1293 $herecurr) if (!$emitted_corrupt++);
1296 # Check for absolute kernel paths.
1298 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1301 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1302 check_absolute_file($1, $herecurr)) {
1305 check_absolute_file($file, $herecurr);
1310 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1311 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1312 $rawline !~ m/^$UTF8*$/) {
1313 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1315 my $blank = copy_spacing($rawline);
1316 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1317 my $hereptr = "$hereline$ptr\n";
1319 ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1322 # ignore non-hunk lines and lines being removed
1323 next if (!$hunk_line || $line =~ /^-/);
1325 #trailing whitespace
1326 if ($line =~ /^\+.*\015/) {
1327 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1328 ERROR("DOS line endings\n" . $herevet);
1330 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1331 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1332 ERROR("trailing whitespace\n" . $herevet);
1335 # check we are in a valid source file if not then ignore this hunk
1336 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1339 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
1340 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1341 $line !~ /^\+\s*printk\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ &&
1344 WARN("line over 80 characters\n" . $herecurr);
1347 # check for adding lines without a newline.
1348 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1349 WARN("adding a line without newline at end of file\n" . $herecurr);
1352 # check we are in a valid source file C or perl if not then ignore this hunk
1353 next if ($realfile !~ /\.(h|c|pl)$/);
1355 # at the beginning of a line any tabs must come first and anything
1356 # more than 8 must use tabs.
1357 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1358 $rawline =~ /^\+\s* \s*/) {
1359 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1360 ERROR("code indent should use tabs where possible\n" . $herevet);
1363 # check we are in a valid C source file if not then ignore this hunk
1364 next if ($realfile !~ /\.(h|c)$/);
1366 # check for RCS/CVS revision markers
1367 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
1368 WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1371 # Check for potential 'bare' types
1372 my ($stat, $cond, $line_nr_next, $remain_next, $off_next);
1373 if ($realcnt && $line =~ /.\s*\S/) {
1374 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
1375 ctx_statement_block($linenr, $realcnt, 0);
1376 $stat =~ s/\n./\n /g;
1377 $cond =~ s/\n./\n /g;
1382 # Ignore goto labels.
1383 if ($s =~ /$Ident:\*$/s) {
1385 # Ignore functions being called
1386 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
1388 } elsif ($s =~ /^.\s*else\b/s) {
1390 # declarations always start with types
1391 } 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) {
1394 possible($type, "A:" . $s);
1396 # definitions in global scope can only start with types
1397 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
1398 possible($1, "B:" . $s);
1401 # any (foo ... *) is a pointer cast, and foo is a type
1402 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
1403 possible($1, "C:" . $s);
1406 # Check for any sort of function declaration.
1407 # int foo(something bar, other baz);
1408 # void (*store_gdt)(x86_descr_ptr *);
1409 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
1410 my ($name_len) = length($1);
1413 substr($ctx, 0, $name_len + 1, '');
1414 $ctx =~ s/\)[^\)]*$//;
1416 for my $arg (split(/\s*,\s*/, $ctx)) {
1417 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
1419 possible($1, "D:" . $s);
1427 # Checks which may be anchored in the context.
1430 # Check for switch () and associated case and default
1431 # statements should be at the same indent.
1432 if ($line=~/\bswitch\s*\(.*\)/) {
1435 my @ctx = ctx_block_outer($linenr, $realcnt);
1437 for my $ctx (@ctx) {
1438 my ($clen, $cindent) = line_stats($ctx);
1439 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1440 $indent != $cindent) {
1441 $err .= "$sep$ctx\n";
1448 ERROR("switch and case should be at the same indent\n$hereline$err");
1452 # if/while/etc brace do not go on next line, unless defining a do while loop,
1453 # or if that brace on the next line is for something else
1454 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
1455 my $pre_ctx = "$1$2";
1457 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
1458 my $ctx_cnt = $realcnt - $#ctx - 1;
1459 my $ctx = join("\n", @ctx);
1461 my $ctx_ln = $linenr;
1462 my $ctx_skip = $realcnt;
1464 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1465 defined $lines[$ctx_ln - 1] &&
1466 $lines[$ctx_ln - 1] =~ /^-/)) {
1467 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1468 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
1472 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1473 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
1475 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1476 ERROR("that open brace { should be on the previous line\n" .
1477 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1479 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1480 $ctx =~ /\)\s*\;\s*$/ &&
1481 defined $lines[$ctx_ln - 1])
1483 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1484 if ($nindent > $indent) {
1485 WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
1486 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1491 # Check relative indent for conditionals and blocks.
1492 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1493 my ($s, $c) = ($stat, $cond);
1495 substr($s, 0, length($c), '');
1497 # Make sure we remove the line prefixes as we have
1498 # none on the first line, and are going to readd them
1502 # Find out how long the conditional actually is.
1503 my @newlines = ($c =~ /\n/gs);
1504 my $cond_lines = 1 + $#newlines;
1506 # We want to check the first line inside the block
1507 # starting at the end of the conditional, so remove:
1508 # 1) any blank line termination
1509 # 2) any opening brace { on end of the line
1511 my $continuation = 0;
1513 $s =~ s/^.*\bdo\b//;
1515 if ($s =~ s/^\s*\\//) {
1518 if ($s =~ s/^\s*?\n//) {
1523 # Also ignore a loop construct at the end of a
1524 # preprocessor statement.
1525 if (($prevline =~ /^.\s*#\s*define\s/ ||
1526 $prevline =~ /\\\s*$/) && $continuation == 0) {
1532 while ($cond_ptr != $cond_lines) {
1533 $cond_ptr = $cond_lines;
1535 # If we see an #else/#elif then the code
1537 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
1542 # 1) blank lines, they should be at 0,
1543 # 2) preprocessor lines, and
1545 if ($continuation ||
1547 $s =~ /^\s*#\s*?/ ||
1548 $s =~ /^\s*$Ident\s*:/) {
1549 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
1555 my (undef, $sindent) = line_stats("+" . $s);
1556 my $stat_real = raw_line($linenr, $cond_lines);
1558 # Check if either of these lines are modified, else
1559 # this is not this patch's fault.
1560 if (!defined($stat_real) ||
1561 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
1564 if (defined($stat_real) && $cond_lines > 1) {
1565 $stat_real = "[...]\n$stat_real";
1568 #print "line<$line> prevline<$prevline> indent<$indent> sindent<$sindent> check<$check> continuation<$continuation> s<$s> cond_lines<$cond_lines> stat_real<$stat_real> stat<$stat>\n";
1570 if ($check && (($sindent % 8) != 0 ||
1571 ($sindent <= $indent && $s ne ''))) {
1572 WARN("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
1576 # Track the 'values' across context and added lines.
1577 my $opline = $line; $opline =~ s/^./ /;
1578 my ($curr_values, $curr_vars) =
1579 annotate_values($opline . "\n", $prev_values);
1580 $curr_values = $prev_values . $curr_values;
1582 my $outline = $opline; $outline =~ s/\t/ /g;
1583 print "$linenr > .$outline\n";
1584 print "$linenr > $curr_values\n";
1585 print "$linenr > $curr_vars\n";
1587 $prev_values = substr($curr_values, -1);
1589 #ignore lines not being added
1590 if ($line=~/^[^\+]/) {next;}
1592 # TEST: allow direct testing of the type matcher.
1594 if ($line =~ /^.\s*$Declare\s*$/) {
1595 ERROR("TEST: is type\n" . $herecurr);
1596 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
1597 ERROR("TEST: is not type ($1 is)\n". $herecurr);
1601 # TEST: allow direct testing of the attribute matcher.
1603 if ($line =~ /^.\s*$Modifier\s*$/) {
1604 ERROR("TEST: is attr\n" . $herecurr);
1605 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
1606 ERROR("TEST: is not attr ($1 is)\n". $herecurr);
1611 # check for initialisation to aggregates open brace on the next line
1612 if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ &&
1613 $line =~ /^.\s*{/) {
1614 ERROR("that open brace { should be on the previous line\n" . $hereprev);
1618 # Checks which are anchored on the added line.
1621 # check for malformed paths in #include statements (uses RAW line)
1622 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
1624 if ($path =~ m{//}) {
1625 ERROR("malformed #include filename\n" .
1630 # no C99 // comments
1631 if ($line =~ m{//}) {
1632 ERROR("do not use C99 // comments\n" . $herecurr);
1634 # Remove C99 comments.
1636 $opline =~ s@//.*@@;
1638 #EXPORT_SYMBOL should immediately follow its function closing }.
1639 if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) ||
1640 ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1642 if ($prevline !~ /(?:
1644 ^.DEFINE_$Ident\(\Q$name\E\)|
1645 ^.DECLARE_$Ident\(\Q$name\E\)|
1646 ^.LIST_HEAD\(\Q$name\E\)|
1647 ^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
1648 \b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[)
1650 WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
1654 # check for external initialisers.
1655 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
1656 ERROR("do not initialise externals to 0 or NULL\n" .
1659 # check for static initialisers.
1660 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
1661 ERROR("do not initialise statics to 0 or NULL\n" .
1665 # check for new typedefs, only function parameters and sparse annotations
1667 if ($line =~ /\btypedef\s/ &&
1668 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
1669 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
1670 $line !~ /\b$typeTypedefs\b/ &&
1671 $line !~ /\b__bitwise(?:__|)\b/) {
1672 WARN("do not add new typedefs\n" . $herecurr);
1675 # * goes on variable not on type
1677 if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) {
1678 my ($from, $to) = ($1, $1);
1680 # Should start with a space.
1681 $to =~ s/^(\S)/ $1/;
1682 # Should not end with a space.
1684 # '*'s should not have spaces between.
1685 while ($to =~ s/\*\s+\*/\*\*/) {
1688 #print "from<$from> to<$to>\n";
1690 ERROR("\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr);
1692 } elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) {
1693 my ($from, $to, $ident) = ($1, $1, $2);
1695 # Should start with a space.
1696 $to =~ s/^(\S)/ $1/;
1697 # Should not end with a space.
1699 # '*'s should not have spaces between.
1700 while ($to =~ s/\*\s+\*/\*\*/) {
1702 # Modifiers should have spaces.
1703 $to =~ s/(\b$Modifier$)/$1 /;
1705 #print "from<$from> to<$to> ident<$ident>\n";
1706 if ($from ne $to && $ident !~ /^$Modifier$/) {
1707 ERROR("\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr);
1711 # # no BUG() or BUG_ON()
1712 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
1713 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
1714 # print "$herecurr";
1718 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
1719 WARN("LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
1722 # printk should use KERN_* levels. Note that follow on printk's on the
1723 # same line do not need a level, so we use the current block context
1724 # to try and find and validate the current printk. In summary the current
1725 # printk includes all preceeding printk's which have no newline on the end.
1726 # we assume the first bad printk is the one to report.
1727 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
1729 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
1730 #print "CHECK<$lines[$ln - 1]\n";
1731 # we have a preceeding printk if it ends
1732 # with "\n" ignore it, else it is to blame
1733 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
1734 if ($rawlines[$ln - 1] !~ m{\\n"}) {
1741 WARN("printk() should include KERN_ facility level\n" . $herecurr);
1745 # function brace can't be on same line, except for #defines of do while,
1746 # or if closed on same line
1747 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
1748 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
1749 ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
1752 # open braces for enum, union and struct go on the same line.
1753 if ($line =~ /^.\s*{/ &&
1754 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1755 ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
1758 # check for spacing round square brackets; allowed:
1759 # 1. with a type on the left -- int [] a;
1760 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
1761 # 3. inside a curly brace -- = { [0...10] = 5 }
1762 while ($line =~ /(.*?\s)\[/g) {
1763 my ($where, $prefix) = ($-[1], $1);
1764 if ($prefix !~ /$Type\s+$/ &&
1765 ($where != 0 || $prefix !~ /^.\s+$/) &&
1766 $prefix !~ /{\s+$/) {
1767 ERROR("space prohibited before open square bracket '['\n" . $herecurr);
1771 # check for spaces between functions and their parentheses.
1772 while ($line =~ /($Ident)\s+\(/g) {
1774 my $ctx_before = substr($line, 0, $-[1]);
1775 my $ctx = "$ctx_before$name";
1777 # Ignore those directives where spaces _are_ permitted.
1779 if|for|while|switch|return|case|
1780 volatile|__volatile__|
1781 __attribute__|format|__extension__|
1785 # cpp #define statements have non-optional spaces, ie
1786 # if there is a space between the name and the open
1787 # parenthesis it is simply not a parameter group.
1788 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
1790 # cpp #elif statement condition may start with a (
1791 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
1793 # If this whole things ends with a type its most
1794 # likely a typedef for a function.
1795 } elsif ($ctx =~ /$Type$/) {
1798 WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
1801 # Check operator spacing.
1802 if (!($line=~/\#\s*include/)) {
1804 <<=|>>=|<=|>=|==|!=|
1805 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
1806 =>|->|<<|>>|<|>|=|!|~|
1807 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
1810 my @elements = split(/($ops|;)/, $opline);
1813 my $blank = copy_spacing($opline);
1815 for (my $n = 0; $n < $#elements; $n += 2) {
1816 $off += length($elements[$n]);
1818 # Pick up the preceeding and succeeding characters.
1819 my $ca = substr($opline, 0, $off);
1821 if (length($opline) >= ($off + length($elements[$n + 1]))) {
1822 $cc = substr($opline, $off + length($elements[$n + 1]));
1824 my $cb = "$ca$;$cc";
1827 $a = 'V' if ($elements[$n] ne '');
1828 $a = 'W' if ($elements[$n] =~ /\s$/);
1829 $a = 'C' if ($elements[$n] =~ /$;$/);
1830 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
1831 $a = 'O' if ($elements[$n] eq '');
1832 $a = 'E' if ($ca =~ /^\s*$/);
1834 my $op = $elements[$n + 1];
1837 if (defined $elements[$n + 2]) {
1838 $c = 'V' if ($elements[$n + 2] ne '');
1839 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
1840 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
1841 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
1842 $c = 'O' if ($elements[$n + 2] eq '');
1843 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
1848 my $ctx = "${a}x${c}";
1850 my $at = "(ctx:$ctx)";
1852 my $ptr = substr($blank, 0, $off) . "^";
1853 my $hereptr = "$hereline$ptr\n";
1855 # Pull out the value of this operator.
1856 my $op_type = substr($curr_values, $off + 1, 1);
1858 # Get the full operator variant.
1859 my $opv = $op . substr($curr_vars, $off, 1);
1861 # Ignore operators passed as parameters.
1862 if ($op_type ne 'V' &&
1863 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
1866 # } elsif ($op =~ /^$;+$/) {
1868 # ; should have either the end of line or a space or \ after it
1869 } elsif ($op eq ';') {
1870 if ($ctx !~ /.x[WEBC]/ &&
1871 $cc !~ /^\\/ && $cc !~ /^;/) {
1872 ERROR("space required after that '$op' $at\n" . $hereptr);
1876 } elsif ($op eq '//') {
1880 # : when part of a bitfield
1881 } elsif ($op eq '->' || $opv eq ':B') {
1882 if ($ctx =~ /Wx.|.xW/) {
1883 ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
1886 # , must have a space on the right.
1887 } elsif ($op eq ',') {
1888 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
1889 ERROR("space required after that '$op' $at\n" . $hereptr);
1892 # '*' as part of a type definition -- reported already.
1893 } elsif ($opv eq '*_') {
1894 #warn "'*' is part of type\n";
1896 # unary operators should have a space before and
1897 # none after. May be left adjacent to another
1898 # unary operator, or a cast
1899 } elsif ($op eq '!' || $op eq '~' ||
1900 $opv eq '*U' || $opv eq '-U' ||
1901 $opv eq '&U' || $opv eq '&&U') {
1902 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
1903 ERROR("space required before that '$op' $at\n" . $hereptr);
1905 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
1906 # A unary '*' may be const
1908 } elsif ($ctx =~ /.xW/) {
1909 ERROR("Aspace prohibited after that '$op' $at\n" . $hereptr);
1912 # unary ++ and unary -- are allowed no space on one side.
1913 } elsif ($op eq '++' or $op eq '--') {
1914 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
1915 ERROR("space required one side of that '$op' $at\n" . $hereptr);
1917 if ($ctx =~ /Wx[BE]/ ||
1918 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
1919 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
1921 if ($ctx =~ /ExW/) {
1922 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1926 # << and >> may either have or not have spaces both sides
1927 } elsif ($op eq '<<' or $op eq '>>' or
1928 $op eq '&' or $op eq '^' or $op eq '|' or
1929 $op eq '+' or $op eq '-' or
1930 $op eq '*' or $op eq '/' or
1933 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
1934 ERROR("need consistent spacing around '$op' $at\n" .
1938 # A colon needs no spaces before when it is
1939 # terminating a case value or a label.
1940 } elsif ($opv eq ':C' || $opv eq ':L') {
1941 if ($ctx =~ /Wx./) {
1942 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
1945 # All the others need spaces both sides.
1946 } elsif ($ctx !~ /[EWC]x[CWE]/) {
1949 # Ignore email addresses <foo@bar>
1951 $cc =~ /^\S+\@\S+>/) ||
1953 $ca =~ /<\S+\@\S+$/))
1959 if (($opv eq ':O' && $ca =~ /\?$/) ||
1960 ($op eq '?' && $cc =~ /^:/)) {
1965 ERROR("spaces required around that '$op' $at\n" . $hereptr);
1968 $off += length($elements[$n + 1]);
1972 # check for multiple assignments
1973 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
1974 CHK("multiple assignments should be avoided\n" . $herecurr);
1977 ## # check for multiple declarations, allowing for a function declaration
1979 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
1980 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
1982 ## # Remove any bracketed sections to ensure we do not
1983 ## # falsly report the parameters of functions.
1985 ## while ($ln =~ s/\([^\(\)]*\)//g) {
1987 ## if ($ln =~ /,/) {
1988 ## WARN("declaring multiple variables together should be avoided\n" . $herecurr);
1992 #need space before brace following if, while, etc
1993 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
1995 ERROR("space required before the open brace '{'\n" . $herecurr);
1998 # closing brace should have a space following it when it has anything
2000 if ($line =~ /}(?!(?:,|;|\)))\S/) {
2001 ERROR("space required after that close brace '}'\n" . $herecurr);
2004 # check spacing on square brackets
2005 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
2006 ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
2008 if ($line =~ /\s\]/) {
2009 ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
2012 # check spacing on parentheses
2013 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
2014 $line !~ /for\s*\(\s+;/) {
2015 ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
2017 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
2018 $line !~ /for\s*\(.*;\s+\)/ &&
2019 $line !~ /:\s+\)/) {
2020 ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
2023 #goto labels aren't indented, allow a single space however
2024 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
2025 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
2026 WARN("labels should not be indented\n" . $herecurr);
2029 # Return is not a function.
2030 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2034 # Flatten any parentheses
2035 $value =~ s/\)\(/\) \(/g;
2036 while ($value =~ s/\[[^\{\}]*\]/1/ ||
2037 $value !~ /(?:$Ident|-?$Constant)\s*
2039 (?:$Ident|-?$Constant)/x &&
2040 $value =~ s/\([^\(\)]*\)/1/) {
2043 if ($value =~ /^(?:$Ident|-?$Constant)$/) {
2044 ERROR("return is not a function, parentheses are not required\n" . $herecurr);
2046 } elsif ($spacing !~ /\s+/) {
2047 ERROR("space required before the open parenthesis '('\n" . $herecurr);
2051 # Need a space before open parenthesis after if, while etc
2052 if ($line=~/\b(if|while|for|switch)\(/) {
2053 ERROR("space required before the open parenthesis '('\n" . $herecurr);
2056 # Check for illegal assignment in if conditional -- and check for trailing
2057 # statements after the conditional.
2058 if ($line =~ /do\s*(?!{)/) {
2059 my ($stat_next) = ctx_statement_block($line_nr_next,
2060 $remain_next, $off_next);
2061 $stat_next =~ s/\n./\n /g;
2062 ##print "stat<$stat> stat_next<$stat_next>\n";
2064 if ($stat_next =~ /^\s*while\b/) {
2065 # If the statement carries leading newlines,
2066 # then count those as offsets.
2068 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2070 statement_rawlines($whitespace) - 1;
2072 $suppress_whiletrailers{$line_nr_next +
2076 if (!defined $suppress_whiletrailers{$linenr} &&
2077 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
2078 my ($s, $c) = ($stat, $cond);
2080 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
2081 ERROR("do not use assignment in if condition\n" . $herecurr);
2084 # Find out what is on the end of the line after the
2086 substr($s, 0, length($c), '');
2088 $s =~ s/$;//g; # Remove any comments
2089 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2090 $c !~ /}\s*while\s*/)
2092 # Find out how long the conditional actually is.
2093 my @newlines = ($c =~ /\n/gs);
2094 my $cond_lines = 1 + $#newlines;
2096 my $stat_real = raw_line($linenr, $cond_lines);
2097 if (defined($stat_real) && $cond_lines > 1) {
2098 $stat_real = "[...]\n$stat_real";
2101 ERROR("trailing statements should be on next line\n" . $herecurr . $stat_real);
2105 # Check for bitwise tests written as boolean
2117 WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2120 # if and else should not have general statements after it
2121 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2123 $s =~ s/$;//g; # Remove any comments
2124 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2125 ERROR("trailing statements should be on next line\n" . $herecurr);
2128 # if should not continue a brace
2129 if ($line =~ /}\s*if\b/) {
2130 ERROR("trailing statements should be on next line\n" .
2133 # case and default should not have general statements after them
2134 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2136 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
2140 ERROR("trailing statements should be on next line\n" . $herecurr);
2143 # Check for }<nl>else {, these must be at the same
2144 # indent level to be relevant to each other.
2145 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2146 $previndent == $indent) {
2147 ERROR("else should follow close brace '}'\n" . $hereprev);
2150 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2151 $previndent == $indent) {
2152 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2154 # Find out what is on the end of the line after the
2156 substr($s, 0, length($c), '');
2159 if ($s =~ /^\s*;/) {
2160 ERROR("while should follow close brace '}'\n" . $hereprev);
2164 #studly caps, commented out until figure out how to distinguish between use of existing and adding new
2165 # if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2166 # print "No studly caps, use _\n";
2167 # print "$herecurr";
2171 #no spaces allowed after \ in define
2172 if ($line=~/\#\s*define.*\\\s$/) {
2173 WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
2176 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
2177 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
2179 my $checkfile = "include/linux/$file";
2180 if (-f "$root/$checkfile" &&
2181 $realfile ne $checkfile &&
2184 if ($realfile =~ m{^arch/}) {
2185 CHK("Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2187 WARN("Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2192 # multi-statement macros should be enclosed in a do while loop, grab the
2193 # first statement and ensure its the whole macro if its not enclosed
2194 # in a known good container
2195 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2196 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
2199 my ($off, $dstat, $dcond, $rest);
2202 my $args = defined($1);
2204 # Find the end of the macro and limit our statement
2206 while ($cnt > 0 && defined $lines[$ln - 1] &&
2207 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
2209 $ctx .= $rawlines[$ln - 1] . "\n";
2210 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2213 $ctx .= $rawlines[$ln - 1];
2215 ($dstat, $dcond, $ln, $cnt, $off) =
2216 ctx_statement_block($linenr, $ln - $linenr + 1, 0);
2217 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
2218 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
2220 # Extract the remainder of the define (if any) and
2221 # rip off surrounding spaces, and trailing \'s.
2223 while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
2224 #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
2225 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
2226 $rest .= substr($lines[$ln - 1], $off) . "\n";
2232 $rest =~ s/\\\n.//g;
2236 # Clean up the original statement.
2238 substr($dstat, 0, length($dcond), '');
2240 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
2243 $dstat =~ s/\\\n.//g;
2244 $dstat =~ s/^\s*//s;
2245 $dstat =~ s/\s*$//s;
2247 # Flatten any parentheses and braces
2248 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2249 $dstat =~ s/\{[^\{\}]*\}/1/ ||
2250 $dstat =~ s/\[[^\{\}]*\]/1/)
2254 my $exceptions = qr{
2263 #print "REST<$rest> dstat<$dstat>\n";
2265 if ($rest !~ /while\s*\(/ &&
2266 $dstat !~ /$exceptions/)
2268 ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
2271 } elsif ($ctx !~ /;/) {
2273 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2274 $dstat !~ /$exceptions/ &&
2275 $dstat !~ /^\.$Ident\s*=/ &&
2276 $dstat =~ /$Operators/)
2278 ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
2283 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
2284 # all assignments may have only one of the following with an assignment:
2287 # VMLINUX_SYMBOL(...)
2288 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
2289 WARN("vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
2292 # check for redundant bracing round if etc
2293 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2294 my ($level, $endln, @chunks) =
2295 ctx_statement_full($linenr, $realcnt, 1);
2296 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
2297 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2298 if ($#chunks > 0 && $level == 0) {
2301 my $herectx = $here . "\n";
2302 my $ln = $linenr - 1;
2303 for my $chunk (@chunks) {
2304 my ($cond, $block) = @{$chunk};
2306 # If the condition carries leading newlines, then count those as offsets.
2307 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2308 my $offset = statement_rawlines($whitespace) - 1;
2310 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2312 # We have looked at and allowed this specific line.
2313 $suppress_ifbraces{$ln + $offset} = 1;
2315 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
2316 $ln += statement_rawlines($block) - 1;
2318 substr($block, 0, length($cond), '');
2320 $seen++ if ($block =~ /^\s*{/);
2322 #print "cond<$cond> block<$block> allowed<$allowed>\n";
2323 if (statement_lines($cond) > 1) {
2324 #print "APW: ALLOWED: cond<$cond>\n";
2327 if ($block =~/\b(?:if|for|while)\b/) {
2328 #print "APW: ALLOWED: block<$block>\n";
2331 if (statement_block_size($block) > 1) {
2332 #print "APW: ALLOWED: lines block<$block>\n";
2336 if ($seen && !$allowed) {
2337 WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
2341 if (!defined $suppress_ifbraces{$linenr - 1} &&
2342 $line =~ /\b(if|while|for|else)\b/) {
2345 # Check the pre-context.
2346 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2347 #print "APW: ALLOWED: pre<$1>\n";
2351 my ($level, $endln, @chunks) =
2352 ctx_statement_full($linenr, $realcnt, $-[0]);
2354 # Check the condition.
2355 my ($cond, $block) = @{$chunks[0]};
2356 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
2357 if (defined $cond) {
2358 substr($block, 0, length($cond), '');
2360 if (statement_lines($cond) > 1) {
2361 #print "APW: ALLOWED: cond<$cond>\n";
2364 if ($block =~/\b(?:if|for|while)\b/) {
2365 #print "APW: ALLOWED: block<$block>\n";
2368 if (statement_block_size($block) > 1) {
2369 #print "APW: ALLOWED: lines block<$block>\n";
2372 # Check the post-context.
2373 if (defined $chunks[1]) {
2374 my ($cond, $block) = @{$chunks[1]};
2375 if (defined $cond) {
2376 substr($block, 0, length($cond), '');
2378 if ($block =~ /^\s*\{/) {
2379 #print "APW: ALLOWED: chunk-1 block<$block>\n";
2383 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
2384 my $herectx = $here . "\n";;
2385 my $cnt = statement_rawlines($block);
2387 for (my $n = 0; $n < $cnt; $n++) {
2388 $herectx .= raw_line($linenr, $n) . "\n";;
2391 WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
2395 # don't include deprecated include files (uses RAW line)
2396 for my $inc (@dep_includes) {
2397 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
2398 ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2402 # don't use deprecated functions
2403 for my $func (@dep_functions) {
2404 if ($line =~ /\b$func\b/) {
2405 ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2409 # no volatiles please
2410 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2411 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
2412 WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
2415 # SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
2416 if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
2417 ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
2421 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
2422 CHK("if this code is redundant consider removing it\n" .
2426 # check for needless kfree() checks
2427 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2429 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
2430 WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
2433 # check for needless usb_free_urb() checks
2434 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2436 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
2437 WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
2441 # warn about #ifdefs in C files
2442 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
2443 # print "#ifdef in C files should be avoided\n";
2444 # print "$herecurr";
2448 # warn about spacing in #ifdefs
2449 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
2450 ERROR("exactly one space required after that #$1\n" . $herecurr);
2453 # check for spinlock_t definitions without a comment.
2454 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
2455 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
2457 if (!ctx_has_comment($first_line, $linenr)) {
2458 CHK("$1 definition without comment\n" . $herecurr);
2461 # check for memory barriers without a comment.
2462 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2463 if (!ctx_has_comment($first_line, $linenr)) {
2464 CHK("memory barrier without comment\n" . $herecurr);
2467 # check of hardware specific defines
2468 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
2469 CHK("architecture specific defines should be avoided\n" . $herecurr);
2472 # check the location of the inline attribute, that it is between
2473 # storage class and type.
2474 if ($line =~ /\b$Type\s+$Inline\b/ ||
2475 $line =~ /\b$Inline\s+$Storage\b/) {
2476 ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
2479 # Check for __inline__ and __inline, prefer inline
2480 if ($line =~ /\b(__inline__|__inline)\b/) {
2481 WARN("plain inline is preferred over $1\n" . $herecurr);
2484 # check for new externs in .c files.
2485 if ($realfile =~ /\.c$/ && defined $stat &&
2486 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
2488 my $function_name = $1;
2489 my $paren_space = $2;
2492 if (defined $cond) {
2493 substr($s, 0, length($cond), '');
2495 if ($s =~ /^\s*;/ &&
2496 $function_name ne 'uninitialized_var')
2498 WARN("externs should be avoided in .c files\n" . $herecurr);
2501 if ($paren_space =~ /\n/) {
2502 WARN("arguments for function declarations should follow identifier\n" . $herecurr);
2505 } elsif ($realfile =~ /\.c$/ && defined $stat &&
2506 $stat =~ /^.\s*extern\s+/)
2508 WARN("externs should be avoided in .c files\n" . $herecurr);
2511 # checks for new __setup's
2512 if ($rawline =~ /\b__setup\("([^"]*)"/) {
2515 if (!grep(/$name/, @setup_docs)) {
2516 CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
2520 # check for pointless casting of kmalloc return
2521 if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
2522 WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
2525 # check for gcc specific __FUNCTION__
2526 if ($line =~ /__FUNCTION__/) {
2527 WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
2530 # check for semaphores used as mutexes
2531 if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
2532 WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
2534 # check for semaphores used as mutexes
2535 if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
2536 WARN("consider using a completion\n" . $herecurr);
2538 # recommend strict_strto* over simple_strto*
2539 if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2540 WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
2542 # check for __initcall(), use device_initcall() explicitly please
2543 if ($line =~ /^.\s*__initcall\s*\(/) {
2544 WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
2546 # check for struct file_operations, ensure they are const.
2547 if ($line !~ /\bconst\b/ &&
2548 $line =~ /\bstruct\s+(file_operations|seq_operations)\b/) {
2549 WARN("struct $1 should normally be const\n" .
2553 # use of NR_CPUS is usually wrong
2554 # ignore definitions of NR_CPUS and usage to define arrays as likely right
2555 if ($line =~ /\bNR_CPUS\b/ &&
2556 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
2557 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
2558 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
2559 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
2560 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
2562 WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
2565 # check for %L{u,d,i} in strings
2567 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2568 $string = substr($rawline, $-[1], $+[1] - $-[1]);
2569 $string =~ s/%%/__/g;
2570 if ($string =~ /(?<!%)%L[udi]/) {
2571 WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2576 # whine mightly about in_atomic
2577 if ($line =~ /\bin_atomic\s*\(/) {
2578 if ($realfile =~ m@^drivers/@) {
2579 ERROR("do not use in_atomic in drivers\n" . $herecurr);
2580 } elsif ($realfile !~ m@^kernel/@) {
2581 WARN("use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
2586 # If we have no input at all, then there is nothing to report on
2587 # so just keep quiet.
2588 if ($#rawlines == -1) {
2592 # In mailback mode only produce a report in the negative, for
2593 # things that appear to be patches.
2594 if ($mailback && ($clean == 1 || !$is_patch)) {
2598 # This is not a patch, and we are are in 'no-patch' mode so
2600 if (!$chk_patch && !$is_patch) {
2605 ERROR("Does not appear to be a unified-diff format patch\n");
2607 if ($is_patch && $chk_signoff && $signoff == 0) {
2608 ERROR("Missing Signed-off-by: line(s)\n");
2611 print report_dump();
2612 if ($summary && !($clean == 1 && $quiet == 1)) {
2613 print "$filename " if ($summary_file);
2614 print "total: $cnt_error errors, $cnt_warn warnings, " .
2615 (($check)? "$cnt_chk checks, " : "") .
2616 "$cnt_lines lines checked\n";
2617 print "\n" if ($quiet == 0);
2620 if ($clean == 1 && $quiet == 0) {
2621 print "$vname has no obvious style problems and is ready for submission.\n"
2623 if ($clean == 0 && $quiet == 0) {
2624 print "$vname has style problems, please review. If any of these errors\n";
2625 print "are false positives report them to the maintainer, see\n";
2626 print "CHECKPATCH in MAINTAINERS.\n";