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
10 use Term
::ANSIColor
qw(:constants);
15 our $SrcFile = qr{\.(?:(h|c)(\.inc)?|cpp|s|S|pl|py|sh)$};
19 use Getopt
::Long
qw(:config no_auto_abbrev);
24 my $chk_patch = undef;
25 my $chk_branch = undef;
45 $P [OPTION
]... [FILE
]...
46 $P [OPTION
]... [GIT
-REV
-LIST
]
52 --no-tree run without a qemu tree
53 --no-signoff
do not check
for 'Signed-off-by' line
54 --patch treat FILE as patchfile
55 --branch treat args as GIT revision list
56 --emacs emacs compile window format
57 --terse one line per report
58 -f
, --file treat FILE as regular source file
59 --strict fail
if only warnings are found
60 --root
=PATH PATH to the qemu tree root
61 --no-summary suppress the per
-file summary
62 --mailback only produce a report
in case of warnings
/errors
63 --summary
-file include the filename
in summary
64 --debug KEY
=[0|1] turn on
/off debugging of KEY
, where KEY is one of
65 'values', 'possible', 'type', and 'attr' (default
67 --test
-only
=WORD report only warnings
/errors containing WORD
69 --color
[=WHEN
] Use colors
'always', 'never', or only
when output
70 is a terminal
('auto'). Default is
'auto'.
71 -h
, --help
, --version display this help
and exit
73 When FILE is
- read standard input
.
79 # Perl's Getopt::Long allows options to take optional arguments after a space.
80 # Prevent --color by itself from consuming other arguments
82 if ($_ eq "--color" || $_ eq "-color") {
83 $_ = "--color=$color";
88 'q|quiet+' => \
$quiet,
90 'signoff!' => \
$chk_signoff,
91 'patch!' => \
$chk_patch,
92 'branch!' => \
$chk_branch,
96 'strict!' => \
$no_warnings,
98 'summary!' => \
$summary,
99 'mailback!' => \
$mailback,
100 'summary-file!' => \
$summary_file,
102 'debug=s' => \
%debug,
103 'test-only=s' => \
$tst_only,
104 'color=s' => \
$color,
105 'no-color' => sub { $color = 'never'; },
115 print "$P: no input files\n";
119 if (!defined $chk_branch && !defined $chk_patch && !defined $file) {
120 $chk_branch = $ARGV[0] =~ /.\.\./ ?
1 : 0;
121 $file = $ARGV[0] =~ /$SrcFile/ ?
1 : 0;
122 $chk_patch = $chk_branch || $file ?
0 : 1;
123 } elsif (!defined $chk_branch && !defined $chk_patch) {
125 $chk_branch = $chk_patch = 0;
127 $chk_branch = $ARGV[0] =~ /.\.\./ ?
1 : 0;
128 $chk_patch = $chk_branch ?
0 : 1;
130 } elsif (!defined $chk_branch && !defined $file) {
132 $chk_branch = $file = 0;
134 $chk_branch = $ARGV[0] =~ /.\.\./ ?
1 : 0;
135 $file = $chk_branch ?
0 : 1;
137 } elsif (!defined $chk_patch && !defined $file) {
139 $chk_patch = $file = 0;
141 $file = $ARGV[0] =~ /$SrcFile/ ?
1 : 0;
142 $chk_patch = $file ?
0 : 1;
144 } elsif (!defined $chk_branch) {
145 $chk_branch = $chk_patch || $file ?
0 : 1;
146 } elsif (!defined $chk_patch) {
147 $chk_patch = $chk_branch || $file ?
0 : 1;
148 } elsif (!defined $file) {
149 $file = $chk_patch || $chk_branch ?
0 : 1;
152 if (($chk_patch && $chk_branch) ||
153 ($chk_patch && $file) ||
154 ($chk_branch && $file)) {
155 die "Only one of --file, --branch, --patch is permitted\n";
157 if (!$chk_patch && !$chk_branch && !$file) {
158 die "One of --file, --branch, --patch is required\n";
161 if ($color =~ /^always$/i) {
163 } elsif ($color =~ /^never$/i) {
165 } elsif ($color =~ /^auto$/i) {
166 $color = (-t STDOUT
);
168 die "Invalid color mode: $color\n";
172 my $dbg_possible = 0;
176 my $dbg_adv_checking = 0;
178 for my $key (keys %debug) {
180 eval "\${dbg_$key} = '$debug{$key}';";
184 my $rpt_cleaners = 0;
193 if (!top_of_kernel_tree
($root)) {
194 die "$P: $root: --root does not point at a valid tree\n";
197 if (top_of_kernel_tree
('.')) {
199 } elsif ($0 =~ m@
(.*)/scripts/[^/]*$@
&&
200 top_of_kernel_tree
($1)) {
205 if (!defined $root) {
206 print "Must be run from the top-level dir. of a qemu tree\n";
211 my $emitted_corrupt = 0;
214 [A
-Za
-z_
][A
-Za
-z\d_
]*
215 (?
:\s
*\#\#\s
*[A
-Za
-z_
][A
-Za
-z\d_
]*)*
217 our $Storage = qr{extern|static|asmlinkage};
222 # Notes to $Attribute:
227 G_GNUC_WARN_UNUSED_RESULT
|
228 G_GNUC_NULL_TERMINATED
|
233 our $Inline = qr{inline};
234 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
235 our $Lval = qr{$Ident(?:$Member)*};
237 our $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
238 our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
239 our $Compare = qr{<=|>=|==|!=|<|>};
243 &&|\
|\
||,|\
^|\
+\
+|--|&|\
||\
+|-|\
*|\
/|%
250 our $NON_ASCII_UTF8 = qr{
251 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
252 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
253 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
254 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
255 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
256 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
257 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
261 [\x09\x0A\x0D\x20-\x7E] # ASCII
265 # some readers default to ISO-8859-1 when showing email source. detect
266 # when UTF-8 is incorrectly interpreted as ISO-8859-1 and reencoded back.
267 # False positives are possible but very unlikely.
268 our $UTF8_MOJIBAKE = qr{
269 \xC3[\x82-\x9F] \xC2[\x80-\xBF] # c2-df 80-bf
270 | \xC3\xA0 \xC2[\xA0-\xBF] \xC2[\x80-\xBF] # e0 a0-bf 80-bf
271 | \xC3[\xA1-\xAC\xAE\xAF] (?
: \xC2[\x80-\xBF]){2} # e1-ec/ee/ef 80-bf 80-bf
272 | \xC3\xAD \xC2[\x80-\x9F] \xC2[\x80-\xBF] # ed 80-9f 80-bf
273 | \xC3\xB0 \xC2[\x90-\xBF] (?
: \xC2[\x80-\xBF]){2} # f0 90-bf 80-bf 80-bf
274 | \xC3[\xB1-\xB3] (?
: \xC2[\x80-\xBF]){3} # f1-f3 80-bf 80-bf 80-bf
275 | \xC3\xB4 \xC2[\x80-\x8F] (?
: \xC2[\x80-\xBF]){2} # f4 80-b8 80-bf 80-bf
278 # There are still some false positives, but this catches most
280 our $typeTypedefs = qr{(?x
:
281 (?
![KMGTPE
]iB
) # IEC binary prefix (do not match)
282 [A
-Z
][A
-Z\d_
]*[a
-z
][A
-Za
-z\d_
]* # camelcase
283 | [A
-Z
][A
-Z\d_
]*AIOCB
# all uppercase
284 | [A
-Z
][A
-Z\d_
]*CPU
# all uppercase
285 | QEMUBH
# all uppercase
290 qr{(?:unsigned\s+)?char},
291 qr{(?:unsigned\s+)?short},
292 qr{(?:unsigned\s+)?int},
293 qr{(?:unsigned\s+)?long},
294 qr{(?:unsigned\s+)?long\s+int},
295 qr{(?:unsigned\s+)?long\s+long},
296 qr{(?:unsigned\s+)?long\s+long\s+int},
305 qr{${Ident}_handler
},
306 qr{${Ident}_handler_fn
},
307 qr{target_(?:u)?long},
340 # This can be modified by sub possible. Since it can be empty, be careful
341 # about regexes that always match, because they can cause infinite loops.
342 our @modifierList = (
346 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
347 if (@modifierList > 0) {
348 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
349 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
351 $Modifier = qr{(?:$Attribute|$Sparse)};
354 (?
:$Modifier\s
+|const\s
+)*
356 (?
:typeof
|__typeof__
)\s
*\
(\s
*\
**\s
*$Ident\s
*\
)|
360 (?
:\s
+$Modifier|\s
+const
)*
364 (?
:[\s\
*]+\s
*const
|[\s\
*]+|(?
:\s
*\
[\s
*\
])+)?
365 (?
:\s
+$Inline|\s
+$Modifier)*
367 $Declare = qr{(?:$Storage\s+)?$Type};
371 $chk_signoff = 0 if ($file);
378 my %git_commits = ();
380 open($HASH, "-|", "git", "log", "--reverse", "--no-merges", "--format=%H %s", $ARGV[0]) ||
381 die "$P: git log --reverse --no-merges --format='%H %s' $ARGV[0] failed - $!\n";
383 for my $line (<$HASH>) {
384 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
385 next if (!defined($1) || !defined($2));
388 push(@patches, $sha1);
389 $git_commits{$sha1} = $subject;
394 die "$P: no revisions returned for revlist '$ARGV[0]'\n"
398 my $num_patches = @patches;
399 for my $hash (@patches) {
401 open($FILE, '-|', "git",
402 "-c", "diff.renamelimit=0",
403 "-c", "diff.renames=True",
404 "-c", "diff.algorithm=histogram",
406 "--patch-with-stat", $hash) ||
407 die "$P: git show $hash - $!\n";
413 $vname = substr($hash, 0, 12) . ' (' . $git_commits{$hash} . ')';
414 if ($num_patches > 1 && $quiet == 0) {
415 my $prefix = "$i/$num_patches";
416 $prefix = BLUE
. BOLD
. $prefix . RESET
if $color;
417 print "$prefix Checking commit $vname\n";
418 $vname = "Patch $i/$num_patches";
420 $vname = "Commit " . $vname;
422 if (!process
($hash)) {
424 print "\n" if ($num_patches > 1 && $quiet == 0);
431 for my $filename (@ARGV) {
434 open($FILE, '-|', "diff -u /dev/null $filename") ||
435 die "$P: $filename: diff failed - $!\n";
436 } elsif ($filename eq '-') {
437 open($FILE, '<&STDIN');
439 open($FILE, '<', "$filename") ||
440 die "$P: $filename: open failed - $!\n";
442 if ($filename eq '-') {
443 $vname = 'Your patch';
447 print "Checking $filename...\n" if @ARGV > 1 && $quiet == 0;
453 if (!process
($filename)) {
463 sub top_of_kernel_tree
{
467 "COPYING", "MAINTAINERS", "Makefile",
468 "README.rst", "docs", "VERSION",
469 "linux-user", "softmmu"
472 foreach my $check (@tree_check) {
473 if (! -e
$root . '/' . $check) {
485 for my $c (split(//, $str)) {
489 for (; ($n % 8) != 0; $n++) {
501 (my $res = shift) =~ tr/\t/ /c;
508 # Drop the diff line leader and expand tabs
510 $line = expand_tabs
($line);
512 # Pick the indent from the front of the line.
513 my ($white) = ($line =~ /^(\s*)/);
515 return (length($line), length($white));
518 my $sanitise_quote = '';
520 sub sanitise_line_reset
{
521 my ($in_comment) = @_;
524 $sanitise_quote = '*/';
526 $sanitise_quote = '';
539 # Always copy over the diff marker.
540 $res = substr($line, 0, 1);
542 for ($off = 1; $off < length($line); $off++) {
543 $c = substr($line, $off, 1);
545 # Comments we are wacking completely including the begin
546 # and end, all to $;.
547 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
548 $sanitise_quote = '*/';
550 substr($res, $off, 2, "$;$;");
554 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
555 $sanitise_quote = '';
556 substr($res, $off, 2, "$;$;");
560 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
561 $sanitise_quote = '//';
563 substr($res, $off, 2, $sanitise_quote);
568 # A \ in a string means ignore the next character.
569 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
571 substr($res, $off, 2, 'XX');
576 if ($c eq "'" || $c eq '"') {
577 if ($sanitise_quote eq '') {
578 $sanitise_quote = $c;
580 substr($res, $off, 1, $c);
582 } elsif ($sanitise_quote eq $c) {
583 $sanitise_quote = '';
587 #print "c<$c> SQ<$sanitise_quote>\n";
588 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
589 substr($res, $off, 1, $;);
590 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
591 substr($res, $off, 1, $;);
592 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
593 substr($res, $off, 1, 'X');
595 substr($res, $off, 1, $c);
599 if ($sanitise_quote eq '//') {
600 $sanitise_quote = '';
603 # The pathname on a #include may be surrounded by '<' and '>'.
604 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
605 my $clean = 'X' x
length($1);
606 $res =~ s@\
<.*\
>@
<$clean>@
;
608 # The whole of a #error is a string.
609 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
610 my $clean = 'X' x
length($1);
611 $res =~ s@
(\#\s
*(?
:error
|warning
)\s
+).*@
$1$clean@
;
617 sub ctx_statement_block
{
618 my ($linenr, $remain, $off) = @_;
619 my $line = $linenr - 1;
636 @stack = (['', 0]) if ($#stack == -1);
638 #warn "CSB: blk<$blk> remain<$remain>\n";
639 # If we are about to drop off the end, pull in more
642 for (; $remain > 0; $line++) {
643 last if (!defined $lines[$line]);
644 next if ($lines[$line] =~ /^-/);
647 $blk .= $lines[$line] . "\n";
652 # Bail if there is no further context.
653 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
659 $c = substr($blk, $off, 1);
660 $remainder = substr($blk, $off);
662 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
664 # Handle nested #if/#else.
665 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
666 push(@stack, [ $type, $level ]);
667 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
668 ($type, $level) = @
{$stack[$#stack - 1]};
669 } elsif ($remainder =~ /^#\s*endif\b/) {
670 ($type, $level) = @
{pop(@stack)};
673 # Statement ends at the ';' or a close '}' at the
675 if ($level == 0 && $c eq ';') {
679 # An else is really a conditional as long as its not else if
680 if ($level == 0 && $coff_set == 0 &&
681 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
682 $remainder =~ /^(else)(?:\s|{)/ &&
683 $remainder !~ /^else\s+if\b/) {
684 $coff = $off + length($1) - 1;
686 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
687 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
690 if (($type eq '' || $type eq '(') && $c eq '(') {
694 if ($type eq '(' && $c eq ')') {
696 $type = ($level != 0)?
'(' : '';
698 if ($level == 0 && $coff < $soff) {
701 #warn "CSB: mark coff<$coff>\n";
704 if (($type eq '' || $type eq '{') && $c eq '{') {
708 if ($type eq '{' && $c eq '}') {
710 $type = ($level != 0)?
'{' : '';
713 if (substr($blk, $off + 1, 1) eq ';') {
721 # We are truly at the end, so shuffle to the next line.
728 my $statement = substr($blk, $soff, $off - $soff + 1);
729 my $condition = substr($blk, $soff, $coff - $soff + 1);
731 #warn "STATEMENT<$statement>\n";
732 #warn "CONDITION<$condition>\n";
734 #print "coff<$coff> soff<$off> loff<$loff>\n";
736 return ($statement, $condition,
737 $line, $remain + 1, $off - $loff + 1, $level);
740 sub statement_lines
{
743 # Strip the diff line prefixes and rip blank lines at start and end.
744 $stmt =~ s/(^|\n)./$1/g;
748 my @stmt_lines = ($stmt =~ /\n/g);
750 return $#stmt_lines + 2;
753 sub statement_rawlines
{
756 my @stmt_lines = ($stmt =~ /\n/g);
758 return $#stmt_lines + 2;
761 sub statement_block_size
{
764 $stmt =~ s/(^|\n)./$1/g;
770 my @stmt_lines = ($stmt =~ /\n/g);
771 my @stmt_statements = ($stmt =~ /;/g);
773 my $stmt_lines = $#stmt_lines + 2;
774 my $stmt_statements = $#stmt_statements + 1;
776 if ($stmt_lines > $stmt_statements) {
779 return $stmt_statements;
783 sub ctx_statement_full
{
784 my ($linenr, $remain, $off) = @_;
785 my ($statement, $condition, $level);
789 # Grab the first conditional/block pair.
790 ($statement, $condition, $linenr, $remain, $off, $level) =
791 ctx_statement_block
($linenr, $remain, $off);
792 #print "F: c<$condition> s<$statement> remain<$remain>\n";
793 push(@chunks, [ $condition, $statement ]);
794 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
795 return ($level, $linenr, @chunks);
798 # Pull in the following conditional/block pairs and see if they
799 # could continue the statement.
801 ($statement, $condition, $linenr, $remain, $off, $level) =
802 ctx_statement_block
($linenr, $remain, $off);
803 #print "C: c<$condition> s<$statement> remain<$remain>\n";
804 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
806 push(@chunks, [ $condition, $statement ]);
809 return ($level, $linenr, @chunks);
813 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
815 my $start = $linenr - 1;
822 my @stack = ($level);
823 for ($line = $start; $remain > 0; $line++) {
824 next if ($rawlines[$line] =~ /^-/);
827 $blk .= $rawlines[$line];
829 # Handle nested #if/#else.
830 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
831 push(@stack, $level);
832 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
833 $level = $stack[$#stack - 1];
834 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
835 $level = pop(@stack);
838 foreach my $c (split(//, $lines[$line])) {
839 ##print "C<$c>L<$level><$open$close>O<$off>\n";
845 if ($c eq $close && $level > 0) {
847 last if ($level == 0);
848 } elsif ($c eq $open) {
853 if (!$outer || $level <= 1) {
854 push(@res, $rawlines[$line]);
857 last if ($level == 0);
860 return ($level, @res);
862 sub ctx_block_outer
{
863 my ($linenr, $remain) = @_;
865 my ($level, @r) = ctx_block_get
($linenr, $remain, 1, '{', '}', 0);
869 my ($linenr, $remain) = @_;
871 my ($level, @r) = ctx_block_get
($linenr, $remain, 0, '{', '}', 0);
875 my ($linenr, $remain, $off) = @_;
877 my ($level, @r) = ctx_block_get
($linenr, $remain, 0, '(', ')', $off);
880 sub ctx_block_level
{
881 my ($linenr, $remain) = @_;
883 return ctx_block_get
($linenr, $remain, 0, '{', '}', 0);
885 sub ctx_statement_level
{
886 my ($linenr, $remain, $off) = @_;
888 return ctx_block_get
($linenr, $remain, 0, '(', ')', $off);
891 sub ctx_locate_comment
{
892 my ($first_line, $end_line) = @_;
894 # Catch a comment on the end of the line itself.
895 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@
.*(/\*.*\*/)\s
*(?
:\\\s
*)?
$@
);
896 return $current_comment if (defined $current_comment);
898 # Look through the context and try and figure out if there is a
901 $current_comment = '';
902 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
903 my $line = $rawlines[$linenr - 1];
905 if ($linenr == $first_line and $line =~ m@
^.\s
*\
*@
) {
908 if ($line =~ m@
/\
*@
) {
911 if (!$in_comment && $current_comment ne '') {
912 $current_comment = '';
914 $current_comment .= $line . "\n" if ($in_comment);
915 if ($line =~ m@\
*/@
) {
920 chomp($current_comment);
921 return($current_comment);
923 sub ctx_has_comment
{
924 my ($first_line, $end_line) = @_;
925 my $cmt = ctx_locate_comment
($first_line, $end_line);
927 ##print "LINE: $rawlines[$end_line - 1 ]\n";
928 ##print "CMMT: $cmt\n";
934 my ($linenr, $cnt) = @_;
936 my $offset = $linenr - 1;
941 $line = $rawlines[$offset++];
942 next if (defined($line) && $line =~ /^-/);
954 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
957 $coded = sprintf("^%c", unpack('C', $2) + 64);
966 my $av_preprocessor = 0;
972 $av_preprocessor = 0;
974 @av_paren_type = ('E');
975 $av_pend_colon = 'O';
978 sub annotate_values
{
979 my ($stream, $type) = @_;
982 my $var = '_' x
length($stream);
985 print "$stream\n" if ($dbg_values > 1);
987 while (length($cur)) {
988 @av_paren_type = ('E') if ($#av_paren_type < 0);
989 print " <" . join('', @av_paren_type) .
990 "> <$type> <$av_pending>" if ($dbg_values > 1);
991 if ($cur =~ /^(\s+)/o) {
992 print "WS($1)\n" if ($dbg_values > 1);
993 if ($1 =~ /\n/ && $av_preprocessor) {
994 $type = pop(@av_paren_type);
995 $av_preprocessor = 0;
998 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
999 print "CAST($1)\n" if ($dbg_values > 1);
1000 push(@av_paren_type, $type);
1003 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1004 print "DECLARE($1)\n" if ($dbg_values > 1);
1007 } elsif ($cur =~ /^($Modifier)\s*/) {
1008 print "MODIFIER($1)\n" if ($dbg_values > 1);
1011 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1012 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1013 $av_preprocessor = 1;
1014 push(@av_paren_type, $type);
1020 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1021 print "UNDEF($1)\n" if ($dbg_values > 1);
1022 $av_preprocessor = 1;
1023 push(@av_paren_type, $type);
1025 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1026 print "PRE_START($1)\n" if ($dbg_values > 1);
1027 $av_preprocessor = 1;
1029 push(@av_paren_type, $type);
1030 push(@av_paren_type, $type);
1033 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1034 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1035 $av_preprocessor = 1;
1037 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1041 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1042 print "PRE_END($1)\n" if ($dbg_values > 1);
1044 $av_preprocessor = 1;
1046 # Assume all arms of the conditional end as this
1047 # one does, and continue as if the #endif was not here.
1048 pop(@av_paren_type);
1049 push(@av_paren_type, $type);
1052 } elsif ($cur =~ /^(\\\n)/o) {
1053 print "PRECONT($1)\n" if ($dbg_values > 1);
1055 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1056 print "ATTR($1)\n" if ($dbg_values > 1);
1057 $av_pending = $type;
1060 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1061 print "SIZEOF($1)\n" if ($dbg_values > 1);
1067 } elsif ($cur =~ /^(if|while|for)\b/o) {
1068 print "COND($1)\n" if ($dbg_values > 1);
1072 } elsif ($cur =~/^(case)/o) {
1073 print "CASE($1)\n" if ($dbg_values > 1);
1074 $av_pend_colon = 'C';
1077 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1078 print "KEYWORD($1)\n" if ($dbg_values > 1);
1081 } elsif ($cur =~ /^(\()/o) {
1082 print "PAREN('$1')\n" if ($dbg_values > 1);
1083 push(@av_paren_type, $av_pending);
1087 } elsif ($cur =~ /^(\))/o) {
1088 my $new_type = pop(@av_paren_type);
1089 if ($new_type ne '_') {
1091 print "PAREN('$1') -> $type\n"
1092 if ($dbg_values > 1);
1094 print "PAREN('$1')\n" if ($dbg_values > 1);
1097 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1098 print "FUNC($1)\n" if ($dbg_values > 1);
1102 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1103 if (defined $2 && $type eq 'C' || $type eq 'T') {
1104 $av_pend_colon = 'B';
1105 } elsif ($type eq 'E') {
1106 $av_pend_colon = 'L';
1108 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1111 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1112 print "IDENT($1)\n" if ($dbg_values > 1);
1115 } elsif ($cur =~ /^($Assignment)/o) {
1116 print "ASSIGN($1)\n" if ($dbg_values > 1);
1119 } elsif ($cur =~/^(;|{|})/) {
1120 print "END($1)\n" if ($dbg_values > 1);
1122 $av_pend_colon = 'O';
1124 } elsif ($cur =~/^(,)/) {
1125 print "COMMA($1)\n" if ($dbg_values > 1);
1128 } elsif ($cur =~ /^(\?)/o) {
1129 print "QUESTION($1)\n" if ($dbg_values > 1);
1132 } elsif ($cur =~ /^(:)/o) {
1133 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1135 substr($var, length($res), 1, $av_pend_colon);
1136 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1141 $av_pend_colon = 'O';
1143 } elsif ($cur =~ /^(\[)/o) {
1144 print "CLOSE($1)\n" if ($dbg_values > 1);
1147 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1150 print "OPV($1)\n" if ($dbg_values > 1);
1157 substr($var, length($res), 1, $variant);
1160 } elsif ($cur =~ /^($Operators)/o) {
1161 print "OP($1)\n" if ($dbg_values > 1);
1162 if ($1 ne '++' && $1 ne '--') {
1166 } elsif ($cur =~ /(^.)/o) {
1167 print "C($1)\n" if ($dbg_values > 1);
1170 $cur = substr($cur, length($1));
1171 $res .= $type x
length($1);
1175 return ($res, $var);
1179 my ($possible, $line) = @_;
1180 my $notPermitted = qr{(?
:
1195 ^(?
:typedef
|struct
|enum
)\b|
1198 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1199 if ($possible !~ $notPermitted) {
1200 # Check for modifiers.
1201 $possible =~ s/\s*$Storage\s*//g;
1202 $possible =~ s/\s*$Sparse\s*//g;
1203 if ($possible =~ /^\s*$/) {
1205 } elsif ($possible =~ /\s/) {
1206 $possible =~ s/\s*(?:$Type|\#\#)\s*//g;
1207 for my $modifier (split(' ', $possible)) {
1208 if ($modifier !~ $notPermitted) {
1209 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1210 push(@modifierList, $modifier);
1215 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1216 push(@typeList, $possible);
1220 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1227 my ($level, $msg) = @_;
1228 if (defined $tst_only && $msg !~ /\Q$tst_only\E/) {
1233 $output .= BOLD
if $color;
1235 $output .= RED
if $color && $level eq 'ERROR';
1236 $output .= MAGENTA
if $color && $level eq 'WARNING';
1237 $output .= $level . ':';
1238 $output .= RESET
if $color;
1239 $output .= ' ' . $msg . "\n";
1241 $output = (split('\n', $output))[0] . "\n" if ($terse);
1243 push(our @report, $output);
1251 if (report
("ERROR", $_[0])) {
1257 if (report
("WARNING", $_[0])) {
1263 # According to tests/qtest/bios-tables-test.c: do not
1264 # change expected file in the same commit with adding test
1266 my ($name, $acpi_testexpected, $acpi_nontestexpected) = @_;
1268 # Note: shell script that rebuilds the expected files is in the same
1269 # directory as files themselves.
1270 # Note: allowed diff list can be changed both when changing expected
1271 # files and when changing tests.
1272 if ($name =~ m
#^tests/data/acpi/# and not $name =~ m#^\.sh$#) {
1273 $$acpi_testexpected = $name;
1274 } elsif ($name !~ m
#^tests/qtest/bios-tables-test-allowed-diff.h$#) {
1275 $$acpi_nontestexpected = $name;
1277 if (defined $$acpi_testexpected and defined $$acpi_nontestexpected) {
1278 ERROR
("Do not add expected files together with tests, " .
1279 "follow instructions in " .
1280 "tests/qtest/bios-tables-test.c: both " .
1281 $$acpi_testexpected . " and " .
1282 $$acpi_nontestexpected . " found\n");
1287 my $filename = shift;
1293 my $stashrawline="";
1304 my $in_header_lines = $file ?
0 : 1;
1305 my $in_commit_log = 0; #Scanning lines before patch
1306 my $reported_maintainer_file = 0;
1307 my $non_utf8_charset = 0;
1315 # Trace the real file/line as we go.
1321 my $comment_edge = 0;
1325 my $prev_values = 'E';
1328 my %suppress_ifbraces;
1329 my %suppress_whiletrailers;
1330 my %suppress_export;
1332 my $acpi_testexpected;
1333 my $acpi_nontestexpected;
1335 # Pre-scan the patch sanitizing the lines.
1337 sanitise_line_reset
();
1339 foreach my $rawline (@rawlines) {
1343 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1352 # Guestimate if this is a continuing comment. Run
1353 # the context looking for a comment "edge". If this
1354 # edge is a close comment then we must be in a comment
1358 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1359 next if (defined $rawlines[$ln - 1] &&
1360 $rawlines[$ln - 1] =~ /^-/);
1362 #print "RAW<$rawlines[$ln - 1]>\n";
1363 last if (!defined $rawlines[$ln - 1]);
1364 if ($rawlines[$ln - 1] =~ m@
(/\*|\*/)@
&&
1365 $rawlines[$ln - 1] !~ m@
"[^"]*(?
:/\*|\*/)[^"]*"@
) {
1370 if (defined $edge && $edge eq '*/') {
1374 # Guestimate if this is a continuing comment. If this
1375 # is the start of a diff block and this line starts
1376 # ' *' then it is very likely a comment.
1377 if (!defined $edge &&
1378 $rawlines[$linenr] =~ m@
^.\s
*(?
:\
*\
*+| \
*)(?
:\s
|$)@
)
1383 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1384 sanitise_line_reset
($in_comment);
1386 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1387 # Standardise the strings and chars within the input to
1388 # simplify matching -- only bother with positive lines.
1389 $line = sanitise_line
($rawline);
1391 push(@lines, $line);
1394 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1399 #print "==>$rawline\n";
1400 #print "-->$line\n";
1407 foreach my $line (@lines) {
1410 my $rawline = $rawlines[$linenr - 1];
1412 #extract the line range in the file after the patch is applied
1413 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1415 $first_line = $linenr + 1;
1425 %suppress_ifbraces = ();
1426 %suppress_whiletrailers = ();
1427 %suppress_export = ();
1430 # track the line number as we move through the hunk, note that
1431 # new versions of GNU diff omit the leading space on completely
1432 # blank context lines so we need to count that too.
1433 } elsif ($line =~ /^( |\+|$)/) {
1435 $realcnt-- if ($realcnt != 0);
1437 # Measure the line length and indent.
1438 ($length, $indent) = line_stats
($rawline);
1440 # Track the previous line.
1441 ($prevline, $stashline) = ($stashline, $line);
1442 ($previndent, $stashindent) = ($stashindent, $indent);
1443 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1445 #warn "line<$line>\n";
1447 } elsif ($realcnt == 1) {
1451 my $hunk_line = ($realcnt != 0);
1453 #make up the handle for any error we report on this line
1454 $prefix = "$filename:$realline: " if ($emacs && $file);
1455 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1457 $here = "#$linenr: " if (!$file);
1458 $here = "#$realline: " if ($file);
1460 # extract the filename as it passes
1461 if ($line =~ /^diff --git.*?(\S+)$/) {
1463 $realfile =~ s@
^([^/]*)/@@
if (!$file);
1464 checkfilename
($realfile, \
$acpi_testexpected, \
$acpi_nontestexpected);
1465 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
1467 $realfile =~ s@
^([^/]*)/@@
if (!$file);
1468 checkfilename
($realfile, \
$acpi_testexpected, \
$acpi_nontestexpected);
1471 if (!$file && $tree && $p1_prefix ne '' &&
1472 -e
"$root/$p1_prefix") {
1473 WARN
("patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1479 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
1481 my $hereline = "$here\n$rawline\n";
1482 my $herecurr = "$here\n$rawline\n";
1483 my $hereprev = "$here\n$prevrawline\n$rawline\n";
1485 $cnt_lines++ if ($realcnt != 0);
1487 # Check for incorrect file permissions
1488 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1489 my $permhere = $here . "FILE: $realfile\n";
1490 if ($realfile =~ /(\bMakefile(?:\.objs)?|\.c|\.cc|\.cpp|\.h|\.mak|\.[sS])$/) {
1491 ERROR
("do not set execute permissions for source files\n" . $permhere);
1495 # Only allow Python 3 interpreter
1496 if ($realline == 1 &&
1497 $line =~ /^\+#!\ *\/usr\
/bin\/(?
:env
)?python
$/) {
1498 ERROR
("please use python3 interpreter\n" . $herecurr);
1501 # Accept git diff extended headers as valid patches
1502 if ($line =~ /^(?:rename|copy) (?:from|to) [\w\/\
.\
-]+\s
*$/) {
1506 if ($line =~ /^(Author|From): .* via .*<qemu-devel\@nongnu.org>/) {
1507 ERROR
("Author email address is mangled by the mailing list\n" . $herecurr);
1510 #check the patch for a signoff:
1511 if ($line =~ /^\s*signed-off-by:/i) {
1512 # This is a signoff, if ugly, so do not double report.
1516 if (!($line =~ /^\s*Signed-off-by:/)) {
1517 ERROR
("The correct form is \"Signed-off-by\"\n" .
1520 if ($line =~ /^\s*signed-off-by:\S/i) {
1521 ERROR
("space required after Signed-off-by:\n" .
1526 # Check if MAINTAINERS is being updated. If so, there's probably no need to
1527 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
1528 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
1529 $reported_maintainer_file = 1;
1532 # Check for added, moved or deleted files
1533 if (!$reported_maintainer_file && !$in_commit_log &&
1534 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
1535 $line =~ /^rename (?:from|to) [\w\/\
.\
-]+\s
*$/ ||
1536 ($line =~ /\{\s*([\w\/\
.\
-]*)\s
*\
=\
>\s
*([\w\
/\.\-]*)\s*\}/ &&
1537 (defined($1) || defined($2)))) &&
1538 !(($realfile ne '') &&
1539 defined($acpi_testexpected) &&
1540 ($realfile eq $acpi_testexpected))) {
1541 $reported_maintainer_file = 1;
1542 WARN
("added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
1545 # Check for wrappage within a valid hunk of the file
1546 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1547 ERROR
("patch seems to be corrupt (line wrapped?)\n" .
1548 $herecurr) if (!$emitted_corrupt++);
1551 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1552 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1553 $rawline !~ m/^$UTF8*$/) {
1554 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1556 my $blank = copy_spacing
($rawline);
1557 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1558 my $hereptr = "$hereline$ptr\n";
1560 ERROR
("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1563 if ($rawline =~ m/$UTF8_MOJIBAKE/) {
1564 ERROR
("Doubly-encoded UTF-8\n" . $herecurr);
1566 # Check if it's the start of a commit log
1567 # (not a header line and we haven't seen the patch filename)
1568 if ($in_header_lines && $realfile =~ /^$/ &&
1569 !($rawline =~ /^\s+\S/ ||
1570 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
1571 $in_header_lines = 0;
1575 # Check if there is UTF-8 in a commit log when a mail header has explicitly
1576 # declined it, i.e defined some charset where it is missing.
1577 if ($in_header_lines &&
1578 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
1580 $non_utf8_charset = 1;
1583 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
1584 $rawline =~ /$NON_ASCII_UTF8/) {
1585 WARN
("8-bit UTF-8 used in possible commit log\n" . $herecurr);
1588 # ignore non-hunk lines and lines being removed
1589 next if (!$hunk_line || $line =~ /^-/);
1591 # ignore files that are being periodically imported from Linux
1592 next if ($realfile =~ /^(linux-headers|include\/standard
-headers
)\
//);
1594 #trailing whitespace
1595 if ($line =~ /^\+.*\015/) {
1596 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
1597 ERROR
("DOS line endings\n" . $herevet);
1599 } elsif ($realfile =~ /^docs\/.+\
.txt
/ ||
1600 $realfile =~ /^docs\/.+\
.md
/) {
1601 if ($rawline =~ /^\+\s+$/ && $rawline !~ /^\+ {4}$/) {
1602 # TODO: properly check we're in a code block
1603 # (surrounding text is 4-column aligned)
1604 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
1605 ERROR
("code blocks in documentation should have " .
1606 "empty lines with exactly 4 columns of " .
1607 "whitespace\n" . $herevet);
1609 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1610 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
1611 ERROR
("trailing whitespace\n" . $herevet);
1615 # checks for trace-events files
1616 if ($realfile =~ /trace-events$/ && $line =~ /^\+/) {
1617 if ($rawline =~ /%[-+ 0]*#/) {
1618 ERROR
("Don't use '#' flag of printf format ('%#') in " .
1619 "trace-events, use '0x' prefix instead\n" . $herecurr);
1622 qr/%[-+ *.0-9]*([hljztL]|ll|hh)?(x|X|"\s*PRI[xX][^"]*"?)/;
1624 # don't consider groups split by [.:/ ], like 2A.20:12ab
1625 my $tmpline = $rawline;
1626 $tmpline =~ s/($hex[.:\/ ])+$hex//g
;
1628 if ($tmpline =~ /(?<!0x)$hex/) {
1629 ERROR
("Hex numbers must be prefixed with '0x'\n" .
1635 # check we are in a valid source file if not then ignore this hunk
1636 next if ($realfile !~ /$SrcFile/);
1638 #90 column limit; exempt URLs, if no other words on line
1639 if ($line =~ /^\+/ &&
1640 !($line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
1641 !($rawline =~ /^[^[:alnum:]]*https?:\S*$/) &&
1645 ERROR
("line over 90 characters\n" . $herecurr);
1647 WARN
("line over 80 characters\n" . $herecurr);
1651 # check for spaces before a quoted newline
1652 if ($rawline =~ /^.*\".*\s\\n/) {
1653 ERROR
("unnecessary whitespace before a quoted newline\n" . $herecurr);
1656 # check for adding lines without a newline.
1657 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1658 ERROR
("adding a line without newline at end of file\n" . $herecurr);
1661 # check for RCS/CVS revision markers
1662 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|\b)/) {
1663 ERROR
("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1666 # tabs are only allowed in assembly source code, and in
1667 # some scripts we imported from other projects.
1668 next if ($realfile =~ /\.(s|S)$/);
1669 next if ($realfile =~ /(checkpatch|get_maintainer)\.pl$/);
1670 next if ($realfile =~ /^target\/hexagon\
/imported\/*/);
1672 if ($rawline =~ /^\+.*\t/) {
1673 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
1674 ERROR
("code indent should never use tabs\n" . $herevet);
1678 # check we are in a valid C source file if not then ignore this hunk
1679 next if ($realfile !~ /\.((h|c)(\.inc)?|cpp)$/);
1681 # Block comment styles
1683 # Block comments use /* on a line of its own
1684 my $commentline = $rawline;
1685 while ($commentline =~ s@
^(\
+.*)/\*.*\*/@
$1@o) { # remove inline /*...*/
1687 if ($commentline =~ m@
^\
+.*/\*\*?+[ \t]*[^ \t]@) { # /* or /** non
-blank
1688 WARN
("Block comments use a leading /* on a separate line\n" . $herecurr);
1691 # Block comments use * on subsequent lines
1692 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
1693 $prevrawline =~ /^\+.*?\/\
*/ && #starting /*
1694 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
1695 $rawline =~ /^\+/ && #line is new
1696 $rawline !~ /^\+[ \t]*\*/) { #no leading *
1697 WARN
("Block comments use * on subsequent lines\n" . $hereprev);
1700 # Block comments use */ on trailing lines
1701 if ($rawline !~ m@
^\
+[ \t]*\
*/[ \t]*$@ && #trailing */
1702 $rawline !~ m@
^\
+.*/\*.*\*/[ \t]*$@
&& #inline /*...*/
1703 $rawline !~ m@
^\
+.*\
*{2,}/[ \t]*$@ && #trailing **/
1704 $rawline =~ m@
^\
+[ \t]*.+\
*\
/[ \t]*$@) { #non blank */
1705 WARN
("Block comments use a trailing */ on a separate line\n" . $herecurr);
1708 # Block comment * alignment
1709 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
1710 $line =~ /^\+[ \t]*$;/ && #leading comment
1711 $rawline =~ /^\+[ \t]*\*/ && #leading *
1712 (($prevrawline =~ /^\+.*?\/\
*/ && #leading /*
1713 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
1714 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
1716 $prevrawline =~ m@
^\
+([ \t]*/?
)\
*@
;
1718 $oldindent = expand_tabs
($1);
1720 $prevrawline =~ m@
^\
+(.*/?
)\
*@
;
1721 $oldindent = expand_tabs
($1);
1723 $rawline =~ m@
^\
+([ \t]*)\
*@
;
1725 $newindent = expand_tabs
($newindent);
1726 if (length($oldindent) ne length($newindent)) {
1727 WARN
("Block comments should align the * on each line\n" . $hereprev);
1731 # Check for potential 'bare' types
1732 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
1734 if ($realcnt && $line =~ /.\s*\S/) {
1735 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
1736 ctx_statement_block
($linenr, $realcnt, 0);
1737 $stat =~ s/\n./\n /g;
1738 $cond =~ s/\n./\n /g;
1740 # Find the real next line.
1741 $realline_next = $line_nr_next;
1742 if (defined $realline_next &&
1743 (!defined $lines[$realline_next - 1] ||
1744 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
1751 # Ignore goto labels.
1752 if ($s =~ /$Ident:\*$/s) {
1754 # Ignore functions being called
1755 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
1757 } elsif ($s =~ /^.\s*else\b/s) {
1759 # declarations always start with types
1760 } 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) {
1763 possible
($type, "A:" . $s);
1765 # definitions in global scope can only start with types
1766 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
1767 possible
($1, "B:" . $s);
1770 # any (foo ... *) is a pointer cast, and foo is a type
1771 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
1772 possible
($1, "C:" . $s);
1775 # Check for any sort of function declaration.
1776 # int foo(something bar, other baz);
1777 # void (*store_gdt)(x86_descr_ptr *);
1778 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
1779 my ($name_len) = length($1);
1782 substr($ctx, 0, $name_len + 1, '');
1783 $ctx =~ s/\)[^\)]*$//;
1785 for my $arg (split(/\s*,\s*/, $ctx)) {
1786 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
1788 possible
($1, "D:" . $s);
1796 # Checks which may be anchored in the context.
1799 # Check for switch () and associated case and default
1800 # statements should be at the same indent.
1801 if ($line=~/\bswitch\s*\(.*\)/) {
1804 my @ctx = ctx_block_outer
($linenr, $realcnt);
1806 for my $ctx (@ctx) {
1807 my ($clen, $cindent) = line_stats
($ctx);
1808 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1809 $indent != $cindent) {
1810 $err .= "$sep$ctx\n";
1817 ERROR
("switch and case should be at the same indent\n$hereline$err");
1821 # if/while/etc brace do not go on next line, unless defining a do while loop,
1822 # or if that brace on the next line is for something else
1823 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
1824 my $pre_ctx = "$1$2";
1826 my ($level, @ctx) = ctx_statement_level
($linenr, $realcnt, 0);
1827 my $ctx_cnt = $realcnt - $#ctx - 1;
1828 my $ctx = join("\n", @ctx);
1830 my $ctx_ln = $linenr;
1831 my $ctx_skip = $realcnt;
1833 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1834 defined $lines[$ctx_ln - 1] &&
1835 $lines[$ctx_ln - 1] =~ /^-/)) {
1836 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1837 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
1841 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1842 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
1844 # The length of the "previous line" is checked against 80 because it
1845 # includes the + at the beginning of the line (if the actual line has
1846 # 79 or 80 characters, it is no longer possible to add a space and an
1847 # opening brace there)
1848 if ($#ctx == 0 && $ctx !~ /{\s*/ &&
1849 defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*\{/ &&
1850 defined($lines[$ctx_ln - 2]) && length($lines[$ctx_ln - 2]) < 80) {
1851 ERROR
("that open brace { should be on the previous line\n" .
1852 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
1854 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1855 $ctx =~ /\)\s*\;\s*$/ &&
1856 defined $lines[$ctx_ln - 1])
1858 my ($nlength, $nindent) = line_stats
($lines[$ctx_ln - 1]);
1859 if ($nindent > $indent) {
1860 ERROR
("trailing semicolon indicates no statements, indent implies otherwise\n" .
1861 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
1866 # 'do ... while (0/false)' only makes sense in macros, without trailing ';'
1867 if ($line =~ /while\s*\((0|false)\);/) {
1868 ERROR
("suspicious ; after while (0)\n" . $herecurr);
1871 # Check superfluous trailing ';'
1872 if ($line =~ /;;$/) {
1873 ERROR
("superfluous trailing semicolon\n" . $herecurr);
1876 # Check relative indent for conditionals and blocks.
1877 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1878 my ($s, $c) = ($stat, $cond);
1880 substr($s, 0, length($c), '');
1882 # Make sure we remove the line prefixes as we have
1883 # none on the first line, and are going to re-add them
1887 # Find out how long the conditional actually is.
1888 my @newlines = ($c =~ /\n/gs);
1889 my $cond_lines = 1 + $#newlines;
1891 # We want to check the first line inside the block
1892 # starting at the end of the conditional, so remove:
1893 # 1) any blank line termination
1894 # 2) any opening brace { on end of the line
1896 my $continuation = 0;
1898 $s =~ s/^.*\bdo\b//;
1900 if ($s =~ s/^\s*\\//) {
1903 if ($s =~ s/^\s*?\n//) {
1908 # Also ignore a loop construct at the end of a
1909 # preprocessor statement.
1910 if (($prevline =~ /^.\s*#\s*define\s/ ||
1911 $prevline =~ /\\\s*$/) && $continuation == 0) {
1917 while ($cond_ptr != $cond_lines) {
1918 $cond_ptr = $cond_lines;
1920 # If we see an #else/#elif then the code
1922 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
1927 # 1) blank lines, they should be at 0,
1928 # 2) preprocessor lines, and
1930 if ($continuation ||
1932 $s =~ /^\s*#\s*?/ ||
1933 $s =~ /^\s*$Ident\s*:/) {
1934 $continuation = ($s =~ /^.*?\\\n/) ?
1 : 0;
1935 if ($s =~ s/^.*?\n//) {
1941 my (undef, $sindent) = line_stats
("+" . $s);
1942 my $stat_real = raw_line
($linenr, $cond_lines);
1944 # Check if either of these lines are modified, else
1945 # this is not this patch's fault.
1946 if (!defined($stat_real) ||
1947 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
1950 if (defined($stat_real) && $cond_lines > 1) {
1951 $stat_real = "[...]\n$stat_real";
1954 #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";
1956 if ($check && (($sindent % 4) != 0 ||
1957 ($sindent <= $indent && $s ne ''))) {
1958 ERROR
("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
1962 # Track the 'values' across context and added lines.
1963 my $opline = $line; $opline =~ s/^./ /;
1964 my ($curr_values, $curr_vars) =
1965 annotate_values
($opline . "\n", $prev_values);
1966 $curr_values = $prev_values . $curr_values;
1968 my $outline = $opline; $outline =~ s/\t/ /g;
1969 print "$linenr > .$outline\n";
1970 print "$linenr > $curr_values\n";
1971 print "$linenr > $curr_vars\n";
1973 $prev_values = substr($curr_values, -1);
1975 #ignore lines not being added
1976 if ($line=~/^[^\+]/) {next;}
1978 # TEST: allow direct testing of the type matcher.
1980 if ($line =~ /^.\s*$Declare\s*$/) {
1981 ERROR
("TEST: is type\n" . $herecurr);
1982 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
1983 ERROR
("TEST: is not type ($1 is)\n". $herecurr);
1987 # TEST: allow direct testing of the attribute matcher.
1989 if ($line =~ /^.\s*$Modifier\s*$/) {
1990 ERROR
("TEST: is attr\n" . $herecurr);
1991 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
1992 ERROR
("TEST: is not attr ($1 is)\n". $herecurr);
1997 # check for initialisation to aggregates open brace on the next line
1998 if ($line =~ /^.\s*\{/ &&
1999 $prevline =~ /(?:^|[^=])=\s*$/) {
2000 ERROR
("that open brace { should be on the previous line\n" . $hereprev);
2004 # Checks which are anchored on the added line.
2007 # check for malformed paths in #include statements (uses RAW line)
2008 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
2010 if ($path =~ m{//}) {
2011 ERROR
("malformed #include filename\n" .
2016 # no C99 // comments
2017 if ($line =~ m{//} &&
2018 $rawline !~ m{// SPDX-License-Identifier: }) {
2019 ERROR
("do not use C99 // comments\n" . $herecurr);
2021 # Remove C99 comments.
2023 $opline =~ s@
//.*@@
;
2025 # check for global initialisers.
2026 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
2027 ERROR
("do not initialise globals to 0 or NULL\n" .
2030 # check for static initialisers.
2031 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2032 ERROR
("do not initialise statics to 0 or NULL\n" .
2036 # * goes on variable not on type
2038 if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) {
2039 my ($from, $to) = ($1, $1);
2041 # Should start with a space.
2042 $to =~ s/^(\S)/ $1/;
2043 # Should not end with a space.
2045 # '*'s should not have spaces between.
2046 while ($to =~ s/\*\s+\*/\*\*/) {
2049 #print "from<$from> to<$to>\n";
2051 ERROR
("\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr);
2053 } elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) {
2054 my ($from, $to, $ident) = ($1, $1, $2);
2056 # Should start with a space.
2057 $to =~ s/^(\S)/ $1/;
2058 # Should not end with a space.
2060 # '*'s should not have spaces between.
2061 while ($to =~ s/\*\s+\*/\*\*/) {
2063 # Modifiers should have spaces.
2064 $to =~ s/(\b$Modifier$)/$1 /;
2066 #print "from<$from> to<$to> ident<$ident>\n";
2067 if ($from ne $to && $ident !~ /^$Modifier$/) {
2068 ERROR
("\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr);
2072 # function brace can't be on same line, except for #defines of do while,
2073 # or if closed on same line
2074 if (($line=~/$Type\s*$Ident\(.*\).*\s\{/) and
2075 !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) {
2076 ERROR
("open brace '{' following function declarations go on the next line\n" . $herecurr);
2079 # open braces for enum, union and struct go on the same line.
2080 if ($line =~ /^.\s*\{/ &&
2081 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
2082 ERROR
("open brace '{' following $1 go on the same line\n" . $hereprev);
2085 # missing space after union, struct or enum definition
2086 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) {
2087 ERROR
("missing space after $1 definition\n" . $herecurr);
2090 # check for spacing round square brackets; allowed:
2091 # 1. with a type on the left -- int [] a;
2092 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2093 # 3. inside a curly brace -- = { [0...10] = 5 }
2094 # 4. after a comma -- [1] = 5, [2] = 6
2095 # 5. in a macro definition -- #define abc(x) [x] = y
2096 while ($line =~ /(.*?\s)\[/g) {
2097 my ($where, $prefix) = ($-[1], $1);
2098 if ($prefix !~ /$Type\s+$/ &&
2099 ($where != 0 || $prefix !~ /^.\s+$/) &&
2100 $prefix !~ /\#\s*define[^(]*\([^)]*\)\s+$/ &&
2101 $prefix !~ /[,{:]\s+$/) {
2102 ERROR
("space prohibited before open square bracket '['\n" . $herecurr);
2106 # check for spaces between functions and their parentheses.
2107 while ($line =~ /($Ident)\s+\(/g) {
2109 my $ctx_before = substr($line, 0, $-[1]);
2110 my $ctx = "$ctx_before$name";
2112 # Ignore those directives where spaces _are_ permitted.
2114 if|for|while|switch
|return|case
|
2115 volatile
|__volatile__
|coroutine_fn
|
2116 __attribute__
|format
|__extension__
|
2120 # Ignore 'catch (...)' in C++
2121 } elsif ($name =~ /^catch$/ && $realfile =~ /(\.cpp|\.h)$/) {
2123 # cpp #define statements have non-optional spaces, ie
2124 # if there is a space between the name and the open
2125 # parenthesis it is simply not a parameter group.
2126 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
2128 # cpp #elif statement condition may start with a (
2129 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
2131 # If this whole things ends with a type its most
2132 # likely a typedef for a function.
2133 } elsif ($ctx =~ /$Type$/) {
2136 ERROR
("space prohibited between function name and open parenthesis '('\n" . $herecurr);
2139 # Check operator spacing.
2140 if (!($line=~/\#\s*include/)) {
2142 <<=|>>=|<=|>=|==|!=|
2143 \
+=|-=|\
*=|\
/=|%=|\
^=|\
|=|&=|
2144 =>|->|<<|>>|<|>|=|!|~|
2145 &&|\
|\
||,|\
^|\
+\
+|--|&|\
||\
+|-|\
*|\
/|%|
2148 my @elements = split(/($ops|;)/, $opline);
2151 my $blank = copy_spacing
($opline);
2153 for (my $n = 0; $n < $#elements; $n += 2) {
2154 $off += length($elements[$n]);
2156 # Pick up the preceding and succeeding characters.
2157 my $ca = substr($opline, 0, $off);
2159 if (length($opline) >= ($off + length($elements[$n + 1]))) {
2160 $cc = substr($opline, $off + length($elements[$n + 1]));
2162 my $cb = "$ca$;$cc";
2165 $a = 'V' if ($elements[$n] ne '');
2166 $a = 'W' if ($elements[$n] =~ /\s$/);
2167 $a = 'C' if ($elements[$n] =~ /$;$/);
2168 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
2169 $a = 'O' if ($elements[$n] eq '');
2170 $a = 'E' if ($ca =~ /^\s*$/);
2172 my $op = $elements[$n + 1];
2175 if (defined $elements[$n + 2]) {
2176 $c = 'V' if ($elements[$n + 2] ne '');
2177 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
2178 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
2179 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
2180 $c = 'O' if ($elements[$n + 2] eq '');
2181 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
2186 my $ctx = "${a}x${c}";
2188 my $at = "(ctx:$ctx)";
2190 my $ptr = substr($blank, 0, $off) . "^";
2191 my $hereptr = "$hereline$ptr\n";
2193 # Pull out the value of this operator.
2194 my $op_type = substr($curr_values, $off + 1, 1);
2196 # Get the full operator variant.
2197 my $opv = $op . substr($curr_vars, $off, 1);
2199 # Ignore operators passed as parameters.
2200 if ($op_type ne 'V' &&
2201 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
2204 # } elsif ($op =~ /^$;+$/) {
2206 # ; should have either the end of line or a space or \ after it
2207 } elsif ($op eq ';') {
2208 if ($ctx !~ /.x[WEBC]/ &&
2209 $cc !~ /^\\/ && $cc !~ /^;/) {
2210 ERROR
("space required after that '$op' $at\n" . $hereptr);
2214 } elsif ($op eq '//') {
2216 # Ignore : used in class declaration in C++
2217 } elsif ($opv eq ':B' && $ctx =~ /Wx[WE]/ &&
2218 $line =~ /class/ && $realfile =~ /(\.cpp|\.h)$/) {
2222 # : when part of a bitfield
2223 } elsif ($op eq '->' || $opv eq ':B') {
2224 if ($ctx =~ /Wx.|.xW/) {
2225 ERROR
("spaces prohibited around that '$op' $at\n" . $hereptr);
2228 # , must have a space on the right.
2229 # not required when having a single },{ on one line
2230 } elsif ($op eq ',') {
2231 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/ &&
2232 ($elements[$n] . $elements[$n + 2]) !~ " *}\\{") {
2233 ERROR
("space required after that '$op' $at\n" . $hereptr);
2236 # '*' as part of a type definition -- reported already.
2237 } elsif ($opv eq '*_') {
2238 #warn "'*' is part of type\n";
2240 # unary operators should have a space before and
2241 # none after. May be left adjacent to another
2242 # unary operator, or a cast
2243 } elsif ($op eq '!' || $op eq '~' ||
2244 $opv eq '*U' || $opv eq '-U' ||
2245 $opv eq '&U' || $opv eq '&&U') {
2246 if ($op eq '~' && $ca =~ /::$/ && $realfile =~ /(\.cpp|\.h)$/) {
2247 # '~' used as a name of Destructor
2249 } elsif ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
2250 ERROR
("space required before that '$op' $at\n" . $hereptr);
2252 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
2253 # A unary '*' may be const
2255 } elsif ($ctx =~ /.xW/) {
2256 ERROR
("space prohibited after that '$op' $at\n" . $hereptr);
2259 # unary ++ and unary -- are allowed no space on one side.
2260 } elsif ($op eq '++' or $op eq '--') {
2261 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
2262 ERROR
("space required one side of that '$op' $at\n" . $hereptr);
2264 if ($ctx =~ /Wx[BE]/ ||
2265 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
2266 ERROR
("space prohibited before that '$op' $at\n" . $hereptr);
2268 if ($ctx =~ /ExW/) {
2269 ERROR
("space prohibited after that '$op' $at\n" . $hereptr);
2272 # A colon needs no spaces before when it is
2273 # terminating a case value or a label.
2274 } elsif ($opv eq ':C' || $opv eq ':L') {
2275 if ($ctx =~ /Wx./) {
2276 ERROR
("space prohibited before that '$op' $at\n" . $hereptr);
2279 # All the others need spaces both sides.
2280 } elsif ($ctx !~ /[EWC]x[CWE]/) {
2283 if ($realfile =~ /\.cpp|\.h$/) {
2284 # Ignore template arguments <...> in C++
2285 if (($op eq '<' || $op eq '>') && $line =~ /<.*>/) {
2295 # Ignore email addresses <foo@bar>
2297 $cc =~ /^\S+\@\S+>/) ||
2299 $ca =~ /<\S+\@\S+$/))
2305 if (($opv eq ':O' && $ca =~ /\?$/) ||
2306 ($op eq '?' && $cc =~ /^:/)) {
2311 ERROR
("spaces required around that '$op' $at\n" . $hereptr);
2314 $off += length($elements[$n + 1]);
2318 #need space before brace following if, while, etc
2319 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
2321 ERROR
("space required before the open brace '{'\n" . $herecurr);
2324 # closing brace should have a space following it when it has anything
2326 if ($line =~ /}(?!(?:,|;|\)))\S/) {
2327 ERROR
("space required after that close brace '}'\n" . $herecurr);
2330 # check spacing on square brackets
2331 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
2332 ERROR
("space prohibited after that open square bracket '['\n" . $herecurr);
2334 if ($line =~ /\s\]/) {
2335 ERROR
("space prohibited before that close square bracket ']'\n" . $herecurr);
2338 # check spacing on parentheses
2339 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
2340 $line !~ /for\s*\(\s+;/) {
2341 ERROR
("space prohibited after that open parenthesis '('\n" . $herecurr);
2343 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
2344 $line !~ /for\s*\(.*;\s+\)/ &&
2345 $line !~ /:\s+\)/) {
2346 ERROR
("space prohibited before that close parenthesis ')'\n" . $herecurr);
2349 # Return is not a function.
2350 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2354 # Flatten any parentheses
2355 $value =~ s/\(/ \(/g;
2356 $value =~ s/\)/\) /g;
2357 while ($value =~ s/\[[^\{\}]*\]/1/ ||
2358 $value !~ /(?
:$Ident|-?
$Constant)\s
*
2360 (?
:$Ident|-?
$Constant)/x
&&
2361 $value =~ s/\([^\(\)]*\)/1/) {
2363 #print "value<$value>\n";
2364 if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/ &&
2366 ERROR
("return is not a function, parentheses are not required\n" . $herecurr);
2368 } elsif ($spacing !~ /\s+/) {
2369 ERROR
("space required before the open parenthesis '('\n" . $herecurr);
2372 # Return of what appears to be an errno should normally be -'ve
2373 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
2375 if ($name ne 'EOF' && $name ne 'ERROR') {
2376 ERROR
("return of an errno should typically be -ve (return -$1)\n" . $herecurr);
2380 if ($line =~ /^.\s*(Q(?:S?LIST|SIMPLEQ|TAILQ)_HEAD)\s*\(\s*[^,]/ &&
2381 $line !~ /^.typedef/) {
2382 ERROR
("named $1 should be typedefed separately\n" . $herecurr);
2385 # Need a space before open parenthesis after if, while etc
2386 if ($line=~/\b(if|while|for|switch)\(/) {
2387 ERROR
("space required before the open parenthesis '('\n" . $herecurr);
2390 # Check for illegal assignment in if conditional -- and check for trailing
2391 # statements after the conditional.
2392 if ($line =~ /do\s*(?!{)/) {
2393 my ($stat_next) = ctx_statement_block
($line_nr_next,
2394 $remain_next, $off_next);
2395 $stat_next =~ s/\n./\n /g;
2396 ##print "stat<$stat> stat_next<$stat_next>\n";
2398 if ($stat_next =~ /^\s*while\b/) {
2399 # If the statement carries leading newlines,
2400 # then count those as offsets.
2402 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2404 statement_rawlines
($whitespace) - 1;
2406 $suppress_whiletrailers{$line_nr_next +
2410 if (!defined $suppress_whiletrailers{$linenr} &&
2411 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
2412 my ($s, $c) = ($stat, $cond);
2414 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
2415 ERROR
("do not use assignment in if condition\n" . $herecurr);
2418 # Find out what is on the end of the line after the
2420 substr($s, 0, length($c), '');
2422 $s =~ s/$;//g; # Remove any comments
2423 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2424 $c !~ /}\s*while\s*/)
2426 # Find out how long the conditional actually is.
2427 my @newlines = ($c =~ /\n/gs);
2428 my $cond_lines = 1 + $#newlines;
2431 $stat_real = raw_line
($linenr, $cond_lines)
2432 . "\n" if ($cond_lines);
2433 if (defined($stat_real) && $cond_lines > 1) {
2434 $stat_real = "[...]\n$stat_real";
2437 ERROR
("trailing statements should be on next line\n" . $herecurr . $stat_real);
2441 # Check for bitwise tests written as boolean
2453 ERROR
("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2456 # if and else should not have general statements after it
2457 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2459 $s =~ s/$;//g; # Remove any comments
2460 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2461 ERROR
("trailing statements should be on next line\n" . $herecurr);
2464 # if should not continue a brace
2465 if ($line =~ /}\s*if\b/) {
2466 ERROR
("trailing statements should be on next line\n" .
2469 # case and default should not have general statements after them
2470 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2472 (?
:\s
*$;*)(?
:\s
*{)?
(?
:\s
*$;*)(?
:\s
*\\)?\s
*$|
2476 ERROR
("trailing statements should be on next line\n" . $herecurr);
2479 # Check for }<nl>else {, these must be at the same
2480 # indent level to be relevant to each other.
2481 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2482 $previndent == $indent) {
2483 ERROR
("else should follow close brace '}'\n" . $hereprev);
2486 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2487 $previndent == $indent) {
2488 my ($s, $c) = ctx_statement_block
($linenr, $realcnt, 0);
2490 # Find out what is on the end of the line after the
2492 substr($s, 0, length($c), '');
2495 if ($s =~ /^\s*;/) {
2496 ERROR
("while should follow close brace '}'\n" . $hereprev);
2500 #studly caps, commented out until figure out how to distinguish between use of existing and adding new
2501 # if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2502 # print "No studly caps, use _\n";
2503 # print "$herecurr";
2507 #no spaces allowed after \ in define
2508 if ($line=~/\#\s*define.*\\\s$/) {
2509 ERROR
("Whitespace after \\ makes next lines useless\n" . $herecurr);
2512 # multi-statement macros should be enclosed in a do while loop, grab the
2513 # first statement and ensure its the whole macro if its not enclosed
2514 # in a known good container
2515 if ($realfile !~ m@
/vmlinux
.lds
.h
$@
&&
2516 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
2519 my ($off, $dstat, $dcond, $rest);
2522 my $args = defined($1);
2524 # Find the end of the macro and limit our statement
2526 while ($cnt > 0 && defined $lines[$ln - 1] &&
2527 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
2529 $ctx .= $rawlines[$ln - 1] . "\n";
2530 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2533 $ctx .= $rawlines[$ln - 1];
2535 ($dstat, $dcond, $ln, $cnt, $off) =
2536 ctx_statement_block
($linenr, $ln - $linenr + 1, 0);
2537 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
2538 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
2540 # Extract the remainder of the define (if any) and
2541 # rip off surrounding spaces, and trailing \'s.
2543 while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
2544 #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
2545 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
2546 $rest .= substr($lines[$ln - 1], $off) . "\n";
2552 $rest =~ s/\\\n.//g;
2556 # Clean up the original statement.
2558 substr($dstat, 0, length($dcond), '');
2560 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
2563 $dstat =~ s/\\\n.//g;
2564 $dstat =~ s/^\s*//s;
2565 $dstat =~ s/\s*$//s;
2567 # Flatten any parentheses and braces
2568 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2569 $dstat =~ s/\{[^\{\}]*\}/1/ ||
2570 $dstat =~ s/\[[^\{\}]*\]/1/)
2574 my $exceptions = qr{
2586 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
2587 if ($rest ne '' && $rest ne ',') {
2588 if ($rest !~ /while\s*\(/ &&
2589 $dstat !~ /$exceptions/)
2591 ERROR
("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
2594 } elsif ($ctx !~ /;/) {
2596 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2597 $dstat !~ /$exceptions/ &&
2598 $dstat !~ /^\.$Ident\s*=/ &&
2599 $dstat =~ /$Operators/)
2601 ERROR
("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
2606 # check for missing bracing around if etc
2607 if ($line =~ /(^.*)\b(?:if|while|for)\b/ &&
2608 $line !~ /\#\s*if/) {
2611 # Check the pre-context.
2612 if ($line =~ /(\}.*?)$/) {
2615 if ($line !~ /else/) {
2616 print "APW: ALLOWED: pre<$pre> line<$line>\n"
2621 my ($level, $endln, @chunks) =
2622 ctx_statement_full
($linenr, $realcnt, 1);
2624 print "APW: chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
2625 print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"
2628 if ($#chunks >= 0 && $level == 0) {
2630 my $herectx = $here . "\n";
2631 my $ln = $linenr - 1;
2632 for my $chunk (@chunks) {
2633 my ($cond, $block) = @
{$chunk};
2635 # If the condition carries leading newlines, then count those as offsets.
2636 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2637 my $offset = statement_rawlines
($whitespace) - 1;
2639 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2641 # We have looked at and allowed this specific line.
2642 $suppress_ifbraces{$ln + $offset} = 1;
2644 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
2645 $ln += statement_rawlines
($block) - 1;
2647 substr($block, 0, length($cond), '');
2649 my $spaced_block = $block;
2650 $spaced_block =~ s/\n\+/ /g;
2652 $seen++ if ($spaced_block =~ /^\s*\{/);
2654 print "APW: cond<$cond> block<$block> allowed<$allowed>\n"
2656 if (statement_lines
($cond) > 1) {
2657 print "APW: ALLOWED: cond<$cond>\n"
2661 if ($block =~/\b(?:if|for|while)\b/) {
2662 print "APW: ALLOWED: block<$block>\n"
2666 if (statement_block_size
($block) > 1) {
2667 print "APW: ALLOWED: lines block<$block>\n"
2672 if ($seen != ($#chunks + 1) && !$allowed) {
2673 ERROR
("braces {} are necessary for all arms of this statement\n" . $herectx);
2677 if (!defined $suppress_ifbraces{$linenr - 1} &&
2678 $line =~ /\b(if|while|for|else)\b/ &&
2679 $line !~ /\#\s*if/ &&
2680 $line !~ /\#\s*else/) {
2683 # Check the pre-context.
2684 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2687 if ($line !~ /else/) {
2688 print "APW: ALLOWED: pre<$pre> line<$line>\n"
2694 my ($level, $endln, @chunks) =
2695 ctx_statement_full
($linenr, $realcnt, $-[0]);
2697 # Check the condition.
2698 my ($cond, $block) = @
{$chunks[0]};
2699 print "CHECKING<$linenr> cond<$cond> block<$block>\n"
2700 if $dbg_adv_checking;
2701 if (defined $cond) {
2702 substr($block, 0, length($cond), '');
2704 if (statement_lines
($cond) > 1) {
2705 print "APW: ALLOWED: cond<$cond>\n"
2709 if ($block =~/\b(?:if|for|while)\b/) {
2710 print "APW: ALLOWED: block<$block>\n"
2714 if (statement_block_size
($block) > 1) {
2715 print "APW: ALLOWED: lines block<$block>\n"
2719 # Check the post-context.
2720 if (defined $chunks[1]) {
2721 my ($cond, $block) = @
{$chunks[1]};
2722 if (defined $cond) {
2723 substr($block, 0, length($cond), '');
2725 if ($block =~ /^\s*\{/) {
2726 print "APW: ALLOWED: chunk-1 block<$block>\n"
2731 print "DCS: level=$level block<$block> allowed=$allowed\n"
2733 if ($level == 0 && $block !~ /^\s*\{/ && !$allowed) {
2734 my $herectx = $here . "\n";;
2735 my $cnt = statement_rawlines
($block);
2737 for (my $n = 0; $n < $cnt; $n++) {
2738 $herectx .= raw_line
($linenr, $n) . "\n";;
2741 ERROR
("braces {} are necessary even for single statement blocks\n" . $herectx);
2745 # no volatiles please
2746 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2747 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/ &&
2748 $line !~ /sig_atomic_t/ &&
2749 !ctx_has_comment
($first_line, $linenr)) {
2750 my $msg = "Use of volatile is usually wrong, please add a comment\n" . $herecurr;
2755 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
2756 ERROR
("if this code is redundant consider removing it\n" .
2760 # check for needless g_free() checks
2761 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2763 if ($line =~ /\bg_free\(\Q$expr\E\);/) {
2764 ERROR
("g_free(NULL) is safe this check is probably not required\n" . $hereprev);
2768 # warn about #ifdefs in C files
2769 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
2770 # print "#ifdef in C files should be avoided\n";
2771 # print "$herecurr";
2775 # warn about spacing in #ifdefs
2776 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
2777 ERROR
("exactly one space required after that #$1\n" . $herecurr);
2779 # check for memory barriers without a comment.
2780 if ($line =~ /\b(smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2781 if (!ctx_has_comment
($first_line, $linenr)) {
2782 ERROR
("memory barrier without comment\n" . $herecurr);
2785 # check of hardware specific defines
2786 # we have e.g. CONFIG_LINUX and CONFIG_WIN32 for common cases
2787 # where they might be necessary.
2788 if ($line =~ m@
^.\s
*\#\s
*if.*\b__@
) {
2789 WARN
("architecture specific defines should be avoided\n" . $herecurr);
2792 # Check that the storage class is at the beginning of a declaration
2793 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
2794 ERROR
("storage class should be at the beginning of the declaration\n" . $herecurr)
2797 # check the location of the inline attribute, that it is between
2798 # storage class and type.
2799 if ($line =~ /\b$Type\s+$Inline\b/ ||
2800 $line =~ /\b$Inline\s+$Storage\b/) {
2801 ERROR
("inline keyword should sit between storage class and type\n" . $herecurr);
2804 # check for sizeof(&)
2805 if ($line =~ /\bsizeof\s*\(\s*\&/) {
2806 ERROR
("sizeof(& should be avoided\n" . $herecurr);
2809 # check for new externs in .c files.
2810 if ($realfile =~ /\.c$/ && defined $stat &&
2811 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
2813 my $function_name = $1;
2814 my $paren_space = $2;
2817 if (defined $cond) {
2818 substr($s, 0, length($cond), '');
2820 if ($s =~ /^\s*;/ &&
2821 $function_name ne 'uninitialized_var')
2823 ERROR
("externs should be avoided in .c files\n" . $herecurr);
2826 if ($paren_space =~ /\n/) {
2827 ERROR
("arguments for function declarations should follow identifier\n" . $herecurr);
2830 } elsif ($realfile =~ /\.c$/ && defined $stat &&
2831 $stat =~ /^.\s*extern\s+/)
2833 ERROR
("externs should be avoided in .c files\n" . $herecurr);
2836 # check for pointless casting of g_malloc return
2837 if ($line =~ /\*\s*\)\s*g_(try|)(m|re)alloc(0?)(_n)?\b/) {
2839 ERROR
("unnecessary cast may hide bugs, use g_$1new$3 instead\n" . $herecurr);
2841 ERROR
("unnecessary cast may hide bugs, use g_$1renew$3 instead\n" . $herecurr);
2845 # check for gcc specific __FUNCTION__
2846 if ($line =~ /__FUNCTION__/) {
2847 ERROR
("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
2850 # recommend g_path_get_* over g_strdup(basename/dirname(...))
2851 if ($line =~ /\bg_strdup\s*\(\s*(basename|dirname)\s*\(/) {
2852 WARN
("consider using g_path_get_$1() in preference to g_strdup($1())\n" . $herecurr);
2855 # enforce g_memdup2() over g_memdup()
2856 if ($line =~ /\bg_memdup\s*\(/) {
2857 ERROR
("use g_memdup2() instead of unsafe g_memdup()\n" . $herecurr);
2860 # recommend qemu_strto* over strto* for numeric conversions
2861 if ($line =~ /\b(strto[^kd].*?)\s*\(/) {
2862 ERROR
("consider using qemu_$1 in preference to $1\n" . $herecurr);
2864 # recommend sigaction over signal for portability, when establishing a handler
2865 if ($line =~ /\bsignal\s*\(/ && !($line =~ /SIG_(?:IGN|DFL)/)) {
2866 ERROR
("use sigaction to establish signal handlers; signal is not portable\n" . $herecurr);
2868 # recommend qemu_bh_new_guarded instead of qemu_bh_new
2869 if ($realfile =~ /.*\/hw\
/.*/ && $line =~ /\bqemu_bh_new\s*\(/) {
2870 ERROR
("use qemu_bh_new_guarded() instead of qemu_bh_new() to avoid reentrancy problems\n" . $herecurr);
2872 # recommend aio_bh_new_guarded instead of aio_bh_new
2873 if ($realfile =~ /.*\/hw\
/.*/ && $line =~ /\baio_bh_new\s*\(/) {
2874 ERROR
("use aio_bh_new_guarded() instead of aio_bh_new() to avoid reentrancy problems\n" . $herecurr);
2876 # check for module_init(), use category-specific init macros explicitly please
2877 if ($line =~ /^module_init\s*\(/) {
2878 ERROR
("please use block_init(), type_init() etc. instead of module_init()\n" . $herecurr);
2880 # check for various ops structs, ensure they are const.
2881 my $struct_ops = qr{AIOCBInfo
|
2885 DisplayChangeListenerOps
|
2889 MemoryRegionIOMMUOps
|
2895 Spice
[A
-Z
][a
-zA
-Z0
-9]*Interface
|
2897 USBDesc
[A
-Z
][a
-zA
-Z0
-9]*|
2901 if ($line !~ /\bconst\b/ &&
2902 $line =~ /\b($struct_ops)\b.*=/) {
2903 ERROR
("initializer for struct $1 should normally be const\n" .
2907 # format strings checks
2909 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2910 $string = substr($rawline, $-[1], $+[1] - $-[1]);
2911 $string =~ s/%%/__/g;
2912 # check for %L{u,d,i} in strings
2913 if ($string =~ /(?<!%)%L[udi]/) {
2914 ERROR
("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2916 # check for %# or %0# in printf-style format strings
2917 if ($string =~ /(?<!%)%0?#/) {
2918 ERROR
("Don't use '#' flag of printf format " .
2919 "('%#') in format strings, use '0x' " .
2920 "prefix instead\n" . $herecurr);
2924 # QEMU specific tests
2925 if ($rawline =~ /\b(?:Qemu|QEmu)\b/) {
2926 ERROR
("use QEMU instead of Qemu or QEmu\n" . $herecurr);
2929 # Qemu error function tests
2931 # Find newlines in error messages
2932 my $qemu_error_funcs = qr{error_setg
|
2935 error_setg_file_open
|
2948 if ($rawline =~ /\b(?:$qemu_error_funcs)\s*\(.*\".*\\n/) {
2949 ERROR
("Error messages should not contain newlines\n" . $herecurr);
2952 # Continue checking for error messages that contains newlines. This
2953 # check handles cases where string literals are spread over multiple lines.
2955 # error_report("Error msg line #1"
2956 # "Error msg line #2\n");
2957 my $quoted_newline_regex = qr{\+\s*\".*\\n.*\"};
2958 my $continued_str_literal = qr{\+\s*\".*\"};
2960 if ($rawline =~ /$quoted_newline_regex/) {
2961 # Backtrack to first line that does not contain only a quoted literal
2962 # and assume that it is the start of the statement.
2963 my $i = $linenr - 2;
2965 while (($i >= 0) & $rawlines[$i] =~ /$continued_str_literal/) {
2969 if ($rawlines[$i] =~ /\b(?:$qemu_error_funcs)\s*\(/) {
2970 ERROR
("Error messages should not contain newlines\n" . $herecurr);
2974 # check for non-portable libc calls that have portable alternatives in QEMU
2975 if ($line =~ /\bffs\(/) {
2976 ERROR
("use ctz32() instead of ffs()\n" . $herecurr);
2978 if ($line =~ /\bffsl\(/) {
2979 ERROR
("use ctz32() or ctz64() instead of ffsl()\n" . $herecurr);
2981 if ($line =~ /\bffsll\(/) {
2982 ERROR
("use ctz64() instead of ffsll()\n" . $herecurr);
2984 if ($line =~ /\bbzero\(/) {
2985 ERROR
("use memset() instead of bzero()\n" . $herecurr);
2987 if ($line =~ /\bgetpagesize\(\)/) {
2988 ERROR
("use qemu_real_host_page_size() instead of getpagesize()\n" . $herecurr);
2990 if ($line =~ /\bsysconf\(_SC_PAGESIZE\)/) {
2991 ERROR
("use qemu_real_host_page_size() instead of sysconf(_SC_PAGESIZE)\n" . $herecurr);
2993 if ($line =~ /\b(g_)?assert\(0\)/) {
2994 ERROR
("use g_assert_not_reached() instead of assert(0)\n" . $herecurr);
2996 my $non_exit_glib_asserts = qr{g_assert_cmpstr
|
3007 g_test_assert_expected_messages
|
3008 g_test_trap_assert_passed
|
3009 g_test_trap_assert_stdout
|
3010 g_test_trap_assert_stdout_unmatched
|
3011 g_test_trap_assert_stderr
|
3012 g_test_trap_assert_stderr_unmatched
}x
;
3013 if ($realfile !~ /^tests\// &&
3014 $line =~ /\b(?:$non_exit_glib_asserts)\(/) {
3015 ERROR
("Use g_assert or g_assert_not_reached\n". $herecurr);
3019 if ($is_patch && $chk_signoff && $signoff == 0) {
3020 ERROR
("Missing Signed-off-by: line(s)\n");
3023 # If we have no input at all, then there is nothing to report on
3024 # so just keep quiet.
3025 if ($#rawlines == -1) {
3029 # In mailback mode only produce a report in the negative, for
3030 # things that appear to be patches.
3031 if ($mailback && ($clean == 1 || !$is_patch)) {
3035 # This is not a patch, and we are are in 'no-patch' mode so
3037 if (!$chk_patch && !$is_patch) {
3041 if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
3042 ERROR
("Does not appear to be a unified-diff format patch\n");
3045 print report_dump
();
3046 if ($summary && !($clean == 1 && $quiet == 1)) {
3047 print "$filename " if ($summary_file);
3048 print "total: $cnt_error errors, $cnt_warn warnings, " .
3049 "$cnt_lines lines checked\n";
3050 print "\n" if ($quiet == 0);
3054 # If there were whitespace errors which cleanpatch can fix
3055 # then suggest that.
3056 # if ($rpt_cleaners) {
3057 # print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
3058 # print " scripts/cleanfile\n\n";
3062 if ($clean == 1 && $quiet == 0) {
3063 print "$vname has no obvious style problems and is ready for submission.\n"
3065 if ($clean == 0 && $quiet == 0) {
3066 print "$vname has style problems, please review. If any of these errors\n";
3067 print "are false positives report them to the maintainer, see\n";
3068 print "CHECKPATCH in MAINTAINERS.\n";
3071 return ($no_warnings ?
$clean : $cnt_error == 0);