my $P = $0;
$P =~ s@.*/@@g;
-my $V = '0.11';
+my $V = '0.14';
use Getopt::Long qw(:config no_auto_abbrev);
my $chk_patch = 1;
my $tst_type = 0;
my $emacs = 0;
+my $terse = 0;
my $file = 0;
my $check = 0;
+my $summary = 1;
+my $mailback = 0;
+my $summary_file = 0;
my $root;
+my %debug;
GetOptions(
'q|quiet+' => \$quiet,
'tree!' => \$tree,
'signoff!' => \$chk_signoff,
'patch!' => \$chk_patch,
- 'test-type!' => \$tst_type,
'emacs!' => \$emacs,
+ 'terse!' => \$terse,
'file!' => \$file,
'subjective!' => \$check,
'strict!' => \$check,
'root=s' => \$root,
+ 'summary!' => \$summary,
+ 'mailback!' => \$mailback,
+ 'summary-file!' => \$summary_file,
+
+ 'debug=s' => \%debug,
+ 'test-type!' => \$tst_type,
) or exit;
my $exit = 0;
if ($#ARGV < 0) {
print "usage: $P [options] patchfile\n";
print "version: $V\n";
- print "options: -q => quiet\n";
- print " --no-tree => run without a kernel tree\n";
- print " --emacs => emacs compile window format\n";
- print " --file => check a source file\n";
- print " --strict => enable more subjective tests\n";
- print " --root => path to the kernel tree root\n";
+ print "options: -q => quiet\n";
+ print " --no-tree => run without a kernel tree\n";
+ print " --terse => one line per report\n";
+ print " --emacs => emacs compile window format\n";
+ print " --file => check a source file\n";
+ print " --strict => enable more subjective tests\n";
+ print " --root => path to the kernel tree root\n";
+ print " --no-summary => suppress the per-file summary\n";
+ print " --summary-file => include the filename in summary\n";
exit(1);
}
+my $dbg_values = 0;
+my $dbg_possible = 0;
+for my $key (keys %debug) {
+ eval "\${dbg_$key} = '$debug{$key}';"
+}
+
+if ($terse) {
+ $emacs = 1;
+ $quiet++;
+}
+
if ($tree) {
if (defined $root) {
if (!top_of_kernel_tree($root)) {
__(?:mem|cpu|dev|)(?:initdata|init)
}x;
our $Inline = qr{inline|__always_inline|noinline};
-our $NonptrType = qr{
- \b
- (?:const\s+)?
- (?:unsigned\s+)?
- (?:
- void|
- char|
- short|
- int|
- long|
- unsigned|
- float|
- double|
- bool|
- long\s+int|
- long\s+long|
- long\s+long\s+int|
- (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
- struct\s+$Ident|
- union\s+$Ident|
- enum\s+$Ident|
- ${Ident}_t|
- ${Ident}_handler|
- ${Ident}_handler_fn
- )
- (?:\s+$Sparse)*
- \b
- }x;
-
-our $Type = qr{
- \b$NonptrType\b
- (?:\s*\*+\s*const|\s*\*+|(?:\s*\[\s*\])+)?
- (?:\s+$Sparse|\s+$Attribute)*
- }x;
-our $Declare = qr{(?:$Storage\s+)?$Type};
our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
our $Lval = qr{$Ident(?:$Member)*};
our $Operators = qr{
<=|>=|==|!=|
=>|->|<<|>>|<|>|!|~|
- &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/
+ &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
}x;
-our $Bare = '';
+our $NonptrType;
+our $Type;
+our $Declare;
+
+our @typeList = (
+ qr{void},
+ qr{char},
+ qr{short},
+ qr{int},
+ qr{long},
+ qr{unsigned},
+ qr{float},
+ qr{double},
+ qr{bool},
+ qr{long\s+int},
+ qr{long\s+long},
+ qr{long\s+long\s+int},
+ qr{(?:__)?(?:u|s|be|le)(?:8|16|32|64)},
+ qr{struct\s+$Ident},
+ qr{union\s+$Ident},
+ qr{enum\s+$Ident},
+ qr{${Ident}_t},
+ qr{${Ident}_handler},
+ qr{${Ident}_handler_fn},
+);
+
+sub build_types {
+ my $all = "(?: \n" . join("|\n ", @typeList) . "\n)";
+ $NonptrType = qr{
+ \b
+ (?:const\s+)?
+ (?:unsigned\s+)?
+ $all
+ (?:\s+$Sparse|\s+const)*
+ \b
+ }x;
+ $Type = qr{
+ \b$NonptrType\b
+ (?:\s*\*+\s*const|\s*\*+|(?:\s*\[\s*\])+)?
+ (?:\s+$Inline|\s+$Sparse|\s+$Attribute)*
+ }x;
+ $Declare = qr{(?:$Storage\s+)?$Type};
+}
+build_types();
$chk_signoff = 0 if ($file);
}
my @rawlines = ();
+my @lines = ();
+my $vname;
for my $filename (@ARGV) {
if ($file) {
open(FILE, "diff -u /dev/null $filename|") ||
open(FILE, "<$filename") ||
die "$P: $filename: open failed - $!\n";
}
+ if ($filename eq '-') {
+ $vname = 'Your patch';
+ } else {
+ $vname = $filename;
+ }
while (<FILE>) {
chomp;
push(@rawlines, $_);
}
close(FILE);
- if (!process($filename, @rawlines)) {
+ if (!process($filename)) {
$exit = 1;
}
@rawlines = ();
+ @lines = ();
}
exit($exit);
my $l = '';
my $quote = '';
+ my $qlen = 0;
foreach my $c (split(//, $line)) {
+ # The second backslash of a pair is not a "quote".
+ if ($l eq "\\" && $c eq "\\") {
+ $c = 'X';
+ }
if ($l ne "\\" && ($c eq "'" || $c eq '"')) {
if ($quote eq '') {
$quote = $c;
$res .= $c;
$l = $c;
+ $qlen = 0;
next;
} elsif ($quote eq $c) {
$quote = '';
}
}
+ if ($quote eq "'" && $qlen > 1) {
+ $quote = '';
+ }
if ($quote && $c ne "\t") {
$res .= "X";
+ $qlen++;
} else {
$res .= $c;
}
$l = $c;
}
+ # Clear out the comments.
+ while ($res =~ m@(/\*.*?\*/)@g) {
+ substr($res, $-[1], $+[1] - $-[1]) = $; x ($+[1] - $-[1]);
+ }
+ if ($res =~ m@(/\*.*)@) {
+ substr($res, $-[1], $+[1] - $-[1]) = $; x ($+[1] - $-[1]);
+ }
+ if ($res =~ m@^.(.*\*/)@) {
+ substr($res, $-[1], $+[1] - $-[1]) = $; x ($+[1] - $-[1]);
+ }
+
+ # The pathname on a #include may be surrounded by '<' and '>'.
+ if ($res =~ /^.#\s*include\s+\<(.*)\>/) {
+ my $clean = 'X' x length($1);
+ $res =~ s@\<.*\>@<$clean>@;
+
+ # The whole of a #error is a string.
+ } elsif ($res =~ /^.#\s*(?:error|warning)\s+(.*)\b/) {
+ my $clean = 'X' x length($1);
+ $res =~ s@(#\s*(?:error|warning)\s+).*@$1$clean@;
+ }
+
return $res;
}
+sub ctx_statement_block {
+ my ($linenr, $remain, $off) = @_;
+ my $line = $linenr - 1;
+ my $blk = '';
+ my $soff = $off;
+ my $coff = $off - 1;
+
+ my $loff = 0;
+
+ my $type = '';
+ my $level = 0;
+ my $c;
+ my $len = 0;
+
+ my $remainder;
+ while (1) {
+ #warn "CSB: blk<$blk>\n";
+ # If we are about to drop off the end, pull in more
+ # context.
+ if ($off >= $len) {
+ for (; $remain > 0; $line++) {
+ next if ($lines[$line] =~ /^-/);
+ $remain--;
+ $loff = $len;
+ $blk .= $lines[$line] . "\n";
+ $len = length($blk);
+ $line++;
+ last;
+ }
+ # Bail if there is no further context.
+ #warn "CSB: blk<$blk> off<$off> len<$len>\n";
+ if ($off >= $len) {
+ last;
+ }
+ }
+ $c = substr($blk, $off, 1);
+ $remainder = substr($blk, $off);
+
+ #warn "CSB: c<$c> type<$type> level<$level>\n";
+ # Statement ends at the ';' or a close '}' at the
+ # outermost level.
+ if ($level == 0 && $c eq ';') {
+ last;
+ }
+
+ # An else is really a conditional as long as its not else if
+ if ($level == 0 && $remainder =~ /(\s+else)(?:\s|{)/ &&
+ $remainder !~ /\s+else\s+if\b/) {
+ $coff = $off + length($1);
+ }
+
+ if (($type eq '' || $type eq '(') && $c eq '(') {
+ $level++;
+ $type = '(';
+ }
+ if ($type eq '(' && $c eq ')') {
+ $level--;
+ $type = ($level != 0)? '(' : '';
+
+ if ($level == 0 && $coff < $soff) {
+ $coff = $off;
+ }
+ }
+ if (($type eq '' || $type eq '{') && $c eq '{') {
+ $level++;
+ $type = '{';
+ }
+ if ($type eq '{' && $c eq '}') {
+ $level--;
+ $type = ($level != 0)? '{' : '';
+
+ if ($level == 0) {
+ last;
+ }
+ }
+ $off++;
+ }
+ if ($off == $len) {
+ $line++;
+ $remain--;
+ }
+
+ my $statement = substr($blk, $soff, $off - $soff + 1);
+ my $condition = substr($blk, $soff, $coff - $soff + 1);
+
+ #warn "STATEMENT<$statement>\n";
+ #warn "CONDITION<$condition>\n";
+
+ #print "off<$off> loff<$loff>\n";
+
+ return ($statement, $condition,
+ $line, $remain + 1, $off - $loff + 1, $level);
+}
+
+sub ctx_statement_full {
+ my ($linenr, $remain, $off) = @_;
+ my ($statement, $condition, $level);
+
+ my (@chunks);
+
+ ($statement, $condition, $linenr, $remain, $off, $level) =
+ ctx_statement_block($linenr, $remain, $off);
+ #print "F: c<$condition> s<$statement>\n";
+ for (;;) {
+ push(@chunks, [ $condition, $statement ]);
+ last if (!($remain > 0 && $condition =~ /^.\s*(?:if|else|do)/));
+ ($statement, $condition, $linenr, $remain, $off, $level) =
+ ctx_statement_block($linenr, $remain, $off);
+ #print "C: c<$condition> s<$statement>\n";
+ }
+
+ return ($level, $linenr, @chunks);
+}
+
sub ctx_block_get {
my ($linenr, $remain, $outer, $open, $close, $off) = @_;
my $line;
return $res;
}
+my $av_preprocessor = 0;
+my $av_paren = 0;
+my @av_paren_type;
+
+sub annotate_reset {
+ $av_preprocessor = 0;
+ $av_paren = 0;
+ @av_paren_type = ();
+}
+
sub annotate_values {
my ($stream, $type) = @_;
my $res;
my $cur = $stream;
- my $debug = 0;
-
- print "$stream\n" if ($debug);
-
- ##my $type = 'N';
- my $pos = 0;
- my $preprocessor = 0;
- my $paren = 0;
- my @paren_type;
-
- # Include any user defined types we may have found as we went.
- my $type_match = "(?:$Type$Bare)";
+ print "$stream\n" if ($dbg_values > 1);
while (length($cur)) {
- print " <$type> " if ($debug);
+ print " <$type> " if ($dbg_values > 1);
if ($cur =~ /^(\s+)/o) {
- print "WS($1)\n" if ($debug);
- if ($1 =~ /\n/ && $preprocessor) {
- $preprocessor = 0;
+ print "WS($1)\n" if ($dbg_values > 1);
+ if ($1 =~ /\n/ && $av_preprocessor) {
+ $av_preprocessor = 0;
$type = 'N';
}
- } elsif ($cur =~ /^($type_match)/) {
- print "DECLARE($1)\n" if ($debug);
+ } elsif ($cur =~ /^($Type)/) {
+ print "DECLARE($1)\n" if ($dbg_values > 1);
$type = 'T';
} elsif ($cur =~ /^(#\s*define\s*$Ident)(\(?)/o) {
- print "DEFINE($1)\n" if ($debug);
- $preprocessor = 1;
- $paren_type[$paren] = 'N';
+ print "DEFINE($1)\n" if ($dbg_values > 1);
+ $av_preprocessor = 1;
+ $av_paren_type[$av_paren] = 'N';
- } elsif ($cur =~ /^(#\s*(?:ifdef|ifndef|if|else|endif))/o) {
- print "PRE($1)\n" if ($debug);
- $preprocessor = 1;
+ } elsif ($cur =~ /^(#\s*(?:ifdef|ifndef|if|else|elif|endif))/o) {
+ print "PRE($1)\n" if ($dbg_values > 1);
+ $av_preprocessor = 1;
$type = 'N';
} elsif ($cur =~ /^(\\\n)/o) {
- print "PRECONT($1)\n" if ($debug);
+ print "PRECONT($1)\n" if ($dbg_values > 1);
} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
- print "SIZEOF($1)\n" if ($debug);
+ print "SIZEOF($1)\n" if ($dbg_values > 1);
if (defined $2) {
- $paren_type[$paren] = 'V';
+ $av_paren_type[$av_paren] = 'V';
}
$type = 'N';
- } elsif ($cur =~ /^(if|while|typeof)\b/o) {
- print "COND($1)\n" if ($debug);
- $paren_type[$paren] = 'N';
+ } elsif ($cur =~ /^(if|while|typeof|__typeof__|for)\b/o) {
+ print "COND($1)\n" if ($dbg_values > 1);
+ $av_paren_type[$av_paren] = 'N';
$type = 'N';
} elsif ($cur =~/^(return|case|else)/o) {
- print "KEYWORD($1)\n" if ($debug);
+ print "KEYWORD($1)\n" if ($dbg_values > 1);
$type = 'N';
} elsif ($cur =~ /^(\()/o) {
- print "PAREN('$1')\n" if ($debug);
- $paren++;
+ print "PAREN('$1')\n" if ($dbg_values > 1);
+ $av_paren++;
$type = 'N';
} elsif ($cur =~ /^(\))/o) {
- $paren-- if ($paren > 0);
- if (defined $paren_type[$paren]) {
- $type = $paren_type[$paren];
- undef $paren_type[$paren];
- print "PAREN('$1') -> $type\n" if ($debug);
+ $av_paren-- if ($av_paren > 0);
+ if (defined $av_paren_type[$av_paren]) {
+ $type = $av_paren_type[$av_paren];
+ undef $av_paren_type[$av_paren];
+ print "PAREN('$1') -> $type\n"
+ if ($dbg_values > 1);
} else {
- print "PAREN('$1')\n" if ($debug);
+ print "PAREN('$1')\n" if ($dbg_values > 1);
}
} elsif ($cur =~ /^($Ident)\(/o) {
- print "FUNC($1)\n" if ($debug);
- $paren_type[$paren] = 'V';
+ print "FUNC($1)\n" if ($dbg_values > 1);
+ $av_paren_type[$av_paren] = 'V';
} elsif ($cur =~ /^($Ident|$Constant)/o) {
- print "IDENT($1)\n" if ($debug);
+ print "IDENT($1)\n" if ($dbg_values > 1);
$type = 'V';
} elsif ($cur =~ /^($Assignment)/o) {
- print "ASSIGN($1)\n" if ($debug);
+ print "ASSIGN($1)\n" if ($dbg_values > 1);
$type = 'N';
+ } elsif ($cur =~/^(;)/) {
+ print "END($1)\n" if ($dbg_values > 1);
+ $type = 'E';
+
} elsif ($cur =~ /^(;|{|}|\?|:|\[)/o) {
- print "END($1)\n" if ($debug);
+ print "CLOSE($1)\n" if ($dbg_values > 1);
$type = 'N';
} elsif ($cur =~ /^($Operators)/o) {
- print "OP($1)\n" if ($debug);
+ print "OP($1)\n" if ($dbg_values > 1);
if ($1 ne '++' && $1 ne '--') {
$type = 'N';
}
} elsif ($cur =~ /(^.)/o) {
- print "C($1)\n" if ($debug);
+ print "C($1)\n" if ($dbg_values > 1);
}
if (defined $1) {
$cur = substr($cur, length($1));
return $res;
}
+sub possible {
+ my ($possible, $line) = @_;
+
+ #print "CHECK<$possible>\n";
+ if ($possible !~ /^(?:$Storage|$Type|DEFINE_\S+)$/ &&
+ $possible ne 'goto' && $possible ne 'return' &&
+ $possible ne 'struct' && $possible ne 'enum' &&
+ $possible ne 'case' && $possible ne 'else' &&
+ $possible ne 'typedef') {
+ warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
+ push(@typeList, $possible);
+ build_types();
+ }
+}
+
my $prefix = '';
-my @report = ();
sub report {
- push(@report, $prefix . $_[0]);
+ my $line = $prefix . $_[0];
+
+ $line = (split('\n', $line))[0] . "\n" if ($terse);
+
+ push(our @report, $line);
}
sub report_dump {
- @report;
+ our @report;
}
sub ERROR {
report("ERROR: $_[0]\n");
sub process {
my $filename = shift;
- my @lines = @_;
my $linenr=0;
my $prevline="";
+ my $prevrawline="";
my $stashline="";
+ my $stashrawline="";
my $length;
my $indent;
my $signoff = 0;
my $is_patch = 0;
+ our @report = ();
our $cnt_lines = 0;
our $cnt_error = 0;
our $cnt_warn = 0;
my $realcnt = 0;
my $here = '';
my $in_comment = 0;
+ my $comment_edge = 0;
my $first_line = 0;
- my $prev_values = 'N';
+ my $prev_values = 'E';
- # Possible bare types.
- my @bare = ();
+ # suppression flags
+ my $suppress_ifbraces = 0;
+ # Pre-scan the patch sanitizing the lines.
# Pre-scan the patch looking for any __setup documentation.
+ #
my @setup_docs = ();
my $setup_docs = 0;
- foreach my $line (@lines) {
+ my $line;
+ foreach my $rawline (@rawlines) {
+ # Standardise the strings and chars within the input to
+ # simplify matching.
+ $line = sanitise_line($rawline);
+ push(@lines, $line);
+
+ ##print "==>$rawline\n";
+ ##print "-->$line\n";
+
if ($line=~/^\+\+\+\s+(\S+)/) {
$setup_docs = 0;
if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
foreach my $line (@lines) {
$linenr++;
- my $rawline = $line;
-
+ my $rawline = $rawlines[$linenr - 1];
#extract the filename as it passes
if ($line=~/^\+\+\+\s+(\S+)/) {
} else {
$realcnt=1+1;
}
- $prev_values = 'N';
+ annotate_reset();
+ $prev_values = 'E';
+
+ $suppress_ifbraces = $linenr - 1;
next;
}
$realline++;
$realcnt-- if ($realcnt != 0);
- # track any sort of multi-line comment. Obviously if
- # the added text or context do not include the whole
- # comment we will not see it. Such is life.
- #
+ # Guestimate if this is a continuing comment. Run
+ # the context looking for a comment "edge". If this
+ # edge is a close comment then we must be in a comment
+ # at context start.
+ if ($linenr == $first_line) {
+ my $edge;
+ for (my $ln = $first_line; $ln < ($linenr + $realcnt); $ln++) {
+ ($edge) = ($rawlines[$ln - 1] =~ m@(/\*|\*/)@);
+ last if (defined $edge);
+ }
+ if (defined $edge && $edge eq '*/') {
+ $in_comment = 1;
+ }
+ }
+
# Guestimate if this is a continuing comment. If this
# is the start of a diff block and this line starts
# ' *' then it is very likely a comment.
- if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
- $in_comment = 1;
- }
- if ($line =~ m@/\*@) {
+ if ($linenr == $first_line and $rawline =~ m@^.\s* \*(?:\s|$)@) {
$in_comment = 1;
}
- if ($line =~ m@\*/@) {
- $in_comment = 0;
+
+ # Find the last comment edge on _this_ line.
+ $comment_edge = 0;
+ while (($rawline =~ m@(/\*|\*/)@g)) {
+ if ($1 eq '/*') {
+ $in_comment = 1;
+ } else {
+ $in_comment = 0;
+ }
+ $comment_edge = 1;
}
# Measure the line length and indent.
- ($length, $indent) = line_stats($line);
+ ($length, $indent) = line_stats($rawline);
# Track the previous line.
($prevline, $stashline) = ($stashline, $line);
($previndent, $stashindent) = ($stashindent, $indent);
+ ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
+
+ #warn "ic<$in_comment> ce<$comment_edge> line<$line>\n";
} elsif ($realcnt == 1) {
$realcnt--;
$here = "#$realline: " if ($file);
$here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
- my $hereline = "$here\n$line\n";
- my $herecurr = "$here\n$line\n";
- my $hereprev = "$here\n$prevline\n$line\n";
+ my $hereline = "$here\n$rawline\n";
+ my $herecurr = "$here\n$rawline\n";
+ my $hereprev = "$here\n$prevrawline\n$rawline\n";
$prefix = "$filename:$realline: " if ($emacs && $file);
$prefix = "$filename:$linenr: " if ($emacs && !$file);
}
# Check for wrappage within a valid hunk of the file
- if ($realcnt != 0 && $line !~ m{^(?:\+|-| |$)}) {
+ if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
ERROR("patch seems to be corrupt (line wrapped?)\n" .
$herecurr) if (!$emitted_corrupt++);
}
# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
if (($realfile =~ /^$/ || $line =~ /^\+/) &&
- !($line =~ m/^(
+ !($rawline =~ m/^(
[\x09\x0A\x0D\x20-\x7E] # ASCII
| [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
| \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
| [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
| \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
)*$/x )) {
- ERROR("Invalid UTF-8\n" . $herecurr);
+ ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $herecurr);
}
#ignore lines being removed
#trailing whitespace
if ($line =~ /^\+.*\015/) {
- my $herevet = "$here\n" . cat_vet($line) . "\n";
+ my $herevet = "$here\n" . cat_vet($rawline) . "\n";
ERROR("DOS line endings\n" . $herevet);
- } elsif ($line =~ /^\+.*\S\s+$/ || $line =~ /^\+\s+$/) {
- my $herevet = "$here\n" . cat_vet($line) . "\n";
+ } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
+ my $herevet = "$here\n" . cat_vet($rawline) . "\n";
ERROR("trailing whitespace\n" . $herevet);
}
#80 column limit
- if ($line =~ /^\+/ && !($prevline=~/\/\*\*/) && $length > 80) {
+ if ($line =~ /^\+/ && !($prevrawline=~/\/\*\*/) && $length > 80) {
WARN("line over 80 characters\n" . $herecurr);
}
+# check for adding lines without a newline.
+ if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
+ WARN("adding a line without newline at end of file\n" . $herecurr);
+ }
+
# check we are in a valid source file *.[hc] if not then ignore this hunk
next if ($realfile !~ /\.[hc]$/);
# at the beginning of a line any tabs must come first and anything
# more than 8 must use tabs.
- if ($line=~/^\+\s* \t\s*\S/ or $line=~/^\+\s* \s*/) {
- my $herevet = "$here\n" . cat_vet($line) . "\n";
+ if ($rawline =~ /^\+\s* \t\s*\S/ ||
+ $rawline =~ /^\+\s* \s*/) {
+ my $herevet = "$here\n" . cat_vet($rawline) . "\n";
ERROR("use tabs not spaces\n" . $herevet);
}
-# Remove comments from the line before processing.
- my $comment_edge = ($line =~ s@/\*.*\*/@@g) +
- ($line =~ s@/\*.*@@) +
- ($line =~ s@^(.).*\*/@$1@);
+# check for RCS/CVS revision markers
+ if ($rawline =~ /\$(Revision|Log|Id)(?:\$|)/) {
+ WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
+ }
# The rest of our checks refer specifically to C style
# only apply those _outside_ comments. Only skip
# lines in the middle of comments.
next if (!$comment_edge && $in_comment);
-# Standardise the strings and chars within the input to simplify matching.
- $line = sanitise_line($line);
-
# Check for potential 'bare' types
- if ($realcnt &&
- $line !~ /^.\s*(?:$Storage\s+)?(?:$Inline\s+)?$Type\b/ &&
- $line !~ /$Ident:\s*$/ &&
- $line !~ /^.\s*$Ident\s*\(/ &&
- # definitions in global scope can only start with types
- ($line =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?($Ident)\b/ ||
- # declarations always start with types
- $line =~ /^.\s*(?:$Storage\s+)?($Ident)\b\s*\**\s*$Ident\s*(?:;|=)/) ||
- # any (foo ... *) is a pointer cast, and foo is a type
- $line =~ /\(($Ident)(?:\s+$Sparse)*\s*\*+\s*\)/) {
- my $possible = $1;
- if ($possible !~ /^(?:$Storage|$Type|DEFINE_\S+)$/ &&
- $possible ne 'goto' && $possible ne 'return' &&
- $possible ne 'struct' && $possible ne 'enum' &&
- $possible ne 'case' && $possible ne 'else' &&
- $possible ne 'typedef') {
- #print "POSSIBLE<$possible>\n";
- push(@bare, $possible);
- my $bare = join("|", @bare);
- $Bare = '|' . qr{
- \b(?:$bare)\b
- (?:\s*\*+\s*const|\s*\*+|(?:\s*\[\s*\])+)?
- (?:\s+$Sparse)*
- }x;
+ if ($realcnt) {
+ # Ignore goto labels.
+ if ($line =~ /$Ident:\*$/) {
+
+ # Ignore functions being called
+ } elsif ($line =~ /^.\s*$Ident\s*\(/) {
+
+ # definitions in global scope can only start with types
+ } elsif ($line =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b/) {
+ possible($1, $line);
+
+ # declarations always start with types
+ } elsif ($prev_values eq 'E' && $line =~ /^.\s*(?:$Storage\s+)?(?:const\s+)?($Ident)\b(:?\s+$Sparse)?\s*\**\s*$Ident\s*(?:;|=|,)/) {
+ possible($1);
+ }
+
+ # any (foo ... *) is a pointer cast, and foo is a type
+ while ($line =~ /\(($Ident)(?:\s+$Sparse)*\s*\*+\s*\)/g) {
+ possible($1, $line);
}
+
+ # Check for any sort of function declaration.
+ # int foo(something bar, other baz);
+ # void (*store_gdt)(x86_descr_ptr *);
+ if ($prev_values eq 'E' && $line =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/) {
+ my ($name_len) = length($1);
+ my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, $name_len);
+ my $ctx = join("\n", @ctx);
+
+ $ctx =~ s/\n.//;
+ substr($ctx, 0, $name_len + 1) = '';
+ $ctx =~ s/\)[^\)]*$//;
+ for my $arg (split(/\s*,\s*/, $ctx)) {
+ if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/ || $arg =~ /^($Ident)$/) {
+
+ possible($1, $line);
+ }
+ }
+ }
+
}
#
my $opline = $line; $opline =~ s/^./ /;
my $curr_values = annotate_values($opline . "\n", $prev_values);
$curr_values = $prev_values . $curr_values;
- #warn "--> $opline\n";
- #warn "--> $curr_values ($prev_values)\n";
+ if ($dbg_values) {
+ my $outline = $opline; $outline =~ s/\t/ /g;
+ warn "--> .$outline\n";
+ warn "--> $curr_values\n";
+ }
$prev_values = substr($curr_values, -1);
#ignore lines not being added
ERROR("malformed #include filename\n" .
$herecurr);
}
- # Sanitise this special form of string.
- $path = 'X' x length($path);
- $line =~ s{\<.*\>}{<$path>};
}
# no C99 // comments
# $clean = 0;
# }
+ if ($line =~ /\bLINUX_VERSION_CODE\b/) {
+ WARN("LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
+ }
+
# printk should use KERN_* levels. Note that follow on printk's on the
# same line do not need a level, so we use the current block context
# to try and find and validate the current printk. In summary the current
# function brace can't be on same line, except for #defines of do while,
# or if closed on same line
- if (($line=~/$Type\s*[A-Za-z\d_]+\(.*\).* {/) and
+ if (($line=~/$Type\s*[A-Za-z\d_]+\(.*\).*\s{/) and
!($line=~/\#define.*do\s{/) and !($line=~/}/)) {
ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
}
+# open braces for enum, union and struct go on the same line.
+ if ($line =~ /^.\s*{/ &&
+ $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
+ ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
+ }
+
# check for spaces between functions and their parentheses.
while ($line =~ /($Ident)\s+\(/g) {
- if ($1 !~ /^(?:if|for|while|switch|return|volatile|__volatile__|__attribute__|format|__extension__|Copyright|case)$/ &&
- $line !~ /$Type\s+\(/ && $line !~ /^.\#\s*define\b/) {
+ my $name = $1;
+ my $ctx = substr($line, 0, $-[1]);
+
+ # Ignore those directives where spaces _are_ permitted.
+ if ($name =~ /^(?:if|for|while|switch|return|volatile|__volatile__|__attribute__|format|__extension__|Copyright|case|__asm__)$/) {
+
+ # cpp #define statements have non-optional spaces, ie
+ # if there is a space between the name and the open
+ # parenthesis it is simply not a parameter group.
+ } elsif ($ctx =~ /^.\#\s*define\s*$/) {
+
+ # If this whole things ends with a type its most
+ # likely a typedef for a function.
+ } elsif ("$ctx$name" =~ /$Type$/) {
+
+ } else {
WARN("no space between function name and open parenthesis '('\n" . $herecurr);
}
}
<<=|>>=|<=|>=|==|!=|
\+=|-=|\*=|\/=|%=|\^=|\|=|&=|
=>|->|<<|>>|<|>|=|!|~|
- &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/
+ &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
}x;
- my @elements = split(/($ops|;)/, $opline);
+ my @elements = split(/($;+|$ops|;)/, $opline);
my $off = 0;
my $blank = copy_spacing($opline);
# print "UNARY: <$op_left$op_type $is_unary $a:$op:$c> <$ca:$op:$cc> <$unary_ctx>\n";
#}
+ # Ignore operators passed as parameters.
+ if ($op_type ne 'V' &&
+ $ca =~ /\s$/ && $cc =~ /^\s*,/) {
+
+ # Ignore comments
+ } elsif ($op =~ /^$;+$/) {
+
# ; should have either the end of line or a space or \ after it
- if ($op eq ';') {
+ } elsif ($op eq ';') {
if ($ctx !~ /.x[WEB]/ && $cc !~ /^\\/ &&
$cc !~ /^;/) {
ERROR("need space after that '$op' $at\n" . $hereptr);
if ($ctx !~ /[WOB]x[^W]/ && $ctx !~ /[^W]x[WOBE]/) {
ERROR("need space one side of that '$op' $at\n" . $hereptr);
}
- if ($ctx =~ /Wx./ && $cc =~ /^;/) {
+ if ($ctx =~ /WxB/ || ($ctx =~ /Wx./ && $cc =~ /^;/)) {
ERROR("no space before that '$op' $at\n" . $hereptr);
}
} elsif ($op eq '<<' or $op eq '>>' or
$op eq '&' or $op eq '^' or $op eq '|' or
$op eq '+' or $op eq '-' or
- $op eq '*' or $op eq '/')
+ $op eq '*' or $op eq '/' or
+ $op eq '%')
{
if ($ctx !~ /VxV|WxW|VxE|WxE|VxO/) {
ERROR("need consistent spacing around '$op' $at\n" .
$line !~ /for\s*\(\s+;/) {
ERROR("no space after that open parenthesis '('\n" . $herecurr);
}
- if ($line =~ /\s\)/ && $line !~ /^.\s*\)/ &&
+ if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
$line !~ /for\s*\(.*;\s+\)/) {
ERROR("no space before that close parenthesis ')'\n" . $herecurr);
}
}
# Check for illegal assignment in if conditional.
- if ($line=~/\bif\s*\(.*[^<>!=]=[^=]/) {
- #next if ($line=~/\".*\Q$op\E.*\"/ or $line=~/\'\Q$op\E\'/);
- ERROR("do not use assignment in if condition\n" . $herecurr);
+ if ($line =~ /\bif\s*\(/) {
+ my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
+
+ if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/) {
+ ERROR("do not use assignment in if condition\n" . $herecurr);
+ }
+
+ # Find out what is on the end of the line after the
+ # conditional.
+ substr($s, 0, length($c)) = '';
+ $s =~ s/\n.*//g;
+ $s =~ s/$;//g; # Remove any comments
+ if (length($c) && $s !~ /^\s*({|;|)\s*\\*\s*$/) {
+ ERROR("trailing statements should be on next line\n" . $herecurr);
+ }
+ }
+
+# Check for bitwise tests written as boolean
+ if ($line =~ /
+ (?:
+ (?:\[|\(|\&\&|\|\|)
+ \s*0[xX][0-9]+\s*
+ (?:\&\&|\|\|)
+ |
+ (?:\&\&|\|\|)
+ \s*0[xX][0-9]+\s*
+ (?:\&\&|\|\||\)|\])
+ )/x)
+ {
+ WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
+ }
+
+# if and else should not have general statements after it
+ if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
+ my $s = $1;
+ $s =~ s/$;//g; # Remove any comments
+ if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
+ ERROR("trailing statements should be on next line\n" . $herecurr);
+ }
}
# Check for }<nl>else {, these must be at the same
ERROR("else should follow close brace '}'\n" . $hereprev);
}
+ if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
+ $previndent == $indent) {
+ my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
+
+ # Find out what is on the end of the line after the
+ # conditional.
+ substr($s, 0, length($c)) = '';
+ $s =~ s/\n.*//g;
+
+ if ($s =~ /^\s*;/) {
+ ERROR("while should follow close brace '}'\n" . $hereprev);
+ }
+ }
+
#studly caps, commented out until figure out how to distinguish between use of existing and adding new
# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
# print "No studly caps, use _\n";
}
}
-# if and else should not have general statements after it
- if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/ &&
- $1 !~ /^\s*(?:\sif|{|\\|$)/) {
- ERROR("trailing statements should be on next line\n" . $herecurr);
- }
-
# multi-statement macros should be enclosed in a do while loop, grab the
# first statement and ensure its the whole macro if its not enclosed
# in a known goot container
$off = length($1);
$ln--;
$cnt++;
+ while ($lines[$ln - 1] =~ /^-/) {
+ $ln--;
+ $cnt++;
+ }
}
my @ctx = ctx_statement($ln, $cnt, $off);
my $ctx_ln = $ln + $#ctx + 1;
}
# check for redundant bracing round if etc
- if ($line =~ /\b(if|while|for|else)\b/) {
+ if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
+ my ($level, $endln, @chunks) =
+ ctx_statement_full($linenr, $realcnt, 0);
+ #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
+ if ($#chunks > 1 && $level == 0) {
+ my $allowed = 0;
+ my $seen = 0;
+ for my $chunk (@chunks) {
+ my ($cond, $block) = @{$chunk};
+
+ substr($block, 0, length($cond)) = '';
+
+ $seen++ if ($block =~ /^\s*{/);
+
+ $block =~ s/(^|\n)./$1/g;
+ $block =~ s/^\s*{//;
+ $block =~ s/}\s*$//;
+ $block =~ s/^\s*//;
+ $block =~ s/\s*$//;
+
+ my @lines = ($block =~ /\n/g);
+ my @statements = ($block =~ /;/g);
+
+ #print "cond<$cond> block<$block> lines<" . scalar(@lines) . "> statements<" . scalar(@statements) . "> seen<$seen> allowed<$allowed>\n";
+ if (scalar(@lines) != 0) {
+ $allowed = 1;
+ }
+ if ($block =~/\b(?:if|for|while)\b/) {
+ $allowed = 1;
+ }
+ if (scalar(@statements) > 1) {
+ $allowed = 1;
+ }
+ }
+ if ($seen && !$allowed) {
+ WARN("braces {} are not necessary for any arm of this statement\n" . $herecurr);
+ $suppress_ifbraces = $endln;
+ }
+ }
+ }
+ if ($linenr > $suppress_ifbraces &&
+ $line =~ /\b(if|while|for|else)\b/) {
# Locate the end of the opening statement.
my @control = ctx_statement($linenr, $realcnt, 0);
my $nr = $linenr + (scalar(@control) - 1);
if ($lines[$nr - 1] =~ /{\s*$/) {
my ($lvl, @block) = ctx_block_level($nr, $cnt);
- my $stmt = join(' ', @block);
- $stmt =~ s/(^[^{]*){//;
+ my $stmt = join("\n", @block);
+ # Drop the diff line leader.
+ $stmt =~ s/\n./\n/g;
+ # Drop the code outside the block.
+ $stmt =~ s/(^[^{]*){\s*//;
my $before = $1;
- $stmt =~ s/}([^}]*$)//;
+ $stmt =~ s/\s*}([^}]*$)//;
my $after = $1;
#print "block<" . join(' ', @block) . "><" . scalar(@block) . ">\n";
- #print "stmt<$stmt>\n\n";
-
- # Count the ;'s if there is fewer than two
- # then there can only be one statement,
- # if there is a brace inside we cannot
- # trivially detect if its one statement.
- # Also nested if's often require braces to
- # disambiguate the else binding so shhh there.
- my @semi = ($stmt =~ /;/g);
- push(@semi, "/**/") if ($stmt =~ m@/\*@);
- ##print "semi<" . scalar(@semi) . ">\n";
- if ($lvl == 0 && scalar(@semi) < 2 &&
+ #print "before<$before> stmt<$stmt> after<$after>\n\n";
+
+ # Count the newlines, if there is only one
+ # then the block should not have {}'s.
+ my @lines = ($stmt =~ /\n/g);
+ my @statements = ($stmt =~ /;/g);
+ #print "lines<" . scalar(@lines) . ">\n";
+ #print "statements<" . scalar(@statements) . ">\n";
+ if ($lvl == 0 && scalar(@lines) == 0 &&
+ scalar(@statements) < 2 &&
$stmt !~ /{/ && $stmt !~ /\bif\b/ &&
$before !~ /}/ && $after !~ /{/) {
my $herectx = "$here\n" . join("\n", @control, @block[1 .. $#block]) . "\n";
ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
}
+# Check for __inline__ and __inline, prefer inline
+ if ($line =~ /\b(__inline__|__inline)\b/) {
+ WARN("plain inline is preferred over $1\n" . $herecurr);
+ }
+
# check for new externs in .c files.
if ($line =~ /^.\s*extern\s/ && ($realfile =~ /\.c$/)) {
WARN("externs should be avoided in .c files\n" . $herecurr);
if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
}
+
+# check for gcc specific __FUNCTION__
+ if ($line =~ /__FUNCTION__/) {
+ WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
+ }
}
- if ($chk_patch && !$is_patch) {
+ # If we have no input at all, then there is nothing to report on
+ # so just keep quiet.
+ if ($#rawlines == -1) {
+ exit(0);
+ }
+
+ # In mailback mode only produce a report in the negative, for
+ # things that appear to be patches.
+ if ($mailback && ($clean == 1 || !$is_patch)) {
+ exit(0);
+ }
+
+ # This is not a patch, and we are are in 'no-patch' mode so
+ # just keep quiet.
+ if (!$chk_patch && !$is_patch) {
+ exit(0);
+ }
+
+ if (!$is_patch) {
ERROR("Does not appear to be a unified-diff format patch\n");
}
if ($is_patch && $chk_signoff && $signoff == 0) {
ERROR("Missing Signed-off-by: line(s)\n");
}
- if ($clean == 0 && ($chk_patch || $is_patch)) {
- print report_dump();
- if ($quiet < 2) {
- print "total: $cnt_error errors, $cnt_warn warnings, " .
- (($check)? "$cnt_chk checks, " : "") .
- "$cnt_lines lines checked\n";
- }
+ print report_dump();
+ if ($summary && !($clean == 1 && $quiet == 1)) {
+ print "$filename " if ($summary_file);
+ print "total: $cnt_error errors, $cnt_warn warnings, " .
+ (($check)? "$cnt_chk checks, " : "") .
+ "$cnt_lines lines checked\n";
+ print "\n" if ($quiet == 0);
}
+
if ($clean == 1 && $quiet == 0) {
- print "Your patch has no obvious style problems and is ready for submission.\n"
+ print "$vname has no obvious style problems and is ready for submission.\n"
}
if ($clean == 0 && $quiet == 0) {
- print "Your patch has style problems, please review. If any of these errors\n";
+ print "$vname has style problems, please review. If any of these errors\n";
print "are false positives report them to the maintainer, see\n";
print "CHECKPATCH in MAINTAINERS.\n";
}
+ print <<EOL if ($file == 1 && $quiet == 0);
+
+WARNING: Using --file mode. Please do not send patches to linux-kernel
+that change whole existing files if you did not significantly change most
+of the the file for other reasons anyways or just wrote the file newly
+from scratch. Pure code style patches have a significant cost in a
+quickly changing code base like Linux because they cause rejects
+with other changes.
+EOL
+
return $clean;
}
git.samba.org / sfrench / cifs-2.6.git / blobdiff