2 # (c) 2001, Dave Jones. (the file handling bit)
3 # (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
4 # (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
5 # (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
6 # Licensed under the terms of the GNU GPL License version 2
15 use Getopt::Long qw(:config no_auto_abbrev);
35 my $configuration_file = ".checkpatch.conf";
36 my $max_line_length = 80;
42 Usage: $P [OPTION]... [FILE]...
47 --no-tree run without a kernel tree
48 --no-signoff do not check for 'Signed-off-by' line
49 --patch treat FILE as patchfile (default)
50 --emacs emacs compile window format
51 --terse one line per report
52 -f, --file treat FILE as regular source file
53 --subjective, --strict enable more subjective tests
54 --ignore TYPE(,TYPE2...) ignore various comma separated message types
55 --max-line-length=n set the maximum line length, if exceeded, warn
56 --show-types show the message "types" in the output
57 --root=PATH PATH to the kernel tree root
58 --no-summary suppress the per-file summary
59 --mailback only produce a report in case of warnings/errors
60 --summary-file include the filename in summary
61 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
62 'values', 'possible', 'type', and 'attr' (default
64 --test-only=WORD report only warnings/errors containing WORD
66 -h, --help, --version display this help and exit
68 When FILE is - read standard input.
74 my $conf = which_conf($configuration_file);
77 open(my $conffile, '<', "$conf")
78 or warn "$P: Can't find a readable $configuration_file file $!\n";
83 $line =~ s/\s*\n?$//g;
87 next if ($line =~ m/^\s*#/);
88 next if ($line =~ m/^\s*$/);
90 my @words = split(" ", $line);
91 foreach my $word (@words) {
92 last if ($word =~ m/^#/);
93 push (@conf_args, $word);
97 unshift(@ARGV, @conf_args) if @conf_args;
101 'q|quiet+' => \$quiet,
103 'signoff!' => \$chk_signoff,
104 'patch!' => \$chk_patch,
108 'subjective!' => \$check,
109 'strict!' => \$check,
110 'ignore=s' => \@ignore,
111 'show-types!' => \$show_types,
112 'max-line-length=i' => \$max_line_length,
114 'summary!' => \$summary,
115 'mailback!' => \$mailback,
116 'summary-file!' => \$summary_file,
118 'debug=s' => \%debug,
119 'test-only=s' => \$tst_only,
129 print "$P: no input files\n";
133 @ignore = split(/,/, join(',',@ignore));
134 foreach my $word (@ignore) {
135 $word =~ s/\s*\n?$//g;
138 $word =~ tr/[a-z]/[A-Z]/;
140 next if ($word =~ m/^\s*#/);
141 next if ($word =~ m/^\s*$/);
143 $ignore_type{$word}++;
147 my $dbg_possible = 0;
150 for my $key (keys %debug) {
152 eval "\${dbg_$key} = '$debug{$key}';";
156 my $rpt_cleaners = 0;
165 if (!top_of_kernel_tree($root)) {
166 die "$P: $root: --root does not point at a valid tree\n";
169 if (top_of_kernel_tree('.')) {
171 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
172 top_of_kernel_tree($1)) {
177 if (!defined $root) {
178 print "Must be run from the top-level dir. of a kernel tree\n";
183 my $emitted_corrupt = 0;
186 [A-Za-z_][A-Za-z\d_]*
187 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
189 our $Storage = qr{extern|static|asmlinkage};
202 # Notes to $Attribute:
203 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
222 __(?:mem|cpu|dev|)(?:initdata|initconst|init\b)|
223 ____cacheline_aligned|
224 ____cacheline_aligned_in_smp|
225 ____cacheline_internodealigned_in_smp|
229 our $Inline = qr{inline|__always_inline|noinline};
230 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
231 our $Lval = qr{$Ident(?:$Member)*};
233 our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
234 our $Binary = qr{(?i)0b[01]+$Int_type?};
235 our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
236 our $Int = qr{[0-9]+$Int_type?};
237 our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
238 our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
239 our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
240 our $Float = qr{$Float_hex|$Float_dec|$Float_int};
241 our $Constant = qr{$Float|$Binary|$Hex|$Int};
242 our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
243 our $Compare = qr{<=|>=|==|!=|<|>};
247 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
254 our $NON_ASCII_UTF8 = qr{
255 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
256 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
257 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
258 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
259 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
260 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
261 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
265 [\x09\x0A\x0D\x20-\x7E] # ASCII
269 our $typeTypedefs = qr{(?x:
270 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
274 our $logFunctions = qr{(?x:
275 printk(?:_ratelimited|_once|)|
276 [a-z0-9]+_(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
277 WARN(?:_RATELIMIT|_ONCE|)|
282 our $signature_tags = qr{(?xi:
295 qr{(?:unsigned\s+)?char},
296 qr{(?:unsigned\s+)?short},
297 qr{(?:unsigned\s+)?int},
298 qr{(?:unsigned\s+)?long},
299 qr{(?:unsigned\s+)?long\s+int},
300 qr{(?:unsigned\s+)?long\s+long},
301 qr{(?:unsigned\s+)?long\s+long\s+int},
310 qr{${Ident}_handler},
311 qr{${Ident}_handler_fn},
313 our @modifierList = (
317 our $allowed_asm_includes = qr{(?x:
321 # memory.h: ARM has a custom one
324 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
325 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
326 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
328 (?:$Modifier\s+|const\s+)*
330 (?:typeof|__typeof__)\s*\([^\)]*\)|
334 (?:\s+$Modifier|\s+const)*
338 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*|\[\])+|(?:\s*\[\s*\])+)?
339 (?:\s+$Inline|\s+$Modifier)*
341 $Declare = qr{(?:$Storage\s+)?$Type};
346 our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
348 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
349 # requires at least perl version v5.10.0
350 # Any use must be runtime checked with $^V
352 our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
353 our $LvalOrFunc = qr{($Lval)\s*($balanced_parens{0,1})\s*};
354 our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
358 return "" if (!defined($string));
359 $string =~ s@^\s*\(\s*@@g;
360 $string =~ s@\s*\)\s*$@@g;
361 $string =~ s@\s+@ @g;
365 $chk_signoff = 0 if ($file);
370 for my $filename (@ARGV) {
373 open($FILE, '-|', "diff -u /dev/null $filename") ||
374 die "$P: $filename: diff failed - $!\n";
375 } elsif ($filename eq '-') {
376 open($FILE, '<&STDIN');
378 open($FILE, '<', "$filename") ||
379 die "$P: $filename: open failed - $!\n";
381 if ($filename eq '-') {
382 $vname = 'Your patch';
391 if (!process($filename)) {
400 sub top_of_kernel_tree {
404 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
405 "README", "Documentation", "arch", "include", "drivers",
406 "fs", "init", "ipc", "kernel", "lib", "scripts",
409 foreach my $check (@tree_check) {
410 if (! -e $root . '/' . $check) {
418 my ($formatted_email) = @_;
424 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
427 $comment = $3 if defined $3;
428 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
430 $comment = $2 if defined $2;
431 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
433 $comment = $2 if defined $2;
434 $formatted_email =~ s/$address.*$//;
435 $name = $formatted_email;
436 $name =~ s/^\s+|\s+$//g;
437 $name =~ s/^\"|\"$//g;
438 # If there's a name left after stripping spaces and
439 # leading quotes, and the address doesn't have both
440 # leading and trailing angle brackets, the address
442 # "joe smith joe@smith.com" bad
443 # "joe smith <joe@smith.com" bad
444 if ($name ne "" && $address !~ /^<[^>]+>$/) {
451 $name =~ s/^\s+|\s+$//g;
452 $name =~ s/^\"|\"$//g;
453 $address =~ s/^\s+|\s+$//g;
454 $address =~ s/^\<|\>$//g;
456 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
457 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
461 return ($name, $address, $comment);
465 my ($name, $address) = @_;
469 $name =~ s/^\s+|\s+$//g;
470 $name =~ s/^\"|\"$//g;
471 $address =~ s/^\s+|\s+$//g;
473 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
474 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
479 $formatted_email = "$address";
481 $formatted_email = "$name <$address>";
484 return $formatted_email;
490 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
491 if (-e "$path/$conf") {
492 return "$path/$conf";
504 for my $c (split(//, $str)) {
508 for (; ($n % 8) != 0; $n++) {
520 (my $res = shift) =~ tr/\t/ /c;
527 # Drop the diff line leader and expand tabs
529 $line = expand_tabs($line);
531 # Pick the indent from the front of the line.
532 my ($white) = ($line =~ /^(\s*)/);
534 return (length($line), length($white));
537 my $sanitise_quote = '';
539 sub sanitise_line_reset {
540 my ($in_comment) = @_;
543 $sanitise_quote = '*/';
545 $sanitise_quote = '';
558 # Always copy over the diff marker.
559 $res = substr($line, 0, 1);
561 for ($off = 1; $off < length($line); $off++) {
562 $c = substr($line, $off, 1);
564 # Comments we are wacking completly including the begin
565 # and end, all to $;.
566 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
567 $sanitise_quote = '*/';
569 substr($res, $off, 2, "$;$;");
573 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
574 $sanitise_quote = '';
575 substr($res, $off, 2, "$;$;");
579 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
580 $sanitise_quote = '//';
582 substr($res, $off, 2, $sanitise_quote);
587 # A \ in a string means ignore the next character.
588 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
590 substr($res, $off, 2, 'XX');
595 if ($c eq "'" || $c eq '"') {
596 if ($sanitise_quote eq '') {
597 $sanitise_quote = $c;
599 substr($res, $off, 1, $c);
601 } elsif ($sanitise_quote eq $c) {
602 $sanitise_quote = '';
606 #print "c<$c> SQ<$sanitise_quote>\n";
607 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
608 substr($res, $off, 1, $;);
609 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
610 substr($res, $off, 1, $;);
611 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
612 substr($res, $off, 1, 'X');
614 substr($res, $off, 1, $c);
618 if ($sanitise_quote eq '//') {
619 $sanitise_quote = '';
622 # The pathname on a #include may be surrounded by '<' and '>'.
623 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
624 my $clean = 'X' x length($1);
625 $res =~ s@\<.*\>@<$clean>@;
627 # The whole of a #error is a string.
628 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
629 my $clean = 'X' x length($1);
630 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
636 sub get_quoted_string {
637 my ($line, $rawline) = @_;
639 return "" if ($line !~ m/(\"[X]+\")/g);
640 return substr($rawline, $-[0], $+[0] - $-[0]);
643 sub ctx_statement_block {
644 my ($linenr, $remain, $off) = @_;
645 my $line = $linenr - 1;
662 @stack = (['', 0]) if ($#stack == -1);
664 #warn "CSB: blk<$blk> remain<$remain>\n";
665 # If we are about to drop off the end, pull in more
668 for (; $remain > 0; $line++) {
669 last if (!defined $lines[$line]);
670 next if ($lines[$line] =~ /^-/);
673 $blk .= $lines[$line] . "\n";
678 # Bail if there is no further context.
679 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
683 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
689 $c = substr($blk, $off, 1);
690 $remainder = substr($blk, $off);
692 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
694 # Handle nested #if/#else.
695 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
696 push(@stack, [ $type, $level ]);
697 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
698 ($type, $level) = @{$stack[$#stack - 1]};
699 } elsif ($remainder =~ /^#\s*endif\b/) {
700 ($type, $level) = @{pop(@stack)};
703 # Statement ends at the ';' or a close '}' at the
705 if ($level == 0 && $c eq ';') {
709 # An else is really a conditional as long as its not else if
710 if ($level == 0 && $coff_set == 0 &&
711 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
712 $remainder =~ /^(else)(?:\s|{)/ &&
713 $remainder !~ /^else\s+if\b/) {
714 $coff = $off + length($1) - 1;
716 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
717 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
720 if (($type eq '' || $type eq '(') && $c eq '(') {
724 if ($type eq '(' && $c eq ')') {
726 $type = ($level != 0)? '(' : '';
728 if ($level == 0 && $coff < $soff) {
731 #warn "CSB: mark coff<$coff>\n";
734 if (($type eq '' || $type eq '{') && $c eq '{') {
738 if ($type eq '{' && $c eq '}') {
740 $type = ($level != 0)? '{' : '';
743 if (substr($blk, $off + 1, 1) eq ';') {
749 # Preprocessor commands end at the newline unless escaped.
750 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
758 # We are truly at the end, so shuffle to the next line.
765 my $statement = substr($blk, $soff, $off - $soff + 1);
766 my $condition = substr($blk, $soff, $coff - $soff + 1);
768 #warn "STATEMENT<$statement>\n";
769 #warn "CONDITION<$condition>\n";
771 #print "coff<$coff> soff<$off> loff<$loff>\n";
773 return ($statement, $condition,
774 $line, $remain + 1, $off - $loff + 1, $level);
777 sub statement_lines {
780 # Strip the diff line prefixes and rip blank lines at start and end.
781 $stmt =~ s/(^|\n)./$1/g;
785 my @stmt_lines = ($stmt =~ /\n/g);
787 return $#stmt_lines + 2;
790 sub statement_rawlines {
793 my @stmt_lines = ($stmt =~ /\n/g);
795 return $#stmt_lines + 2;
798 sub statement_block_size {
801 $stmt =~ s/(^|\n)./$1/g;
807 my @stmt_lines = ($stmt =~ /\n/g);
808 my @stmt_statements = ($stmt =~ /;/g);
810 my $stmt_lines = $#stmt_lines + 2;
811 my $stmt_statements = $#stmt_statements + 1;
813 if ($stmt_lines > $stmt_statements) {
816 return $stmt_statements;
820 sub ctx_statement_full {
821 my ($linenr, $remain, $off) = @_;
822 my ($statement, $condition, $level);
826 # Grab the first conditional/block pair.
827 ($statement, $condition, $linenr, $remain, $off, $level) =
828 ctx_statement_block($linenr, $remain, $off);
829 #print "F: c<$condition> s<$statement> remain<$remain>\n";
830 push(@chunks, [ $condition, $statement ]);
831 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
832 return ($level, $linenr, @chunks);
835 # Pull in the following conditional/block pairs and see if they
836 # could continue the statement.
838 ($statement, $condition, $linenr, $remain, $off, $level) =
839 ctx_statement_block($linenr, $remain, $off);
840 #print "C: c<$condition> s<$statement> remain<$remain>\n";
841 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
843 push(@chunks, [ $condition, $statement ]);
846 return ($level, $linenr, @chunks);
850 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
852 my $start = $linenr - 1;
859 my @stack = ($level);
860 for ($line = $start; $remain > 0; $line++) {
861 next if ($rawlines[$line] =~ /^-/);
864 $blk .= $rawlines[$line];
866 # Handle nested #if/#else.
867 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
868 push(@stack, $level);
869 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
870 $level = $stack[$#stack - 1];
871 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
872 $level = pop(@stack);
875 foreach my $c (split(//, $lines[$line])) {
876 ##print "C<$c>L<$level><$open$close>O<$off>\n";
882 if ($c eq $close && $level > 0) {
884 last if ($level == 0);
885 } elsif ($c eq $open) {
890 if (!$outer || $level <= 1) {
891 push(@res, $rawlines[$line]);
894 last if ($level == 0);
897 return ($level, @res);
899 sub ctx_block_outer {
900 my ($linenr, $remain) = @_;
902 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
906 my ($linenr, $remain) = @_;
908 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
912 my ($linenr, $remain, $off) = @_;
914 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
917 sub ctx_block_level {
918 my ($linenr, $remain) = @_;
920 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
922 sub ctx_statement_level {
923 my ($linenr, $remain, $off) = @_;
925 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
928 sub ctx_locate_comment {
929 my ($first_line, $end_line) = @_;
931 # Catch a comment on the end of the line itself.
932 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
933 return $current_comment if (defined $current_comment);
935 # Look through the context and try and figure out if there is a
938 $current_comment = '';
939 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
940 my $line = $rawlines[$linenr - 1];
942 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
945 if ($line =~ m@/\*@) {
948 if (!$in_comment && $current_comment ne '') {
949 $current_comment = '';
951 $current_comment .= $line . "\n" if ($in_comment);
952 if ($line =~ m@\*/@) {
957 chomp($current_comment);
958 return($current_comment);
960 sub ctx_has_comment {
961 my ($first_line, $end_line) = @_;
962 my $cmt = ctx_locate_comment($first_line, $end_line);
964 ##print "LINE: $rawlines[$end_line - 1 ]\n";
965 ##print "CMMT: $cmt\n";
971 my ($linenr, $cnt) = @_;
973 my $offset = $linenr - 1;
978 $line = $rawlines[$offset++];
979 next if (defined($line) && $line =~ /^-/);
991 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
994 $coded = sprintf("^%c", unpack('C', $2) + 64);
1003 my $av_preprocessor = 0;
1008 sub annotate_reset {
1009 $av_preprocessor = 0;
1011 @av_paren_type = ('E');
1012 $av_pend_colon = 'O';
1015 sub annotate_values {
1016 my ($stream, $type) = @_;
1019 my $var = '_' x length($stream);
1022 print "$stream\n" if ($dbg_values > 1);
1024 while (length($cur)) {
1025 @av_paren_type = ('E') if ($#av_paren_type < 0);
1026 print " <" . join('', @av_paren_type) .
1027 "> <$type> <$av_pending>" if ($dbg_values > 1);
1028 if ($cur =~ /^(\s+)/o) {
1029 print "WS($1)\n" if ($dbg_values > 1);
1030 if ($1 =~ /\n/ && $av_preprocessor) {
1031 $type = pop(@av_paren_type);
1032 $av_preprocessor = 0;
1035 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1036 print "CAST($1)\n" if ($dbg_values > 1);
1037 push(@av_paren_type, $type);
1040 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1041 print "DECLARE($1)\n" if ($dbg_values > 1);
1044 } elsif ($cur =~ /^($Modifier)\s*/) {
1045 print "MODIFIER($1)\n" if ($dbg_values > 1);
1048 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1049 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1050 $av_preprocessor = 1;
1051 push(@av_paren_type, $type);
1057 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1058 print "UNDEF($1)\n" if ($dbg_values > 1);
1059 $av_preprocessor = 1;
1060 push(@av_paren_type, $type);
1062 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1063 print "PRE_START($1)\n" if ($dbg_values > 1);
1064 $av_preprocessor = 1;
1066 push(@av_paren_type, $type);
1067 push(@av_paren_type, $type);
1070 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1071 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1072 $av_preprocessor = 1;
1074 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1078 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1079 print "PRE_END($1)\n" if ($dbg_values > 1);
1081 $av_preprocessor = 1;
1083 # Assume all arms of the conditional end as this
1084 # one does, and continue as if the #endif was not here.
1085 pop(@av_paren_type);
1086 push(@av_paren_type, $type);
1089 } elsif ($cur =~ /^(\\\n)/o) {
1090 print "PRECONT($1)\n" if ($dbg_values > 1);
1092 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1093 print "ATTR($1)\n" if ($dbg_values > 1);
1094 $av_pending = $type;
1097 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1098 print "SIZEOF($1)\n" if ($dbg_values > 1);
1104 } elsif ($cur =~ /^(if|while|for)\b/o) {
1105 print "COND($1)\n" if ($dbg_values > 1);
1109 } elsif ($cur =~/^(case)/o) {
1110 print "CASE($1)\n" if ($dbg_values > 1);
1111 $av_pend_colon = 'C';
1114 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1115 print "KEYWORD($1)\n" if ($dbg_values > 1);
1118 } elsif ($cur =~ /^(\()/o) {
1119 print "PAREN('$1')\n" if ($dbg_values > 1);
1120 push(@av_paren_type, $av_pending);
1124 } elsif ($cur =~ /^(\))/o) {
1125 my $new_type = pop(@av_paren_type);
1126 if ($new_type ne '_') {
1128 print "PAREN('$1') -> $type\n"
1129 if ($dbg_values > 1);
1131 print "PAREN('$1')\n" if ($dbg_values > 1);
1134 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1135 print "FUNC($1)\n" if ($dbg_values > 1);
1139 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1140 if (defined $2 && $type eq 'C' || $type eq 'T') {
1141 $av_pend_colon = 'B';
1142 } elsif ($type eq 'E') {
1143 $av_pend_colon = 'L';
1145 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1148 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1149 print "IDENT($1)\n" if ($dbg_values > 1);
1152 } elsif ($cur =~ /^($Assignment)/o) {
1153 print "ASSIGN($1)\n" if ($dbg_values > 1);
1156 } elsif ($cur =~/^(;|{|})/) {
1157 print "END($1)\n" if ($dbg_values > 1);
1159 $av_pend_colon = 'O';
1161 } elsif ($cur =~/^(,)/) {
1162 print "COMMA($1)\n" if ($dbg_values > 1);
1165 } elsif ($cur =~ /^(\?)/o) {
1166 print "QUESTION($1)\n" if ($dbg_values > 1);
1169 } elsif ($cur =~ /^(:)/o) {
1170 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1172 substr($var, length($res), 1, $av_pend_colon);
1173 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1178 $av_pend_colon = 'O';
1180 } elsif ($cur =~ /^(\[)/o) {
1181 print "CLOSE($1)\n" if ($dbg_values > 1);
1184 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1187 print "OPV($1)\n" if ($dbg_values > 1);
1194 substr($var, length($res), 1, $variant);
1197 } elsif ($cur =~ /^($Operators)/o) {
1198 print "OP($1)\n" if ($dbg_values > 1);
1199 if ($1 ne '++' && $1 ne '--') {
1203 } elsif ($cur =~ /(^.)/o) {
1204 print "C($1)\n" if ($dbg_values > 1);
1207 $cur = substr($cur, length($1));
1208 $res .= $type x length($1);
1212 return ($res, $var);
1216 my ($possible, $line) = @_;
1217 my $notPermitted = qr{(?:
1234 ^(?:typedef|struct|enum)\b
1236 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1237 if ($possible !~ $notPermitted) {
1238 # Check for modifiers.
1239 $possible =~ s/\s*$Storage\s*//g;
1240 $possible =~ s/\s*$Sparse\s*//g;
1241 if ($possible =~ /^\s*$/) {
1243 } elsif ($possible =~ /\s/) {
1244 $possible =~ s/\s*$Type\s*//g;
1245 for my $modifier (split(' ', $possible)) {
1246 if ($modifier !~ $notPermitted) {
1247 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1248 push(@modifierList, $modifier);
1253 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1254 push(@typeList, $possible);
1258 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1265 return !defined $ignore_type{$_[0]};
1269 if (!show_type($_[1]) ||
1270 (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) {
1275 $line = "$prefix$_[0]:$_[1]: $_[2]\n";
1277 $line = "$prefix$_[0]: $_[2]\n";
1279 $line = (split('\n', $line))[0] . "\n" if ($terse);
1281 push(our @report, $line);
1290 if (report("ERROR", $_[0], $_[1])) {
1296 if (report("WARNING", $_[0], $_[1])) {
1302 if ($check && report("CHECK", $_[0], $_[1])) {
1308 sub check_absolute_file {
1309 my ($absolute, $herecurr) = @_;
1310 my $file = $absolute;
1312 ##print "absolute<$absolute>\n";
1314 # See if any suffix of this path is a path within the tree.
1315 while ($file =~ s@^[^/]*/@@) {
1316 if (-f "$root/$file") {
1317 ##print "file<$file>\n";
1325 # It is, so see if the prefix is acceptable.
1326 my $prefix = $absolute;
1327 substr($prefix, -length($file)) = '';
1329 ##print "prefix<$prefix>\n";
1330 if ($prefix ne ".../") {
1331 WARN("USE_RELATIVE_PATH",
1332 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1336 sub pos_last_openparen {
1341 my $opens = $line =~ tr/\(/\(/;
1342 my $closes = $line =~ tr/\)/\)/;
1344 my $last_openparen = 0;
1346 if (($opens == 0) || ($closes >= $opens)) {
1350 my $len = length($line);
1352 for ($pos = 0; $pos < $len; $pos++) {
1353 my $string = substr($line, $pos);
1354 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1355 $pos += length($1) - 1;
1356 } elsif (substr($line, $pos, 1) eq '(') {
1357 $last_openparen = $pos;
1358 } elsif (index($string, '(') == -1) {
1363 return $last_openparen + 1;
1367 my $filename = shift;
1373 my $stashrawline="";
1384 my $in_header_lines = 1;
1385 my $in_commit_log = 0; #Scanning lines before patch
1387 my $non_utf8_charset = 0;
1395 # Trace the real file/line as we go.
1401 my $comment_edge = 0;
1405 my $prev_values = 'E';
1408 my %suppress_ifbraces;
1409 my %suppress_whiletrailers;
1410 my %suppress_export;
1411 my $suppress_statement = 0;
1415 # Pre-scan the patch sanitizing the lines.
1416 # Pre-scan the patch looking for any __setup documentation.
1418 my @setup_docs = ();
1421 sanitise_line_reset();
1423 foreach my $rawline (@rawlines) {
1427 if ($rawline=~/^\+\+\+\s+(\S+)/) {
1429 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1434 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1443 # Guestimate if this is a continuing comment. Run
1444 # the context looking for a comment "edge". If this
1445 # edge is a close comment then we must be in a comment
1449 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1450 next if (defined $rawlines[$ln - 1] &&
1451 $rawlines[$ln - 1] =~ /^-/);
1453 #print "RAW<$rawlines[$ln - 1]>\n";
1454 last if (!defined $rawlines[$ln - 1]);
1455 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1456 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1461 if (defined $edge && $edge eq '*/') {
1465 # Guestimate if this is a continuing comment. If this
1466 # is the start of a diff block and this line starts
1467 # ' *' then it is very likely a comment.
1468 if (!defined $edge &&
1469 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1474 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1475 sanitise_line_reset($in_comment);
1477 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1478 # Standardise the strings and chars within the input to
1479 # simplify matching -- only bother with positive lines.
1480 $line = sanitise_line($rawline);
1482 push(@lines, $line);
1485 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1490 #print "==>$rawline\n";
1491 #print "-->$line\n";
1493 if ($setup_docs && $line =~ /^\+/) {
1494 push(@setup_docs, $line);
1502 foreach my $line (@lines) {
1505 my $rawline = $rawlines[$linenr - 1];
1507 #extract the line range in the file after the patch is applied
1508 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1510 $first_line = $linenr + 1;
1520 %suppress_ifbraces = ();
1521 %suppress_whiletrailers = ();
1522 %suppress_export = ();
1523 $suppress_statement = 0;
1526 # track the line number as we move through the hunk, note that
1527 # new versions of GNU diff omit the leading space on completely
1528 # blank context lines so we need to count that too.
1529 } elsif ($line =~ /^( |\+|$)/) {
1531 $realcnt-- if ($realcnt != 0);
1533 # Measure the line length and indent.
1534 ($length, $indent) = line_stats($rawline);
1536 # Track the previous line.
1537 ($prevline, $stashline) = ($stashline, $line);
1538 ($previndent, $stashindent) = ($stashindent, $indent);
1539 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1541 #warn "line<$line>\n";
1543 } elsif ($realcnt == 1) {
1547 my $hunk_line = ($realcnt != 0);
1549 #make up the handle for any error we report on this line
1550 $prefix = "$filename:$realline: " if ($emacs && $file);
1551 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1553 $here = "#$linenr: " if (!$file);
1554 $here = "#$realline: " if ($file);
1556 # extract the filename as it passes
1557 if ($line =~ /^diff --git.*?(\S+)$/) {
1559 $realfile =~ s@^([^/]*)/@@;
1561 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
1563 $realfile =~ s@^([^/]*)/@@;
1567 if (!$file && $tree && $p1_prefix ne '' &&
1568 -e "$root/$p1_prefix") {
1569 WARN("PATCH_PREFIX",
1570 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1573 if ($realfile =~ m@^include/asm/@) {
1574 ERROR("MODIFIED_INCLUDE_ASM",
1575 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1580 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
1582 my $hereline = "$here\n$rawline\n";
1583 my $herecurr = "$here\n$rawline\n";
1584 my $hereprev = "$here\n$prevrawline\n$rawline\n";
1586 $cnt_lines++ if ($realcnt != 0);
1588 # Check for incorrect file permissions
1589 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1590 my $permhere = $here . "FILE: $realfile\n";
1591 if ($realfile !~ m@scripts/@ &&
1592 $realfile !~ /\.(py|pl|awk|sh)$/) {
1593 ERROR("EXECUTE_PERMISSIONS",
1594 "do not set execute permissions for source files\n" . $permhere);
1598 # Check the patch for a signoff:
1599 if ($line =~ /^\s*signed-off-by:/i) {
1604 # Check signature styles
1605 if (!$in_header_lines &&
1606 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
1607 my $space_before = $1;
1609 my $space_after = $3;
1611 my $ucfirst_sign_off = ucfirst(lc($sign_off));
1613 if ($sign_off !~ /$signature_tags/) {
1614 WARN("BAD_SIGN_OFF",
1615 "Non-standard signature: $sign_off\n" . $herecurr);
1617 if (defined $space_before && $space_before ne "") {
1618 WARN("BAD_SIGN_OFF",
1619 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr);
1621 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
1622 WARN("BAD_SIGN_OFF",
1623 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr);
1625 if (!defined $space_after || $space_after ne " ") {
1626 WARN("BAD_SIGN_OFF",
1627 "Use a single space after $ucfirst_sign_off\n" . $herecurr);
1630 my ($email_name, $email_address, $comment) = parse_email($email);
1631 my $suggested_email = format_email(($email_name, $email_address));
1632 if ($suggested_email eq "") {
1633 ERROR("BAD_SIGN_OFF",
1634 "Unrecognized email address: '$email'\n" . $herecurr);
1636 my $dequoted = $suggested_email;
1637 $dequoted =~ s/^"//;
1638 $dequoted =~ s/" </ </;
1639 # Don't force email to have quotes
1640 # Allow just an angle bracketed address
1641 if ("$dequoted$comment" ne $email &&
1642 "<$email_address>$comment" ne $email &&
1643 "$suggested_email$comment" ne $email) {
1644 WARN("BAD_SIGN_OFF",
1645 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
1650 # Check for wrappage within a valid hunk of the file
1651 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1652 ERROR("CORRUPTED_PATCH",
1653 "patch seems to be corrupt (line wrapped?)\n" .
1654 $herecurr) if (!$emitted_corrupt++);
1657 # Check for absolute kernel paths.
1659 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1662 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1663 check_absolute_file($1, $herecurr)) {
1666 check_absolute_file($file, $herecurr);
1671 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1672 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1673 $rawline !~ m/^$UTF8*$/) {
1674 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1676 my $blank = copy_spacing($rawline);
1677 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1678 my $hereptr = "$hereline$ptr\n";
1681 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1684 # Check if it's the start of a commit log
1685 # (not a header line and we haven't seen the patch filename)
1686 if ($in_header_lines && $realfile =~ /^$/ &&
1687 $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
1688 $in_header_lines = 0;
1692 # Check if there is UTF-8 in a commit log when a mail header has explicitly
1693 # declined it, i.e defined some charset where it is missing.
1694 if ($in_header_lines &&
1695 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
1697 $non_utf8_charset = 1;
1700 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
1701 $rawline =~ /$NON_ASCII_UTF8/) {
1702 WARN("UTF8_BEFORE_PATCH",
1703 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
1706 # ignore non-hunk lines and lines being removed
1707 next if (!$hunk_line || $line =~ /^-/);
1709 #trailing whitespace
1710 if ($line =~ /^\+.*\015/) {
1711 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1712 ERROR("DOS_LINE_ENDINGS",
1713 "DOS line endings\n" . $herevet);
1715 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1716 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1717 ERROR("TRAILING_WHITESPACE",
1718 "trailing whitespace\n" . $herevet);
1722 # check for Kconfig help text having a real description
1723 # Only applies when adding the entry originally, after that we do not have
1724 # sufficient context to determine whether it is indeed long enough.
1725 if ($realfile =~ /Kconfig/ &&
1726 $line =~ /.\s*config\s+/) {
1729 my $ln = $linenr + 1;
1733 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
1734 $f = $lines[$ln - 1];
1735 $cnt-- if ($lines[$ln - 1] !~ /^-/);
1736 $is_end = $lines[$ln - 1] =~ /^\+/;
1738 next if ($f =~ /^-/);
1740 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
1742 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
1749 next if ($f =~ /^$/);
1750 if ($f =~ /^\s*config\s/) {
1756 WARN("CONFIG_DESCRIPTION",
1757 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
1758 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
1761 # discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
1762 if ($realfile =~ /Kconfig/ &&
1763 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
1764 WARN("CONFIG_EXPERIMENTAL",
1765 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
1768 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
1769 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
1772 'EXTRA_AFLAGS' => 'asflags-y',
1773 'EXTRA_CFLAGS' => 'ccflags-y',
1774 'EXTRA_CPPFLAGS' => 'cppflags-y',
1775 'EXTRA_LDFLAGS' => 'ldflags-y',
1778 WARN("DEPRECATED_VARIABLE",
1779 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
1782 # check we are in a valid source file if not then ignore this hunk
1783 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1786 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
1787 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1788 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
1789 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
1790 $length > $max_line_length)
1793 "line over $max_line_length characters\n" . $herecurr);
1796 # Check for user-visible strings broken across lines, which breaks the ability
1797 # to grep for the string. Limited to strings used as parameters (those
1798 # following an open parenthesis), which almost completely eliminates false
1799 # positives, as well as warning only once per parameter rather than once per
1800 # line of the string. Make an exception when the previous string ends in a
1801 # newline (multiple lines in one string constant) or \n\t (common in inline
1802 # assembly to indent the instruction on the following line).
1803 if ($line =~ /^\+\s*"/ &&
1804 $prevline =~ /"\s*$/ &&
1805 $prevline =~ /\(/ &&
1806 $prevrawline !~ /\\n(?:\\t)*"\s*$/) {
1807 WARN("SPLIT_STRING",
1808 "quoted string split across lines\n" . $hereprev);
1811 # check for spaces before a quoted newline
1812 if ($rawline =~ /^.*\".*\s\\n/) {
1813 WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
1814 "unnecessary whitespace before a quoted newline\n" . $herecurr);
1817 # check for adding lines without a newline.
1818 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1819 WARN("MISSING_EOF_NEWLINE",
1820 "adding a line without newline at end of file\n" . $herecurr);
1823 # Blackfin: use hi/lo macros
1824 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
1825 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
1826 my $herevet = "$here\n" . cat_vet($line) . "\n";
1828 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
1830 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
1831 my $herevet = "$here\n" . cat_vet($line) . "\n";
1833 "use the HI() macro, not (... >> 16)\n" . $herevet);
1837 # check we are in a valid source file C or perl if not then ignore this hunk
1838 next if ($realfile !~ /\.(h|c|pl)$/);
1840 # at the beginning of a line any tabs must come first and anything
1841 # more than 8 must use tabs.
1842 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1843 $rawline =~ /^\+\s* \s*/) {
1844 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1845 ERROR("CODE_INDENT",
1846 "code indent should use tabs where possible\n" . $herevet);
1850 # check for space before tabs.
1851 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
1852 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1853 WARN("SPACE_BEFORE_TAB",
1854 "please, no space before tabs\n" . $herevet);
1857 # check for && or || at the start of a line
1858 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
1859 CHK("LOGICAL_CONTINUATIONS",
1860 "Logical continuations should be on the previous line\n" . $hereprev);
1863 # check multi-line statement indentation matches previous line
1864 if ($^V && $^V ge 5.10.0 &&
1865 $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) {
1866 $prevline =~ /^\+(\t*)(.*)$/;
1870 my $pos = pos_last_openparen($rest);
1872 $line =~ /^(\+| )([ \t]*)/;
1875 my $goodtabindent = $oldindent .
1878 my $goodspaceindent = $oldindent . " " x $pos;
1880 if ($newindent ne $goodtabindent &&
1881 $newindent ne $goodspaceindent) {
1882 CHK("PARENTHESIS_ALIGNMENT",
1883 "Alignment should match open parenthesis\n" . $hereprev);
1888 if ($line =~ /^\+.*\*[ \t]*\)[ \t]+/) {
1890 "No space is necessary after a cast\n" . $hereprev);
1893 if ($realfile =~ m@^(drivers/net/|net/)@ &&
1894 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
1895 $rawline =~ /^\+[ \t]*\*/) {
1896 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
1897 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
1900 if ($realfile =~ m@^(drivers/net/|net/)@ &&
1901 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
1902 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
1903 $rawline !~ /^\+[ \t]*\*/) { #no leading *
1904 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
1905 "networking block comments start with * on subsequent lines\n" . $hereprev);
1908 if ($realfile =~ m@^(drivers/net/|net/)@ &&
1909 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
1910 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
1911 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
1912 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
1913 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
1914 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
1917 # check for spaces at the beginning of a line.
1919 # 1) within comments
1920 # 2) indented preprocessor commands
1922 if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/) {
1923 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1924 WARN("LEADING_SPACE",
1925 "please, no spaces at the start of a line\n" . $herevet);
1928 # check we are in a valid C source file if not then ignore this hunk
1929 next if ($realfile !~ /\.(h|c)$/);
1931 # discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
1932 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
1933 WARN("CONFIG_EXPERIMENTAL",
1934 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
1937 # check for RCS/CVS revision markers
1938 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
1940 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1943 # Blackfin: don't use __builtin_bfin_[cs]sync
1944 if ($line =~ /__builtin_bfin_csync/) {
1945 my $herevet = "$here\n" . cat_vet($line) . "\n";
1947 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
1949 if ($line =~ /__builtin_bfin_ssync/) {
1950 my $herevet = "$here\n" . cat_vet($line) . "\n";
1952 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
1955 # check for old HOTPLUG __dev<foo> section markings
1956 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
1957 WARN("HOTPLUG_SECTION",
1958 "Using $1 is unnecessary\n" . $herecurr);
1961 # Check for potential 'bare' types
1962 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
1964 #print "LINE<$line>\n";
1965 if ($linenr >= $suppress_statement &&
1966 $realcnt && $line =~ /.\s*\S/) {
1967 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
1968 ctx_statement_block($linenr, $realcnt, 0);
1969 $stat =~ s/\n./\n /g;
1970 $cond =~ s/\n./\n /g;
1972 #print "linenr<$linenr> <$stat>\n";
1973 # If this statement has no statement boundaries within
1974 # it there is no point in retrying a statement scan
1975 # until we hit end of it.
1976 my $frag = $stat; $frag =~ s/;+\s*$//;
1977 if ($frag !~ /(?:{|;)/) {
1978 #print "skip<$line_nr_next>\n";
1979 $suppress_statement = $line_nr_next;
1982 # Find the real next line.
1983 $realline_next = $line_nr_next;
1984 if (defined $realline_next &&
1985 (!defined $lines[$realline_next - 1] ||
1986 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
1993 # Ignore goto labels.
1994 if ($s =~ /$Ident:\*$/s) {
1996 # Ignore functions being called
1997 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
1999 } elsif ($s =~ /^.\s*else\b/s) {
2001 # declarations always start with types
2002 } 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) {
2005 possible($type, "A:" . $s);
2007 # definitions in global scope can only start with types
2008 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
2009 possible($1, "B:" . $s);
2012 # any (foo ... *) is a pointer cast, and foo is a type
2013 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
2014 possible($1, "C:" . $s);
2017 # Check for any sort of function declaration.
2018 # int foo(something bar, other baz);
2019 # void (*store_gdt)(x86_descr_ptr *);
2020 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
2021 my ($name_len) = length($1);
2024 substr($ctx, 0, $name_len + 1, '');
2025 $ctx =~ s/\)[^\)]*$//;
2027 for my $arg (split(/\s*,\s*/, $ctx)) {
2028 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
2030 possible($1, "D:" . $s);
2038 # Checks which may be anchored in the context.
2041 # Check for switch () and associated case and default
2042 # statements should be at the same indent.
2043 if ($line=~/\bswitch\s*\(.*\)/) {
2046 my @ctx = ctx_block_outer($linenr, $realcnt);
2048 for my $ctx (@ctx) {
2049 my ($clen, $cindent) = line_stats($ctx);
2050 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2051 $indent != $cindent) {
2052 $err .= "$sep$ctx\n";
2059 ERROR("SWITCH_CASE_INDENT_LEVEL",
2060 "switch and case should be at the same indent\n$hereline$err");
2064 # if/while/etc brace do not go on next line, unless defining a do while loop,
2065 # or if that brace on the next line is for something else
2066 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
2067 my $pre_ctx = "$1$2";
2069 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
2071 if ($line =~ /^\+\t{6,}/) {
2072 WARN("DEEP_INDENTATION",
2073 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2076 my $ctx_cnt = $realcnt - $#ctx - 1;
2077 my $ctx = join("\n", @ctx);
2079 my $ctx_ln = $linenr;
2080 my $ctx_skip = $realcnt;
2082 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2083 defined $lines[$ctx_ln - 1] &&
2084 $lines[$ctx_ln - 1] =~ /^-/)) {
2085 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2086 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
2090 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2091 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
2093 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
2095 "that open brace { should be on the previous line\n" .
2096 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2098 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2099 $ctx =~ /\)\s*\;\s*$/ &&
2100 defined $lines[$ctx_ln - 1])
2102 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2103 if ($nindent > $indent) {
2104 WARN("TRAILING_SEMICOLON",
2105 "trailing semicolon indicates no statements, indent implies otherwise\n" .
2106 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2111 # Check relative indent for conditionals and blocks.
2112 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2113 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2114 ctx_statement_block($linenr, $realcnt, 0)
2115 if (!defined $stat);
2116 my ($s, $c) = ($stat, $cond);
2118 substr($s, 0, length($c), '');
2120 # Make sure we remove the line prefixes as we have
2121 # none on the first line, and are going to readd them
2125 # Find out how long the conditional actually is.
2126 my @newlines = ($c =~ /\n/gs);
2127 my $cond_lines = 1 + $#newlines;
2129 # We want to check the first line inside the block
2130 # starting at the end of the conditional, so remove:
2131 # 1) any blank line termination
2132 # 2) any opening brace { on end of the line
2134 my $continuation = 0;
2136 $s =~ s/^.*\bdo\b//;
2138 if ($s =~ s/^\s*\\//) {
2141 if ($s =~ s/^\s*?\n//) {
2146 # Also ignore a loop construct at the end of a
2147 # preprocessor statement.
2148 if (($prevline =~ /^.\s*#\s*define\s/ ||
2149 $prevline =~ /\\\s*$/) && $continuation == 0) {
2155 while ($cond_ptr != $cond_lines) {
2156 $cond_ptr = $cond_lines;
2158 # If we see an #else/#elif then the code
2160 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2165 # 1) blank lines, they should be at 0,
2166 # 2) preprocessor lines, and
2168 if ($continuation ||
2170 $s =~ /^\s*#\s*?/ ||
2171 $s =~ /^\s*$Ident\s*:/) {
2172 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
2173 if ($s =~ s/^.*?\n//) {
2179 my (undef, $sindent) = line_stats("+" . $s);
2180 my $stat_real = raw_line($linenr, $cond_lines);
2182 # Check if either of these lines are modified, else
2183 # this is not this patch's fault.
2184 if (!defined($stat_real) ||
2185 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2188 if (defined($stat_real) && $cond_lines > 1) {
2189 $stat_real = "[...]\n$stat_real";
2192 #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";
2194 if ($check && (($sindent % 8) != 0 ||
2195 ($sindent <= $indent && $s ne ''))) {
2196 WARN("SUSPECT_CODE_INDENT",
2197 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
2201 # Track the 'values' across context and added lines.
2202 my $opline = $line; $opline =~ s/^./ /;
2203 my ($curr_values, $curr_vars) =
2204 annotate_values($opline . "\n", $prev_values);
2205 $curr_values = $prev_values . $curr_values;
2207 my $outline = $opline; $outline =~ s/\t/ /g;
2208 print "$linenr > .$outline\n";
2209 print "$linenr > $curr_values\n";
2210 print "$linenr > $curr_vars\n";
2212 $prev_values = substr($curr_values, -1);
2214 #ignore lines not being added
2215 if ($line=~/^[^\+]/) {next;}
2217 # TEST: allow direct testing of the type matcher.
2219 if ($line =~ /^.\s*$Declare\s*$/) {
2221 "TEST: is type\n" . $herecurr);
2222 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
2223 ERROR("TEST_NOT_TYPE",
2224 "TEST: is not type ($1 is)\n". $herecurr);
2228 # TEST: allow direct testing of the attribute matcher.
2230 if ($line =~ /^.\s*$Modifier\s*$/) {
2232 "TEST: is attr\n" . $herecurr);
2233 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
2234 ERROR("TEST_NOT_ATTR",
2235 "TEST: is not attr ($1 is)\n". $herecurr);
2240 # check for initialisation to aggregates open brace on the next line
2241 if ($line =~ /^.\s*{/ &&
2242 $prevline =~ /(?:^|[^=])=\s*$/) {
2244 "that open brace { should be on the previous line\n" . $hereprev);
2248 # Checks which are anchored on the added line.
2251 # check for malformed paths in #include statements (uses RAW line)
2252 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
2254 if ($path =~ m{//}) {
2255 ERROR("MALFORMED_INCLUDE",
2256 "malformed #include filename\n" . $herecurr);
2258 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
2259 ERROR("UAPI_INCLUDE",
2260 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
2264 # no C99 // comments
2265 if ($line =~ m{//}) {
2266 ERROR("C99_COMMENTS",
2267 "do not use C99 // comments\n" . $herecurr);
2269 # Remove C99 comments.
2271 $opline =~ s@//.*@@;
2273 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2274 # the whole statement.
2275 #print "APW <$lines[$realline_next - 1]>\n";
2276 if (defined $realline_next &&
2277 exists $lines[$realline_next - 1] &&
2278 !defined $suppress_export{$realline_next} &&
2279 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2280 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2281 # Handle definitions which produce identifiers with
2284 # EXPORT_SYMBOL(something_foo);
2286 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
2287 $name =~ /^${Ident}_$2/) {
2288 #print "FOO C name<$name>\n";
2289 $suppress_export{$realline_next} = 1;
2291 } elsif ($stat !~ /(?:
2293 ^.DEFINE_$Ident\(\Q$name\E\)|
2294 ^.DECLARE_$Ident\(\Q$name\E\)|
2295 ^.LIST_HEAD\(\Q$name\E\)|
2296 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2297 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
2299 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2300 $suppress_export{$realline_next} = 2;
2302 $suppress_export{$realline_next} = 1;
2305 if (!defined $suppress_export{$linenr} &&
2306 $prevline =~ /^.\s*$/ &&
2307 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2308 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2309 #print "FOO B <$lines[$linenr - 1]>\n";
2310 $suppress_export{$linenr} = 2;
2312 if (defined $suppress_export{$linenr} &&
2313 $suppress_export{$linenr} == 2) {
2314 WARN("EXPORT_SYMBOL",
2315 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
2318 # check for global initialisers.
2319 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
2320 ERROR("GLOBAL_INITIALISERS",
2321 "do not initialise globals to 0 or NULL\n" .
2324 # check for static initialisers.
2325 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2326 ERROR("INITIALISED_STATIC",
2327 "do not initialise statics to 0 or NULL\n" .
2331 # check for static const char * arrays.
2332 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
2333 WARN("STATIC_CONST_CHAR_ARRAY",
2334 "static const char * array should probably be static const char * const\n" .
2338 # check for static char foo[] = "bar" declarations.
2339 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
2340 WARN("STATIC_CONST_CHAR_ARRAY",
2341 "static char array declaration should probably be static const char\n" .
2345 # check for declarations of struct pci_device_id
2346 if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) {
2347 WARN("DEFINE_PCI_DEVICE_TABLE",
2348 "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr);
2351 # check for new typedefs, only function parameters and sparse annotations
2353 if ($line =~ /\btypedef\s/ &&
2354 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
2355 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
2356 $line !~ /\b$typeTypedefs\b/ &&
2357 $line !~ /\b__bitwise(?:__|)\b/) {
2358 WARN("NEW_TYPEDEFS",
2359 "do not add new typedefs\n" . $herecurr);
2362 # * goes on variable not on type
2364 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2366 my ($from, $to) = ($2, $2);
2368 # Should start with a space.
2369 $to =~ s/^(\S)/ $1/;
2370 # Should not end with a space.
2372 # '*'s should not have spaces between.
2373 while ($to =~ s/\*\s+\*/\*\*/) {
2376 #print "from<$from> to<$to>\n";
2378 ERROR("POINTER_LOCATION",
2379 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr);
2382 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2384 my ($from, $to, $ident) = ($2, $2, $3);
2386 # Should start with a space.
2387 $to =~ s/^(\S)/ $1/;
2388 # Should not end with a space.
2390 # '*'s should not have spaces between.
2391 while ($to =~ s/\*\s+\*/\*\*/) {
2393 # Modifiers should have spaces.
2394 $to =~ s/(\b$Modifier$)/$1 /;
2396 #print "from<$from> to<$to> ident<$ident>\n";
2397 if ($from ne $to && $ident !~ /^$Modifier$/) {
2398 ERROR("POINTER_LOCATION",
2399 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr);
2403 # # no BUG() or BUG_ON()
2404 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
2405 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2406 # print "$herecurr";
2410 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
2411 WARN("LINUX_VERSION_CODE",
2412 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
2415 # check for uses of printk_ratelimit
2416 if ($line =~ /\bprintk_ratelimit\s*\(/) {
2417 WARN("PRINTK_RATELIMITED",
2418 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
2421 # printk should use KERN_* levels. Note that follow on printk's on the
2422 # same line do not need a level, so we use the current block context
2423 # to try and find and validate the current printk. In summary the current
2424 # printk includes all preceding printk's which have no newline on the end.
2425 # we assume the first bad printk is the one to report.
2426 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
2428 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2429 #print "CHECK<$lines[$ln - 1]\n";
2430 # we have a preceding printk if it ends
2431 # with "\n" ignore it, else it is to blame
2432 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2433 if ($rawlines[$ln - 1] !~ m{\\n"}) {
2440 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2441 "printk() should include KERN_ facility level\n" . $herecurr);
2445 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
2447 my $level = lc($orig);
2448 $level = "warn" if ($level eq "warning");
2449 my $level2 = $level;
2450 $level2 = "dbg" if ($level eq "debug");
2451 WARN("PREFER_PR_LEVEL",
2452 "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
2455 if ($line =~ /\bpr_warning\s*\(/) {
2456 WARN("PREFER_PR_LEVEL",
2457 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr);
2460 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
2462 my $level = lc($orig);
2463 $level = "warn" if ($level eq "warning");
2464 $level = "dbg" if ($level eq "debug");
2465 WARN("PREFER_DEV_LEVEL",
2466 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
2469 # function brace can't be on same line, except for #defines of do while,
2470 # or if closed on same line
2471 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2472 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
2474 "open brace '{' following function declarations go on the next line\n" . $herecurr);
2477 # open braces for enum, union and struct go on the same line.
2478 if ($line =~ /^.\s*{/ &&
2479 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
2481 "open brace '{' following $1 go on the same line\n" . $hereprev);
2484 # missing space after union, struct or enum definition
2485 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) {
2487 "missing space after $1 definition\n" . $herecurr);
2490 # check for spacing round square brackets; allowed:
2491 # 1. with a type on the left -- int [] a;
2492 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2493 # 3. inside a curly brace -- = { [0...10] = 5 }
2494 while ($line =~ /(.*?\s)\[/g) {
2495 my ($where, $prefix) = ($-[1], $1);
2496 if ($prefix !~ /$Type\s+$/ &&
2497 ($where != 0 || $prefix !~ /^.\s+$/) &&
2498 $prefix !~ /[{,]\s+$/) {
2499 ERROR("BRACKET_SPACE",
2500 "space prohibited before open square bracket '['\n" . $herecurr);
2504 # check for spaces between functions and their parentheses.
2505 while ($line =~ /($Ident)\s+\(/g) {
2507 my $ctx_before = substr($line, 0, $-[1]);
2508 my $ctx = "$ctx_before$name";
2510 # Ignore those directives where spaces _are_ permitted.
2512 if|for|while|switch|return|case|
2513 volatile|__volatile__|
2514 __attribute__|format|__extension__|
2518 # cpp #define statements have non-optional spaces, ie
2519 # if there is a space between the name and the open
2520 # parenthesis it is simply not a parameter group.
2521 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
2523 # cpp #elif statement condition may start with a (
2524 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
2526 # If this whole things ends with a type its most
2527 # likely a typedef for a function.
2528 } elsif ($ctx =~ /$Type$/) {
2532 "space prohibited between function name and open parenthesis '('\n" . $herecurr);
2536 # check for whitespace before a non-naked semicolon
2537 if ($line =~ /^\+.*\S\s+;/) {
2539 "space prohibited before semicolon\n" . $herecurr);
2542 # Check operator spacing.
2543 if (!($line=~/\#\s*include/)) {
2545 <<=|>>=|<=|>=|==|!=|
2546 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
2547 =>|->|<<|>>|<|>|=|!|~|
2548 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
2551 my @elements = split(/($ops|;)/, $opline);
2554 my $blank = copy_spacing($opline);
2556 for (my $n = 0; $n < $#elements; $n += 2) {
2557 $off += length($elements[$n]);
2559 # Pick up the preceding and succeeding characters.
2560 my $ca = substr($opline, 0, $off);
2562 if (length($opline) >= ($off + length($elements[$n + 1]))) {
2563 $cc = substr($opline, $off + length($elements[$n + 1]));
2565 my $cb = "$ca$;$cc";
2568 $a = 'V' if ($elements[$n] ne '');
2569 $a = 'W' if ($elements[$n] =~ /\s$/);
2570 $a = 'C' if ($elements[$n] =~ /$;$/);
2571 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
2572 $a = 'O' if ($elements[$n] eq '');
2573 $a = 'E' if ($ca =~ /^\s*$/);
2575 my $op = $elements[$n + 1];
2578 if (defined $elements[$n + 2]) {
2579 $c = 'V' if ($elements[$n + 2] ne '');
2580 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
2581 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
2582 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
2583 $c = 'O' if ($elements[$n + 2] eq '');
2584 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
2589 my $ctx = "${a}x${c}";
2591 my $at = "(ctx:$ctx)";
2593 my $ptr = substr($blank, 0, $off) . "^";
2594 my $hereptr = "$hereline$ptr\n";
2596 # Pull out the value of this operator.
2597 my $op_type = substr($curr_values, $off + 1, 1);
2599 # Get the full operator variant.
2600 my $opv = $op . substr($curr_vars, $off, 1);
2602 # Ignore operators passed as parameters.
2603 if ($op_type ne 'V' &&
2604 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
2607 # } elsif ($op =~ /^$;+$/) {
2609 # ; should have either the end of line or a space or \ after it
2610 } elsif ($op eq ';') {
2611 if ($ctx !~ /.x[WEBC]/ &&
2612 $cc !~ /^\\/ && $cc !~ /^;/) {
2614 "space required after that '$op' $at\n" . $hereptr);
2618 } elsif ($op eq '//') {
2622 # : when part of a bitfield
2623 } elsif ($op eq '->' || $opv eq ':B') {
2624 if ($ctx =~ /Wx.|.xW/) {
2626 "spaces prohibited around that '$op' $at\n" . $hereptr);
2629 # , must have a space on the right.
2630 } elsif ($op eq ',') {
2631 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
2633 "space required after that '$op' $at\n" . $hereptr);
2636 # '*' as part of a type definition -- reported already.
2637 } elsif ($opv eq '*_') {
2638 #warn "'*' is part of type\n";
2640 # unary operators should have a space before and
2641 # none after. May be left adjacent to another
2642 # unary operator, or a cast
2643 } elsif ($op eq '!' || $op eq '~' ||
2644 $opv eq '*U' || $opv eq '-U' ||
2645 $opv eq '&U' || $opv eq '&&U') {
2646 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
2648 "space required before that '$op' $at\n" . $hereptr);
2650 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
2651 # A unary '*' may be const
2653 } elsif ($ctx =~ /.xW/) {
2655 "space prohibited after that '$op' $at\n" . $hereptr);
2658 # unary ++ and unary -- are allowed no space on one side.
2659 } elsif ($op eq '++' or $op eq '--') {
2660 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
2662 "space required one side of that '$op' $at\n" . $hereptr);
2664 if ($ctx =~ /Wx[BE]/ ||
2665 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
2667 "space prohibited before that '$op' $at\n" . $hereptr);
2669 if ($ctx =~ /ExW/) {
2671 "space prohibited after that '$op' $at\n" . $hereptr);
2675 # << and >> may either have or not have spaces both sides
2676 } elsif ($op eq '<<' or $op eq '>>' or
2677 $op eq '&' or $op eq '^' or $op eq '|' or
2678 $op eq '+' or $op eq '-' or
2679 $op eq '*' or $op eq '/' or
2682 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
2684 "need consistent spacing around '$op' $at\n" .
2688 # A colon needs no spaces before when it is
2689 # terminating a case value or a label.
2690 } elsif ($opv eq ':C' || $opv eq ':L') {
2691 if ($ctx =~ /Wx./) {
2693 "space prohibited before that '$op' $at\n" . $hereptr);
2696 # All the others need spaces both sides.
2697 } elsif ($ctx !~ /[EWC]x[CWE]/) {
2700 # Ignore email addresses <foo@bar>
2702 $cc =~ /^\S+\@\S+>/) ||
2704 $ca =~ /<\S+\@\S+$/))
2710 if (($opv eq ':O' && $ca =~ /\?$/) ||
2711 ($op eq '?' && $cc =~ /^:/)) {
2717 "spaces required around that '$op' $at\n" . $hereptr);
2720 $off += length($elements[$n + 1]);
2724 # check for multiple assignments
2725 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
2726 CHK("MULTIPLE_ASSIGNMENTS",
2727 "multiple assignments should be avoided\n" . $herecurr);
2730 ## # check for multiple declarations, allowing for a function declaration
2732 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
2733 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
2735 ## # Remove any bracketed sections to ensure we do not
2736 ## # falsly report the parameters of functions.
2738 ## while ($ln =~ s/\([^\(\)]*\)//g) {
2740 ## if ($ln =~ /,/) {
2741 ## WARN("MULTIPLE_DECLARATION",
2742 ## "declaring multiple variables together should be avoided\n" . $herecurr);
2746 #need space before brace following if, while, etc
2747 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
2750 "space required before the open brace '{'\n" . $herecurr);
2753 # closing brace should have a space following it when it has anything
2755 if ($line =~ /}(?!(?:,|;|\)))\S/) {
2757 "space required after that close brace '}'\n" . $herecurr);
2760 # check spacing on square brackets
2761 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
2763 "space prohibited after that open square bracket '['\n" . $herecurr);
2765 if ($line =~ /\s\]/) {
2767 "space prohibited before that close square bracket ']'\n" . $herecurr);
2770 # check spacing on parentheses
2771 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
2772 $line !~ /for\s*\(\s+;/) {
2774 "space prohibited after that open parenthesis '('\n" . $herecurr);
2776 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
2777 $line !~ /for\s*\(.*;\s+\)/ &&
2778 $line !~ /:\s+\)/) {
2780 "space prohibited before that close parenthesis ')'\n" . $herecurr);
2783 #goto labels aren't indented, allow a single space however
2784 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
2785 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
2786 WARN("INDENTED_LABEL",
2787 "labels should not be indented\n" . $herecurr);
2790 # Return is not a function.
2791 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2795 # Flatten any parentheses
2796 $value =~ s/\(/ \(/g;
2797 $value =~ s/\)/\) /g;
2798 while ($value =~ s/\[[^\[\]]*\]/1/ ||
2799 $value !~ /(?:$Ident|-?$Constant)\s*
2801 (?:$Ident|-?$Constant)/x &&
2802 $value =~ s/\([^\(\)]*\)/1/) {
2804 #print "value<$value>\n";
2805 if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
2806 ERROR("RETURN_PARENTHESES",
2807 "return is not a function, parentheses are not required\n" . $herecurr);
2809 } elsif ($spacing !~ /\s+/) {
2811 "space required before the open parenthesis '('\n" . $herecurr);
2814 # Return of what appears to be an errno should normally be -'ve
2815 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
2817 if ($name ne 'EOF' && $name ne 'ERROR') {
2818 WARN("USE_NEGATIVE_ERRNO",
2819 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
2823 # Need a space before open parenthesis after if, while etc
2824 if ($line=~/\b(if|while|for|switch)\(/) {
2825 ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr);
2828 # Check for illegal assignment in if conditional -- and check for trailing
2829 # statements after the conditional.
2830 if ($line =~ /do\s*(?!{)/) {
2831 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2832 ctx_statement_block($linenr, $realcnt, 0)
2833 if (!defined $stat);
2834 my ($stat_next) = ctx_statement_block($line_nr_next,
2835 $remain_next, $off_next);
2836 $stat_next =~ s/\n./\n /g;
2837 ##print "stat<$stat> stat_next<$stat_next>\n";
2839 if ($stat_next =~ /^\s*while\b/) {
2840 # If the statement carries leading newlines,
2841 # then count those as offsets.
2843 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2845 statement_rawlines($whitespace) - 1;
2847 $suppress_whiletrailers{$line_nr_next +
2851 if (!defined $suppress_whiletrailers{$linenr} &&
2852 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
2853 my ($s, $c) = ($stat, $cond);
2855 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
2856 ERROR("ASSIGN_IN_IF",
2857 "do not use assignment in if condition\n" . $herecurr);
2860 # Find out what is on the end of the line after the
2862 substr($s, 0, length($c), '');
2864 $s =~ s/$;//g; # Remove any comments
2865 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2866 $c !~ /}\s*while\s*/)
2868 # Find out how long the conditional actually is.
2869 my @newlines = ($c =~ /\n/gs);
2870 my $cond_lines = 1 + $#newlines;
2873 $stat_real = raw_line($linenr, $cond_lines)
2874 . "\n" if ($cond_lines);
2875 if (defined($stat_real) && $cond_lines > 1) {
2876 $stat_real = "[...]\n$stat_real";
2879 ERROR("TRAILING_STATEMENTS",
2880 "trailing statements should be on next line\n" . $herecurr . $stat_real);
2884 # Check for bitwise tests written as boolean
2896 WARN("HEXADECIMAL_BOOLEAN_TEST",
2897 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2900 # if and else should not have general statements after it
2901 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2903 $s =~ s/$;//g; # Remove any comments
2904 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2905 ERROR("TRAILING_STATEMENTS",
2906 "trailing statements should be on next line\n" . $herecurr);
2909 # if should not continue a brace
2910 if ($line =~ /}\s*if\b/) {
2911 ERROR("TRAILING_STATEMENTS",
2912 "trailing statements should be on next line\n" .
2915 # case and default should not have general statements after them
2916 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2918 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
2922 ERROR("TRAILING_STATEMENTS",
2923 "trailing statements should be on next line\n" . $herecurr);
2926 # Check for }<nl>else {, these must be at the same
2927 # indent level to be relevant to each other.
2928 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2929 $previndent == $indent) {
2930 ERROR("ELSE_AFTER_BRACE",
2931 "else should follow close brace '}'\n" . $hereprev);
2934 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2935 $previndent == $indent) {
2936 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2938 # Find out what is on the end of the line after the
2940 substr($s, 0, length($c), '');
2943 if ($s =~ /^\s*;/) {
2944 ERROR("WHILE_AFTER_BRACE",
2945 "while should follow close brace '}'\n" . $hereprev);
2949 #Specific variable tests
2950 while ($line =~ m{($Constant|$Lval)}g) {
2953 #gcc binary extension
2954 if ($var =~ /^$Binary$/) {
2955 WARN("GCC_BINARY_CONSTANT",
2956 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr);
2960 if ($var !~ /^$Constant$/ &&
2961 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
2962 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
2963 !defined $camelcase{$var}) {
2964 $camelcase{$var} = 1;
2966 "Avoid CamelCase: <$var>\n" . $herecurr);
2970 #no spaces allowed after \ in define
2971 if ($line=~/\#\s*define.*\\\s$/) {
2972 WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
2973 "Whitepspace after \\ makes next lines useless\n" . $herecurr);
2976 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
2977 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
2979 my $checkfile = "include/linux/$file";
2980 if (-f "$root/$checkfile" &&
2981 $realfile ne $checkfile &&
2982 $1 !~ /$allowed_asm_includes/)
2984 if ($realfile =~ m{^arch/}) {
2985 CHK("ARCH_INCLUDE_LINUX",
2986 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2988 WARN("INCLUDE_LINUX",
2989 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2994 # multi-statement macros should be enclosed in a do while loop, grab the
2995 # first statement and ensure its the whole macro if its not enclosed
2996 # in a known good container
2997 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2998 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
3001 my ($off, $dstat, $dcond, $rest);
3003 ($dstat, $dcond, $ln, $cnt, $off) =
3004 ctx_statement_block($linenr, $realcnt, 0);
3006 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
3007 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
3009 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
3011 $dstat =~ s/\\\n.//g;
3012 $dstat =~ s/^\s*//s;
3013 $dstat =~ s/\s*$//s;
3015 # Flatten any parentheses and braces
3016 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
3017 $dstat =~ s/\{[^\{\}]*\}/1/ ||
3018 $dstat =~ s/\[[^\[\]]*\]/1/)
3022 # Flatten any obvious string concatentation.
3023 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
3024 $dstat =~ s/$Ident\s*("X*")/$1/)
3028 my $exceptions = qr{
3040 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
3042 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
3043 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
3044 $dstat !~ /^[!~-]?(?:$Ident|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo
3045 $dstat !~ /^'X'$/ && # character constants
3046 $dstat !~ /$exceptions/ &&
3047 $dstat !~ /^\.$Ident\s*=/ && # .foo =
3048 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
3049 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
3050 $dstat !~ /^for\s*$Constant$/ && # for (...)
3051 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
3052 $dstat !~ /^do\s*{/ && # do {...
3053 $dstat !~ /^\({/) # ({...
3056 my $herectx = $here . "\n";
3057 my $cnt = statement_rawlines($ctx);
3059 for (my $n = 0; $n < $cnt; $n++) {
3060 $herectx .= raw_line($linenr, $n) . "\n";
3063 if ($dstat =~ /;/) {
3064 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
3065 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
3067 ERROR("COMPLEX_MACRO",
3068 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
3072 # check for line continuations outside of #defines, preprocessor #, and asm
3075 if ($prevline !~ /^..*\\$/ &&
3076 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
3077 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
3078 $line =~ /^\+.*\\$/) {
3079 WARN("LINE_CONTINUATIONS",
3080 "Avoid unnecessary line continuations\n" . $herecurr);
3084 # do {} while (0) macro tests:
3085 # single-statement macros do not need to be enclosed in do while (0) loop,
3086 # macro should not end with a semicolon
3087 if ($^V && $^V ge 5.10.0 &&
3088 $realfile !~ m@/vmlinux.lds.h$@ &&
3089 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
3092 my ($off, $dstat, $dcond, $rest);
3094 ($dstat, $dcond, $ln, $cnt, $off) =
3095 ctx_statement_block($linenr, $realcnt, 0);
3098 $dstat =~ s/\\\n.//g;
3100 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
3105 my $cnt = statement_rawlines($ctx);
3106 my $herectx = $here . "\n";
3108 for (my $n = 0; $n < $cnt; $n++) {
3109 $herectx .= raw_line($linenr, $n) . "\n";
3112 if (($stmts =~ tr/;/;/) == 1 &&
3113 $stmts !~ /^\s*(if|while|for|switch)\b/) {
3114 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
3115 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
3117 if (defined $semis && $semis ne "") {
3118 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
3119 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
3124 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3125 # all assignments may have only one of the following with an assignment:
3128 # VMLINUX_SYMBOL(...)
3129 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
3130 WARN("MISSING_VMLINUX_SYMBOL",
3131 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
3134 # check for redundant bracing round if etc
3135 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
3136 my ($level, $endln, @chunks) =
3137 ctx_statement_full($linenr, $realcnt, 1);
3138 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
3139 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3140 if ($#chunks > 0 && $level == 0) {
3144 my $herectx = $here . "\n";
3145 my $ln = $linenr - 1;
3146 for my $chunk (@chunks) {
3147 my ($cond, $block) = @{$chunk};
3149 # If the condition carries leading newlines, then count those as offsets.
3150 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
3151 my $offset = statement_rawlines($whitespace) - 1;
3153 $allowed[$allow] = 0;
3154 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3156 # We have looked at and allowed this specific line.
3157 $suppress_ifbraces{$ln + $offset} = 1;
3159 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
3160 $ln += statement_rawlines($block) - 1;
3162 substr($block, 0, length($cond), '');
3164 $seen++ if ($block =~ /^\s*{/);
3166 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
3167 if (statement_lines($cond) > 1) {
3168 #print "APW: ALLOWED: cond<$cond>\n";
3169 $allowed[$allow] = 1;
3171 if ($block =~/\b(?:if|for|while)\b/) {
3172 #print "APW: ALLOWED: block<$block>\n";
3173 $allowed[$allow] = 1;
3175 if (statement_block_size($block) > 1) {
3176 #print "APW: ALLOWED: lines block<$block>\n";
3177 $allowed[$allow] = 1;
3182 my $sum_allowed = 0;
3183 foreach (@allowed) {
3186 if ($sum_allowed == 0) {
3188 "braces {} are not necessary for any arm of this statement\n" . $herectx);
3189 } elsif ($sum_allowed != $allow &&
3192 "braces {} should be used on all arms of this statement\n" . $herectx);
3197 if (!defined $suppress_ifbraces{$linenr - 1} &&
3198 $line =~ /\b(if|while|for|else)\b/) {
3201 # Check the pre-context.
3202 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
3203 #print "APW: ALLOWED: pre<$1>\n";
3207 my ($level, $endln, @chunks) =
3208 ctx_statement_full($linenr, $realcnt, $-[0]);
3210 # Check the condition.
3211 my ($cond, $block) = @{$chunks[0]};
3212 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
3213 if (defined $cond) {
3214 substr($block, 0, length($cond), '');
3216 if (statement_lines($cond) > 1) {
3217 #print "APW: ALLOWED: cond<$cond>\n";
3220 if ($block =~/\b(?:if|for|while)\b/) {
3221 #print "APW: ALLOWED: block<$block>\n";
3224 if (statement_block_size($block) > 1) {
3225 #print "APW: ALLOWED: lines block<$block>\n";
3228 # Check the post-context.
3229 if (defined $chunks[1]) {
3230 my ($cond, $block) = @{$chunks[1]};
3231 if (defined $cond) {
3232 substr($block, 0, length($cond), '');
3234 if ($block =~ /^\s*\{/) {
3235 #print "APW: ALLOWED: chunk-1 block<$block>\n";
3239 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
3240 my $herectx = $here . "\n";
3241 my $cnt = statement_rawlines($block);
3243 for (my $n = 0; $n < $cnt; $n++) {
3244 $herectx .= raw_line($linenr, $n) . "\n";
3248 "braces {} are not necessary for single statement blocks\n" . $herectx);
3252 # check for unnecessary blank lines around braces
3253 if (($line =~ /^.\s*}\s*$/ && $prevline =~ /^.\s*$/)) {
3255 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
3257 if (($line =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
3259 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
3262 # no volatiles please
3263 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
3264 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
3266 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
3270 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
3271 CHK("REDUNDANT_CODE",
3272 "if this code is redundant consider removing it\n" .
3276 # check for needless "if (<foo>) fn(<foo>)" uses
3277 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
3278 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
3279 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
3281 "$1(NULL) is safe this check is probably not required\n" . $hereprev);
3285 # prefer usleep_range over udelay
3286 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
3287 # ignore udelay's < 10, however
3290 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
3294 # warn about unexpectedly long msleep's
3295 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
3298 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
3302 # warn about #ifdefs in C files
3303 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
3304 # print "#ifdef in C files should be avoided\n";
3305 # print "$herecurr";
3309 # warn about spacing in #ifdefs
3310 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
3312 "exactly one space required after that #$1\n" . $herecurr);
3315 # check for spinlock_t definitions without a comment.
3316 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
3317 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
3319 if (!ctx_has_comment($first_line, $linenr)) {
3320 CHK("UNCOMMENTED_DEFINITION",
3321 "$1 definition without comment\n" . $herecurr);
3324 # check for memory barriers without a comment.
3325 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
3326 if (!ctx_has_comment($first_line, $linenr)) {
3327 CHK("MEMORY_BARRIER",
3328 "memory barrier without comment\n" . $herecurr);
3331 # check of hardware specific defines
3332 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
3334 "architecture specific defines should be avoided\n" . $herecurr);
3337 # Check that the storage class is at the beginning of a declaration
3338 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
3339 WARN("STORAGE_CLASS",
3340 "storage class should be at the beginning of the declaration\n" . $herecurr)
3343 # check the location of the inline attribute, that it is between
3344 # storage class and type.
3345 if ($line =~ /\b$Type\s+$Inline\b/ ||
3346 $line =~ /\b$Inline\s+$Storage\b/) {
3347 ERROR("INLINE_LOCATION",
3348 "inline keyword should sit between storage class and type\n" . $herecurr);
3351 # Check for __inline__ and __inline, prefer inline
3352 if ($line =~ /\b(__inline__|__inline)\b/) {
3354 "plain inline is preferred over $1\n" . $herecurr);
3357 # Check for __attribute__ packed, prefer __packed
3358 if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
3359 WARN("PREFER_PACKED",
3360 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
3363 # Check for __attribute__ aligned, prefer __aligned
3364 if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
3365 WARN("PREFER_ALIGNED",
3366 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
3369 # Check for __attribute__ format(printf, prefer __printf
3370 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
3371 WARN("PREFER_PRINTF",
3372 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr);
3375 # Check for __attribute__ format(scanf, prefer __scanf
3376 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
3377 WARN("PREFER_SCANF",
3378 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr);
3381 # check for sizeof(&)
3382 if ($line =~ /\bsizeof\s*\(\s*\&/) {
3383 WARN("SIZEOF_ADDRESS",
3384 "sizeof(& should be avoided\n" . $herecurr);
3387 # check for sizeof without parenthesis
3388 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
3389 WARN("SIZEOF_PARENTHESIS",
3390 "sizeof $1 should be sizeof($1)\n" . $herecurr);
3393 # check for line continuations in quoted strings with odd counts of "
3394 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
3395 WARN("LINE_CONTINUATIONS",
3396 "Avoid line continuations in quoted strings\n" . $herecurr);
3399 # check for struct spinlock declarations
3400 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
3401 WARN("USE_SPINLOCK_T",
3402 "struct spinlock should be spinlock_t\n" . $herecurr);
3405 # check for seq_printf uses that could be seq_puts
3406 if ($line =~ /\bseq_printf\s*\(/) {
3407 my $fmt = get_quoted_string($line, $rawline);
3408 if ($fmt !~ /[^\\]\%/) {
3409 WARN("PREFER_SEQ_PUTS",
3410 "Prefer seq_puts to seq_printf\n" . $herecurr);
3414 # Check for misused memsets
3415 if ($^V && $^V ge 5.10.0 &&
3417 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
3423 if ($ms_size =~ /^(0x|)0$/i) {
3425 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
3426 } elsif ($ms_size =~ /^(0x|)1$/i) {
3428 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
3432 # typecasts on min/max could be min_t/max_t
3433 if ($^V && $^V ge 5.10.0 &&
3435 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
3436 if (defined $2 || defined $7) {
3438 my $cast1 = deparenthesize($2);
3440 my $cast2 = deparenthesize($7);
3444 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
3445 $cast = "$cast1 or $cast2";
3446 } elsif ($cast1 ne "") {
3452 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
3456 # check usleep_range arguments
3457 if ($^V && $^V ge 5.10.0 &&
3459 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
3463 WARN("USLEEP_RANGE",
3464 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
3465 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
3467 WARN("USLEEP_RANGE",
3468 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
3472 # check for new externs in .c files.
3473 if ($realfile =~ /\.c$/ && defined $stat &&
3474 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
3476 my $function_name = $1;
3477 my $paren_space = $2;
3480 if (defined $cond) {
3481 substr($s, 0, length($cond), '');
3483 if ($s =~ /^\s*;/ &&
3484 $function_name ne 'uninitialized_var')
3486 WARN("AVOID_EXTERNS",
3487 "externs should be avoided in .c files\n" . $herecurr);
3490 if ($paren_space =~ /\n/) {
3491 WARN("FUNCTION_ARGUMENTS",
3492 "arguments for function declarations should follow identifier\n" . $herecurr);
3495 } elsif ($realfile =~ /\.c$/ && defined $stat &&
3496 $stat =~ /^.\s*extern\s+/)
3498 WARN("AVOID_EXTERNS",
3499 "externs should be avoided in .c files\n" . $herecurr);
3502 # checks for new __setup's
3503 if ($rawline =~ /\b__setup\("([^"]*)"/) {
3506 if (!grep(/$name/, @setup_docs)) {
3507 CHK("UNDOCUMENTED_SETUP",
3508 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
3512 # check for pointless casting of kmalloc return
3513 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
3514 WARN("UNNECESSARY_CASTS",
3515 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
3519 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
3520 if ($^V && $^V ge 5.10.0 &&
3521 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
3522 CHK("ALLOC_SIZEOF_STRUCT",
3523 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
3526 # check for krealloc arg reuse
3527 if ($^V && $^V ge 5.10.0 &&
3528 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
3529 WARN("KREALLOC_ARG_REUSE",
3530 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
3533 # check for alloc argument mismatch
3534 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
3535 WARN("ALLOC_ARRAY_ARGS",
3536 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
3539 # check for multiple semicolons
3540 if ($line =~ /;\s*;\s*$/) {
3541 WARN("ONE_SEMICOLON",
3542 "Statements terminations use 1 semicolon\n" . $herecurr);
3545 # check for switch/default statements without a break;
3546 if ($^V && $^V ge 5.10.0 &&
3548 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
3550 my $herectx = $here . "\n";
3551 my $cnt = statement_rawlines($stat);
3552 for (my $n = 0; $n < $cnt; $n++) {
3553 $herectx .= raw_line($linenr, $n) . "\n";
3555 WARN("DEFAULT_NO_BREAK",
3556 "switch default: should use break\n" . $herectx);
3559 # check for gcc specific __FUNCTION__
3560 if ($line =~ /__FUNCTION__/) {
3562 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
3565 # check for use of yield()
3566 if ($line =~ /\byield\s*\(\s*\)/) {
3568 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
3571 # check for semaphores initialized locked
3572 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
3573 WARN("CONSIDER_COMPLETION",
3574 "consider using a completion\n" . $herecurr);
3577 # recommend kstrto* over simple_strto* and strict_strto*
3578 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
3579 WARN("CONSIDER_KSTRTO",
3580 "$1 is obsolete, use k$3 instead\n" . $herecurr);
3583 # check for __initcall(), use device_initcall() explicitly please
3584 if ($line =~ /^.\s*__initcall\s*\(/) {
3585 WARN("USE_DEVICE_INITCALL",
3586 "please use device_initcall() instead of __initcall()\n" . $herecurr);
3589 # check for various ops structs, ensure they are const.
3590 my $struct_ops = qr{acpi_dock_ops|
3591 address_space_operations|
3593 block_device_operations|
3598 file_lock_operations|
3608 lock_manager_operations|
3614 pipe_buf_operations|
3615 platform_hibernation_ops|
3616 platform_suspend_ops|
3621 soc_pcmcia_socket_ops|
3627 if ($line !~ /\bconst\b/ &&
3628 $line =~ /\bstruct\s+($struct_ops)\b/) {
3629 WARN("CONST_STRUCT",
3630 "struct $1 should normally be const\n" .
3634 # use of NR_CPUS is usually wrong
3635 # ignore definitions of NR_CPUS and usage to define arrays as likely right
3636 if ($line =~ /\bNR_CPUS\b/ &&
3637 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
3638 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
3639 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
3640 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
3641 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
3644 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
3647 # check for %L{u,d,i} in strings
3649 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
3650 $string = substr($rawline, $-[1], $+[1] - $-[1]);
3651 $string =~ s/%%/__/g;
3652 if ($string =~ /(?<!%)%L[udi]/) {
3654 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
3659 # whine mightly about in_atomic
3660 if ($line =~ /\bin_atomic\s*\(/) {
3661 if ($realfile =~ m@^drivers/@) {
3663 "do not use in_atomic in drivers\n" . $herecurr);
3664 } elsif ($realfile !~ m@^kernel/@) {
3666 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
3670 # check for lockdep_set_novalidate_class
3671 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
3672 $line =~ /__lockdep_no_validate__\s*\)/ ) {
3673 if ($realfile !~ m@^kernel/lockdep@ &&
3674 $realfile !~ m@^include/linux/lockdep@ &&
3675 $realfile !~ m@^drivers/base/core@) {
3677 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
3681 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
3682 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
3683 WARN("EXPORTED_WORLD_WRITABLE",
3684 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
3688 # If we have no input at all, then there is nothing to report on
3689 # so just keep quiet.
3690 if ($#rawlines == -1) {
3694 # In mailback mode only produce a report in the negative, for
3695 # things that appear to be patches.
3696 if ($mailback && ($clean == 1 || !$is_patch)) {
3700 # This is not a patch, and we are are in 'no-patch' mode so
3702 if (!$chk_patch && !$is_patch) {
3707 ERROR("NOT_UNIFIED_DIFF",
3708 "Does not appear to be a unified-diff format patch\n");
3710 if ($is_patch && $chk_signoff && $signoff == 0) {
3711 ERROR("MISSING_SIGN_OFF",
3712 "Missing Signed-off-by: line(s)\n");
3715 print report_dump();
3716 if ($summary && !($clean == 1 && $quiet == 1)) {
3717 print "$filename " if ($summary_file);
3718 print "total: $cnt_error errors, $cnt_warn warnings, " .
3719 (($check)? "$cnt_chk checks, " : "") .
3720 "$cnt_lines lines checked\n";
3721 print "\n" if ($quiet == 0);
3726 if ($^V lt 5.10.0) {
3727 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
3728 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
3731 # If there were whitespace errors which cleanpatch can fix
3732 # then suggest that.
3733 if ($rpt_cleaners) {
3734 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
3735 print " scripts/cleanfile\n\n";
3740 if ($quiet == 0 && keys %ignore_type) {
3741 print "NOTE: Ignored message types:";
3742 foreach my $ignore (sort keys %ignore_type) {
3748 if ($clean == 1 && $quiet == 0) {
3749 print "$vname has no obvious style problems and is ready for submission.\n"
3751 if ($clean == 0 && $quiet == 0) {
3753 $vname has style problems, please review.
3755 If any of these errors are false positives, please report
3756 them to the maintainer, see CHECKPATCH in MAINTAINERS.