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);
38 my $configuration_file = ".checkpatch.conf";
39 my $max_line_length = 80;
40 my $ignore_perl_version = 0;
41 my $minimum_perl_version = 5.10.0;
47 Usage: $P [OPTION]... [FILE]...
52 --no-tree run without a kernel tree
53 --no-signoff do not check for 'Signed-off-by' line
54 --patch treat FILE as patchfile (default)
55 --emacs emacs compile window format
56 --terse one line per report
57 -f, --file treat FILE as regular source file
58 --subjective, --strict enable more subjective tests
59 --ignore TYPE(,TYPE2...) ignore various comma separated message types
60 --max-line-length=n set the maximum line length, if exceeded, warn
61 --show-types show the message "types" in the output
62 --root=PATH PATH to the kernel tree root
63 --no-summary suppress the per-file summary
64 --mailback only produce a report in case of warnings/errors
65 --summary-file include the filename in summary
66 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
67 'values', 'possible', 'type', and 'attr' (default
69 --test-only=WORD report only warnings/errors containing WORD
71 --fix EXPERIMENTAL - may create horrible results
72 If correctable single-line errors exist, create
73 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
74 with potential errors corrected to the preferred
76 --ignore-perl-version override checking of perl version. expect
78 -h, --help, --version display this help and exit
80 When FILE is - read standard input.
86 my $conf = which_conf($configuration_file);
89 open(my $conffile, '<', "$conf")
90 or warn "$P: Can't find a readable $configuration_file file $!\n";
95 $line =~ s/\s*\n?$//g;
99 next if ($line =~ m/^\s*#/);
100 next if ($line =~ m/^\s*$/);
102 my @words = split(" ", $line);
103 foreach my $word (@words) {
104 last if ($word =~ m/^#/);
105 push (@conf_args, $word);
109 unshift(@ARGV, @conf_args) if @conf_args;
113 'q|quiet+' => \$quiet,
115 'signoff!' => \$chk_signoff,
116 'patch!' => \$chk_patch,
120 'subjective!' => \$check,
121 'strict!' => \$check,
122 'ignore=s' => \@ignore,
123 'show-types!' => \$show_types,
124 'max-line-length=i' => \$max_line_length,
126 'summary!' => \$summary,
127 'mailback!' => \$mailback,
128 'summary-file!' => \$summary_file,
130 'ignore-perl-version!' => \$ignore_perl_version,
131 'debug=s' => \%debug,
132 'test-only=s' => \$tst_only,
141 if ($^V && $^V lt $minimum_perl_version) {
142 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
143 if (!$ignore_perl_version) {
149 print "$P: no input files\n";
153 @ignore = split(/,/, join(',',@ignore));
154 foreach my $word (@ignore) {
155 $word =~ s/\s*\n?$//g;
158 $word =~ tr/[a-z]/[A-Z]/;
160 next if ($word =~ m/^\s*#/);
161 next if ($word =~ m/^\s*$/);
163 $ignore_type{$word}++;
167 my $dbg_possible = 0;
170 for my $key (keys %debug) {
172 eval "\${dbg_$key} = '$debug{$key}';";
176 my $rpt_cleaners = 0;
185 if (!top_of_kernel_tree($root)) {
186 die "$P: $root: --root does not point at a valid tree\n";
189 if (top_of_kernel_tree('.')) {
191 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
192 top_of_kernel_tree($1)) {
197 if (!defined $root) {
198 print "Must be run from the top-level dir. of a kernel tree\n";
203 my $emitted_corrupt = 0;
206 [A-Za-z_][A-Za-z\d_]*
207 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
209 our $Storage = qr{extern|static|asmlinkage};
222 # Notes to $Attribute:
223 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
242 __(?:mem|cpu|dev|)(?:initdata|initconst|init\b)|
243 ____cacheline_aligned|
244 ____cacheline_aligned_in_smp|
245 ____cacheline_internodealigned_in_smp|
249 our $Inline = qr{inline|__always_inline|noinline};
250 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
251 our $Lval = qr{$Ident(?:$Member)*};
253 our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
254 our $Binary = qr{(?i)0b[01]+$Int_type?};
255 our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
256 our $Int = qr{[0-9]+$Int_type?};
257 our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
258 our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
259 our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
260 our $Float = qr{$Float_hex|$Float_dec|$Float_int};
261 our $Constant = qr{$Float|$Binary|$Hex|$Int};
262 our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
263 our $Compare = qr{<=|>=|==|!=|<|>};
264 our $Arithmetic = qr{\+|-|\*|\/|%};
268 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
275 our $NON_ASCII_UTF8 = qr{
276 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
277 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
278 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
279 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
280 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
281 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
282 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
286 [\x09\x0A\x0D\x20-\x7E] # ASCII
290 our $typeTypedefs = qr{(?x:
291 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
295 our $logFunctions = qr{(?x:
296 printk(?:_ratelimited|_once|)|
297 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
298 WARN(?:_RATELIMIT|_ONCE|)|
303 our $signature_tags = qr{(?xi:
316 qr{(?:unsigned\s+)?char},
317 qr{(?:unsigned\s+)?short},
318 qr{(?:unsigned\s+)?int},
319 qr{(?:unsigned\s+)?long},
320 qr{(?:unsigned\s+)?long\s+int},
321 qr{(?:unsigned\s+)?long\s+long},
322 qr{(?:unsigned\s+)?long\s+long\s+int},
331 qr{${Ident}_handler},
332 qr{${Ident}_handler_fn},
334 our @modifierList = (
338 our $allowed_asm_includes = qr{(?x:
342 # memory.h: ARM has a custom one
345 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
346 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
347 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
349 (?:$Modifier\s+|const\s+)*
351 (?:typeof|__typeof__)\s*\([^\)]*\)|
355 (?:\s+$Modifier|\s+const)*
359 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*|\[\])+|(?:\s*\[\s*\])+)?
360 (?:\s+$Inline|\s+$Modifier)*
362 $Declare = qr{(?:$Storage\s+)?$Type};
366 our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
368 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
369 # requires at least perl version v5.10.0
370 # Any use must be runtime checked with $^V
372 our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
373 our $LvalOrFunc = qr{($Lval)\s*($balanced_parens{0,1})\s*};
374 our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
378 return "" if (!defined($string));
379 $string =~ s@^\s*\(\s*@@g;
380 $string =~ s@\s*\)\s*$@@g;
381 $string =~ s@\s+@ @g;
385 sub seed_camelcase_file {
388 return if (!(-f $file));
392 open(my $include_file, '<', "$file")
393 or warn "$P: Can't read '$file' $!\n";
394 my $text = <$include_file>;
395 close($include_file);
397 my @lines = split('\n', $text);
399 foreach my $line (@lines) {
400 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
401 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
404 elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*\(/) {
410 my $camelcase_seeded = 0;
411 sub seed_camelcase_includes {
412 return if ($camelcase_seeded);
415 my $camelcase_cache = "";
416 my @include_files = ();
418 $camelcase_seeded = 1;
421 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
422 chomp $git_last_include_commit;
423 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
425 my $last_mod_date = 0;
426 $files = `find $root/include -name "*.h"`;
427 @include_files = split('\n', $files);
428 foreach my $file (@include_files) {
429 my $date = POSIX::strftime("%Y%m%d%H%M",
430 localtime((stat $file)[9]));
431 $last_mod_date = $date if ($last_mod_date < $date);
433 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
436 if ($camelcase_cache ne "" && -f $camelcase_cache) {
437 open(my $camelcase_file, '<', "$camelcase_cache")
438 or warn "$P: Can't read '$camelcase_cache' $!\n";
439 while (<$camelcase_file>) {
443 close($camelcase_file);
449 $files = `git ls-files "include/*.h"`;
450 @include_files = split('\n', $files);
453 foreach my $file (@include_files) {
454 seed_camelcase_file($file);
457 if ($camelcase_cache ne "") {
458 unlink glob ".checkpatch-camelcase.*";
459 open(my $camelcase_file, '>', "$camelcase_cache")
460 or warn "$P: Can't write '$camelcase_cache' $!\n";
461 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
462 print $camelcase_file ("$_\n");
464 close($camelcase_file);
468 $chk_signoff = 0 if ($file);
474 for my $filename (@ARGV) {
477 open($FILE, '-|', "diff -u /dev/null $filename") ||
478 die "$P: $filename: diff failed - $!\n";
479 } elsif ($filename eq '-') {
480 open($FILE, '<&STDIN');
482 open($FILE, '<', "$filename") ||
483 die "$P: $filename: open failed - $!\n";
485 if ($filename eq '-') {
486 $vname = 'Your patch';
495 if (!process($filename)) {
505 sub top_of_kernel_tree {
509 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
510 "README", "Documentation", "arch", "include", "drivers",
511 "fs", "init", "ipc", "kernel", "lib", "scripts",
514 foreach my $check (@tree_check) {
515 if (! -e $root . '/' . $check) {
523 my ($formatted_email) = @_;
529 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
532 $comment = $3 if defined $3;
533 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
535 $comment = $2 if defined $2;
536 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
538 $comment = $2 if defined $2;
539 $formatted_email =~ s/$address.*$//;
540 $name = $formatted_email;
542 $name =~ s/^\"|\"$//g;
543 # If there's a name left after stripping spaces and
544 # leading quotes, and the address doesn't have both
545 # leading and trailing angle brackets, the address
547 # "joe smith joe@smith.com" bad
548 # "joe smith <joe@smith.com" bad
549 if ($name ne "" && $address !~ /^<[^>]+>$/) {
557 $name =~ s/^\"|\"$//g;
558 $address = trim($address);
559 $address =~ s/^\<|\>$//g;
561 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
562 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
566 return ($name, $address, $comment);
570 my ($name, $address) = @_;
575 $name =~ s/^\"|\"$//g;
576 $address = trim($address);
578 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
579 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
584 $formatted_email = "$address";
586 $formatted_email = "$name <$address>";
589 return $formatted_email;
595 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
596 if (-e "$path/$conf") {
597 return "$path/$conf";
609 for my $c (split(//, $str)) {
613 for (; ($n % 8) != 0; $n++) {
625 (my $res = shift) =~ tr/\t/ /c;
632 # Drop the diff line leader and expand tabs
634 $line = expand_tabs($line);
636 # Pick the indent from the front of the line.
637 my ($white) = ($line =~ /^(\s*)/);
639 return (length($line), length($white));
642 my $sanitise_quote = '';
644 sub sanitise_line_reset {
645 my ($in_comment) = @_;
648 $sanitise_quote = '*/';
650 $sanitise_quote = '';
663 # Always copy over the diff marker.
664 $res = substr($line, 0, 1);
666 for ($off = 1; $off < length($line); $off++) {
667 $c = substr($line, $off, 1);
669 # Comments we are wacking completly including the begin
670 # and end, all to $;.
671 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
672 $sanitise_quote = '*/';
674 substr($res, $off, 2, "$;$;");
678 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
679 $sanitise_quote = '';
680 substr($res, $off, 2, "$;$;");
684 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
685 $sanitise_quote = '//';
687 substr($res, $off, 2, $sanitise_quote);
692 # A \ in a string means ignore the next character.
693 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
695 substr($res, $off, 2, 'XX');
700 if ($c eq "'" || $c eq '"') {
701 if ($sanitise_quote eq '') {
702 $sanitise_quote = $c;
704 substr($res, $off, 1, $c);
706 } elsif ($sanitise_quote eq $c) {
707 $sanitise_quote = '';
711 #print "c<$c> SQ<$sanitise_quote>\n";
712 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
713 substr($res, $off, 1, $;);
714 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
715 substr($res, $off, 1, $;);
716 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
717 substr($res, $off, 1, 'X');
719 substr($res, $off, 1, $c);
723 if ($sanitise_quote eq '//') {
724 $sanitise_quote = '';
727 # The pathname on a #include may be surrounded by '<' and '>'.
728 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
729 my $clean = 'X' x length($1);
730 $res =~ s@\<.*\>@<$clean>@;
732 # The whole of a #error is a string.
733 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
734 my $clean = 'X' x length($1);
735 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
741 sub get_quoted_string {
742 my ($line, $rawline) = @_;
744 return "" if ($line !~ m/(\"[X]+\")/g);
745 return substr($rawline, $-[0], $+[0] - $-[0]);
748 sub ctx_statement_block {
749 my ($linenr, $remain, $off) = @_;
750 my $line = $linenr - 1;
767 @stack = (['', 0]) if ($#stack == -1);
769 #warn "CSB: blk<$blk> remain<$remain>\n";
770 # If we are about to drop off the end, pull in more
773 for (; $remain > 0; $line++) {
774 last if (!defined $lines[$line]);
775 next if ($lines[$line] =~ /^-/);
778 $blk .= $lines[$line] . "\n";
783 # Bail if there is no further context.
784 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
788 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
794 $c = substr($blk, $off, 1);
795 $remainder = substr($blk, $off);
797 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
799 # Handle nested #if/#else.
800 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
801 push(@stack, [ $type, $level ]);
802 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
803 ($type, $level) = @{$stack[$#stack - 1]};
804 } elsif ($remainder =~ /^#\s*endif\b/) {
805 ($type, $level) = @{pop(@stack)};
808 # Statement ends at the ';' or a close '}' at the
810 if ($level == 0 && $c eq ';') {
814 # An else is really a conditional as long as its not else if
815 if ($level == 0 && $coff_set == 0 &&
816 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
817 $remainder =~ /^(else)(?:\s|{)/ &&
818 $remainder !~ /^else\s+if\b/) {
819 $coff = $off + length($1) - 1;
821 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
822 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
825 if (($type eq '' || $type eq '(') && $c eq '(') {
829 if ($type eq '(' && $c eq ')') {
831 $type = ($level != 0)? '(' : '';
833 if ($level == 0 && $coff < $soff) {
836 #warn "CSB: mark coff<$coff>\n";
839 if (($type eq '' || $type eq '{') && $c eq '{') {
843 if ($type eq '{' && $c eq '}') {
845 $type = ($level != 0)? '{' : '';
848 if (substr($blk, $off + 1, 1) eq ';') {
854 # Preprocessor commands end at the newline unless escaped.
855 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
863 # We are truly at the end, so shuffle to the next line.
870 my $statement = substr($blk, $soff, $off - $soff + 1);
871 my $condition = substr($blk, $soff, $coff - $soff + 1);
873 #warn "STATEMENT<$statement>\n";
874 #warn "CONDITION<$condition>\n";
876 #print "coff<$coff> soff<$off> loff<$loff>\n";
878 return ($statement, $condition,
879 $line, $remain + 1, $off - $loff + 1, $level);
882 sub statement_lines {
885 # Strip the diff line prefixes and rip blank lines at start and end.
886 $stmt =~ s/(^|\n)./$1/g;
890 my @stmt_lines = ($stmt =~ /\n/g);
892 return $#stmt_lines + 2;
895 sub statement_rawlines {
898 my @stmt_lines = ($stmt =~ /\n/g);
900 return $#stmt_lines + 2;
903 sub statement_block_size {
906 $stmt =~ s/(^|\n)./$1/g;
912 my @stmt_lines = ($stmt =~ /\n/g);
913 my @stmt_statements = ($stmt =~ /;/g);
915 my $stmt_lines = $#stmt_lines + 2;
916 my $stmt_statements = $#stmt_statements + 1;
918 if ($stmt_lines > $stmt_statements) {
921 return $stmt_statements;
925 sub ctx_statement_full {
926 my ($linenr, $remain, $off) = @_;
927 my ($statement, $condition, $level);
931 # Grab the first conditional/block pair.
932 ($statement, $condition, $linenr, $remain, $off, $level) =
933 ctx_statement_block($linenr, $remain, $off);
934 #print "F: c<$condition> s<$statement> remain<$remain>\n";
935 push(@chunks, [ $condition, $statement ]);
936 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
937 return ($level, $linenr, @chunks);
940 # Pull in the following conditional/block pairs and see if they
941 # could continue the statement.
943 ($statement, $condition, $linenr, $remain, $off, $level) =
944 ctx_statement_block($linenr, $remain, $off);
945 #print "C: c<$condition> s<$statement> remain<$remain>\n";
946 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
948 push(@chunks, [ $condition, $statement ]);
951 return ($level, $linenr, @chunks);
955 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
957 my $start = $linenr - 1;
964 my @stack = ($level);
965 for ($line = $start; $remain > 0; $line++) {
966 next if ($rawlines[$line] =~ /^-/);
969 $blk .= $rawlines[$line];
971 # Handle nested #if/#else.
972 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
973 push(@stack, $level);
974 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
975 $level = $stack[$#stack - 1];
976 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
977 $level = pop(@stack);
980 foreach my $c (split(//, $lines[$line])) {
981 ##print "C<$c>L<$level><$open$close>O<$off>\n";
987 if ($c eq $close && $level > 0) {
989 last if ($level == 0);
990 } elsif ($c eq $open) {
995 if (!$outer || $level <= 1) {
996 push(@res, $rawlines[$line]);
999 last if ($level == 0);
1002 return ($level, @res);
1004 sub ctx_block_outer {
1005 my ($linenr, $remain) = @_;
1007 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1011 my ($linenr, $remain) = @_;
1013 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1017 my ($linenr, $remain, $off) = @_;
1019 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1022 sub ctx_block_level {
1023 my ($linenr, $remain) = @_;
1025 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1027 sub ctx_statement_level {
1028 my ($linenr, $remain, $off) = @_;
1030 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1033 sub ctx_locate_comment {
1034 my ($first_line, $end_line) = @_;
1036 # Catch a comment on the end of the line itself.
1037 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1038 return $current_comment if (defined $current_comment);
1040 # Look through the context and try and figure out if there is a
1043 $current_comment = '';
1044 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1045 my $line = $rawlines[$linenr - 1];
1047 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1050 if ($line =~ m@/\*@) {
1053 if (!$in_comment && $current_comment ne '') {
1054 $current_comment = '';
1056 $current_comment .= $line . "\n" if ($in_comment);
1057 if ($line =~ m@\*/@) {
1062 chomp($current_comment);
1063 return($current_comment);
1065 sub ctx_has_comment {
1066 my ($first_line, $end_line) = @_;
1067 my $cmt = ctx_locate_comment($first_line, $end_line);
1069 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1070 ##print "CMMT: $cmt\n";
1072 return ($cmt ne '');
1076 my ($linenr, $cnt) = @_;
1078 my $offset = $linenr - 1;
1083 $line = $rawlines[$offset++];
1084 next if (defined($line) && $line =~ /^-/);
1096 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1099 $coded = sprintf("^%c", unpack('C', $2) + 64);
1108 my $av_preprocessor = 0;
1113 sub annotate_reset {
1114 $av_preprocessor = 0;
1116 @av_paren_type = ('E');
1117 $av_pend_colon = 'O';
1120 sub annotate_values {
1121 my ($stream, $type) = @_;
1124 my $var = '_' x length($stream);
1127 print "$stream\n" if ($dbg_values > 1);
1129 while (length($cur)) {
1130 @av_paren_type = ('E') if ($#av_paren_type < 0);
1131 print " <" . join('', @av_paren_type) .
1132 "> <$type> <$av_pending>" if ($dbg_values > 1);
1133 if ($cur =~ /^(\s+)/o) {
1134 print "WS($1)\n" if ($dbg_values > 1);
1135 if ($1 =~ /\n/ && $av_preprocessor) {
1136 $type = pop(@av_paren_type);
1137 $av_preprocessor = 0;
1140 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1141 print "CAST($1)\n" if ($dbg_values > 1);
1142 push(@av_paren_type, $type);
1145 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1146 print "DECLARE($1)\n" if ($dbg_values > 1);
1149 } elsif ($cur =~ /^($Modifier)\s*/) {
1150 print "MODIFIER($1)\n" if ($dbg_values > 1);
1153 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1154 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1155 $av_preprocessor = 1;
1156 push(@av_paren_type, $type);
1162 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1163 print "UNDEF($1)\n" if ($dbg_values > 1);
1164 $av_preprocessor = 1;
1165 push(@av_paren_type, $type);
1167 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1168 print "PRE_START($1)\n" if ($dbg_values > 1);
1169 $av_preprocessor = 1;
1171 push(@av_paren_type, $type);
1172 push(@av_paren_type, $type);
1175 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1176 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1177 $av_preprocessor = 1;
1179 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1183 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1184 print "PRE_END($1)\n" if ($dbg_values > 1);
1186 $av_preprocessor = 1;
1188 # Assume all arms of the conditional end as this
1189 # one does, and continue as if the #endif was not here.
1190 pop(@av_paren_type);
1191 push(@av_paren_type, $type);
1194 } elsif ($cur =~ /^(\\\n)/o) {
1195 print "PRECONT($1)\n" if ($dbg_values > 1);
1197 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1198 print "ATTR($1)\n" if ($dbg_values > 1);
1199 $av_pending = $type;
1202 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1203 print "SIZEOF($1)\n" if ($dbg_values > 1);
1209 } elsif ($cur =~ /^(if|while|for)\b/o) {
1210 print "COND($1)\n" if ($dbg_values > 1);
1214 } elsif ($cur =~/^(case)/o) {
1215 print "CASE($1)\n" if ($dbg_values > 1);
1216 $av_pend_colon = 'C';
1219 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1220 print "KEYWORD($1)\n" if ($dbg_values > 1);
1223 } elsif ($cur =~ /^(\()/o) {
1224 print "PAREN('$1')\n" if ($dbg_values > 1);
1225 push(@av_paren_type, $av_pending);
1229 } elsif ($cur =~ /^(\))/o) {
1230 my $new_type = pop(@av_paren_type);
1231 if ($new_type ne '_') {
1233 print "PAREN('$1') -> $type\n"
1234 if ($dbg_values > 1);
1236 print "PAREN('$1')\n" if ($dbg_values > 1);
1239 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1240 print "FUNC($1)\n" if ($dbg_values > 1);
1244 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1245 if (defined $2 && $type eq 'C' || $type eq 'T') {
1246 $av_pend_colon = 'B';
1247 } elsif ($type eq 'E') {
1248 $av_pend_colon = 'L';
1250 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1253 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1254 print "IDENT($1)\n" if ($dbg_values > 1);
1257 } elsif ($cur =~ /^($Assignment)/o) {
1258 print "ASSIGN($1)\n" if ($dbg_values > 1);
1261 } elsif ($cur =~/^(;|{|})/) {
1262 print "END($1)\n" if ($dbg_values > 1);
1264 $av_pend_colon = 'O';
1266 } elsif ($cur =~/^(,)/) {
1267 print "COMMA($1)\n" if ($dbg_values > 1);
1270 } elsif ($cur =~ /^(\?)/o) {
1271 print "QUESTION($1)\n" if ($dbg_values > 1);
1274 } elsif ($cur =~ /^(:)/o) {
1275 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1277 substr($var, length($res), 1, $av_pend_colon);
1278 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1283 $av_pend_colon = 'O';
1285 } elsif ($cur =~ /^(\[)/o) {
1286 print "CLOSE($1)\n" if ($dbg_values > 1);
1289 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1292 print "OPV($1)\n" if ($dbg_values > 1);
1299 substr($var, length($res), 1, $variant);
1302 } elsif ($cur =~ /^($Operators)/o) {
1303 print "OP($1)\n" if ($dbg_values > 1);
1304 if ($1 ne '++' && $1 ne '--') {
1308 } elsif ($cur =~ /(^.)/o) {
1309 print "C($1)\n" if ($dbg_values > 1);
1312 $cur = substr($cur, length($1));
1313 $res .= $type x length($1);
1317 return ($res, $var);
1321 my ($possible, $line) = @_;
1322 my $notPermitted = qr{(?:
1339 ^(?:typedef|struct|enum)\b
1341 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1342 if ($possible !~ $notPermitted) {
1343 # Check for modifiers.
1344 $possible =~ s/\s*$Storage\s*//g;
1345 $possible =~ s/\s*$Sparse\s*//g;
1346 if ($possible =~ /^\s*$/) {
1348 } elsif ($possible =~ /\s/) {
1349 $possible =~ s/\s*$Type\s*//g;
1350 for my $modifier (split(' ', $possible)) {
1351 if ($modifier !~ $notPermitted) {
1352 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1353 push(@modifierList, $modifier);
1358 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1359 push(@typeList, $possible);
1363 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1370 return !defined $ignore_type{$_[0]};
1374 if (!show_type($_[1]) ||
1375 (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) {
1380 $line = "$prefix$_[0]:$_[1]: $_[2]\n";
1382 $line = "$prefix$_[0]: $_[2]\n";
1384 $line = (split('\n', $line))[0] . "\n" if ($terse);
1386 push(our @report, $line);
1395 if (report("ERROR", $_[0], $_[1])) {
1403 if (report("WARNING", $_[0], $_[1])) {
1411 if ($check && report("CHECK", $_[0], $_[1])) {
1419 sub check_absolute_file {
1420 my ($absolute, $herecurr) = @_;
1421 my $file = $absolute;
1423 ##print "absolute<$absolute>\n";
1425 # See if any suffix of this path is a path within the tree.
1426 while ($file =~ s@^[^/]*/@@) {
1427 if (-f "$root/$file") {
1428 ##print "file<$file>\n";
1436 # It is, so see if the prefix is acceptable.
1437 my $prefix = $absolute;
1438 substr($prefix, -length($file)) = '';
1440 ##print "prefix<$prefix>\n";
1441 if ($prefix ne ".../") {
1442 WARN("USE_RELATIVE_PATH",
1443 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1450 $string =~ s/(^\s+|\s+$)//g;
1458 my $source_indent = 8;
1459 my $max_spaces_before_tab = $source_indent - 1;
1460 my $spaces_to_tab = " " x $source_indent;
1462 #convert leading spaces to tabs
1463 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1464 #Remove spaces before a tab
1465 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1470 sub pos_last_openparen {
1475 my $opens = $line =~ tr/\(/\(/;
1476 my $closes = $line =~ tr/\)/\)/;
1478 my $last_openparen = 0;
1480 if (($opens == 0) || ($closes >= $opens)) {
1484 my $len = length($line);
1486 for ($pos = 0; $pos < $len; $pos++) {
1487 my $string = substr($line, $pos);
1488 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1489 $pos += length($1) - 1;
1490 } elsif (substr($line, $pos, 1) eq '(') {
1491 $last_openparen = $pos;
1492 } elsif (index($string, '(') == -1) {
1497 return $last_openparen + 1;
1501 my $filename = shift;
1507 my $stashrawline="";
1518 my $in_header_lines = 1;
1519 my $in_commit_log = 0; #Scanning lines before patch
1521 my $non_utf8_charset = 0;
1529 # Trace the real file/line as we go.
1535 my $comment_edge = 0;
1539 my $prev_values = 'E';
1542 my %suppress_ifbraces;
1543 my %suppress_whiletrailers;
1544 my %suppress_export;
1545 my $suppress_statement = 0;
1547 my %signatures = ();
1549 # Pre-scan the patch sanitizing the lines.
1550 # Pre-scan the patch looking for any __setup documentation.
1552 my @setup_docs = ();
1555 sanitise_line_reset();
1557 foreach my $rawline (@rawlines) {
1561 push(@fixed, $rawline) if ($fix);
1563 if ($rawline=~/^\+\+\+\s+(\S+)/) {
1565 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1570 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1579 # Guestimate if this is a continuing comment. Run
1580 # the context looking for a comment "edge". If this
1581 # edge is a close comment then we must be in a comment
1585 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1586 next if (defined $rawlines[$ln - 1] &&
1587 $rawlines[$ln - 1] =~ /^-/);
1589 #print "RAW<$rawlines[$ln - 1]>\n";
1590 last if (!defined $rawlines[$ln - 1]);
1591 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1592 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1597 if (defined $edge && $edge eq '*/') {
1601 # Guestimate if this is a continuing comment. If this
1602 # is the start of a diff block and this line starts
1603 # ' *' then it is very likely a comment.
1604 if (!defined $edge &&
1605 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1610 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1611 sanitise_line_reset($in_comment);
1613 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1614 # Standardise the strings and chars within the input to
1615 # simplify matching -- only bother with positive lines.
1616 $line = sanitise_line($rawline);
1618 push(@lines, $line);
1621 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1626 #print "==>$rawline\n";
1627 #print "-->$line\n";
1629 if ($setup_docs && $line =~ /^\+/) {
1630 push(@setup_docs, $line);
1638 foreach my $line (@lines) {
1641 my $rawline = $rawlines[$linenr - 1];
1643 #extract the line range in the file after the patch is applied
1644 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1646 $first_line = $linenr + 1;
1656 %suppress_ifbraces = ();
1657 %suppress_whiletrailers = ();
1658 %suppress_export = ();
1659 $suppress_statement = 0;
1662 # track the line number as we move through the hunk, note that
1663 # new versions of GNU diff omit the leading space on completely
1664 # blank context lines so we need to count that too.
1665 } elsif ($line =~ /^( |\+|$)/) {
1667 $realcnt-- if ($realcnt != 0);
1669 # Measure the line length and indent.
1670 ($length, $indent) = line_stats($rawline);
1672 # Track the previous line.
1673 ($prevline, $stashline) = ($stashline, $line);
1674 ($previndent, $stashindent) = ($stashindent, $indent);
1675 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1677 #warn "line<$line>\n";
1679 } elsif ($realcnt == 1) {
1683 my $hunk_line = ($realcnt != 0);
1685 #make up the handle for any error we report on this line
1686 $prefix = "$filename:$realline: " if ($emacs && $file);
1687 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1689 $here = "#$linenr: " if (!$file);
1690 $here = "#$realline: " if ($file);
1692 # extract the filename as it passes
1693 if ($line =~ /^diff --git.*?(\S+)$/) {
1695 $realfile =~ s@^([^/]*)/@@;
1697 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
1699 $realfile =~ s@^([^/]*)/@@;
1703 if (!$file && $tree && $p1_prefix ne '' &&
1704 -e "$root/$p1_prefix") {
1705 WARN("PATCH_PREFIX",
1706 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1709 if ($realfile =~ m@^include/asm/@) {
1710 ERROR("MODIFIED_INCLUDE_ASM",
1711 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1716 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
1718 my $hereline = "$here\n$rawline\n";
1719 my $herecurr = "$here\n$rawline\n";
1720 my $hereprev = "$here\n$prevrawline\n$rawline\n";
1722 $cnt_lines++ if ($realcnt != 0);
1724 # Check for incorrect file permissions
1725 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1726 my $permhere = $here . "FILE: $realfile\n";
1727 if ($realfile !~ m@scripts/@ &&
1728 $realfile !~ /\.(py|pl|awk|sh)$/) {
1729 ERROR("EXECUTE_PERMISSIONS",
1730 "do not set execute permissions for source files\n" . $permhere);
1734 # Check the patch for a signoff:
1735 if ($line =~ /^\s*signed-off-by:/i) {
1740 # Check signature styles
1741 if (!$in_header_lines &&
1742 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
1743 my $space_before = $1;
1745 my $space_after = $3;
1747 my $ucfirst_sign_off = ucfirst(lc($sign_off));
1749 if ($sign_off !~ /$signature_tags/) {
1750 WARN("BAD_SIGN_OFF",
1751 "Non-standard signature: $sign_off\n" . $herecurr);
1753 if (defined $space_before && $space_before ne "") {
1754 if (WARN("BAD_SIGN_OFF",
1755 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
1757 $fixed[$linenr - 1] =
1758 "$ucfirst_sign_off $email";
1761 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
1762 if (WARN("BAD_SIGN_OFF",
1763 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
1765 $fixed[$linenr - 1] =
1766 "$ucfirst_sign_off $email";
1770 if (!defined $space_after || $space_after ne " ") {
1771 if (WARN("BAD_SIGN_OFF",
1772 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
1774 $fixed[$linenr - 1] =
1775 "$ucfirst_sign_off $email";
1779 my ($email_name, $email_address, $comment) = parse_email($email);
1780 my $suggested_email = format_email(($email_name, $email_address));
1781 if ($suggested_email eq "") {
1782 ERROR("BAD_SIGN_OFF",
1783 "Unrecognized email address: '$email'\n" . $herecurr);
1785 my $dequoted = $suggested_email;
1786 $dequoted =~ s/^"//;
1787 $dequoted =~ s/" </ </;
1788 # Don't force email to have quotes
1789 # Allow just an angle bracketed address
1790 if ("$dequoted$comment" ne $email &&
1791 "<$email_address>$comment" ne $email &&
1792 "$suggested_email$comment" ne $email) {
1793 WARN("BAD_SIGN_OFF",
1794 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
1798 # Check for duplicate signatures
1799 my $sig_nospace = $line;
1800 $sig_nospace =~ s/\s//g;
1801 $sig_nospace = lc($sig_nospace);
1802 if (defined $signatures{$sig_nospace}) {
1803 WARN("BAD_SIGN_OFF",
1804 "Duplicate signature\n" . $herecurr);
1806 $signatures{$sig_nospace} = 1;
1810 # Check for wrappage within a valid hunk of the file
1811 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1812 ERROR("CORRUPTED_PATCH",
1813 "patch seems to be corrupt (line wrapped?)\n" .
1814 $herecurr) if (!$emitted_corrupt++);
1817 # Check for absolute kernel paths.
1819 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1822 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1823 check_absolute_file($1, $herecurr)) {
1826 check_absolute_file($file, $herecurr);
1831 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1832 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1833 $rawline !~ m/^$UTF8*$/) {
1834 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1836 my $blank = copy_spacing($rawline);
1837 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1838 my $hereptr = "$hereline$ptr\n";
1841 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1844 # Check if it's the start of a commit log
1845 # (not a header line and we haven't seen the patch filename)
1846 if ($in_header_lines && $realfile =~ /^$/ &&
1847 $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
1848 $in_header_lines = 0;
1852 # Check if there is UTF-8 in a commit log when a mail header has explicitly
1853 # declined it, i.e defined some charset where it is missing.
1854 if ($in_header_lines &&
1855 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
1857 $non_utf8_charset = 1;
1860 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
1861 $rawline =~ /$NON_ASCII_UTF8/) {
1862 WARN("UTF8_BEFORE_PATCH",
1863 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
1866 # ignore non-hunk lines and lines being removed
1867 next if (!$hunk_line || $line =~ /^-/);
1869 #trailing whitespace
1870 if ($line =~ /^\+.*\015/) {
1871 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1872 if (ERROR("DOS_LINE_ENDINGS",
1873 "DOS line endings\n" . $herevet) &&
1875 $fixed[$linenr - 1] =~ s/[\s\015]+$//;
1877 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1878 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1879 if (ERROR("TRAILING_WHITESPACE",
1880 "trailing whitespace\n" . $herevet) &&
1882 $fixed[$linenr - 1] =~ s/\s+$//;
1888 # check for Kconfig help text having a real description
1889 # Only applies when adding the entry originally, after that we do not have
1890 # sufficient context to determine whether it is indeed long enough.
1891 if ($realfile =~ /Kconfig/ &&
1892 $line =~ /.\s*config\s+/) {
1895 my $ln = $linenr + 1;
1899 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
1900 $f = $lines[$ln - 1];
1901 $cnt-- if ($lines[$ln - 1] !~ /^-/);
1902 $is_end = $lines[$ln - 1] =~ /^\+/;
1904 next if ($f =~ /^-/);
1906 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
1908 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
1915 next if ($f =~ /^$/);
1916 if ($f =~ /^\s*config\s/) {
1922 WARN("CONFIG_DESCRIPTION",
1923 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
1924 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
1927 # discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
1928 if ($realfile =~ /Kconfig/ &&
1929 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
1930 WARN("CONFIG_EXPERIMENTAL",
1931 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
1934 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
1935 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
1938 'EXTRA_AFLAGS' => 'asflags-y',
1939 'EXTRA_CFLAGS' => 'ccflags-y',
1940 'EXTRA_CPPFLAGS' => 'cppflags-y',
1941 'EXTRA_LDFLAGS' => 'ldflags-y',
1944 WARN("DEPRECATED_VARIABLE",
1945 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
1948 # check we are in a valid source file if not then ignore this hunk
1949 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1952 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
1953 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1954 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
1955 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
1956 $length > $max_line_length)
1959 "line over $max_line_length characters\n" . $herecurr);
1962 # Check for user-visible strings broken across lines, which breaks the ability
1963 # to grep for the string. Limited to strings used as parameters (those
1964 # following an open parenthesis), which almost completely eliminates false
1965 # positives, as well as warning only once per parameter rather than once per
1966 # line of the string. Make an exception when the previous string ends in a
1967 # newline (multiple lines in one string constant) or \n\t (common in inline
1968 # assembly to indent the instruction on the following line).
1969 if ($line =~ /^\+\s*"/ &&
1970 $prevline =~ /"\s*$/ &&
1971 $prevline =~ /\(/ &&
1972 $prevrawline !~ /\\n(?:\\t)*"\s*$/) {
1973 WARN("SPLIT_STRING",
1974 "quoted string split across lines\n" . $hereprev);
1977 # check for spaces before a quoted newline
1978 if ($rawline =~ /^.*\".*\s\\n/) {
1979 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
1980 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
1982 $fixed[$linenr - 1] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
1987 # check for adding lines without a newline.
1988 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1989 WARN("MISSING_EOF_NEWLINE",
1990 "adding a line without newline at end of file\n" . $herecurr);
1993 # Blackfin: use hi/lo macros
1994 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
1995 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
1996 my $herevet = "$here\n" . cat_vet($line) . "\n";
1998 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
2000 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2001 my $herevet = "$here\n" . cat_vet($line) . "\n";
2003 "use the HI() macro, not (... >> 16)\n" . $herevet);
2007 # check we are in a valid source file C or perl if not then ignore this hunk
2008 next if ($realfile !~ /\.(h|c|pl)$/);
2010 # at the beginning of a line any tabs must come first and anything
2011 # more than 8 must use tabs.
2012 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2013 $rawline =~ /^\+\s* \s*/) {
2014 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2016 if (ERROR("CODE_INDENT",
2017 "code indent should use tabs where possible\n" . $herevet) &&
2019 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2023 # check for space before tabs.
2024 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2025 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2026 if (WARN("SPACE_BEFORE_TAB",
2027 "please, no space before tabs\n" . $herevet) &&
2029 $fixed[$linenr - 1] =~
2030 s/(^\+.*) +\t/$1\t/;
2034 # check for && or || at the start of a line
2035 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2036 CHK("LOGICAL_CONTINUATIONS",
2037 "Logical continuations should be on the previous line\n" . $hereprev);
2040 # check multi-line statement indentation matches previous line
2041 if ($^V && $^V ge 5.10.0 &&
2042 $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) {
2043 $prevline =~ /^\+(\t*)(.*)$/;
2047 my $pos = pos_last_openparen($rest);
2049 $line =~ /^(\+| )([ \t]*)/;
2052 my $goodtabindent = $oldindent .
2055 my $goodspaceindent = $oldindent . " " x $pos;
2057 if ($newindent ne $goodtabindent &&
2058 $newindent ne $goodspaceindent) {
2060 if (CHK("PARENTHESIS_ALIGNMENT",
2061 "Alignment should match open parenthesis\n" . $hereprev) &&
2062 $fix && $line =~ /^\+/) {
2063 $fixed[$linenr - 1] =~
2064 s/^\+[ \t]*/\+$goodtabindent/;
2070 if ($line =~ /^\+.*\*[ \t]*\)[ \t]+(?!$Assignment|$Arithmetic)/) {
2072 "No space is necessary after a cast\n" . $hereprev) &&
2074 $fixed[$linenr - 1] =~
2075 s/^(\+.*\*[ \t]*\))[ \t]+/$1/;
2079 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2080 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
2081 $rawline =~ /^\+[ \t]*\*/) {
2082 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2083 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2086 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2087 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2088 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
2089 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2090 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2091 "networking block comments start with * on subsequent lines\n" . $hereprev);
2094 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2095 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2096 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2097 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2098 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
2099 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2100 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2103 # check for spaces at the beginning of a line.
2105 # 1) within comments
2106 # 2) indented preprocessor commands
2108 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
2109 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2110 if (WARN("LEADING_SPACE",
2111 "please, no spaces at the start of a line\n" . $herevet) &&
2113 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2117 # check we are in a valid C source file if not then ignore this hunk
2118 next if ($realfile !~ /\.(h|c)$/);
2120 # discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2121 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2122 WARN("CONFIG_EXPERIMENTAL",
2123 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2126 # check for RCS/CVS revision markers
2127 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
2129 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
2132 # Blackfin: don't use __builtin_bfin_[cs]sync
2133 if ($line =~ /__builtin_bfin_csync/) {
2134 my $herevet = "$here\n" . cat_vet($line) . "\n";
2136 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
2138 if ($line =~ /__builtin_bfin_ssync/) {
2139 my $herevet = "$here\n" . cat_vet($line) . "\n";
2141 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
2144 # check for old HOTPLUG __dev<foo> section markings
2145 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2146 WARN("HOTPLUG_SECTION",
2147 "Using $1 is unnecessary\n" . $herecurr);
2150 # Check for potential 'bare' types
2151 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2153 #print "LINE<$line>\n";
2154 if ($linenr >= $suppress_statement &&
2155 $realcnt && $line =~ /.\s*\S/) {
2156 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2157 ctx_statement_block($linenr, $realcnt, 0);
2158 $stat =~ s/\n./\n /g;
2159 $cond =~ s/\n./\n /g;
2161 #print "linenr<$linenr> <$stat>\n";
2162 # If this statement has no statement boundaries within
2163 # it there is no point in retrying a statement scan
2164 # until we hit end of it.
2165 my $frag = $stat; $frag =~ s/;+\s*$//;
2166 if ($frag !~ /(?:{|;)/) {
2167 #print "skip<$line_nr_next>\n";
2168 $suppress_statement = $line_nr_next;
2171 # Find the real next line.
2172 $realline_next = $line_nr_next;
2173 if (defined $realline_next &&
2174 (!defined $lines[$realline_next - 1] ||
2175 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2182 # Ignore goto labels.
2183 if ($s =~ /$Ident:\*$/s) {
2185 # Ignore functions being called
2186 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
2188 } elsif ($s =~ /^.\s*else\b/s) {
2190 # declarations always start with types
2191 } 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) {
2194 possible($type, "A:" . $s);
2196 # definitions in global scope can only start with types
2197 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
2198 possible($1, "B:" . $s);
2201 # any (foo ... *) is a pointer cast, and foo is a type
2202 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
2203 possible($1, "C:" . $s);
2206 # Check for any sort of function declaration.
2207 # int foo(something bar, other baz);
2208 # void (*store_gdt)(x86_descr_ptr *);
2209 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
2210 my ($name_len) = length($1);
2213 substr($ctx, 0, $name_len + 1, '');
2214 $ctx =~ s/\)[^\)]*$//;
2216 for my $arg (split(/\s*,\s*/, $ctx)) {
2217 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
2219 possible($1, "D:" . $s);
2227 # Checks which may be anchored in the context.
2230 # Check for switch () and associated case and default
2231 # statements should be at the same indent.
2232 if ($line=~/\bswitch\s*\(.*\)/) {
2235 my @ctx = ctx_block_outer($linenr, $realcnt);
2237 for my $ctx (@ctx) {
2238 my ($clen, $cindent) = line_stats($ctx);
2239 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2240 $indent != $cindent) {
2241 $err .= "$sep$ctx\n";
2248 ERROR("SWITCH_CASE_INDENT_LEVEL",
2249 "switch and case should be at the same indent\n$hereline$err");
2253 # if/while/etc brace do not go on next line, unless defining a do while loop,
2254 # or if that brace on the next line is for something else
2255 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
2256 my $pre_ctx = "$1$2";
2258 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
2260 if ($line =~ /^\+\t{6,}/) {
2261 WARN("DEEP_INDENTATION",
2262 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2265 my $ctx_cnt = $realcnt - $#ctx - 1;
2266 my $ctx = join("\n", @ctx);
2268 my $ctx_ln = $linenr;
2269 my $ctx_skip = $realcnt;
2271 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2272 defined $lines[$ctx_ln - 1] &&
2273 $lines[$ctx_ln - 1] =~ /^-/)) {
2274 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2275 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
2279 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2280 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
2282 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
2284 "that open brace { should be on the previous line\n" .
2285 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2287 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2288 $ctx =~ /\)\s*\;\s*$/ &&
2289 defined $lines[$ctx_ln - 1])
2291 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2292 if ($nindent > $indent) {
2293 WARN("TRAILING_SEMICOLON",
2294 "trailing semicolon indicates no statements, indent implies otherwise\n" .
2295 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2300 # Check relative indent for conditionals and blocks.
2301 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2302 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2303 ctx_statement_block($linenr, $realcnt, 0)
2304 if (!defined $stat);
2305 my ($s, $c) = ($stat, $cond);
2307 substr($s, 0, length($c), '');
2309 # Make sure we remove the line prefixes as we have
2310 # none on the first line, and are going to readd them
2314 # Find out how long the conditional actually is.
2315 my @newlines = ($c =~ /\n/gs);
2316 my $cond_lines = 1 + $#newlines;
2318 # We want to check the first line inside the block
2319 # starting at the end of the conditional, so remove:
2320 # 1) any blank line termination
2321 # 2) any opening brace { on end of the line
2323 my $continuation = 0;
2325 $s =~ s/^.*\bdo\b//;
2327 if ($s =~ s/^\s*\\//) {
2330 if ($s =~ s/^\s*?\n//) {
2335 # Also ignore a loop construct at the end of a
2336 # preprocessor statement.
2337 if (($prevline =~ /^.\s*#\s*define\s/ ||
2338 $prevline =~ /\\\s*$/) && $continuation == 0) {
2344 while ($cond_ptr != $cond_lines) {
2345 $cond_ptr = $cond_lines;
2347 # If we see an #else/#elif then the code
2349 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2354 # 1) blank lines, they should be at 0,
2355 # 2) preprocessor lines, and
2357 if ($continuation ||
2359 $s =~ /^\s*#\s*?/ ||
2360 $s =~ /^\s*$Ident\s*:/) {
2361 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
2362 if ($s =~ s/^.*?\n//) {
2368 my (undef, $sindent) = line_stats("+" . $s);
2369 my $stat_real = raw_line($linenr, $cond_lines);
2371 # Check if either of these lines are modified, else
2372 # this is not this patch's fault.
2373 if (!defined($stat_real) ||
2374 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2377 if (defined($stat_real) && $cond_lines > 1) {
2378 $stat_real = "[...]\n$stat_real";
2381 #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";
2383 if ($check && (($sindent % 8) != 0 ||
2384 ($sindent <= $indent && $s ne ''))) {
2385 WARN("SUSPECT_CODE_INDENT",
2386 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
2390 # Track the 'values' across context and added lines.
2391 my $opline = $line; $opline =~ s/^./ /;
2392 my ($curr_values, $curr_vars) =
2393 annotate_values($opline . "\n", $prev_values);
2394 $curr_values = $prev_values . $curr_values;
2396 my $outline = $opline; $outline =~ s/\t/ /g;
2397 print "$linenr > .$outline\n";
2398 print "$linenr > $curr_values\n";
2399 print "$linenr > $curr_vars\n";
2401 $prev_values = substr($curr_values, -1);
2403 #ignore lines not being added
2404 next if ($line =~ /^[^\+]/);
2406 # TEST: allow direct testing of the type matcher.
2408 if ($line =~ /^.\s*$Declare\s*$/) {
2410 "TEST: is type\n" . $herecurr);
2411 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
2412 ERROR("TEST_NOT_TYPE",
2413 "TEST: is not type ($1 is)\n". $herecurr);
2417 # TEST: allow direct testing of the attribute matcher.
2419 if ($line =~ /^.\s*$Modifier\s*$/) {
2421 "TEST: is attr\n" . $herecurr);
2422 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
2423 ERROR("TEST_NOT_ATTR",
2424 "TEST: is not attr ($1 is)\n". $herecurr);
2429 # check for initialisation to aggregates open brace on the next line
2430 if ($line =~ /^.\s*{/ &&
2431 $prevline =~ /(?:^|[^=])=\s*$/) {
2433 "that open brace { should be on the previous line\n" . $hereprev);
2437 # Checks which are anchored on the added line.
2440 # check for malformed paths in #include statements (uses RAW line)
2441 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
2443 if ($path =~ m{//}) {
2444 ERROR("MALFORMED_INCLUDE",
2445 "malformed #include filename\n" . $herecurr);
2447 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
2448 ERROR("UAPI_INCLUDE",
2449 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
2453 # no C99 // comments
2454 if ($line =~ m{//}) {
2455 if (ERROR("C99_COMMENTS",
2456 "do not use C99 // comments\n" . $herecurr) &&
2458 my $line = $fixed[$linenr - 1];
2459 if ($line =~ /\/\/(.*)$/) {
2460 my $comment = trim($1);
2461 $fixed[$linenr - 1] =~ s@\/\/(.*)$@/\* $comment \*/@;
2465 # Remove C99 comments.
2467 $opline =~ s@//.*@@;
2469 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2470 # the whole statement.
2471 #print "APW <$lines[$realline_next - 1]>\n";
2472 if (defined $realline_next &&
2473 exists $lines[$realline_next - 1] &&
2474 !defined $suppress_export{$realline_next} &&
2475 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2476 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2477 # Handle definitions which produce identifiers with
2480 # EXPORT_SYMBOL(something_foo);
2482 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
2483 $name =~ /^${Ident}_$2/) {
2484 #print "FOO C name<$name>\n";
2485 $suppress_export{$realline_next} = 1;
2487 } elsif ($stat !~ /(?:
2489 ^.DEFINE_$Ident\(\Q$name\E\)|
2490 ^.DECLARE_$Ident\(\Q$name\E\)|
2491 ^.LIST_HEAD\(\Q$name\E\)|
2492 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2493 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
2495 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2496 $suppress_export{$realline_next} = 2;
2498 $suppress_export{$realline_next} = 1;
2501 if (!defined $suppress_export{$linenr} &&
2502 $prevline =~ /^.\s*$/ &&
2503 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2504 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2505 #print "FOO B <$lines[$linenr - 1]>\n";
2506 $suppress_export{$linenr} = 2;
2508 if (defined $suppress_export{$linenr} &&
2509 $suppress_export{$linenr} == 2) {
2510 WARN("EXPORT_SYMBOL",
2511 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
2514 # check for global initialisers.
2515 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
2516 if (ERROR("GLOBAL_INITIALISERS",
2517 "do not initialise globals to 0 or NULL\n" .
2520 $fixed[$linenr - 1] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
2523 # check for static initialisers.
2524 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2525 if (ERROR("INITIALISED_STATIC",
2526 "do not initialise statics to 0 or NULL\n" .
2529 $fixed[$linenr - 1] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
2533 # check for static const char * arrays.
2534 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
2535 WARN("STATIC_CONST_CHAR_ARRAY",
2536 "static const char * array should probably be static const char * const\n" .
2540 # check for static char foo[] = "bar" declarations.
2541 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
2542 WARN("STATIC_CONST_CHAR_ARRAY",
2543 "static char array declaration should probably be static const char\n" .
2547 # check for declarations of struct pci_device_id
2548 if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) {
2549 WARN("DEFINE_PCI_DEVICE_TABLE",
2550 "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr);
2553 # check for new typedefs, only function parameters and sparse annotations
2555 if ($line =~ /\btypedef\s/ &&
2556 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
2557 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
2558 $line !~ /\b$typeTypedefs\b/ &&
2559 $line !~ /\b__bitwise(?:__|)\b/) {
2560 WARN("NEW_TYPEDEFS",
2561 "do not add new typedefs\n" . $herecurr);
2564 # * goes on variable not on type
2566 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2568 my ($ident, $from, $to) = ($1, $2, $2);
2570 # Should start with a space.
2571 $to =~ s/^(\S)/ $1/;
2572 # Should not end with a space.
2574 # '*'s should not have spaces between.
2575 while ($to =~ s/\*\s+\*/\*\*/) {
2578 ## print "1: from<$from> to<$to> ident<$ident>\n";
2580 if (ERROR("POINTER_LOCATION",
2581 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
2583 my $sub_from = $ident;
2584 my $sub_to = $ident;
2585 $sub_to =~ s/\Q$from\E/$to/;
2586 $fixed[$linenr - 1] =~
2587 s@\Q$sub_from\E@$sub_to@;
2591 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2593 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
2595 # Should start with a space.
2596 $to =~ s/^(\S)/ $1/;
2597 # Should not end with a space.
2599 # '*'s should not have spaces between.
2600 while ($to =~ s/\*\s+\*/\*\*/) {
2602 # Modifiers should have spaces.
2603 $to =~ s/(\b$Modifier$)/$1 /;
2605 ## print "2: from<$from> to<$to> ident<$ident>\n";
2606 if ($from ne $to && $ident !~ /^$Modifier$/) {
2607 if (ERROR("POINTER_LOCATION",
2608 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
2611 my $sub_from = $match;
2612 my $sub_to = $match;
2613 $sub_to =~ s/\Q$from\E/$to/;
2614 $fixed[$linenr - 1] =~
2615 s@\Q$sub_from\E@$sub_to@;
2620 # # no BUG() or BUG_ON()
2621 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
2622 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2623 # print "$herecurr";
2627 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
2628 WARN("LINUX_VERSION_CODE",
2629 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
2632 # check for uses of printk_ratelimit
2633 if ($line =~ /\bprintk_ratelimit\s*\(/) {
2634 WARN("PRINTK_RATELIMITED",
2635 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
2638 # printk should use KERN_* levels. Note that follow on printk's on the
2639 # same line do not need a level, so we use the current block context
2640 # to try and find and validate the current printk. In summary the current
2641 # printk includes all preceding printk's which have no newline on the end.
2642 # we assume the first bad printk is the one to report.
2643 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
2645 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2646 #print "CHECK<$lines[$ln - 1]\n";
2647 # we have a preceding printk if it ends
2648 # with "\n" ignore it, else it is to blame
2649 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2650 if ($rawlines[$ln - 1] !~ m{\\n"}) {
2657 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2658 "printk() should include KERN_ facility level\n" . $herecurr);
2662 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
2664 my $level = lc($orig);
2665 $level = "warn" if ($level eq "warning");
2666 my $level2 = $level;
2667 $level2 = "dbg" if ($level eq "debug");
2668 WARN("PREFER_PR_LEVEL",
2669 "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
2672 if ($line =~ /\bpr_warning\s*\(/) {
2673 if (WARN("PREFER_PR_LEVEL",
2674 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
2676 $fixed[$linenr - 1] =~
2677 s/\bpr_warning\b/pr_warn/;
2681 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
2683 my $level = lc($orig);
2684 $level = "warn" if ($level eq "warning");
2685 $level = "dbg" if ($level eq "debug");
2686 WARN("PREFER_DEV_LEVEL",
2687 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
2690 # function brace can't be on same line, except for #defines of do while,
2691 # or if closed on same line
2692 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2693 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
2695 "open brace '{' following function declarations go on the next line\n" . $herecurr);
2698 # open braces for enum, union and struct go on the same line.
2699 if ($line =~ /^.\s*{/ &&
2700 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
2702 "open brace '{' following $1 go on the same line\n" . $hereprev);
2705 # missing space after union, struct or enum definition
2706 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
2708 "missing space after $1 definition\n" . $herecurr) &&
2710 $fixed[$linenr - 1] =~
2711 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
2715 # check for spacing round square brackets; allowed:
2716 # 1. with a type on the left -- int [] a;
2717 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2718 # 3. inside a curly brace -- = { [0...10] = 5 }
2719 while ($line =~ /(.*?\s)\[/g) {
2720 my ($where, $prefix) = ($-[1], $1);
2721 if ($prefix !~ /$Type\s+$/ &&
2722 ($where != 0 || $prefix !~ /^.\s+$/) &&
2723 $prefix !~ /[{,]\s+$/) {
2724 if (ERROR("BRACKET_SPACE",
2725 "space prohibited before open square bracket '['\n" . $herecurr) &&
2727 $fixed[$linenr - 1] =~
2728 s/^(\+.*?)\s+\[/$1\[/;
2733 # check for spaces between functions and their parentheses.
2734 while ($line =~ /($Ident)\s+\(/g) {
2736 my $ctx_before = substr($line, 0, $-[1]);
2737 my $ctx = "$ctx_before$name";
2739 # Ignore those directives where spaces _are_ permitted.
2741 if|for|while|switch|return|case|
2742 volatile|__volatile__|
2743 __attribute__|format|__extension__|
2746 # cpp #define statements have non-optional spaces, ie
2747 # if there is a space between the name and the open
2748 # parenthesis it is simply not a parameter group.
2749 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
2751 # cpp #elif statement condition may start with a (
2752 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
2754 # If this whole things ends with a type its most
2755 # likely a typedef for a function.
2756 } elsif ($ctx =~ /$Type$/) {
2760 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
2762 $fixed[$linenr - 1] =~
2763 s/\b$name\s+\(/$name\(/;
2768 # Check operator spacing.
2769 if (!($line=~/\#\s*include/)) {
2770 my $fixed_line = "";
2774 <<=|>>=|<=|>=|==|!=|
2775 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
2776 =>|->|<<|>>|<|>|=|!|~|
2777 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
2780 my @elements = split(/($ops|;)/, $opline);
2782 ## print("element count: <" . $#elements . ">\n");
2783 ## foreach my $el (@elements) {
2784 ## print("el: <$el>\n");
2787 my @fix_elements = ();
2790 foreach my $el (@elements) {
2791 push(@fix_elements, substr($rawline, $off, length($el)));
2792 $off += length($el);
2797 my $blank = copy_spacing($opline);
2799 for (my $n = 0; $n < $#elements; $n += 2) {
2801 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
2803 ## print("n: <$n> good: <$good>\n");
2805 $off += length($elements[$n]);
2807 # Pick up the preceding and succeeding characters.
2808 my $ca = substr($opline, 0, $off);
2810 if (length($opline) >= ($off + length($elements[$n + 1]))) {
2811 $cc = substr($opline, $off + length($elements[$n + 1]));
2813 my $cb = "$ca$;$cc";
2816 $a = 'V' if ($elements[$n] ne '');
2817 $a = 'W' if ($elements[$n] =~ /\s$/);
2818 $a = 'C' if ($elements[$n] =~ /$;$/);
2819 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
2820 $a = 'O' if ($elements[$n] eq '');
2821 $a = 'E' if ($ca =~ /^\s*$/);
2823 my $op = $elements[$n + 1];
2826 if (defined $elements[$n + 2]) {
2827 $c = 'V' if ($elements[$n + 2] ne '');
2828 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
2829 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
2830 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
2831 $c = 'O' if ($elements[$n + 2] eq '');
2832 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
2837 my $ctx = "${a}x${c}";
2839 my $at = "(ctx:$ctx)";
2841 my $ptr = substr($blank, 0, $off) . "^";
2842 my $hereptr = "$hereline$ptr\n";
2844 # Pull out the value of this operator.
2845 my $op_type = substr($curr_values, $off + 1, 1);
2847 # Get the full operator variant.
2848 my $opv = $op . substr($curr_vars, $off, 1);
2850 # Ignore operators passed as parameters.
2851 if ($op_type ne 'V' &&
2852 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
2855 # } elsif ($op =~ /^$;+$/) {
2857 # ; should have either the end of line or a space or \ after it
2858 } elsif ($op eq ';') {
2859 if ($ctx !~ /.x[WEBC]/ &&
2860 $cc !~ /^\\/ && $cc !~ /^;/) {
2861 if (ERROR("SPACING",
2862 "space required after that '$op' $at\n" . $hereptr)) {
2863 $good = trim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
2869 } elsif ($op eq '//') {
2873 # : when part of a bitfield
2874 } elsif ($op eq '->' || $opv eq ':B') {
2875 if ($ctx =~ /Wx.|.xW/) {
2876 if (ERROR("SPACING",
2877 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
2878 $good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
2880 if (defined $fix_elements[$n + 2]) {
2881 $fix_elements[$n + 2] =~ s/^\s+//;
2886 # , must have a space on the right.
2887 } elsif ($op eq ',') {
2888 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
2889 if (ERROR("SPACING",
2890 "space required after that '$op' $at\n" . $hereptr)) {
2891 $good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]) . " ";
2896 # '*' as part of a type definition -- reported already.
2897 } elsif ($opv eq '*_') {
2898 #warn "'*' is part of type\n";
2900 # unary operators should have a space before and
2901 # none after. May be left adjacent to another
2902 # unary operator, or a cast
2903 } elsif ($op eq '!' || $op eq '~' ||
2904 $opv eq '*U' || $opv eq '-U' ||
2905 $opv eq '&U' || $opv eq '&&U') {
2906 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
2907 if (ERROR("SPACING",
2908 "space required before that '$op' $at\n" . $hereptr)) {
2909 $good = trim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
2913 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
2914 # A unary '*' may be const
2916 } elsif ($ctx =~ /.xW/) {
2917 if (ERROR("SPACING",
2918 "space prohibited after that '$op' $at\n" . $hereptr)) {
2919 $fixed_line =~ s/\s+$//;
2920 $good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
2922 if (defined $fix_elements[$n + 2]) {
2923 $fix_elements[$n + 2] =~ s/^\s+//;
2928 # unary ++ and unary -- are allowed no space on one side.
2929 } elsif ($op eq '++' or $op eq '--') {
2930 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
2931 if (ERROR("SPACING",
2932 "space required one side of that '$op' $at\n" . $hereptr)) {
2933 $fixed_line =~ s/\s+$//;
2934 $good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]) . " ";
2938 if ($ctx =~ /Wx[BE]/ ||
2939 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
2940 if (ERROR("SPACING",
2941 "space prohibited before that '$op' $at\n" . $hereptr)) {
2942 $fixed_line =~ s/\s+$//;
2943 $good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
2947 if ($ctx =~ /ExW/) {
2948 if (ERROR("SPACING",
2949 "space prohibited after that '$op' $at\n" . $hereptr)) {
2950 $fixed_line =~ s/\s+$//;
2951 $good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
2953 if (defined $fix_elements[$n + 2]) {
2954 $fix_elements[$n + 2] =~ s/^\s+//;
2959 # << and >> may either have or not have spaces both sides
2960 } elsif ($op eq '<<' or $op eq '>>' or
2961 $op eq '&' or $op eq '^' or $op eq '|' or
2962 $op eq '+' or $op eq '-' or
2963 $op eq '*' or $op eq '/' or
2966 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
2967 if (ERROR("SPACING",
2968 "need consistent spacing around '$op' $at\n" . $hereptr)) {
2969 $fixed_line =~ s/\s+$//;
2970 $good = trim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
2975 # A colon needs no spaces before when it is
2976 # terminating a case value or a label.
2977 } elsif ($opv eq ':C' || $opv eq ':L') {
2978 if ($ctx =~ /Wx./) {
2979 if (ERROR("SPACING",
2980 "space prohibited before that '$op' $at\n" . $hereptr)) {
2981 $good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
2986 # All the others need spaces both sides.
2987 } elsif ($ctx !~ /[EWC]x[CWE]/) {
2990 # Ignore email addresses <foo@bar>
2992 $cc =~ /^\S+\@\S+>/) ||
2994 $ca =~ /<\S+\@\S+$/))
3000 if (($opv eq ':O' && $ca =~ /\?$/) ||
3001 ($op eq '?' && $cc =~ /^:/)) {
3006 if (ERROR("SPACING",
3007 "spaces required around that '$op' $at\n" . $hereptr)) {
3008 $good = trim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3009 $good = $fix_elements[$n] . " " . trim($fix_elements[$n + 1]) . " ";
3014 $off += length($elements[$n + 1]);
3016 ## print("n: <$n> GOOD: <$good>\n");
3018 $fixed_line = $fixed_line . $good;
3021 if (($#elements % 2) == 0) {
3022 $fixed_line = $fixed_line . $fix_elements[$#elements];
3025 if ($fix && $line_fixed && $fixed_line ne $fixed[$linenr - 1]) {
3026 $fixed[$linenr - 1] = $fixed_line;
3032 # check for whitespace before a non-naked semicolon
3033 if ($line =~ /^\+.*\S\s+;/) {
3035 "space prohibited before semicolon\n" . $herecurr) &&
3037 1 while $fixed[$linenr - 1] =~
3038 s/^(\+.*\S)\s+;/$1;/;
3042 # check for multiple assignments
3043 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
3044 CHK("MULTIPLE_ASSIGNMENTS",
3045 "multiple assignments should be avoided\n" . $herecurr);
3048 ## # check for multiple declarations, allowing for a function declaration
3050 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3051 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3053 ## # Remove any bracketed sections to ensure we do not
3054 ## # falsly report the parameters of functions.
3056 ## while ($ln =~ s/\([^\(\)]*\)//g) {
3058 ## if ($ln =~ /,/) {
3059 ## WARN("MULTIPLE_DECLARATION",
3060 ## "declaring multiple variables together should be avoided\n" . $herecurr);
3064 #need space before brace following if, while, etc
3065 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3067 if (ERROR("SPACING",
3068 "space required before the open brace '{'\n" . $herecurr) &&
3070 $fixed[$linenr - 1] =~ s/^(\+.*(?:do|\))){/$1 {/;
3074 ## # check for blank lines before declarations
3075 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3076 ## $prevrawline =~ /^.\s*$/) {
3078 ## "No blank lines before declarations\n" . $hereprev);
3082 # closing brace should have a space following it when it has anything
3084 if ($line =~ /}(?!(?:,|;|\)))\S/) {
3085 if (ERROR("SPACING",
3086 "space required after that close brace '}'\n" . $herecurr) &&
3088 $fixed[$linenr - 1] =~
3089 s/}((?!(?:,|;|\)))\S)/} $1/;
3093 # check spacing on square brackets
3094 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
3095 if (ERROR("SPACING",
3096 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3098 $fixed[$linenr - 1] =~
3102 if ($line =~ /\s\]/) {
3103 if (ERROR("SPACING",
3104 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3106 $fixed[$linenr - 1] =~
3111 # check spacing on parentheses
3112 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3113 $line !~ /for\s*\(\s+;/) {
3114 if (ERROR("SPACING",
3115 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3117 $fixed[$linenr - 1] =~
3121 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
3122 $line !~ /for\s*\(.*;\s+\)/ &&
3123 $line !~ /:\s+\)/) {
3124 if (ERROR("SPACING",
3125 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3127 $fixed[$linenr - 1] =~
3132 #goto labels aren't indented, allow a single space however
3133 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
3134 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
3135 if (WARN("INDENTED_LABEL",
3136 "labels should not be indented\n" . $herecurr) &&
3138 $fixed[$linenr - 1] =~
3143 # Return is not a function.
3144 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
3148 # Flatten any parentheses
3149 $value =~ s/\(/ \(/g;
3150 $value =~ s/\)/\) /g;
3151 while ($value =~ s/\[[^\[\]]*\]/1/ ||
3152 $value !~ /(?:$Ident|-?$Constant)\s*
3154 (?:$Ident|-?$Constant)/x &&
3155 $value =~ s/\([^\(\)]*\)/1/) {
3157 #print "value<$value>\n";
3158 if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
3159 ERROR("RETURN_PARENTHESES",
3160 "return is not a function, parentheses are not required\n" . $herecurr);
3162 } elsif ($spacing !~ /\s+/) {
3164 "space required before the open parenthesis '('\n" . $herecurr);
3167 # Return of what appears to be an errno should normally be -'ve
3168 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
3170 if ($name ne 'EOF' && $name ne 'ERROR') {
3171 WARN("USE_NEGATIVE_ERRNO",
3172 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
3176 # Need a space before open parenthesis after if, while etc
3177 if ($line =~ /\b(if|while|for|switch)\(/) {
3178 if (ERROR("SPACING",
3179 "space required before the open parenthesis '('\n" . $herecurr) &&
3181 $fixed[$linenr - 1] =~
3182 s/\b(if|while|for|switch)\(/$1 \(/;
3186 # Check for illegal assignment in if conditional -- and check for trailing
3187 # statements after the conditional.
3188 if ($line =~ /do\s*(?!{)/) {
3189 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3190 ctx_statement_block($linenr, $realcnt, 0)
3191 if (!defined $stat);
3192 my ($stat_next) = ctx_statement_block($line_nr_next,
3193 $remain_next, $off_next);
3194 $stat_next =~ s/\n./\n /g;
3195 ##print "stat<$stat> stat_next<$stat_next>\n";
3197 if ($stat_next =~ /^\s*while\b/) {
3198 # If the statement carries leading newlines,
3199 # then count those as offsets.
3201 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
3203 statement_rawlines($whitespace) - 1;
3205 $suppress_whiletrailers{$line_nr_next +
3209 if (!defined $suppress_whiletrailers{$linenr} &&
3210 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
3211 my ($s, $c) = ($stat, $cond);
3213 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
3214 ERROR("ASSIGN_IN_IF",
3215 "do not use assignment in if condition\n" . $herecurr);
3218 # Find out what is on the end of the line after the
3220 substr($s, 0, length($c), '');
3222 $s =~ s/$;//g; # Remove any comments
3223 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
3224 $c !~ /}\s*while\s*/)
3226 # Find out how long the conditional actually is.
3227 my @newlines = ($c =~ /\n/gs);
3228 my $cond_lines = 1 + $#newlines;
3231 $stat_real = raw_line($linenr, $cond_lines)
3232 . "\n" if ($cond_lines);
3233 if (defined($stat_real) && $cond_lines > 1) {
3234 $stat_real = "[...]\n$stat_real";
3237 ERROR("TRAILING_STATEMENTS",
3238 "trailing statements should be on next line\n" . $herecurr . $stat_real);
3242 # Check for bitwise tests written as boolean
3254 WARN("HEXADECIMAL_BOOLEAN_TEST",
3255 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
3258 # if and else should not have general statements after it
3259 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
3261 $s =~ s/$;//g; # Remove any comments
3262 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
3263 ERROR("TRAILING_STATEMENTS",
3264 "trailing statements should be on next line\n" . $herecurr);
3267 # if should not continue a brace
3268 if ($line =~ /}\s*if\b/) {
3269 ERROR("TRAILING_STATEMENTS",
3270 "trailing statements should be on next line\n" .
3273 # case and default should not have general statements after them
3274 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
3276 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
3280 ERROR("TRAILING_STATEMENTS",
3281 "trailing statements should be on next line\n" . $herecurr);
3284 # Check for }<nl>else {, these must be at the same
3285 # indent level to be relevant to each other.
3286 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
3287 $previndent == $indent) {
3288 ERROR("ELSE_AFTER_BRACE",
3289 "else should follow close brace '}'\n" . $hereprev);
3292 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
3293 $previndent == $indent) {
3294 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
3296 # Find out what is on the end of the line after the
3298 substr($s, 0, length($c), '');
3301 if ($s =~ /^\s*;/) {
3302 ERROR("WHILE_AFTER_BRACE",
3303 "while should follow close brace '}'\n" . $hereprev);
3307 #Specific variable tests
3308 while ($line =~ m{($Constant|$Lval)}g) {
3311 #gcc binary extension
3312 if ($var =~ /^$Binary$/) {
3313 if (WARN("GCC_BINARY_CONSTANT",
3314 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
3316 my $hexval = sprintf("0x%x", oct($var));
3317 $fixed[$linenr - 1] =~
3318 s/\b$var\b/$hexval/;
3323 if ($var !~ /^$Constant$/ &&
3324 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
3325 #Ignore Page<foo> variants
3326 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
3327 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
3328 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) {
3329 while ($var =~ m{($Ident)}g) {
3331 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
3332 seed_camelcase_includes() if ($check);
3333 if (!defined $camelcase{$word}) {
3334 $camelcase{$word} = 1;
3336 "Avoid CamelCase: <$word>\n" . $herecurr);
3342 #no spaces allowed after \ in define
3343 if ($line =~ /\#\s*define.*\\\s+$/) {
3344 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
3345 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
3347 $fixed[$linenr - 1] =~ s/\s+$//;
3351 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
3352 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
3354 my $checkfile = "include/linux/$file";
3355 if (-f "$root/$checkfile" &&
3356 $realfile ne $checkfile &&
3357 $1 !~ /$allowed_asm_includes/)
3359 if ($realfile =~ m{^arch/}) {
3360 CHK("ARCH_INCLUDE_LINUX",
3361 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
3363 WARN("INCLUDE_LINUX",
3364 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
3369 # multi-statement macros should be enclosed in a do while loop, grab the
3370 # first statement and ensure its the whole macro if its not enclosed
3371 # in a known good container
3372 if ($realfile !~ m@/vmlinux.lds.h$@ &&
3373 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
3376 my ($off, $dstat, $dcond, $rest);
3378 ($dstat, $dcond, $ln, $cnt, $off) =
3379 ctx_statement_block($linenr, $realcnt, 0);
3381 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
3382 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
3384 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
3386 $dstat =~ s/\\\n.//g;
3387 $dstat =~ s/^\s*//s;
3388 $dstat =~ s/\s*$//s;
3390 # Flatten any parentheses and braces
3391 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
3392 $dstat =~ s/\{[^\{\}]*\}/1/ ||
3393 $dstat =~ s/\[[^\[\]]*\]/1/)
3397 # Flatten any obvious string concatentation.
3398 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
3399 $dstat =~ s/$Ident\s*("X*")/$1/)
3403 my $exceptions = qr{
3415 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
3417 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
3418 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
3419 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
3420 $dstat !~ /^'X'$/ && # character constants
3421 $dstat !~ /$exceptions/ &&
3422 $dstat !~ /^\.$Ident\s*=/ && # .foo =
3423 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
3424 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
3425 $dstat !~ /^for\s*$Constant$/ && # for (...)
3426 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
3427 $dstat !~ /^do\s*{/ && # do {...
3428 $dstat !~ /^\({/) # ({...
3431 my $herectx = $here . "\n";
3432 my $cnt = statement_rawlines($ctx);
3434 for (my $n = 0; $n < $cnt; $n++) {
3435 $herectx .= raw_line($linenr, $n) . "\n";
3438 if ($dstat =~ /;/) {
3439 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
3440 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
3442 ERROR("COMPLEX_MACRO",
3443 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
3447 # check for line continuations outside of #defines, preprocessor #, and asm
3450 if ($prevline !~ /^..*\\$/ &&
3451 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
3452 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
3453 $line =~ /^\+.*\\$/) {
3454 WARN("LINE_CONTINUATIONS",
3455 "Avoid unnecessary line continuations\n" . $herecurr);
3459 # do {} while (0) macro tests:
3460 # single-statement macros do not need to be enclosed in do while (0) loop,
3461 # macro should not end with a semicolon
3462 if ($^V && $^V ge 5.10.0 &&
3463 $realfile !~ m@/vmlinux.lds.h$@ &&
3464 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
3467 my ($off, $dstat, $dcond, $rest);
3469 ($dstat, $dcond, $ln, $cnt, $off) =
3470 ctx_statement_block($linenr, $realcnt, 0);
3473 $dstat =~ s/\\\n.//g;
3475 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
3480 my $cnt = statement_rawlines($ctx);
3481 my $herectx = $here . "\n";
3483 for (my $n = 0; $n < $cnt; $n++) {
3484 $herectx .= raw_line($linenr, $n) . "\n";
3487 if (($stmts =~ tr/;/;/) == 1 &&
3488 $stmts !~ /^\s*(if|while|for|switch)\b/) {
3489 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
3490 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
3492 if (defined $semis && $semis ne "") {
3493 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
3494 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
3499 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3500 # all assignments may have only one of the following with an assignment:
3503 # VMLINUX_SYMBOL(...)
3504 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
3505 WARN("MISSING_VMLINUX_SYMBOL",
3506 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
3509 # check for redundant bracing round if etc
3510 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
3511 my ($level, $endln, @chunks) =
3512 ctx_statement_full($linenr, $realcnt, 1);
3513 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
3514 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3515 if ($#chunks > 0 && $level == 0) {
3519 my $herectx = $here . "\n";
3520 my $ln = $linenr - 1;
3521 for my $chunk (@chunks) {
3522 my ($cond, $block) = @{$chunk};
3524 # If the condition carries leading newlines, then count those as offsets.
3525 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
3526 my $offset = statement_rawlines($whitespace) - 1;
3528 $allowed[$allow] = 0;
3529 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3531 # We have looked at and allowed this specific line.
3532 $suppress_ifbraces{$ln + $offset} = 1;
3534 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
3535 $ln += statement_rawlines($block) - 1;
3537 substr($block, 0, length($cond), '');
3539 $seen++ if ($block =~ /^\s*{/);
3541 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
3542 if (statement_lines($cond) > 1) {
3543 #print "APW: ALLOWED: cond<$cond>\n";
3544 $allowed[$allow] = 1;
3546 if ($block =~/\b(?:if|for|while)\b/) {
3547 #print "APW: ALLOWED: block<$block>\n";
3548 $allowed[$allow] = 1;
3550 if (statement_block_size($block) > 1) {
3551 #print "APW: ALLOWED: lines block<$block>\n";
3552 $allowed[$allow] = 1;
3557 my $sum_allowed = 0;
3558 foreach (@allowed) {
3561 if ($sum_allowed == 0) {
3563 "braces {} are not necessary for any arm of this statement\n" . $herectx);
3564 } elsif ($sum_allowed != $allow &&
3567 "braces {} should be used on all arms of this statement\n" . $herectx);
3572 if (!defined $suppress_ifbraces{$linenr - 1} &&
3573 $line =~ /\b(if|while|for|else)\b/) {
3576 # Check the pre-context.
3577 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
3578 #print "APW: ALLOWED: pre<$1>\n";
3582 my ($level, $endln, @chunks) =
3583 ctx_statement_full($linenr, $realcnt, $-[0]);
3585 # Check the condition.
3586 my ($cond, $block) = @{$chunks[0]};
3587 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
3588 if (defined $cond) {
3589 substr($block, 0, length($cond), '');
3591 if (statement_lines($cond) > 1) {
3592 #print "APW: ALLOWED: cond<$cond>\n";
3595 if ($block =~/\b(?:if|for|while)\b/) {
3596 #print "APW: ALLOWED: block<$block>\n";
3599 if (statement_block_size($block) > 1) {
3600 #print "APW: ALLOWED: lines block<$block>\n";
3603 # Check the post-context.
3604 if (defined $chunks[1]) {
3605 my ($cond, $block) = @{$chunks[1]};
3606 if (defined $cond) {
3607 substr($block, 0, length($cond), '');
3609 if ($block =~ /^\s*\{/) {
3610 #print "APW: ALLOWED: chunk-1 block<$block>\n";
3614 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
3615 my $herectx = $here . "\n";
3616 my $cnt = statement_rawlines($block);
3618 for (my $n = 0; $n < $cnt; $n++) {
3619 $herectx .= raw_line($linenr, $n) . "\n";
3623 "braces {} are not necessary for single statement blocks\n" . $herectx);
3627 # check for unnecessary blank lines around braces
3628 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
3630 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
3632 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
3634 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
3637 # no volatiles please
3638 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
3639 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
3641 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
3645 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
3646 CHK("REDUNDANT_CODE",
3647 "if this code is redundant consider removing it\n" .
3651 # check for needless "if (<foo>) fn(<foo>)" uses
3652 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
3653 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
3654 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
3656 "$1(NULL) is safe this check is probably not required\n" . $hereprev);
3660 # prefer usleep_range over udelay
3661 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
3662 # ignore udelay's < 10, however
3665 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
3669 # warn about unexpectedly long msleep's
3670 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
3673 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
3677 # check for comparisons of jiffies
3678 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
3679 WARN("JIFFIES_COMPARISON",
3680 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
3683 # check for comparisons of get_jiffies_64()
3684 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
3685 WARN("JIFFIES_COMPARISON",
3686 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
3689 # warn about #ifdefs in C files
3690 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
3691 # print "#ifdef in C files should be avoided\n";
3692 # print "$herecurr";
3696 # warn about spacing in #ifdefs
3697 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
3698 if (ERROR("SPACING",
3699 "exactly one space required after that #$1\n" . $herecurr) &&
3701 $fixed[$linenr - 1] =~
3702 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
3707 # check for spinlock_t definitions without a comment.
3708 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
3709 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
3711 if (!ctx_has_comment($first_line, $linenr)) {
3712 CHK("UNCOMMENTED_DEFINITION",
3713 "$1 definition without comment\n" . $herecurr);
3716 # check for memory barriers without a comment.
3717 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
3718 if (!ctx_has_comment($first_line, $linenr)) {
3719 CHK("MEMORY_BARRIER",
3720 "memory barrier without comment\n" . $herecurr);
3723 # check of hardware specific defines
3724 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
3726 "architecture specific defines should be avoided\n" . $herecurr);
3729 # Check that the storage class is at the beginning of a declaration
3730 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
3731 WARN("STORAGE_CLASS",
3732 "storage class should be at the beginning of the declaration\n" . $herecurr)
3735 # check the location of the inline attribute, that it is between
3736 # storage class and type.
3737 if ($line =~ /\b$Type\s+$Inline\b/ ||
3738 $line =~ /\b$Inline\s+$Storage\b/) {
3739 ERROR("INLINE_LOCATION",
3740 "inline keyword should sit between storage class and type\n" . $herecurr);
3743 # Check for __inline__ and __inline, prefer inline
3744 if ($line =~ /\b(__inline__|__inline)\b/) {
3746 "plain inline is preferred over $1\n" . $herecurr) &&
3748 $fixed[$linenr - 1] =~ s/\b(__inline__|__inline)\b/inline/;
3753 # Check for __attribute__ packed, prefer __packed
3754 if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
3755 WARN("PREFER_PACKED",
3756 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
3759 # Check for __attribute__ aligned, prefer __aligned
3760 if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
3761 WARN("PREFER_ALIGNED",
3762 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
3765 # Check for __attribute__ format(printf, prefer __printf
3766 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
3767 if (WARN("PREFER_PRINTF",
3768 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
3770 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
3775 # Check for __attribute__ format(scanf, prefer __scanf
3776 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
3777 if (WARN("PREFER_SCANF",
3778 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
3780 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
3784 # check for sizeof(&)
3785 if ($line =~ /\bsizeof\s*\(\s*\&/) {
3786 WARN("SIZEOF_ADDRESS",
3787 "sizeof(& should be avoided\n" . $herecurr);
3790 # check for sizeof without parenthesis
3791 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
3792 if (WARN("SIZEOF_PARENTHESIS",
3793 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
3795 $fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
3799 # check for line continuations in quoted strings with odd counts of "
3800 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
3801 WARN("LINE_CONTINUATIONS",
3802 "Avoid line continuations in quoted strings\n" . $herecurr);
3805 # check for struct spinlock declarations
3806 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
3807 WARN("USE_SPINLOCK_T",
3808 "struct spinlock should be spinlock_t\n" . $herecurr);
3811 # check for seq_printf uses that could be seq_puts
3812 if ($line =~ /\bseq_printf\s*\(/) {
3813 my $fmt = get_quoted_string($line, $rawline);
3814 if ($fmt !~ /[^\\]\%/) {
3815 if (WARN("PREFER_SEQ_PUTS",
3816 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
3818 $fixed[$linenr - 1] =~ s/\bseq_printf\b/seq_puts/;
3823 # Check for misused memsets
3824 if ($^V && $^V ge 5.10.0 &&
3826 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
3832 if ($ms_size =~ /^(0x|)0$/i) {
3834 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
3835 } elsif ($ms_size =~ /^(0x|)1$/i) {
3837 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
3841 # typecasts on min/max could be min_t/max_t
3842 if ($^V && $^V ge 5.10.0 &&
3844 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
3845 if (defined $2 || defined $7) {
3847 my $cast1 = deparenthesize($2);
3849 my $cast2 = deparenthesize($7);
3853 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
3854 $cast = "$cast1 or $cast2";
3855 } elsif ($cast1 ne "") {
3861 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
3865 # check usleep_range arguments
3866 if ($^V && $^V ge 5.10.0 &&
3868 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
3872 WARN("USLEEP_RANGE",
3873 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
3874 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
3876 WARN("USLEEP_RANGE",
3877 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
3881 # check for new externs in .h files.
3882 if ($realfile =~ /\.h$/ &&
3883 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
3884 if (WARN("AVOID_EXTERNS",
3885 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
3887 $fixed[$linenr - 1] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
3891 # check for new externs in .c files.
3892 if ($realfile =~ /\.c$/ && defined $stat &&
3893 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
3895 my $function_name = $1;
3896 my $paren_space = $2;
3899 if (defined $cond) {
3900 substr($s, 0, length($cond), '');
3902 if ($s =~ /^\s*;/ &&
3903 $function_name ne 'uninitialized_var')
3905 WARN("AVOID_EXTERNS",
3906 "externs should be avoided in .c files\n" . $herecurr);
3909 if ($paren_space =~ /\n/) {
3910 WARN("FUNCTION_ARGUMENTS",
3911 "arguments for function declarations should follow identifier\n" . $herecurr);
3914 } elsif ($realfile =~ /\.c$/ && defined $stat &&
3915 $stat =~ /^.\s*extern\s+/)
3917 WARN("AVOID_EXTERNS",
3918 "externs should be avoided in .c files\n" . $herecurr);
3921 # checks for new __setup's
3922 if ($rawline =~ /\b__setup\("([^"]*)"/) {
3925 if (!grep(/$name/, @setup_docs)) {
3926 CHK("UNDOCUMENTED_SETUP",
3927 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
3931 # check for pointless casting of kmalloc return
3932 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
3933 WARN("UNNECESSARY_CASTS",
3934 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
3938 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
3939 if ($^V && $^V ge 5.10.0 &&
3940 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
3941 CHK("ALLOC_SIZEOF_STRUCT",
3942 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
3945 # check for krealloc arg reuse
3946 if ($^V && $^V ge 5.10.0 &&
3947 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
3948 WARN("KREALLOC_ARG_REUSE",
3949 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
3952 # check for alloc argument mismatch
3953 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
3954 WARN("ALLOC_ARRAY_ARGS",
3955 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
3958 # check for multiple semicolons
3959 if ($line =~ /;\s*;\s*$/) {
3960 if (WARN("ONE_SEMICOLON",
3961 "Statements terminations use 1 semicolon\n" . $herecurr) &&
3963 $fixed[$linenr - 1] =~ s/(\s*;\s*){2,}$/;/g;
3967 # check for switch/default statements without a break;
3968 if ($^V && $^V ge 5.10.0 &&
3970 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
3972 my $herectx = $here . "\n";
3973 my $cnt = statement_rawlines($stat);
3974 for (my $n = 0; $n < $cnt; $n++) {
3975 $herectx .= raw_line($linenr, $n) . "\n";
3977 WARN("DEFAULT_NO_BREAK",
3978 "switch default: should use break\n" . $herectx);
3981 # check for gcc specific __FUNCTION__
3982 if ($line =~ /\b__FUNCTION__\b/) {
3983 if (WARN("USE_FUNC",
3984 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
3986 $fixed[$linenr - 1] =~ s/\b__FUNCTION__\b/__func__/g;
3990 # check for use of yield()
3991 if ($line =~ /\byield\s*\(\s*\)/) {
3993 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
3996 # check for comparisons against true and false
3997 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
4005 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
4007 my $type = lc($otype);
4008 if ($type =~ /^(?:true|false)$/) {
4009 if (("$test" eq "==" && "$type" eq "true") ||
4010 ("$test" eq "!=" && "$type" eq "false")) {
4014 CHK("BOOL_COMPARISON",
4015 "Using comparison to $otype is error prone\n" . $herecurr);
4017 ## maybe suggesting a correct construct would better
4018 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
4023 # check for semaphores initialized locked
4024 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
4025 WARN("CONSIDER_COMPLETION",
4026 "consider using a completion\n" . $herecurr);
4029 # recommend kstrto* over simple_strto* and strict_strto*
4030 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
4031 WARN("CONSIDER_KSTRTO",
4032 "$1 is obsolete, use k$3 instead\n" . $herecurr);
4035 # check for __initcall(), use device_initcall() explicitly please
4036 if ($line =~ /^.\s*__initcall\s*\(/) {
4037 WARN("USE_DEVICE_INITCALL",
4038 "please use device_initcall() instead of __initcall()\n" . $herecurr);
4041 # check for various ops structs, ensure they are const.
4042 my $struct_ops = qr{acpi_dock_ops|
4043 address_space_operations|
4045 block_device_operations|
4050 file_lock_operations|
4060 lock_manager_operations|
4066 pipe_buf_operations|
4067 platform_hibernation_ops|
4068 platform_suspend_ops|
4073 soc_pcmcia_socket_ops|
4079 if ($line !~ /\bconst\b/ &&
4080 $line =~ /\bstruct\s+($struct_ops)\b/) {
4081 WARN("CONST_STRUCT",
4082 "struct $1 should normally be const\n" .
4086 # use of NR_CPUS is usually wrong
4087 # ignore definitions of NR_CPUS and usage to define arrays as likely right
4088 if ($line =~ /\bNR_CPUS\b/ &&
4089 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
4090 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
4091 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
4092 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
4093 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
4096 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
4099 # check for %L{u,d,i} in strings
4101 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4102 $string = substr($rawline, $-[1], $+[1] - $-[1]);
4103 $string =~ s/%%/__/g;
4104 if ($string =~ /(?<!%)%L[udi]/) {
4106 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
4111 # whine mightly about in_atomic
4112 if ($line =~ /\bin_atomic\s*\(/) {
4113 if ($realfile =~ m@^drivers/@) {
4115 "do not use in_atomic in drivers\n" . $herecurr);
4116 } elsif ($realfile !~ m@^kernel/@) {
4118 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
4122 # check for lockdep_set_novalidate_class
4123 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
4124 $line =~ /__lockdep_no_validate__\s*\)/ ) {
4125 if ($realfile !~ m@^kernel/lockdep@ &&
4126 $realfile !~ m@^include/linux/lockdep@ &&
4127 $realfile !~ m@^drivers/base/core@) {
4129 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
4133 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
4134 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
4135 WARN("EXPORTED_WORLD_WRITABLE",
4136 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
4140 # If we have no input at all, then there is nothing to report on
4141 # so just keep quiet.
4142 if ($#rawlines == -1) {
4146 # In mailback mode only produce a report in the negative, for
4147 # things that appear to be patches.
4148 if ($mailback && ($clean == 1 || !$is_patch)) {
4152 # This is not a patch, and we are are in 'no-patch' mode so
4154 if (!$chk_patch && !$is_patch) {
4159 ERROR("NOT_UNIFIED_DIFF",
4160 "Does not appear to be a unified-diff format patch\n");
4162 if ($is_patch && $chk_signoff && $signoff == 0) {
4163 ERROR("MISSING_SIGN_OFF",
4164 "Missing Signed-off-by: line(s)\n");
4167 print report_dump();
4168 if ($summary && !($clean == 1 && $quiet == 1)) {
4169 print "$filename " if ($summary_file);
4170 print "total: $cnt_error errors, $cnt_warn warnings, " .
4171 (($check)? "$cnt_chk checks, " : "") .
4172 "$cnt_lines lines checked\n";
4173 print "\n" if ($quiet == 0);
4178 if ($^V lt 5.10.0) {
4179 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
4180 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
4183 # If there were whitespace errors which cleanpatch can fix
4184 # then suggest that.
4185 if ($rpt_cleaners) {
4186 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
4187 print " scripts/cleanfile\n\n";
4192 if ($quiet == 0 && keys %ignore_type) {
4193 print "NOTE: Ignored message types:";
4194 foreach my $ignore (sort keys %ignore_type) {
4200 if ($clean == 0 && $fix && "@rawlines" ne "@fixed") {
4201 my $newfile = $filename . ".EXPERIMENTAL-checkpatch-fixes";
4205 open($f, '>', $newfile)
4206 or die "$P: Can't open $newfile for write\n";
4207 foreach my $fixed_line (@fixed) {
4210 if ($linecount > 3) {
4211 $fixed_line =~ s/^\+//;
4212 print $f $fixed_line. "\n";
4215 print $f $fixed_line . "\n";
4222 Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
4224 Do _NOT_ trust the results written to this file.
4225 Do _NOT_ submit these changes without inspecting them for correctness.
4227 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
4228 No warranties, expressed or implied...
4234 if ($clean == 1 && $quiet == 0) {
4235 print "$vname has no obvious style problems and is ready for submission.\n"
4237 if ($clean == 0 && $quiet == 0) {
4239 $vname has style problems, please review.
4241 If any of these errors are false positives, please report
4242 them to the maintainer, see CHECKPATCH in MAINTAINERS.