2 # (c) 2001, Dave Jones. (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-2010 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);
37 Usage
: $P [OPTION
]... [FILE
]...
42 --no-tree run without a kernel tree
43 --no-signoff
do not check
for 'Signed-off-by' line
44 --patch treat FILE as patchfile
(default)
45 --emacs emacs compile window format
46 --terse one line per report
47 -f
, --file treat FILE as regular source file
48 --subjective
, --strict enable more subjective tests
49 --root
=PATH PATH to the kernel tree root
50 --no-summary suppress the per-file summary
51 --mailback only produce a report
in case of warnings
/errors
52 --summary-file include the filename
in summary
53 --debug KEY
=[0|1] turn on
/off debugging of KEY
, where KEY
is one of
54 'values', 'possible', 'type', and 'attr' (default
56 --test-only
=WORD report only warnings
/errors containing WORD
58 -h
, --help
, --version display this help
and exit
60 When FILE
is - read standard input
.
67 'q|quiet+' => \
$quiet,
69 'signoff!' => \
$chk_signoff,
70 'patch!' => \
$chk_patch,
74 'subjective!' => \
$check,
77 'summary!' => \
$summary,
78 'mailback!' => \
$mailback,
79 'summary-file!' => \
$summary_file,
82 'test-only=s' => \
$tst_only,
92 print "$P: no input files\n";
101 my $dbg_adv_checking = 0;
103 for my $key (keys %debug) {
105 eval "\${dbg_$key} = '$debug{$key}';";
109 my $rpt_cleaners = 0;
118 if (!top_of_kernel_tree
($root)) {
119 die "$P: $root: --root does not point at a valid tree\n";
122 if (top_of_kernel_tree
('.')) {
124 } elsif ($0 =~ m
@(.*)/scripts/[^/]*$@ &&
125 top_of_kernel_tree
($1)) {
130 if (!defined $root) {
131 print "Must be run from the top-level dir. of a kernel tree\n";
136 my $emitted_corrupt = 0;
139 [A-Za-z_
][A-Za-z\d_
]*
140 (?
:\s
*\#\#\s
*[A-Za-z_
][A-Za-z\d_
]*)*
142 our $Storage = qr{extern|static|asmlinkage};
147 # Notes to $Attribute:
152 QEMU_WARN_UNUSED_RESULT
|
159 our $Inline = qr{inline};
160 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
161 our $Lval = qr{$Ident(?:$Member)*};
163 our $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
164 our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
165 our $Compare = qr{<=|>=|==|!=|<|>};
169 &&|\
|\
||,|\
^|\
+\
+|--|&|\
||\
+|-|\
*|\
/|%
177 [\x09\x0A\x0D\x20-\x7E] # ASCII
178 | [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
179 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
180 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
181 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
182 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
183 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
184 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
187 # There are still some false positives, but this catches most
189 our $typeTypedefs = qr{(?x
:
190 [A-Z
][A-Z\d_
]*[a-z
][A-Za-z\d_
]* # camelcase
191 | [A-Z
][A-Z\d_
]*AIOCB
# all uppercase
192 | [A-Z
][A-Z\d_
]*CPU
# all uppercase
193 | QEMUBH
# all uppercase
198 qr{(?:unsigned\s+)?char},
199 qr{(?:unsigned\s+)?short},
200 qr{(?:unsigned\s+)?int},
201 qr{(?:unsigned\s+)?long},
202 qr{(?:unsigned\s+)?long\s+int},
203 qr{(?:unsigned\s+)?long\s+long},
204 qr{(?:unsigned\s+)?long\s+long\s+int},
213 qr{${Ident}_handler
},
214 qr{${Ident}_handler_fn
},
215 qr{target_(?:u)?long},
218 # This can be modified by sub possible. Since it can be empty, be careful
219 # about regexes that always match, because they can cause infinite loops.
220 our @modifierList = (
224 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
225 if (@modifierList > 0) {
226 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
227 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
229 $Modifier = qr{(?:$Attribute|$Sparse)};
232 (?
:$Modifier\s+|const\s
+)*
234 (?
:typeof
|__typeof__
)\s
*\
(\s
*\
**\s
*$Ident\s*\)|
238 (?
:\s
+$Modifier|\s
+const
)*
242 (?
:[\s\
*]+\s
*const
|[\s\
*]+|(?
:\s
*\
[\s
*\
])+)?
243 (?
:\s
+$Inline|\s
+$Modifier)*
245 $Declare = qr{(?:$Storage\s+)?$Type};
249 $chk_signoff = 0 if ($file);
254 for my $filename (@ARGV) {
257 open($FILE, '-|', "diff -u /dev/null $filename") ||
258 die "$P: $filename: diff failed - $!\n";
259 } elsif ($filename eq '-') {
260 open($FILE, '<&STDIN');
262 open($FILE, '<', "$filename") ||
263 die "$P: $filename: open failed - $!\n";
265 if ($filename eq '-') {
266 $vname = 'Your patch';
275 if (!process
($filename)) {
284 sub top_of_kernel_tree
{
288 "COPYING", "MAINTAINERS", "Makefile",
289 "README", "docs", "VERSION",
293 foreach my $check (@tree_check) {
294 if (! -e
$root . '/' . $check) {
306 for my $c (split(//, $str)) {
310 for (; ($n % 8) != 0; $n++) {
322 (my $res = shift) =~ tr/\t/ /c;
329 # Drop the diff line leader and expand tabs
331 $line = expand_tabs
($line);
333 # Pick the indent from the front of the line.
334 my ($white) = ($line =~ /^(\s*)/);
336 return (length($line), length($white));
339 my $sanitise_quote = '';
341 sub sanitise_line_reset
{
342 my ($in_comment) = @_;
345 $sanitise_quote = '*/';
347 $sanitise_quote = '';
360 # Always copy over the diff marker.
361 $res = substr($line, 0, 1);
363 for ($off = 1; $off < length($line); $off++) {
364 $c = substr($line, $off, 1);
366 # Comments we are wacking completely including the begin
367 # and end, all to $;.
368 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
369 $sanitise_quote = '*/';
371 substr($res, $off, 2, "$;$;");
375 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
376 $sanitise_quote = '';
377 substr($res, $off, 2, "$;$;");
381 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
382 $sanitise_quote = '//';
384 substr($res, $off, 2, $sanitise_quote);
389 # A \ in a string means ignore the next character.
390 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
392 substr($res, $off, 2, 'XX');
397 if ($c eq "'" || $c eq '"') {
398 if ($sanitise_quote eq '') {
399 $sanitise_quote = $c;
401 substr($res, $off, 1, $c);
403 } elsif ($sanitise_quote eq $c) {
404 $sanitise_quote = '';
408 #print "c<$c> SQ<$sanitise_quote>\n";
409 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
410 substr($res, $off, 1, $;);
411 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
412 substr($res, $off, 1, $;);
413 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
414 substr($res, $off, 1, 'X');
416 substr($res, $off, 1, $c);
420 if ($sanitise_quote eq '//') {
421 $sanitise_quote = '';
424 # The pathname on a #include may be surrounded by '<' and '>'.
425 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
426 my $clean = 'X' x
length($1);
427 $res =~ s
@\<.*\
>@<$clean>@;
429 # The whole of a #error is a string.
430 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
431 my $clean = 'X' x
length($1);
432 $res =~ s
@(\#\s
*(?
:error
|warning
)\s
+).*@$1$clean@;
438 sub ctx_statement_block
{
439 my ($linenr, $remain, $off) = @_;
440 my $line = $linenr - 1;
457 @stack = (['', 0]) if ($#stack == -1);
459 #warn "CSB: blk<$blk> remain<$remain>\n";
460 # If we are about to drop off the end, pull in more
463 for (; $remain > 0; $line++) {
464 last if (!defined $lines[$line]);
465 next if ($lines[$line] =~ /^-/);
468 $blk .= $lines[$line] . "\n";
473 # Bail if there is no further context.
474 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
480 $c = substr($blk, $off, 1);
481 $remainder = substr($blk, $off);
483 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
485 # Handle nested #if/#else.
486 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
487 push(@stack, [ $type, $level ]);
488 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
489 ($type, $level) = @{$stack[$#stack - 1]};
490 } elsif ($remainder =~ /^#\s*endif\b/) {
491 ($type, $level) = @{pop(@stack)};
494 # Statement ends at the ';' or a close '}' at the
496 if ($level == 0 && $c eq ';') {
500 # An else is really a conditional as long as its not else if
501 if ($level == 0 && $coff_set == 0 &&
502 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
503 $remainder =~ /^(else)(?:\s|{)/ &&
504 $remainder !~ /^else\s+if\b/) {
505 $coff = $off + length($1) - 1;
507 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
508 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
511 if (($type eq '' || $type eq '(') && $c eq '(') {
515 if ($type eq '(' && $c eq ')') {
517 $type = ($level != 0)?
'(' : '';
519 if ($level == 0 && $coff < $soff) {
522 #warn "CSB: mark coff<$coff>\n";
525 if (($type eq '' || $type eq '{') && $c eq '{') {
529 if ($type eq '{' && $c eq '}') {
531 $type = ($level != 0)?
'{' : '';
534 if (substr($blk, $off + 1, 1) eq ';') {
542 # We are truly at the end, so shuffle to the next line.
549 my $statement = substr($blk, $soff, $off - $soff + 1);
550 my $condition = substr($blk, $soff, $coff - $soff + 1);
552 #warn "STATEMENT<$statement>\n";
553 #warn "CONDITION<$condition>\n";
555 #print "coff<$coff> soff<$off> loff<$loff>\n";
557 return ($statement, $condition,
558 $line, $remain + 1, $off - $loff + 1, $level);
561 sub statement_lines
{
564 # Strip the diff line prefixes and rip blank lines at start and end.
565 $stmt =~ s/(^|\n)./$1/g;
569 my @stmt_lines = ($stmt =~ /\n/g);
571 return $#stmt_lines + 2;
574 sub statement_rawlines
{
577 my @stmt_lines = ($stmt =~ /\n/g);
579 return $#stmt_lines + 2;
582 sub statement_block_size
{
585 $stmt =~ s/(^|\n)./$1/g;
591 my @stmt_lines = ($stmt =~ /\n/g);
592 my @stmt_statements = ($stmt =~ /;/g);
594 my $stmt_lines = $#stmt_lines + 2;
595 my $stmt_statements = $#stmt_statements + 1;
597 if ($stmt_lines > $stmt_statements) {
600 return $stmt_statements;
604 sub ctx_statement_full
{
605 my ($linenr, $remain, $off) = @_;
606 my ($statement, $condition, $level);
610 # Grab the first conditional/block pair.
611 ($statement, $condition, $linenr, $remain, $off, $level) =
612 ctx_statement_block
($linenr, $remain, $off);
613 #print "F: c<$condition> s<$statement> remain<$remain>\n";
614 push(@chunks, [ $condition, $statement ]);
615 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
616 return ($level, $linenr, @chunks);
619 # Pull in the following conditional/block pairs and see if they
620 # could continue the statement.
622 ($statement, $condition, $linenr, $remain, $off, $level) =
623 ctx_statement_block
($linenr, $remain, $off);
624 #print "C: c<$condition> s<$statement> remain<$remain>\n";
625 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
627 push(@chunks, [ $condition, $statement ]);
630 return ($level, $linenr, @chunks);
634 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
636 my $start = $linenr - 1;
643 my @stack = ($level);
644 for ($line = $start; $remain > 0; $line++) {
645 next if ($rawlines[$line] =~ /^-/);
648 $blk .= $rawlines[$line];
650 # Handle nested #if/#else.
651 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
652 push(@stack, $level);
653 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
654 $level = $stack[$#stack - 1];
655 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
656 $level = pop(@stack);
659 foreach my $c (split(//, $lines[$line])) {
660 ##print "C<$c>L<$level><$open$close>O<$off>\n";
666 if ($c eq $close && $level > 0) {
668 last if ($level == 0);
669 } elsif ($c eq $open) {
674 if (!$outer || $level <= 1) {
675 push(@res, $rawlines[$line]);
678 last if ($level == 0);
681 return ($level, @res);
683 sub ctx_block_outer
{
684 my ($linenr, $remain) = @_;
686 my ($level, @r) = ctx_block_get
($linenr, $remain, 1, '{', '}', 0);
690 my ($linenr, $remain) = @_;
692 my ($level, @r) = ctx_block_get
($linenr, $remain, 0, '{', '}', 0);
696 my ($linenr, $remain, $off) = @_;
698 my ($level, @r) = ctx_block_get
($linenr, $remain, 0, '(', ')', $off);
701 sub ctx_block_level
{
702 my ($linenr, $remain) = @_;
704 return ctx_block_get
($linenr, $remain, 0, '{', '}', 0);
706 sub ctx_statement_level
{
707 my ($linenr, $remain, $off) = @_;
709 return ctx_block_get
($linenr, $remain, 0, '(', ')', $off);
712 sub ctx_locate_comment
{
713 my ($first_line, $end_line) = @_;
715 # Catch a comment on the end of the line itself.
716 my ($current_comment) = ($rawlines[$end_line - 1] =~ m
@.*(/\*.*\*/)\s
*(?
:\\\s
*)?
$@);
717 return $current_comment if (defined $current_comment);
719 # Look through the context and try and figure out if there is a
722 $current_comment = '';
723 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
724 my $line = $rawlines[$linenr - 1];
726 if ($linenr == $first_line and $line =~ m
@^.\s
*\
*@) {
729 if ($line =~ m
@/\*@) {
732 if (!$in_comment && $current_comment ne '') {
733 $current_comment = '';
735 $current_comment .= $line . "\n" if ($in_comment);
736 if ($line =~ m
@\*/@) {
741 chomp($current_comment);
742 return($current_comment);
744 sub ctx_has_comment
{
745 my ($first_line, $end_line) = @_;
746 my $cmt = ctx_locate_comment
($first_line, $end_line);
748 ##print "LINE: $rawlines[$end_line - 1 ]\n";
749 ##print "CMMT: $cmt\n";
755 my ($linenr, $cnt) = @_;
757 my $offset = $linenr - 1;
762 $line = $rawlines[$offset++];
763 next if (defined($line) && $line =~ /^-/);
775 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
778 $coded = sprintf("^%c", unpack('C', $2) + 64);
787 my $av_preprocessor = 0;
793 $av_preprocessor = 0;
795 @av_paren_type = ('E');
796 $av_pend_colon = 'O';
799 sub annotate_values
{
800 my ($stream, $type) = @_;
803 my $var = '_' x
length($stream);
806 print "$stream\n" if ($dbg_values > 1);
808 while (length($cur)) {
809 @av_paren_type = ('E') if ($#av_paren_type < 0);
810 print " <" . join('', @av_paren_type) .
811 "> <$type> <$av_pending>" if ($dbg_values > 1);
812 if ($cur =~ /^(\s+)/o) {
813 print "WS($1)\n" if ($dbg_values > 1);
814 if ($1 =~ /\n/ && $av_preprocessor) {
815 $type = pop(@av_paren_type);
816 $av_preprocessor = 0;
819 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
820 print "CAST($1)\n" if ($dbg_values > 1);
821 push(@av_paren_type, $type);
824 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
825 print "DECLARE($1)\n" if ($dbg_values > 1);
828 } elsif ($cur =~ /^($Modifier)\s*/) {
829 print "MODIFIER($1)\n" if ($dbg_values > 1);
832 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
833 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
834 $av_preprocessor = 1;
835 push(@av_paren_type, $type);
841 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
842 print "UNDEF($1)\n" if ($dbg_values > 1);
843 $av_preprocessor = 1;
844 push(@av_paren_type, $type);
846 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
847 print "PRE_START($1)\n" if ($dbg_values > 1);
848 $av_preprocessor = 1;
850 push(@av_paren_type, $type);
851 push(@av_paren_type, $type);
854 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
855 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
856 $av_preprocessor = 1;
858 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
862 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
863 print "PRE_END($1)\n" if ($dbg_values > 1);
865 $av_preprocessor = 1;
867 # Assume all arms of the conditional end as this
868 # one does, and continue as if the #endif was not here.
870 push(@av_paren_type, $type);
873 } elsif ($cur =~ /^(\\\n)/o) {
874 print "PRECONT($1)\n" if ($dbg_values > 1);
876 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
877 print "ATTR($1)\n" if ($dbg_values > 1);
881 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
882 print "SIZEOF($1)\n" if ($dbg_values > 1);
888 } elsif ($cur =~ /^(if|while|for)\b/o) {
889 print "COND($1)\n" if ($dbg_values > 1);
893 } elsif ($cur =~/^(case)/o) {
894 print "CASE($1)\n" if ($dbg_values > 1);
895 $av_pend_colon = 'C';
898 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
899 print "KEYWORD($1)\n" if ($dbg_values > 1);
902 } elsif ($cur =~ /^(\()/o) {
903 print "PAREN('$1')\n" if ($dbg_values > 1);
904 push(@av_paren_type, $av_pending);
908 } elsif ($cur =~ /^(\))/o) {
909 my $new_type = pop(@av_paren_type);
910 if ($new_type ne '_') {
912 print "PAREN('$1') -> $type\n"
913 if ($dbg_values > 1);
915 print "PAREN('$1')\n" if ($dbg_values > 1);
918 } elsif ($cur =~ /^($Ident)\s*\(/o) {
919 print "FUNC($1)\n" if ($dbg_values > 1);
923 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
924 if (defined $2 && $type eq 'C' || $type eq 'T') {
925 $av_pend_colon = 'B';
926 } elsif ($type eq 'E') {
927 $av_pend_colon = 'L';
929 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
932 } elsif ($cur =~ /^($Ident|$Constant)/o) {
933 print "IDENT($1)\n" if ($dbg_values > 1);
936 } elsif ($cur =~ /^($Assignment)/o) {
937 print "ASSIGN($1)\n" if ($dbg_values > 1);
940 } elsif ($cur =~/^(;|{|})/) {
941 print "END($1)\n" if ($dbg_values > 1);
943 $av_pend_colon = 'O';
945 } elsif ($cur =~/^(,)/) {
946 print "COMMA($1)\n" if ($dbg_values > 1);
949 } elsif ($cur =~ /^(\?)/o) {
950 print "QUESTION($1)\n" if ($dbg_values > 1);
953 } elsif ($cur =~ /^(:)/o) {
954 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
956 substr($var, length($res), 1, $av_pend_colon);
957 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
962 $av_pend_colon = 'O';
964 } elsif ($cur =~ /^(\[)/o) {
965 print "CLOSE($1)\n" if ($dbg_values > 1);
968 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
971 print "OPV($1)\n" if ($dbg_values > 1);
978 substr($var, length($res), 1, $variant);
981 } elsif ($cur =~ /^($Operators)/o) {
982 print "OP($1)\n" if ($dbg_values > 1);
983 if ($1 ne '++' && $1 ne '--') {
987 } elsif ($cur =~ /(^.)/o) {
988 print "C($1)\n" if ($dbg_values > 1);
991 $cur = substr($cur, length($1));
992 $res .= $type x
length($1);
1000 my ($possible, $line) = @_;
1001 my $notPermitted = qr{(?
:
1018 ^(?
:typedef
|struct
|enum
)\b
1020 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1021 if ($possible !~ $notPermitted) {
1022 # Check for modifiers.
1023 $possible =~ s/\s*$Storage\s*//g;
1024 $possible =~ s/\s*$Sparse\s*//g;
1025 if ($possible =~ /^\s*$/) {
1027 } elsif ($possible =~ /\s/) {
1028 $possible =~ s/\s*$Type\s*//g;
1029 for my $modifier (split(' ', $possible)) {
1030 if ($modifier !~ $notPermitted) {
1031 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1032 push(@modifierList, $modifier);
1037 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1038 push(@typeList, $possible);
1042 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1049 if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
1052 my $line = $prefix . $_[0];
1054 $line = (split('\n', $line))[0] . "\n" if ($terse);
1056 push(our @report, $line);
1064 if (report
("ERROR: $_[0]\n")) {
1070 if (report
("WARNING: $_[0]\n")) {
1076 if ($check && report
("CHECK: $_[0]\n")) {
1083 my $filename = shift;
1089 my $stashrawline="";
1106 # Trace the real file/line as we go.
1112 my $comment_edge = 0;
1116 my $prev_values = 'E';
1119 my %suppress_ifbraces;
1120 my %suppress_whiletrailers;
1121 my %suppress_export;
1123 # Pre-scan the patch sanitizing the lines.
1125 sanitise_line_reset
();
1127 foreach my $rawline (@rawlines) {
1131 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1140 # Guestimate if this is a continuing comment. Run
1141 # the context looking for a comment "edge". If this
1142 # edge is a close comment then we must be in a comment
1146 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1147 next if (defined $rawlines[$ln - 1] &&
1148 $rawlines[$ln - 1] =~ /^-/);
1150 #print "RAW<$rawlines[$ln - 1]>\n";
1151 last if (!defined $rawlines[$ln - 1]);
1152 if ($rawlines[$ln - 1] =~ m
@(/\*|\*/)@ &&
1153 $rawlines[$ln - 1] !~ m
@"[^"]*(?
:/\*|\*/)[^"]*"@) {
1158 if (defined $edge && $edge eq '*/') {
1162 # Guestimate if this is a continuing comment. If this
1163 # is the start of a diff block and this line starts
1164 # ' *' then it is very likely a comment.
1165 if (!defined $edge &&
1166 $rawlines[$linenr] =~ m
@^.\s
*(?
:\
*\
*+| \
*)(?
:\s
|$)@)
1171 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1172 sanitise_line_reset
($in_comment);
1174 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1175 # Standardise the strings and chars within the input to
1176 # simplify matching -- only bother with positive lines.
1177 $line = sanitise_line
($rawline);
1179 push(@lines, $line);
1182 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1187 #print "==>$rawline\n";
1188 #print "-->$line\n";
1195 foreach my $line (@lines) {
1198 my $rawline = $rawlines[$linenr - 1];
1200 #extract the line range in the file after the patch is applied
1201 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1203 $first_line = $linenr + 1;
1213 %suppress_ifbraces = ();
1214 %suppress_whiletrailers = ();
1215 %suppress_export = ();
1218 # track the line number as we move through the hunk, note that
1219 # new versions of GNU diff omit the leading space on completely
1220 # blank context lines so we need to count that too.
1221 } elsif ($line =~ /^( |\+|$)/) {
1223 $realcnt-- if ($realcnt != 0);
1225 # Measure the line length and indent.
1226 ($length, $indent) = line_stats
($rawline);
1228 # Track the previous line.
1229 ($prevline, $stashline) = ($stashline, $line);
1230 ($previndent, $stashindent) = ($stashindent, $indent);
1231 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1233 #warn "line<$line>\n";
1235 } elsif ($realcnt == 1) {
1239 my $hunk_line = ($realcnt != 0);
1241 #make up the handle for any error we report on this line
1242 $prefix = "$filename:$realline: " if ($emacs && $file);
1243 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1245 $here = "#$linenr: " if (!$file);
1246 $here = "#$realline: " if ($file);
1248 # extract the filename as it passes
1249 if ($line =~ /^diff --git.*?(\S+)$/) {
1251 $realfile =~ s
@^([^/]*)/@@;
1253 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
1255 $realfile =~ s
@^([^/]*)/@@;
1258 if (!$file && $tree && $p1_prefix ne '' &&
1259 -e
"$root/$p1_prefix") {
1260 WARN
("patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1266 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
1268 my $hereline = "$here\n$rawline\n";
1269 my $herecurr = "$here\n$rawline\n";
1270 my $hereprev = "$here\n$prevrawline\n$rawline\n";
1272 $cnt_lines++ if ($realcnt != 0);
1274 # Check for incorrect file permissions
1275 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1276 my $permhere = $here . "FILE: $realfile\n";
1277 if ($realfile =~ /(\bMakefile(?:\.objs)?|\.c|\.cc|\.cpp|\.h|\.mak|\.[sS])$/) {
1278 ERROR
("do not set execute permissions for source files\n" . $permhere);
1282 # Accept git diff extended headers as valid patches
1283 if ($line =~ /^(?:rename|copy) (?:from|to) [\w\/\
.\
-]+\s
*$/) {
1287 #check the patch for a signoff:
1288 if ($line =~ /^\s*signed-off-by:/i) {
1289 # This is a signoff, if ugly, so do not double report.
1291 if (!($line =~ /^\s*Signed-off-by:/)) {
1292 WARN
("Signed-off-by: is the preferred form\n" .
1295 if ($line =~ /^\s*signed-off-by:\S/i) {
1296 WARN
("space required after Signed-off-by:\n" .
1301 # Check for wrappage within a valid hunk of the file
1302 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1303 ERROR
("patch seems to be corrupt (line wrapped?)\n" .
1304 $herecurr) if (!$emitted_corrupt++);
1307 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1308 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1309 $rawline !~ m/^$UTF8*$/) {
1310 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1312 my $blank = copy_spacing
($rawline);
1313 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1314 my $hereptr = "$hereline$ptr\n";
1316 ERROR
("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1319 # ignore non-hunk lines and lines being removed
1320 next if (!$hunk_line || $line =~ /^-/);
1322 # ignore files that are being periodically imported from Linux
1323 next if ($realfile =~ /^(linux-headers|include\/standard
-headers
)\
//);
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);
1336 # check we are in a valid source file if not then ignore this hunk
1337 next if ($realfile !~ /\.(h|c|cpp|s|S|pl|py|sh)$/);
1340 if ($line =~ /^\+/ &&
1341 !($line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
1344 WARN
("line over 80 characters\n" . $herecurr);
1347 # check for spaces before a quoted newline
1348 if ($rawline =~ /^.*\".*\s\\n/) {
1349 WARN
("unnecessary whitespace before a quoted newline\n" . $herecurr);
1352 # check for adding lines without a newline.
1353 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1354 WARN
("adding a line without newline at end of file\n" . $herecurr);
1357 # tabs are only allowed in assembly source code, and in
1358 # some scripts we imported from other projects.
1359 next if ($realfile =~ /\.(s|S)$/);
1360 next if ($realfile =~ /(checkpatch|get_maintainer|texi2pod)\.pl$/);
1362 if ($rawline =~ /^\+.*\t/) {
1363 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
1364 ERROR
("code indent should never use tabs\n" . $herevet);
1368 # check we are in a valid C source file if not then ignore this hunk
1369 next if ($realfile !~ /\.(h|c|cpp)$/);
1371 # check for RCS/CVS revision markers
1372 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
1373 WARN
("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1376 # Check for potential 'bare' types
1377 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
1379 if ($realcnt && $line =~ /.\s*\S/) {
1380 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
1381 ctx_statement_block
($linenr, $realcnt, 0);
1382 $stat =~ s/\n./\n /g;
1383 $cond =~ s/\n./\n /g;
1385 # Find the real next line.
1386 $realline_next = $line_nr_next;
1387 if (defined $realline_next &&
1388 (!defined $lines[$realline_next - 1] ||
1389 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
1396 # Ignore goto labels.
1397 if ($s =~ /$Ident:\*$/s) {
1399 # Ignore functions being called
1400 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
1402 } elsif ($s =~ /^.\s*else\b/s) {
1404 # declarations always start with types
1405 } 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) {
1408 possible
($type, "A:" . $s);
1410 # definitions in global scope can only start with types
1411 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
1412 possible
($1, "B:" . $s);
1415 # any (foo ... *) is a pointer cast, and foo is a type
1416 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
1417 possible
($1, "C:" . $s);
1420 # Check for any sort of function declaration.
1421 # int foo(something bar, other baz);
1422 # void (*store_gdt)(x86_descr_ptr *);
1423 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
1424 my ($name_len) = length($1);
1427 substr($ctx, 0, $name_len + 1, '');
1428 $ctx =~ s/\)[^\)]*$//;
1430 for my $arg (split(/\s*,\s*/, $ctx)) {
1431 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
1433 possible
($1, "D:" . $s);
1441 # Checks which may be anchored in the context.
1444 # Check for switch () and associated case and default
1445 # statements should be at the same indent.
1446 if ($line=~/\bswitch\s*\(.*\)/) {
1449 my @ctx = ctx_block_outer
($linenr, $realcnt);
1451 for my $ctx (@ctx) {
1452 my ($clen, $cindent) = line_stats
($ctx);
1453 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1454 $indent != $cindent) {
1455 $err .= "$sep$ctx\n";
1462 ERROR
("switch and case should be at the same indent\n$hereline$err");
1466 # if/while/etc brace do not go on next line, unless defining a do while loop,
1467 # or if that brace on the next line is for something else
1468 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
1469 my $pre_ctx = "$1$2";
1471 my ($level, @ctx) = ctx_statement_level
($linenr, $realcnt, 0);
1472 my $ctx_cnt = $realcnt - $#ctx - 1;
1473 my $ctx = join("\n", @ctx);
1475 my $ctx_ln = $linenr;
1476 my $ctx_skip = $realcnt;
1478 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1479 defined $lines[$ctx_ln - 1] &&
1480 $lines[$ctx_ln - 1] =~ /^-/)) {
1481 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1482 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
1486 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1487 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
1489 # The length of the "previous line" is checked against 80 because it
1490 # includes the + at the beginning of the line (if the actual line has
1491 # 79 or 80 characters, it is no longer possible to add a space and an
1492 # opening brace there)
1493 if ($#ctx == 0 && $ctx !~ /{\s*/ &&
1494 defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*\{/ &&
1495 defined($lines[$ctx_ln - 2]) && length($lines[$ctx_ln - 2]) < 80) {
1496 ERROR
("that open brace { should be on the previous line\n" .
1497 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
1499 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1500 $ctx =~ /\)\s*\;\s*$/ &&
1501 defined $lines[$ctx_ln - 1])
1503 my ($nlength, $nindent) = line_stats
($lines[$ctx_ln - 1]);
1504 if ($nindent > $indent) {
1505 WARN
("trailing semicolon indicates no statements, indent implies otherwise\n" .
1506 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
1511 # Check relative indent for conditionals and blocks.
1512 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1513 my ($s, $c) = ($stat, $cond);
1515 substr($s, 0, length($c), '');
1517 # Make sure we remove the line prefixes as we have
1518 # none on the first line, and are going to readd them
1522 # Find out how long the conditional actually is.
1523 my @newlines = ($c =~ /\n/gs);
1524 my $cond_lines = 1 + $#newlines;
1526 # We want to check the first line inside the block
1527 # starting at the end of the conditional, so remove:
1528 # 1) any blank line termination
1529 # 2) any opening brace { on end of the line
1531 my $continuation = 0;
1533 $s =~ s/^.*\bdo\b//;
1535 if ($s =~ s/^\s*\\//) {
1538 if ($s =~ s/^\s*?\n//) {
1543 # Also ignore a loop construct at the end of a
1544 # preprocessor statement.
1545 if (($prevline =~ /^.\s*#\s*define\s/ ||
1546 $prevline =~ /\\\s*$/) && $continuation == 0) {
1552 while ($cond_ptr != $cond_lines) {
1553 $cond_ptr = $cond_lines;
1555 # If we see an #else/#elif then the code
1557 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
1562 # 1) blank lines, they should be at 0,
1563 # 2) preprocessor lines, and
1565 if ($continuation ||
1567 $s =~ /^\s*#\s*?/ ||
1568 $s =~ /^\s*$Ident\s*:/) {
1569 $continuation = ($s =~ /^.*?\\\n/) ?
1 : 0;
1570 if ($s =~ s/^.*?\n//) {
1576 my (undef, $sindent) = line_stats
("+" . $s);
1577 my $stat_real = raw_line
($linenr, $cond_lines);
1579 # Check if either of these lines are modified, else
1580 # this is not this patch's fault.
1581 if (!defined($stat_real) ||
1582 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
1585 if (defined($stat_real) && $cond_lines > 1) {
1586 $stat_real = "[...]\n$stat_real";
1589 #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";
1591 if ($check && (($sindent % 4) != 0 ||
1592 ($sindent <= $indent && $s ne ''))) {
1593 WARN
("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
1597 # Track the 'values' across context and added lines.
1598 my $opline = $line; $opline =~ s/^./ /;
1599 my ($curr_values, $curr_vars) =
1600 annotate_values
($opline . "\n", $prev_values);
1601 $curr_values = $prev_values . $curr_values;
1603 my $outline = $opline; $outline =~ s/\t/ /g;
1604 print "$linenr > .$outline\n";
1605 print "$linenr > $curr_values\n";
1606 print "$linenr > $curr_vars\n";
1608 $prev_values = substr($curr_values, -1);
1610 #ignore lines not being added
1611 if ($line=~/^[^\+]/) {next;}
1613 # TEST: allow direct testing of the type matcher.
1615 if ($line =~ /^.\s*$Declare\s*$/) {
1616 ERROR
("TEST: is type\n" . $herecurr);
1617 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
1618 ERROR
("TEST: is not type ($1 is)\n". $herecurr);
1622 # TEST: allow direct testing of the attribute matcher.
1624 if ($line =~ /^.\s*$Modifier\s*$/) {
1625 ERROR
("TEST: is attr\n" . $herecurr);
1626 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
1627 ERROR
("TEST: is not attr ($1 is)\n". $herecurr);
1632 # check for initialisation to aggregates open brace on the next line
1633 if ($line =~ /^.\s*\{/ &&
1634 $prevline =~ /(?:^|[^=])=\s*$/) {
1635 ERROR
("that open brace { should be on the previous line\n" . $hereprev);
1639 # Checks which are anchored on the added line.
1642 # check for malformed paths in #include statements (uses RAW line)
1643 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
1645 if ($path =~ m{//}) {
1646 ERROR
("malformed #include filename\n" .
1651 # no C99 // comments
1652 if ($line =~ m{//}) {
1653 ERROR
("do not use C99 // comments\n" . $herecurr);
1655 # Remove C99 comments.
1657 $opline =~ s
@//.*@@;
1659 # check for global initialisers.
1660 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
1661 ERROR
("do not initialise globals to 0 or NULL\n" .
1664 # check for static initialisers.
1665 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
1666 ERROR
("do not initialise statics to 0 or NULL\n" .
1670 # * goes on variable not on type
1672 if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) {
1673 my ($from, $to) = ($1, $1);
1675 # Should start with a space.
1676 $to =~ s/^(\S)/ $1/;
1677 # Should not end with a space.
1679 # '*'s should not have spaces between.
1680 while ($to =~ s/\*\s+\*/\*\*/) {
1683 #print "from<$from> to<$to>\n";
1685 ERROR
("\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr);
1687 } elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) {
1688 my ($from, $to, $ident) = ($1, $1, $2);
1690 # Should start with a space.
1691 $to =~ s/^(\S)/ $1/;
1692 # Should not end with a space.
1694 # '*'s should not have spaces between.
1695 while ($to =~ s/\*\s+\*/\*\*/) {
1697 # Modifiers should have spaces.
1698 $to =~ s/(\b$Modifier$)/$1 /;
1700 #print "from<$from> to<$to> ident<$ident>\n";
1701 if ($from ne $to && $ident !~ /^$Modifier$/) {
1702 ERROR
("\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr);
1706 # function brace can't be on same line, except for #defines of do while,
1707 # or if closed on same line
1708 if (($line=~/$Type\s*$Ident\(.*\).*\s\{/) and
1709 !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) {
1710 ERROR
("open brace '{' following function declarations go on the next line\n" . $herecurr);
1713 # open braces for enum, union and struct go on the same line.
1714 if ($line =~ /^.\s*\{/ &&
1715 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1716 ERROR
("open brace '{' following $1 go on the same line\n" . $hereprev);
1719 # missing space after union, struct or enum definition
1720 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) {
1721 ERROR
("missing space after $1 definition\n" . $herecurr);
1724 # check for spacing round square brackets; allowed:
1725 # 1. with a type on the left -- int [] a;
1726 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
1727 # 3. inside a curly brace -- = { [0...10] = 5 }
1728 # 4. after a comma -- [1] = 5, [2] = 6
1729 # 5. in a macro definition -- #define abc(x) [x] = y
1730 while ($line =~ /(.*?\s)\[/g) {
1731 my ($where, $prefix) = ($-[1], $1);
1732 if ($prefix !~ /$Type\s+$/ &&
1733 ($where != 0 || $prefix !~ /^.\s+$/) &&
1734 $prefix !~ /{\s+$/ &&
1735 $prefix !~ /\#\s*define[^(]*\([^)]*\)\s+$/ &&
1736 $prefix !~ /,\s+$/) {
1737 ERROR
("space prohibited before open square bracket '['\n" . $herecurr);
1741 # check for spaces between functions and their parentheses.
1742 while ($line =~ /($Ident)\s+\(/g) {
1744 my $ctx_before = substr($line, 0, $-[1]);
1745 my $ctx = "$ctx_before$name";
1747 # Ignore those directives where spaces _are_ permitted.
1749 if|for|while|switch
|return|case
|
1750 volatile
|__volatile__
|
1751 __attribute__
|format
|__extension__
|
1755 # Ignore 'catch (...)' in C++
1756 } elsif ($name =~ /^catch$/ && $realfile =~ /(\.cpp|\.h)$/) {
1758 # cpp #define statements have non-optional spaces, ie
1759 # if there is a space between the name and the open
1760 # parenthesis it is simply not a parameter group.
1761 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
1763 # cpp #elif statement condition may start with a (
1764 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
1766 # If this whole things ends with a type its most
1767 # likely a typedef for a function.
1768 } elsif ($ctx =~ /$Type$/) {
1771 WARN
("space prohibited between function name and open parenthesis '('\n" . $herecurr);
1774 # Check operator spacing.
1775 if (!($line=~/\#\s*include/)) {
1777 <<=|>>=|<=|>=|==|!=|
1778 \
+=|-=|\
*=|\
/=|%=|\
^=|\
|=|&=|
1779 =>|->|<<|>>|<|>|=|!|~|
1780 &&|\
|\
||,|\
^|\
+\
+|--|&|\
||\
+|-|\
*|\
/|%|
1783 my @elements = split(/($ops|;)/, $opline);
1786 my $blank = copy_spacing
($opline);
1788 for (my $n = 0; $n < $#elements; $n += 2) {
1789 $off += length($elements[$n]);
1791 # Pick up the preceding and succeeding characters.
1792 my $ca = substr($opline, 0, $off);
1794 if (length($opline) >= ($off + length($elements[$n + 1]))) {
1795 $cc = substr($opline, $off + length($elements[$n + 1]));
1797 my $cb = "$ca$;$cc";
1800 $a = 'V' if ($elements[$n] ne '');
1801 $a = 'W' if ($elements[$n] =~ /\s$/);
1802 $a = 'C' if ($elements[$n] =~ /$;$/);
1803 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
1804 $a = 'O' if ($elements[$n] eq '');
1805 $a = 'E' if ($ca =~ /^\s*$/);
1807 my $op = $elements[$n + 1];
1810 if (defined $elements[$n + 2]) {
1811 $c = 'V' if ($elements[$n + 2] ne '');
1812 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
1813 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
1814 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
1815 $c = 'O' if ($elements[$n + 2] eq '');
1816 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
1821 my $ctx = "${a}x${c}";
1823 my $at = "(ctx:$ctx)";
1825 my $ptr = substr($blank, 0, $off) . "^";
1826 my $hereptr = "$hereline$ptr\n";
1828 # Pull out the value of this operator.
1829 my $op_type = substr($curr_values, $off + 1, 1);
1831 # Get the full operator variant.
1832 my $opv = $op . substr($curr_vars, $off, 1);
1834 # Ignore operators passed as parameters.
1835 if ($op_type ne 'V' &&
1836 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
1839 # } elsif ($op =~ /^$;+$/) {
1841 # ; should have either the end of line or a space or \ after it
1842 } elsif ($op eq ';') {
1843 if ($ctx !~ /.x[WEBC]/ &&
1844 $cc !~ /^\\/ && $cc !~ /^;/) {
1845 ERROR
("space required after that '$op' $at\n" . $hereptr);
1849 } elsif ($op eq '//') {
1851 # Ignore : used in class declaration in C++
1852 } elsif ($opv eq ':B' && $ctx =~ /Wx[WE]/ &&
1853 $line =~ /class/ && $realfile =~ /(\.cpp|\.h)$/) {
1857 # : when part of a bitfield
1858 } elsif ($op eq '->' || $opv eq ':B') {
1859 if ($ctx =~ /Wx.|.xW/) {
1860 ERROR
("spaces prohibited around that '$op' $at\n" . $hereptr);
1863 # , must have a space on the right.
1864 # not required when having a single },{ on one line
1865 } elsif ($op eq ',') {
1866 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/ &&
1867 ($elements[$n] . $elements[$n + 2]) !~ " *}\\{") {
1868 ERROR
("space required after that '$op' $at\n" . $hereptr);
1871 # '*' as part of a type definition -- reported already.
1872 } elsif ($opv eq '*_') {
1873 #warn "'*' is part of type\n";
1875 # unary operators should have a space before and
1876 # none after. May be left adjacent to another
1877 # unary operator, or a cast
1878 } elsif ($op eq '!' || $op eq '~' ||
1879 $opv eq '*U' || $opv eq '-U' ||
1880 $opv eq '&U' || $opv eq '&&U') {
1881 if ($op eq '~' && $ca =~ /::$/ && $realfile =~ /(\.cpp|\.h)$/) {
1882 # '~' used as a name of Destructor
1884 } elsif ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
1885 ERROR
("space required before that '$op' $at\n" . $hereptr);
1887 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
1888 # A unary '*' may be const
1890 } elsif ($ctx =~ /.xW/) {
1891 ERROR
("space prohibited after that '$op' $at\n" . $hereptr);
1894 # unary ++ and unary -- are allowed no space on one side.
1895 } elsif ($op eq '++' or $op eq '--') {
1896 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
1897 ERROR
("space required one side of that '$op' $at\n" . $hereptr);
1899 if ($ctx =~ /Wx[BE]/ ||
1900 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
1901 ERROR
("space prohibited before that '$op' $at\n" . $hereptr);
1903 if ($ctx =~ /ExW/) {
1904 ERROR
("space prohibited after that '$op' $at\n" . $hereptr);
1907 # A colon needs no spaces before when it is
1908 # terminating a case value or a label.
1909 } elsif ($opv eq ':C' || $opv eq ':L') {
1910 if ($ctx =~ /Wx./) {
1911 ERROR
("space prohibited before that '$op' $at\n" . $hereptr);
1914 # All the others need spaces both sides.
1915 } elsif ($ctx !~ /[EWC]x[CWE]/) {
1918 if ($realfile =~ /\.cpp|\.h$/) {
1919 # Ignore template arguments <...> in C++
1920 if (($op eq '<' || $op eq '>') && $line =~ /<.*>/) {
1930 # Ignore email addresses <foo@bar>
1932 $cc =~ /^\S+\@\S+>/) ||
1934 $ca =~ /<\S+\@\S+$/))
1940 if (($opv eq ':O' && $ca =~ /\?$/) ||
1941 ($op eq '?' && $cc =~ /^:/)) {
1946 ERROR
("spaces required around that '$op' $at\n" . $hereptr);
1949 $off += length($elements[$n + 1]);
1953 #need space before brace following if, while, etc
1954 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
1956 ERROR
("space required before the open brace '{'\n" . $herecurr);
1959 # closing brace should have a space following it when it has anything
1961 if ($line =~ /}(?!(?:,|;|\)))\S/) {
1962 ERROR
("space required after that close brace '}'\n" . $herecurr);
1965 # check spacing on square brackets
1966 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
1967 ERROR
("space prohibited after that open square bracket '['\n" . $herecurr);
1969 if ($line =~ /\s\]/) {
1970 ERROR
("space prohibited before that close square bracket ']'\n" . $herecurr);
1973 # check spacing on parentheses
1974 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
1975 $line !~ /for\s*\(\s+;/) {
1976 ERROR
("space prohibited after that open parenthesis '('\n" . $herecurr);
1978 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
1979 $line !~ /for\s*\(.*;\s+\)/ &&
1980 $line !~ /:\s+\)/) {
1981 ERROR
("space prohibited before that close parenthesis ')'\n" . $herecurr);
1984 # Return is not a function.
1985 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
1989 # Flatten any parentheses
1990 $value =~ s/\(/ \(/g;
1991 $value =~ s/\)/\) /g;
1992 while ($value =~ s/\[[^\{\}]*\]/1/ ||
1993 $value !~ /(?
:$Ident|-?
$Constant)\s
*
1995 (?
:$Ident|-?
$Constant)/x
&&
1996 $value =~ s/\([^\(\)]*\)/1/) {
1998 #print "value<$value>\n";
1999 if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
2000 ERROR
("return is not a function, parentheses are not required\n" . $herecurr);
2002 } elsif ($spacing !~ /\s+/) {
2003 ERROR
("space required before the open parenthesis '('\n" . $herecurr);
2006 # Return of what appears to be an errno should normally be -'ve
2007 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
2009 if ($name ne 'EOF' && $name ne 'ERROR') {
2010 WARN
("return of an errno should typically be -ve (return -$1)\n" . $herecurr);
2014 # Need a space before open parenthesis after if, while etc
2015 if ($line=~/\b(if|while|for|switch)\(/) {
2016 ERROR
("space required before the open parenthesis '('\n" . $herecurr);
2019 # Check for illegal assignment in if conditional -- and check for trailing
2020 # statements after the conditional.
2021 if ($line =~ /do\s*(?!{)/) {
2022 my ($stat_next) = ctx_statement_block
($line_nr_next,
2023 $remain_next, $off_next);
2024 $stat_next =~ s/\n./\n /g;
2025 ##print "stat<$stat> stat_next<$stat_next>\n";
2027 if ($stat_next =~ /^\s*while\b/) {
2028 # If the statement carries leading newlines,
2029 # then count those as offsets.
2031 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2033 statement_rawlines
($whitespace) - 1;
2035 $suppress_whiletrailers{$line_nr_next +
2039 if (!defined $suppress_whiletrailers{$linenr} &&
2040 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
2041 my ($s, $c) = ($stat, $cond);
2043 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
2044 ERROR
("do not use assignment in if condition\n" . $herecurr);
2047 # Find out what is on the end of the line after the
2049 substr($s, 0, length($c), '');
2051 $s =~ s/$;//g; # Remove any comments
2052 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2053 $c !~ /}\s*while\s*/)
2055 # Find out how long the conditional actually is.
2056 my @newlines = ($c =~ /\n/gs);
2057 my $cond_lines = 1 + $#newlines;
2060 $stat_real = raw_line
($linenr, $cond_lines)
2061 . "\n" if ($cond_lines);
2062 if (defined($stat_real) && $cond_lines > 1) {
2063 $stat_real = "[...]\n$stat_real";
2066 ERROR
("trailing statements should be on next line\n" . $herecurr . $stat_real);
2070 # Check for bitwise tests written as boolean
2082 WARN
("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2085 # if and else should not have general statements after it
2086 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2088 $s =~ s/$;//g; # Remove any comments
2089 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2090 ERROR
("trailing statements should be on next line\n" . $herecurr);
2093 # if should not continue a brace
2094 if ($line =~ /}\s*if\b/) {
2095 ERROR
("trailing statements should be on next line\n" .
2098 # case and default should not have general statements after them
2099 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2101 (?
:\s
*$;*)(?
:\s
*{)?
(?
:\s
*$;*)(?
:\s
*\\)?\s
*$|
2105 ERROR
("trailing statements should be on next line\n" . $herecurr);
2108 # Check for }<nl>else {, these must be at the same
2109 # indent level to be relevant to each other.
2110 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2111 $previndent == $indent) {
2112 ERROR
("else should follow close brace '}'\n" . $hereprev);
2115 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2116 $previndent == $indent) {
2117 my ($s, $c) = ctx_statement_block
($linenr, $realcnt, 0);
2119 # Find out what is on the end of the line after the
2121 substr($s, 0, length($c), '');
2124 if ($s =~ /^\s*;/) {
2125 ERROR
("while should follow close brace '}'\n" . $hereprev);
2129 #studly caps, commented out until figure out how to distinguish between use of existing and adding new
2130 # if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2131 # print "No studly caps, use _\n";
2132 # print "$herecurr";
2136 #no spaces allowed after \ in define
2137 if ($line=~/\#\s*define.*\\\s$/) {
2138 WARN
("Whitepspace after \\ makes next lines useless\n" . $herecurr);
2141 # multi-statement macros should be enclosed in a do while loop, grab the
2142 # first statement and ensure its the whole macro if its not enclosed
2143 # in a known good container
2144 if ($realfile !~ m
@/vmlinux.lds
.h
$@ &&
2145 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
2148 my ($off, $dstat, $dcond, $rest);
2151 my $args = defined($1);
2153 # Find the end of the macro and limit our statement
2155 while ($cnt > 0 && defined $lines[$ln - 1] &&
2156 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
2158 $ctx .= $rawlines[$ln - 1] . "\n";
2159 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2162 $ctx .= $rawlines[$ln - 1];
2164 ($dstat, $dcond, $ln, $cnt, $off) =
2165 ctx_statement_block
($linenr, $ln - $linenr + 1, 0);
2166 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
2167 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
2169 # Extract the remainder of the define (if any) and
2170 # rip off surrounding spaces, and trailing \'s.
2172 while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
2173 #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
2174 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
2175 $rest .= substr($lines[$ln - 1], $off) . "\n";
2181 $rest =~ s/\\\n.//g;
2185 # Clean up the original statement.
2187 substr($dstat, 0, length($dcond), '');
2189 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
2192 $dstat =~ s/\\\n.//g;
2193 $dstat =~ s/^\s*//s;
2194 $dstat =~ s/\s*$//s;
2196 # Flatten any parentheses and braces
2197 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2198 $dstat =~ s/\{[^\{\}]*\}/1/ ||
2199 $dstat =~ s/\[[^\{\}]*\]/1/)
2203 my $exceptions = qr{
2215 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
2216 if ($rest ne '' && $rest ne ',') {
2217 if ($rest !~ /while\s*\(/ &&
2218 $dstat !~ /$exceptions/)
2220 ERROR
("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
2223 } elsif ($ctx !~ /;/) {
2225 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2226 $dstat !~ /$exceptions/ &&
2227 $dstat !~ /^\.$Ident\s*=/ &&
2228 $dstat =~ /$Operators/)
2230 ERROR
("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
2235 # check for missing bracing round if etc
2236 if ($line =~ /(^.*)\bif\b/ && $line !~ /\#\s*if/) {
2237 my ($level, $endln, @chunks) =
2238 ctx_statement_full
($linenr, $realcnt, 1);
2240 print "APW: chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
2241 print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"
2244 if ($#chunks >= 0 && $level == 0) {
2247 my $herectx = $here . "\n";
2248 my $ln = $linenr - 1;
2249 for my $chunk (@chunks) {
2250 my ($cond, $block) = @{$chunk};
2252 # If the condition carries leading newlines, then count those as offsets.
2253 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2254 my $offset = statement_rawlines
($whitespace) - 1;
2256 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2258 # We have looked at and allowed this specific line.
2259 $suppress_ifbraces{$ln + $offset} = 1;
2261 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
2262 $ln += statement_rawlines
($block) - 1;
2264 substr($block, 0, length($cond), '');
2266 my $spaced_block = $block;
2267 $spaced_block =~ s/\n\+/ /g;
2269 $seen++ if ($spaced_block =~ /^\s*\{/);
2271 print "APW: cond<$cond> block<$block> allowed<$allowed>\n"
2273 if (statement_lines
($cond) > 1) {
2274 print "APW: ALLOWED: cond<$cond>\n"
2278 if ($block =~/\b(?:if|for|while)\b/) {
2279 print "APW: ALLOWED: block<$block>\n"
2283 if (statement_block_size
($block) > 1) {
2284 print "APW: ALLOWED: lines block<$block>\n"
2289 if ($seen != ($#chunks + 1)) {
2290 WARN
("braces {} are necessary for all arms of this statement\n" . $herectx);
2294 if (!defined $suppress_ifbraces{$linenr - 1} &&
2295 $line =~ /\b(if|while|for|else)\b/ &&
2296 $line !~ /\#\s*if/ &&
2297 $line !~ /\#\s*else/) {
2300 # Check the pre-context.
2301 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2304 if ($line !~ /else/) {
2305 print "APW: ALLOWED: pre<$pre> line<$line>\n"
2311 my ($level, $endln, @chunks) =
2312 ctx_statement_full
($linenr, $realcnt, $-[0]);
2314 # Check the condition.
2315 my ($cond, $block) = @{$chunks[0]};
2316 print "CHECKING<$linenr> cond<$cond> block<$block>\n"
2317 if $dbg_adv_checking;
2318 if (defined $cond) {
2319 substr($block, 0, length($cond), '');
2321 if (statement_lines
($cond) > 1) {
2322 print "APW: ALLOWED: cond<$cond>\n"
2326 if ($block =~/\b(?:if|for|while)\b/) {
2327 print "APW: ALLOWED: block<$block>\n"
2331 if (statement_block_size
($block) > 1) {
2332 print "APW: ALLOWED: lines block<$block>\n"
2336 # Check the post-context.
2337 if (defined $chunks[1]) {
2338 my ($cond, $block) = @{$chunks[1]};
2339 if (defined $cond) {
2340 substr($block, 0, length($cond), '');
2342 if ($block =~ /^\s*\{/) {
2343 print "APW: ALLOWED: chunk-1 block<$block>\n"
2348 print "DCS: level=$level block<$block> allowed=$allowed\n"
2350 if ($level == 0 && $block !~ /^\s*\{/ && !$allowed) {
2351 my $herectx = $here . "\n";;
2352 my $cnt = statement_rawlines
($block);
2354 for (my $n = 0; $n < $cnt; $n++) {
2355 $herectx .= raw_line
($linenr, $n) . "\n";;
2358 WARN
("braces {} are necessary even for single statement blocks\n" . $herectx);
2362 # no volatiles please
2363 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2364 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
2365 WARN
("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
2369 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
2370 WARN
("if this code is redundant consider removing it\n" .
2374 # check for needless g_free() checks
2375 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2377 if ($line =~ /\bg_free\(\Q$expr\E\);/) {
2378 WARN
("g_free(NULL) is safe this check is probably not required\n" . $hereprev);
2382 # warn about #ifdefs in C files
2383 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
2384 # print "#ifdef in C files should be avoided\n";
2385 # print "$herecurr";
2389 # warn about spacing in #ifdefs
2390 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
2391 ERROR
("exactly one space required after that #$1\n" . $herecurr);
2393 # check for memory barriers without a comment.
2394 if ($line =~ /\b(smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2395 if (!ctx_has_comment
($first_line, $linenr)) {
2396 WARN
("memory barrier without comment\n" . $herecurr);
2399 # check of hardware specific defines
2400 # we have e.g. CONFIG_LINUX and CONFIG_WIN32 for common cases
2401 # where they might be necessary.
2402 if ($line =~ m
@^.\s
*\#\s
*if.*\b__
@) {
2403 WARN
("architecture specific defines should be avoided\n" . $herecurr);
2406 # Check that the storage class is at the beginning of a declaration
2407 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
2408 WARN
("storage class should be at the beginning of the declaration\n" . $herecurr)
2411 # check the location of the inline attribute, that it is between
2412 # storage class and type.
2413 if ($line =~ /\b$Type\s+$Inline\b/ ||
2414 $line =~ /\b$Inline\s+$Storage\b/) {
2415 ERROR
("inline keyword should sit between storage class and type\n" . $herecurr);
2418 # check for sizeof(&)
2419 if ($line =~ /\bsizeof\s*\(\s*\&/) {
2420 WARN
("sizeof(& should be avoided\n" . $herecurr);
2423 # check for new externs in .c files.
2424 if ($realfile =~ /\.c$/ && defined $stat &&
2425 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
2427 my $function_name = $1;
2428 my $paren_space = $2;
2431 if (defined $cond) {
2432 substr($s, 0, length($cond), '');
2434 if ($s =~ /^\s*;/ &&
2435 $function_name ne 'uninitialized_var')
2437 WARN
("externs should be avoided in .c files\n" . $herecurr);
2440 if ($paren_space =~ /\n/) {
2441 WARN
("arguments for function declarations should follow identifier\n" . $herecurr);
2444 } elsif ($realfile =~ /\.c$/ && defined $stat &&
2445 $stat =~ /^.\s*extern\s+/)
2447 WARN
("externs should be avoided in .c files\n" . $herecurr);
2450 # check for pointless casting of g_malloc return
2451 if ($line =~ /\*\s*\)\s*g_(try)?(m|re)alloc(0?)(_n)?\b/) {
2453 WARN
("unnecessary cast may hide bugs, use g_$1new$3 instead\n" . $herecurr);
2455 WARN
("unnecessary cast may hide bugs, use g_$1renew$3 instead\n" . $herecurr);
2459 # check for gcc specific __FUNCTION__
2460 if ($line =~ /__FUNCTION__/) {
2461 WARN
("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
2464 # recommend qemu_strto* over strto* for numeric conversions
2465 if ($line =~ /\b(strto[^kd].*?)\s*\(/) {
2466 WARN
("consider using qemu_$1 in preference to $1\n" . $herecurr);
2468 # check for module_init(), use category-specific init macros explicitly please
2469 if ($line =~ /^module_init\s*\(/) {
2470 WARN
("please use block_init(), type_init() etc. instead of module_init()\n" . $herecurr);
2472 # check for various ops structs, ensure they are const.
2473 my $struct_ops = qr{AIOCBInfo
|
2477 DisplayChangeListenerOps
|
2481 MemoryRegionIOMMUOps
|
2487 Spice
[A-Z
][a-zA-Z0-9
]*Interface
|
2489 USBDesc
[A-Z
][a-zA-Z0-9
]*|
2493 if ($line !~ /\bconst\b/ &&
2494 $line =~ /\b($struct_ops)\b/) {
2495 WARN
("struct $1 should normally be const\n" .
2499 # check for %L{u,d,i} in strings
2501 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2502 $string = substr($rawline, $-[1], $+[1] - $-[1]);
2503 $string =~ s/%%/__/g;
2504 if ($string =~ /(?<!%)%L[udi]/) {
2505 WARN
("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2510 # QEMU specific tests
2511 if ($rawline =~ /\b(?:Qemu|QEmu)\b/) {
2512 WARN
("use QEMU instead of Qemu or QEmu\n" . $herecurr);
2515 # Qemu error function tests
2517 # Find newlines in error messages
2518 my $qemu_error_funcs = qr{error_setg
|
2521 error_setg_file_open
|
2528 if ($rawline =~ /\b(?:$qemu_error_funcs)\s*\(.*\".*\\n/) {
2529 WARN
("Error messages should not contain newlines\n" . $herecurr);
2532 # Continue checking for error messages that contains newlines. This
2533 # check handles cases where string literals are spread over multiple lines.
2535 # error_report("Error msg line #1"
2536 # "Error msg line #2\n");
2537 my $quoted_newline_regex = qr{\+\s*\".*\\n.*\"};
2538 my $continued_str_literal = qr{\+\s*\".*\"};
2540 if ($rawline =~ /$quoted_newline_regex/) {
2541 # Backtrack to first line that does not contain only a quoted literal
2542 # and assume that it is the start of the statement.
2543 my $i = $linenr - 2;
2545 while (($i >= 0) & $rawlines[$i] =~ /$continued_str_literal/) {
2549 if ($rawlines[$i] =~ /\b(?:$qemu_error_funcs)\s*\(/) {
2550 WARN
("Error messages should not contain newlines\n" . $herecurr);
2554 # check for non-portable libc calls that have portable alternatives in QEMU
2555 if ($line =~ /\bffs\(/) {
2556 ERROR
("use ctz32() instead of ffs()\n" . $herecurr);
2558 if ($line =~ /\bffsl\(/) {
2559 ERROR
("use ctz32() or ctz64() instead of ffsl()\n" . $herecurr);
2561 if ($line =~ /\bffsll\(/) {
2562 ERROR
("use ctz64() instead of ffsll()\n" . $herecurr);
2564 if ($line =~ /\bbzero\(/) {
2565 ERROR
("use memset() instead of bzero()\n" . $herecurr);
2569 # If we have no input at all, then there is nothing to report on
2570 # so just keep quiet.
2571 if ($#rawlines == -1) {
2575 # In mailback mode only produce a report in the negative, for
2576 # things that appear to be patches.
2577 if ($mailback && ($clean == 1 || !$is_patch)) {
2581 # This is not a patch, and we are are in 'no-patch' mode so
2583 if (!$chk_patch && !$is_patch) {
2588 ERROR
("Does not appear to be a unified-diff format patch\n");
2590 if ($is_patch && $chk_signoff && $signoff == 0) {
2591 ERROR
("Missing Signed-off-by: line(s)\n");
2594 print report_dump
();
2595 if ($summary && !($clean == 1 && $quiet == 1)) {
2596 print "$filename " if ($summary_file);
2597 print "total: $cnt_error errors, $cnt_warn warnings, " .
2598 (($check)?
"$cnt_chk checks, " : "") .
2599 "$cnt_lines lines checked\n";
2600 print "\n" if ($quiet == 0);
2604 # If there were whitespace errors which cleanpatch can fix
2605 # then suggest that.
2606 # if ($rpt_cleaners) {
2607 # print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
2608 # print " scripts/cleanfile\n\n";
2612 if ($clean == 1 && $quiet == 0) {
2613 print "$vname has no obvious style problems and is ready for submission.\n"
2615 if ($clean == 0 && $quiet == 0) {
2616 print "$vname has style problems, please review. If any of these errors\n";
2617 print "are false positives report them to the maintainer, see\n";
2618 print "CHECKPATCH in MAINTAINERS.\n";