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";
41 Usage: $P [OPTION]... [FILE]...
46 --no-tree run without a kernel tree
47 --no-signoff do not check for 'Signed-off-by' line
48 --patch treat FILE as patchfile (default)
49 --emacs emacs compile window format
50 --terse one line per report
51 -f, --file treat FILE as regular source file
52 --subjective, --strict enable more subjective tests
53 --ignore TYPE(,TYPE2...) ignore various comma separated message types
54 --show-types show the message "types" in the output
55 --root=PATH PATH to the kernel tree root
56 --no-summary suppress the per-file summary
57 --mailback only produce a report in case of warnings/errors
58 --summary-file include the filename in summary
59 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
60 'values', 'possible', 'type', and 'attr' (default
62 --test-only=WORD report only warnings/errors containing WORD
64 -h, --help, --version display this help and exit
66 When FILE is - read standard input.
72 my $conf = which_conf($configuration_file);
75 open(my $conffile, '<', "$conf")
76 or warn "$P: Can't find a readable $configuration_file file $!\n";
81 $line =~ s/\s*\n?$//g;
85 next if ($line =~ m/^\s*#/);
86 next if ($line =~ m/^\s*$/);
88 my @words = split(" ", $line);
89 foreach my $word (@words) {
90 last if ($word =~ m/^#/);
91 push (@conf_args, $word);
95 unshift(@ARGV, @conf_args) if @conf_args;
99 'q|quiet+' => \$quiet,
101 'signoff!' => \$chk_signoff,
102 'patch!' => \$chk_patch,
106 'subjective!' => \$check,
107 'strict!' => \$check,
108 'ignore=s' => \@ignore,
109 'show-types!' => \$show_types,
111 'summary!' => \$summary,
112 'mailback!' => \$mailback,
113 'summary-file!' => \$summary_file,
115 'debug=s' => \%debug,
116 'test-only=s' => \$tst_only,
126 print "$P: no input files\n";
130 @ignore = split(/,/, join(',',@ignore));
131 foreach my $word (@ignore) {
132 $word =~ s/\s*\n?$//g;
135 $word =~ tr/[a-z]/[A-Z]/;
137 next if ($word =~ m/^\s*#/);
138 next if ($word =~ m/^\s*$/);
140 $ignore_type{$word}++;
144 my $dbg_possible = 0;
147 for my $key (keys %debug) {
149 eval "\${dbg_$key} = '$debug{$key}';";
153 my $rpt_cleaners = 0;
162 if (!top_of_kernel_tree($root)) {
163 die "$P: $root: --root does not point at a valid tree\n";
166 if (top_of_kernel_tree('.')) {
168 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
169 top_of_kernel_tree($1)) {
174 if (!defined $root) {
175 print "Must be run from the top-level dir. of a kernel tree\n";
180 my $emitted_corrupt = 0;
183 [A-Za-z_][A-Za-z\d_]*
184 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
186 our $Storage = qr{extern|static|asmlinkage};
199 # Notes to $Attribute:
200 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
219 __(?:mem|cpu|dev|)(?:initdata|initconst|init\b)|
220 ____cacheline_aligned|
221 ____cacheline_aligned_in_smp|
222 ____cacheline_internodealigned_in_smp|
226 our $Inline = qr{inline|__always_inline|noinline};
227 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
228 our $Lval = qr{$Ident(?:$Member)*};
230 our $Constant = qr{(?i:(?:[0-9]+|0x[0-9a-f]+)[ul]*)};
231 our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
232 our $Compare = qr{<=|>=|==|!=|<|>};
236 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
243 our $NON_ASCII_UTF8 = qr{
244 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
245 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
246 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
247 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
248 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
249 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
250 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
254 [\x09\x0A\x0D\x20-\x7E] # ASCII
258 our $typeTypedefs = qr{(?x:
259 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
263 our $logFunctions = qr{(?x:
264 printk(?:_ratelimited|_once|)|
265 [a-z0-9]+_(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
266 WARN(?:_RATELIMIT|_ONCE|)|
271 our $signature_tags = qr{(?xi:
283 qr{(?:unsigned\s+)?char},
284 qr{(?:unsigned\s+)?short},
285 qr{(?:unsigned\s+)?int},
286 qr{(?:unsigned\s+)?long},
287 qr{(?:unsigned\s+)?long\s+int},
288 qr{(?:unsigned\s+)?long\s+long},
289 qr{(?:unsigned\s+)?long\s+long\s+int},
298 qr{${Ident}_handler},
299 qr{${Ident}_handler_fn},
301 our @modifierList = (
305 our $allowed_asm_includes = qr{(?x:
309 # memory.h: ARM has a custom one
312 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
313 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
314 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
316 (?:$Modifier\s+|const\s+)*
318 (?:typeof|__typeof__)\s*\([^\)]*\)|
322 (?:\s+$Modifier|\s+const)*
326 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*|\[\])+|(?:\s*\[\s*\])+)?
327 (?:\s+$Inline|\s+$Modifier)*
329 $Declare = qr{(?:$Storage\s+)?$Type};
334 our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
336 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
337 # requires at least perl version v5.10.0
338 # Any use must be runtime checked with $^V
340 our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
341 our $LvalOrFunc = qr{($Lval)\s*($balanced_parens{0,1})\s*};
342 our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
346 return "" if (!defined($string));
347 $string =~ s@^\s*\(\s*@@g;
348 $string =~ s@\s*\)\s*$@@g;
349 $string =~ s@\s+@ @g;
353 $chk_signoff = 0 if ($file);
355 my @dep_includes = ();
356 my @dep_functions = ();
357 my $removal = "Documentation/feature-removal-schedule.txt";
358 if ($tree && -f "$root/$removal") {
359 open(my $REMOVE, '<', "$root/$removal") ||
360 die "$P: $removal: open failed - $!\n";
362 if (/^Check:\s+(.*\S)/) {
363 for my $entry (split(/[, ]+/, $1)) {
364 if ($entry =~ m@include/(.*)@) {
365 push(@dep_includes, $1);
367 } elsif ($entry !~ m@/@) {
368 push(@dep_functions, $entry);
379 for my $filename (@ARGV) {
382 open($FILE, '-|', "diff -u /dev/null $filename") ||
383 die "$P: $filename: diff failed - $!\n";
384 } elsif ($filename eq '-') {
385 open($FILE, '<&STDIN');
387 open($FILE, '<', "$filename") ||
388 die "$P: $filename: open failed - $!\n";
390 if ($filename eq '-') {
391 $vname = 'Your patch';
400 if (!process($filename)) {
409 sub top_of_kernel_tree {
413 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
414 "README", "Documentation", "arch", "include", "drivers",
415 "fs", "init", "ipc", "kernel", "lib", "scripts",
418 foreach my $check (@tree_check) {
419 if (! -e $root . '/' . $check) {
427 my ($formatted_email) = @_;
433 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
436 $comment = $3 if defined $3;
437 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
439 $comment = $2 if defined $2;
440 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
442 $comment = $2 if defined $2;
443 $formatted_email =~ s/$address.*$//;
444 $name = $formatted_email;
445 $name =~ s/^\s+|\s+$//g;
446 $name =~ s/^\"|\"$//g;
447 # If there's a name left after stripping spaces and
448 # leading quotes, and the address doesn't have both
449 # leading and trailing angle brackets, the address
451 # "joe smith joe@smith.com" bad
452 # "joe smith <joe@smith.com" bad
453 if ($name ne "" && $address !~ /^<[^>]+>$/) {
460 $name =~ s/^\s+|\s+$//g;
461 $name =~ s/^\"|\"$//g;
462 $address =~ s/^\s+|\s+$//g;
463 $address =~ s/^\<|\>$//g;
465 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
466 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
470 return ($name, $address, $comment);
474 my ($name, $address) = @_;
478 $name =~ s/^\s+|\s+$//g;
479 $name =~ s/^\"|\"$//g;
480 $address =~ s/^\s+|\s+$//g;
482 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
483 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
488 $formatted_email = "$address";
490 $formatted_email = "$name <$address>";
493 return $formatted_email;
499 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
500 if (-e "$path/$conf") {
501 return "$path/$conf";
513 for my $c (split(//, $str)) {
517 for (; ($n % 8) != 0; $n++) {
529 (my $res = shift) =~ tr/\t/ /c;
536 # Drop the diff line leader and expand tabs
538 $line = expand_tabs($line);
540 # Pick the indent from the front of the line.
541 my ($white) = ($line =~ /^(\s*)/);
543 return (length($line), length($white));
546 my $sanitise_quote = '';
548 sub sanitise_line_reset {
549 my ($in_comment) = @_;
552 $sanitise_quote = '*/';
554 $sanitise_quote = '';
567 # Always copy over the diff marker.
568 $res = substr($line, 0, 1);
570 for ($off = 1; $off < length($line); $off++) {
571 $c = substr($line, $off, 1);
573 # Comments we are wacking completly including the begin
574 # and end, all to $;.
575 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
576 $sanitise_quote = '*/';
578 substr($res, $off, 2, "$;$;");
582 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
583 $sanitise_quote = '';
584 substr($res, $off, 2, "$;$;");
588 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
589 $sanitise_quote = '//';
591 substr($res, $off, 2, $sanitise_quote);
596 # A \ in a string means ignore the next character.
597 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
599 substr($res, $off, 2, 'XX');
604 if ($c eq "'" || $c eq '"') {
605 if ($sanitise_quote eq '') {
606 $sanitise_quote = $c;
608 substr($res, $off, 1, $c);
610 } elsif ($sanitise_quote eq $c) {
611 $sanitise_quote = '';
615 #print "c<$c> SQ<$sanitise_quote>\n";
616 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
617 substr($res, $off, 1, $;);
618 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
619 substr($res, $off, 1, $;);
620 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
621 substr($res, $off, 1, 'X');
623 substr($res, $off, 1, $c);
627 if ($sanitise_quote eq '//') {
628 $sanitise_quote = '';
631 # The pathname on a #include may be surrounded by '<' and '>'.
632 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
633 my $clean = 'X' x length($1);
634 $res =~ s@\<.*\>@<$clean>@;
636 # The whole of a #error is a string.
637 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
638 my $clean = 'X' x length($1);
639 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
645 sub ctx_statement_block {
646 my ($linenr, $remain, $off) = @_;
647 my $line = $linenr - 1;
664 @stack = (['', 0]) if ($#stack == -1);
666 #warn "CSB: blk<$blk> remain<$remain>\n";
667 # If we are about to drop off the end, pull in more
670 for (; $remain > 0; $line++) {
671 last if (!defined $lines[$line]);
672 next if ($lines[$line] =~ /^-/);
675 $blk .= $lines[$line] . "\n";
680 # Bail if there is no further context.
681 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
685 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
691 $c = substr($blk, $off, 1);
692 $remainder = substr($blk, $off);
694 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
696 # Handle nested #if/#else.
697 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
698 push(@stack, [ $type, $level ]);
699 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
700 ($type, $level) = @{$stack[$#stack - 1]};
701 } elsif ($remainder =~ /^#\s*endif\b/) {
702 ($type, $level) = @{pop(@stack)};
705 # Statement ends at the ';' or a close '}' at the
707 if ($level == 0 && $c eq ';') {
711 # An else is really a conditional as long as its not else if
712 if ($level == 0 && $coff_set == 0 &&
713 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
714 $remainder =~ /^(else)(?:\s|{)/ &&
715 $remainder !~ /^else\s+if\b/) {
716 $coff = $off + length($1) - 1;
718 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
719 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
722 if (($type eq '' || $type eq '(') && $c eq '(') {
726 if ($type eq '(' && $c eq ')') {
728 $type = ($level != 0)? '(' : '';
730 if ($level == 0 && $coff < $soff) {
733 #warn "CSB: mark coff<$coff>\n";
736 if (($type eq '' || $type eq '{') && $c eq '{') {
740 if ($type eq '{' && $c eq '}') {
742 $type = ($level != 0)? '{' : '';
745 if (substr($blk, $off + 1, 1) eq ';') {
751 # Preprocessor commands end at the newline unless escaped.
752 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
760 # We are truly at the end, so shuffle to the next line.
767 my $statement = substr($blk, $soff, $off - $soff + 1);
768 my $condition = substr($blk, $soff, $coff - $soff + 1);
770 #warn "STATEMENT<$statement>\n";
771 #warn "CONDITION<$condition>\n";
773 #print "coff<$coff> soff<$off> loff<$loff>\n";
775 return ($statement, $condition,
776 $line, $remain + 1, $off - $loff + 1, $level);
779 sub statement_lines {
782 # Strip the diff line prefixes and rip blank lines at start and end.
783 $stmt =~ s/(^|\n)./$1/g;
787 my @stmt_lines = ($stmt =~ /\n/g);
789 return $#stmt_lines + 2;
792 sub statement_rawlines {
795 my @stmt_lines = ($stmt =~ /\n/g);
797 return $#stmt_lines + 2;
800 sub statement_block_size {
803 $stmt =~ s/(^|\n)./$1/g;
809 my @stmt_lines = ($stmt =~ /\n/g);
810 my @stmt_statements = ($stmt =~ /;/g);
812 my $stmt_lines = $#stmt_lines + 2;
813 my $stmt_statements = $#stmt_statements + 1;
815 if ($stmt_lines > $stmt_statements) {
818 return $stmt_statements;
822 sub ctx_statement_full {
823 my ($linenr, $remain, $off) = @_;
824 my ($statement, $condition, $level);
828 # Grab the first conditional/block pair.
829 ($statement, $condition, $linenr, $remain, $off, $level) =
830 ctx_statement_block($linenr, $remain, $off);
831 #print "F: c<$condition> s<$statement> remain<$remain>\n";
832 push(@chunks, [ $condition, $statement ]);
833 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
834 return ($level, $linenr, @chunks);
837 # Pull in the following conditional/block pairs and see if they
838 # could continue the statement.
840 ($statement, $condition, $linenr, $remain, $off, $level) =
841 ctx_statement_block($linenr, $remain, $off);
842 #print "C: c<$condition> s<$statement> remain<$remain>\n";
843 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
845 push(@chunks, [ $condition, $statement ]);
848 return ($level, $linenr, @chunks);
852 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
854 my $start = $linenr - 1;
861 my @stack = ($level);
862 for ($line = $start; $remain > 0; $line++) {
863 next if ($rawlines[$line] =~ /^-/);
866 $blk .= $rawlines[$line];
868 # Handle nested #if/#else.
869 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
870 push(@stack, $level);
871 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
872 $level = $stack[$#stack - 1];
873 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
874 $level = pop(@stack);
877 foreach my $c (split(//, $lines[$line])) {
878 ##print "C<$c>L<$level><$open$close>O<$off>\n";
884 if ($c eq $close && $level > 0) {
886 last if ($level == 0);
887 } elsif ($c eq $open) {
892 if (!$outer || $level <= 1) {
893 push(@res, $rawlines[$line]);
896 last if ($level == 0);
899 return ($level, @res);
901 sub ctx_block_outer {
902 my ($linenr, $remain) = @_;
904 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
908 my ($linenr, $remain) = @_;
910 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
914 my ($linenr, $remain, $off) = @_;
916 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
919 sub ctx_block_level {
920 my ($linenr, $remain) = @_;
922 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
924 sub ctx_statement_level {
925 my ($linenr, $remain, $off) = @_;
927 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
930 sub ctx_locate_comment {
931 my ($first_line, $end_line) = @_;
933 # Catch a comment on the end of the line itself.
934 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
935 return $current_comment if (defined $current_comment);
937 # Look through the context and try and figure out if there is a
940 $current_comment = '';
941 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
942 my $line = $rawlines[$linenr - 1];
944 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
947 if ($line =~ m@/\*@) {
950 if (!$in_comment && $current_comment ne '') {
951 $current_comment = '';
953 $current_comment .= $line . "\n" if ($in_comment);
954 if ($line =~ m@\*/@) {
959 chomp($current_comment);
960 return($current_comment);
962 sub ctx_has_comment {
963 my ($first_line, $end_line) = @_;
964 my $cmt = ctx_locate_comment($first_line, $end_line);
966 ##print "LINE: $rawlines[$end_line - 1 ]\n";
967 ##print "CMMT: $cmt\n";
973 my ($linenr, $cnt) = @_;
975 my $offset = $linenr - 1;
980 $line = $rawlines[$offset++];
981 next if (defined($line) && $line =~ /^-/);
993 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
996 $coded = sprintf("^%c", unpack('C', $2) + 64);
1005 my $av_preprocessor = 0;
1010 sub annotate_reset {
1011 $av_preprocessor = 0;
1013 @av_paren_type = ('E');
1014 $av_pend_colon = 'O';
1017 sub annotate_values {
1018 my ($stream, $type) = @_;
1021 my $var = '_' x length($stream);
1024 print "$stream\n" if ($dbg_values > 1);
1026 while (length($cur)) {
1027 @av_paren_type = ('E') if ($#av_paren_type < 0);
1028 print " <" . join('', @av_paren_type) .
1029 "> <$type> <$av_pending>" if ($dbg_values > 1);
1030 if ($cur =~ /^(\s+)/o) {
1031 print "WS($1)\n" if ($dbg_values > 1);
1032 if ($1 =~ /\n/ && $av_preprocessor) {
1033 $type = pop(@av_paren_type);
1034 $av_preprocessor = 0;
1037 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1038 print "CAST($1)\n" if ($dbg_values > 1);
1039 push(@av_paren_type, $type);
1042 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1043 print "DECLARE($1)\n" if ($dbg_values > 1);
1046 } elsif ($cur =~ /^($Modifier)\s*/) {
1047 print "MODIFIER($1)\n" if ($dbg_values > 1);
1050 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1051 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1052 $av_preprocessor = 1;
1053 push(@av_paren_type, $type);
1059 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1060 print "UNDEF($1)\n" if ($dbg_values > 1);
1061 $av_preprocessor = 1;
1062 push(@av_paren_type, $type);
1064 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1065 print "PRE_START($1)\n" if ($dbg_values > 1);
1066 $av_preprocessor = 1;
1068 push(@av_paren_type, $type);
1069 push(@av_paren_type, $type);
1072 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1073 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1074 $av_preprocessor = 1;
1076 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1080 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1081 print "PRE_END($1)\n" if ($dbg_values > 1);
1083 $av_preprocessor = 1;
1085 # Assume all arms of the conditional end as this
1086 # one does, and continue as if the #endif was not here.
1087 pop(@av_paren_type);
1088 push(@av_paren_type, $type);
1091 } elsif ($cur =~ /^(\\\n)/o) {
1092 print "PRECONT($1)\n" if ($dbg_values > 1);
1094 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1095 print "ATTR($1)\n" if ($dbg_values > 1);
1096 $av_pending = $type;
1099 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1100 print "SIZEOF($1)\n" if ($dbg_values > 1);
1106 } elsif ($cur =~ /^(if|while|for)\b/o) {
1107 print "COND($1)\n" if ($dbg_values > 1);
1111 } elsif ($cur =~/^(case)/o) {
1112 print "CASE($1)\n" if ($dbg_values > 1);
1113 $av_pend_colon = 'C';
1116 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1117 print "KEYWORD($1)\n" if ($dbg_values > 1);
1120 } elsif ($cur =~ /^(\()/o) {
1121 print "PAREN('$1')\n" if ($dbg_values > 1);
1122 push(@av_paren_type, $av_pending);
1126 } elsif ($cur =~ /^(\))/o) {
1127 my $new_type = pop(@av_paren_type);
1128 if ($new_type ne '_') {
1130 print "PAREN('$1') -> $type\n"
1131 if ($dbg_values > 1);
1133 print "PAREN('$1')\n" if ($dbg_values > 1);
1136 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1137 print "FUNC($1)\n" if ($dbg_values > 1);
1141 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1142 if (defined $2 && $type eq 'C' || $type eq 'T') {
1143 $av_pend_colon = 'B';
1144 } elsif ($type eq 'E') {
1145 $av_pend_colon = 'L';
1147 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1150 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1151 print "IDENT($1)\n" if ($dbg_values > 1);
1154 } elsif ($cur =~ /^($Assignment)/o) {
1155 print "ASSIGN($1)\n" if ($dbg_values > 1);
1158 } elsif ($cur =~/^(;|{|})/) {
1159 print "END($1)\n" if ($dbg_values > 1);
1161 $av_pend_colon = 'O';
1163 } elsif ($cur =~/^(,)/) {
1164 print "COMMA($1)\n" if ($dbg_values > 1);
1167 } elsif ($cur =~ /^(\?)/o) {
1168 print "QUESTION($1)\n" if ($dbg_values > 1);
1171 } elsif ($cur =~ /^(:)/o) {
1172 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1174 substr($var, length($res), 1, $av_pend_colon);
1175 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1180 $av_pend_colon = 'O';
1182 } elsif ($cur =~ /^(\[)/o) {
1183 print "CLOSE($1)\n" if ($dbg_values > 1);
1186 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1189 print "OPV($1)\n" if ($dbg_values > 1);
1196 substr($var, length($res), 1, $variant);
1199 } elsif ($cur =~ /^($Operators)/o) {
1200 print "OP($1)\n" if ($dbg_values > 1);
1201 if ($1 ne '++' && $1 ne '--') {
1205 } elsif ($cur =~ /(^.)/o) {
1206 print "C($1)\n" if ($dbg_values > 1);
1209 $cur = substr($cur, length($1));
1210 $res .= $type x length($1);
1214 return ($res, $var);
1218 my ($possible, $line) = @_;
1219 my $notPermitted = qr{(?:
1236 ^(?:typedef|struct|enum)\b
1238 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1239 if ($possible !~ $notPermitted) {
1240 # Check for modifiers.
1241 $possible =~ s/\s*$Storage\s*//g;
1242 $possible =~ s/\s*$Sparse\s*//g;
1243 if ($possible =~ /^\s*$/) {
1245 } elsif ($possible =~ /\s/) {
1246 $possible =~ s/\s*$Type\s*//g;
1247 for my $modifier (split(' ', $possible)) {
1248 if ($modifier !~ $notPermitted) {
1249 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1250 push(@modifierList, $modifier);
1255 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1256 push(@typeList, $possible);
1260 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1267 return !defined $ignore_type{$_[0]};
1271 if (!show_type($_[1]) ||
1272 (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) {
1277 $line = "$prefix$_[0]:$_[1]: $_[2]\n";
1279 $line = "$prefix$_[0]: $_[2]\n";
1281 $line = (split('\n', $line))[0] . "\n" if ($terse);
1283 push(our @report, $line);
1292 if (report("ERROR", $_[0], $_[1])) {
1298 if (report("WARNING", $_[0], $_[1])) {
1304 if ($check && report("CHECK", $_[0], $_[1])) {
1310 sub check_absolute_file {
1311 my ($absolute, $herecurr) = @_;
1312 my $file = $absolute;
1314 ##print "absolute<$absolute>\n";
1316 # See if any suffix of this path is a path within the tree.
1317 while ($file =~ s@^[^/]*/@@) {
1318 if (-f "$root/$file") {
1319 ##print "file<$file>\n";
1327 # It is, so see if the prefix is acceptable.
1328 my $prefix = $absolute;
1329 substr($prefix, -length($file)) = '';
1331 ##print "prefix<$prefix>\n";
1332 if ($prefix ne ".../") {
1333 WARN("USE_RELATIVE_PATH",
1334 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1338 sub pos_last_openparen {
1343 my $opens = $line =~ tr/\(/\(/;
1344 my $closes = $line =~ tr/\)/\)/;
1346 my $last_openparen = 0;
1348 if (($opens == 0) || ($closes >= $opens)) {
1352 my $len = length($line);
1354 for ($pos = 0; $pos < $len; $pos++) {
1355 my $string = substr($line, $pos);
1356 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1357 $pos += length($1) - 1;
1358 } elsif (substr($line, $pos, 1) eq '(') {
1359 $last_openparen = $pos;
1360 } elsif (index($string, '(') == -1) {
1365 return $last_openparen + 1;
1369 my $filename = shift;
1375 my $stashrawline="";
1386 my $in_header_lines = 1;
1387 my $in_commit_log = 0; #Scanning lines before patch
1389 my $non_utf8_charset = 0;
1397 # Trace the real file/line as we go.
1403 my $comment_edge = 0;
1407 my $prev_values = 'E';
1410 my %suppress_ifbraces;
1411 my %suppress_whiletrailers;
1412 my %suppress_export;
1413 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 =~ /(Makefile|Kconfig|\.c|\.h|\.S|\.tmpl)$/) {
1592 ERROR("EXECUTE_PERMISSIONS",
1593 "do not set execute permissions for source files\n" . $permhere);
1597 # Check the patch for a signoff:
1598 if ($line =~ /^\s*signed-off-by:/i) {
1603 # Check signature styles
1604 if (!$in_header_lines &&
1605 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
1606 my $space_before = $1;
1608 my $space_after = $3;
1610 my $ucfirst_sign_off = ucfirst(lc($sign_off));
1612 if ($sign_off !~ /$signature_tags/) {
1613 WARN("BAD_SIGN_OFF",
1614 "Non-standard signature: $sign_off\n" . $herecurr);
1616 if (defined $space_before && $space_before ne "") {
1617 WARN("BAD_SIGN_OFF",
1618 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr);
1620 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
1621 WARN("BAD_SIGN_OFF",
1622 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr);
1624 if (!defined $space_after || $space_after ne " ") {
1625 WARN("BAD_SIGN_OFF",
1626 "Use a single space after $ucfirst_sign_off\n" . $herecurr);
1629 my ($email_name, $email_address, $comment) = parse_email($email);
1630 my $suggested_email = format_email(($email_name, $email_address));
1631 if ($suggested_email eq "") {
1632 ERROR("BAD_SIGN_OFF",
1633 "Unrecognized email address: '$email'\n" . $herecurr);
1635 my $dequoted = $suggested_email;
1636 $dequoted =~ s/^"//;
1637 $dequoted =~ s/" </ </;
1638 # Don't force email to have quotes
1639 # Allow just an angle bracketed address
1640 if ("$dequoted$comment" ne $email &&
1641 "<$email_address>$comment" ne $email &&
1642 "$suggested_email$comment" ne $email) {
1643 WARN("BAD_SIGN_OFF",
1644 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
1649 # Check for wrappage within a valid hunk of the file
1650 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1651 ERROR("CORRUPTED_PATCH",
1652 "patch seems to be corrupt (line wrapped?)\n" .
1653 $herecurr) if (!$emitted_corrupt++);
1656 # Check for absolute kernel paths.
1658 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1661 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1662 check_absolute_file($1, $herecurr)) {
1665 check_absolute_file($file, $herecurr);
1670 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1671 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1672 $rawline !~ m/^$UTF8*$/) {
1673 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1675 my $blank = copy_spacing($rawline);
1676 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1677 my $hereptr = "$hereline$ptr\n";
1680 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1683 # Check if it's the start of a commit log
1684 # (not a header line and we haven't seen the patch filename)
1685 if ($in_header_lines && $realfile =~ /^$/ &&
1686 $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
1687 $in_header_lines = 0;
1691 # Check if there is UTF-8 in a commit log when a mail header has explicitly
1692 # declined it, i.e defined some charset where it is missing.
1693 if ($in_header_lines &&
1694 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
1696 $non_utf8_charset = 1;
1699 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
1700 $rawline =~ /$NON_ASCII_UTF8/) {
1701 WARN("UTF8_BEFORE_PATCH",
1702 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
1705 # ignore non-hunk lines and lines being removed
1706 next if (!$hunk_line || $line =~ /^-/);
1708 #trailing whitespace
1709 if ($line =~ /^\+.*\015/) {
1710 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1711 ERROR("DOS_LINE_ENDINGS",
1712 "DOS line endings\n" . $herevet);
1714 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1715 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1716 ERROR("TRAILING_WHITESPACE",
1717 "trailing whitespace\n" . $herevet);
1721 # check for Kconfig help text having a real description
1722 # Only applies when adding the entry originally, after that we do not have
1723 # sufficient context to determine whether it is indeed long enough.
1724 if ($realfile =~ /Kconfig/ &&
1725 $line =~ /.\s*config\s+/) {
1728 my $ln = $linenr + 1;
1732 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
1733 $f = $lines[$ln - 1];
1734 $cnt-- if ($lines[$ln - 1] !~ /^-/);
1735 $is_end = $lines[$ln - 1] =~ /^\+/;
1737 next if ($f =~ /^-/);
1739 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
1741 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
1748 next if ($f =~ /^$/);
1749 if ($f =~ /^\s*config\s/) {
1755 WARN("CONFIG_DESCRIPTION",
1756 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
1757 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
1760 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
1761 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
1764 'EXTRA_AFLAGS' => 'asflags-y',
1765 'EXTRA_CFLAGS' => 'ccflags-y',
1766 'EXTRA_CPPFLAGS' => 'cppflags-y',
1767 'EXTRA_LDFLAGS' => 'ldflags-y',
1770 WARN("DEPRECATED_VARIABLE",
1771 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
1774 # check we are in a valid source file if not then ignore this hunk
1775 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1778 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
1779 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1780 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
1781 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
1785 "line over 80 characters\n" . $herecurr);
1788 # Check for user-visible strings broken across lines, which breaks the ability
1789 # to grep for the string. Limited to strings used as parameters (those
1790 # following an open parenthesis), which almost completely eliminates false
1791 # positives, as well as warning only once per parameter rather than once per
1792 # line of the string. Make an exception when the previous string ends in a
1793 # newline (multiple lines in one string constant) or \n\t (common in inline
1794 # assembly to indent the instruction on the following line).
1795 if ($line =~ /^\+\s*"/ &&
1796 $prevline =~ /"\s*$/ &&
1797 $prevline =~ /\(/ &&
1798 $prevrawline !~ /\\n(?:\\t)*"\s*$/) {
1799 WARN("SPLIT_STRING",
1800 "quoted string split across lines\n" . $hereprev);
1803 # check for spaces before a quoted newline
1804 if ($rawline =~ /^.*\".*\s\\n/) {
1805 WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
1806 "unnecessary whitespace before a quoted newline\n" . $herecurr);
1809 # check for adding lines without a newline.
1810 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1811 WARN("MISSING_EOF_NEWLINE",
1812 "adding a line without newline at end of file\n" . $herecurr);
1815 # Blackfin: use hi/lo macros
1816 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
1817 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
1818 my $herevet = "$here\n" . cat_vet($line) . "\n";
1820 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
1822 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
1823 my $herevet = "$here\n" . cat_vet($line) . "\n";
1825 "use the HI() macro, not (... >> 16)\n" . $herevet);
1829 # check we are in a valid source file C or perl if not then ignore this hunk
1830 next if ($realfile !~ /\.(h|c|pl)$/);
1832 # at the beginning of a line any tabs must come first and anything
1833 # more than 8 must use tabs.
1834 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1835 $rawline =~ /^\+\s* \s*/) {
1836 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1837 ERROR("CODE_INDENT",
1838 "code indent should use tabs where possible\n" . $herevet);
1842 # check for space before tabs.
1843 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
1844 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1845 WARN("SPACE_BEFORE_TAB",
1846 "please, no space before tabs\n" . $herevet);
1849 # check for && or || at the start of a line
1850 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
1851 CHK("LOGICAL_CONTINUATIONS",
1852 "Logical continuations should be on the previous line\n" . $hereprev);
1855 # check multi-line statement indentation matches previous line
1856 if ($^V && $^V ge 5.10.0 &&
1857 $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) {
1858 $prevline =~ /^\+(\t*)(.*)$/;
1862 my $pos = pos_last_openparen($rest);
1864 $line =~ /^(\+| )([ \t]*)/;
1867 my $goodtabindent = $oldindent .
1870 my $goodspaceindent = $oldindent . " " x $pos;
1872 if ($newindent ne $goodtabindent &&
1873 $newindent ne $goodspaceindent) {
1874 CHK("PARENTHESIS_ALIGNMENT",
1875 "Alignment should match open parenthesis\n" . $hereprev);
1880 if ($line =~ /^\+.*\*[ \t]*\)[ \t]+/) {
1882 "No space is necessary after a cast\n" . $hereprev);
1885 if ($realfile =~ m@^(drivers/net/|net/)@ &&
1886 $rawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
1887 $prevrawline =~ /^\+[ \t]*$/) {
1888 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
1889 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
1892 if ($realfile =~ m@^(drivers/net/|net/)@ &&
1893 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
1894 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
1895 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
1896 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
1897 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
1898 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
1901 # check for spaces at the beginning of a line.
1903 # 1) within comments
1904 # 2) indented preprocessor commands
1906 if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/) {
1907 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1908 WARN("LEADING_SPACE",
1909 "please, no spaces at the start of a line\n" . $herevet);
1912 # check we are in a valid C source file if not then ignore this hunk
1913 next if ($realfile !~ /\.(h|c)$/);
1915 # check for RCS/CVS revision markers
1916 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
1918 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1921 # Blackfin: don't use __builtin_bfin_[cs]sync
1922 if ($line =~ /__builtin_bfin_csync/) {
1923 my $herevet = "$here\n" . cat_vet($line) . "\n";
1925 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
1927 if ($line =~ /__builtin_bfin_ssync/) {
1928 my $herevet = "$here\n" . cat_vet($line) . "\n";
1930 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
1933 # Check for potential 'bare' types
1934 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
1936 #print "LINE<$line>\n";
1937 if ($linenr >= $suppress_statement &&
1938 $realcnt && $line =~ /.\s*\S/) {
1939 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
1940 ctx_statement_block($linenr, $realcnt, 0);
1941 $stat =~ s/\n./\n /g;
1942 $cond =~ s/\n./\n /g;
1944 #print "linenr<$linenr> <$stat>\n";
1945 # If this statement has no statement boundaries within
1946 # it there is no point in retrying a statement scan
1947 # until we hit end of it.
1948 my $frag = $stat; $frag =~ s/;+\s*$//;
1949 if ($frag !~ /(?:{|;)/) {
1950 #print "skip<$line_nr_next>\n";
1951 $suppress_statement = $line_nr_next;
1954 # Find the real next line.
1955 $realline_next = $line_nr_next;
1956 if (defined $realline_next &&
1957 (!defined $lines[$realline_next - 1] ||
1958 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
1965 # Ignore goto labels.
1966 if ($s =~ /$Ident:\*$/s) {
1968 # Ignore functions being called
1969 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
1971 } elsif ($s =~ /^.\s*else\b/s) {
1973 # declarations always start with types
1974 } 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) {
1977 possible($type, "A:" . $s);
1979 # definitions in global scope can only start with types
1980 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
1981 possible($1, "B:" . $s);
1984 # any (foo ... *) is a pointer cast, and foo is a type
1985 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
1986 possible($1, "C:" . $s);
1989 # Check for any sort of function declaration.
1990 # int foo(something bar, other baz);
1991 # void (*store_gdt)(x86_descr_ptr *);
1992 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
1993 my ($name_len) = length($1);
1996 substr($ctx, 0, $name_len + 1, '');
1997 $ctx =~ s/\)[^\)]*$//;
1999 for my $arg (split(/\s*,\s*/, $ctx)) {
2000 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
2002 possible($1, "D:" . $s);
2010 # Checks which may be anchored in the context.
2013 # Check for switch () and associated case and default
2014 # statements should be at the same indent.
2015 if ($line=~/\bswitch\s*\(.*\)/) {
2018 my @ctx = ctx_block_outer($linenr, $realcnt);
2020 for my $ctx (@ctx) {
2021 my ($clen, $cindent) = line_stats($ctx);
2022 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2023 $indent != $cindent) {
2024 $err .= "$sep$ctx\n";
2031 ERROR("SWITCH_CASE_INDENT_LEVEL",
2032 "switch and case should be at the same indent\n$hereline$err");
2036 # if/while/etc brace do not go on next line, unless defining a do while loop,
2037 # or if that brace on the next line is for something else
2038 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
2039 my $pre_ctx = "$1$2";
2041 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
2043 if ($line =~ /^\+\t{6,}/) {
2044 WARN("DEEP_INDENTATION",
2045 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2048 my $ctx_cnt = $realcnt - $#ctx - 1;
2049 my $ctx = join("\n", @ctx);
2051 my $ctx_ln = $linenr;
2052 my $ctx_skip = $realcnt;
2054 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2055 defined $lines[$ctx_ln - 1] &&
2056 $lines[$ctx_ln - 1] =~ /^-/)) {
2057 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2058 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
2062 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2063 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
2065 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
2067 "that open brace { should be on the previous line\n" .
2068 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2070 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2071 $ctx =~ /\)\s*\;\s*$/ &&
2072 defined $lines[$ctx_ln - 1])
2074 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2075 if ($nindent > $indent) {
2076 WARN("TRAILING_SEMICOLON",
2077 "trailing semicolon indicates no statements, indent implies otherwise\n" .
2078 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2083 # Check relative indent for conditionals and blocks.
2084 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2085 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2086 ctx_statement_block($linenr, $realcnt, 0)
2087 if (!defined $stat);
2088 my ($s, $c) = ($stat, $cond);
2090 substr($s, 0, length($c), '');
2092 # Make sure we remove the line prefixes as we have
2093 # none on the first line, and are going to readd them
2097 # Find out how long the conditional actually is.
2098 my @newlines = ($c =~ /\n/gs);
2099 my $cond_lines = 1 + $#newlines;
2101 # We want to check the first line inside the block
2102 # starting at the end of the conditional, so remove:
2103 # 1) any blank line termination
2104 # 2) any opening brace { on end of the line
2106 my $continuation = 0;
2108 $s =~ s/^.*\bdo\b//;
2110 if ($s =~ s/^\s*\\//) {
2113 if ($s =~ s/^\s*?\n//) {
2118 # Also ignore a loop construct at the end of a
2119 # preprocessor statement.
2120 if (($prevline =~ /^.\s*#\s*define\s/ ||
2121 $prevline =~ /\\\s*$/) && $continuation == 0) {
2127 while ($cond_ptr != $cond_lines) {
2128 $cond_ptr = $cond_lines;
2130 # If we see an #else/#elif then the code
2132 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2137 # 1) blank lines, they should be at 0,
2138 # 2) preprocessor lines, and
2140 if ($continuation ||
2142 $s =~ /^\s*#\s*?/ ||
2143 $s =~ /^\s*$Ident\s*:/) {
2144 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
2145 if ($s =~ s/^.*?\n//) {
2151 my (undef, $sindent) = line_stats("+" . $s);
2152 my $stat_real = raw_line($linenr, $cond_lines);
2154 # Check if either of these lines are modified, else
2155 # this is not this patch's fault.
2156 if (!defined($stat_real) ||
2157 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2160 if (defined($stat_real) && $cond_lines > 1) {
2161 $stat_real = "[...]\n$stat_real";
2164 #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";
2166 if ($check && (($sindent % 8) != 0 ||
2167 ($sindent <= $indent && $s ne ''))) {
2168 WARN("SUSPECT_CODE_INDENT",
2169 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
2173 # Track the 'values' across context and added lines.
2174 my $opline = $line; $opline =~ s/^./ /;
2175 my ($curr_values, $curr_vars) =
2176 annotate_values($opline . "\n", $prev_values);
2177 $curr_values = $prev_values . $curr_values;
2179 my $outline = $opline; $outline =~ s/\t/ /g;
2180 print "$linenr > .$outline\n";
2181 print "$linenr > $curr_values\n";
2182 print "$linenr > $curr_vars\n";
2184 $prev_values = substr($curr_values, -1);
2186 #ignore lines not being added
2187 if ($line=~/^[^\+]/) {next;}
2189 # TEST: allow direct testing of the type matcher.
2191 if ($line =~ /^.\s*$Declare\s*$/) {
2193 "TEST: is type\n" . $herecurr);
2194 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
2195 ERROR("TEST_NOT_TYPE",
2196 "TEST: is not type ($1 is)\n". $herecurr);
2200 # TEST: allow direct testing of the attribute matcher.
2202 if ($line =~ /^.\s*$Modifier\s*$/) {
2204 "TEST: is attr\n" . $herecurr);
2205 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
2206 ERROR("TEST_NOT_ATTR",
2207 "TEST: is not attr ($1 is)\n". $herecurr);
2212 # check for initialisation to aggregates open brace on the next line
2213 if ($line =~ /^.\s*{/ &&
2214 $prevline =~ /(?:^|[^=])=\s*$/) {
2216 "that open brace { should be on the previous line\n" . $hereprev);
2220 # Checks which are anchored on the added line.
2223 # check for malformed paths in #include statements (uses RAW line)
2224 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
2226 if ($path =~ m{//}) {
2227 ERROR("MALFORMED_INCLUDE",
2228 "malformed #include filename\n" .
2233 # no C99 // comments
2234 if ($line =~ m{//}) {
2235 ERROR("C99_COMMENTS",
2236 "do not use C99 // comments\n" . $herecurr);
2238 # Remove C99 comments.
2240 $opline =~ s@//.*@@;
2242 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2243 # the whole statement.
2244 #print "APW <$lines[$realline_next - 1]>\n";
2245 if (defined $realline_next &&
2246 exists $lines[$realline_next - 1] &&
2247 !defined $suppress_export{$realline_next} &&
2248 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2249 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2250 # Handle definitions which produce identifiers with
2253 # EXPORT_SYMBOL(something_foo);
2255 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
2256 $name =~ /^${Ident}_$2/) {
2257 #print "FOO C name<$name>\n";
2258 $suppress_export{$realline_next} = 1;
2260 } elsif ($stat !~ /(?:
2262 ^.DEFINE_$Ident\(\Q$name\E\)|
2263 ^.DECLARE_$Ident\(\Q$name\E\)|
2264 ^.LIST_HEAD\(\Q$name\E\)|
2265 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2266 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
2268 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2269 $suppress_export{$realline_next} = 2;
2271 $suppress_export{$realline_next} = 1;
2274 if (!defined $suppress_export{$linenr} &&
2275 $prevline =~ /^.\s*$/ &&
2276 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2277 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2278 #print "FOO B <$lines[$linenr - 1]>\n";
2279 $suppress_export{$linenr} = 2;
2281 if (defined $suppress_export{$linenr} &&
2282 $suppress_export{$linenr} == 2) {
2283 WARN("EXPORT_SYMBOL",
2284 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
2287 # check for global initialisers.
2288 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
2289 ERROR("GLOBAL_INITIALISERS",
2290 "do not initialise globals to 0 or NULL\n" .
2293 # check for static initialisers.
2294 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2295 ERROR("INITIALISED_STATIC",
2296 "do not initialise statics to 0 or NULL\n" .
2300 # check for static const char * arrays.
2301 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
2302 WARN("STATIC_CONST_CHAR_ARRAY",
2303 "static const char * array should probably be static const char * const\n" .
2307 # check for static char foo[] = "bar" declarations.
2308 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
2309 WARN("STATIC_CONST_CHAR_ARRAY",
2310 "static char array declaration should probably be static const char\n" .
2314 # check for declarations of struct pci_device_id
2315 if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) {
2316 WARN("DEFINE_PCI_DEVICE_TABLE",
2317 "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr);
2320 # check for new typedefs, only function parameters and sparse annotations
2322 if ($line =~ /\btypedef\s/ &&
2323 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
2324 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
2325 $line !~ /\b$typeTypedefs\b/ &&
2326 $line !~ /\b__bitwise(?:__|)\b/) {
2327 WARN("NEW_TYPEDEFS",
2328 "do not add new typedefs\n" . $herecurr);
2331 # * goes on variable not on type
2333 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2335 my ($from, $to) = ($2, $2);
2337 # Should start with a space.
2338 $to =~ s/^(\S)/ $1/;
2339 # Should not end with a space.
2341 # '*'s should not have spaces between.
2342 while ($to =~ s/\*\s+\*/\*\*/) {
2345 #print "from<$from> to<$to>\n";
2347 ERROR("POINTER_LOCATION",
2348 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr);
2351 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2353 my ($from, $to, $ident) = ($2, $2, $3);
2355 # Should start with a space.
2356 $to =~ s/^(\S)/ $1/;
2357 # Should not end with a space.
2359 # '*'s should not have spaces between.
2360 while ($to =~ s/\*\s+\*/\*\*/) {
2362 # Modifiers should have spaces.
2363 $to =~ s/(\b$Modifier$)/$1 /;
2365 #print "from<$from> to<$to> ident<$ident>\n";
2366 if ($from ne $to && $ident !~ /^$Modifier$/) {
2367 ERROR("POINTER_LOCATION",
2368 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr);
2372 # # no BUG() or BUG_ON()
2373 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
2374 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2375 # print "$herecurr";
2379 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
2380 WARN("LINUX_VERSION_CODE",
2381 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
2384 # check for uses of printk_ratelimit
2385 if ($line =~ /\bprintk_ratelimit\s*\(/) {
2386 WARN("PRINTK_RATELIMITED",
2387 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
2390 # printk should use KERN_* levels. Note that follow on printk's on the
2391 # same line do not need a level, so we use the current block context
2392 # to try and find and validate the current printk. In summary the current
2393 # printk includes all preceding printk's which have no newline on the end.
2394 # we assume the first bad printk is the one to report.
2395 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
2397 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2398 #print "CHECK<$lines[$ln - 1]\n";
2399 # we have a preceding printk if it ends
2400 # with "\n" ignore it, else it is to blame
2401 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2402 if ($rawlines[$ln - 1] !~ m{\\n"}) {
2409 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2410 "printk() should include KERN_ facility level\n" . $herecurr);
2414 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
2416 my $level = lc($orig);
2417 $level = "warn" if ($level eq "warning");
2418 my $level2 = $level;
2419 $level2 = "dbg" if ($level eq "debug");
2420 WARN("PREFER_PR_LEVEL",
2421 "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
2424 if ($line =~ /\bpr_warning\s*\(/) {
2425 WARN("PREFER_PR_LEVEL",
2426 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr);
2429 # function brace can't be on same line, except for #defines of do while,
2430 # or if closed on same line
2431 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2432 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
2434 "open brace '{' following function declarations go on the next line\n" . $herecurr);
2437 # open braces for enum, union and struct go on the same line.
2438 if ($line =~ /^.\s*{/ &&
2439 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
2441 "open brace '{' following $1 go on the same line\n" . $hereprev);
2444 # missing space after union, struct or enum definition
2445 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) {
2447 "missing space after $1 definition\n" . $herecurr);
2450 # check for spacing round square brackets; allowed:
2451 # 1. with a type on the left -- int [] a;
2452 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2453 # 3. inside a curly brace -- = { [0...10] = 5 }
2454 while ($line =~ /(.*?\s)\[/g) {
2455 my ($where, $prefix) = ($-[1], $1);
2456 if ($prefix !~ /$Type\s+$/ &&
2457 ($where != 0 || $prefix !~ /^.\s+$/) &&
2458 $prefix !~ /[{,]\s+$/) {
2459 ERROR("BRACKET_SPACE",
2460 "space prohibited before open square bracket '['\n" . $herecurr);
2464 # check for spaces between functions and their parentheses.
2465 while ($line =~ /($Ident)\s+\(/g) {
2467 my $ctx_before = substr($line, 0, $-[1]);
2468 my $ctx = "$ctx_before$name";
2470 # Ignore those directives where spaces _are_ permitted.
2472 if|for|while|switch|return|case|
2473 volatile|__volatile__|
2474 __attribute__|format|__extension__|
2478 # cpp #define statements have non-optional spaces, ie
2479 # if there is a space between the name and the open
2480 # parenthesis it is simply not a parameter group.
2481 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
2483 # cpp #elif statement condition may start with a (
2484 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
2486 # If this whole things ends with a type its most
2487 # likely a typedef for a function.
2488 } elsif ($ctx =~ /$Type$/) {
2492 "space prohibited between function name and open parenthesis '('\n" . $herecurr);
2496 # check for whitespace before a non-naked semicolon
2497 if ($line =~ /^\+.*\S\s+;/) {
2499 "space prohibited before semicolon\n" . $herecurr);
2502 # Check operator spacing.
2503 if (!($line=~/\#\s*include/)) {
2505 <<=|>>=|<=|>=|==|!=|
2506 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
2507 =>|->|<<|>>|<|>|=|!|~|
2508 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
2511 my @elements = split(/($ops|;)/, $opline);
2514 my $blank = copy_spacing($opline);
2516 for (my $n = 0; $n < $#elements; $n += 2) {
2517 $off += length($elements[$n]);
2519 # Pick up the preceding and succeeding characters.
2520 my $ca = substr($opline, 0, $off);
2522 if (length($opline) >= ($off + length($elements[$n + 1]))) {
2523 $cc = substr($opline, $off + length($elements[$n + 1]));
2525 my $cb = "$ca$;$cc";
2528 $a = 'V' if ($elements[$n] ne '');
2529 $a = 'W' if ($elements[$n] =~ /\s$/);
2530 $a = 'C' if ($elements[$n] =~ /$;$/);
2531 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
2532 $a = 'O' if ($elements[$n] eq '');
2533 $a = 'E' if ($ca =~ /^\s*$/);
2535 my $op = $elements[$n + 1];
2538 if (defined $elements[$n + 2]) {
2539 $c = 'V' if ($elements[$n + 2] ne '');
2540 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
2541 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
2542 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
2543 $c = 'O' if ($elements[$n + 2] eq '');
2544 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
2549 my $ctx = "${a}x${c}";
2551 my $at = "(ctx:$ctx)";
2553 my $ptr = substr($blank, 0, $off) . "^";
2554 my $hereptr = "$hereline$ptr\n";
2556 # Pull out the value of this operator.
2557 my $op_type = substr($curr_values, $off + 1, 1);
2559 # Get the full operator variant.
2560 my $opv = $op . substr($curr_vars, $off, 1);
2562 # Ignore operators passed as parameters.
2563 if ($op_type ne 'V' &&
2564 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
2567 # } elsif ($op =~ /^$;+$/) {
2569 # ; should have either the end of line or a space or \ after it
2570 } elsif ($op eq ';') {
2571 if ($ctx !~ /.x[WEBC]/ &&
2572 $cc !~ /^\\/ && $cc !~ /^;/) {
2574 "space required after that '$op' $at\n" . $hereptr);
2578 } elsif ($op eq '//') {
2582 # : when part of a bitfield
2583 } elsif ($op eq '->' || $opv eq ':B') {
2584 if ($ctx =~ /Wx.|.xW/) {
2586 "spaces prohibited around that '$op' $at\n" . $hereptr);
2589 # , must have a space on the right.
2590 } elsif ($op eq ',') {
2591 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
2593 "space required after that '$op' $at\n" . $hereptr);
2596 # '*' as part of a type definition -- reported already.
2597 } elsif ($opv eq '*_') {
2598 #warn "'*' is part of type\n";
2600 # unary operators should have a space before and
2601 # none after. May be left adjacent to another
2602 # unary operator, or a cast
2603 } elsif ($op eq '!' || $op eq '~' ||
2604 $opv eq '*U' || $opv eq '-U' ||
2605 $opv eq '&U' || $opv eq '&&U') {
2606 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
2608 "space required before that '$op' $at\n" . $hereptr);
2610 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
2611 # A unary '*' may be const
2613 } elsif ($ctx =~ /.xW/) {
2615 "space prohibited after that '$op' $at\n" . $hereptr);
2618 # unary ++ and unary -- are allowed no space on one side.
2619 } elsif ($op eq '++' or $op eq '--') {
2620 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
2622 "space required one side of that '$op' $at\n" . $hereptr);
2624 if ($ctx =~ /Wx[BE]/ ||
2625 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
2627 "space prohibited before that '$op' $at\n" . $hereptr);
2629 if ($ctx =~ /ExW/) {
2631 "space prohibited after that '$op' $at\n" . $hereptr);
2635 # << and >> may either have or not have spaces both sides
2636 } elsif ($op eq '<<' or $op eq '>>' or
2637 $op eq '&' or $op eq '^' or $op eq '|' or
2638 $op eq '+' or $op eq '-' or
2639 $op eq '*' or $op eq '/' or
2642 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
2644 "need consistent spacing around '$op' $at\n" .
2648 # A colon needs no spaces before when it is
2649 # terminating a case value or a label.
2650 } elsif ($opv eq ':C' || $opv eq ':L') {
2651 if ($ctx =~ /Wx./) {
2653 "space prohibited before that '$op' $at\n" . $hereptr);
2656 # All the others need spaces both sides.
2657 } elsif ($ctx !~ /[EWC]x[CWE]/) {
2660 # Ignore email addresses <foo@bar>
2662 $cc =~ /^\S+\@\S+>/) ||
2664 $ca =~ /<\S+\@\S+$/))
2670 if (($opv eq ':O' && $ca =~ /\?$/) ||
2671 ($op eq '?' && $cc =~ /^:/)) {
2677 "spaces required around that '$op' $at\n" . $hereptr);
2680 $off += length($elements[$n + 1]);
2684 # check for multiple assignments
2685 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
2686 CHK("MULTIPLE_ASSIGNMENTS",
2687 "multiple assignments should be avoided\n" . $herecurr);
2690 ## # check for multiple declarations, allowing for a function declaration
2692 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
2693 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
2695 ## # Remove any bracketed sections to ensure we do not
2696 ## # falsly report the parameters of functions.
2698 ## while ($ln =~ s/\([^\(\)]*\)//g) {
2700 ## if ($ln =~ /,/) {
2701 ## WARN("MULTIPLE_DECLARATION",
2702 ## "declaring multiple variables together should be avoided\n" . $herecurr);
2706 #need space before brace following if, while, etc
2707 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
2710 "space required before the open brace '{'\n" . $herecurr);
2713 # closing brace should have a space following it when it has anything
2715 if ($line =~ /}(?!(?:,|;|\)))\S/) {
2717 "space required after that close brace '}'\n" . $herecurr);
2720 # check spacing on square brackets
2721 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
2723 "space prohibited after that open square bracket '['\n" . $herecurr);
2725 if ($line =~ /\s\]/) {
2727 "space prohibited before that close square bracket ']'\n" . $herecurr);
2730 # check spacing on parentheses
2731 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
2732 $line !~ /for\s*\(\s+;/) {
2734 "space prohibited after that open parenthesis '('\n" . $herecurr);
2736 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
2737 $line !~ /for\s*\(.*;\s+\)/ &&
2738 $line !~ /:\s+\)/) {
2740 "space prohibited before that close parenthesis ')'\n" . $herecurr);
2743 #goto labels aren't indented, allow a single space however
2744 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
2745 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
2746 WARN("INDENTED_LABEL",
2747 "labels should not be indented\n" . $herecurr);
2750 # Return is not a function.
2751 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2755 # Flatten any parentheses
2756 $value =~ s/\(/ \(/g;
2757 $value =~ s/\)/\) /g;
2758 while ($value =~ s/\[[^\[\]]*\]/1/ ||
2759 $value !~ /(?:$Ident|-?$Constant)\s*
2761 (?:$Ident|-?$Constant)/x &&
2762 $value =~ s/\([^\(\)]*\)/1/) {
2764 #print "value<$value>\n";
2765 if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
2766 ERROR("RETURN_PARENTHESES",
2767 "return is not a function, parentheses are not required\n" . $herecurr);
2769 } elsif ($spacing !~ /\s+/) {
2771 "space required before the open parenthesis '('\n" . $herecurr);
2774 # Return of what appears to be an errno should normally be -'ve
2775 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
2777 if ($name ne 'EOF' && $name ne 'ERROR') {
2778 WARN("USE_NEGATIVE_ERRNO",
2779 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
2783 # Need a space before open parenthesis after if, while etc
2784 if ($line=~/\b(if|while|for|switch)\(/) {
2785 ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr);
2788 # Check for illegal assignment in if conditional -- and check for trailing
2789 # statements after the conditional.
2790 if ($line =~ /do\s*(?!{)/) {
2791 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2792 ctx_statement_block($linenr, $realcnt, 0)
2793 if (!defined $stat);
2794 my ($stat_next) = ctx_statement_block($line_nr_next,
2795 $remain_next, $off_next);
2796 $stat_next =~ s/\n./\n /g;
2797 ##print "stat<$stat> stat_next<$stat_next>\n";
2799 if ($stat_next =~ /^\s*while\b/) {
2800 # If the statement carries leading newlines,
2801 # then count those as offsets.
2803 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2805 statement_rawlines($whitespace) - 1;
2807 $suppress_whiletrailers{$line_nr_next +
2811 if (!defined $suppress_whiletrailers{$linenr} &&
2812 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
2813 my ($s, $c) = ($stat, $cond);
2815 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
2816 ERROR("ASSIGN_IN_IF",
2817 "do not use assignment in if condition\n" . $herecurr);
2820 # Find out what is on the end of the line after the
2822 substr($s, 0, length($c), '');
2824 $s =~ s/$;//g; # Remove any comments
2825 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2826 $c !~ /}\s*while\s*/)
2828 # Find out how long the conditional actually is.
2829 my @newlines = ($c =~ /\n/gs);
2830 my $cond_lines = 1 + $#newlines;
2833 $stat_real = raw_line($linenr, $cond_lines)
2834 . "\n" if ($cond_lines);
2835 if (defined($stat_real) && $cond_lines > 1) {
2836 $stat_real = "[...]\n$stat_real";
2839 ERROR("TRAILING_STATEMENTS",
2840 "trailing statements should be on next line\n" . $herecurr . $stat_real);
2844 # Check for bitwise tests written as boolean
2856 WARN("HEXADECIMAL_BOOLEAN_TEST",
2857 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2860 # if and else should not have general statements after it
2861 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2863 $s =~ s/$;//g; # Remove any comments
2864 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2865 ERROR("TRAILING_STATEMENTS",
2866 "trailing statements should be on next line\n" . $herecurr);
2869 # if should not continue a brace
2870 if ($line =~ /}\s*if\b/) {
2871 ERROR("TRAILING_STATEMENTS",
2872 "trailing statements should be on next line\n" .
2875 # case and default should not have general statements after them
2876 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2878 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
2882 ERROR("TRAILING_STATEMENTS",
2883 "trailing statements should be on next line\n" . $herecurr);
2886 # Check for }<nl>else {, these must be at the same
2887 # indent level to be relevant to each other.
2888 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2889 $previndent == $indent) {
2890 ERROR("ELSE_AFTER_BRACE",
2891 "else should follow close brace '}'\n" . $hereprev);
2894 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2895 $previndent == $indent) {
2896 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2898 # Find out what is on the end of the line after the
2900 substr($s, 0, length($c), '');
2903 if ($s =~ /^\s*;/) {
2904 ERROR("WHILE_AFTER_BRACE",
2905 "while should follow close brace '}'\n" . $hereprev);
2909 #studly caps, commented out until figure out how to distinguish between use of existing and adding new
2910 # if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2911 # print "No studly caps, use _\n";
2912 # print "$herecurr";
2916 #no spaces allowed after \ in define
2917 if ($line=~/\#\s*define.*\\\s$/) {
2918 WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
2919 "Whitepspace after \\ makes next lines useless\n" . $herecurr);
2922 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
2923 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
2925 my $checkfile = "include/linux/$file";
2926 if (-f "$root/$checkfile" &&
2927 $realfile ne $checkfile &&
2928 $1 !~ /$allowed_asm_includes/)
2930 if ($realfile =~ m{^arch/}) {
2931 CHK("ARCH_INCLUDE_LINUX",
2932 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2934 WARN("INCLUDE_LINUX",
2935 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2940 # multi-statement macros should be enclosed in a do while loop, grab the
2941 # first statement and ensure its the whole macro if its not enclosed
2942 # in a known good container
2943 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2944 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
2947 my ($off, $dstat, $dcond, $rest);
2949 ($dstat, $dcond, $ln, $cnt, $off) =
2950 ctx_statement_block($linenr, $realcnt, 0);
2952 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
2953 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
2955 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
2957 $dstat =~ s/\\\n.//g;
2958 $dstat =~ s/^\s*//s;
2959 $dstat =~ s/\s*$//s;
2961 # Flatten any parentheses and braces
2962 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2963 $dstat =~ s/\{[^\{\}]*\}/1/ ||
2964 $dstat =~ s/\[[^\[\]]*\]/1/)
2968 # Flatten any obvious string concatentation.
2969 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
2970 $dstat =~ s/$Ident\s*("X*")/$1/)
2974 my $exceptions = qr{
2986 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
2988 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
2989 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
2990 $dstat !~ /^[!~-]?(?:$Ident|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo
2991 $dstat !~ /^'X'$/ && # character constants
2992 $dstat !~ /$exceptions/ &&
2993 $dstat !~ /^\.$Ident\s*=/ && # .foo =
2994 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
2995 $dstat !~ /^for\s*$Constant$/ && # for (...)
2996 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
2997 $dstat !~ /^do\s*{/ && # do {...
2998 $dstat !~ /^\({/) # ({...
3001 my $herectx = $here . "\n";
3002 my $cnt = statement_rawlines($ctx);
3004 for (my $n = 0; $n < $cnt; $n++) {
3005 $herectx .= raw_line($linenr, $n) . "\n";
3008 if ($dstat =~ /;/) {
3009 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
3010 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
3012 ERROR("COMPLEX_MACRO",
3013 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
3018 # do {} while (0) macro tests:
3019 # single-statement macros do not need to be enclosed in do while (0) loop,
3020 # macro should not end with a semicolon
3021 if ($^V && $^V ge 5.10.0 &&
3022 $realfile !~ m@/vmlinux.lds.h$@ &&
3023 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
3026 my ($off, $dstat, $dcond, $rest);
3028 ($dstat, $dcond, $ln, $cnt, $off) =
3029 ctx_statement_block($linenr, $realcnt, 0);
3032 $dstat =~ s/\\\n.//g;
3034 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
3039 my $cnt = statement_rawlines($ctx);
3040 my $herectx = $here . "\n";
3042 for (my $n = 0; $n < $cnt; $n++) {
3043 $herectx .= raw_line($linenr, $n) . "\n";
3046 if (($stmts =~ tr/;/;/) == 1 &&
3047 $stmts !~ /^\s*(if|while|for|switch)\b/) {
3048 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
3049 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
3051 if (defined $semis && $semis ne "") {
3052 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
3053 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
3058 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3059 # all assignments may have only one of the following with an assignment:
3062 # VMLINUX_SYMBOL(...)
3063 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
3064 WARN("MISSING_VMLINUX_SYMBOL",
3065 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
3068 # check for redundant bracing round if etc
3069 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
3070 my ($level, $endln, @chunks) =
3071 ctx_statement_full($linenr, $realcnt, 1);
3072 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
3073 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3074 if ($#chunks > 0 && $level == 0) {
3078 my $herectx = $here . "\n";
3079 my $ln = $linenr - 1;
3080 for my $chunk (@chunks) {
3081 my ($cond, $block) = @{$chunk};
3083 # If the condition carries leading newlines, then count those as offsets.
3084 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
3085 my $offset = statement_rawlines($whitespace) - 1;
3087 $allowed[$allow] = 0;
3088 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3090 # We have looked at and allowed this specific line.
3091 $suppress_ifbraces{$ln + $offset} = 1;
3093 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
3094 $ln += statement_rawlines($block) - 1;
3096 substr($block, 0, length($cond), '');
3098 $seen++ if ($block =~ /^\s*{/);
3100 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
3101 if (statement_lines($cond) > 1) {
3102 #print "APW: ALLOWED: cond<$cond>\n";
3103 $allowed[$allow] = 1;
3105 if ($block =~/\b(?:if|for|while)\b/) {
3106 #print "APW: ALLOWED: block<$block>\n";
3107 $allowed[$allow] = 1;
3109 if (statement_block_size($block) > 1) {
3110 #print "APW: ALLOWED: lines block<$block>\n";
3111 $allowed[$allow] = 1;
3116 my $sum_allowed = 0;
3117 foreach (@allowed) {
3120 if ($sum_allowed == 0) {
3122 "braces {} are not necessary for any arm of this statement\n" . $herectx);
3123 } elsif ($sum_allowed != $allow &&
3126 "braces {} should be used on all arms of this statement\n" . $herectx);
3131 if (!defined $suppress_ifbraces{$linenr - 1} &&
3132 $line =~ /\b(if|while|for|else)\b/) {
3135 # Check the pre-context.
3136 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
3137 #print "APW: ALLOWED: pre<$1>\n";
3141 my ($level, $endln, @chunks) =
3142 ctx_statement_full($linenr, $realcnt, $-[0]);
3144 # Check the condition.
3145 my ($cond, $block) = @{$chunks[0]};
3146 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
3147 if (defined $cond) {
3148 substr($block, 0, length($cond), '');
3150 if (statement_lines($cond) > 1) {
3151 #print "APW: ALLOWED: cond<$cond>\n";
3154 if ($block =~/\b(?:if|for|while)\b/) {
3155 #print "APW: ALLOWED: block<$block>\n";
3158 if (statement_block_size($block) > 1) {
3159 #print "APW: ALLOWED: lines block<$block>\n";
3162 # Check the post-context.
3163 if (defined $chunks[1]) {
3164 my ($cond, $block) = @{$chunks[1]};
3165 if (defined $cond) {
3166 substr($block, 0, length($cond), '');
3168 if ($block =~ /^\s*\{/) {
3169 #print "APW: ALLOWED: chunk-1 block<$block>\n";
3173 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
3174 my $herectx = $here . "\n";
3175 my $cnt = statement_rawlines($block);
3177 for (my $n = 0; $n < $cnt; $n++) {
3178 $herectx .= raw_line($linenr, $n) . "\n";
3182 "braces {} are not necessary for single statement blocks\n" . $herectx);
3186 # don't include deprecated include files (uses RAW line)
3187 for my $inc (@dep_includes) {
3188 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
3189 ERROR("DEPRECATED_INCLUDE",
3190 "Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
3194 # don't use deprecated functions
3195 for my $func (@dep_functions) {
3196 if ($line =~ /\b$func\b/) {
3197 ERROR("DEPRECATED_FUNCTION",
3198 "Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
3202 # no volatiles please
3203 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
3204 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
3206 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
3210 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
3211 CHK("REDUNDANT_CODE",
3212 "if this code is redundant consider removing it\n" .
3216 # check for needless kfree() checks
3217 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
3219 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
3220 WARN("NEEDLESS_KFREE",
3221 "kfree(NULL) is safe this check is probably not required\n" . $hereprev);
3224 # check for needless usb_free_urb() checks
3225 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
3227 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
3228 WARN("NEEDLESS_USB_FREE_URB",
3229 "usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
3233 # prefer usleep_range over udelay
3234 if ($line =~ /\budelay\s*\(\s*(\w+)\s*\)/) {
3235 # ignore udelay's < 10, however
3236 if (! (($1 =~ /(\d+)/) && ($1 < 10)) ) {
3238 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
3242 # warn about unexpectedly long msleep's
3243 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
3246 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
3250 # warn about #ifdefs in C files
3251 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
3252 # print "#ifdef in C files should be avoided\n";
3253 # print "$herecurr";
3257 # warn about spacing in #ifdefs
3258 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
3260 "exactly one space required after that #$1\n" . $herecurr);
3263 # check for spinlock_t definitions without a comment.
3264 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
3265 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
3267 if (!ctx_has_comment($first_line, $linenr)) {
3268 CHK("UNCOMMENTED_DEFINITION",
3269 "$1 definition without comment\n" . $herecurr);
3272 # check for memory barriers without a comment.
3273 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
3274 if (!ctx_has_comment($first_line, $linenr)) {
3275 CHK("MEMORY_BARRIER",
3276 "memory barrier without comment\n" . $herecurr);
3279 # check of hardware specific defines
3280 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
3282 "architecture specific defines should be avoided\n" . $herecurr);
3285 # Check that the storage class is at the beginning of a declaration
3286 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
3287 WARN("STORAGE_CLASS",
3288 "storage class should be at the beginning of the declaration\n" . $herecurr)
3291 # check the location of the inline attribute, that it is between
3292 # storage class and type.
3293 if ($line =~ /\b$Type\s+$Inline\b/ ||
3294 $line =~ /\b$Inline\s+$Storage\b/) {
3295 ERROR("INLINE_LOCATION",
3296 "inline keyword should sit between storage class and type\n" . $herecurr);
3299 # Check for __inline__ and __inline, prefer inline
3300 if ($line =~ /\b(__inline__|__inline)\b/) {
3302 "plain inline is preferred over $1\n" . $herecurr);
3305 # Check for __attribute__ packed, prefer __packed
3306 if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
3307 WARN("PREFER_PACKED",
3308 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
3311 # Check for __attribute__ aligned, prefer __aligned
3312 if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
3313 WARN("PREFER_ALIGNED",
3314 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
3317 # Check for __attribute__ format(printf, prefer __printf
3318 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
3319 WARN("PREFER_PRINTF",
3320 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr);
3323 # Check for __attribute__ format(scanf, prefer __scanf
3324 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
3325 WARN("PREFER_SCANF",
3326 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr);
3329 # check for sizeof(&)
3330 if ($line =~ /\bsizeof\s*\(\s*\&/) {
3331 WARN("SIZEOF_ADDRESS",
3332 "sizeof(& should be avoided\n" . $herecurr);
3335 # check for sizeof without parenthesis
3336 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
3337 WARN("SIZEOF_PARENTHESIS",
3338 "sizeof $1 should be sizeof($1)\n" . $herecurr);
3341 # check for line continuations in quoted strings with odd counts of "
3342 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
3343 WARN("LINE_CONTINUATIONS",
3344 "Avoid line continuations in quoted strings\n" . $herecurr);
3347 # Check for misused memsets
3348 if ($^V && $^V ge 5.10.0 &&
3350 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
3356 if ($ms_size =~ /^(0x|)0$/i) {
3358 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
3359 } elsif ($ms_size =~ /^(0x|)1$/i) {
3361 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
3365 # typecasts on min/max could be min_t/max_t
3366 if ($^V && $^V ge 5.10.0 &&
3368 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
3369 if (defined $2 || defined $7) {
3371 my $cast1 = deparenthesize($2);
3373 my $cast2 = deparenthesize($7);
3377 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
3378 $cast = "$cast1 or $cast2";
3379 } elsif ($cast1 ne "") {
3385 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
3389 # check usleep_range arguments
3390 if ($^V && $^V ge 5.10.0 &&
3392 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
3396 WARN("USLEEP_RANGE",
3397 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
3398 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
3400 WARN("USLEEP_RANGE",
3401 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
3405 # check for new externs in .c files.
3406 if ($realfile =~ /\.c$/ && defined $stat &&
3407 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
3409 my $function_name = $1;
3410 my $paren_space = $2;
3413 if (defined $cond) {
3414 substr($s, 0, length($cond), '');
3416 if ($s =~ /^\s*;/ &&
3417 $function_name ne 'uninitialized_var')
3419 WARN("AVOID_EXTERNS",
3420 "externs should be avoided in .c files\n" . $herecurr);
3423 if ($paren_space =~ /\n/) {
3424 WARN("FUNCTION_ARGUMENTS",
3425 "arguments for function declarations should follow identifier\n" . $herecurr);
3428 } elsif ($realfile =~ /\.c$/ && defined $stat &&
3429 $stat =~ /^.\s*extern\s+/)
3431 WARN("AVOID_EXTERNS",
3432 "externs should be avoided in .c files\n" . $herecurr);
3435 # checks for new __setup's
3436 if ($rawline =~ /\b__setup\("([^"]*)"/) {
3439 if (!grep(/$name/, @setup_docs)) {
3440 CHK("UNDOCUMENTED_SETUP",
3441 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
3445 # check for pointless casting of kmalloc return
3446 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
3447 WARN("UNNECESSARY_CASTS",
3448 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
3451 # check for multiple semicolons
3452 if ($line =~ /;\s*;\s*$/) {
3453 WARN("ONE_SEMICOLON",
3454 "Statements terminations use 1 semicolon\n" . $herecurr);
3457 # check for gcc specific __FUNCTION__
3458 if ($line =~ /__FUNCTION__/) {
3460 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
3463 # check for use of yield()
3464 if ($line =~ /\byield\s*\(\s*\)/) {
3466 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
3469 # check for semaphores initialized locked
3470 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
3471 WARN("CONSIDER_COMPLETION",
3472 "consider using a completion\n" . $herecurr);
3475 # recommend kstrto* over simple_strto* and strict_strto*
3476 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
3477 WARN("CONSIDER_KSTRTO",
3478 "$1 is obsolete, use k$3 instead\n" . $herecurr);
3481 # check for __initcall(), use device_initcall() explicitly please
3482 if ($line =~ /^.\s*__initcall\s*\(/) {
3483 WARN("USE_DEVICE_INITCALL",
3484 "please use device_initcall() instead of __initcall()\n" . $herecurr);
3487 # check for various ops structs, ensure they are const.
3488 my $struct_ops = qr{acpi_dock_ops|
3489 address_space_operations|
3491 block_device_operations|
3496 file_lock_operations|
3506 lock_manager_operations|
3512 pipe_buf_operations|
3513 platform_hibernation_ops|
3514 platform_suspend_ops|
3519 soc_pcmcia_socket_ops|
3525 if ($line !~ /\bconst\b/ &&
3526 $line =~ /\bstruct\s+($struct_ops)\b/) {
3527 WARN("CONST_STRUCT",
3528 "struct $1 should normally be const\n" .
3532 # use of NR_CPUS is usually wrong
3533 # ignore definitions of NR_CPUS and usage to define arrays as likely right
3534 if ($line =~ /\bNR_CPUS\b/ &&
3535 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
3536 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
3537 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
3538 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
3539 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
3542 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
3545 # check for %L{u,d,i} in strings
3547 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
3548 $string = substr($rawline, $-[1], $+[1] - $-[1]);
3549 $string =~ s/%%/__/g;
3550 if ($string =~ /(?<!%)%L[udi]/) {
3552 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
3557 # whine mightly about in_atomic
3558 if ($line =~ /\bin_atomic\s*\(/) {
3559 if ($realfile =~ m@^drivers/@) {
3561 "do not use in_atomic in drivers\n" . $herecurr);
3562 } elsif ($realfile !~ m@^kernel/@) {
3564 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
3568 # check for lockdep_set_novalidate_class
3569 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
3570 $line =~ /__lockdep_no_validate__\s*\)/ ) {
3571 if ($realfile !~ m@^kernel/lockdep@ &&
3572 $realfile !~ m@^include/linux/lockdep@ &&
3573 $realfile !~ m@^drivers/base/core@) {
3575 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
3579 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
3580 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
3581 WARN("EXPORTED_WORLD_WRITABLE",
3582 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
3586 # If we have no input at all, then there is nothing to report on
3587 # so just keep quiet.
3588 if ($#rawlines == -1) {
3592 # In mailback mode only produce a report in the negative, for
3593 # things that appear to be patches.
3594 if ($mailback && ($clean == 1 || !$is_patch)) {
3598 # This is not a patch, and we are are in 'no-patch' mode so
3600 if (!$chk_patch && !$is_patch) {
3605 ERROR("NOT_UNIFIED_DIFF",
3606 "Does not appear to be a unified-diff format patch\n");
3608 if ($is_patch && $chk_signoff && $signoff == 0) {
3609 ERROR("MISSING_SIGN_OFF",
3610 "Missing Signed-off-by: line(s)\n");
3613 print report_dump();
3614 if ($summary && !($clean == 1 && $quiet == 1)) {
3615 print "$filename " if ($summary_file);
3616 print "total: $cnt_error errors, $cnt_warn warnings, " .
3617 (($check)? "$cnt_chk checks, " : "") .
3618 "$cnt_lines lines checked\n";
3619 print "\n" if ($quiet == 0);
3624 if ($^V lt 5.10.0) {
3625 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
3626 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
3629 # If there were whitespace errors which cleanpatch can fix
3630 # then suggest that.
3631 if ($rpt_cleaners) {
3632 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
3633 print " scripts/cleanfile\n\n";
3638 if ($quiet == 0 && keys %ignore_type) {
3639 print "NOTE: Ignored message types:";
3640 foreach my $ignore (sort keys %ignore_type) {
3646 if ($clean == 1 && $quiet == 0) {
3647 print "$vname has no obvious style problems and is ready for submission.\n"
3649 if ($clean == 0 && $quiet == 0) {
3651 $vname has style problems, please review.
3653 If any of these errors are false positives, please report
3654 them to the maintainer, see CHECKPATCH in MAINTAINERS.