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>
7 # SPDX-License-Identifier: GPL-2.0-only
16 use Getopt
::Long
qw(:config no_auto_abbrev);
36 my $configuration_file = ".checkpatch.conf";
37 my $max_line_length = 80;
43 Usage
: $P [OPTION
]... [FILE
]...
48 --no-tree run without a kernel tree
49 --no-signoff
do not check
for 'Signed-off-by' line
50 --patch treat FILE as patchfile
(default)
51 --emacs emacs compile window format
52 --terse one line per report
53 -f
, --file treat FILE as regular source file
54 --subjective
, --strict enable more subjective tests
55 --ignore TYPE
(,TYPE2
...) ignore various comma separated message types
56 --max
-line
-length=n set the maximum line
length, if exceeded
, warn
57 --show
-types show the message
"types" in the output
58 --root
=PATH PATH to the kernel tree root
59 --no-summary suppress the per
-file summary
60 --mailback only produce a report
in case of warnings
/errors
61 --summary
-file include the filename
in summary
62 --debug KEY
=[0|1] turn on
/off debugging of KEY
, where KEY is one of
63 'values', 'possible', 'type', and 'attr' (default
65 --test
-only
=WORD report only warnings
/errors containing WORD
67 -h
, --help
, --version display this help
and exit
69 When FILE is
- read standard input
.
75 my $conf = which_conf
($configuration_file);
78 open(my $conffile, '<', "$conf")
79 or warn "$P: Can't find a readable $configuration_file file $!\n";
84 $line =~ s/\s*\n?$//g;
88 next if ($line =~ m/^\s*#/);
89 next if ($line =~ m/^\s*$/);
91 my @words = split(" ", $line);
92 foreach my $word (@words) {
93 last if ($word =~ m/^#/);
94 push (@conf_args, $word);
98 unshift(@ARGV, @conf_args) if @conf_args;
102 'q|quiet+' => \
$quiet,
104 'signoff!' => \
$chk_signoff,
105 'patch!' => \
$chk_patch,
109 'subjective!' => \
$check,
110 'strict!' => \
$check,
111 'ignore=s' => \
@ignore,
112 'show-types!' => \
$show_types,
113 'max-line-length=i' => \
$max_line_length,
115 'summary!' => \
$summary,
116 'mailback!' => \
$mailback,
117 'summary-file!' => \
$summary_file,
119 'debug=s' => \
%debug,
120 'test-only=s' => \
$tst_only,
130 print "$P: no input files\n";
134 @ignore = split(/,/, join(',',@ignore));
135 foreach my $word (@ignore) {
136 $word =~ s/\s*\n?$//g;
139 $word =~ tr/[a-z]/[A-Z]/;
141 next if ($word =~ m/^\s*#/);
142 next if ($word =~ m/^\s*$/);
144 $ignore_type{$word}++;
148 my $dbg_possible = 0;
151 for my $key (keys %debug) {
153 eval "\${dbg_$key} = '$debug{$key}';";
157 my $rpt_cleaners = 0;
166 if (!top_of_kernel_tree
($root)) {
167 die "$P: $root: --root does not point at a valid tree\n";
170 if (top_of_kernel_tree
('.')) {
172 } elsif ($0 =~ m@
(.*)/scripts/[^/]*$@
&&
173 top_of_kernel_tree
($1)) {
178 if (!defined $root) {
179 print "Must be run from the top-level dir. of a kernel tree\n";
184 my $emitted_corrupt = 0;
187 [A
-Za
-z_
][A
-Za
-z\d_
]*
188 (?
:\s
*\#\#\s
*[A
-Za
-z_
][A
-Za
-z\d_
]*)*
190 our $Storage = qr{extern|static|asmlinkage};
203 # Notes to $Attribute:
204 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
223 __
(?
:mem
|cpu
|dev
|)(?
:initdata
|initconst
|init
\b)|
224 ____cacheline_aligned
|
225 ____cacheline_aligned_in_smp
|
226 ____cacheline_internodealigned_in_smp
|
230 our $Inline = qr{inline|__always_inline|noinline};
231 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
232 our $Lval = qr{$Ident(?:$Member)*};
234 our $Float_hex = qr{(?i:0x[0-9a-f]+p-?[0-9]+[fl]?)};
235 our $Float_dec = qr{(?i:((?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?))};
236 our $Float_int = qr{(?i:[0-9]+e-?[0-9]+[fl]?)};
237 our $Float = qr{$Float_hex|$Float_dec|$Float_int};
238 our $Constant = qr{(?:$Float|(?i:(?:0x[0-9a-f]+|[0-9]+)[ul]*))};
239 our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
240 our $Compare = qr{<=|>=|==|!=|<|>};
244 &&|\
|\
||,|\
^|\
+\
+|--|&|\
||\
+|-|\
*|\
/|%
251 our $NON_ASCII_UTF8 = qr{
252 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
253 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
254 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
255 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
256 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
257 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
258 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
262 [\x09\x0A\x0D\x20-\x7E] # ASCII
266 our $typeTypedefs = qr{(?x
:
267 (?
:__
)?
(?
:u
|s
|be
|le)(?
:8|16|32|64)|
271 our $logFunctions = qr{(?x
:
272 printk
(?
:_ratelimited
|_once
|)|
273 [a
-z0
-9]+_
(?
:printk
|emerg
|alert
|crit
|err
|warning
|warn|notice
|info
|debug
|dbg
|vdbg
|devel
|cont
|WARN
)(?
:_ratelimited
|_once
|)|
274 WARN
(?
:_RATELIMIT
|_ONCE
|)|
279 our $signature_tags = qr{(?xi
:
291 qr{(?:unsigned\s+)?char},
292 qr{(?:unsigned\s+)?short},
293 qr{(?:unsigned\s+)?int},
294 qr{(?:unsigned\s+)?long},
295 qr{(?:unsigned\s+)?long\s+int},
296 qr{(?:unsigned\s+)?long\s+long},
297 qr{(?:unsigned\s+)?long\s+long\s+int},
306 qr{${Ident}_handler
},
307 qr{${Ident}_handler_fn
},
309 our @modifierList = (
313 our $allowed_asm_includes = qr{(?x
:
317 # memory.h: ARM has a custom one
320 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
321 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
322 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
324 (?
:$Modifier\s
+|const\s
+)*
326 (?
:typeof
|__typeof__
)\s
*\
([^\
)]*\
)|
330 (?
:\s
+$Modifier|\s
+const
)*
334 (?
:(?
:\s
|\
*|\
[\
])+\s
*const
|(?
:\s
|\
*|\
[\
])+|(?
:\s
*\
[\s
*\
])+)?
335 (?
:\s
+$Inline|\s
+$Modifier)*
337 $Declare = qr{(?:$Storage\s+)?$Type};
342 our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s
*};
344 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
345 # requires at least perl version v5.10.0
346 # Any use must be runtime checked with $^V
348 our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
349 our $LvalOrFunc = qr{($Lval)\s*($balanced_parens{0,1})\s
*};
350 our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
354 return "" if (!defined($string));
355 $string =~ s@
^\s
*\
(\s
*@
@g;
356 $string =~ s@\s
*\
)\s
*$@
@g;
357 $string =~ s@\s
+@
@g;
361 $chk_signoff = 0 if ($file);
366 for my $filename (@ARGV) {
369 open($FILE, '-|', "diff -u /dev/null $filename") ||
370 die "$P: $filename: diff failed - $!\n";
371 } elsif ($filename eq '-') {
372 open($FILE, '<&STDIN');
374 open($FILE, '<', "$filename") ||
375 die "$P: $filename: open failed - $!\n";
377 if ($filename eq '-') {
378 $vname = 'Your patch';
387 if (!process
($filename)) {
396 sub top_of_kernel_tree
{
400 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
401 "README", "Documentation", "arch", "include", "drivers",
402 "fs", "init", "ipc", "kernel", "lib", "scripts",
405 foreach my $check (@tree_check) {
406 if (! -e
$root . '/' . $check) {
414 my ($formatted_email) = @_;
420 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
423 $comment = $3 if defined $3;
424 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
426 $comment = $2 if defined $2;
427 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
429 $comment = $2 if defined $2;
430 $formatted_email =~ s/$address.*$//;
431 $name = $formatted_email;
432 $name =~ s/^\s+|\s+$//g;
433 $name =~ s/^\"|\"$//g;
434 # If there's a name left after stripping spaces and
435 # leading quotes, and the address doesn't have both
436 # leading and trailing angle brackets, the address
438 # "joe smith joe@smith.com" bad
439 # "joe smith <joe@smith.com" bad
440 if ($name ne "" && $address !~ /^<[^>]+>$/) {
447 $name =~ s/^\s+|\s+$//g;
448 $name =~ s/^\"|\"$//g;
449 $address =~ s/^\s+|\s+$//g;
450 $address =~ s/^\<|\>$//g;
452 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
453 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
457 return ($name, $address, $comment);
461 my ($name, $address) = @_;
465 $name =~ s/^\s+|\s+$//g;
466 $name =~ s/^\"|\"$//g;
467 $address =~ s/^\s+|\s+$//g;
469 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
470 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
475 $formatted_email = "$address";
477 $formatted_email = "$name <$address>";
480 return $formatted_email;
486 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
487 if (-e
"$path/$conf") {
488 return "$path/$conf";
500 for my $c (split(//, $str)) {
504 for (; ($n % 4) != 0; $n++) {
516 (my $res = shift) =~ tr/\t/ /c;
523 # Drop the diff line leader and expand tabs
525 $line = expand_tabs
($line);
527 # Pick the indent from the front of the line.
528 my ($white) = ($line =~ /^(\s*)/);
530 return (length($line), length($white));
533 my $sanitise_quote = '';
535 sub sanitise_line_reset
{
536 my ($in_comment) = @_;
539 $sanitise_quote = '*/';
541 $sanitise_quote = '';
554 # Always copy over the diff marker.
555 $res = substr($line, 0, 1);
557 for ($off = 1; $off < length($line); $off++) {
558 $c = substr($line, $off, 1);
560 # Comments we are wacking completly including the begin
561 # and end, all to $;.
562 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
563 $sanitise_quote = '*/';
565 substr($res, $off, 2, "$;$;");
569 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
570 $sanitise_quote = '';
571 substr($res, $off, 2, "$;$;");
575 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
576 $sanitise_quote = '//';
578 substr($res, $off, 2, $sanitise_quote);
583 # A \ in a string means ignore the next character.
584 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
586 substr($res, $off, 2, 'XX');
591 if ($c eq "'" || $c eq '"') {
592 if ($sanitise_quote eq '') {
593 $sanitise_quote = $c;
595 substr($res, $off, 1, $c);
597 } elsif ($sanitise_quote eq $c) {
598 $sanitise_quote = '';
602 #print "c<$c> SQ<$sanitise_quote>\n";
603 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
604 substr($res, $off, 1, $;);
605 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
606 substr($res, $off, 1, $;);
607 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
608 substr($res, $off, 1, 'X');
610 substr($res, $off, 1, $c);
614 if ($sanitise_quote eq '//') {
615 $sanitise_quote = '';
618 # The pathname on a #include may be surrounded by '<' and '>'.
619 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
620 my $clean = 'X' x
length($1);
621 $res =~ s@\
<.*\
>@
<$clean>@
;
623 # The whole of a #error is a string.
624 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
625 my $clean = 'X' x
length($1);
626 $res =~ s@
(\#\s
*(?
:error
|warning
)\s
+).*@
$1$clean@
;
632 sub ctx_statement_block
{
633 my ($linenr, $remain, $off) = @_;
634 my $line = $linenr - 1;
651 @stack = (['', 0]) if ($#stack == -1);
653 #warn "CSB: blk<$blk> remain<$remain>\n";
654 # If we are about to drop off the end, pull in more
657 for (; $remain > 0; $line++) {
658 last if (!defined $lines[$line]);
659 next if ($lines[$line] =~ /^-/);
662 $blk .= $lines[$line] . "\n";
667 # Bail if there is no further context.
668 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
672 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
678 $c = substr($blk, $off, 1);
679 $remainder = substr($blk, $off);
681 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
683 # Handle nested #if/#else.
684 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
685 push(@stack, [ $type, $level ]);
686 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
687 ($type, $level) = @
{$stack[$#stack - 1]};
688 } elsif ($remainder =~ /^#\s*endif\b/) {
689 ($type, $level) = @
{pop(@stack)};
692 # Statement ends at the ';' or a close '}' at the
694 if ($level == 0 && $c eq ';') {
698 # An else is really a conditional as long as its not else if
699 if ($level == 0 && $coff_set == 0 &&
700 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
701 $remainder =~ /^(else)(?:\s|{)/ &&
702 $remainder !~ /^else\s+if\b/) {
703 $coff = $off + length($1) - 1;
705 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
706 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
709 if (($type eq '' || $type eq '(') && $c eq '(') {
713 if ($type eq '(' && $c eq ')') {
715 $type = ($level != 0)?
'(' : '';
717 if ($level == 0 && $coff < $soff) {
720 #warn "CSB: mark coff<$coff>\n";
723 if (($type eq '' || $type eq '{') && $c eq '{') {
727 if ($type eq '{' && $c eq '}') {
729 $type = ($level != 0)?
'{' : '';
732 if (substr($blk, $off + 1, 1) eq ';') {
738 # Preprocessor commands end at the newline unless escaped.
739 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
747 # We are truly at the end, so shuffle to the next line.
754 my $statement = substr($blk, $soff, $off - $soff + 1);
755 my $condition = substr($blk, $soff, $coff - $soff + 1);
757 #warn "STATEMENT<$statement>\n";
758 #warn "CONDITION<$condition>\n";
760 #print "coff<$coff> soff<$off> loff<$loff>\n";
762 return ($statement, $condition,
763 $line, $remain + 1, $off - $loff + 1, $level);
766 sub statement_lines
{
769 # Strip the diff line prefixes and rip blank lines at start and end.
770 $stmt =~ s/(^|\n)./$1/g;
774 my @stmt_lines = ($stmt =~ /\n/g);
776 return $#stmt_lines + 2;
779 sub statement_rawlines
{
782 my @stmt_lines = ($stmt =~ /\n/g);
784 return $#stmt_lines + 2;
787 sub statement_block_size
{
790 $stmt =~ s/(^|\n)./$1/g;
796 my @stmt_lines = ($stmt =~ /\n/g);
797 my @stmt_statements = ($stmt =~ /;/g);
799 my $stmt_lines = $#stmt_lines + 2;
800 my $stmt_statements = $#stmt_statements + 1;
802 if ($stmt_lines > $stmt_statements) {
805 return $stmt_statements;
809 sub ctx_statement_full
{
810 my ($linenr, $remain, $off) = @_;
811 my ($statement, $condition, $level);
815 # Grab the first conditional/block pair.
816 ($statement, $condition, $linenr, $remain, $off, $level) =
817 ctx_statement_block
($linenr, $remain, $off);
818 #print "F: c<$condition> s<$statement> remain<$remain>\n";
819 push(@chunks, [ $condition, $statement ]);
820 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
821 return ($level, $linenr, @chunks);
824 # Pull in the following conditional/block pairs and see if they
825 # could continue the statement.
827 ($statement, $condition, $linenr, $remain, $off, $level) =
828 ctx_statement_block
($linenr, $remain, $off);
829 #print "C: c<$condition> s<$statement> remain<$remain>\n";
830 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
832 push(@chunks, [ $condition, $statement ]);
835 return ($level, $linenr, @chunks);
839 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
841 my $start = $linenr - 1;
848 my @stack = ($level);
849 for ($line = $start; $remain > 0; $line++) {
850 next if ($rawlines[$line] =~ /^-/);
853 $blk .= $rawlines[$line];
855 # Handle nested #if/#else.
856 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
857 push(@stack, $level);
858 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
859 $level = $stack[$#stack - 1];
860 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
861 $level = pop(@stack);
864 foreach my $c (split(//, $lines[$line])) {
865 ##print "C<$c>L<$level><$open$close>O<$off>\n";
871 if ($c eq $close && $level > 0) {
873 last if ($level == 0);
874 } elsif ($c eq $open) {
879 if (!$outer || $level <= 1) {
880 push(@res, $rawlines[$line]);
883 last if ($level == 0);
886 return ($level, @res);
888 sub ctx_block_outer
{
889 my ($linenr, $remain) = @_;
891 my ($level, @r) = ctx_block_get
($linenr, $remain, 1, '{', '}', 0);
895 my ($linenr, $remain) = @_;
897 my ($level, @r) = ctx_block_get
($linenr, $remain, 0, '{', '}', 0);
901 my ($linenr, $remain, $off) = @_;
903 my ($level, @r) = ctx_block_get
($linenr, $remain, 0, '(', ')', $off);
906 sub ctx_block_level
{
907 my ($linenr, $remain) = @_;
909 return ctx_block_get
($linenr, $remain, 0, '{', '}', 0);
911 sub ctx_statement_level
{
912 my ($linenr, $remain, $off) = @_;
914 return ctx_block_get
($linenr, $remain, 0, '(', ')', $off);
917 sub ctx_locate_comment
{
918 my ($first_line, $end_line) = @_;
920 # Catch a comment on the end of the line itself.
921 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@
.*(/\*.*\*/)\s
*(?
:\\\s
*)?
$@
);
922 return $current_comment if (defined $current_comment);
924 # Look through the context and try and figure out if there is a
927 $current_comment = '';
928 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
929 my $line = $rawlines[$linenr - 1];
931 if ($linenr == $first_line and $line =~ m@
^.\s
*\
*@
) {
934 if ($line =~ m@
/\
*@
) {
937 if (!$in_comment && $current_comment ne '') {
938 $current_comment = '';
940 $current_comment .= $line . "\n" if ($in_comment);
941 if ($line =~ m@\
*/@
) {
946 chomp($current_comment);
947 return($current_comment);
949 sub ctx_has_comment
{
950 my ($first_line, $end_line) = @_;
951 my $cmt = ctx_locate_comment
($first_line, $end_line);
953 ##print "LINE: $rawlines[$end_line - 1 ]\n";
954 ##print "CMMT: $cmt\n";
960 my ($linenr, $cnt) = @_;
962 my $offset = $linenr - 1;
967 $line = $rawlines[$offset++];
968 next if (defined($line) && $line =~ /^-/);
980 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
983 $coded = sprintf("^%c", unpack('C', $2) + 64);
992 my $av_preprocessor = 0;
998 $av_preprocessor = 0;
1000 @av_paren_type = ('E');
1001 $av_pend_colon = 'O';
1004 sub annotate_values
{
1005 my ($stream, $type) = @_;
1008 my $var = '_' x
length($stream);
1011 print "$stream\n" if ($dbg_values > 1);
1013 while (length($cur)) {
1014 @av_paren_type = ('E') if ($#av_paren_type < 0);
1015 print " <" . join('', @av_paren_type) .
1016 "> <$type> <$av_pending>" if ($dbg_values > 1);
1017 if ($cur =~ /^(\s+)/o) {
1018 print "WS($1)\n" if ($dbg_values > 1);
1019 if ($1 =~ /\n/ && $av_preprocessor) {
1020 $type = pop(@av_paren_type);
1021 $av_preprocessor = 0;
1024 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1025 print "CAST($1)\n" if ($dbg_values > 1);
1026 push(@av_paren_type, $type);
1029 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1030 print "DECLARE($1)\n" if ($dbg_values > 1);
1033 } elsif ($cur =~ /^($Modifier)\s*/) {
1034 print "MODIFIER($1)\n" if ($dbg_values > 1);
1037 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1038 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1039 $av_preprocessor = 1;
1040 push(@av_paren_type, $type);
1046 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1047 print "UNDEF($1)\n" if ($dbg_values > 1);
1048 $av_preprocessor = 1;
1049 push(@av_paren_type, $type);
1051 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1052 print "PRE_START($1)\n" if ($dbg_values > 1);
1053 $av_preprocessor = 1;
1055 push(@av_paren_type, $type);
1056 push(@av_paren_type, $type);
1059 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1060 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1061 $av_preprocessor = 1;
1063 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1067 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1068 print "PRE_END($1)\n" if ($dbg_values > 1);
1070 $av_preprocessor = 1;
1072 # Assume all arms of the conditional end as this
1073 # one does, and continue as if the #endif was not here.
1074 pop(@av_paren_type);
1075 push(@av_paren_type, $type);
1078 } elsif ($cur =~ /^(\\\n)/o) {
1079 print "PRECONT($1)\n" if ($dbg_values > 1);
1081 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1082 print "ATTR($1)\n" if ($dbg_values > 1);
1083 $av_pending = $type;
1086 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1087 print "SIZEOF($1)\n" if ($dbg_values > 1);
1093 } elsif ($cur =~ /^(if|while|for)\b/o) {
1094 print "COND($1)\n" if ($dbg_values > 1);
1098 } elsif ($cur =~/^(case)/o) {
1099 print "CASE($1)\n" if ($dbg_values > 1);
1100 $av_pend_colon = 'C';
1103 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1104 print "KEYWORD($1)\n" if ($dbg_values > 1);
1107 } elsif ($cur =~ /^(\()/o) {
1108 print "PAREN('$1')\n" if ($dbg_values > 1);
1109 push(@av_paren_type, $av_pending);
1113 } elsif ($cur =~ /^(\))/o) {
1114 my $new_type = pop(@av_paren_type);
1115 if ($new_type ne '_') {
1117 print "PAREN('$1') -> $type\n"
1118 if ($dbg_values > 1);
1120 print "PAREN('$1')\n" if ($dbg_values > 1);
1123 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1124 print "FUNC($1)\n" if ($dbg_values > 1);
1128 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1129 if (defined $2 && $type eq 'C' || $type eq 'T') {
1130 $av_pend_colon = 'B';
1131 } elsif ($type eq 'E') {
1132 $av_pend_colon = 'L';
1134 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1137 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1138 print "IDENT($1)\n" if ($dbg_values > 1);
1141 } elsif ($cur =~ /^($Assignment)/o) {
1142 print "ASSIGN($1)\n" if ($dbg_values > 1);
1145 } elsif ($cur =~/^(;|{|})/) {
1146 print "END($1)\n" if ($dbg_values > 1);
1148 $av_pend_colon = 'O';
1150 } elsif ($cur =~/^(,)/) {
1151 print "COMMA($1)\n" if ($dbg_values > 1);
1154 } elsif ($cur =~ /^(\?)/o) {
1155 print "QUESTION($1)\n" if ($dbg_values > 1);
1158 } elsif ($cur =~ /^(:)/o) {
1159 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1161 substr($var, length($res), 1, $av_pend_colon);
1162 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1167 $av_pend_colon = 'O';
1169 } elsif ($cur =~ /^(\[)/o) {
1170 print "CLOSE($1)\n" if ($dbg_values > 1);
1173 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1176 print "OPV($1)\n" if ($dbg_values > 1);
1183 substr($var, length($res), 1, $variant);
1186 } elsif ($cur =~ /^($Operators)/o) {
1187 print "OP($1)\n" if ($dbg_values > 1);
1188 if ($1 ne '++' && $1 ne '--') {
1192 } elsif ($cur =~ /(^.)/o) {
1193 print "C($1)\n" if ($dbg_values > 1);
1196 $cur = substr($cur, length($1));
1197 $res .= $type x
length($1);
1201 return ($res, $var);
1205 my ($possible, $line) = @_;
1206 my $notPermitted = qr{(?
:
1223 ^(?
:typedef
|struct
|enum
)\b
1225 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1226 if ($possible !~ $notPermitted) {
1227 # Check for modifiers.
1228 $possible =~ s/\s*$Storage\s*//g;
1229 $possible =~ s/\s*$Sparse\s*//g;
1230 if ($possible =~ /^\s*$/) {
1232 } elsif ($possible =~ /\s/) {
1233 $possible =~ s/\s*$Type\s*//g;
1234 for my $modifier (split(' ', $possible)) {
1235 if ($modifier !~ $notPermitted) {
1236 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1237 push(@modifierList, $modifier);
1242 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1243 push(@typeList, $possible);
1247 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1254 return !defined $ignore_type{$_[0]};
1258 if (!show_type
($_[1]) ||
1259 (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) {
1264 $line = "$prefix$_[0]:$_[1]: $_[2]\n";
1266 $line = "$prefix$_[0]: $_[2]\n";
1268 $line = (split('\n', $line))[0] . "\n" if ($terse);
1270 push(our @report, $line);
1279 if (report
("ERROR", $_[0], $_[1])) {
1285 if (report
("WARNING", $_[0], $_[1])) {
1291 if ($check && report
("CHECK", $_[0], $_[1])) {
1297 sub check_absolute_file
{
1298 my ($absolute, $herecurr) = @_;
1299 my $file = $absolute;
1301 ##print "absolute<$absolute>\n";
1303 # See if any suffix of this path is a path within the tree.
1304 while ($file =~ s@
^[^/]*/@@
) {
1305 if (-f
"$root/$file") {
1306 ##print "file<$file>\n";
1314 # It is, so see if the prefix is acceptable.
1315 my $prefix = $absolute;
1316 substr($prefix, -length($file)) = '';
1318 ##print "prefix<$prefix>\n";
1319 if ($prefix ne ".../") {
1320 WARN
("USE_RELATIVE_PATH",
1321 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1325 sub pos_last_openparen
{
1330 my $opens = $line =~ tr/\(/\(/;
1331 my $closes = $line =~ tr/\)/\)/;
1333 my $last_openparen = 0;
1335 if (($opens == 0) || ($closes >= $opens)) {
1339 my $len = length($line);
1341 for ($pos = 0; $pos < $len; $pos++) {
1342 my $string = substr($line, $pos);
1343 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1344 $pos += length($1) - 1;
1345 } elsif (substr($line, $pos, 1) eq '(') {
1346 $last_openparen = $pos;
1347 } elsif (index($string, '(') == -1) {
1352 return $last_openparen + 1;
1356 my $filename = shift;
1362 my $stashrawline="";
1373 my $in_header_lines = 1;
1374 my $in_commit_log = 0; #Scanning lines before patch
1376 my $non_utf8_charset = 0;
1384 # Trace the real file/line as we go.
1390 my $comment_edge = 0;
1394 my $prev_values = 'E';
1397 my %suppress_ifbraces;
1398 my %suppress_whiletrailers;
1399 my %suppress_export;
1400 my $suppress_statement = 0;
1404 # Pre-scan the patch sanitizing the lines.
1405 # Pre-scan the patch looking for any __setup documentation.
1407 my @setup_docs = ();
1410 sanitise_line_reset
();
1412 foreach my $rawline (@rawlines) {
1416 if ($rawline=~/^\+\+\+\s+(\S+)/) {
1418 if ($1 =~ m
@Documentation/kernel
-parameters
.txt
$@
) {
1423 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1432 # Guestimate if this is a continuing comment. Run
1433 # the context looking for a comment "edge". If this
1434 # edge is a close comment then we must be in a comment
1438 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1439 next if (defined $rawlines[$ln - 1] &&
1440 $rawlines[$ln - 1] =~ /^-/);
1442 #print "RAW<$rawlines[$ln - 1]>\n";
1443 last if (!defined $rawlines[$ln - 1]);
1444 if ($rawlines[$ln - 1] =~ m@
(/\*|\*/)@
&&
1445 $rawlines[$ln - 1] !~ m@
"[^"]*(?
:/\*|\*/)[^"]*"@
) {
1450 if (defined $edge && $edge eq '*/') {
1454 # Guestimate if this is a continuing comment. If this
1455 # is the start of a diff block and this line starts
1456 # ' *' then it is very likely a comment.
1457 if (!defined $edge &&
1458 $rawlines[$linenr] =~ m@
^.\s
*(?
:\
*\
*+| \
*)(?
:\s
|$)@
)
1463 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1464 sanitise_line_reset
($in_comment);
1466 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1467 # Standardise the strings and chars within the input to
1468 # simplify matching -- only bother with positive lines.
1469 $line = sanitise_line
($rawline);
1471 push(@lines, $line);
1474 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1479 #print "==>$rawline\n";
1480 #print "-->$line\n";
1482 if ($setup_docs && $line =~ /^\+/) {
1483 push(@setup_docs, $line);
1491 foreach my $line (@lines) {
1494 my $rawline = $rawlines[$linenr - 1];
1496 #extract the line range in the file after the patch is applied
1497 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1499 $first_line = $linenr + 1;
1509 %suppress_ifbraces = ();
1510 %suppress_whiletrailers = ();
1511 %suppress_export = ();
1512 $suppress_statement = 0;
1515 # track the line number as we move through the hunk, note that
1516 # new versions of GNU diff omit the leading space on completely
1517 # blank context lines so we need to count that too.
1518 } elsif ($line =~ /^( |\+|$)/) {
1520 $realcnt-- if ($realcnt != 0);
1522 # Measure the line length and indent.
1523 ($length, $indent) = line_stats
($rawline);
1525 # Track the previous line.
1526 ($prevline, $stashline) = ($stashline, $line);
1527 ($previndent, $stashindent) = ($stashindent, $indent);
1528 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1530 #warn "line<$line>\n";
1532 } elsif ($realcnt == 1) {
1536 my $hunk_line = ($realcnt != 0);
1538 #make up the handle for any error we report on this line
1539 $prefix = "$filename:$realline: " if ($emacs && $file);
1540 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1542 $here = "#$linenr: " if (!$file);
1543 $here = "#$realline: " if ($file);
1545 # extract the filename as it passes
1546 if ($line =~ /^diff --git.*?(\S+)$/) {
1548 $realfile =~ s@
^([^/]*)/@@
;
1550 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
1552 $realfile =~ s@
^([^/]*)/@@
;
1556 if (!$file && $tree && $p1_prefix ne '' &&
1557 -e
"$root/$p1_prefix") {
1558 WARN
("PATCH_PREFIX",
1559 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1562 if ($realfile =~ m@
^include
/asm/@
) {
1563 ERROR
("MODIFIED_INCLUDE_ASM",
1564 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1569 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
1571 my $hereline = "$here\n$rawline\n";
1572 my $herecurr = "$here\n$rawline\n";
1573 my $hereprev = "$here\n$prevrawline\n$rawline\n";
1575 $cnt_lines++ if ($realcnt != 0);
1577 # Check for incorrect file permissions
1578 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1579 my $permhere = $here . "FILE: $realfile\n";
1580 if ($realfile =~ /(Makefile|Kconfig|\.c|\.h|\.S|\.tmpl)$/) {
1581 ERROR
("EXECUTE_PERMISSIONS",
1582 "do not set execute permissions for source files\n" . $permhere);
1586 # Check the patch for a signoff:
1587 if ($line =~ /^\s*signed-off-by:/i) {
1592 # Check signature styles
1593 if (!$in_header_lines &&
1594 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
1595 my $space_before = $1;
1597 my $space_after = $3;
1599 my $ucfirst_sign_off = ucfirst(lc($sign_off));
1601 if ($sign_off !~ /$signature_tags/) {
1602 WARN
("BAD_SIGN_OFF",
1603 "Non-standard signature: $sign_off\n" . $herecurr);
1605 if (defined $space_before && $space_before ne "") {
1606 WARN
("BAD_SIGN_OFF",
1607 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr);
1609 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
1610 WARN
("BAD_SIGN_OFF",
1611 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr);
1613 if (!defined $space_after || $space_after ne " ") {
1614 WARN
("BAD_SIGN_OFF",
1615 "Use a single space after $ucfirst_sign_off\n" . $herecurr);
1618 my ($email_name, $email_address, $comment) = parse_email
($email);
1619 my $suggested_email = format_email
(($email_name, $email_address));
1620 if ($suggested_email eq "") {
1621 ERROR
("BAD_SIGN_OFF",
1622 "Unrecognized email address: '$email'\n" . $herecurr);
1624 my $dequoted = $suggested_email;
1625 $dequoted =~ s/^"//;
1626 $dequoted =~ s/" </ </;
1627 # Don't force email to have quotes
1628 # Allow just an angle bracketed address
1629 if ("$dequoted$comment" ne $email &&
1630 "<$email_address>$comment" ne $email &&
1631 "$suggested_email$comment" ne $email) {
1632 WARN
("BAD_SIGN_OFF",
1633 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
1638 # Check for wrappage within a valid hunk of the file
1639 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1640 ERROR
("CORRUPTED_PATCH",
1641 "patch seems to be corrupt (line wrapped?)\n" .
1642 $herecurr) if (!$emitted_corrupt++);
1645 # Check for absolute kernel paths.
1647 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1650 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1651 check_absolute_file
($1, $herecurr)) {
1654 check_absolute_file
($file, $herecurr);
1659 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1660 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1661 $rawline !~ m/^$UTF8*$/) {
1662 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1664 my $blank = copy_spacing
($rawline);
1665 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1666 my $hereptr = "$hereline$ptr\n";
1669 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1672 # Check if it's the start of a commit log
1673 # (not a header line and we haven't seen the patch filename)
1674 if ($in_header_lines && $realfile =~ /^$/ &&
1675 $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
1676 $in_header_lines = 0;
1680 # Check if there is UTF-8 in a commit log when a mail header has explicitly
1681 # declined it, i.e defined some charset where it is missing.
1682 if ($in_header_lines &&
1683 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
1685 $non_utf8_charset = 1;
1688 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
1689 $rawline =~ /$NON_ASCII_UTF8/) {
1690 WARN
("UTF8_BEFORE_PATCH",
1691 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
1694 # ignore non-hunk lines and lines being removed
1695 next if (!$hunk_line || $line =~ /^-/);
1697 #trailing whitespace
1698 if ($line =~ /^\+.*\015/) {
1699 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
1700 ERROR
("DOS_LINE_ENDINGS",
1701 "DOS line endings\n" . $herevet);
1703 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1704 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
1705 ERROR
("TRAILING_WHITESPACE",
1706 "trailing whitespace\n" . $herevet);
1710 # check for Kconfig help text having a real description
1711 # Only applies when adding the entry originally, after that we do not have
1712 # sufficient context to determine whether it is indeed long enough.
1713 if ($realfile =~ /Kconfig/ &&
1714 $line =~ /.\s*config\s+/) {
1717 my $ln = $linenr + 1;
1721 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
1722 $f = $lines[$ln - 1];
1723 $cnt-- if ($lines[$ln - 1] !~ /^-/);
1724 $is_end = $lines[$ln - 1] =~ /^\+/;
1726 next if ($f =~ /^-/);
1728 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
1730 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
1737 next if ($f =~ /^$/);
1738 if ($f =~ /^\s*config\s/) {
1744 WARN
("CONFIG_DESCRIPTION",
1745 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
1746 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
1749 # discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
1750 if ($realfile =~ /Kconfig/ &&
1751 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
1752 WARN
("CONFIG_EXPERIMENTAL",
1753 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
1756 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
1757 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
1760 'EXTRA_AFLAGS' => 'asflags-y',
1761 'EXTRA_CFLAGS' => 'ccflags-y',
1762 'EXTRA_CPPFLAGS' => 'cppflags-y',
1763 'EXTRA_LDFLAGS' => 'ldflags-y',
1766 WARN
("DEPRECATED_VARIABLE",
1767 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
1770 # check we are in a valid source file if not then ignore this hunk
1771 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1774 if ($line =~ /^\+/ && $prevrawline !~ /\/\
*\
*/ &&
1775 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1776 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
1777 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
1778 $length > $max_line_length)
1781 "line over $max_line_length characters\n" . $herecurr);
1784 # Check for user-visible strings broken across lines, which breaks the ability
1785 # to grep for the string. Limited to strings used as parameters (those
1786 # following an open parenthesis), which almost completely eliminates false
1787 # positives, as well as warning only once per parameter rather than once per
1788 # line of the string. Make an exception when the previous string ends in a
1789 # newline (multiple lines in one string constant) or \n\t (common in inline
1790 # assembly to indent the instruction on the following line).
1791 if ($line =~ /^\+\s*"/ &&
1792 $prevline =~ /"\s*$/ &&
1793 $prevline =~ /\(/ &&
1794 $prevrawline !~ /\\n(?:\\t)*"\s*$/) {
1795 WARN
("SPLIT_STRING",
1796 "quoted string split across lines\n" . $hereprev);
1799 # check for spaces before a quoted newline
1800 if ($rawline =~ /^.*\".*\s\\n/) {
1801 WARN
("QUOTED_WHITESPACE_BEFORE_NEWLINE",
1802 "unnecessary whitespace before a quoted newline\n" . $herecurr);
1805 # check for adding lines without a newline.
1806 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1807 WARN
("MISSING_EOF_NEWLINE",
1808 "adding a line without newline at end of file\n" . $herecurr);
1811 # Blackfin: use hi/lo macros
1812 if ($realfile =~ m
@arch/blackfin/.*\
.S
$@
) {
1813 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
1814 my $herevet = "$here\n" . cat_vet
($line) . "\n";
1816 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
1818 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
1819 my $herevet = "$here\n" . cat_vet
($line) . "\n";
1821 "use the HI() macro, not (... >> 16)\n" . $herevet);
1825 # check we are in a valid source file C or perl if not then ignore this hunk
1826 next if ($realfile !~ /\.(h|c|pl)$/);
1828 # at the beginning of a line any tabs must come first and anything
1829 # more than 8 must use tabs.
1830 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1831 $rawline =~ /^\+\s* \s*/) {
1832 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
1833 ERROR
("CODE_INDENT",
1834 "code indent should use tabs where possible\n" . $herevet);
1838 # check for space before tabs.
1839 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
1840 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
1841 WARN
("SPACE_BEFORE_TAB",
1842 "please, no space before tabs\n" . $herevet);
1845 # check for && or || at the start of a line
1846 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
1847 CHK
("LOGICAL_CONTINUATIONS",
1848 "Logical continuations should be on the previous line\n" . $hereprev);
1851 # check multi-line statement indentation matches previous line
1852 if ($^V
&& $^V
ge 5.10.0 &&
1853 $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) {
1854 $prevline =~ /^\+(\t*)(.*)$/;
1858 my $pos = pos_last_openparen
($rest);
1860 $line =~ /^(\+| )([ \t]*)/;
1863 my $goodtabindent = $oldindent .
1866 my $goodspaceindent = $oldindent . " " x
$pos;
1868 if ($newindent ne $goodtabindent &&
1869 $newindent ne $goodspaceindent) {
1870 CHK
("PARENTHESIS_ALIGNMENT",
1871 "Alignment should match open parenthesis\n" . $hereprev);
1876 if ($line =~ /^\+.*\*[ \t]*\)[ \t]+/) {
1878 "No space is necessary after a cast\n" . $hereprev);
1881 if ($realfile =~ m@
^(drivers
/net
/|net
/)@
&&
1882 $rawline =~ /^\+[ \t]*\/\
*[ \t]*$/ &&
1883 $prevrawline =~ /^\+[ \t]*$/) {
1884 WARN
("NETWORKING_BLOCK_COMMENT_STYLE",
1885 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
1888 if ($realfile =~ m@
^(drivers
/net
/|net
/)@
&&
1889 $rawline !~ m@
^\
+[ \t]*\
*/[ \t]*$@ && #trailing */
1890 $rawline !~ m@
^\
+.*/\*.*\*/[ \t]*$@
&& #inline /*...*/
1891 $rawline !~ m@
^\
+.*\
*{2,}/[ \t]*$@ && #trailing **/
1892 $rawline =~ m@
^\
+[ \t]*.+\
*\
/[ \t]*$@) { #non blank */
1893 WARN
("NETWORKING_BLOCK_COMMENT_STYLE",
1894 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
1897 # check for spaces at the beginning of a line.
1899 # 1) within comments
1900 # 2) indented preprocessor commands
1902 if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/) {
1903 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
1904 WARN
("LEADING_SPACE",
1905 "please, no spaces at the start of a line\n" . $herevet);
1908 # check we are in a valid C source file if not then ignore this hunk
1909 next if ($realfile !~ /\.(h|c)$/);
1911 # discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
1912 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
1913 WARN
("CONFIG_EXPERIMENTAL",
1914 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
1917 # check for RCS/CVS revision markers
1918 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
1920 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1923 # Blackfin: don't use __builtin_bfin_[cs]sync
1924 if ($line =~ /__builtin_bfin_csync/) {
1925 my $herevet = "$here\n" . cat_vet
($line) . "\n";
1927 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
1929 if ($line =~ /__builtin_bfin_ssync/) {
1930 my $herevet = "$here\n" . cat_vet
($line) . "\n";
1932 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
1935 # Check for potential 'bare' types
1936 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
1938 #print "LINE<$line>\n";
1939 if ($linenr >= $suppress_statement &&
1940 $realcnt && $line =~ /.\s*\S/) {
1941 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
1942 ctx_statement_block
($linenr, $realcnt, 0);
1943 $stat =~ s/\n./\n /g;
1944 $cond =~ s/\n./\n /g;
1946 #print "linenr<$linenr> <$stat>\n";
1947 # If this statement has no statement boundaries within
1948 # it there is no point in retrying a statement scan
1949 # until we hit end of it.
1950 my $frag = $stat; $frag =~ s/;+\s*$//;
1951 if ($frag !~ /(?:{|;)/) {
1952 #print "skip<$line_nr_next>\n";
1953 $suppress_statement = $line_nr_next;
1956 # Find the real next line.
1957 $realline_next = $line_nr_next;
1958 if (defined $realline_next &&
1959 (!defined $lines[$realline_next - 1] ||
1960 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
1967 # Ignore goto labels.
1968 if ($s =~ /$Ident:\*$/s) {
1970 # Ignore functions being called
1971 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
1973 } elsif ($s =~ /^.\s*else\b/s) {
1975 # declarations always start with types
1976 } 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) {
1979 possible
($type, "A:" . $s);
1981 # definitions in global scope can only start with types
1982 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
1983 possible
($1, "B:" . $s);
1986 # any (foo ... *) is a pointer cast, and foo is a type
1987 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
1988 possible
($1, "C:" . $s);
1991 # Check for any sort of function declaration.
1992 # int foo(something bar, other baz);
1993 # void (*store_gdt)(x86_descr_ptr *);
1994 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
1995 my ($name_len) = length($1);
1998 substr($ctx, 0, $name_len + 1, '');
1999 $ctx =~ s/\)[^\)]*$//;
2001 for my $arg (split(/\s*,\s*/, $ctx)) {
2002 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
2004 possible
($1, "D:" . $s);
2012 # Checks which may be anchored in the context.
2015 # Check for switch () and associated case and default
2016 # statements should be at the same indent.
2017 if ($line=~/\bswitch\s*\(.*\)/) {
2020 my @ctx = ctx_block_outer
($linenr, $realcnt);
2022 for my $ctx (@ctx) {
2023 my ($clen, $cindent) = line_stats
($ctx);
2024 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2025 $indent != $cindent) {
2026 $err .= "$sep$ctx\n";
2033 ERROR
("SWITCH_CASE_INDENT_LEVEL",
2034 "switch and case should be at the same indent\n$hereline$err");
2038 # if/while/etc brace do not go on next line, unless defining a do while loop,
2039 # or if that brace on the next line is for something else
2040 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
2041 my $pre_ctx = "$1$2";
2043 my ($level, @ctx) = ctx_statement_level
($linenr, $realcnt, 0);
2045 if ($line =~ /^\+\t{6,}/) {
2046 WARN
("DEEP_INDENTATION",
2047 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2050 my $ctx_cnt = $realcnt - $#ctx - 1;
2051 my $ctx = join("\n", @ctx);
2053 my $ctx_ln = $linenr;
2054 my $ctx_skip = $realcnt;
2056 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2057 defined $lines[$ctx_ln - 1] &&
2058 $lines[$ctx_ln - 1] =~ /^-/)) {
2059 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2060 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
2064 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2065 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
2067 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
2069 "that open brace { should be on the previous line\n" .
2070 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2072 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2073 $ctx =~ /\)\s*\;\s*$/ &&
2074 defined $lines[$ctx_ln - 1])
2076 my ($nlength, $nindent) = line_stats
($lines[$ctx_ln - 1]);
2077 if ($nindent > $indent) {
2078 WARN
("TRAILING_SEMICOLON",
2079 "trailing semicolon indicates no statements, indent implies otherwise\n" .
2080 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2085 # Check relative indent for conditionals and blocks.
2086 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2087 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2088 ctx_statement_block
($linenr, $realcnt, 0)
2089 if (!defined $stat);
2090 my ($s, $c) = ($stat, $cond);
2092 substr($s, 0, length($c), '');
2094 # Make sure we remove the line prefixes as we have
2095 # none on the first line, and are going to readd them
2099 # Find out how long the conditional actually is.
2100 my @newlines = ($c =~ /\n/gs);
2101 my $cond_lines = 1 + $#newlines;
2103 # We want to check the first line inside the block
2104 # starting at the end of the conditional, so remove:
2105 # 1) any blank line termination
2106 # 2) any opening brace { on end of the line
2108 my $continuation = 0;
2110 $s =~ s/^.*\bdo\b//;
2112 if ($s =~ s/^\s*\\//) {
2115 if ($s =~ s/^\s*?\n//) {
2120 # Also ignore a loop construct at the end of a
2121 # preprocessor statement.
2122 if (($prevline =~ /^.\s*#\s*define\s/ ||
2123 $prevline =~ /\\\s*$/) && $continuation == 0) {
2129 while ($cond_ptr != $cond_lines) {
2130 $cond_ptr = $cond_lines;
2132 # If we see an #else/#elif then the code
2134 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2139 # 1) blank lines, they should be at 0,
2140 # 2) preprocessor lines, and
2142 if ($continuation ||
2144 $s =~ /^\s*#\s*?/ ||
2145 $s =~ /^\s*$Ident\s*:/) {
2146 $continuation = ($s =~ /^.*?\\\n/) ?
1 : 0;
2147 if ($s =~ s/^.*?\n//) {
2153 my (undef, $sindent) = line_stats
("+" . $s);
2154 my $stat_real = raw_line
($linenr, $cond_lines);
2156 # Check if either of these lines are modified, else
2157 # this is not this patch's fault.
2158 if (!defined($stat_real) ||
2159 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2162 if (defined($stat_real) && $cond_lines > 1) {
2163 $stat_real = "[...]\n$stat_real";
2166 #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";
2168 if ($check && (($sindent % 4) != 0 ||
2169 ($sindent <= $indent && $s ne ''))) {
2170 WARN
("SUSPECT_CODE_INDENT",
2171 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
2175 # Track the 'values' across context and added lines.
2176 my $opline = $line; $opline =~ s/^./ /;
2177 my ($curr_values, $curr_vars) =
2178 annotate_values
($opline . "\n", $prev_values);
2179 $curr_values = $prev_values . $curr_values;
2181 my $outline = $opline; $outline =~ s/\t/ /g;
2182 print "$linenr > .$outline\n";
2183 print "$linenr > $curr_values\n";
2184 print "$linenr > $curr_vars\n";
2186 $prev_values = substr($curr_values, -1);
2188 #ignore lines not being added
2189 if ($line=~/^[^\+]/) {next;}
2191 # TEST: allow direct testing of the type matcher.
2193 if ($line =~ /^.\s*$Declare\s*$/) {
2195 "TEST: is type\n" . $herecurr);
2196 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
2197 ERROR
("TEST_NOT_TYPE",
2198 "TEST: is not type ($1 is)\n". $herecurr);
2202 # TEST: allow direct testing of the attribute matcher.
2204 if ($line =~ /^.\s*$Modifier\s*$/) {
2206 "TEST: is attr\n" . $herecurr);
2207 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
2208 ERROR
("TEST_NOT_ATTR",
2209 "TEST: is not attr ($1 is)\n". $herecurr);
2214 # check for initialisation to aggregates open brace on the next line
2215 if ($line =~ /^.\s*{/ &&
2216 $prevline =~ /(?:^|[^=])=\s*$/) {
2218 "that open brace { should be on the previous line\n" . $hereprev);
2222 # Checks which are anchored on the added line.
2225 # check for malformed paths in #include statements (uses RAW line)
2226 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
2228 if ($path =~ m{//}) {
2229 ERROR
("MALFORMED_INCLUDE",
2230 "malformed #include filename\n" . $herecurr);
2232 if ($path =~ "^uapi/" && $realfile =~ m@
\binclude
/uapi
/@
) {
2233 ERROR
("UAPI_INCLUDE",
2234 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
2238 # no C99 // comments
2239 if ($line =~ m{//}) {
2240 ERROR
("C99_COMMENTS",
2241 "do not use C99 // comments\n" . $herecurr);
2243 # Remove C99 comments.
2245 $opline =~ s@
//.*@@
;
2247 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2248 # the whole statement.
2249 #print "APW <$lines[$realline_next - 1]>\n";
2250 if (defined $realline_next &&
2251 exists $lines[$realline_next - 1] &&
2252 !defined $suppress_export{$realline_next} &&
2253 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2254 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2255 # Handle definitions which produce identifiers with
2258 # EXPORT_SYMBOL(something_foo);
2260 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
2261 $name =~ /^${Ident}_$2/) {
2262 #print "FOO C name<$name>\n";
2263 $suppress_export{$realline_next} = 1;
2265 } elsif ($stat !~ /(?
:
2267 ^.DEFINE_
$Ident\
(\Q
$name\E\
)|
2268 ^.DECLARE_
$Ident\
(\Q
$name\E\
)|
2269 ^.LIST_HEAD\
(\Q
$name\E\
)|
2270 ^.(?
:$Storage\s
+)?
$Type\s
*\
(\s
*\
*\s
*\Q
$name\E\s
*\
)\s
*\
(|
2271 \b\Q
$name\E
(?
:\s
+$Attribute)*\s
*(?
:;|=|\
[|\
()
2273 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2274 $suppress_export{$realline_next} = 2;
2276 $suppress_export{$realline_next} = 1;
2279 if (!defined $suppress_export{$linenr} &&
2280 $prevline =~ /^.\s*$/ &&
2281 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2282 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2283 #print "FOO B <$lines[$linenr - 1]>\n";
2284 $suppress_export{$linenr} = 2;
2286 if (defined $suppress_export{$linenr} &&
2287 $suppress_export{$linenr} == 2) {
2288 WARN
("EXPORT_SYMBOL",
2289 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
2292 # check for global initialisers.
2293 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
2294 ERROR
("GLOBAL_INITIALISERS",
2295 "do not initialise globals to 0 or NULL\n" .
2298 # check for static initialisers.
2299 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2300 ERROR
("INITIALISED_STATIC",
2301 "do not initialise statics to 0 or NULL\n" .
2305 # check for static const char * arrays.
2306 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
2307 WARN
("STATIC_CONST_CHAR_ARRAY",
2308 "static const char * array should probably be static const char * const\n" .
2312 # check for static char foo[] = "bar" declarations.
2313 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
2314 WARN
("STATIC_CONST_CHAR_ARRAY",
2315 "static char array declaration should probably be static const char\n" .
2319 # check for declarations of struct pci_device_id
2320 if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) {
2321 WARN
("DEFINE_PCI_DEVICE_TABLE",
2322 "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr);
2325 # check for new typedefs, only function parameters and sparse annotations
2327 if ($line =~ /\btypedef\s/ &&
2328 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
2329 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
2330 $line !~ /\b$typeTypedefs\b/ &&
2331 $line !~ /\b__bitwise(?:__|)\b/) {
2332 WARN
("NEW_TYPEDEFS",
2333 "do not add new typedefs\n" . $herecurr);
2336 # * goes on variable not on type
2338 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2340 my ($from, $to) = ($2, $2);
2342 # Should start with a space.
2343 $to =~ s/^(\S)/ $1/;
2344 # Should not end with a space.
2346 # '*'s should not have spaces between.
2347 while ($to =~ s/\*\s+\*/\*\*/) {
2350 #print "from<$from> to<$to>\n";
2352 ERROR
("POINTER_LOCATION",
2353 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr);
2356 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2358 my ($from, $to, $ident) = ($2, $2, $3);
2360 # Should start with a space.
2361 $to =~ s/^(\S)/ $1/;
2362 # Should not end with a space.
2364 # '*'s should not have spaces between.
2365 while ($to =~ s/\*\s+\*/\*\*/) {
2367 # Modifiers should have spaces.
2368 $to =~ s/(\b$Modifier$)/$1 /;
2370 #print "from<$from> to<$to> ident<$ident>\n";
2371 if ($from ne $to && $ident !~ /^$Modifier$/) {
2372 ERROR
("POINTER_LOCATION",
2373 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr);
2377 # # no BUG() or BUG_ON()
2378 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
2379 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2380 # print "$herecurr";
2384 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
2385 WARN
("LINUX_VERSION_CODE",
2386 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
2389 # check for uses of printk_ratelimit
2390 if ($line =~ /\bprintk_ratelimit\s*\(/) {
2391 WARN
("PRINTK_RATELIMITED",
2392 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
2395 # printk should use KERN_* levels. Note that follow on printk's on the
2396 # same line do not need a level, so we use the current block context
2397 # to try and find and validate the current printk. In summary the current
2398 # printk includes all preceding printk's which have no newline on the end.
2399 # we assume the first bad printk is the one to report.
2400 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
2402 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2403 #print "CHECK<$lines[$ln - 1]\n";
2404 # we have a preceding printk if it ends
2405 # with "\n" ignore it, else it is to blame
2406 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2407 if ($rawlines[$ln - 1] !~ m{\\n"}) {
2414 WARN
("PRINTK_WITHOUT_KERN_LEVEL",
2415 "printk() should include KERN_ facility level\n" . $herecurr);
2419 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
2421 my $level = lc($orig);
2422 $level = "warn" if ($level eq "warning");
2423 my $level2 = $level;
2424 $level2 = "dbg" if ($level eq "debug");
2425 WARN
("PREFER_PR_LEVEL",
2426 "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
2429 if ($line =~ /\bpr_warning\s*\(/) {
2430 WARN
("PREFER_PR_LEVEL",
2431 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr);
2434 # function brace can't be on same line, except for #defines of do while,
2435 # or if closed on same line
2436 if (($line=~/$Type\s*$Ident\(.*\).*\s\{/) and
2437 !($line=~/\#\s*define.*do\s\{/) and !($line=~/\}/)) {
2439 "open brace '{' following function declarations go on the next line\n" . $herecurr);
2442 # open braces for enum, union and struct go on the same line.
2443 if ($line =~ /^.\s*{/ &&
2444 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
2446 "open brace '{' following $1 go on the same line\n" . $hereprev);
2449 # missing space after union, struct or enum definition
2450 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) {
2452 "missing space after $1 definition\n" . $herecurr);
2455 # check for spacing round square brackets; allowed:
2456 # 1. with a type on the left -- int [] a;
2457 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2458 # 3. inside a curly brace -- = { [0...10] = 5 }
2459 while ($line =~ /(.*?\s)\[/g) {
2460 my ($where, $prefix) = ($-[1], $1);
2461 if ($prefix !~ /$Type\s+$/ &&
2462 ($where != 0 || $prefix !~ /^.\s+$/) &&
2463 $prefix !~ /[{,]\s+$/) {
2464 ERROR
("BRACKET_SPACE",
2465 "space prohibited before open square bracket '['\n" . $herecurr);
2469 # check for spaces between functions and their parentheses.
2470 while ($line =~ /($Ident)\s+\(/g) {
2472 my $ctx_before = substr($line, 0, $-[1]);
2473 my $ctx = "$ctx_before$name";
2475 # Ignore those directives where spaces _are_ permitted.
2477 if|for|while|switch
|return|case
|
2478 volatile
|__volatile__
|
2479 __attribute__
|format
|__extension__
|
2483 # cpp #define statements have non-optional spaces, ie
2484 # if there is a space between the name and the open
2485 # parenthesis it is simply not a parameter group.
2486 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
2488 # cpp #elif statement condition may start with a (
2489 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
2491 # If this whole things ends with a type its most
2492 # likely a typedef for a function.
2493 } elsif ($ctx =~ /$Type$/) {
2497 "space prohibited between function name and open parenthesis '('\n" . $herecurr);
2501 # check for whitespace before a non-naked semicolon
2502 if ($line =~ /^\+.*\S\s+;/) {
2504 "space prohibited before semicolon\n" . $herecurr);
2507 # Check operator spacing.
2508 if (!($line=~/\#\s*include/)) {
2510 <<=|>>=|<=|>=|==|!=|
2511 \
+=|-=|\
*=|\
/=|%=|\
^=|\
|=|&=|
2512 =>|->|<<|>>|<|>|=|!|~|
2513 &&|\
|\
||,|\
^|\
+\
+|--|&|\
||\
+|-|\
*|\
/|%|
2516 my @elements = split(/($ops|;)/, $opline);
2519 my $blank = copy_spacing
($opline);
2521 for (my $n = 0; $n < $#elements; $n += 2) {
2522 $off += length($elements[$n]);
2524 # Pick up the preceding and succeeding characters.
2525 my $ca = substr($opline, 0, $off);
2527 if (length($opline) >= ($off + length($elements[$n + 1]))) {
2528 $cc = substr($opline, $off + length($elements[$n + 1]));
2530 my $cb = "$ca$;$cc";
2533 $a = 'V' if ($elements[$n] ne '');
2534 $a = 'W' if ($elements[$n] =~ /\s$/);
2535 $a = 'C' if ($elements[$n] =~ /$;$/);
2536 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
2537 $a = 'O' if ($elements[$n] eq '');
2538 $a = 'E' if ($ca =~ /^\s*$/);
2540 my $op = $elements[$n + 1];
2543 if (defined $elements[$n + 2]) {
2544 $c = 'V' if ($elements[$n + 2] ne '');
2545 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
2546 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
2547 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
2548 $c = 'O' if ($elements[$n + 2] eq '');
2549 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
2554 my $ctx = "${a}x${c}";
2556 my $at = "(ctx:$ctx)";
2558 my $ptr = substr($blank, 0, $off) . "^";
2559 my $hereptr = "$hereline$ptr\n";
2561 # Pull out the value of this operator.
2562 my $op_type = substr($curr_values, $off + 1, 1);
2564 # Get the full operator variant.
2565 my $opv = $op . substr($curr_vars, $off, 1);
2567 # Ignore operators passed as parameters.
2568 if ($op_type ne 'V' &&
2569 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
2572 # } elsif ($op =~ /^$;+$/) {
2574 # ; should have either the end of line or a space or \ after it
2575 } elsif ($op eq ';') {
2576 if ($ctx !~ /.x[WEBC]/ &&
2577 $cc !~ /^\\/ && $cc !~ /^;/) {
2579 "space required after that '$op' $at\n" . $hereptr);
2583 } elsif ($op eq '//') {
2587 # : when part of a bitfield
2588 } elsif ($op eq '->' || $opv eq ':B') {
2589 if ($ctx =~ /Wx.|.xW/) {
2591 "spaces prohibited around that '$op' $at\n" . $hereptr);
2594 # , must have a space on the right.
2595 } elsif ($op eq ',') {
2596 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
2598 "space required after that '$op' $at\n" . $hereptr);
2601 # '*' as part of a type definition -- reported already.
2602 } elsif ($opv eq '*_') {
2603 #warn "'*' is part of type\n";
2605 # unary operators should have a space before and
2606 # none after. May be left adjacent to another
2607 # unary operator, or a cast
2608 } elsif ($op eq '!' || $op eq '~' ||
2609 $opv eq '*U' || $opv eq '-U' ||
2610 $opv eq '&U' || $opv eq '&&U') {
2611 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
2613 "space required before that '$op' $at\n" . $hereptr);
2615 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
2616 # A unary '*' may be const
2618 } elsif ($ctx =~ /.xW/) {
2620 "space prohibited after that '$op' $at\n" . $hereptr);
2623 # unary ++ and unary -- are allowed no space on one side.
2624 } elsif ($op eq '++' or $op eq '--') {
2625 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
2627 "space required one side of that '$op' $at\n" . $hereptr);
2629 if ($ctx =~ /Wx[BE]/ ||
2630 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
2632 "space prohibited before that '$op' $at\n" . $hereptr);
2634 if ($ctx =~ /ExW/) {
2636 "space prohibited after that '$op' $at\n" . $hereptr);
2640 # << and >> may either have or not have spaces both sides
2641 } elsif ($op eq '<<' or $op eq '>>' or
2642 $op eq '&' or $op eq '^' or $op eq '|' or
2643 $op eq '+' or $op eq '-' or
2644 $op eq '*' or $op eq '/' or
2647 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
2649 "need consistent spacing around '$op' $at\n" .
2653 # A colon needs no spaces before when it is
2654 # terminating a case value or a label.
2655 } elsif ($opv eq ':C' || $opv eq ':L') {
2656 if ($ctx =~ /Wx./) {
2658 "space prohibited before that '$op' $at\n" . $hereptr);
2661 # All the others need spaces both sides.
2662 } elsif ($ctx !~ /[EWC]x[CWE]/) {
2665 # Ignore email addresses <foo@bar>
2667 $cc =~ /^\S+\@\S+>/) ||
2669 $ca =~ /<\S+\@\S+$/))
2675 if (($opv eq ':O' && $ca =~ /\?$/) ||
2676 ($op eq '?' && $cc =~ /^:/)) {
2682 "spaces required around that '$op' $at\n" . $hereptr);
2685 $off += length($elements[$n + 1]);
2689 # check for multiple assignments
2690 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
2691 CHK
("MULTIPLE_ASSIGNMENTS",
2692 "multiple assignments should be avoided\n" . $herecurr);
2695 ## # check for multiple declarations, allowing for a function declaration
2697 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
2698 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
2700 ## # Remove any bracketed sections to ensure we do not
2701 ## # falsly report the parameters of functions.
2703 ## while ($ln =~ s/\([^\(\)]*\)//g) {
2705 ## if ($ln =~ /,/) {
2706 ## WARN("MULTIPLE_DECLARATION",
2707 ## "declaring multiple variables together should be avoided\n" . $herecurr);
2711 #need space before brace following if, while, etc
2712 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
2715 "space required before the open brace '{'\n" . $herecurr);
2718 # closing brace should have a space following it when it has anything
2720 if ($line =~ /}(?!(?:,|;|\)))\S/) {
2722 "space required after that close brace '}'\n" . $herecurr);
2725 # check spacing on square brackets
2726 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
2728 "space prohibited after that open square bracket '['\n" . $herecurr);
2730 if ($line =~ /\s\]/) {
2732 "space prohibited before that close square bracket ']'\n" . $herecurr);
2735 # check spacing on parentheses
2736 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
2737 $line !~ /for\s*\(\s+;/) {
2739 "space prohibited after that open parenthesis '('\n" . $herecurr);
2741 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
2742 $line !~ /for\s*\(.*;\s+\)/ &&
2743 $line !~ /:\s+\)/) {
2745 "space prohibited before that close parenthesis ')'\n" . $herecurr);
2748 #goto labels aren't indented, allow a single space however
2749 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
2750 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
2751 WARN
("INDENTED_LABEL",
2752 "labels should not be indented\n" . $herecurr);
2755 # Return is not a function.
2756 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2760 # Flatten any parentheses
2761 $value =~ s/\(/ \(/g;
2762 $value =~ s/\)/\) /g;
2763 while ($value =~ s/\[[^\[\]]*\]/1/ ||
2764 $value !~ /(?
:$Ident|-?
$Constant)\s
*
2766 (?
:$Ident|-?
$Constant)/x
&&
2767 $value =~ s/\([^\(\)]*\)/1/) {
2769 #print "value<$value>\n";
2770 if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
2771 ERROR
("RETURN_PARENTHESES",
2772 "return is not a function, parentheses are not required\n" . $herecurr);
2774 } elsif ($spacing !~ /\s+/) {
2776 "space required before the open parenthesis '('\n" . $herecurr);
2779 # Return of what appears to be an errno should normally be -'ve
2780 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
2782 if ($name ne 'EOF' && $name ne 'ERROR') {
2783 WARN
("USE_NEGATIVE_ERRNO",
2784 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
2788 # Need a space before open parenthesis after if, while etc
2789 if ($line=~/\b(if|while|for|switch)\(/) {
2790 ERROR
("SPACING", "space required before the open parenthesis '('\n" . $herecurr);
2793 # Check for illegal assignment in if conditional -- and check for trailing
2794 # statements after the conditional.
2795 if ($line =~ /do\s*(?!{)/) {
2796 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2797 ctx_statement_block
($linenr, $realcnt, 0)
2798 if (!defined $stat);
2799 my ($stat_next) = ctx_statement_block
($line_nr_next,
2800 $remain_next, $off_next);
2801 $stat_next =~ s/\n./\n /g;
2802 ##print "stat<$stat> stat_next<$stat_next>\n";
2804 if ($stat_next =~ /^\s*while\b/) {
2805 # If the statement carries leading newlines,
2806 # then count those as offsets.
2808 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2810 statement_rawlines
($whitespace) - 1;
2812 $suppress_whiletrailers{$line_nr_next +
2816 if (!defined $suppress_whiletrailers{$linenr} &&
2817 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
2818 my ($s, $c) = ($stat, $cond);
2820 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
2821 ERROR
("ASSIGN_IN_IF",
2822 "do not use assignment in if condition\n" . $herecurr);
2825 # Find out what is on the end of the line after the
2827 substr($s, 0, length($c), '');
2829 $s =~ s/$;//g; # Remove any comments
2830 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2831 $c !~ /}\s*while\s*/)
2833 # Find out how long the conditional actually is.
2834 my @newlines = ($c =~ /\n/gs);
2835 my $cond_lines = 1 + $#newlines;
2838 $stat_real = raw_line
($linenr, $cond_lines)
2839 . "\n" if ($cond_lines);
2840 if (defined($stat_real) && $cond_lines > 1) {
2841 $stat_real = "[...]\n$stat_real";
2844 ERROR
("TRAILING_STATEMENTS",
2845 "trailing statements should be on next line\n" . $herecurr . $stat_real);
2849 # Check for bitwise tests written as boolean
2861 WARN
("HEXADECIMAL_BOOLEAN_TEST",
2862 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2865 # if and else should not have general statements after it
2866 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2868 $s =~ s/$;//g; # Remove any comments
2869 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2870 ERROR
("TRAILING_STATEMENTS",
2871 "trailing statements should be on next line\n" . $herecurr);
2874 # if should not continue a brace
2875 if ($line =~ /}\s*if\b/) {
2876 ERROR
("TRAILING_STATEMENTS",
2877 "trailing statements should be on next line\n" .
2880 # case and default should not have general statements after them
2881 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2883 (?
:\s
*$;*)(?
:\s
*{)?
(?
:\s
*$;*)(?
:\s
*\\)?\s
*$|
2887 ERROR
("TRAILING_STATEMENTS",
2888 "trailing statements should be on next line\n" . $herecurr);
2891 # Check for }<nl>else {, these must be at the same
2892 # indent level to be relevant to each other.
2893 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2894 $previndent == $indent) {
2895 ERROR
("ELSE_AFTER_BRACE",
2896 "else should follow close brace '}'\n" . $hereprev);
2899 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2900 $previndent == $indent) {
2901 my ($s, $c) = ctx_statement_block
($linenr, $realcnt, 0);
2903 # Find out what is on the end of the line after the
2905 substr($s, 0, length($c), '');
2908 if ($s =~ /^\s*;/) {
2909 ERROR
("WHILE_AFTER_BRACE",
2910 "while should follow close brace '}'\n" . $hereprev);
2915 while ($line =~ m{($Constant|$Lval)}g) {
2917 if ($var !~ /$Constant/ &&
2918 $var =~ /[A-Z]\w*[a-z]|[a-z]\w*[A-Z]/ &&
2919 !defined $camelcase{$var}) {
2920 $camelcase{$var} = 1;
2922 "Avoid CamelCase: <$var>\n" . $herecurr);
2926 #no spaces allowed after \ in define
2927 if ($line=~/\#\s*define.*\\\s$/) {
2928 WARN
("WHITESPACE_AFTER_LINE_CONTINUATION",
2929 "Whitepspace after \\ makes next lines useless\n" . $herecurr);
2932 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
2933 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
2935 my $checkfile = "include/linux/$file";
2936 if (-f
"$root/$checkfile" &&
2937 $realfile ne $checkfile &&
2938 $1 !~ /$allowed_asm_includes/)
2940 if ($realfile =~ m{^arch/}) {
2941 CHK
("ARCH_INCLUDE_LINUX",
2942 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2944 WARN
("INCLUDE_LINUX",
2945 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2950 # multi-statement macros should be enclosed in a do while loop, grab the
2951 # first statement and ensure its the whole macro if its not enclosed
2952 # in a known good container
2953 if ($realfile !~ m@
/vmlinux
.lds
.h
$@
&&
2954 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
2957 my ($off, $dstat, $dcond, $rest);
2959 ($dstat, $dcond, $ln, $cnt, $off) =
2960 ctx_statement_block
($linenr, $realcnt, 0);
2962 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
2963 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
2965 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
2967 $dstat =~ s/\\\n.//g;
2968 $dstat =~ s/^\s*//s;
2969 $dstat =~ s/\s*$//s;
2971 # Flatten any parentheses and braces
2972 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2973 $dstat =~ s/\{[^\{\}]*\}/1/ ||
2974 $dstat =~ s/\[[^\[\]]*\]/1/)
2978 # Flatten any obvious string concatentation.
2979 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
2980 $dstat =~ s/$Ident\s*("X*")/$1/)
2984 my $exceptions = qr{
2996 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
2998 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
2999 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
3000 $dstat !~ /^[!~-]?(?:$Ident|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo
3001 $dstat !~ /^'X'$/ && # character constants
3002 $dstat !~ /$exceptions/ &&
3003 $dstat !~ /^\.$Ident\s*=/ && # .foo =
3004 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
3005 $dstat !~ /^for\s*$Constant$/ && # for (...)
3006 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
3007 $dstat !~ /^do\s*{/ && # do {...
3008 $dstat !~ /^\(\{/) # ({...
3011 my $herectx = $here . "\n";
3012 my $cnt = statement_rawlines
($ctx);
3014 for (my $n = 0; $n < $cnt; $n++) {
3015 $herectx .= raw_line
($linenr, $n) . "\n";
3018 if ($dstat =~ /;/) {
3019 ERROR
("MULTISTATEMENT_MACRO_USE_DO_WHILE",
3020 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
3022 ERROR
("COMPLEX_MACRO",
3023 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
3027 # check for line continuations outside of #defines, preprocessor #, and asm
3030 if ($prevline !~ /^..*\\$/ &&
3031 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
3032 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
3033 $line =~ /^\+.*\\$/) {
3034 WARN
("LINE_CONTINUATIONS",
3035 "Avoid unnecessary line continuations\n" . $herecurr);
3039 # do {} while (0) macro tests:
3040 # single-statement macros do not need to be enclosed in do while (0) loop,
3041 # macro should not end with a semicolon
3042 if ($^V
&& $^V
ge 5.10.0 &&
3043 $realfile !~ m@
/vmlinux
.lds
.h
$@
&&
3044 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
3047 my ($off, $dstat, $dcond, $rest);
3049 ($dstat, $dcond, $ln, $cnt, $off) =
3050 ctx_statement_block
($linenr, $realcnt, 0);
3053 $dstat =~ s/\\\n.//g;
3055 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
3060 my $cnt = statement_rawlines
($ctx);
3061 my $herectx = $here . "\n";
3063 for (my $n = 0; $n < $cnt; $n++) {
3064 $herectx .= raw_line
($linenr, $n) . "\n";
3067 if (($stmts =~ tr/;/;/) == 1 &&
3068 $stmts !~ /^\s*(if|while|for|switch)\b/) {
3069 WARN
("SINGLE_STATEMENT_DO_WHILE_MACRO",
3070 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
3072 if (defined $semis && $semis ne "") {
3073 WARN
("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
3074 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
3079 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3080 # all assignments may have only one of the following with an assignment:
3083 # VMLINUX_SYMBOL(...)
3084 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
3085 WARN
("MISSING_VMLINUX_SYMBOL",
3086 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
3089 # check for redundant bracing round if etc
3090 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
3091 my ($level, $endln, @chunks) =
3092 ctx_statement_full
($linenr, $realcnt, 1);
3093 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
3094 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3095 if ($#chunks > 0 && $level == 0) {
3099 my $herectx = $here . "\n";
3100 my $ln = $linenr - 1;
3101 for my $chunk (@chunks) {
3102 my ($cond, $block) = @
{$chunk};
3104 # If the condition carries leading newlines, then count those as offsets.
3105 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
3106 my $offset = statement_rawlines
($whitespace) - 1;
3108 $allowed[$allow] = 0;
3109 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3111 # We have looked at and allowed this specific line.
3112 $suppress_ifbraces{$ln + $offset} = 1;
3114 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
3115 $ln += statement_rawlines
($block) - 1;
3117 substr($block, 0, length($cond), '');
3119 $seen++ if ($block =~ /^\s*{/);
3121 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
3122 if (statement_lines
($cond) > 1) {
3123 #print "APW: ALLOWED: cond<$cond>\n";
3124 $allowed[$allow] = 1;
3126 if ($block =~/\b(?:if|for|while)\b/) {
3127 #print "APW: ALLOWED: block<$block>\n";
3128 $allowed[$allow] = 1;
3130 if (statement_block_size
($block) > 1) {
3131 #print "APW: ALLOWED: lines block<$block>\n";
3132 $allowed[$allow] = 1;
3137 my $sum_allowed = 0;
3138 foreach (@allowed) {
3141 if ($sum_allowed == 0) {
3143 "braces {} are not necessary for any arm of this statement\n" . $herectx);
3144 } elsif ($sum_allowed != $allow &&
3147 "braces {} should be used on all arms of this statement\n" . $herectx);
3152 if (!defined $suppress_ifbraces{$linenr - 1} &&
3153 $line =~ /\b(if|while|for|else)\b/) {
3156 # Check the pre-context.
3157 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
3158 #print "APW: ALLOWED: pre<$1>\n";
3162 my ($level, $endln, @chunks) =
3163 ctx_statement_full
($linenr, $realcnt, $-[0]);
3165 # Check the condition.
3166 my ($cond, $block) = @
{$chunks[0]};
3167 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
3168 if (defined $cond) {
3169 substr($block, 0, length($cond), '');
3171 if (statement_lines
($cond) > 1) {
3172 #print "APW: ALLOWED: cond<$cond>\n";
3175 if ($block =~/\b(?:if|for|while)\b/) {
3176 #print "APW: ALLOWED: block<$block>\n";
3179 if (statement_block_size
($block) > 1) {
3180 #print "APW: ALLOWED: lines block<$block>\n";
3183 # Check the post-context.
3184 if (defined $chunks[1]) {
3185 my ($cond, $block) = @
{$chunks[1]};
3186 if (defined $cond) {
3187 substr($block, 0, length($cond), '');
3189 if ($block =~ /^\s*\{/) {
3190 #print "APW: ALLOWED: chunk-1 block<$block>\n";
3194 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
3195 my $herectx = $here . "\n";
3196 my $cnt = statement_rawlines
($block);
3198 for (my $n = 0; $n < $cnt; $n++) {
3199 $herectx .= raw_line
($linenr, $n) . "\n";
3202 WARN
("BRACES_SINGLE_STMT",
3203 "braces {} are not necessary for single statement blocks\n" . $herectx);
3207 # check for unnecessary blank lines around braces
3208 if (($line =~ /^..*}\s*$/ && $prevline =~ /^.\s*$/)) {
3210 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
3212 if (($line =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
3214 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
3217 # no volatiles please
3218 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
3219 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
3221 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
3225 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
3226 CHK
("REDUNDANT_CODE",
3227 "if this code is redundant consider removing it\n" .
3231 # check for needless "if (<foo>) fn(<foo>)" uses
3232 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
3233 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
3234 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
3236 "$1(NULL) is safe this check is probably not required\n" . $hereprev);
3240 # prefer usleep_range over udelay
3241 if ($line =~ /\budelay\s*\(\s*(\w+)\s*\)/) {
3242 # ignore udelay's < 10, however
3243 if (! (($1 =~ /(\d+)/) && ($1 < 10)) ) {
3245 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
3249 # warn about unexpectedly long msleep's
3250 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
3253 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
3257 # warn about #ifdefs in C files
3258 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
3259 # print "#ifdef in C files should be avoided\n";
3260 # print "$herecurr";
3264 # warn about spacing in #ifdefs
3265 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
3267 "exactly one space required after that #$1\n" . $herecurr);
3270 # check for spinlock_t definitions without a comment.
3271 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
3272 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
3274 if (!ctx_has_comment
($first_line, $linenr)) {
3275 CHK
("UNCOMMENTED_DEFINITION",
3276 "$1 definition without comment\n" . $herecurr);
3279 # check for memory barriers without a comment.
3280 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
3281 if (!ctx_has_comment
($first_line, $linenr)) {
3282 CHK
("MEMORY_BARRIER",
3283 "memory barrier without comment\n" . $herecurr);
3286 # check of hardware specific defines
3287 if ($line =~ m@
^.\s
*\#\s
*if.*\b(__i386__
|__powerpc64__
|__sun__
|__s390x__
)\b@
&& $realfile !~ m
@include/asm
-@
) {
3289 "architecture specific defines should be avoided\n" . $herecurr);
3292 # Check that the storage class is at the beginning of a declaration
3293 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
3294 WARN
("STORAGE_CLASS",
3295 "storage class should be at the beginning of the declaration\n" . $herecurr)
3298 # check the location of the inline attribute, that it is between
3299 # storage class and type.
3300 if ($line =~ /\b$Type\s+$Inline\b/ ||
3301 $line =~ /\b$Inline\s+$Storage\b/) {
3302 ERROR
("INLINE_LOCATION",
3303 "inline keyword should sit between storage class and type\n" . $herecurr);
3306 # Check for __inline__ and __inline, prefer inline
3307 if ($line =~ /\b(__inline__|__inline)\b/) {
3309 "plain inline is preferred over $1\n" . $herecurr);
3312 # Check for __attribute__ packed, prefer __packed
3313 if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
3314 WARN
("PREFER_PACKED",
3315 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
3318 # Check for __attribute__ aligned, prefer __aligned
3319 if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
3320 WARN
("PREFER_ALIGNED",
3321 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
3324 # Check for __attribute__ format(printf, prefer __printf
3325 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
3326 WARN
("PREFER_PRINTF",
3327 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr);
3330 # Check for __attribute__ format(scanf, prefer __scanf
3331 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
3332 WARN
("PREFER_SCANF",
3333 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr);
3336 # check for sizeof(&)
3337 if ($line =~ /\bsizeof\s*\(\s*\&/) {
3338 WARN
("SIZEOF_ADDRESS",
3339 "sizeof(& should be avoided\n" . $herecurr);
3342 # check for sizeof without parenthesis
3343 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
3344 WARN
("SIZEOF_PARENTHESIS",
3345 "sizeof $1 should be sizeof($1)\n" . $herecurr);
3348 # check for line continuations in quoted strings with odd counts of "
3349 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
3350 WARN
("LINE_CONTINUATIONS",
3351 "Avoid line continuations in quoted strings\n" . $herecurr);
3354 # check for struct spinlock declarations
3355 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
3356 WARN
("USE_SPINLOCK_T",
3357 "struct spinlock should be spinlock_t\n" . $herecurr);
3360 # Check for misused memsets
3361 if ($^V
&& $^V
ge 5.10.0 &&
3363 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
3369 if ($ms_size =~ /^(0x|)0$/i) {
3371 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
3372 } elsif ($ms_size =~ /^(0x|)1$/i) {
3374 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
3378 # typecasts on min/max could be min_t/max_t
3379 if ($^V
&& $^V
ge 5.10.0 &&
3381 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
3382 if (defined $2 || defined $7) {
3384 my $cast1 = deparenthesize
($2);
3386 my $cast2 = deparenthesize
($7);
3390 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
3391 $cast = "$cast1 or $cast2";
3392 } elsif ($cast1 ne "") {
3398 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
3402 # check usleep_range arguments
3403 if ($^V
&& $^V
ge 5.10.0 &&
3405 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
3409 WARN
("USLEEP_RANGE",
3410 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
3411 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
3413 WARN
("USLEEP_RANGE",
3414 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
3418 # check for new externs in .c files.
3419 if ($realfile =~ /\.c$/ && defined $stat &&
3420 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
3422 my $function_name = $1;
3423 my $paren_space = $2;
3426 if (defined $cond) {
3427 substr($s, 0, length($cond), '');
3429 if ($s =~ /^\s*;/ &&
3430 $function_name ne 'uninitialized_var')
3432 WARN
("AVOID_EXTERNS",
3433 "externs should be avoided in .c files\n" . $herecurr);
3436 if ($paren_space =~ /\n/) {
3437 WARN
("FUNCTION_ARGUMENTS",
3438 "arguments for function declarations should follow identifier\n" . $herecurr);
3441 } elsif ($realfile =~ /\.c$/ && defined $stat &&
3442 $stat =~ /^.\s*extern\s+/)
3444 WARN
("AVOID_EXTERNS",
3445 "externs should be avoided in .c files\n" . $herecurr);
3448 # checks for new __setup's
3449 if ($rawline =~ /\b__setup\("([^"]*)"/) {
3452 if (!grep(/$name/, @setup_docs)) {
3453 CHK
("UNDOCUMENTED_SETUP",
3454 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
3458 # check for pointless casting of kmalloc return
3459 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
3460 WARN
("UNNECESSARY_CASTS",
3461 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
3464 # check for multiple semicolons
3465 if ($line =~ /;\s*;\s*$/) {
3466 WARN
("ONE_SEMICOLON",
3467 "Statements terminations use 1 semicolon\n" . $herecurr);
3470 # check for switch/default statements without a break;
3471 if ($^V
&& $^V
ge 5.10.0 &&
3473 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
3475 my $herectx = $here . "\n";
3476 my $cnt = statement_rawlines
($stat);
3477 for (my $n = 0; $n < $cnt; $n++) {
3478 $herectx .= raw_line
($linenr, $n) . "\n";
3480 WARN
("DEFAULT_NO_BREAK",
3481 "switch default: should use break\n" . $herectx);
3484 # check for gcc specific __FUNCTION__
3485 if ($line =~ /__FUNCTION__/) {
3487 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
3490 # check for use of yield()
3491 if ($line =~ /\byield\s*\(\s*\)/) {
3493 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
3496 # check for semaphores initialized locked
3497 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
3498 WARN
("CONSIDER_COMPLETION",
3499 "consider using a completion\n" . $herecurr);
3502 # recommend kstrto* over simple_strto* and strict_strto*
3503 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
3504 WARN
("CONSIDER_KSTRTO",
3505 "$1 is obsolete, use k$3 instead\n" . $herecurr);
3508 # check for __initcall(), use device_initcall() explicitly please
3509 if ($line =~ /^.\s*__initcall\s*\(/) {
3510 WARN
("USE_DEVICE_INITCALL",
3511 "please use device_initcall() instead of __initcall()\n" . $herecurr);
3514 # check for various ops structs, ensure they are const.
3515 my $struct_ops = qr{acpi_dock_ops
|
3516 address_space_operations
|
3518 block_device_operations
|
3523 file_lock_operations
|
3533 lock_manager_operations
|
3539 pipe_buf_operations
|
3540 platform_hibernation_ops
|
3541 platform_suspend_ops
|
3546 soc_pcmcia_socket_ops
|
3552 if ($line !~ /\bconst\b/ &&
3553 $line =~ /\bstruct\s+($struct_ops)\b/) {
3554 WARN
("CONST_STRUCT",
3555 "struct $1 should normally be const\n" .
3559 # use of NR_CPUS is usually wrong
3560 # ignore definitions of NR_CPUS and usage to define arrays as likely right
3561 if ($line =~ /\bNR_CPUS\b/ &&
3562 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
3563 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
3564 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
3565 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
3566 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
3569 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
3572 # check for %L{u,d,i} in strings
3574 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
3575 $string = substr($rawline, $-[1], $+[1] - $-[1]);
3576 $string =~ s/%%/__/g;
3577 if ($string =~ /(?<!%)%L[udi]/) {
3579 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
3584 # whine mightly about in_atomic
3585 if ($line =~ /\bin_atomic\s*\(/) {
3586 if ($realfile =~ m@
^drivers
/@
) {
3588 "do not use in_atomic in drivers\n" . $herecurr);
3589 } elsif ($realfile !~ m@
^kernel
/@
) {
3591 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
3595 # check for lockdep_set_novalidate_class
3596 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
3597 $line =~ /__lockdep_no_validate__\s*\)/ ) {
3598 if ($realfile !~ m@
^kernel
/lockdep@
&&
3599 $realfile !~ m@
^include
/linux/lockdep@
&&
3600 $realfile !~ m@
^drivers
/base/core@
) {
3602 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
3606 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
3607 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
3608 WARN
("EXPORTED_WORLD_WRITABLE",
3609 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
3613 # If we have no input at all, then there is nothing to report on
3614 # so just keep quiet.
3615 if ($#rawlines == -1) {
3619 # In mailback mode only produce a report in the negative, for
3620 # things that appear to be patches.
3621 if ($mailback && ($clean == 1 || !$is_patch)) {
3625 # This is not a patch, and we are are in 'no-patch' mode so
3627 if (!$chk_patch && !$is_patch) {
3632 ERROR
("NOT_UNIFIED_DIFF",
3633 "Does not appear to be a unified-diff format patch\n");
3635 if ($is_patch && $chk_signoff && $signoff == 0) {
3636 ERROR
("MISSING_SIGN_OFF",
3637 "Missing Signed-off-by: line(s)\n");
3640 print report_dump
();
3641 if ($summary && !($clean == 1 && $quiet == 1)) {
3642 print "$filename " if ($summary_file);
3643 print "total: $cnt_error errors, $cnt_warn warnings, " .
3644 (($check)?
"$cnt_chk checks, " : "") .
3645 "$cnt_lines lines checked\n";
3646 print "\n" if ($quiet == 0);
3651 if ($^V
lt 5.10.0) {
3652 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
3653 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
3656 # If there were whitespace errors which cleanpatch can fix
3657 # then suggest that.
3658 if ($rpt_cleaners) {
3659 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
3660 print " scripts/cleanfile\n\n";
3665 if ($quiet == 0 && keys %ignore_type) {
3666 print "NOTE: Ignored message types:";
3667 foreach my $ignore (sort keys %ignore_type) {
3673 if ($clean == 1 && $quiet == 0) {
3674 print "$vname has no obvious style problems and is ready for submission.\n"
3676 if ($clean == 0 && $quiet == 0) {
3678 $vname has style problems
, please review
.
3680 If any of these errors are false positives
, please report
3681 them to the maintainer
, see CHECKPATCH
in MAINTAINERS
.