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
16 use Getopt::Long qw(:config no_auto_abbrev);
40 my $configuration_file = ".checkpatch.conf";
41 my $max_line_length = 80;
42 my $ignore_perl_version = 0;
43 my $minimum_perl_version = 5.10.0;
49 Usage: $P [OPTION]... [FILE]...
54 --no-tree run without a kernel tree
55 --no-signoff do not check for 'Signed-off-by' line
56 --patch treat FILE as patchfile (default)
57 --emacs emacs compile window format
58 --terse one line per report
59 -f, --file treat FILE as regular source file
60 --subjective, --strict enable more subjective tests
61 --types TYPE(,TYPE2...) show only these comma separated message types
62 --ignore TYPE(,TYPE2...) ignore various comma separated message types
63 --max-line-length=n set the maximum line length, if exceeded, warn
64 --show-types show the message "types" in the output
65 --root=PATH PATH to the kernel tree root
66 --no-summary suppress the per-file summary
67 --mailback only produce a report in case of warnings/errors
68 --summary-file include the filename in summary
69 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
70 'values', 'possible', 'type', and 'attr' (default
72 --test-only=WORD report only warnings/errors containing WORD
74 --fix EXPERIMENTAL - may create horrible results
75 If correctable single-line errors exist, create
76 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
77 with potential errors corrected to the preferred
79 --ignore-perl-version override checking of perl version. expect
81 -h, --help, --version display this help and exit
83 When FILE is - read standard input.
89 my $conf = which_conf($configuration_file);
92 open(my $conffile, '<', "$conf")
93 or warn "$P: Can't find a readable $configuration_file file $!\n";
98 $line =~ s/\s*\n?$//g;
102 next if ($line =~ m/^\s*#/);
103 next if ($line =~ m/^\s*$/);
105 my @words = split(" ", $line);
106 foreach my $word (@words) {
107 last if ($word =~ m/^#/);
108 push (@conf_args, $word);
112 unshift(@ARGV, @conf_args) if @conf_args;
116 'q|quiet+' => \$quiet,
118 'signoff!' => \$chk_signoff,
119 'patch!' => \$chk_patch,
123 'subjective!' => \$check,
124 'strict!' => \$check,
125 'ignore=s' => \@ignore,
127 'show-types!' => \$show_types,
128 'max-line-length=i' => \$max_line_length,
130 'summary!' => \$summary,
131 'mailback!' => \$mailback,
132 'summary-file!' => \$summary_file,
134 'ignore-perl-version!' => \$ignore_perl_version,
135 'debug=s' => \%debug,
136 'test-only=s' => \$tst_only,
145 if ($^V && $^V lt $minimum_perl_version) {
146 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
147 if (!$ignore_perl_version) {
153 print "$P: no input files\n";
157 sub hash_save_array_words {
158 my ($hashRef, $arrayRef) = @_;
160 my @array = split(/,/, join(',', @$arrayRef));
161 foreach my $word (@array) {
162 $word =~ s/\s*\n?$//g;
165 $word =~ tr/[a-z]/[A-Z]/;
167 next if ($word =~ m/^\s*#/);
168 next if ($word =~ m/^\s*$/);
174 sub hash_show_words {
175 my ($hashRef, $prefix) = @_;
177 if ($quiet == 0 && keys $hashRef) {
178 print "NOTE: $prefix message types:";
179 foreach my $word (sort keys $hashRef) {
186 hash_save_array_words(\%ignore_type, \@ignore);
187 hash_save_array_words(\%use_type, \@use);
190 my $dbg_possible = 0;
193 for my $key (keys %debug) {
195 eval "\${dbg_$key} = '$debug{$key}';";
199 my $rpt_cleaners = 0;
208 if (!top_of_kernel_tree($root)) {
209 die "$P: $root: --root does not point at a valid tree\n";
212 if (top_of_kernel_tree('.')) {
214 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
215 top_of_kernel_tree($1)) {
220 if (!defined $root) {
221 print "Must be run from the top-level dir. of a kernel tree\n";
226 my $emitted_corrupt = 0;
229 [A-Za-z_][A-Za-z\d_]*
230 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
232 our $Storage = qr{extern|static|asmlinkage};
245 # Notes to $Attribute:
246 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
265 __(?:mem|cpu|dev|)(?:initdata|initconst|init\b)|
266 ____cacheline_aligned|
267 ____cacheline_aligned_in_smp|
268 ____cacheline_internodealigned_in_smp|
272 our $Inline = qr{inline|__always_inline|noinline};
273 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
274 our $Lval = qr{$Ident(?:$Member)*};
276 our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
277 our $Binary = qr{(?i)0b[01]+$Int_type?};
278 our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
279 our $Int = qr{[0-9]+$Int_type?};
280 our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
281 our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
282 our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
283 our $Float = qr{$Float_hex|$Float_dec|$Float_int};
284 our $Constant = qr{$Float|$Binary|$Hex|$Int};
285 our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
286 our $Compare = qr{<=|>=|==|!=|<|>};
287 our $Arithmetic = qr{\+|-|\*|\/|%};
291 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
298 our $NON_ASCII_UTF8 = qr{
299 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
300 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
301 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
302 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
303 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
304 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
305 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
309 [\x09\x0A\x0D\x20-\x7E] # ASCII
313 our $typeTypedefs = qr{(?x:
314 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
318 our $logFunctions = qr{(?x:
319 printk(?:_ratelimited|_once|)|
320 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
321 WARN(?:_RATELIMIT|_ONCE|)|
326 our $signature_tags = qr{(?xi:
339 qr{(?:unsigned\s+)?char},
340 qr{(?:unsigned\s+)?short},
341 qr{(?:unsigned\s+)?int},
342 qr{(?:unsigned\s+)?long},
343 qr{(?:unsigned\s+)?long\s+int},
344 qr{(?:unsigned\s+)?long\s+long},
345 qr{(?:unsigned\s+)?long\s+long\s+int},
354 qr{${Ident}_handler},
355 qr{${Ident}_handler_fn},
357 our @modifierList = (
361 our $allowed_asm_includes = qr{(?x:
365 # memory.h: ARM has a custom one
368 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
369 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
370 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
372 (?:$Modifier\s+|const\s+)*
374 (?:typeof|__typeof__)\s*\([^\)]*\)|
378 (?:\s+$Modifier|\s+const)*
382 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*|\[\])+|(?:\s*\[\s*\])+)?
383 (?:\s+$Inline|\s+$Modifier)*
385 $Declare = qr{(?:$Storage\s+)?$Type};
389 our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
391 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
392 # requires at least perl version v5.10.0
393 # Any use must be runtime checked with $^V
395 our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
396 our $LvalOrFunc = qr{($Lval)\s*($balanced_parens{0,1})\s*};
397 our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
401 return "" if (!defined($string));
402 $string =~ s@^\s*\(\s*@@g;
403 $string =~ s@\s*\)\s*$@@g;
404 $string =~ s@\s+@ @g;
408 sub seed_camelcase_file {
411 return if (!(-f $file));
415 open(my $include_file, '<', "$file")
416 or warn "$P: Can't read '$file' $!\n";
417 my $text = <$include_file>;
418 close($include_file);
420 my @lines = split('\n', $text);
422 foreach my $line (@lines) {
423 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
424 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
427 elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*\(/) {
433 my $camelcase_seeded = 0;
434 sub seed_camelcase_includes {
435 return if ($camelcase_seeded);
438 my $camelcase_cache = "";
439 my @include_files = ();
441 $camelcase_seeded = 1;
444 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
445 chomp $git_last_include_commit;
446 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
448 my $last_mod_date = 0;
449 $files = `find $root/include -name "*.h"`;
450 @include_files = split('\n', $files);
451 foreach my $file (@include_files) {
452 my $date = POSIX::strftime("%Y%m%d%H%M",
453 localtime((stat $file)[9]));
454 $last_mod_date = $date if ($last_mod_date < $date);
456 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
459 if ($camelcase_cache ne "" && -f $camelcase_cache) {
460 open(my $camelcase_file, '<', "$camelcase_cache")
461 or warn "$P: Can't read '$camelcase_cache' $!\n";
462 while (<$camelcase_file>) {
466 close($camelcase_file);
472 $files = `git ls-files "include/*.h"`;
473 @include_files = split('\n', $files);
476 foreach my $file (@include_files) {
477 seed_camelcase_file($file);
480 if ($camelcase_cache ne "") {
481 unlink glob ".checkpatch-camelcase.*";
482 open(my $camelcase_file, '>', "$camelcase_cache")
483 or warn "$P: Can't write '$camelcase_cache' $!\n";
484 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
485 print $camelcase_file ("$_\n");
487 close($camelcase_file);
491 $chk_signoff = 0 if ($file);
497 for my $filename (@ARGV) {
500 open($FILE, '-|', "diff -u /dev/null $filename") ||
501 die "$P: $filename: diff failed - $!\n";
502 } elsif ($filename eq '-') {
503 open($FILE, '<&STDIN');
505 open($FILE, '<', "$filename") ||
506 die "$P: $filename: open failed - $!\n";
508 if ($filename eq '-') {
509 $vname = 'Your patch';
518 if (!process($filename)) {
528 sub top_of_kernel_tree {
532 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
533 "README", "Documentation", "arch", "include", "drivers",
534 "fs", "init", "ipc", "kernel", "lib", "scripts",
537 foreach my $check (@tree_check) {
538 if (! -e $root . '/' . $check) {
546 my ($formatted_email) = @_;
552 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
555 $comment = $3 if defined $3;
556 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
558 $comment = $2 if defined $2;
559 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
561 $comment = $2 if defined $2;
562 $formatted_email =~ s/$address.*$//;
563 $name = $formatted_email;
565 $name =~ s/^\"|\"$//g;
566 # If there's a name left after stripping spaces and
567 # leading quotes, and the address doesn't have both
568 # leading and trailing angle brackets, the address
570 # "joe smith joe@smith.com" bad
571 # "joe smith <joe@smith.com" bad
572 if ($name ne "" && $address !~ /^<[^>]+>$/) {
580 $name =~ s/^\"|\"$//g;
581 $address = trim($address);
582 $address =~ s/^\<|\>$//g;
584 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
585 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
589 return ($name, $address, $comment);
593 my ($name, $address) = @_;
598 $name =~ s/^\"|\"$//g;
599 $address = trim($address);
601 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
602 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
607 $formatted_email = "$address";
609 $formatted_email = "$name <$address>";
612 return $formatted_email;
618 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
619 if (-e "$path/$conf") {
620 return "$path/$conf";
632 for my $c (split(//, $str)) {
636 for (; ($n % 8) != 0; $n++) {
648 (my $res = shift) =~ tr/\t/ /c;
655 # Drop the diff line leader and expand tabs
657 $line = expand_tabs($line);
659 # Pick the indent from the front of the line.
660 my ($white) = ($line =~ /^(\s*)/);
662 return (length($line), length($white));
665 my $sanitise_quote = '';
667 sub sanitise_line_reset {
668 my ($in_comment) = @_;
671 $sanitise_quote = '*/';
673 $sanitise_quote = '';
686 # Always copy over the diff marker.
687 $res = substr($line, 0, 1);
689 for ($off = 1; $off < length($line); $off++) {
690 $c = substr($line, $off, 1);
692 # Comments we are wacking completly including the begin
693 # and end, all to $;.
694 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
695 $sanitise_quote = '*/';
697 substr($res, $off, 2, "$;$;");
701 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
702 $sanitise_quote = '';
703 substr($res, $off, 2, "$;$;");
707 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
708 $sanitise_quote = '//';
710 substr($res, $off, 2, $sanitise_quote);
715 # A \ in a string means ignore the next character.
716 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
718 substr($res, $off, 2, 'XX');
723 if ($c eq "'" || $c eq '"') {
724 if ($sanitise_quote eq '') {
725 $sanitise_quote = $c;
727 substr($res, $off, 1, $c);
729 } elsif ($sanitise_quote eq $c) {
730 $sanitise_quote = '';
734 #print "c<$c> SQ<$sanitise_quote>\n";
735 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
736 substr($res, $off, 1, $;);
737 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
738 substr($res, $off, 1, $;);
739 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
740 substr($res, $off, 1, 'X');
742 substr($res, $off, 1, $c);
746 if ($sanitise_quote eq '//') {
747 $sanitise_quote = '';
750 # The pathname on a #include may be surrounded by '<' and '>'.
751 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
752 my $clean = 'X' x length($1);
753 $res =~ s@\<.*\>@<$clean>@;
755 # The whole of a #error is a string.
756 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
757 my $clean = 'X' x length($1);
758 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
764 sub get_quoted_string {
765 my ($line, $rawline) = @_;
767 return "" if ($line !~ m/(\"[X]+\")/g);
768 return substr($rawline, $-[0], $+[0] - $-[0]);
771 sub ctx_statement_block {
772 my ($linenr, $remain, $off) = @_;
773 my $line = $linenr - 1;
790 @stack = (['', 0]) if ($#stack == -1);
792 #warn "CSB: blk<$blk> remain<$remain>\n";
793 # If we are about to drop off the end, pull in more
796 for (; $remain > 0; $line++) {
797 last if (!defined $lines[$line]);
798 next if ($lines[$line] =~ /^-/);
801 $blk .= $lines[$line] . "\n";
806 # Bail if there is no further context.
807 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
811 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
817 $c = substr($blk, $off, 1);
818 $remainder = substr($blk, $off);
820 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
822 # Handle nested #if/#else.
823 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
824 push(@stack, [ $type, $level ]);
825 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
826 ($type, $level) = @{$stack[$#stack - 1]};
827 } elsif ($remainder =~ /^#\s*endif\b/) {
828 ($type, $level) = @{pop(@stack)};
831 # Statement ends at the ';' or a close '}' at the
833 if ($level == 0 && $c eq ';') {
837 # An else is really a conditional as long as its not else if
838 if ($level == 0 && $coff_set == 0 &&
839 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
840 $remainder =~ /^(else)(?:\s|{)/ &&
841 $remainder !~ /^else\s+if\b/) {
842 $coff = $off + length($1) - 1;
844 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
845 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
848 if (($type eq '' || $type eq '(') && $c eq '(') {
852 if ($type eq '(' && $c eq ')') {
854 $type = ($level != 0)? '(' : '';
856 if ($level == 0 && $coff < $soff) {
859 #warn "CSB: mark coff<$coff>\n";
862 if (($type eq '' || $type eq '{') && $c eq '{') {
866 if ($type eq '{' && $c eq '}') {
868 $type = ($level != 0)? '{' : '';
871 if (substr($blk, $off + 1, 1) eq ';') {
877 # Preprocessor commands end at the newline unless escaped.
878 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
886 # We are truly at the end, so shuffle to the next line.
893 my $statement = substr($blk, $soff, $off - $soff + 1);
894 my $condition = substr($blk, $soff, $coff - $soff + 1);
896 #warn "STATEMENT<$statement>\n";
897 #warn "CONDITION<$condition>\n";
899 #print "coff<$coff> soff<$off> loff<$loff>\n";
901 return ($statement, $condition,
902 $line, $remain + 1, $off - $loff + 1, $level);
905 sub statement_lines {
908 # Strip the diff line prefixes and rip blank lines at start and end.
909 $stmt =~ s/(^|\n)./$1/g;
913 my @stmt_lines = ($stmt =~ /\n/g);
915 return $#stmt_lines + 2;
918 sub statement_rawlines {
921 my @stmt_lines = ($stmt =~ /\n/g);
923 return $#stmt_lines + 2;
926 sub statement_block_size {
929 $stmt =~ s/(^|\n)./$1/g;
935 my @stmt_lines = ($stmt =~ /\n/g);
936 my @stmt_statements = ($stmt =~ /;/g);
938 my $stmt_lines = $#stmt_lines + 2;
939 my $stmt_statements = $#stmt_statements + 1;
941 if ($stmt_lines > $stmt_statements) {
944 return $stmt_statements;
948 sub ctx_statement_full {
949 my ($linenr, $remain, $off) = @_;
950 my ($statement, $condition, $level);
954 # Grab the first conditional/block pair.
955 ($statement, $condition, $linenr, $remain, $off, $level) =
956 ctx_statement_block($linenr, $remain, $off);
957 #print "F: c<$condition> s<$statement> remain<$remain>\n";
958 push(@chunks, [ $condition, $statement ]);
959 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
960 return ($level, $linenr, @chunks);
963 # Pull in the following conditional/block pairs and see if they
964 # could continue the statement.
966 ($statement, $condition, $linenr, $remain, $off, $level) =
967 ctx_statement_block($linenr, $remain, $off);
968 #print "C: c<$condition> s<$statement> remain<$remain>\n";
969 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
971 push(@chunks, [ $condition, $statement ]);
974 return ($level, $linenr, @chunks);
978 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
980 my $start = $linenr - 1;
987 my @stack = ($level);
988 for ($line = $start; $remain > 0; $line++) {
989 next if ($rawlines[$line] =~ /^-/);
992 $blk .= $rawlines[$line];
994 # Handle nested #if/#else.
995 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
996 push(@stack, $level);
997 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
998 $level = $stack[$#stack - 1];
999 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1000 $level = pop(@stack);
1003 foreach my $c (split(//, $lines[$line])) {
1004 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1010 if ($c eq $close && $level > 0) {
1012 last if ($level == 0);
1013 } elsif ($c eq $open) {
1018 if (!$outer || $level <= 1) {
1019 push(@res, $rawlines[$line]);
1022 last if ($level == 0);
1025 return ($level, @res);
1027 sub ctx_block_outer {
1028 my ($linenr, $remain) = @_;
1030 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1034 my ($linenr, $remain) = @_;
1036 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1040 my ($linenr, $remain, $off) = @_;
1042 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1045 sub ctx_block_level {
1046 my ($linenr, $remain) = @_;
1048 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1050 sub ctx_statement_level {
1051 my ($linenr, $remain, $off) = @_;
1053 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1056 sub ctx_locate_comment {
1057 my ($first_line, $end_line) = @_;
1059 # Catch a comment on the end of the line itself.
1060 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1061 return $current_comment if (defined $current_comment);
1063 # Look through the context and try and figure out if there is a
1066 $current_comment = '';
1067 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1068 my $line = $rawlines[$linenr - 1];
1070 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1073 if ($line =~ m@/\*@) {
1076 if (!$in_comment && $current_comment ne '') {
1077 $current_comment = '';
1079 $current_comment .= $line . "\n" if ($in_comment);
1080 if ($line =~ m@\*/@) {
1085 chomp($current_comment);
1086 return($current_comment);
1088 sub ctx_has_comment {
1089 my ($first_line, $end_line) = @_;
1090 my $cmt = ctx_locate_comment($first_line, $end_line);
1092 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1093 ##print "CMMT: $cmt\n";
1095 return ($cmt ne '');
1099 my ($linenr, $cnt) = @_;
1101 my $offset = $linenr - 1;
1106 $line = $rawlines[$offset++];
1107 next if (defined($line) && $line =~ /^-/);
1119 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1122 $coded = sprintf("^%c", unpack('C', $2) + 64);
1131 my $av_preprocessor = 0;
1136 sub annotate_reset {
1137 $av_preprocessor = 0;
1139 @av_paren_type = ('E');
1140 $av_pend_colon = 'O';
1143 sub annotate_values {
1144 my ($stream, $type) = @_;
1147 my $var = '_' x length($stream);
1150 print "$stream\n" if ($dbg_values > 1);
1152 while (length($cur)) {
1153 @av_paren_type = ('E') if ($#av_paren_type < 0);
1154 print " <" . join('', @av_paren_type) .
1155 "> <$type> <$av_pending>" if ($dbg_values > 1);
1156 if ($cur =~ /^(\s+)/o) {
1157 print "WS($1)\n" if ($dbg_values > 1);
1158 if ($1 =~ /\n/ && $av_preprocessor) {
1159 $type = pop(@av_paren_type);
1160 $av_preprocessor = 0;
1163 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1164 print "CAST($1)\n" if ($dbg_values > 1);
1165 push(@av_paren_type, $type);
1168 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1169 print "DECLARE($1)\n" if ($dbg_values > 1);
1172 } elsif ($cur =~ /^($Modifier)\s*/) {
1173 print "MODIFIER($1)\n" if ($dbg_values > 1);
1176 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1177 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1178 $av_preprocessor = 1;
1179 push(@av_paren_type, $type);
1185 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1186 print "UNDEF($1)\n" if ($dbg_values > 1);
1187 $av_preprocessor = 1;
1188 push(@av_paren_type, $type);
1190 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1191 print "PRE_START($1)\n" if ($dbg_values > 1);
1192 $av_preprocessor = 1;
1194 push(@av_paren_type, $type);
1195 push(@av_paren_type, $type);
1198 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1199 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1200 $av_preprocessor = 1;
1202 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1206 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1207 print "PRE_END($1)\n" if ($dbg_values > 1);
1209 $av_preprocessor = 1;
1211 # Assume all arms of the conditional end as this
1212 # one does, and continue as if the #endif was not here.
1213 pop(@av_paren_type);
1214 push(@av_paren_type, $type);
1217 } elsif ($cur =~ /^(\\\n)/o) {
1218 print "PRECONT($1)\n" if ($dbg_values > 1);
1220 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1221 print "ATTR($1)\n" if ($dbg_values > 1);
1222 $av_pending = $type;
1225 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1226 print "SIZEOF($1)\n" if ($dbg_values > 1);
1232 } elsif ($cur =~ /^(if|while|for)\b/o) {
1233 print "COND($1)\n" if ($dbg_values > 1);
1237 } elsif ($cur =~/^(case)/o) {
1238 print "CASE($1)\n" if ($dbg_values > 1);
1239 $av_pend_colon = 'C';
1242 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1243 print "KEYWORD($1)\n" if ($dbg_values > 1);
1246 } elsif ($cur =~ /^(\()/o) {
1247 print "PAREN('$1')\n" if ($dbg_values > 1);
1248 push(@av_paren_type, $av_pending);
1252 } elsif ($cur =~ /^(\))/o) {
1253 my $new_type = pop(@av_paren_type);
1254 if ($new_type ne '_') {
1256 print "PAREN('$1') -> $type\n"
1257 if ($dbg_values > 1);
1259 print "PAREN('$1')\n" if ($dbg_values > 1);
1262 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1263 print "FUNC($1)\n" if ($dbg_values > 1);
1267 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1268 if (defined $2 && $type eq 'C' || $type eq 'T') {
1269 $av_pend_colon = 'B';
1270 } elsif ($type eq 'E') {
1271 $av_pend_colon = 'L';
1273 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1276 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1277 print "IDENT($1)\n" if ($dbg_values > 1);
1280 } elsif ($cur =~ /^($Assignment)/o) {
1281 print "ASSIGN($1)\n" if ($dbg_values > 1);
1284 } elsif ($cur =~/^(;|{|})/) {
1285 print "END($1)\n" if ($dbg_values > 1);
1287 $av_pend_colon = 'O';
1289 } elsif ($cur =~/^(,)/) {
1290 print "COMMA($1)\n" if ($dbg_values > 1);
1293 } elsif ($cur =~ /^(\?)/o) {
1294 print "QUESTION($1)\n" if ($dbg_values > 1);
1297 } elsif ($cur =~ /^(:)/o) {
1298 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1300 substr($var, length($res), 1, $av_pend_colon);
1301 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1306 $av_pend_colon = 'O';
1308 } elsif ($cur =~ /^(\[)/o) {
1309 print "CLOSE($1)\n" if ($dbg_values > 1);
1312 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1315 print "OPV($1)\n" if ($dbg_values > 1);
1322 substr($var, length($res), 1, $variant);
1325 } elsif ($cur =~ /^($Operators)/o) {
1326 print "OP($1)\n" if ($dbg_values > 1);
1327 if ($1 ne '++' && $1 ne '--') {
1331 } elsif ($cur =~ /(^.)/o) {
1332 print "C($1)\n" if ($dbg_values > 1);
1335 $cur = substr($cur, length($1));
1336 $res .= $type x length($1);
1340 return ($res, $var);
1344 my ($possible, $line) = @_;
1345 my $notPermitted = qr{(?:
1362 ^(?:typedef|struct|enum)\b
1364 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1365 if ($possible !~ $notPermitted) {
1366 # Check for modifiers.
1367 $possible =~ s/\s*$Storage\s*//g;
1368 $possible =~ s/\s*$Sparse\s*//g;
1369 if ($possible =~ /^\s*$/) {
1371 } elsif ($possible =~ /\s/) {
1372 $possible =~ s/\s*$Type\s*//g;
1373 for my $modifier (split(' ', $possible)) {
1374 if ($modifier !~ $notPermitted) {
1375 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1376 push(@modifierList, $modifier);
1381 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1382 push(@typeList, $possible);
1386 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1393 return defined $use_type{$_[0]} if (scalar keys %use_type > 0);
1395 return !defined $ignore_type{$_[0]};
1399 if (!show_type($_[1]) ||
1400 (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) {
1405 $line = "$prefix$_[0]:$_[1]: $_[2]\n";
1407 $line = "$prefix$_[0]: $_[2]\n";
1409 $line = (split('\n', $line))[0] . "\n" if ($terse);
1411 push(our @report, $line);
1420 if (report("ERROR", $_[0], $_[1])) {
1428 if (report("WARNING", $_[0], $_[1])) {
1436 if ($check && report("CHECK", $_[0], $_[1])) {
1444 sub check_absolute_file {
1445 my ($absolute, $herecurr) = @_;
1446 my $file = $absolute;
1448 ##print "absolute<$absolute>\n";
1450 # See if any suffix of this path is a path within the tree.
1451 while ($file =~ s@^[^/]*/@@) {
1452 if (-f "$root/$file") {
1453 ##print "file<$file>\n";
1461 # It is, so see if the prefix is acceptable.
1462 my $prefix = $absolute;
1463 substr($prefix, -length($file)) = '';
1465 ##print "prefix<$prefix>\n";
1466 if ($prefix ne ".../") {
1467 WARN("USE_RELATIVE_PATH",
1468 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1475 $string =~ s/^\s+|\s+$//g;
1483 $string =~ s/^\s+//;
1491 $string =~ s/\s+$//;
1499 my $source_indent = 8;
1500 my $max_spaces_before_tab = $source_indent - 1;
1501 my $spaces_to_tab = " " x $source_indent;
1503 #convert leading spaces to tabs
1504 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1505 #Remove spaces before a tab
1506 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1511 sub pos_last_openparen {
1516 my $opens = $line =~ tr/\(/\(/;
1517 my $closes = $line =~ tr/\)/\)/;
1519 my $last_openparen = 0;
1521 if (($opens == 0) || ($closes >= $opens)) {
1525 my $len = length($line);
1527 for ($pos = 0; $pos < $len; $pos++) {
1528 my $string = substr($line, $pos);
1529 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1530 $pos += length($1) - 1;
1531 } elsif (substr($line, $pos, 1) eq '(') {
1532 $last_openparen = $pos;
1533 } elsif (index($string, '(') == -1) {
1538 return $last_openparen + 1;
1542 my $filename = shift;
1548 my $stashrawline="";
1559 my $in_header_lines = 1;
1560 my $in_commit_log = 0; #Scanning lines before patch
1562 my $non_utf8_charset = 0;
1570 # Trace the real file/line as we go.
1576 my $comment_edge = 0;
1580 my $prev_values = 'E';
1583 my %suppress_ifbraces;
1584 my %suppress_whiletrailers;
1585 my %suppress_export;
1586 my $suppress_statement = 0;
1588 my %signatures = ();
1590 # Pre-scan the patch sanitizing the lines.
1591 # Pre-scan the patch looking for any __setup documentation.
1593 my @setup_docs = ();
1596 sanitise_line_reset();
1598 foreach my $rawline (@rawlines) {
1602 push(@fixed, $rawline) if ($fix);
1604 if ($rawline=~/^\+\+\+\s+(\S+)/) {
1606 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1611 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1620 # Guestimate if this is a continuing comment. Run
1621 # the context looking for a comment "edge". If this
1622 # edge is a close comment then we must be in a comment
1626 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1627 next if (defined $rawlines[$ln - 1] &&
1628 $rawlines[$ln - 1] =~ /^-/);
1630 #print "RAW<$rawlines[$ln - 1]>\n";
1631 last if (!defined $rawlines[$ln - 1]);
1632 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1633 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1638 if (defined $edge && $edge eq '*/') {
1642 # Guestimate if this is a continuing comment. If this
1643 # is the start of a diff block and this line starts
1644 # ' *' then it is very likely a comment.
1645 if (!defined $edge &&
1646 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1651 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1652 sanitise_line_reset($in_comment);
1654 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1655 # Standardise the strings and chars within the input to
1656 # simplify matching -- only bother with positive lines.
1657 $line = sanitise_line($rawline);
1659 push(@lines, $line);
1662 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1667 #print "==>$rawline\n";
1668 #print "-->$line\n";
1670 if ($setup_docs && $line =~ /^\+/) {
1671 push(@setup_docs, $line);
1679 foreach my $line (@lines) {
1682 my $rawline = $rawlines[$linenr - 1];
1684 #extract the line range in the file after the patch is applied
1685 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1687 $first_line = $linenr + 1;
1697 %suppress_ifbraces = ();
1698 %suppress_whiletrailers = ();
1699 %suppress_export = ();
1700 $suppress_statement = 0;
1703 # track the line number as we move through the hunk, note that
1704 # new versions of GNU diff omit the leading space on completely
1705 # blank context lines so we need to count that too.
1706 } elsif ($line =~ /^( |\+|$)/) {
1708 $realcnt-- if ($realcnt != 0);
1710 # Measure the line length and indent.
1711 ($length, $indent) = line_stats($rawline);
1713 # Track the previous line.
1714 ($prevline, $stashline) = ($stashline, $line);
1715 ($previndent, $stashindent) = ($stashindent, $indent);
1716 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1718 #warn "line<$line>\n";
1720 } elsif ($realcnt == 1) {
1724 my $hunk_line = ($realcnt != 0);
1726 #make up the handle for any error we report on this line
1727 $prefix = "$filename:$realline: " if ($emacs && $file);
1728 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1730 $here = "#$linenr: " if (!$file);
1731 $here = "#$realline: " if ($file);
1733 # extract the filename as it passes
1734 if ($line =~ /^diff --git.*?(\S+)$/) {
1736 $realfile =~ s@^([^/]*)/@@;
1738 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
1740 $realfile =~ s@^([^/]*)/@@;
1744 if (!$file && $tree && $p1_prefix ne '' &&
1745 -e "$root/$p1_prefix") {
1746 WARN("PATCH_PREFIX",
1747 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1750 if ($realfile =~ m@^include/asm/@) {
1751 ERROR("MODIFIED_INCLUDE_ASM",
1752 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1757 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
1759 my $hereline = "$here\n$rawline\n";
1760 my $herecurr = "$here\n$rawline\n";
1761 my $hereprev = "$here\n$prevrawline\n$rawline\n";
1763 $cnt_lines++ if ($realcnt != 0);
1765 # Check for incorrect file permissions
1766 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1767 my $permhere = $here . "FILE: $realfile\n";
1768 if ($realfile !~ m@scripts/@ &&
1769 $realfile !~ /\.(py|pl|awk|sh)$/) {
1770 ERROR("EXECUTE_PERMISSIONS",
1771 "do not set execute permissions for source files\n" . $permhere);
1775 # Check the patch for a signoff:
1776 if ($line =~ /^\s*signed-off-by:/i) {
1781 # Check signature styles
1782 if (!$in_header_lines &&
1783 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
1784 my $space_before = $1;
1786 my $space_after = $3;
1788 my $ucfirst_sign_off = ucfirst(lc($sign_off));
1790 if ($sign_off !~ /$signature_tags/) {
1791 WARN("BAD_SIGN_OFF",
1792 "Non-standard signature: $sign_off\n" . $herecurr);
1794 if (defined $space_before && $space_before ne "") {
1795 if (WARN("BAD_SIGN_OFF",
1796 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
1798 $fixed[$linenr - 1] =
1799 "$ucfirst_sign_off $email";
1802 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
1803 if (WARN("BAD_SIGN_OFF",
1804 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
1806 $fixed[$linenr - 1] =
1807 "$ucfirst_sign_off $email";
1811 if (!defined $space_after || $space_after ne " ") {
1812 if (WARN("BAD_SIGN_OFF",
1813 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
1815 $fixed[$linenr - 1] =
1816 "$ucfirst_sign_off $email";
1820 my ($email_name, $email_address, $comment) = parse_email($email);
1821 my $suggested_email = format_email(($email_name, $email_address));
1822 if ($suggested_email eq "") {
1823 ERROR("BAD_SIGN_OFF",
1824 "Unrecognized email address: '$email'\n" . $herecurr);
1826 my $dequoted = $suggested_email;
1827 $dequoted =~ s/^"//;
1828 $dequoted =~ s/" </ </;
1829 # Don't force email to have quotes
1830 # Allow just an angle bracketed address
1831 if ("$dequoted$comment" ne $email &&
1832 "<$email_address>$comment" ne $email &&
1833 "$suggested_email$comment" ne $email) {
1834 WARN("BAD_SIGN_OFF",
1835 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
1839 # Check for duplicate signatures
1840 my $sig_nospace = $line;
1841 $sig_nospace =~ s/\s//g;
1842 $sig_nospace = lc($sig_nospace);
1843 if (defined $signatures{$sig_nospace}) {
1844 WARN("BAD_SIGN_OFF",
1845 "Duplicate signature\n" . $herecurr);
1847 $signatures{$sig_nospace} = 1;
1851 # Check for wrappage within a valid hunk of the file
1852 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1853 ERROR("CORRUPTED_PATCH",
1854 "patch seems to be corrupt (line wrapped?)\n" .
1855 $herecurr) if (!$emitted_corrupt++);
1858 # Check for absolute kernel paths.
1860 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1863 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1864 check_absolute_file($1, $herecurr)) {
1867 check_absolute_file($file, $herecurr);
1872 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1873 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1874 $rawline !~ m/^$UTF8*$/) {
1875 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1877 my $blank = copy_spacing($rawline);
1878 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1879 my $hereptr = "$hereline$ptr\n";
1882 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1885 # Check if it's the start of a commit log
1886 # (not a header line and we haven't seen the patch filename)
1887 if ($in_header_lines && $realfile =~ /^$/ &&
1888 $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
1889 $in_header_lines = 0;
1893 # Check if there is UTF-8 in a commit log when a mail header has explicitly
1894 # declined it, i.e defined some charset where it is missing.
1895 if ($in_header_lines &&
1896 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
1898 $non_utf8_charset = 1;
1901 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
1902 $rawline =~ /$NON_ASCII_UTF8/) {
1903 WARN("UTF8_BEFORE_PATCH",
1904 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
1907 # ignore non-hunk lines and lines being removed
1908 next if (!$hunk_line || $line =~ /^-/);
1910 #trailing whitespace
1911 if ($line =~ /^\+.*\015/) {
1912 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1913 if (ERROR("DOS_LINE_ENDINGS",
1914 "DOS line endings\n" . $herevet) &&
1916 $fixed[$linenr - 1] =~ s/[\s\015]+$//;
1918 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1919 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1920 if (ERROR("TRAILING_WHITESPACE",
1921 "trailing whitespace\n" . $herevet) &&
1923 $fixed[$linenr - 1] =~ s/\s+$//;
1929 # check for Kconfig help text having a real description
1930 # Only applies when adding the entry originally, after that we do not have
1931 # sufficient context to determine whether it is indeed long enough.
1932 if ($realfile =~ /Kconfig/ &&
1933 $line =~ /.\s*config\s+/) {
1936 my $ln = $linenr + 1;
1940 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
1941 $f = $lines[$ln - 1];
1942 $cnt-- if ($lines[$ln - 1] !~ /^-/);
1943 $is_end = $lines[$ln - 1] =~ /^\+/;
1945 next if ($f =~ /^-/);
1947 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
1949 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
1956 next if ($f =~ /^$/);
1957 if ($f =~ /^\s*config\s/) {
1963 WARN("CONFIG_DESCRIPTION",
1964 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
1965 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
1968 # discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
1969 if ($realfile =~ /Kconfig/ &&
1970 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
1971 WARN("CONFIG_EXPERIMENTAL",
1972 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
1975 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
1976 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
1979 'EXTRA_AFLAGS' => 'asflags-y',
1980 'EXTRA_CFLAGS' => 'ccflags-y',
1981 'EXTRA_CPPFLAGS' => 'cppflags-y',
1982 'EXTRA_LDFLAGS' => 'ldflags-y',
1985 WARN("DEPRECATED_VARIABLE",
1986 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
1989 # check we are in a valid source file if not then ignore this hunk
1990 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1993 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
1994 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1995 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
1996 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
1997 $length > $max_line_length)
2000 "line over $max_line_length characters\n" . $herecurr);
2003 # Check for user-visible strings broken across lines, which breaks the ability
2004 # to grep for the string. Limited to strings used as parameters (those
2005 # following an open parenthesis), which almost completely eliminates false
2006 # positives, as well as warning only once per parameter rather than once per
2007 # line of the string. Make an exception when the previous string ends in a
2008 # newline (multiple lines in one string constant) or \n\t (common in inline
2009 # assembly to indent the instruction on the following line).
2010 if ($line =~ /^\+\s*"/ &&
2011 $prevline =~ /"\s*$/ &&
2012 $prevline =~ /\(/ &&
2013 $prevrawline !~ /\\n(?:\\t)*"\s*$/) {
2014 WARN("SPLIT_STRING",
2015 "quoted string split across lines\n" . $hereprev);
2018 # check for spaces before a quoted newline
2019 if ($rawline =~ /^.*\".*\s\\n/) {
2020 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
2021 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
2023 $fixed[$linenr - 1] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
2028 # check for adding lines without a newline.
2029 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2030 WARN("MISSING_EOF_NEWLINE",
2031 "adding a line without newline at end of file\n" . $herecurr);
2034 # Blackfin: use hi/lo macros
2035 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2036 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2037 my $herevet = "$here\n" . cat_vet($line) . "\n";
2039 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
2041 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2042 my $herevet = "$here\n" . cat_vet($line) . "\n";
2044 "use the HI() macro, not (... >> 16)\n" . $herevet);
2048 # check we are in a valid source file C or perl if not then ignore this hunk
2049 next if ($realfile !~ /\.(h|c|pl)$/);
2051 # at the beginning of a line any tabs must come first and anything
2052 # more than 8 must use tabs.
2053 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2054 $rawline =~ /^\+\s* \s*/) {
2055 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2057 if (ERROR("CODE_INDENT",
2058 "code indent should use tabs where possible\n" . $herevet) &&
2060 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2064 # check for space before tabs.
2065 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2066 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2067 if (WARN("SPACE_BEFORE_TAB",
2068 "please, no space before tabs\n" . $herevet) &&
2070 $fixed[$linenr - 1] =~
2071 s/(^\+.*) +\t/$1\t/;
2075 # check for && or || at the start of a line
2076 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2077 CHK("LOGICAL_CONTINUATIONS",
2078 "Logical continuations should be on the previous line\n" . $hereprev);
2081 # check multi-line statement indentation matches previous line
2082 if ($^V && $^V ge 5.10.0 &&
2083 $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) {
2084 $prevline =~ /^\+(\t*)(.*)$/;
2088 my $pos = pos_last_openparen($rest);
2090 $line =~ /^(\+| )([ \t]*)/;
2093 my $goodtabindent = $oldindent .
2096 my $goodspaceindent = $oldindent . " " x $pos;
2098 if ($newindent ne $goodtabindent &&
2099 $newindent ne $goodspaceindent) {
2101 if (CHK("PARENTHESIS_ALIGNMENT",
2102 "Alignment should match open parenthesis\n" . $hereprev) &&
2103 $fix && $line =~ /^\+/) {
2104 $fixed[$linenr - 1] =~
2105 s/^\+[ \t]*/\+$goodtabindent/;
2111 if ($line =~ /^\+.*\*[ \t]*\)[ \t]+(?!$Assignment|$Arithmetic)/) {
2113 "No space is necessary after a cast\n" . $hereprev) &&
2115 $fixed[$linenr - 1] =~
2116 s/^(\+.*\*[ \t]*\))[ \t]+/$1/;
2120 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2121 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
2122 $rawline =~ /^\+[ \t]*\*/) {
2123 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2124 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2127 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2128 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2129 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
2130 $rawline =~ /^\+/ && #line is new
2131 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2132 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2133 "networking block comments start with * on subsequent lines\n" . $hereprev);
2136 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2137 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2138 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2139 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2140 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
2141 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2142 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2145 # check for spaces at the beginning of a line.
2147 # 1) within comments
2148 # 2) indented preprocessor commands
2150 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
2151 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2152 if (WARN("LEADING_SPACE",
2153 "please, no spaces at the start of a line\n" . $herevet) &&
2155 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2159 # check we are in a valid C source file if not then ignore this hunk
2160 next if ($realfile !~ /\.(h|c)$/);
2162 # discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2163 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2164 WARN("CONFIG_EXPERIMENTAL",
2165 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2168 # check for RCS/CVS revision markers
2169 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
2171 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
2174 # Blackfin: don't use __builtin_bfin_[cs]sync
2175 if ($line =~ /__builtin_bfin_csync/) {
2176 my $herevet = "$here\n" . cat_vet($line) . "\n";
2178 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
2180 if ($line =~ /__builtin_bfin_ssync/) {
2181 my $herevet = "$here\n" . cat_vet($line) . "\n";
2183 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
2186 # check for old HOTPLUG __dev<foo> section markings
2187 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2188 WARN("HOTPLUG_SECTION",
2189 "Using $1 is unnecessary\n" . $herecurr);
2192 # Check for potential 'bare' types
2193 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2195 #print "LINE<$line>\n";
2196 if ($linenr >= $suppress_statement &&
2197 $realcnt && $line =~ /.\s*\S/) {
2198 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2199 ctx_statement_block($linenr, $realcnt, 0);
2200 $stat =~ s/\n./\n /g;
2201 $cond =~ s/\n./\n /g;
2203 #print "linenr<$linenr> <$stat>\n";
2204 # If this statement has no statement boundaries within
2205 # it there is no point in retrying a statement scan
2206 # until we hit end of it.
2207 my $frag = $stat; $frag =~ s/;+\s*$//;
2208 if ($frag !~ /(?:{|;)/) {
2209 #print "skip<$line_nr_next>\n";
2210 $suppress_statement = $line_nr_next;
2213 # Find the real next line.
2214 $realline_next = $line_nr_next;
2215 if (defined $realline_next &&
2216 (!defined $lines[$realline_next - 1] ||
2217 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2224 # Ignore goto labels.
2225 if ($s =~ /$Ident:\*$/s) {
2227 # Ignore functions being called
2228 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
2230 } elsif ($s =~ /^.\s*else\b/s) {
2232 # declarations always start with types
2233 } 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) {
2236 possible($type, "A:" . $s);
2238 # definitions in global scope can only start with types
2239 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
2240 possible($1, "B:" . $s);
2243 # any (foo ... *) is a pointer cast, and foo is a type
2244 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
2245 possible($1, "C:" . $s);
2248 # Check for any sort of function declaration.
2249 # int foo(something bar, other baz);
2250 # void (*store_gdt)(x86_descr_ptr *);
2251 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
2252 my ($name_len) = length($1);
2255 substr($ctx, 0, $name_len + 1, '');
2256 $ctx =~ s/\)[^\)]*$//;
2258 for my $arg (split(/\s*,\s*/, $ctx)) {
2259 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
2261 possible($1, "D:" . $s);
2269 # Checks which may be anchored in the context.
2272 # Check for switch () and associated case and default
2273 # statements should be at the same indent.
2274 if ($line=~/\bswitch\s*\(.*\)/) {
2277 my @ctx = ctx_block_outer($linenr, $realcnt);
2279 for my $ctx (@ctx) {
2280 my ($clen, $cindent) = line_stats($ctx);
2281 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2282 $indent != $cindent) {
2283 $err .= "$sep$ctx\n";
2290 ERROR("SWITCH_CASE_INDENT_LEVEL",
2291 "switch and case should be at the same indent\n$hereline$err");
2295 # if/while/etc brace do not go on next line, unless defining a do while loop,
2296 # or if that brace on the next line is for something else
2297 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
2298 my $pre_ctx = "$1$2";
2300 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
2302 if ($line =~ /^\+\t{6,}/) {
2303 WARN("DEEP_INDENTATION",
2304 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2307 my $ctx_cnt = $realcnt - $#ctx - 1;
2308 my $ctx = join("\n", @ctx);
2310 my $ctx_ln = $linenr;
2311 my $ctx_skip = $realcnt;
2313 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2314 defined $lines[$ctx_ln - 1] &&
2315 $lines[$ctx_ln - 1] =~ /^-/)) {
2316 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2317 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
2321 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2322 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
2324 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
2326 "that open brace { should be on the previous line\n" .
2327 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2329 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2330 $ctx =~ /\)\s*\;\s*$/ &&
2331 defined $lines[$ctx_ln - 1])
2333 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2334 if ($nindent > $indent) {
2335 WARN("TRAILING_SEMICOLON",
2336 "trailing semicolon indicates no statements, indent implies otherwise\n" .
2337 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2342 # Check relative indent for conditionals and blocks.
2343 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2344 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2345 ctx_statement_block($linenr, $realcnt, 0)
2346 if (!defined $stat);
2347 my ($s, $c) = ($stat, $cond);
2349 substr($s, 0, length($c), '');
2351 # Make sure we remove the line prefixes as we have
2352 # none on the first line, and are going to readd them
2356 # Find out how long the conditional actually is.
2357 my @newlines = ($c =~ /\n/gs);
2358 my $cond_lines = 1 + $#newlines;
2360 # We want to check the first line inside the block
2361 # starting at the end of the conditional, so remove:
2362 # 1) any blank line termination
2363 # 2) any opening brace { on end of the line
2365 my $continuation = 0;
2367 $s =~ s/^.*\bdo\b//;
2369 if ($s =~ s/^\s*\\//) {
2372 if ($s =~ s/^\s*?\n//) {
2377 # Also ignore a loop construct at the end of a
2378 # preprocessor statement.
2379 if (($prevline =~ /^.\s*#\s*define\s/ ||
2380 $prevline =~ /\\\s*$/) && $continuation == 0) {
2386 while ($cond_ptr != $cond_lines) {
2387 $cond_ptr = $cond_lines;
2389 # If we see an #else/#elif then the code
2391 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2396 # 1) blank lines, they should be at 0,
2397 # 2) preprocessor lines, and
2399 if ($continuation ||
2401 $s =~ /^\s*#\s*?/ ||
2402 $s =~ /^\s*$Ident\s*:/) {
2403 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
2404 if ($s =~ s/^.*?\n//) {
2410 my (undef, $sindent) = line_stats("+" . $s);
2411 my $stat_real = raw_line($linenr, $cond_lines);
2413 # Check if either of these lines are modified, else
2414 # this is not this patch's fault.
2415 if (!defined($stat_real) ||
2416 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2419 if (defined($stat_real) && $cond_lines > 1) {
2420 $stat_real = "[...]\n$stat_real";
2423 #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";
2425 if ($check && (($sindent % 8) != 0 ||
2426 ($sindent <= $indent && $s ne ''))) {
2427 WARN("SUSPECT_CODE_INDENT",
2428 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
2432 # Track the 'values' across context and added lines.
2433 my $opline = $line; $opline =~ s/^./ /;
2434 my ($curr_values, $curr_vars) =
2435 annotate_values($opline . "\n", $prev_values);
2436 $curr_values = $prev_values . $curr_values;
2438 my $outline = $opline; $outline =~ s/\t/ /g;
2439 print "$linenr > .$outline\n";
2440 print "$linenr > $curr_values\n";
2441 print "$linenr > $curr_vars\n";
2443 $prev_values = substr($curr_values, -1);
2445 #ignore lines not being added
2446 next if ($line =~ /^[^\+]/);
2448 # TEST: allow direct testing of the type matcher.
2450 if ($line =~ /^.\s*$Declare\s*$/) {
2452 "TEST: is type\n" . $herecurr);
2453 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
2454 ERROR("TEST_NOT_TYPE",
2455 "TEST: is not type ($1 is)\n". $herecurr);
2459 # TEST: allow direct testing of the attribute matcher.
2461 if ($line =~ /^.\s*$Modifier\s*$/) {
2463 "TEST: is attr\n" . $herecurr);
2464 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
2465 ERROR("TEST_NOT_ATTR",
2466 "TEST: is not attr ($1 is)\n". $herecurr);
2471 # check for initialisation to aggregates open brace on the next line
2472 if ($line =~ /^.\s*{/ &&
2473 $prevline =~ /(?:^|[^=])=\s*$/) {
2475 "that open brace { should be on the previous line\n" . $hereprev);
2479 # Checks which are anchored on the added line.
2482 # check for malformed paths in #include statements (uses RAW line)
2483 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
2485 if ($path =~ m{//}) {
2486 ERROR("MALFORMED_INCLUDE",
2487 "malformed #include filename\n" . $herecurr);
2489 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
2490 ERROR("UAPI_INCLUDE",
2491 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
2495 # no C99 // comments
2496 if ($line =~ m{//}) {
2497 if (ERROR("C99_COMMENTS",
2498 "do not use C99 // comments\n" . $herecurr) &&
2500 my $line = $fixed[$linenr - 1];
2501 if ($line =~ /\/\/(.*)$/) {
2502 my $comment = trim($1);
2503 $fixed[$linenr - 1] =~ s@\/\/(.*)$@/\* $comment \*/@;
2507 # Remove C99 comments.
2509 $opline =~ s@//.*@@;
2511 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2512 # the whole statement.
2513 #print "APW <$lines[$realline_next - 1]>\n";
2514 if (defined $realline_next &&
2515 exists $lines[$realline_next - 1] &&
2516 !defined $suppress_export{$realline_next} &&
2517 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2518 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2519 # Handle definitions which produce identifiers with
2522 # EXPORT_SYMBOL(something_foo);
2524 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
2525 $name =~ /^${Ident}_$2/) {
2526 #print "FOO C name<$name>\n";
2527 $suppress_export{$realline_next} = 1;
2529 } elsif ($stat !~ /(?:
2531 ^.DEFINE_$Ident\(\Q$name\E\)|
2532 ^.DECLARE_$Ident\(\Q$name\E\)|
2533 ^.LIST_HEAD\(\Q$name\E\)|
2534 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2535 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
2537 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2538 $suppress_export{$realline_next} = 2;
2540 $suppress_export{$realline_next} = 1;
2543 if (!defined $suppress_export{$linenr} &&
2544 $prevline =~ /^.\s*$/ &&
2545 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2546 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2547 #print "FOO B <$lines[$linenr - 1]>\n";
2548 $suppress_export{$linenr} = 2;
2550 if (defined $suppress_export{$linenr} &&
2551 $suppress_export{$linenr} == 2) {
2552 WARN("EXPORT_SYMBOL",
2553 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
2556 # check for global initialisers.
2557 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
2558 if (ERROR("GLOBAL_INITIALISERS",
2559 "do not initialise globals to 0 or NULL\n" .
2562 $fixed[$linenr - 1] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
2565 # check for static initialisers.
2566 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2567 if (ERROR("INITIALISED_STATIC",
2568 "do not initialise statics to 0 or NULL\n" .
2571 $fixed[$linenr - 1] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
2575 # check for static const char * arrays.
2576 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
2577 WARN("STATIC_CONST_CHAR_ARRAY",
2578 "static const char * array should probably be static const char * const\n" .
2582 # check for static char foo[] = "bar" declarations.
2583 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
2584 WARN("STATIC_CONST_CHAR_ARRAY",
2585 "static char array declaration should probably be static const char\n" .
2589 # check for declarations of struct pci_device_id
2590 if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) {
2591 WARN("DEFINE_PCI_DEVICE_TABLE",
2592 "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr);
2595 # check for new typedefs, only function parameters and sparse annotations
2597 if ($line =~ /\btypedef\s/ &&
2598 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
2599 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
2600 $line !~ /\b$typeTypedefs\b/ &&
2601 $line !~ /\b__bitwise(?:__|)\b/) {
2602 WARN("NEW_TYPEDEFS",
2603 "do not add new typedefs\n" . $herecurr);
2606 # * goes on variable not on type
2608 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2610 my ($ident, $from, $to) = ($1, $2, $2);
2612 # Should start with a space.
2613 $to =~ s/^(\S)/ $1/;
2614 # Should not end with a space.
2616 # '*'s should not have spaces between.
2617 while ($to =~ s/\*\s+\*/\*\*/) {
2620 ## print "1: from<$from> to<$to> ident<$ident>\n";
2622 if (ERROR("POINTER_LOCATION",
2623 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
2625 my $sub_from = $ident;
2626 my $sub_to = $ident;
2627 $sub_to =~ s/\Q$from\E/$to/;
2628 $fixed[$linenr - 1] =~
2629 s@\Q$sub_from\E@$sub_to@;
2633 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2635 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
2637 # Should start with a space.
2638 $to =~ s/^(\S)/ $1/;
2639 # Should not end with a space.
2641 # '*'s should not have spaces between.
2642 while ($to =~ s/\*\s+\*/\*\*/) {
2644 # Modifiers should have spaces.
2645 $to =~ s/(\b$Modifier$)/$1 /;
2647 ## print "2: from<$from> to<$to> ident<$ident>\n";
2648 if ($from ne $to && $ident !~ /^$Modifier$/) {
2649 if (ERROR("POINTER_LOCATION",
2650 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
2653 my $sub_from = $match;
2654 my $sub_to = $match;
2655 $sub_to =~ s/\Q$from\E/$to/;
2656 $fixed[$linenr - 1] =~
2657 s@\Q$sub_from\E@$sub_to@;
2662 # # no BUG() or BUG_ON()
2663 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
2664 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2665 # print "$herecurr";
2669 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
2670 WARN("LINUX_VERSION_CODE",
2671 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
2674 # check for uses of printk_ratelimit
2675 if ($line =~ /\bprintk_ratelimit\s*\(/) {
2676 WARN("PRINTK_RATELIMITED",
2677 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
2680 # printk should use KERN_* levels. Note that follow on printk's on the
2681 # same line do not need a level, so we use the current block context
2682 # to try and find and validate the current printk. In summary the current
2683 # printk includes all preceding printk's which have no newline on the end.
2684 # we assume the first bad printk is the one to report.
2685 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
2687 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2688 #print "CHECK<$lines[$ln - 1]\n";
2689 # we have a preceding printk if it ends
2690 # with "\n" ignore it, else it is to blame
2691 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2692 if ($rawlines[$ln - 1] !~ m{\\n"}) {
2699 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2700 "printk() should include KERN_ facility level\n" . $herecurr);
2704 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
2706 my $level = lc($orig);
2707 $level = "warn" if ($level eq "warning");
2708 my $level2 = $level;
2709 $level2 = "dbg" if ($level eq "debug");
2710 WARN("PREFER_PR_LEVEL",
2711 "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
2714 if ($line =~ /\bpr_warning\s*\(/) {
2715 if (WARN("PREFER_PR_LEVEL",
2716 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
2718 $fixed[$linenr - 1] =~
2719 s/\bpr_warning\b/pr_warn/;
2723 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
2725 my $level = lc($orig);
2726 $level = "warn" if ($level eq "warning");
2727 $level = "dbg" if ($level eq "debug");
2728 WARN("PREFER_DEV_LEVEL",
2729 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
2732 # function brace can't be on same line, except for #defines of do while,
2733 # or if closed on same line
2734 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2735 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
2737 "open brace '{' following function declarations go on the next line\n" . $herecurr);
2740 # open braces for enum, union and struct go on the same line.
2741 if ($line =~ /^.\s*{/ &&
2742 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
2744 "open brace '{' following $1 go on the same line\n" . $hereprev);
2747 # missing space after union, struct or enum definition
2748 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
2750 "missing space after $1 definition\n" . $herecurr) &&
2752 $fixed[$linenr - 1] =~
2753 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
2757 # check for spacing round square brackets; allowed:
2758 # 1. with a type on the left -- int [] a;
2759 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2760 # 3. inside a curly brace -- = { [0...10] = 5 }
2761 while ($line =~ /(.*?\s)\[/g) {
2762 my ($where, $prefix) = ($-[1], $1);
2763 if ($prefix !~ /$Type\s+$/ &&
2764 ($where != 0 || $prefix !~ /^.\s+$/) &&
2765 $prefix !~ /[{,]\s+$/) {
2766 if (ERROR("BRACKET_SPACE",
2767 "space prohibited before open square bracket '['\n" . $herecurr) &&
2769 $fixed[$linenr - 1] =~
2770 s/^(\+.*?)\s+\[/$1\[/;
2775 # check for spaces between functions and their parentheses.
2776 while ($line =~ /($Ident)\s+\(/g) {
2778 my $ctx_before = substr($line, 0, $-[1]);
2779 my $ctx = "$ctx_before$name";
2781 # Ignore those directives where spaces _are_ permitted.
2783 if|for|while|switch|return|case|
2784 volatile|__volatile__|
2785 __attribute__|format|__extension__|
2788 # cpp #define statements have non-optional spaces, ie
2789 # if there is a space between the name and the open
2790 # parenthesis it is simply not a parameter group.
2791 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
2793 # cpp #elif statement condition may start with a (
2794 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
2796 # If this whole things ends with a type its most
2797 # likely a typedef for a function.
2798 } elsif ($ctx =~ /$Type$/) {
2802 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
2804 $fixed[$linenr - 1] =~
2805 s/\b$name\s+\(/$name\(/;
2810 # Check operator spacing.
2811 if (!($line=~/\#\s*include/)) {
2812 my $fixed_line = "";
2816 <<=|>>=|<=|>=|==|!=|
2817 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
2818 =>|->|<<|>>|<|>|=|!|~|
2819 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
2822 my @elements = split(/($ops|;)/, $opline);
2824 ## print("element count: <" . $#elements . ">\n");
2825 ## foreach my $el (@elements) {
2826 ## print("el: <$el>\n");
2829 my @fix_elements = ();
2832 foreach my $el (@elements) {
2833 push(@fix_elements, substr($rawline, $off, length($el)));
2834 $off += length($el);
2839 my $blank = copy_spacing($opline);
2840 my $last_after = -1;
2842 for (my $n = 0; $n < $#elements; $n += 2) {
2844 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
2846 ## print("n: <$n> good: <$good>\n");
2848 $off += length($elements[$n]);
2850 # Pick up the preceding and succeeding characters.
2851 my $ca = substr($opline, 0, $off);
2853 if (length($opline) >= ($off + length($elements[$n + 1]))) {
2854 $cc = substr($opline, $off + length($elements[$n + 1]));
2856 my $cb = "$ca$;$cc";
2859 $a = 'V' if ($elements[$n] ne '');
2860 $a = 'W' if ($elements[$n] =~ /\s$/);
2861 $a = 'C' if ($elements[$n] =~ /$;$/);
2862 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
2863 $a = 'O' if ($elements[$n] eq '');
2864 $a = 'E' if ($ca =~ /^\s*$/);
2866 my $op = $elements[$n + 1];
2869 if (defined $elements[$n + 2]) {
2870 $c = 'V' if ($elements[$n + 2] ne '');
2871 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
2872 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
2873 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
2874 $c = 'O' if ($elements[$n + 2] eq '');
2875 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
2880 my $ctx = "${a}x${c}";
2882 my $at = "(ctx:$ctx)";
2884 my $ptr = substr($blank, 0, $off) . "^";
2885 my $hereptr = "$hereline$ptr\n";
2887 # Pull out the value of this operator.
2888 my $op_type = substr($curr_values, $off + 1, 1);
2890 # Get the full operator variant.
2891 my $opv = $op . substr($curr_vars, $off, 1);
2893 # Ignore operators passed as parameters.
2894 if ($op_type ne 'V' &&
2895 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
2898 # } elsif ($op =~ /^$;+$/) {
2900 # ; should have either the end of line or a space or \ after it
2901 } elsif ($op eq ';') {
2902 if ($ctx !~ /.x[WEBC]/ &&
2903 $cc !~ /^\\/ && $cc !~ /^;/) {
2904 if (ERROR("SPACING",
2905 "space required after that '$op' $at\n" . $hereptr)) {
2906 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
2912 } elsif ($op eq '//') {
2916 # : when part of a bitfield
2917 } elsif ($op eq '->' || $opv eq ':B') {
2918 if ($ctx =~ /Wx.|.xW/) {
2919 if (ERROR("SPACING",
2920 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
2921 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
2922 if (defined $fix_elements[$n + 2]) {
2923 $fix_elements[$n + 2] =~ s/^\s+//;
2929 # , must have a space on the right.
2930 } elsif ($op eq ',') {
2931 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
2932 if (ERROR("SPACING",
2933 "space required after that '$op' $at\n" . $hereptr)) {
2934 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
2940 # '*' as part of a type definition -- reported already.
2941 } elsif ($opv eq '*_') {
2942 #warn "'*' is part of type\n";
2944 # unary operators should have a space before and
2945 # none after. May be left adjacent to another
2946 # unary operator, or a cast
2947 } elsif ($op eq '!' || $op eq '~' ||
2948 $opv eq '*U' || $opv eq '-U' ||
2949 $opv eq '&U' || $opv eq '&&U') {
2950 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
2951 if (ERROR("SPACING",
2952 "space required before that '$op' $at\n" . $hereptr)) {
2953 if ($n != $last_after + 2) {
2954 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
2959 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
2960 # A unary '*' may be const
2962 } elsif ($ctx =~ /.xW/) {
2963 if (ERROR("SPACING",
2964 "space prohibited after that '$op' $at\n" . $hereptr)) {
2965 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
2966 if (defined $fix_elements[$n + 2]) {
2967 $fix_elements[$n + 2] =~ s/^\s+//;
2973 # unary ++ and unary -- are allowed no space on one side.
2974 } elsif ($op eq '++' or $op eq '--') {
2975 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
2976 if (ERROR("SPACING",
2977 "space required one side of that '$op' $at\n" . $hereptr)) {
2978 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
2982 if ($ctx =~ /Wx[BE]/ ||
2983 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
2984 if (ERROR("SPACING",
2985 "space prohibited before that '$op' $at\n" . $hereptr)) {
2986 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
2990 if ($ctx =~ /ExW/) {
2991 if (ERROR("SPACING",
2992 "space prohibited after that '$op' $at\n" . $hereptr)) {
2993 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
2994 if (defined $fix_elements[$n + 2]) {
2995 $fix_elements[$n + 2] =~ s/^\s+//;
3001 # << and >> may either have or not have spaces both sides
3002 } elsif ($op eq '<<' or $op eq '>>' or
3003 $op eq '&' or $op eq '^' or $op eq '|' or
3004 $op eq '+' or $op eq '-' or
3005 $op eq '*' or $op eq '/' or
3008 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
3009 if (ERROR("SPACING",
3010 "need consistent spacing around '$op' $at\n" . $hereptr)) {
3011 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3012 if (defined $fix_elements[$n + 2]) {
3013 $fix_elements[$n + 2] =~ s/^\s+//;
3019 # A colon needs no spaces before when it is
3020 # terminating a case value or a label.
3021 } elsif ($opv eq ':C' || $opv eq ':L') {
3022 if ($ctx =~ /Wx./) {
3023 if (ERROR("SPACING",
3024 "space prohibited before that '$op' $at\n" . $hereptr)) {
3025 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3030 # All the others need spaces both sides.
3031 } elsif ($ctx !~ /[EWC]x[CWE]/) {
3034 # Ignore email addresses <foo@bar>
3036 $cc =~ /^\S+\@\S+>/) ||
3038 $ca =~ /<\S+\@\S+$/))
3044 if (($opv eq ':O' && $ca =~ /\?$/) ||
3045 ($op eq '?' && $cc =~ /^:/)) {
3050 if (ERROR("SPACING",
3051 "spaces required around that '$op' $at\n" . $hereptr)) {
3052 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3053 if (defined $fix_elements[$n + 2]) {
3054 $fix_elements[$n + 2] =~ s/^\s+//;
3060 $off += length($elements[$n + 1]);
3062 ## print("n: <$n> GOOD: <$good>\n");
3064 $fixed_line = $fixed_line . $good;
3067 if (($#elements % 2) == 0) {
3068 $fixed_line = $fixed_line . $fix_elements[$#elements];
3071 if ($fix && $line_fixed && $fixed_line ne $fixed[$linenr - 1]) {
3072 $fixed[$linenr - 1] = $fixed_line;
3078 # check for whitespace before a non-naked semicolon
3079 if ($line =~ /^\+.*\S\s+;/) {
3081 "space prohibited before semicolon\n" . $herecurr) &&
3083 1 while $fixed[$linenr - 1] =~
3084 s/^(\+.*\S)\s+;/$1;/;
3088 # check for multiple assignments
3089 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
3090 CHK("MULTIPLE_ASSIGNMENTS",
3091 "multiple assignments should be avoided\n" . $herecurr);
3094 ## # check for multiple declarations, allowing for a function declaration
3096 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3097 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3099 ## # Remove any bracketed sections to ensure we do not
3100 ## # falsly report the parameters of functions.
3102 ## while ($ln =~ s/\([^\(\)]*\)//g) {
3104 ## if ($ln =~ /,/) {
3105 ## WARN("MULTIPLE_DECLARATION",
3106 ## "declaring multiple variables together should be avoided\n" . $herecurr);
3110 #need space before brace following if, while, etc
3111 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3113 if (ERROR("SPACING",
3114 "space required before the open brace '{'\n" . $herecurr) &&
3116 $fixed[$linenr - 1] =~ s/^(\+.*(?:do|\))){/$1 {/;
3120 ## # check for blank lines before declarations
3121 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3122 ## $prevrawline =~ /^.\s*$/) {
3124 ## "No blank lines before declarations\n" . $hereprev);
3128 # closing brace should have a space following it when it has anything
3130 if ($line =~ /}(?!(?:,|;|\)))\S/) {
3131 if (ERROR("SPACING",
3132 "space required after that close brace '}'\n" . $herecurr) &&
3134 $fixed[$linenr - 1] =~
3135 s/}((?!(?:,|;|\)))\S)/} $1/;
3139 # check spacing on square brackets
3140 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
3141 if (ERROR("SPACING",
3142 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3144 $fixed[$linenr - 1] =~
3148 if ($line =~ /\s\]/) {
3149 if (ERROR("SPACING",
3150 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3152 $fixed[$linenr - 1] =~
3157 # check spacing on parentheses
3158 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3159 $line !~ /for\s*\(\s+;/) {
3160 if (ERROR("SPACING",
3161 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3163 $fixed[$linenr - 1] =~
3167 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
3168 $line !~ /for\s*\(.*;\s+\)/ &&
3169 $line !~ /:\s+\)/) {
3170 if (ERROR("SPACING",
3171 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3173 $fixed[$linenr - 1] =~
3178 #goto labels aren't indented, allow a single space however
3179 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
3180 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
3181 if (WARN("INDENTED_LABEL",
3182 "labels should not be indented\n" . $herecurr) &&
3184 $fixed[$linenr - 1] =~
3189 # Return is not a function.
3190 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
3194 # Flatten any parentheses
3195 $value =~ s/\(/ \(/g;
3196 $value =~ s/\)/\) /g;
3197 while ($value =~ s/\[[^\[\]]*\]/1/ ||
3198 $value !~ /(?:$Ident|-?$Constant)\s*
3200 (?:$Ident|-?$Constant)/x &&
3201 $value =~ s/\([^\(\)]*\)/1/) {
3203 #print "value<$value>\n";
3204 if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
3205 ERROR("RETURN_PARENTHESES",
3206 "return is not a function, parentheses are not required\n" . $herecurr);
3208 } elsif ($spacing !~ /\s+/) {
3210 "space required before the open parenthesis '('\n" . $herecurr);
3213 # Return of what appears to be an errno should normally be -'ve
3214 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
3216 if ($name ne 'EOF' && $name ne 'ERROR') {
3217 WARN("USE_NEGATIVE_ERRNO",
3218 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
3222 # Need a space before open parenthesis after if, while etc
3223 if ($line =~ /\b(if|while|for|switch)\(/) {
3224 if (ERROR("SPACING",
3225 "space required before the open parenthesis '('\n" . $herecurr) &&
3227 $fixed[$linenr - 1] =~
3228 s/\b(if|while|for|switch)\(/$1 \(/;
3232 # Check for illegal assignment in if conditional -- and check for trailing
3233 # statements after the conditional.
3234 if ($line =~ /do\s*(?!{)/) {
3235 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3236 ctx_statement_block($linenr, $realcnt, 0)
3237 if (!defined $stat);
3238 my ($stat_next) = ctx_statement_block($line_nr_next,
3239 $remain_next, $off_next);
3240 $stat_next =~ s/\n./\n /g;
3241 ##print "stat<$stat> stat_next<$stat_next>\n";
3243 if ($stat_next =~ /^\s*while\b/) {
3244 # If the statement carries leading newlines,
3245 # then count those as offsets.
3247 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
3249 statement_rawlines($whitespace) - 1;
3251 $suppress_whiletrailers{$line_nr_next +
3255 if (!defined $suppress_whiletrailers{$linenr} &&
3256 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
3257 my ($s, $c) = ($stat, $cond);
3259 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
3260 ERROR("ASSIGN_IN_IF",
3261 "do not use assignment in if condition\n" . $herecurr);
3264 # Find out what is on the end of the line after the
3266 substr($s, 0, length($c), '');
3268 $s =~ s/$;//g; # Remove any comments
3269 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
3270 $c !~ /}\s*while\s*/)
3272 # Find out how long the conditional actually is.
3273 my @newlines = ($c =~ /\n/gs);
3274 my $cond_lines = 1 + $#newlines;
3277 $stat_real = raw_line($linenr, $cond_lines)
3278 . "\n" if ($cond_lines);
3279 if (defined($stat_real) && $cond_lines > 1) {
3280 $stat_real = "[...]\n$stat_real";
3283 ERROR("TRAILING_STATEMENTS",
3284 "trailing statements should be on next line\n" . $herecurr . $stat_real);
3288 # Check for bitwise tests written as boolean
3300 WARN("HEXADECIMAL_BOOLEAN_TEST",
3301 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
3304 # if and else should not have general statements after it
3305 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
3307 $s =~ s/$;//g; # Remove any comments
3308 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
3309 ERROR("TRAILING_STATEMENTS",
3310 "trailing statements should be on next line\n" . $herecurr);
3313 # if should not continue a brace
3314 if ($line =~ /}\s*if\b/) {
3315 ERROR("TRAILING_STATEMENTS",
3316 "trailing statements should be on next line\n" .
3319 # case and default should not have general statements after them
3320 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
3322 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
3326 ERROR("TRAILING_STATEMENTS",
3327 "trailing statements should be on next line\n" . $herecurr);
3330 # Check for }<nl>else {, these must be at the same
3331 # indent level to be relevant to each other.
3332 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
3333 $previndent == $indent) {
3334 ERROR("ELSE_AFTER_BRACE",
3335 "else should follow close brace '}'\n" . $hereprev);
3338 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
3339 $previndent == $indent) {
3340 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
3342 # Find out what is on the end of the line after the
3344 substr($s, 0, length($c), '');
3347 if ($s =~ /^\s*;/) {
3348 ERROR("WHILE_AFTER_BRACE",
3349 "while should follow close brace '}'\n" . $hereprev);
3353 #Specific variable tests
3354 while ($line =~ m{($Constant|$Lval)}g) {
3357 #gcc binary extension
3358 if ($var =~ /^$Binary$/) {
3359 if (WARN("GCC_BINARY_CONSTANT",
3360 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
3362 my $hexval = sprintf("0x%x", oct($var));
3363 $fixed[$linenr - 1] =~
3364 s/\b$var\b/$hexval/;
3369 if ($var !~ /^$Constant$/ &&
3370 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
3371 #Ignore Page<foo> variants
3372 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
3373 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
3374 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) {
3375 while ($var =~ m{($Ident)}g) {
3377 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
3378 seed_camelcase_includes() if ($check);
3379 if (!defined $camelcase{$word}) {
3380 $camelcase{$word} = 1;
3382 "Avoid CamelCase: <$word>\n" . $herecurr);
3388 #no spaces allowed after \ in define
3389 if ($line =~ /\#\s*define.*\\\s+$/) {
3390 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
3391 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
3393 $fixed[$linenr - 1] =~ s/\s+$//;
3397 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
3398 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
3400 my $checkfile = "include/linux/$file";
3401 if (-f "$root/$checkfile" &&
3402 $realfile ne $checkfile &&
3403 $1 !~ /$allowed_asm_includes/)
3405 if ($realfile =~ m{^arch/}) {
3406 CHK("ARCH_INCLUDE_LINUX",
3407 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
3409 WARN("INCLUDE_LINUX",
3410 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
3415 # multi-statement macros should be enclosed in a do while loop, grab the
3416 # first statement and ensure its the whole macro if its not enclosed
3417 # in a known good container
3418 if ($realfile !~ m@/vmlinux.lds.h$@ &&
3419 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
3422 my ($off, $dstat, $dcond, $rest);
3424 ($dstat, $dcond, $ln, $cnt, $off) =
3425 ctx_statement_block($linenr, $realcnt, 0);
3427 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
3428 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
3430 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
3432 $dstat =~ s/\\\n.//g;
3433 $dstat =~ s/^\s*//s;
3434 $dstat =~ s/\s*$//s;
3436 # Flatten any parentheses and braces
3437 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
3438 $dstat =~ s/\{[^\{\}]*\}/1/ ||
3439 $dstat =~ s/\[[^\[\]]*\]/1/)
3443 # Flatten any obvious string concatentation.
3444 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
3445 $dstat =~ s/$Ident\s*("X*")/$1/)
3449 my $exceptions = qr{
3461 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
3463 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
3464 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
3465 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
3466 $dstat !~ /^'X'$/ && # character constants
3467 $dstat !~ /$exceptions/ &&
3468 $dstat !~ /^\.$Ident\s*=/ && # .foo =
3469 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
3470 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
3471 $dstat !~ /^for\s*$Constant$/ && # for (...)
3472 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
3473 $dstat !~ /^do\s*{/ && # do {...
3474 $dstat !~ /^\({/ && # ({...
3475 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
3478 my $herectx = $here . "\n";
3479 my $cnt = statement_rawlines($ctx);
3481 for (my $n = 0; $n < $cnt; $n++) {
3482 $herectx .= raw_line($linenr, $n) . "\n";
3485 if ($dstat =~ /;/) {
3486 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
3487 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
3489 ERROR("COMPLEX_MACRO",
3490 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
3494 # check for line continuations outside of #defines, preprocessor #, and asm
3497 if ($prevline !~ /^..*\\$/ &&
3498 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
3499 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
3500 $line =~ /^\+.*\\$/) {
3501 WARN("LINE_CONTINUATIONS",
3502 "Avoid unnecessary line continuations\n" . $herecurr);
3506 # do {} while (0) macro tests:
3507 # single-statement macros do not need to be enclosed in do while (0) loop,
3508 # macro should not end with a semicolon
3509 if ($^V && $^V ge 5.10.0 &&
3510 $realfile !~ m@/vmlinux.lds.h$@ &&
3511 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
3514 my ($off, $dstat, $dcond, $rest);
3516 ($dstat, $dcond, $ln, $cnt, $off) =
3517 ctx_statement_block($linenr, $realcnt, 0);
3520 $dstat =~ s/\\\n.//g;
3522 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
3527 my $cnt = statement_rawlines($ctx);
3528 my $herectx = $here . "\n";
3530 for (my $n = 0; $n < $cnt; $n++) {
3531 $herectx .= raw_line($linenr, $n) . "\n";
3534 if (($stmts =~ tr/;/;/) == 1 &&
3535 $stmts !~ /^\s*(if|while|for|switch)\b/) {
3536 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
3537 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
3539 if (defined $semis && $semis ne "") {
3540 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
3541 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
3546 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3547 # all assignments may have only one of the following with an assignment:
3550 # VMLINUX_SYMBOL(...)
3551 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
3552 WARN("MISSING_VMLINUX_SYMBOL",
3553 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
3556 # check for redundant bracing round if etc
3557 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
3558 my ($level, $endln, @chunks) =
3559 ctx_statement_full($linenr, $realcnt, 1);
3560 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
3561 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3562 if ($#chunks > 0 && $level == 0) {
3566 my $herectx = $here . "\n";
3567 my $ln = $linenr - 1;
3568 for my $chunk (@chunks) {
3569 my ($cond, $block) = @{$chunk};
3571 # If the condition carries leading newlines, then count those as offsets.
3572 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
3573 my $offset = statement_rawlines($whitespace) - 1;
3575 $allowed[$allow] = 0;
3576 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3578 # We have looked at and allowed this specific line.
3579 $suppress_ifbraces{$ln + $offset} = 1;
3581 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
3582 $ln += statement_rawlines($block) - 1;
3584 substr($block, 0, length($cond), '');
3586 $seen++ if ($block =~ /^\s*{/);
3588 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
3589 if (statement_lines($cond) > 1) {
3590 #print "APW: ALLOWED: cond<$cond>\n";
3591 $allowed[$allow] = 1;
3593 if ($block =~/\b(?:if|for|while)\b/) {
3594 #print "APW: ALLOWED: block<$block>\n";
3595 $allowed[$allow] = 1;
3597 if (statement_block_size($block) > 1) {
3598 #print "APW: ALLOWED: lines block<$block>\n";
3599 $allowed[$allow] = 1;
3604 my $sum_allowed = 0;
3605 foreach (@allowed) {
3608 if ($sum_allowed == 0) {
3610 "braces {} are not necessary for any arm of this statement\n" . $herectx);
3611 } elsif ($sum_allowed != $allow &&
3614 "braces {} should be used on all arms of this statement\n" . $herectx);
3619 if (!defined $suppress_ifbraces{$linenr - 1} &&
3620 $line =~ /\b(if|while|for|else)\b/) {
3623 # Check the pre-context.
3624 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
3625 #print "APW: ALLOWED: pre<$1>\n";
3629 my ($level, $endln, @chunks) =
3630 ctx_statement_full($linenr, $realcnt, $-[0]);
3632 # Check the condition.
3633 my ($cond, $block) = @{$chunks[0]};
3634 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
3635 if (defined $cond) {
3636 substr($block, 0, length($cond), '');
3638 if (statement_lines($cond) > 1) {
3639 #print "APW: ALLOWED: cond<$cond>\n";
3642 if ($block =~/\b(?:if|for|while)\b/) {
3643 #print "APW: ALLOWED: block<$block>\n";
3646 if (statement_block_size($block) > 1) {
3647 #print "APW: ALLOWED: lines block<$block>\n";
3650 # Check the post-context.
3651 if (defined $chunks[1]) {
3652 my ($cond, $block) = @{$chunks[1]};
3653 if (defined $cond) {
3654 substr($block, 0, length($cond), '');
3656 if ($block =~ /^\s*\{/) {
3657 #print "APW: ALLOWED: chunk-1 block<$block>\n";
3661 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
3662 my $herectx = $here . "\n";
3663 my $cnt = statement_rawlines($block);
3665 for (my $n = 0; $n < $cnt; $n++) {
3666 $herectx .= raw_line($linenr, $n) . "\n";
3670 "braces {} are not necessary for single statement blocks\n" . $herectx);
3674 # check for unnecessary blank lines around braces
3675 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
3677 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
3679 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
3681 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
3684 # no volatiles please
3685 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
3686 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
3688 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
3692 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
3693 CHK("REDUNDANT_CODE",
3694 "if this code is redundant consider removing it\n" .
3698 # check for needless "if (<foo>) fn(<foo>)" uses
3699 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
3700 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
3701 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
3703 "$1(NULL) is safe this check is probably not required\n" . $hereprev);
3707 # prefer usleep_range over udelay
3708 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
3709 # ignore udelay's < 10, however
3712 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
3716 # warn about unexpectedly long msleep's
3717 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
3720 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
3724 # check for comparisons of jiffies
3725 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
3726 WARN("JIFFIES_COMPARISON",
3727 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
3730 # check for comparisons of get_jiffies_64()
3731 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
3732 WARN("JIFFIES_COMPARISON",
3733 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
3736 # warn about #ifdefs in C files
3737 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
3738 # print "#ifdef in C files should be avoided\n";
3739 # print "$herecurr";
3743 # warn about spacing in #ifdefs
3744 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
3745 if (ERROR("SPACING",
3746 "exactly one space required after that #$1\n" . $herecurr) &&
3748 $fixed[$linenr - 1] =~
3749 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
3754 # check for spinlock_t definitions without a comment.
3755 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
3756 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
3758 if (!ctx_has_comment($first_line, $linenr)) {
3759 CHK("UNCOMMENTED_DEFINITION",
3760 "$1 definition without comment\n" . $herecurr);
3763 # check for memory barriers without a comment.
3764 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
3765 if (!ctx_has_comment($first_line, $linenr)) {
3766 CHK("MEMORY_BARRIER",
3767 "memory barrier without comment\n" . $herecurr);
3770 # check of hardware specific defines
3771 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
3773 "architecture specific defines should be avoided\n" . $herecurr);
3776 # Check that the storage class is at the beginning of a declaration
3777 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
3778 WARN("STORAGE_CLASS",
3779 "storage class should be at the beginning of the declaration\n" . $herecurr)
3782 # check the location of the inline attribute, that it is between
3783 # storage class and type.
3784 if ($line =~ /\b$Type\s+$Inline\b/ ||
3785 $line =~ /\b$Inline\s+$Storage\b/) {
3786 ERROR("INLINE_LOCATION",
3787 "inline keyword should sit between storage class and type\n" . $herecurr);
3790 # Check for __inline__ and __inline, prefer inline
3791 if ($line =~ /\b(__inline__|__inline)\b/) {
3793 "plain inline is preferred over $1\n" . $herecurr) &&
3795 $fixed[$linenr - 1] =~ s/\b(__inline__|__inline)\b/inline/;
3800 # Check for __attribute__ packed, prefer __packed
3801 if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
3802 WARN("PREFER_PACKED",
3803 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
3806 # Check for __attribute__ aligned, prefer __aligned
3807 if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
3808 WARN("PREFER_ALIGNED",
3809 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
3812 # Check for __attribute__ format(printf, prefer __printf
3813 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
3814 if (WARN("PREFER_PRINTF",
3815 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
3817 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
3822 # Check for __attribute__ format(scanf, prefer __scanf
3823 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
3824 if (WARN("PREFER_SCANF",
3825 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
3827 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
3831 # check for sizeof(&)
3832 if ($line =~ /\bsizeof\s*\(\s*\&/) {
3833 WARN("SIZEOF_ADDRESS",
3834 "sizeof(& should be avoided\n" . $herecurr);
3837 # check for sizeof without parenthesis
3838 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
3839 if (WARN("SIZEOF_PARENTHESIS",
3840 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
3842 $fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
3846 # check for line continuations in quoted strings with odd counts of "
3847 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
3848 WARN("LINE_CONTINUATIONS",
3849 "Avoid line continuations in quoted strings\n" . $herecurr);
3852 # check for struct spinlock declarations
3853 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
3854 WARN("USE_SPINLOCK_T",
3855 "struct spinlock should be spinlock_t\n" . $herecurr);
3858 # check for seq_printf uses that could be seq_puts
3859 if ($line =~ /\bseq_printf\s*\(/) {
3860 my $fmt = get_quoted_string($line, $rawline);
3861 if ($fmt !~ /[^\\]\%/) {
3862 if (WARN("PREFER_SEQ_PUTS",
3863 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
3865 $fixed[$linenr - 1] =~ s/\bseq_printf\b/seq_puts/;
3870 # Check for misused memsets
3871 if ($^V && $^V ge 5.10.0 &&
3873 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
3879 if ($ms_size =~ /^(0x|)0$/i) {
3881 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
3882 } elsif ($ms_size =~ /^(0x|)1$/i) {
3884 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
3888 # typecasts on min/max could be min_t/max_t
3889 if ($^V && $^V ge 5.10.0 &&
3891 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
3892 if (defined $2 || defined $7) {
3894 my $cast1 = deparenthesize($2);
3896 my $cast2 = deparenthesize($7);
3900 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
3901 $cast = "$cast1 or $cast2";
3902 } elsif ($cast1 ne "") {
3908 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
3912 # check usleep_range arguments
3913 if ($^V && $^V ge 5.10.0 &&
3915 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
3919 WARN("USLEEP_RANGE",
3920 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
3921 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
3923 WARN("USLEEP_RANGE",
3924 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
3928 # check for new externs in .h files.
3929 if ($realfile =~ /\.h$/ &&
3930 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
3931 if (WARN("AVOID_EXTERNS",
3932 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
3934 $fixed[$linenr - 1] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
3938 # check for new externs in .c files.
3939 if ($realfile =~ /\.c$/ && defined $stat &&
3940 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
3942 my $function_name = $1;
3943 my $paren_space = $2;
3946 if (defined $cond) {
3947 substr($s, 0, length($cond), '');
3949 if ($s =~ /^\s*;/ &&
3950 $function_name ne 'uninitialized_var')
3952 WARN("AVOID_EXTERNS",
3953 "externs should be avoided in .c files\n" . $herecurr);
3956 if ($paren_space =~ /\n/) {
3957 WARN("FUNCTION_ARGUMENTS",
3958 "arguments for function declarations should follow identifier\n" . $herecurr);
3961 } elsif ($realfile =~ /\.c$/ && defined $stat &&
3962 $stat =~ /^.\s*extern\s+/)
3964 WARN("AVOID_EXTERNS",
3965 "externs should be avoided in .c files\n" . $herecurr);
3968 # checks for new __setup's
3969 if ($rawline =~ /\b__setup\("([^"]*)"/) {
3972 if (!grep(/$name/, @setup_docs)) {
3973 CHK("UNDOCUMENTED_SETUP",
3974 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
3978 # check for pointless casting of kmalloc return
3979 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
3980 WARN("UNNECESSARY_CASTS",
3981 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
3985 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
3986 if ($^V && $^V ge 5.10.0 &&
3987 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
3988 CHK("ALLOC_SIZEOF_STRUCT",
3989 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
3992 # check for krealloc arg reuse
3993 if ($^V && $^V ge 5.10.0 &&
3994 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
3995 WARN("KREALLOC_ARG_REUSE",
3996 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
3999 # check for alloc argument mismatch
4000 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
4001 WARN("ALLOC_ARRAY_ARGS",
4002 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
4005 # check for multiple semicolons
4006 if ($line =~ /;\s*;\s*$/) {
4007 if (WARN("ONE_SEMICOLON",
4008 "Statements terminations use 1 semicolon\n" . $herecurr) &&
4010 $fixed[$linenr - 1] =~ s/(\s*;\s*){2,}$/;/g;
4014 # check for switch/default statements without a break;
4015 if ($^V && $^V ge 5.10.0 &&
4017 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
4019 my $herectx = $here . "\n";
4020 my $cnt = statement_rawlines($stat);
4021 for (my $n = 0; $n < $cnt; $n++) {
4022 $herectx .= raw_line($linenr, $n) . "\n";
4024 WARN("DEFAULT_NO_BREAK",
4025 "switch default: should use break\n" . $herectx);
4028 # check for gcc specific __FUNCTION__
4029 if ($line =~ /\b__FUNCTION__\b/) {
4030 if (WARN("USE_FUNC",
4031 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
4033 $fixed[$linenr - 1] =~ s/\b__FUNCTION__\b/__func__/g;
4037 # check for use of yield()
4038 if ($line =~ /\byield\s*\(\s*\)/) {
4040 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
4043 # check for comparisons against true and false
4044 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
4052 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
4054 my $type = lc($otype);
4055 if ($type =~ /^(?:true|false)$/) {
4056 if (("$test" eq "==" && "$type" eq "true") ||
4057 ("$test" eq "!=" && "$type" eq "false")) {
4061 CHK("BOOL_COMPARISON",
4062 "Using comparison to $otype is error prone\n" . $herecurr);
4064 ## maybe suggesting a correct construct would better
4065 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
4070 # check for semaphores initialized locked
4071 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
4072 WARN("CONSIDER_COMPLETION",
4073 "consider using a completion\n" . $herecurr);
4076 # recommend kstrto* over simple_strto* and strict_strto*
4077 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
4078 WARN("CONSIDER_KSTRTO",
4079 "$1 is obsolete, use k$3 instead\n" . $herecurr);
4082 # check for __initcall(), use device_initcall() explicitly please
4083 if ($line =~ /^.\s*__initcall\s*\(/) {
4084 WARN("USE_DEVICE_INITCALL",
4085 "please use device_initcall() instead of __initcall()\n" . $herecurr);
4088 # check for various ops structs, ensure they are const.
4089 my $struct_ops = qr{acpi_dock_ops|
4090 address_space_operations|
4092 block_device_operations|
4097 file_lock_operations|
4107 lock_manager_operations|
4113 pipe_buf_operations|
4114 platform_hibernation_ops|
4115 platform_suspend_ops|
4120 soc_pcmcia_socket_ops|
4126 if ($line !~ /\bconst\b/ &&
4127 $line =~ /\bstruct\s+($struct_ops)\b/) {
4128 WARN("CONST_STRUCT",
4129 "struct $1 should normally be const\n" .
4133 # use of NR_CPUS is usually wrong
4134 # ignore definitions of NR_CPUS and usage to define arrays as likely right
4135 if ($line =~ /\bNR_CPUS\b/ &&
4136 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
4137 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
4138 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
4139 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
4140 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
4143 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
4146 # check for %L{u,d,i} in strings
4148 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4149 $string = substr($rawline, $-[1], $+[1] - $-[1]);
4150 $string =~ s/%%/__/g;
4151 if ($string =~ /(?<!%)%L[udi]/) {
4153 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
4158 # whine mightly about in_atomic
4159 if ($line =~ /\bin_atomic\s*\(/) {
4160 if ($realfile =~ m@^drivers/@) {
4162 "do not use in_atomic in drivers\n" . $herecurr);
4163 } elsif ($realfile !~ m@^kernel/@) {
4165 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
4169 # check for lockdep_set_novalidate_class
4170 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
4171 $line =~ /__lockdep_no_validate__\s*\)/ ) {
4172 if ($realfile !~ m@^kernel/lockdep@ &&
4173 $realfile !~ m@^include/linux/lockdep@ &&
4174 $realfile !~ m@^drivers/base/core@) {
4176 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
4180 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
4181 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
4182 WARN("EXPORTED_WORLD_WRITABLE",
4183 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
4187 # If we have no input at all, then there is nothing to report on
4188 # so just keep quiet.
4189 if ($#rawlines == -1) {
4193 # In mailback mode only produce a report in the negative, for
4194 # things that appear to be patches.
4195 if ($mailback && ($clean == 1 || !$is_patch)) {
4199 # This is not a patch, and we are are in 'no-patch' mode so
4201 if (!$chk_patch && !$is_patch) {
4206 ERROR("NOT_UNIFIED_DIFF",
4207 "Does not appear to be a unified-diff format patch\n");
4209 if ($is_patch && $chk_signoff && $signoff == 0) {
4210 ERROR("MISSING_SIGN_OFF",
4211 "Missing Signed-off-by: line(s)\n");
4214 print report_dump();
4215 if ($summary && !($clean == 1 && $quiet == 1)) {
4216 print "$filename " if ($summary_file);
4217 print "total: $cnt_error errors, $cnt_warn warnings, " .
4218 (($check)? "$cnt_chk checks, " : "") .
4219 "$cnt_lines lines checked\n";
4220 print "\n" if ($quiet == 0);
4225 if ($^V lt 5.10.0) {
4226 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
4227 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
4230 # If there were whitespace errors which cleanpatch can fix
4231 # then suggest that.
4232 if ($rpt_cleaners) {
4233 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
4234 print " scripts/cleanfile\n\n";
4239 hash_show_words(\%use_type, "Used");
4240 hash_show_words(\%ignore_type, "Ignored");
4242 if ($clean == 0 && $fix && "@rawlines" ne "@fixed") {
4243 my $newfile = $filename . ".EXPERIMENTAL-checkpatch-fixes";
4247 open($f, '>', $newfile)
4248 or die "$P: Can't open $newfile for write\n";
4249 foreach my $fixed_line (@fixed) {
4252 if ($linecount > 3) {
4253 $fixed_line =~ s/^\+//;
4254 print $f $fixed_line. "\n";
4257 print $f $fixed_line . "\n";
4264 Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
4266 Do _NOT_ trust the results written to this file.
4267 Do _NOT_ submit these changes without inspecting them for correctness.
4269 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
4270 No warranties, expressed or implied...
4276 if ($clean == 1 && $quiet == 0) {
4277 print "$vname has no obvious style problems and is ready for submission.\n"
4279 if ($clean == 0 && $quiet == 0) {
4281 $vname has style problems, please review.
4283 If any of these errors are false positives, please report
4284 them to the maintainer, see CHECKPATCH in MAINTAINERS.