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);
41 my $configuration_file = ".checkpatch.conf";
42 my $max_line_length = 80;
43 my $ignore_perl_version = 0;
44 my $minimum_perl_version = 5.10.0;
50 Usage: $P [OPTION]... [FILE]...
55 --no-tree run without a kernel tree
56 --no-signoff do not check for 'Signed-off-by' line
57 --patch treat FILE as patchfile (default)
58 --emacs emacs compile window format
59 --terse one line per report
60 -f, --file treat FILE as regular source file
61 --subjective, --strict enable more subjective tests
62 --types TYPE(,TYPE2...) show only these comma separated message types
63 --ignore TYPE(,TYPE2...) ignore various comma separated message types
64 --max-line-length=n set the maximum line length, if exceeded, warn
65 --show-types show the message "types" in the output
66 --root=PATH PATH to the kernel tree root
67 --no-summary suppress the per-file summary
68 --mailback only produce a report in case of warnings/errors
69 --summary-file include the filename in summary
70 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
71 'values', 'possible', 'type', and 'attr' (default
73 --test-only=WORD report only warnings/errors containing WORD
75 --fix EXPERIMENTAL - may create horrible results
76 If correctable single-line errors exist, create
77 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
78 with potential errors corrected to the preferred
80 --fix-inplace EXPERIMENTAL - may create horrible results
81 Is the same as --fix, but overwrites the input
82 file. It's your fault if there's no backup or git
83 --ignore-perl-version override checking of perl version. expect
85 -h, --help, --version display this help and exit
87 When FILE is - read standard input.
93 my $conf = which_conf($configuration_file);
96 open(my $conffile, '<', "$conf")
97 or warn "$P: Can't find a readable $configuration_file file $!\n";
102 $line =~ s/\s*\n?$//g;
106 next if ($line =~ m/^\s*#/);
107 next if ($line =~ m/^\s*$/);
109 my @words = split(" ", $line);
110 foreach my $word (@words) {
111 last if ($word =~ m/^#/);
112 push (@conf_args, $word);
116 unshift(@ARGV, @conf_args) if @conf_args;
120 'q|quiet+' => \$quiet,
122 'signoff!' => \$chk_signoff,
123 'patch!' => \$chk_patch,
127 'subjective!' => \$check,
128 'strict!' => \$check,
129 'ignore=s' => \@ignore,
131 'show-types!' => \$show_types,
132 'max-line-length=i' => \$max_line_length,
134 'summary!' => \$summary,
135 'mailback!' => \$mailback,
136 'summary-file!' => \$summary_file,
138 'fix-inplace!' => \$fix_inplace,
139 'ignore-perl-version!' => \$ignore_perl_version,
140 'debug=s' => \%debug,
141 'test-only=s' => \$tst_only,
148 $fix = 1 if ($fix_inplace);
152 if ($^V && $^V lt $minimum_perl_version) {
153 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
154 if (!$ignore_perl_version) {
160 print "$P: no input files\n";
164 sub hash_save_array_words {
165 my ($hashRef, $arrayRef) = @_;
167 my @array = split(/,/, join(',', @$arrayRef));
168 foreach my $word (@array) {
169 $word =~ s/\s*\n?$//g;
172 $word =~ tr/[a-z]/[A-Z]/;
174 next if ($word =~ m/^\s*#/);
175 next if ($word =~ m/^\s*$/);
181 sub hash_show_words {
182 my ($hashRef, $prefix) = @_;
184 if ($quiet == 0 && keys %$hashRef) {
185 print "NOTE: $prefix message types:";
186 foreach my $word (sort keys %$hashRef) {
193 hash_save_array_words(\%ignore_type, \@ignore);
194 hash_save_array_words(\%use_type, \@use);
197 my $dbg_possible = 0;
200 for my $key (keys %debug) {
202 eval "\${dbg_$key} = '$debug{$key}';";
206 my $rpt_cleaners = 0;
215 if (!top_of_kernel_tree($root)) {
216 die "$P: $root: --root does not point at a valid tree\n";
219 if (top_of_kernel_tree('.')) {
221 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
222 top_of_kernel_tree($1)) {
227 if (!defined $root) {
228 print "Must be run from the top-level dir. of a kernel tree\n";
233 my $emitted_corrupt = 0;
236 [A-Za-z_][A-Za-z\d_]*
237 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
239 our $Storage = qr{extern|static|asmlinkage};
251 our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
252 our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
253 our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
254 our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
255 our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
257 # Notes to $Attribute:
258 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
278 ____cacheline_aligned|
279 ____cacheline_aligned_in_smp|
280 ____cacheline_internodealigned_in_smp|
284 our $Inline = qr{inline|__always_inline|noinline};
285 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
286 our $Lval = qr{$Ident(?:$Member)*};
288 our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
289 our $Binary = qr{(?i)0b[01]+$Int_type?};
290 our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
291 our $Int = qr{[0-9]+$Int_type?};
292 our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
293 our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
294 our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
295 our $Float = qr{$Float_hex|$Float_dec|$Float_int};
296 our $Constant = qr{$Float|$Binary|$Hex|$Int};
297 our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
298 our $Compare = qr{<=|>=|==|!=|<|>};
299 our $Arithmetic = qr{\+|-|\*|\/|%};
303 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
307 our $NonptrTypeWithAttr;
311 our $NON_ASCII_UTF8 = qr{
312 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
313 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
314 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
315 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
316 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
317 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
318 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
322 [\x09\x0A\x0D\x20-\x7E] # ASCII
326 our $typeTypedefs = qr{(?x:
327 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
331 our $logFunctions = qr{(?x:
332 printk(?:_ratelimited|_once|)|
333 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
334 WARN(?:_RATELIMIT|_ONCE|)|
337 seq_vprintf|seq_printf|seq_puts
340 our $signature_tags = qr{(?xi:
353 qr{(?:unsigned\s+)?char},
354 qr{(?:unsigned\s+)?short},
355 qr{(?:unsigned\s+)?int},
356 qr{(?:unsigned\s+)?long},
357 qr{(?:unsigned\s+)?long\s+int},
358 qr{(?:unsigned\s+)?long\s+long},
359 qr{(?:unsigned\s+)?long\s+long\s+int},
368 qr{${Ident}_handler},
369 qr{${Ident}_handler_fn},
371 our @typeListWithAttr = (
373 qr{struct\s+$InitAttribute\s+$Ident},
374 qr{union\s+$InitAttribute\s+$Ident},
377 our @modifierList = (
381 our $allowed_asm_includes = qr{(?x:
385 # memory.h: ARM has a custom one
388 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
389 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
390 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
391 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
393 (?:$Modifier\s+|const\s+)*
395 (?:typeof|__typeof__)\s*\([^\)]*\)|
399 (?:\s+$Modifier|\s+const)*
401 $NonptrTypeWithAttr = qr{
402 (?:$Modifier\s+|const\s+)*
404 (?:typeof|__typeof__)\s*\([^\)]*\)|
408 (?:\s+$Modifier|\s+const)*
412 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*|\[\])+|(?:\s*\[\s*\])+)?
413 (?:\s+$Inline|\s+$Modifier)*
415 $Declare = qr{(?:$Storage\s+)?$Type};
419 our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
421 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
422 # requires at least perl version v5.10.0
423 # Any use must be runtime checked with $^V
425 our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
426 our $LvalOrFunc = qr{($Lval)\s*($balanced_parens{0,1})\s*};
427 our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
431 return "" if (!defined($string));
432 $string =~ s@^\s*\(\s*@@g;
433 $string =~ s@\s*\)\s*$@@g;
434 $string =~ s@\s+@ @g;
438 sub seed_camelcase_file {
441 return if (!(-f $file));
445 open(my $include_file, '<', "$file")
446 or warn "$P: Can't read '$file' $!\n";
447 my $text = <$include_file>;
448 close($include_file);
450 my @lines = split('\n', $text);
452 foreach my $line (@lines) {
453 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
454 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
456 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
458 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
464 my $camelcase_seeded = 0;
465 sub seed_camelcase_includes {
466 return if ($camelcase_seeded);
469 my $camelcase_cache = "";
470 my @include_files = ();
472 $camelcase_seeded = 1;
475 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
476 chomp $git_last_include_commit;
477 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
479 my $last_mod_date = 0;
480 $files = `find $root/include -name "*.h"`;
481 @include_files = split('\n', $files);
482 foreach my $file (@include_files) {
483 my $date = POSIX::strftime("%Y%m%d%H%M",
484 localtime((stat $file)[9]));
485 $last_mod_date = $date if ($last_mod_date < $date);
487 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
490 if ($camelcase_cache ne "" && -f $camelcase_cache) {
491 open(my $camelcase_file, '<', "$camelcase_cache")
492 or warn "$P: Can't read '$camelcase_cache' $!\n";
493 while (<$camelcase_file>) {
497 close($camelcase_file);
503 $files = `git ls-files "include/*.h"`;
504 @include_files = split('\n', $files);
507 foreach my $file (@include_files) {
508 seed_camelcase_file($file);
511 if ($camelcase_cache ne "") {
512 unlink glob ".checkpatch-camelcase.*";
513 open(my $camelcase_file, '>', "$camelcase_cache")
514 or warn "$P: Can't write '$camelcase_cache' $!\n";
515 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
516 print $camelcase_file ("$_\n");
518 close($camelcase_file);
522 $chk_signoff = 0 if ($file);
528 for my $filename (@ARGV) {
531 open($FILE, '-|', "diff -u /dev/null $filename") ||
532 die "$P: $filename: diff failed - $!\n";
533 } elsif ($filename eq '-') {
534 open($FILE, '<&STDIN');
536 open($FILE, '<', "$filename") ||
537 die "$P: $filename: open failed - $!\n";
539 if ($filename eq '-') {
540 $vname = 'Your patch';
549 if (!process($filename)) {
559 sub top_of_kernel_tree {
563 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
564 "README", "Documentation", "arch", "include", "drivers",
565 "fs", "init", "ipc", "kernel", "lib", "scripts",
568 foreach my $check (@tree_check) {
569 if (! -e $root . '/' . $check) {
577 my ($formatted_email) = @_;
583 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
586 $comment = $3 if defined $3;
587 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
589 $comment = $2 if defined $2;
590 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
592 $comment = $2 if defined $2;
593 $formatted_email =~ s/$address.*$//;
594 $name = $formatted_email;
596 $name =~ s/^\"|\"$//g;
597 # If there's a name left after stripping spaces and
598 # leading quotes, and the address doesn't have both
599 # leading and trailing angle brackets, the address
601 # "joe smith joe@smith.com" bad
602 # "joe smith <joe@smith.com" bad
603 if ($name ne "" && $address !~ /^<[^>]+>$/) {
611 $name =~ s/^\"|\"$//g;
612 $address = trim($address);
613 $address =~ s/^\<|\>$//g;
615 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
616 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
620 return ($name, $address, $comment);
624 my ($name, $address) = @_;
629 $name =~ s/^\"|\"$//g;
630 $address = trim($address);
632 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
633 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
638 $formatted_email = "$address";
640 $formatted_email = "$name <$address>";
643 return $formatted_email;
649 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
650 if (-e "$path/$conf") {
651 return "$path/$conf";
663 for my $c (split(//, $str)) {
667 for (; ($n % 8) != 0; $n++) {
679 (my $res = shift) =~ tr/\t/ /c;
686 # Drop the diff line leader and expand tabs
688 $line = expand_tabs($line);
690 # Pick the indent from the front of the line.
691 my ($white) = ($line =~ /^(\s*)/);
693 return (length($line), length($white));
696 my $sanitise_quote = '';
698 sub sanitise_line_reset {
699 my ($in_comment) = @_;
702 $sanitise_quote = '*/';
704 $sanitise_quote = '';
717 # Always copy over the diff marker.
718 $res = substr($line, 0, 1);
720 for ($off = 1; $off < length($line); $off++) {
721 $c = substr($line, $off, 1);
723 # Comments we are wacking completly including the begin
724 # and end, all to $;.
725 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
726 $sanitise_quote = '*/';
728 substr($res, $off, 2, "$;$;");
732 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
733 $sanitise_quote = '';
734 substr($res, $off, 2, "$;$;");
738 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
739 $sanitise_quote = '//';
741 substr($res, $off, 2, $sanitise_quote);
746 # A \ in a string means ignore the next character.
747 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
749 substr($res, $off, 2, 'XX');
754 if ($c eq "'" || $c eq '"') {
755 if ($sanitise_quote eq '') {
756 $sanitise_quote = $c;
758 substr($res, $off, 1, $c);
760 } elsif ($sanitise_quote eq $c) {
761 $sanitise_quote = '';
765 #print "c<$c> SQ<$sanitise_quote>\n";
766 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
767 substr($res, $off, 1, $;);
768 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
769 substr($res, $off, 1, $;);
770 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
771 substr($res, $off, 1, 'X');
773 substr($res, $off, 1, $c);
777 if ($sanitise_quote eq '//') {
778 $sanitise_quote = '';
781 # The pathname on a #include may be surrounded by '<' and '>'.
782 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
783 my $clean = 'X' x length($1);
784 $res =~ s@\<.*\>@<$clean>@;
786 # The whole of a #error is a string.
787 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
788 my $clean = 'X' x length($1);
789 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
795 sub get_quoted_string {
796 my ($line, $rawline) = @_;
798 return "" if ($line !~ m/(\"[X]+\")/g);
799 return substr($rawline, $-[0], $+[0] - $-[0]);
802 sub ctx_statement_block {
803 my ($linenr, $remain, $off) = @_;
804 my $line = $linenr - 1;
821 @stack = (['', 0]) if ($#stack == -1);
823 #warn "CSB: blk<$blk> remain<$remain>\n";
824 # If we are about to drop off the end, pull in more
827 for (; $remain > 0; $line++) {
828 last if (!defined $lines[$line]);
829 next if ($lines[$line] =~ /^-/);
832 $blk .= $lines[$line] . "\n";
837 # Bail if there is no further context.
838 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
842 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
848 $c = substr($blk, $off, 1);
849 $remainder = substr($blk, $off);
851 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
853 # Handle nested #if/#else.
854 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
855 push(@stack, [ $type, $level ]);
856 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
857 ($type, $level) = @{$stack[$#stack - 1]};
858 } elsif ($remainder =~ /^#\s*endif\b/) {
859 ($type, $level) = @{pop(@stack)};
862 # Statement ends at the ';' or a close '}' at the
864 if ($level == 0 && $c eq ';') {
868 # An else is really a conditional as long as its not else if
869 if ($level == 0 && $coff_set == 0 &&
870 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
871 $remainder =~ /^(else)(?:\s|{)/ &&
872 $remainder !~ /^else\s+if\b/) {
873 $coff = $off + length($1) - 1;
875 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
876 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
879 if (($type eq '' || $type eq '(') && $c eq '(') {
883 if ($type eq '(' && $c eq ')') {
885 $type = ($level != 0)? '(' : '';
887 if ($level == 0 && $coff < $soff) {
890 #warn "CSB: mark coff<$coff>\n";
893 if (($type eq '' || $type eq '{') && $c eq '{') {
897 if ($type eq '{' && $c eq '}') {
899 $type = ($level != 0)? '{' : '';
902 if (substr($blk, $off + 1, 1) eq ';') {
908 # Preprocessor commands end at the newline unless escaped.
909 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
917 # We are truly at the end, so shuffle to the next line.
924 my $statement = substr($blk, $soff, $off - $soff + 1);
925 my $condition = substr($blk, $soff, $coff - $soff + 1);
927 #warn "STATEMENT<$statement>\n";
928 #warn "CONDITION<$condition>\n";
930 #print "coff<$coff> soff<$off> loff<$loff>\n";
932 return ($statement, $condition,
933 $line, $remain + 1, $off - $loff + 1, $level);
936 sub statement_lines {
939 # Strip the diff line prefixes and rip blank lines at start and end.
940 $stmt =~ s/(^|\n)./$1/g;
944 my @stmt_lines = ($stmt =~ /\n/g);
946 return $#stmt_lines + 2;
949 sub statement_rawlines {
952 my @stmt_lines = ($stmt =~ /\n/g);
954 return $#stmt_lines + 2;
957 sub statement_block_size {
960 $stmt =~ s/(^|\n)./$1/g;
966 my @stmt_lines = ($stmt =~ /\n/g);
967 my @stmt_statements = ($stmt =~ /;/g);
969 my $stmt_lines = $#stmt_lines + 2;
970 my $stmt_statements = $#stmt_statements + 1;
972 if ($stmt_lines > $stmt_statements) {
975 return $stmt_statements;
979 sub ctx_statement_full {
980 my ($linenr, $remain, $off) = @_;
981 my ($statement, $condition, $level);
985 # Grab the first conditional/block pair.
986 ($statement, $condition, $linenr, $remain, $off, $level) =
987 ctx_statement_block($linenr, $remain, $off);
988 #print "F: c<$condition> s<$statement> remain<$remain>\n";
989 push(@chunks, [ $condition, $statement ]);
990 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
991 return ($level, $linenr, @chunks);
994 # Pull in the following conditional/block pairs and see if they
995 # could continue the statement.
997 ($statement, $condition, $linenr, $remain, $off, $level) =
998 ctx_statement_block($linenr, $remain, $off);
999 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1000 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1002 push(@chunks, [ $condition, $statement ]);
1005 return ($level, $linenr, @chunks);
1009 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1011 my $start = $linenr - 1;
1018 my @stack = ($level);
1019 for ($line = $start; $remain > 0; $line++) {
1020 next if ($rawlines[$line] =~ /^-/);
1023 $blk .= $rawlines[$line];
1025 # Handle nested #if/#else.
1026 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1027 push(@stack, $level);
1028 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1029 $level = $stack[$#stack - 1];
1030 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1031 $level = pop(@stack);
1034 foreach my $c (split(//, $lines[$line])) {
1035 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1041 if ($c eq $close && $level > 0) {
1043 last if ($level == 0);
1044 } elsif ($c eq $open) {
1049 if (!$outer || $level <= 1) {
1050 push(@res, $rawlines[$line]);
1053 last if ($level == 0);
1056 return ($level, @res);
1058 sub ctx_block_outer {
1059 my ($linenr, $remain) = @_;
1061 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1065 my ($linenr, $remain) = @_;
1067 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1071 my ($linenr, $remain, $off) = @_;
1073 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1076 sub ctx_block_level {
1077 my ($linenr, $remain) = @_;
1079 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1081 sub ctx_statement_level {
1082 my ($linenr, $remain, $off) = @_;
1084 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1087 sub ctx_locate_comment {
1088 my ($first_line, $end_line) = @_;
1090 # Catch a comment on the end of the line itself.
1091 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1092 return $current_comment if (defined $current_comment);
1094 # Look through the context and try and figure out if there is a
1097 $current_comment = '';
1098 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1099 my $line = $rawlines[$linenr - 1];
1101 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1104 if ($line =~ m@/\*@) {
1107 if (!$in_comment && $current_comment ne '') {
1108 $current_comment = '';
1110 $current_comment .= $line . "\n" if ($in_comment);
1111 if ($line =~ m@\*/@) {
1116 chomp($current_comment);
1117 return($current_comment);
1119 sub ctx_has_comment {
1120 my ($first_line, $end_line) = @_;
1121 my $cmt = ctx_locate_comment($first_line, $end_line);
1123 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1124 ##print "CMMT: $cmt\n";
1126 return ($cmt ne '');
1130 my ($linenr, $cnt) = @_;
1132 my $offset = $linenr - 1;
1137 $line = $rawlines[$offset++];
1138 next if (defined($line) && $line =~ /^-/);
1150 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1153 $coded = sprintf("^%c", unpack('C', $2) + 64);
1162 my $av_preprocessor = 0;
1167 sub annotate_reset {
1168 $av_preprocessor = 0;
1170 @av_paren_type = ('E');
1171 $av_pend_colon = 'O';
1174 sub annotate_values {
1175 my ($stream, $type) = @_;
1178 my $var = '_' x length($stream);
1181 print "$stream\n" if ($dbg_values > 1);
1183 while (length($cur)) {
1184 @av_paren_type = ('E') if ($#av_paren_type < 0);
1185 print " <" . join('', @av_paren_type) .
1186 "> <$type> <$av_pending>" if ($dbg_values > 1);
1187 if ($cur =~ /^(\s+)/o) {
1188 print "WS($1)\n" if ($dbg_values > 1);
1189 if ($1 =~ /\n/ && $av_preprocessor) {
1190 $type = pop(@av_paren_type);
1191 $av_preprocessor = 0;
1194 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1195 print "CAST($1)\n" if ($dbg_values > 1);
1196 push(@av_paren_type, $type);
1199 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1200 print "DECLARE($1)\n" if ($dbg_values > 1);
1203 } elsif ($cur =~ /^($Modifier)\s*/) {
1204 print "MODIFIER($1)\n" if ($dbg_values > 1);
1207 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1208 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1209 $av_preprocessor = 1;
1210 push(@av_paren_type, $type);
1216 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1217 print "UNDEF($1)\n" if ($dbg_values > 1);
1218 $av_preprocessor = 1;
1219 push(@av_paren_type, $type);
1221 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1222 print "PRE_START($1)\n" if ($dbg_values > 1);
1223 $av_preprocessor = 1;
1225 push(@av_paren_type, $type);
1226 push(@av_paren_type, $type);
1229 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1230 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1231 $av_preprocessor = 1;
1233 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1237 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1238 print "PRE_END($1)\n" if ($dbg_values > 1);
1240 $av_preprocessor = 1;
1242 # Assume all arms of the conditional end as this
1243 # one does, and continue as if the #endif was not here.
1244 pop(@av_paren_type);
1245 push(@av_paren_type, $type);
1248 } elsif ($cur =~ /^(\\\n)/o) {
1249 print "PRECONT($1)\n" if ($dbg_values > 1);
1251 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1252 print "ATTR($1)\n" if ($dbg_values > 1);
1253 $av_pending = $type;
1256 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1257 print "SIZEOF($1)\n" if ($dbg_values > 1);
1263 } elsif ($cur =~ /^(if|while|for)\b/o) {
1264 print "COND($1)\n" if ($dbg_values > 1);
1268 } elsif ($cur =~/^(case)/o) {
1269 print "CASE($1)\n" if ($dbg_values > 1);
1270 $av_pend_colon = 'C';
1273 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1274 print "KEYWORD($1)\n" if ($dbg_values > 1);
1277 } elsif ($cur =~ /^(\()/o) {
1278 print "PAREN('$1')\n" if ($dbg_values > 1);
1279 push(@av_paren_type, $av_pending);
1283 } elsif ($cur =~ /^(\))/o) {
1284 my $new_type = pop(@av_paren_type);
1285 if ($new_type ne '_') {
1287 print "PAREN('$1') -> $type\n"
1288 if ($dbg_values > 1);
1290 print "PAREN('$1')\n" if ($dbg_values > 1);
1293 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1294 print "FUNC($1)\n" if ($dbg_values > 1);
1298 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1299 if (defined $2 && $type eq 'C' || $type eq 'T') {
1300 $av_pend_colon = 'B';
1301 } elsif ($type eq 'E') {
1302 $av_pend_colon = 'L';
1304 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1307 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1308 print "IDENT($1)\n" if ($dbg_values > 1);
1311 } elsif ($cur =~ /^($Assignment)/o) {
1312 print "ASSIGN($1)\n" if ($dbg_values > 1);
1315 } elsif ($cur =~/^(;|{|})/) {
1316 print "END($1)\n" if ($dbg_values > 1);
1318 $av_pend_colon = 'O';
1320 } elsif ($cur =~/^(,)/) {
1321 print "COMMA($1)\n" if ($dbg_values > 1);
1324 } elsif ($cur =~ /^(\?)/o) {
1325 print "QUESTION($1)\n" if ($dbg_values > 1);
1328 } elsif ($cur =~ /^(:)/o) {
1329 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1331 substr($var, length($res), 1, $av_pend_colon);
1332 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1337 $av_pend_colon = 'O';
1339 } elsif ($cur =~ /^(\[)/o) {
1340 print "CLOSE($1)\n" if ($dbg_values > 1);
1343 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1346 print "OPV($1)\n" if ($dbg_values > 1);
1353 substr($var, length($res), 1, $variant);
1356 } elsif ($cur =~ /^($Operators)/o) {
1357 print "OP($1)\n" if ($dbg_values > 1);
1358 if ($1 ne '++' && $1 ne '--') {
1362 } elsif ($cur =~ /(^.)/o) {
1363 print "C($1)\n" if ($dbg_values > 1);
1366 $cur = substr($cur, length($1));
1367 $res .= $type x length($1);
1371 return ($res, $var);
1375 my ($possible, $line) = @_;
1376 my $notPermitted = qr{(?:
1393 ^(?:typedef|struct|enum)\b
1395 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1396 if ($possible !~ $notPermitted) {
1397 # Check for modifiers.
1398 $possible =~ s/\s*$Storage\s*//g;
1399 $possible =~ s/\s*$Sparse\s*//g;
1400 if ($possible =~ /^\s*$/) {
1402 } elsif ($possible =~ /\s/) {
1403 $possible =~ s/\s*$Type\s*//g;
1404 for my $modifier (split(' ', $possible)) {
1405 if ($modifier !~ $notPermitted) {
1406 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1407 push(@modifierList, $modifier);
1412 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1413 push(@typeList, $possible);
1417 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1424 return defined $use_type{$_[0]} if (scalar keys %use_type > 0);
1426 return !defined $ignore_type{$_[0]};
1430 if (!show_type($_[1]) ||
1431 (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) {
1436 $line = "$prefix$_[0]:$_[1]: $_[2]\n";
1438 $line = "$prefix$_[0]: $_[2]\n";
1440 $line = (split('\n', $line))[0] . "\n" if ($terse);
1442 push(our @report, $line);
1451 if (report("ERROR", $_[0], $_[1])) {
1459 if (report("WARNING", $_[0], $_[1])) {
1467 if ($check && report("CHECK", $_[0], $_[1])) {
1475 sub check_absolute_file {
1476 my ($absolute, $herecurr) = @_;
1477 my $file = $absolute;
1479 ##print "absolute<$absolute>\n";
1481 # See if any suffix of this path is a path within the tree.
1482 while ($file =~ s@^[^/]*/@@) {
1483 if (-f "$root/$file") {
1484 ##print "file<$file>\n";
1492 # It is, so see if the prefix is acceptable.
1493 my $prefix = $absolute;
1494 substr($prefix, -length($file)) = '';
1496 ##print "prefix<$prefix>\n";
1497 if ($prefix ne ".../") {
1498 WARN("USE_RELATIVE_PATH",
1499 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1506 $string =~ s/^\s+|\s+$//g;
1514 $string =~ s/^\s+//;
1522 $string =~ s/\s+$//;
1527 sub string_find_replace {
1528 my ($string, $find, $replace) = @_;
1530 $string =~ s/$find/$replace/g;
1538 my $source_indent = 8;
1539 my $max_spaces_before_tab = $source_indent - 1;
1540 my $spaces_to_tab = " " x $source_indent;
1542 #convert leading spaces to tabs
1543 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1544 #Remove spaces before a tab
1545 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1550 sub pos_last_openparen {
1555 my $opens = $line =~ tr/\(/\(/;
1556 my $closes = $line =~ tr/\)/\)/;
1558 my $last_openparen = 0;
1560 if (($opens == 0) || ($closes >= $opens)) {
1564 my $len = length($line);
1566 for ($pos = 0; $pos < $len; $pos++) {
1567 my $string = substr($line, $pos);
1568 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1569 $pos += length($1) - 1;
1570 } elsif (substr($line, $pos, 1) eq '(') {
1571 $last_openparen = $pos;
1572 } elsif (index($string, '(') == -1) {
1577 return $last_openparen + 1;
1581 my $filename = shift;
1587 my $stashrawline="";
1598 my $in_header_lines = 1;
1599 my $in_commit_log = 0; #Scanning lines before patch
1601 my $non_utf8_charset = 0;
1609 # Trace the real file/line as we go.
1615 my $comment_edge = 0;
1619 my $prev_values = 'E';
1622 my %suppress_ifbraces;
1623 my %suppress_whiletrailers;
1624 my %suppress_export;
1625 my $suppress_statement = 0;
1627 my %signatures = ();
1629 # Pre-scan the patch sanitizing the lines.
1630 # Pre-scan the patch looking for any __setup documentation.
1632 my @setup_docs = ();
1635 my $camelcase_file_seeded = 0;
1637 sanitise_line_reset();
1639 foreach my $rawline (@rawlines) {
1643 push(@fixed, $rawline) if ($fix);
1645 if ($rawline=~/^\+\+\+\s+(\S+)/) {
1647 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1652 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1661 # Guestimate if this is a continuing comment. Run
1662 # the context looking for a comment "edge". If this
1663 # edge is a close comment then we must be in a comment
1667 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1668 next if (defined $rawlines[$ln - 1] &&
1669 $rawlines[$ln - 1] =~ /^-/);
1671 #print "RAW<$rawlines[$ln - 1]>\n";
1672 last if (!defined $rawlines[$ln - 1]);
1673 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1674 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1679 if (defined $edge && $edge eq '*/') {
1683 # Guestimate if this is a continuing comment. If this
1684 # is the start of a diff block and this line starts
1685 # ' *' then it is very likely a comment.
1686 if (!defined $edge &&
1687 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1692 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1693 sanitise_line_reset($in_comment);
1695 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1696 # Standardise the strings and chars within the input to
1697 # simplify matching -- only bother with positive lines.
1698 $line = sanitise_line($rawline);
1700 push(@lines, $line);
1703 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1708 #print "==>$rawline\n";
1709 #print "-->$line\n";
1711 if ($setup_docs && $line =~ /^\+/) {
1712 push(@setup_docs, $line);
1720 foreach my $line (@lines) {
1722 my $sline = $line; #copy of $line
1723 $sline =~ s/$;/ /g; #with comments as spaces
1725 my $rawline = $rawlines[$linenr - 1];
1727 #extract the line range in the file after the patch is applied
1728 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1730 $first_line = $linenr + 1;
1740 %suppress_ifbraces = ();
1741 %suppress_whiletrailers = ();
1742 %suppress_export = ();
1743 $suppress_statement = 0;
1746 # track the line number as we move through the hunk, note that
1747 # new versions of GNU diff omit the leading space on completely
1748 # blank context lines so we need to count that too.
1749 } elsif ($line =~ /^( |\+|$)/) {
1751 $realcnt-- if ($realcnt != 0);
1753 # Measure the line length and indent.
1754 ($length, $indent) = line_stats($rawline);
1756 # Track the previous line.
1757 ($prevline, $stashline) = ($stashline, $line);
1758 ($previndent, $stashindent) = ($stashindent, $indent);
1759 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1761 #warn "line<$line>\n";
1763 } elsif ($realcnt == 1) {
1767 my $hunk_line = ($realcnt != 0);
1769 #make up the handle for any error we report on this line
1770 $prefix = "$filename:$realline: " if ($emacs && $file);
1771 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1773 $here = "#$linenr: " if (!$file);
1774 $here = "#$realline: " if ($file);
1776 # extract the filename as it passes
1777 if ($line =~ /^diff --git.*?(\S+)$/) {
1779 $realfile =~ s@^([^/]*)/@@ if (!$file);
1781 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
1783 $realfile =~ s@^([^/]*)/@@ if (!$file);
1787 if (!$file && $tree && $p1_prefix ne '' &&
1788 -e "$root/$p1_prefix") {
1789 WARN("PATCH_PREFIX",
1790 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1793 if ($realfile =~ m@^include/asm/@) {
1794 ERROR("MODIFIED_INCLUDE_ASM",
1795 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1800 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
1802 my $hereline = "$here\n$rawline\n";
1803 my $herecurr = "$here\n$rawline\n";
1804 my $hereprev = "$here\n$prevrawline\n$rawline\n";
1806 $cnt_lines++ if ($realcnt != 0);
1808 # Check for incorrect file permissions
1809 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1810 my $permhere = $here . "FILE: $realfile\n";
1811 if ($realfile !~ m@scripts/@ &&
1812 $realfile !~ /\.(py|pl|awk|sh)$/) {
1813 ERROR("EXECUTE_PERMISSIONS",
1814 "do not set execute permissions for source files\n" . $permhere);
1818 # Check the patch for a signoff:
1819 if ($line =~ /^\s*signed-off-by:/i) {
1824 # Check signature styles
1825 if (!$in_header_lines &&
1826 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
1827 my $space_before = $1;
1829 my $space_after = $3;
1831 my $ucfirst_sign_off = ucfirst(lc($sign_off));
1833 if ($sign_off !~ /$signature_tags/) {
1834 WARN("BAD_SIGN_OFF",
1835 "Non-standard signature: $sign_off\n" . $herecurr);
1837 if (defined $space_before && $space_before ne "") {
1838 if (WARN("BAD_SIGN_OFF",
1839 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
1841 $fixed[$linenr - 1] =
1842 "$ucfirst_sign_off $email";
1845 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
1846 if (WARN("BAD_SIGN_OFF",
1847 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
1849 $fixed[$linenr - 1] =
1850 "$ucfirst_sign_off $email";
1854 if (!defined $space_after || $space_after ne " ") {
1855 if (WARN("BAD_SIGN_OFF",
1856 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
1858 $fixed[$linenr - 1] =
1859 "$ucfirst_sign_off $email";
1863 my ($email_name, $email_address, $comment) = parse_email($email);
1864 my $suggested_email = format_email(($email_name, $email_address));
1865 if ($suggested_email eq "") {
1866 ERROR("BAD_SIGN_OFF",
1867 "Unrecognized email address: '$email'\n" . $herecurr);
1869 my $dequoted = $suggested_email;
1870 $dequoted =~ s/^"//;
1871 $dequoted =~ s/" </ </;
1872 # Don't force email to have quotes
1873 # Allow just an angle bracketed address
1874 if ("$dequoted$comment" ne $email &&
1875 "<$email_address>$comment" ne $email &&
1876 "$suggested_email$comment" ne $email) {
1877 WARN("BAD_SIGN_OFF",
1878 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
1882 # Check for duplicate signatures
1883 my $sig_nospace = $line;
1884 $sig_nospace =~ s/\s//g;
1885 $sig_nospace = lc($sig_nospace);
1886 if (defined $signatures{$sig_nospace}) {
1887 WARN("BAD_SIGN_OFF",
1888 "Duplicate signature\n" . $herecurr);
1890 $signatures{$sig_nospace} = 1;
1894 # Check for wrappage within a valid hunk of the file
1895 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1896 ERROR("CORRUPTED_PATCH",
1897 "patch seems to be corrupt (line wrapped?)\n" .
1898 $herecurr) if (!$emitted_corrupt++);
1901 # Check for absolute kernel paths.
1903 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1906 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1907 check_absolute_file($1, $herecurr)) {
1910 check_absolute_file($file, $herecurr);
1915 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1916 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1917 $rawline !~ m/^$UTF8*$/) {
1918 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1920 my $blank = copy_spacing($rawline);
1921 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1922 my $hereptr = "$hereline$ptr\n";
1925 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1928 # Check if it's the start of a commit log
1929 # (not a header line and we haven't seen the patch filename)
1930 if ($in_header_lines && $realfile =~ /^$/ &&
1931 $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
1932 $in_header_lines = 0;
1936 # Check if there is UTF-8 in a commit log when a mail header has explicitly
1937 # declined it, i.e defined some charset where it is missing.
1938 if ($in_header_lines &&
1939 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
1941 $non_utf8_charset = 1;
1944 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
1945 $rawline =~ /$NON_ASCII_UTF8/) {
1946 WARN("UTF8_BEFORE_PATCH",
1947 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
1950 # ignore non-hunk lines and lines being removed
1951 next if (!$hunk_line || $line =~ /^-/);
1953 #trailing whitespace
1954 if ($line =~ /^\+.*\015/) {
1955 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1956 if (ERROR("DOS_LINE_ENDINGS",
1957 "DOS line endings\n" . $herevet) &&
1959 $fixed[$linenr - 1] =~ s/[\s\015]+$//;
1961 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1962 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1963 if (ERROR("TRAILING_WHITESPACE",
1964 "trailing whitespace\n" . $herevet) &&
1966 $fixed[$linenr - 1] =~ s/\s+$//;
1972 # Check for FSF mailing addresses.
1973 if ($rawline =~ /\bYou should have received a copy/i ||
1974 $rawline =~ /\bwrite to the Free/i ||
1975 $rawline =~ /\b59\s+Temple\s+Pl/i ||
1976 $rawline =~ /\b51\s+Franklin\s+St/i) {
1977 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1978 my $msg_type = \&ERROR;
1979 $msg_type = \&CHK if ($file);
1980 $msg_type = \&CHK if ($rawline =~ /\bYou should have received a copy/i);
1981 &{$msg_type}("FSF_MAILING_ADDRESS",
1982 "Do not include the paragraph about writing to the Free Software Foundation's mailing address from the sample GPL notice. The FSF has changed addresses in the past, and may do so again. Linux already includes a copy of the GPL.\n" . $herevet)
1985 # check for Kconfig help text having a real description
1986 # Only applies when adding the entry originally, after that we do not have
1987 # sufficient context to determine whether it is indeed long enough.
1988 if ($realfile =~ /Kconfig/ &&
1989 $line =~ /.\s*config\s+/) {
1992 my $ln = $linenr + 1;
1996 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
1997 $f = $lines[$ln - 1];
1998 $cnt-- if ($lines[$ln - 1] !~ /^-/);
1999 $is_end = $lines[$ln - 1] =~ /^\+/;
2001 next if ($f =~ /^-/);
2003 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
2005 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
2012 next if ($f =~ /^$/);
2013 if ($f =~ /^\s*config\s/) {
2019 WARN("CONFIG_DESCRIPTION",
2020 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
2021 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2024 # discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2025 if ($realfile =~ /Kconfig/ &&
2026 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2027 WARN("CONFIG_EXPERIMENTAL",
2028 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2031 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2032 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2035 'EXTRA_AFLAGS' => 'asflags-y',
2036 'EXTRA_CFLAGS' => 'ccflags-y',
2037 'EXTRA_CPPFLAGS' => 'cppflags-y',
2038 'EXTRA_LDFLAGS' => 'ldflags-y',
2041 WARN("DEPRECATED_VARIABLE",
2042 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2045 # check we are in a valid source file if not then ignore this hunk
2046 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
2049 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
2050 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
2051 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
2052 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
2053 $length > $max_line_length)
2056 "line over $max_line_length characters\n" . $herecurr);
2059 # Check for user-visible strings broken across lines, which breaks the ability
2060 # to grep for the string. Make exceptions when the previous string ends in a
2061 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
2062 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
2063 if ($line =~ /^\+\s*"/ &&
2064 $prevline =~ /"\s*$/ &&
2065 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
2066 WARN("SPLIT_STRING",
2067 "quoted string split across lines\n" . $hereprev);
2070 # check for spaces before a quoted newline
2071 if ($rawline =~ /^.*\".*\s\\n/) {
2072 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
2073 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
2075 $fixed[$linenr - 1] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
2080 # check for adding lines without a newline.
2081 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2082 WARN("MISSING_EOF_NEWLINE",
2083 "adding a line without newline at end of file\n" . $herecurr);
2086 # Blackfin: use hi/lo macros
2087 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2088 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2089 my $herevet = "$here\n" . cat_vet($line) . "\n";
2091 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
2093 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2094 my $herevet = "$here\n" . cat_vet($line) . "\n";
2096 "use the HI() macro, not (... >> 16)\n" . $herevet);
2100 # check we are in a valid source file C or perl if not then ignore this hunk
2101 next if ($realfile !~ /\.(h|c|pl)$/);
2103 # at the beginning of a line any tabs must come first and anything
2104 # more than 8 must use tabs.
2105 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2106 $rawline =~ /^\+\s* \s*/) {
2107 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2109 if (ERROR("CODE_INDENT",
2110 "code indent should use tabs where possible\n" . $herevet) &&
2112 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2116 # check for space before tabs.
2117 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2118 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2119 if (WARN("SPACE_BEFORE_TAB",
2120 "please, no space before tabs\n" . $herevet) &&
2122 while ($fixed[$linenr - 1] =~
2123 s/(^\+.*) {8,8}+\t/$1\t\t/) {}
2124 while ($fixed[$linenr - 1] =~
2125 s/(^\+.*) +\t/$1\t/) {}
2129 # check for && or || at the start of a line
2130 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2131 CHK("LOGICAL_CONTINUATIONS",
2132 "Logical continuations should be on the previous line\n" . $hereprev);
2135 # check multi-line statement indentation matches previous line
2136 if ($^V && $^V ge 5.10.0 &&
2137 $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) {
2138 $prevline =~ /^\+(\t*)(.*)$/;
2142 my $pos = pos_last_openparen($rest);
2144 $line =~ /^(\+| )([ \t]*)/;
2147 my $goodtabindent = $oldindent .
2150 my $goodspaceindent = $oldindent . " " x $pos;
2152 if ($newindent ne $goodtabindent &&
2153 $newindent ne $goodspaceindent) {
2155 if (CHK("PARENTHESIS_ALIGNMENT",
2156 "Alignment should match open parenthesis\n" . $hereprev) &&
2157 $fix && $line =~ /^\+/) {
2158 $fixed[$linenr - 1] =~
2159 s/^\+[ \t]*/\+$goodtabindent/;
2165 if ($line =~ /^\+.*\*[ \t]*\)[ \t]+(?!$Assignment|$Arithmetic)/) {
2167 "No space is necessary after a cast\n" . $hereprev) &&
2169 $fixed[$linenr - 1] =~
2170 s/^(\+.*\*[ \t]*\))[ \t]+/$1/;
2174 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2175 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
2176 $rawline =~ /^\+[ \t]*\*/) {
2177 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2178 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2181 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2182 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2183 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
2184 $rawline =~ /^\+/ && #line is new
2185 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2186 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2187 "networking block comments start with * on subsequent lines\n" . $hereprev);
2190 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2191 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2192 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2193 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2194 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
2195 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2196 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2199 # check for spaces at the beginning of a line.
2201 # 1) within comments
2202 # 2) indented preprocessor commands
2204 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
2205 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2206 if (WARN("LEADING_SPACE",
2207 "please, no spaces at the start of a line\n" . $herevet) &&
2209 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2213 # check we are in a valid C source file if not then ignore this hunk
2214 next if ($realfile !~ /\.(h|c)$/);
2216 # discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2217 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2218 WARN("CONFIG_EXPERIMENTAL",
2219 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2222 # check for RCS/CVS revision markers
2223 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
2225 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
2228 # Blackfin: don't use __builtin_bfin_[cs]sync
2229 if ($line =~ /__builtin_bfin_csync/) {
2230 my $herevet = "$here\n" . cat_vet($line) . "\n";
2232 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
2234 if ($line =~ /__builtin_bfin_ssync/) {
2235 my $herevet = "$here\n" . cat_vet($line) . "\n";
2237 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
2240 # check for old HOTPLUG __dev<foo> section markings
2241 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2242 WARN("HOTPLUG_SECTION",
2243 "Using $1 is unnecessary\n" . $herecurr);
2246 # Check for potential 'bare' types
2247 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2249 #print "LINE<$line>\n";
2250 if ($linenr >= $suppress_statement &&
2251 $realcnt && $sline =~ /.\s*\S/) {
2252 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2253 ctx_statement_block($linenr, $realcnt, 0);
2254 $stat =~ s/\n./\n /g;
2255 $cond =~ s/\n./\n /g;
2257 #print "linenr<$linenr> <$stat>\n";
2258 # If this statement has no statement boundaries within
2259 # it there is no point in retrying a statement scan
2260 # until we hit end of it.
2261 my $frag = $stat; $frag =~ s/;+\s*$//;
2262 if ($frag !~ /(?:{|;)/) {
2263 #print "skip<$line_nr_next>\n";
2264 $suppress_statement = $line_nr_next;
2267 # Find the real next line.
2268 $realline_next = $line_nr_next;
2269 if (defined $realline_next &&
2270 (!defined $lines[$realline_next - 1] ||
2271 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2278 # Ignore goto labels.
2279 if ($s =~ /$Ident:\*$/s) {
2281 # Ignore functions being called
2282 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
2284 } elsif ($s =~ /^.\s*else\b/s) {
2286 # declarations always start with types
2287 } 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) {
2290 possible($type, "A:" . $s);
2292 # definitions in global scope can only start with types
2293 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
2294 possible($1, "B:" . $s);
2297 # any (foo ... *) is a pointer cast, and foo is a type
2298 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
2299 possible($1, "C:" . $s);
2302 # Check for any sort of function declaration.
2303 # int foo(something bar, other baz);
2304 # void (*store_gdt)(x86_descr_ptr *);
2305 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
2306 my ($name_len) = length($1);
2309 substr($ctx, 0, $name_len + 1, '');
2310 $ctx =~ s/\)[^\)]*$//;
2312 for my $arg (split(/\s*,\s*/, $ctx)) {
2313 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
2315 possible($1, "D:" . $s);
2323 # Checks which may be anchored in the context.
2326 # Check for switch () and associated case and default
2327 # statements should be at the same indent.
2328 if ($line=~/\bswitch\s*\(.*\)/) {
2331 my @ctx = ctx_block_outer($linenr, $realcnt);
2333 for my $ctx (@ctx) {
2334 my ($clen, $cindent) = line_stats($ctx);
2335 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2336 $indent != $cindent) {
2337 $err .= "$sep$ctx\n";
2344 ERROR("SWITCH_CASE_INDENT_LEVEL",
2345 "switch and case should be at the same indent\n$hereline$err");
2349 # if/while/etc brace do not go on next line, unless defining a do while loop,
2350 # or if that brace on the next line is for something else
2351 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
2352 my $pre_ctx = "$1$2";
2354 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
2356 if ($line =~ /^\+\t{6,}/) {
2357 WARN("DEEP_INDENTATION",
2358 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2361 my $ctx_cnt = $realcnt - $#ctx - 1;
2362 my $ctx = join("\n", @ctx);
2364 my $ctx_ln = $linenr;
2365 my $ctx_skip = $realcnt;
2367 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2368 defined $lines[$ctx_ln - 1] &&
2369 $lines[$ctx_ln - 1] =~ /^-/)) {
2370 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2371 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
2375 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2376 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
2378 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
2380 "that open brace { should be on the previous line\n" .
2381 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2383 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2384 $ctx =~ /\)\s*\;\s*$/ &&
2385 defined $lines[$ctx_ln - 1])
2387 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2388 if ($nindent > $indent) {
2389 WARN("TRAILING_SEMICOLON",
2390 "trailing semicolon indicates no statements, indent implies otherwise\n" .
2391 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2396 # Check relative indent for conditionals and blocks.
2397 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2398 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2399 ctx_statement_block($linenr, $realcnt, 0)
2400 if (!defined $stat);
2401 my ($s, $c) = ($stat, $cond);
2403 substr($s, 0, length($c), '');
2405 # Make sure we remove the line prefixes as we have
2406 # none on the first line, and are going to readd them
2410 # Find out how long the conditional actually is.
2411 my @newlines = ($c =~ /\n/gs);
2412 my $cond_lines = 1 + $#newlines;
2414 # We want to check the first line inside the block
2415 # starting at the end of the conditional, so remove:
2416 # 1) any blank line termination
2417 # 2) any opening brace { on end of the line
2419 my $continuation = 0;
2421 $s =~ s/^.*\bdo\b//;
2423 if ($s =~ s/^\s*\\//) {
2426 if ($s =~ s/^\s*?\n//) {
2431 # Also ignore a loop construct at the end of a
2432 # preprocessor statement.
2433 if (($prevline =~ /^.\s*#\s*define\s/ ||
2434 $prevline =~ /\\\s*$/) && $continuation == 0) {
2440 while ($cond_ptr != $cond_lines) {
2441 $cond_ptr = $cond_lines;
2443 # If we see an #else/#elif then the code
2445 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2450 # 1) blank lines, they should be at 0,
2451 # 2) preprocessor lines, and
2453 if ($continuation ||
2455 $s =~ /^\s*#\s*?/ ||
2456 $s =~ /^\s*$Ident\s*:/) {
2457 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
2458 if ($s =~ s/^.*?\n//) {
2464 my (undef, $sindent) = line_stats("+" . $s);
2465 my $stat_real = raw_line($linenr, $cond_lines);
2467 # Check if either of these lines are modified, else
2468 # this is not this patch's fault.
2469 if (!defined($stat_real) ||
2470 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2473 if (defined($stat_real) && $cond_lines > 1) {
2474 $stat_real = "[...]\n$stat_real";
2477 #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";
2479 if ($check && (($sindent % 8) != 0 ||
2480 ($sindent <= $indent && $s ne ''))) {
2481 WARN("SUSPECT_CODE_INDENT",
2482 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
2486 # Track the 'values' across context and added lines.
2487 my $opline = $line; $opline =~ s/^./ /;
2488 my ($curr_values, $curr_vars) =
2489 annotate_values($opline . "\n", $prev_values);
2490 $curr_values = $prev_values . $curr_values;
2492 my $outline = $opline; $outline =~ s/\t/ /g;
2493 print "$linenr > .$outline\n";
2494 print "$linenr > $curr_values\n";
2495 print "$linenr > $curr_vars\n";
2497 $prev_values = substr($curr_values, -1);
2499 #ignore lines not being added
2500 next if ($line =~ /^[^\+]/);
2502 # TEST: allow direct testing of the type matcher.
2504 if ($line =~ /^.\s*$Declare\s*$/) {
2506 "TEST: is type\n" . $herecurr);
2507 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
2508 ERROR("TEST_NOT_TYPE",
2509 "TEST: is not type ($1 is)\n". $herecurr);
2513 # TEST: allow direct testing of the attribute matcher.
2515 if ($line =~ /^.\s*$Modifier\s*$/) {
2517 "TEST: is attr\n" . $herecurr);
2518 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
2519 ERROR("TEST_NOT_ATTR",
2520 "TEST: is not attr ($1 is)\n". $herecurr);
2525 # check for initialisation to aggregates open brace on the next line
2526 if ($line =~ /^.\s*{/ &&
2527 $prevline =~ /(?:^|[^=])=\s*$/) {
2529 "that open brace { should be on the previous line\n" . $hereprev);
2533 # Checks which are anchored on the added line.
2536 # check for malformed paths in #include statements (uses RAW line)
2537 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
2539 if ($path =~ m{//}) {
2540 ERROR("MALFORMED_INCLUDE",
2541 "malformed #include filename\n" . $herecurr);
2543 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
2544 ERROR("UAPI_INCLUDE",
2545 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
2549 # no C99 // comments
2550 if ($line =~ m{//}) {
2551 if (ERROR("C99_COMMENTS",
2552 "do not use C99 // comments\n" . $herecurr) &&
2554 my $line = $fixed[$linenr - 1];
2555 if ($line =~ /\/\/(.*)$/) {
2556 my $comment = trim($1);
2557 $fixed[$linenr - 1] =~ s@\/\/(.*)$@/\* $comment \*/@;
2561 # Remove C99 comments.
2563 $opline =~ s@//.*@@;
2565 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2566 # the whole statement.
2567 #print "APW <$lines[$realline_next - 1]>\n";
2568 if (defined $realline_next &&
2569 exists $lines[$realline_next - 1] &&
2570 !defined $suppress_export{$realline_next} &&
2571 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2572 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2573 # Handle definitions which produce identifiers with
2576 # EXPORT_SYMBOL(something_foo);
2578 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
2579 $name =~ /^${Ident}_$2/) {
2580 #print "FOO C name<$name>\n";
2581 $suppress_export{$realline_next} = 1;
2583 } elsif ($stat !~ /(?:
2585 ^.DEFINE_$Ident\(\Q$name\E\)|
2586 ^.DECLARE_$Ident\(\Q$name\E\)|
2587 ^.LIST_HEAD\(\Q$name\E\)|
2588 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2589 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
2591 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2592 $suppress_export{$realline_next} = 2;
2594 $suppress_export{$realline_next} = 1;
2597 if (!defined $suppress_export{$linenr} &&
2598 $prevline =~ /^.\s*$/ &&
2599 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2600 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2601 #print "FOO B <$lines[$linenr - 1]>\n";
2602 $suppress_export{$linenr} = 2;
2604 if (defined $suppress_export{$linenr} &&
2605 $suppress_export{$linenr} == 2) {
2606 WARN("EXPORT_SYMBOL",
2607 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
2610 # check for global initialisers.
2611 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
2612 if (ERROR("GLOBAL_INITIALISERS",
2613 "do not initialise globals to 0 or NULL\n" .
2616 $fixed[$linenr - 1] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
2619 # check for static initialisers.
2620 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2621 if (ERROR("INITIALISED_STATIC",
2622 "do not initialise statics to 0 or NULL\n" .
2625 $fixed[$linenr - 1] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
2629 # check for static const char * arrays.
2630 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
2631 WARN("STATIC_CONST_CHAR_ARRAY",
2632 "static const char * array should probably be static const char * const\n" .
2636 # check for static char foo[] = "bar" declarations.
2637 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
2638 WARN("STATIC_CONST_CHAR_ARRAY",
2639 "static char array declaration should probably be static const char\n" .
2643 # check for uses of DEFINE_PCI_DEVICE_TABLE
2644 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
2645 if (WARN("DEFINE_PCI_DEVICE_TABLE",
2646 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
2648 $fixed[$linenr - 1] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
2652 # check for new typedefs, only function parameters and sparse annotations
2654 if ($line =~ /\btypedef\s/ &&
2655 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
2656 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
2657 $line !~ /\b$typeTypedefs\b/ &&
2658 $line !~ /\b__bitwise(?:__|)\b/) {
2659 WARN("NEW_TYPEDEFS",
2660 "do not add new typedefs\n" . $herecurr);
2663 # * goes on variable not on type
2665 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2667 my ($ident, $from, $to) = ($1, $2, $2);
2669 # Should start with a space.
2670 $to =~ s/^(\S)/ $1/;
2671 # Should not end with a space.
2673 # '*'s should not have spaces between.
2674 while ($to =~ s/\*\s+\*/\*\*/) {
2677 ## print "1: from<$from> to<$to> ident<$ident>\n";
2679 if (ERROR("POINTER_LOCATION",
2680 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
2682 my $sub_from = $ident;
2683 my $sub_to = $ident;
2684 $sub_to =~ s/\Q$from\E/$to/;
2685 $fixed[$linenr - 1] =~
2686 s@\Q$sub_from\E@$sub_to@;
2690 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2692 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
2694 # Should start with a space.
2695 $to =~ s/^(\S)/ $1/;
2696 # Should not end with a space.
2698 # '*'s should not have spaces between.
2699 while ($to =~ s/\*\s+\*/\*\*/) {
2701 # Modifiers should have spaces.
2702 $to =~ s/(\b$Modifier$)/$1 /;
2704 ## print "2: from<$from> to<$to> ident<$ident>\n";
2705 if ($from ne $to && $ident !~ /^$Modifier$/) {
2706 if (ERROR("POINTER_LOCATION",
2707 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
2710 my $sub_from = $match;
2711 my $sub_to = $match;
2712 $sub_to =~ s/\Q$from\E/$to/;
2713 $fixed[$linenr - 1] =~
2714 s@\Q$sub_from\E@$sub_to@;
2719 # # no BUG() or BUG_ON()
2720 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
2721 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2722 # print "$herecurr";
2726 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
2727 WARN("LINUX_VERSION_CODE",
2728 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
2731 # check for uses of printk_ratelimit
2732 if ($line =~ /\bprintk_ratelimit\s*\(/) {
2733 WARN("PRINTK_RATELIMITED",
2734 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
2737 # printk should use KERN_* levels. Note that follow on printk's on the
2738 # same line do not need a level, so we use the current block context
2739 # to try and find and validate the current printk. In summary the current
2740 # printk includes all preceding printk's which have no newline on the end.
2741 # we assume the first bad printk is the one to report.
2742 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
2744 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2745 #print "CHECK<$lines[$ln - 1]\n";
2746 # we have a preceding printk if it ends
2747 # with "\n" ignore it, else it is to blame
2748 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2749 if ($rawlines[$ln - 1] !~ m{\\n"}) {
2756 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2757 "printk() should include KERN_ facility level\n" . $herecurr);
2761 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
2763 my $level = lc($orig);
2764 $level = "warn" if ($level eq "warning");
2765 my $level2 = $level;
2766 $level2 = "dbg" if ($level eq "debug");
2767 WARN("PREFER_PR_LEVEL",
2768 "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
2771 if ($line =~ /\bpr_warning\s*\(/) {
2772 if (WARN("PREFER_PR_LEVEL",
2773 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
2775 $fixed[$linenr - 1] =~
2776 s/\bpr_warning\b/pr_warn/;
2780 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
2782 my $level = lc($orig);
2783 $level = "warn" if ($level eq "warning");
2784 $level = "dbg" if ($level eq "debug");
2785 WARN("PREFER_DEV_LEVEL",
2786 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
2789 # function brace can't be on same line, except for #defines of do while,
2790 # or if closed on same line
2791 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2792 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
2794 "open brace '{' following function declarations go on the next line\n" . $herecurr);
2797 # open braces for enum, union and struct go on the same line.
2798 if ($line =~ /^.\s*{/ &&
2799 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
2801 "open brace '{' following $1 go on the same line\n" . $hereprev);
2804 # missing space after union, struct or enum definition
2805 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
2807 "missing space after $1 definition\n" . $herecurr) &&
2809 $fixed[$linenr - 1] =~
2810 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
2814 # check for spacing round square brackets; allowed:
2815 # 1. with a type on the left -- int [] a;
2816 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2817 # 3. inside a curly brace -- = { [0...10] = 5 }
2818 while ($line =~ /(.*?\s)\[/g) {
2819 my ($where, $prefix) = ($-[1], $1);
2820 if ($prefix !~ /$Type\s+$/ &&
2821 ($where != 0 || $prefix !~ /^.\s+$/) &&
2822 $prefix !~ /[{,]\s+$/) {
2823 if (ERROR("BRACKET_SPACE",
2824 "space prohibited before open square bracket '['\n" . $herecurr) &&
2826 $fixed[$linenr - 1] =~
2827 s/^(\+.*?)\s+\[/$1\[/;
2832 # check for spaces between functions and their parentheses.
2833 while ($line =~ /($Ident)\s+\(/g) {
2835 my $ctx_before = substr($line, 0, $-[1]);
2836 my $ctx = "$ctx_before$name";
2838 # Ignore those directives where spaces _are_ permitted.
2840 if|for|while|switch|return|case|
2841 volatile|__volatile__|
2842 __attribute__|format|__extension__|
2845 # cpp #define statements have non-optional spaces, ie
2846 # if there is a space between the name and the open
2847 # parenthesis it is simply not a parameter group.
2848 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
2850 # cpp #elif statement condition may start with a (
2851 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
2853 # If this whole things ends with a type its most
2854 # likely a typedef for a function.
2855 } elsif ($ctx =~ /$Type$/) {
2859 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
2861 $fixed[$linenr - 1] =~
2862 s/\b$name\s+\(/$name\(/;
2867 # Check operator spacing.
2868 if (!($line=~/\#\s*include/)) {
2869 my $fixed_line = "";
2873 <<=|>>=|<=|>=|==|!=|
2874 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
2875 =>|->|<<|>>|<|>|=|!|~|
2876 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
2879 my @elements = split(/($ops|;)/, $opline);
2881 ## print("element count: <" . $#elements . ">\n");
2882 ## foreach my $el (@elements) {
2883 ## print("el: <$el>\n");
2886 my @fix_elements = ();
2889 foreach my $el (@elements) {
2890 push(@fix_elements, substr($rawline, $off, length($el)));
2891 $off += length($el);
2896 my $blank = copy_spacing($opline);
2897 my $last_after = -1;
2899 for (my $n = 0; $n < $#elements; $n += 2) {
2901 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
2903 ## print("n: <$n> good: <$good>\n");
2905 $off += length($elements[$n]);
2907 # Pick up the preceding and succeeding characters.
2908 my $ca = substr($opline, 0, $off);
2910 if (length($opline) >= ($off + length($elements[$n + 1]))) {
2911 $cc = substr($opline, $off + length($elements[$n + 1]));
2913 my $cb = "$ca$;$cc";
2916 $a = 'V' if ($elements[$n] ne '');
2917 $a = 'W' if ($elements[$n] =~ /\s$/);
2918 $a = 'C' if ($elements[$n] =~ /$;$/);
2919 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
2920 $a = 'O' if ($elements[$n] eq '');
2921 $a = 'E' if ($ca =~ /^\s*$/);
2923 my $op = $elements[$n + 1];
2926 if (defined $elements[$n + 2]) {
2927 $c = 'V' if ($elements[$n + 2] ne '');
2928 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
2929 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
2930 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
2931 $c = 'O' if ($elements[$n + 2] eq '');
2932 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
2937 my $ctx = "${a}x${c}";
2939 my $at = "(ctx:$ctx)";
2941 my $ptr = substr($blank, 0, $off) . "^";
2942 my $hereptr = "$hereline$ptr\n";
2944 # Pull out the value of this operator.
2945 my $op_type = substr($curr_values, $off + 1, 1);
2947 # Get the full operator variant.
2948 my $opv = $op . substr($curr_vars, $off, 1);
2950 # Ignore operators passed as parameters.
2951 if ($op_type ne 'V' &&
2952 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
2955 # } elsif ($op =~ /^$;+$/) {
2957 # ; should have either the end of line or a space or \ after it
2958 } elsif ($op eq ';') {
2959 if ($ctx !~ /.x[WEBC]/ &&
2960 $cc !~ /^\\/ && $cc !~ /^;/) {
2961 if (ERROR("SPACING",
2962 "space required after that '$op' $at\n" . $hereptr)) {
2963 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
2969 } elsif ($op eq '//') {
2973 # : when part of a bitfield
2974 } elsif ($op eq '->' || $opv eq ':B') {
2975 if ($ctx =~ /Wx.|.xW/) {
2976 if (ERROR("SPACING",
2977 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
2978 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
2979 if (defined $fix_elements[$n + 2]) {
2980 $fix_elements[$n + 2] =~ s/^\s+//;
2986 # , must have a space on the right.
2987 } elsif ($op eq ',') {
2988 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
2989 if (ERROR("SPACING",
2990 "space required after that '$op' $at\n" . $hereptr)) {
2991 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
2997 # '*' as part of a type definition -- reported already.
2998 } elsif ($opv eq '*_') {
2999 #warn "'*' is part of type\n";
3001 # unary operators should have a space before and
3002 # none after. May be left adjacent to another
3003 # unary operator, or a cast
3004 } elsif ($op eq '!' || $op eq '~' ||
3005 $opv eq '*U' || $opv eq '-U' ||
3006 $opv eq '&U' || $opv eq '&&U') {
3007 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
3008 if (ERROR("SPACING",
3009 "space required before that '$op' $at\n" . $hereptr)) {
3010 if ($n != $last_after + 2) {
3011 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3016 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
3017 # A unary '*' may be const
3019 } elsif ($ctx =~ /.xW/) {
3020 if (ERROR("SPACING",
3021 "space prohibited after that '$op' $at\n" . $hereptr)) {
3022 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
3023 if (defined $fix_elements[$n + 2]) {
3024 $fix_elements[$n + 2] =~ s/^\s+//;
3030 # unary ++ and unary -- are allowed no space on one side.
3031 } elsif ($op eq '++' or $op eq '--') {
3032 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
3033 if (ERROR("SPACING",
3034 "space required one side of that '$op' $at\n" . $hereptr)) {
3035 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3039 if ($ctx =~ /Wx[BE]/ ||
3040 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
3041 if (ERROR("SPACING",
3042 "space prohibited before that '$op' $at\n" . $hereptr)) {
3043 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3047 if ($ctx =~ /ExW/) {
3048 if (ERROR("SPACING",
3049 "space prohibited after that '$op' $at\n" . $hereptr)) {
3050 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3051 if (defined $fix_elements[$n + 2]) {
3052 $fix_elements[$n + 2] =~ s/^\s+//;
3058 # << and >> may either have or not have spaces both sides
3059 } elsif ($op eq '<<' or $op eq '>>' or
3060 $op eq '&' or $op eq '^' or $op eq '|' or
3061 $op eq '+' or $op eq '-' or
3062 $op eq '*' or $op eq '/' or
3065 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
3066 if (ERROR("SPACING",
3067 "need consistent spacing around '$op' $at\n" . $hereptr)) {
3068 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3069 if (defined $fix_elements[$n + 2]) {
3070 $fix_elements[$n + 2] =~ s/^\s+//;
3076 # A colon needs no spaces before when it is
3077 # terminating a case value or a label.
3078 } elsif ($opv eq ':C' || $opv eq ':L') {
3079 if ($ctx =~ /Wx./) {
3080 if (ERROR("SPACING",
3081 "space prohibited before that '$op' $at\n" . $hereptr)) {
3082 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3087 # All the others need spaces both sides.
3088 } elsif ($ctx !~ /[EWC]x[CWE]/) {
3091 # Ignore email addresses <foo@bar>
3093 $cc =~ /^\S+\@\S+>/) ||
3095 $ca =~ /<\S+\@\S+$/))
3100 # messages are ERROR, but ?: are CHK
3102 my $msg_type = \&ERROR;
3103 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
3105 if (&{$msg_type}("SPACING",
3106 "spaces required around that '$op' $at\n" . $hereptr)) {
3107 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3108 if (defined $fix_elements[$n + 2]) {
3109 $fix_elements[$n + 2] =~ s/^\s+//;
3115 $off += length($elements[$n + 1]);
3117 ## print("n: <$n> GOOD: <$good>\n");
3119 $fixed_line = $fixed_line . $good;
3122 if (($#elements % 2) == 0) {
3123 $fixed_line = $fixed_line . $fix_elements[$#elements];
3126 if ($fix && $line_fixed && $fixed_line ne $fixed[$linenr - 1]) {
3127 $fixed[$linenr - 1] = $fixed_line;
3133 # check for whitespace before a non-naked semicolon
3134 if ($line =~ /^\+.*\S\s+;\s*$/) {
3136 "space prohibited before semicolon\n" . $herecurr) &&
3138 1 while $fixed[$linenr - 1] =~
3139 s/^(\+.*\S)\s+;/$1;/;
3143 # check for multiple assignments
3144 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
3145 CHK("MULTIPLE_ASSIGNMENTS",
3146 "multiple assignments should be avoided\n" . $herecurr);
3149 ## # check for multiple declarations, allowing for a function declaration
3151 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3152 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3154 ## # Remove any bracketed sections to ensure we do not
3155 ## # falsly report the parameters of functions.
3157 ## while ($ln =~ s/\([^\(\)]*\)//g) {
3159 ## if ($ln =~ /,/) {
3160 ## WARN("MULTIPLE_DECLARATION",
3161 ## "declaring multiple variables together should be avoided\n" . $herecurr);
3165 #need space before brace following if, while, etc
3166 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3168 if (ERROR("SPACING",
3169 "space required before the open brace '{'\n" . $herecurr) &&
3171 $fixed[$linenr - 1] =~ s/^(\+.*(?:do|\))){/$1 {/;
3175 ## # check for blank lines before declarations
3176 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3177 ## $prevrawline =~ /^.\s*$/) {
3179 ## "No blank lines before declarations\n" . $hereprev);
3183 # closing brace should have a space following it when it has anything
3185 if ($line =~ /}(?!(?:,|;|\)))\S/) {
3186 if (ERROR("SPACING",
3187 "space required after that close brace '}'\n" . $herecurr) &&
3189 $fixed[$linenr - 1] =~
3190 s/}((?!(?:,|;|\)))\S)/} $1/;
3194 # check spacing on square brackets
3195 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
3196 if (ERROR("SPACING",
3197 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3199 $fixed[$linenr - 1] =~
3203 if ($line =~ /\s\]/) {
3204 if (ERROR("SPACING",
3205 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3207 $fixed[$linenr - 1] =~
3212 # check spacing on parentheses
3213 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3214 $line !~ /for\s*\(\s+;/) {
3215 if (ERROR("SPACING",
3216 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3218 $fixed[$linenr - 1] =~
3222 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
3223 $line !~ /for\s*\(.*;\s+\)/ &&
3224 $line !~ /:\s+\)/) {
3225 if (ERROR("SPACING",
3226 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3228 $fixed[$linenr - 1] =~
3233 #goto labels aren't indented, allow a single space however
3234 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
3235 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
3236 if (WARN("INDENTED_LABEL",
3237 "labels should not be indented\n" . $herecurr) &&
3239 $fixed[$linenr - 1] =~
3244 # Return is not a function.
3245 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
3247 if ($^V && $^V ge 5.10.0 &&
3248 $stat =~ /^.\s*return\s*$balanced_parens\s*;\s*$/) {
3249 ERROR("RETURN_PARENTHESES",
3250 "return is not a function, parentheses are not required\n" . $herecurr);
3252 } elsif ($spacing !~ /\s+/) {
3254 "space required before the open parenthesis '('\n" . $herecurr);
3258 # if statements using unnecessary parentheses - ie: if ((foo == bar))
3259 if ($^V && $^V ge 5.10.0 &&
3260 $line =~ /\bif\s*((?:\(\s*){2,})/) {
3261 my $openparens = $1;
3262 my $count = $openparens =~ tr@\(@\(@;
3264 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3265 my $comp = $4; #Not $1 because of $LvalOrFunc
3266 $msg = " - maybe == should be = ?" if ($comp eq "==");
3267 WARN("UNNECESSARY_PARENTHESES",
3268 "Unnecessary parentheses$msg\n" . $herecurr);
3272 # Return of what appears to be an errno should normally be -'ve
3273 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
3275 if ($name ne 'EOF' && $name ne 'ERROR') {
3276 WARN("USE_NEGATIVE_ERRNO",
3277 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
3281 # Need a space before open parenthesis after if, while etc
3282 if ($line =~ /\b(if|while|for|switch)\(/) {
3283 if (ERROR("SPACING",
3284 "space required before the open parenthesis '('\n" . $herecurr) &&
3286 $fixed[$linenr - 1] =~
3287 s/\b(if|while|for|switch)\(/$1 \(/;
3291 # Check for illegal assignment in if conditional -- and check for trailing
3292 # statements after the conditional.
3293 if ($line =~ /do\s*(?!{)/) {
3294 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3295 ctx_statement_block($linenr, $realcnt, 0)
3296 if (!defined $stat);
3297 my ($stat_next) = ctx_statement_block($line_nr_next,
3298 $remain_next, $off_next);
3299 $stat_next =~ s/\n./\n /g;
3300 ##print "stat<$stat> stat_next<$stat_next>\n";
3302 if ($stat_next =~ /^\s*while\b/) {
3303 # If the statement carries leading newlines,
3304 # then count those as offsets.
3306 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
3308 statement_rawlines($whitespace) - 1;
3310 $suppress_whiletrailers{$line_nr_next +
3314 if (!defined $suppress_whiletrailers{$linenr} &&
3315 defined($stat) && defined($cond) &&
3316 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
3317 my ($s, $c) = ($stat, $cond);
3319 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
3320 ERROR("ASSIGN_IN_IF",
3321 "do not use assignment in if condition\n" . $herecurr);
3324 # Find out what is on the end of the line after the
3326 substr($s, 0, length($c), '');
3328 $s =~ s/$;//g; # Remove any comments
3329 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
3330 $c !~ /}\s*while\s*/)
3332 # Find out how long the conditional actually is.
3333 my @newlines = ($c =~ /\n/gs);
3334 my $cond_lines = 1 + $#newlines;
3337 $stat_real = raw_line($linenr, $cond_lines)
3338 . "\n" if ($cond_lines);
3339 if (defined($stat_real) && $cond_lines > 1) {
3340 $stat_real = "[...]\n$stat_real";
3343 ERROR("TRAILING_STATEMENTS",
3344 "trailing statements should be on next line\n" . $herecurr . $stat_real);
3348 # Check for bitwise tests written as boolean
3360 WARN("HEXADECIMAL_BOOLEAN_TEST",
3361 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
3364 # if and else should not have general statements after it
3365 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
3367 $s =~ s/$;//g; # Remove any comments
3368 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
3369 ERROR("TRAILING_STATEMENTS",
3370 "trailing statements should be on next line\n" . $herecurr);
3373 # if should not continue a brace
3374 if ($line =~ /}\s*if\b/) {
3375 ERROR("TRAILING_STATEMENTS",
3376 "trailing statements should be on next line\n" .
3379 # case and default should not have general statements after them
3380 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
3382 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
3386 ERROR("TRAILING_STATEMENTS",
3387 "trailing statements should be on next line\n" . $herecurr);
3390 # Check for }<nl>else {, these must be at the same
3391 # indent level to be relevant to each other.
3392 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
3393 $previndent == $indent) {
3394 ERROR("ELSE_AFTER_BRACE",
3395 "else should follow close brace '}'\n" . $hereprev);
3398 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
3399 $previndent == $indent) {
3400 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
3402 # Find out what is on the end of the line after the
3404 substr($s, 0, length($c), '');
3407 if ($s =~ /^\s*;/) {
3408 ERROR("WHILE_AFTER_BRACE",
3409 "while should follow close brace '}'\n" . $hereprev);
3413 #Specific variable tests
3414 while ($line =~ m{($Constant|$Lval)}g) {
3417 #gcc binary extension
3418 if ($var =~ /^$Binary$/) {
3419 if (WARN("GCC_BINARY_CONSTANT",
3420 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
3422 my $hexval = sprintf("0x%x", oct($var));
3423 $fixed[$linenr - 1] =~
3424 s/\b$var\b/$hexval/;
3429 if ($var !~ /^$Constant$/ &&
3430 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
3431 #Ignore Page<foo> variants
3432 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
3433 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
3434 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) {
3435 while ($var =~ m{($Ident)}g) {
3437 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
3439 seed_camelcase_includes();
3440 if (!$file && !$camelcase_file_seeded) {
3441 seed_camelcase_file($realfile);
3442 $camelcase_file_seeded = 1;
3445 if (!defined $camelcase{$word}) {
3446 $camelcase{$word} = 1;
3448 "Avoid CamelCase: <$word>\n" . $herecurr);
3454 #no spaces allowed after \ in define
3455 if ($line =~ /\#\s*define.*\\\s+$/) {
3456 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
3457 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
3459 $fixed[$linenr - 1] =~ s/\s+$//;
3463 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
3464 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
3466 my $checkfile = "include/linux/$file";
3467 if (-f "$root/$checkfile" &&
3468 $realfile ne $checkfile &&
3469 $1 !~ /$allowed_asm_includes/)
3471 if ($realfile =~ m{^arch/}) {
3472 CHK("ARCH_INCLUDE_LINUX",
3473 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
3475 WARN("INCLUDE_LINUX",
3476 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
3481 # multi-statement macros should be enclosed in a do while loop, grab the
3482 # first statement and ensure its the whole macro if its not enclosed
3483 # in a known good container
3484 if ($realfile !~ m@/vmlinux.lds.h$@ &&
3485 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
3488 my ($off, $dstat, $dcond, $rest);
3490 ($dstat, $dcond, $ln, $cnt, $off) =
3491 ctx_statement_block($linenr, $realcnt, 0);
3493 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
3494 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
3496 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
3498 $dstat =~ s/\\\n.//g;
3499 $dstat =~ s/^\s*//s;
3500 $dstat =~ s/\s*$//s;
3502 # Flatten any parentheses and braces
3503 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
3504 $dstat =~ s/\{[^\{\}]*\}/1/ ||
3505 $dstat =~ s/\[[^\[\]]*\]/1/)
3509 # Flatten any obvious string concatentation.
3510 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
3511 $dstat =~ s/$Ident\s*("X*")/$1/)
3515 my $exceptions = qr{
3527 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
3529 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
3530 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
3531 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
3532 $dstat !~ /^'X'$/ && # character constants
3533 $dstat !~ /$exceptions/ &&
3534 $dstat !~ /^\.$Ident\s*=/ && # .foo =
3535 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
3536 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
3537 $dstat !~ /^for\s*$Constant$/ && # for (...)
3538 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
3539 $dstat !~ /^do\s*{/ && # do {...
3540 $dstat !~ /^\({/ && # ({...
3541 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
3544 my $herectx = $here . "\n";
3545 my $cnt = statement_rawlines($ctx);
3547 for (my $n = 0; $n < $cnt; $n++) {
3548 $herectx .= raw_line($linenr, $n) . "\n";
3551 if ($dstat =~ /;/) {
3552 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
3553 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
3555 ERROR("COMPLEX_MACRO",
3556 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
3560 # check for line continuations outside of #defines, preprocessor #, and asm
3563 if ($prevline !~ /^..*\\$/ &&
3564 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
3565 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
3566 $line =~ /^\+.*\\$/) {
3567 WARN("LINE_CONTINUATIONS",
3568 "Avoid unnecessary line continuations\n" . $herecurr);
3572 # do {} while (0) macro tests:
3573 # single-statement macros do not need to be enclosed in do while (0) loop,
3574 # macro should not end with a semicolon
3575 if ($^V && $^V ge 5.10.0 &&
3576 $realfile !~ m@/vmlinux.lds.h$@ &&
3577 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
3580 my ($off, $dstat, $dcond, $rest);
3582 ($dstat, $dcond, $ln, $cnt, $off) =
3583 ctx_statement_block($linenr, $realcnt, 0);
3586 $dstat =~ s/\\\n.//g;
3588 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
3593 my $cnt = statement_rawlines($ctx);
3594 my $herectx = $here . "\n";
3596 for (my $n = 0; $n < $cnt; $n++) {
3597 $herectx .= raw_line($linenr, $n) . "\n";
3600 if (($stmts =~ tr/;/;/) == 1 &&
3601 $stmts !~ /^\s*(if|while|for|switch)\b/) {
3602 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
3603 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
3605 if (defined $semis && $semis ne "") {
3606 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
3607 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
3612 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3613 # all assignments may have only one of the following with an assignment:
3616 # VMLINUX_SYMBOL(...)
3617 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
3618 WARN("MISSING_VMLINUX_SYMBOL",
3619 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
3622 # check for redundant bracing round if etc
3623 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
3624 my ($level, $endln, @chunks) =
3625 ctx_statement_full($linenr, $realcnt, 1);
3626 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
3627 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3628 if ($#chunks > 0 && $level == 0) {
3632 my $herectx = $here . "\n";
3633 my $ln = $linenr - 1;
3634 for my $chunk (@chunks) {
3635 my ($cond, $block) = @{$chunk};
3637 # If the condition carries leading newlines, then count those as offsets.
3638 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
3639 my $offset = statement_rawlines($whitespace) - 1;
3641 $allowed[$allow] = 0;
3642 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3644 # We have looked at and allowed this specific line.
3645 $suppress_ifbraces{$ln + $offset} = 1;
3647 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
3648 $ln += statement_rawlines($block) - 1;
3650 substr($block, 0, length($cond), '');
3652 $seen++ if ($block =~ /^\s*{/);
3654 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
3655 if (statement_lines($cond) > 1) {
3656 #print "APW: ALLOWED: cond<$cond>\n";
3657 $allowed[$allow] = 1;
3659 if ($block =~/\b(?:if|for|while)\b/) {
3660 #print "APW: ALLOWED: block<$block>\n";
3661 $allowed[$allow] = 1;
3663 if (statement_block_size($block) > 1) {
3664 #print "APW: ALLOWED: lines block<$block>\n";
3665 $allowed[$allow] = 1;
3670 my $sum_allowed = 0;
3671 foreach (@allowed) {
3674 if ($sum_allowed == 0) {
3676 "braces {} are not necessary for any arm of this statement\n" . $herectx);
3677 } elsif ($sum_allowed != $allow &&
3680 "braces {} should be used on all arms of this statement\n" . $herectx);
3685 if (!defined $suppress_ifbraces{$linenr - 1} &&
3686 $line =~ /\b(if|while|for|else)\b/) {
3689 # Check the pre-context.
3690 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
3691 #print "APW: ALLOWED: pre<$1>\n";
3695 my ($level, $endln, @chunks) =
3696 ctx_statement_full($linenr, $realcnt, $-[0]);
3698 # Check the condition.
3699 my ($cond, $block) = @{$chunks[0]};
3700 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
3701 if (defined $cond) {
3702 substr($block, 0, length($cond), '');
3704 if (statement_lines($cond) > 1) {
3705 #print "APW: ALLOWED: cond<$cond>\n";
3708 if ($block =~/\b(?:if|for|while)\b/) {
3709 #print "APW: ALLOWED: block<$block>\n";
3712 if (statement_block_size($block) > 1) {
3713 #print "APW: ALLOWED: lines block<$block>\n";
3716 # Check the post-context.
3717 if (defined $chunks[1]) {
3718 my ($cond, $block) = @{$chunks[1]};
3719 if (defined $cond) {
3720 substr($block, 0, length($cond), '');
3722 if ($block =~ /^\s*\{/) {
3723 #print "APW: ALLOWED: chunk-1 block<$block>\n";
3727 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
3728 my $herectx = $here . "\n";
3729 my $cnt = statement_rawlines($block);
3731 for (my $n = 0; $n < $cnt; $n++) {
3732 $herectx .= raw_line($linenr, $n) . "\n";
3736 "braces {} are not necessary for single statement blocks\n" . $herectx);
3740 # check for unnecessary blank lines around braces
3741 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
3743 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
3745 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
3747 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
3750 # no volatiles please
3751 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
3752 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
3754 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
3758 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
3759 CHK("REDUNDANT_CODE",
3760 "if this code is redundant consider removing it\n" .
3764 # check for needless "if (<foo>) fn(<foo>)" uses
3765 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
3766 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
3767 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
3769 "$1(NULL) is safe this check is probably not required\n" . $hereprev);
3773 # check for bad placement of section $InitAttribute (e.g.: __initdata)
3774 if ($line =~ /(\b$InitAttribute\b)/) {
3776 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
3779 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
3780 ERROR("MISPLACED_INIT",
3781 "$attr should be placed after $var\n" . $herecurr)) ||
3782 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
3783 WARN("MISPLACED_INIT",
3784 "$attr should be placed after $var\n" . $herecurr))) &&
3786 $fixed[$linenr - 1] =~ s/(\bstatic\s+(?:const\s+)?)(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*([=;])\s*/"$1" . trim(string_find_replace($2, "\\s*$attr\\s*", " ")) . " " . trim(string_find_replace($3, "\\s*$attr\\s*", "")) . " $attr" . ("$4" eq ";" ? ";" : " = ")/e;
3791 # check for $InitAttributeData (ie: __initdata) with const
3792 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
3794 $attr =~ /($InitAttributePrefix)(.*)/;
3795 my $attr_prefix = $1;
3797 if (ERROR("INIT_ATTRIBUTE",
3798 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
3800 $fixed[$linenr - 1] =~
3801 s/$InitAttributeData/${attr_prefix}initconst/;
3805 # check for $InitAttributeConst (ie: __initconst) without const
3806 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
3808 if (ERROR("INIT_ATTRIBUTE",
3809 "Use of $attr requires a separate use of const\n" . $herecurr) &&
3811 my $lead = $fixed[$linenr - 1] =~
3812 /(^\+\s*(?:static\s+))/;
3814 $lead = "$lead " if ($lead !~ /^\+$/);
3815 $lead = "${lead}const ";
3816 $fixed[$linenr - 1] =~ s/(^\+\s*(?:static\s+))/$lead/;
3820 # prefer usleep_range over udelay
3821 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
3822 # ignore udelay's < 10, however
3825 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
3829 # warn about unexpectedly long msleep's
3830 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
3833 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
3837 # check for comparisons of jiffies
3838 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
3839 WARN("JIFFIES_COMPARISON",
3840 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
3843 # check for comparisons of get_jiffies_64()
3844 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
3845 WARN("JIFFIES_COMPARISON",
3846 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
3849 # warn about #ifdefs in C files
3850 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
3851 # print "#ifdef in C files should be avoided\n";
3852 # print "$herecurr";
3856 # warn about spacing in #ifdefs
3857 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
3858 if (ERROR("SPACING",
3859 "exactly one space required after that #$1\n" . $herecurr) &&
3861 $fixed[$linenr - 1] =~
3862 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
3867 # check for spinlock_t definitions without a comment.
3868 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
3869 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
3871 if (!ctx_has_comment($first_line, $linenr)) {
3872 CHK("UNCOMMENTED_DEFINITION",
3873 "$1 definition without comment\n" . $herecurr);
3876 # check for memory barriers without a comment.
3877 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
3878 if (!ctx_has_comment($first_line, $linenr)) {
3879 WARN("MEMORY_BARRIER",
3880 "memory barrier without comment\n" . $herecurr);
3883 # check of hardware specific defines
3884 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
3886 "architecture specific defines should be avoided\n" . $herecurr);
3889 # Check that the storage class is at the beginning of a declaration
3890 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
3891 WARN("STORAGE_CLASS",
3892 "storage class should be at the beginning of the declaration\n" . $herecurr)
3895 # check the location of the inline attribute, that it is between
3896 # storage class and type.
3897 if ($line =~ /\b$Type\s+$Inline\b/ ||
3898 $line =~ /\b$Inline\s+$Storage\b/) {
3899 ERROR("INLINE_LOCATION",
3900 "inline keyword should sit between storage class and type\n" . $herecurr);
3903 # Check for __inline__ and __inline, prefer inline
3904 if ($realfile !~ m@\binclude/uapi/@ &&
3905 $line =~ /\b(__inline__|__inline)\b/) {
3907 "plain inline is preferred over $1\n" . $herecurr) &&
3909 $fixed[$linenr - 1] =~ s/\b(__inline__|__inline)\b/inline/;
3914 # Check for __attribute__ packed, prefer __packed
3915 if ($realfile !~ m@\binclude/uapi/@ &&
3916 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
3917 WARN("PREFER_PACKED",
3918 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
3921 # Check for __attribute__ aligned, prefer __aligned
3922 if ($realfile !~ m@\binclude/uapi/@ &&
3923 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
3924 WARN("PREFER_ALIGNED",
3925 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
3928 # Check for __attribute__ format(printf, prefer __printf
3929 if ($realfile !~ m@\binclude/uapi/@ &&
3930 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
3931 if (WARN("PREFER_PRINTF",
3932 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
3934 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
3939 # Check for __attribute__ format(scanf, prefer __scanf
3940 if ($realfile !~ m@\binclude/uapi/@ &&
3941 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
3942 if (WARN("PREFER_SCANF",
3943 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
3945 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
3949 # check for sizeof(&)
3950 if ($line =~ /\bsizeof\s*\(\s*\&/) {
3951 WARN("SIZEOF_ADDRESS",
3952 "sizeof(& should be avoided\n" . $herecurr);
3955 # check for sizeof without parenthesis
3956 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
3957 if (WARN("SIZEOF_PARENTHESIS",
3958 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
3960 $fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
3964 # check for line continuations in quoted strings with odd counts of "
3965 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
3966 WARN("LINE_CONTINUATIONS",
3967 "Avoid line continuations in quoted strings\n" . $herecurr);
3970 # check for struct spinlock declarations
3971 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
3972 WARN("USE_SPINLOCK_T",
3973 "struct spinlock should be spinlock_t\n" . $herecurr);
3976 # check for seq_printf uses that could be seq_puts
3977 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
3978 my $fmt = get_quoted_string($line, $rawline);
3979 if ($fmt ne "" && $fmt !~ /[^\\]\%/) {
3980 if (WARN("PREFER_SEQ_PUTS",
3981 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
3983 $fixed[$linenr - 1] =~ s/\bseq_printf\b/seq_puts/;
3988 # Check for misused memsets
3989 if ($^V && $^V ge 5.10.0 &&
3991 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
3997 if ($ms_size =~ /^(0x|)0$/i) {
3999 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
4000 } elsif ($ms_size =~ /^(0x|)1$/i) {
4002 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
4006 # typecasts on min/max could be min_t/max_t
4007 if ($^V && $^V ge 5.10.0 &&
4009 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
4010 if (defined $2 || defined $7) {
4012 my $cast1 = deparenthesize($2);
4014 my $cast2 = deparenthesize($7);
4018 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
4019 $cast = "$cast1 or $cast2";
4020 } elsif ($cast1 ne "") {
4026 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
4030 # check usleep_range arguments
4031 if ($^V && $^V ge 5.10.0 &&
4033 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
4037 WARN("USLEEP_RANGE",
4038 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4039 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
4041 WARN("USLEEP_RANGE",
4042 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4046 # check for naked sscanf
4047 if ($^V && $^V ge 5.10.0 &&
4049 $stat =~ /\bsscanf\b/ &&
4050 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
4051 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
4052 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
4053 my $lc = $stat =~ tr@\n@@;
4054 $lc = $lc + $linenr;
4055 my $stat_real = raw_line($linenr, 0);
4056 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4057 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4059 WARN("NAKED_SSCANF",
4060 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
4063 # check for new externs in .h files.
4064 if ($realfile =~ /\.h$/ &&
4065 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
4066 if (CHK("AVOID_EXTERNS",
4067 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
4069 $fixed[$linenr - 1] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
4073 # check for new externs in .c files.
4074 if ($realfile =~ /\.c$/ && defined $stat &&
4075 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
4077 my $function_name = $1;
4078 my $paren_space = $2;
4081 if (defined $cond) {
4082 substr($s, 0, length($cond), '');
4084 if ($s =~ /^\s*;/ &&
4085 $function_name ne 'uninitialized_var')
4087 WARN("AVOID_EXTERNS",
4088 "externs should be avoided in .c files\n" . $herecurr);
4091 if ($paren_space =~ /\n/) {
4092 WARN("FUNCTION_ARGUMENTS",
4093 "arguments for function declarations should follow identifier\n" . $herecurr);
4096 } elsif ($realfile =~ /\.c$/ && defined $stat &&
4097 $stat =~ /^.\s*extern\s+/)
4099 WARN("AVOID_EXTERNS",
4100 "externs should be avoided in .c files\n" . $herecurr);
4103 # checks for new __setup's
4104 if ($rawline =~ /\b__setup\("([^"]*)"/) {
4107 if (!grep(/$name/, @setup_docs)) {
4108 CHK("UNDOCUMENTED_SETUP",
4109 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
4113 # check for pointless casting of kmalloc return
4114 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
4115 WARN("UNNECESSARY_CASTS",
4116 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
4120 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
4121 if ($^V && $^V ge 5.10.0 &&
4122 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
4123 CHK("ALLOC_SIZEOF_STRUCT",
4124 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
4127 # check for krealloc arg reuse
4128 if ($^V && $^V ge 5.10.0 &&
4129 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
4130 WARN("KREALLOC_ARG_REUSE",
4131 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
4134 # check for alloc argument mismatch
4135 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
4136 WARN("ALLOC_ARRAY_ARGS",
4137 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
4140 # check for GFP_NOWAIT use
4141 if ($line =~ /\b__GFP_NOFAIL\b/) {
4142 WARN("__GFP_NOFAIL",
4143 "Use of __GFP_NOFAIL is deprecated, no new users should be added\n" . $herecurr);
4146 # check for multiple semicolons
4147 if ($line =~ /;\s*;\s*$/) {
4148 if (WARN("ONE_SEMICOLON",
4149 "Statements terminations use 1 semicolon\n" . $herecurr) &&
4151 $fixed[$linenr - 1] =~ s/(\s*;\s*){2,}$/;/g;
4155 # check for case / default statements not preceeded by break/fallthrough/switch
4156 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
4158 my $has_statement = 0;
4160 my $prevline = $linenr;
4161 while ($prevline > 1 && $count < 3 && !$has_break) {
4163 my $rline = $rawlines[$prevline - 1];
4164 my $fline = $lines[$prevline - 1];
4165 last if ($fline =~ /^\@\@/);
4166 next if ($fline =~ /^\-/);
4167 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
4168 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
4169 next if ($fline =~ /^.[\s$;]*$/);
4172 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
4174 if (!$has_break && $has_statement) {
4175 WARN("MISSING_BREAK",
4176 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
4180 # check for switch/default statements without a break;
4181 if ($^V && $^V ge 5.10.0 &&
4183 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
4185 my $herectx = $here . "\n";
4186 my $cnt = statement_rawlines($stat);
4187 for (my $n = 0; $n < $cnt; $n++) {
4188 $herectx .= raw_line($linenr, $n) . "\n";
4190 WARN("DEFAULT_NO_BREAK",
4191 "switch default: should use break\n" . $herectx);
4194 # check for gcc specific __FUNCTION__
4195 if ($line =~ /\b__FUNCTION__\b/) {
4196 if (WARN("USE_FUNC",
4197 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
4199 $fixed[$linenr - 1] =~ s/\b__FUNCTION__\b/__func__/g;
4203 # check for use of yield()
4204 if ($line =~ /\byield\s*\(\s*\)/) {
4206 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
4209 # check for comparisons against true and false
4210 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
4218 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
4220 my $type = lc($otype);
4221 if ($type =~ /^(?:true|false)$/) {
4222 if (("$test" eq "==" && "$type" eq "true") ||
4223 ("$test" eq "!=" && "$type" eq "false")) {
4227 CHK("BOOL_COMPARISON",
4228 "Using comparison to $otype is error prone\n" . $herecurr);
4230 ## maybe suggesting a correct construct would better
4231 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
4236 # check for semaphores initialized locked
4237 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
4238 WARN("CONSIDER_COMPLETION",
4239 "consider using a completion\n" . $herecurr);
4242 # recommend kstrto* over simple_strto* and strict_strto*
4243 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
4244 WARN("CONSIDER_KSTRTO",
4245 "$1 is obsolete, use k$3 instead\n" . $herecurr);
4248 # check for __initcall(), use device_initcall() explicitly please
4249 if ($line =~ /^.\s*__initcall\s*\(/) {
4250 WARN("USE_DEVICE_INITCALL",
4251 "please use device_initcall() instead of __initcall()\n" . $herecurr);
4254 # check for various ops structs, ensure they are const.
4255 my $struct_ops = qr{acpi_dock_ops|
4256 address_space_operations|
4258 block_device_operations|
4263 file_lock_operations|
4273 lock_manager_operations|
4279 pipe_buf_operations|
4280 platform_hibernation_ops|
4281 platform_suspend_ops|
4286 soc_pcmcia_socket_ops|
4292 if ($line !~ /\bconst\b/ &&
4293 $line =~ /\bstruct\s+($struct_ops)\b/) {
4294 WARN("CONST_STRUCT",
4295 "struct $1 should normally be const\n" .
4299 # use of NR_CPUS is usually wrong
4300 # ignore definitions of NR_CPUS and usage to define arrays as likely right
4301 if ($line =~ /\bNR_CPUS\b/ &&
4302 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
4303 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
4304 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
4305 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
4306 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
4309 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
4312 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
4313 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
4314 ERROR("DEFINE_ARCH_HAS",
4315 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
4318 # check for %L{u,d,i} in strings
4320 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4321 $string = substr($rawline, $-[1], $+[1] - $-[1]);
4322 $string =~ s/%%/__/g;
4323 if ($string =~ /(?<!%)%L[udi]/) {
4325 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
4330 # whine mightly about in_atomic
4331 if ($line =~ /\bin_atomic\s*\(/) {
4332 if ($realfile =~ m@^drivers/@) {
4334 "do not use in_atomic in drivers\n" . $herecurr);
4335 } elsif ($realfile !~ m@^kernel/@) {
4337 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
4341 # check for lockdep_set_novalidate_class
4342 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
4343 $line =~ /__lockdep_no_validate__\s*\)/ ) {
4344 if ($realfile !~ m@^kernel/lockdep@ &&
4345 $realfile !~ m@^include/linux/lockdep@ &&
4346 $realfile !~ m@^drivers/base/core@) {
4348 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
4352 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
4353 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
4354 WARN("EXPORTED_WORLD_WRITABLE",
4355 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
4359 # If we have no input at all, then there is nothing to report on
4360 # so just keep quiet.
4361 if ($#rawlines == -1) {
4365 # In mailback mode only produce a report in the negative, for
4366 # things that appear to be patches.
4367 if ($mailback && ($clean == 1 || !$is_patch)) {
4371 # This is not a patch, and we are are in 'no-patch' mode so
4373 if (!$chk_patch && !$is_patch) {
4378 ERROR("NOT_UNIFIED_DIFF",
4379 "Does not appear to be a unified-diff format patch\n");
4381 if ($is_patch && $chk_signoff && $signoff == 0) {
4382 ERROR("MISSING_SIGN_OFF",
4383 "Missing Signed-off-by: line(s)\n");
4386 print report_dump();
4387 if ($summary && !($clean == 1 && $quiet == 1)) {
4388 print "$filename " if ($summary_file);
4389 print "total: $cnt_error errors, $cnt_warn warnings, " .
4390 (($check)? "$cnt_chk checks, " : "") .
4391 "$cnt_lines lines checked\n";
4392 print "\n" if ($quiet == 0);
4397 if ($^V lt 5.10.0) {
4398 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
4399 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
4402 # If there were whitespace errors which cleanpatch can fix
4403 # then suggest that.
4404 if ($rpt_cleaners) {
4405 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
4406 print " scripts/cleanfile\n\n";
4411 hash_show_words(\%use_type, "Used");
4412 hash_show_words(\%ignore_type, "Ignored");
4414 if ($clean == 0 && $fix && "@rawlines" ne "@fixed") {
4415 my $newfile = $filename;
4416 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
4420 open($f, '>', $newfile)
4421 or die "$P: Can't open $newfile for write\n";
4422 foreach my $fixed_line (@fixed) {
4425 if ($linecount > 3) {
4426 $fixed_line =~ s/^\+//;
4427 print $f $fixed_line. "\n";
4430 print $f $fixed_line . "\n";
4437 Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
4439 Do _NOT_ trust the results written to this file.
4440 Do _NOT_ submit these changes without inspecting them for correctness.
4442 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
4443 No warranties, expressed or implied...
4449 if ($clean == 1 && $quiet == 0) {
4450 print "$vname has no obvious style problems and is ready for submission.\n"
4452 if ($clean == 0 && $quiet == 0) {
4454 $vname has style problems, please review.
4456 If any of these errors are false positives, please report
4457 them to the maintainer, see CHECKPATCH in MAINTAINERS.