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);
42 my $configuration_file = ".checkpatch.conf";
43 my $max_line_length = 80;
44 my $ignore_perl_version = 0;
45 my $minimum_perl_version = 5.10.0;
51 Usage: $P [OPTION]... [FILE]...
56 --no-tree run without a kernel tree
57 --no-signoff do not check for 'Signed-off-by' line
58 --patch treat FILE as patchfile (default)
59 --emacs emacs compile window format
60 --terse one line per report
61 -f, --file treat FILE as regular source file
62 --subjective, --strict enable more subjective tests
63 --types TYPE(,TYPE2...) show only these comma separated message types
64 --ignore TYPE(,TYPE2...) ignore various comma separated message types
65 --max-line-length=n set the maximum line length, if exceeded, warn
66 --show-types show the message "types" in the output
67 --root=PATH PATH to the kernel tree root
68 --no-summary suppress the per-file summary
69 --mailback only produce a report in case of warnings/errors
70 --summary-file include the filename in summary
71 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
72 'values', 'possible', 'type', and 'attr' (default
74 --test-only=WORD report only warnings/errors containing WORD
76 --fix EXPERIMENTAL - may create horrible results
77 If correctable single-line errors exist, create
78 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
79 with potential errors corrected to the preferred
81 --fix-inplace EXPERIMENTAL - may create horrible results
82 Is the same as --fix, but overwrites the input
83 file. It's your fault if there's no backup or git
84 --ignore-perl-version override checking of perl version. expect
86 -h, --help, --version display this help and exit
88 When FILE is - read standard input.
94 my $conf = which_conf($configuration_file);
97 open(my $conffile, '<', "$conf")
98 or warn "$P: Can't find a readable $configuration_file file $!\n";
100 while (<$conffile>) {
103 $line =~ s/\s*\n?$//g;
107 next if ($line =~ m/^\s*#/);
108 next if ($line =~ m/^\s*$/);
110 my @words = split(" ", $line);
111 foreach my $word (@words) {
112 last if ($word =~ m/^#/);
113 push (@conf_args, $word);
117 unshift(@ARGV, @conf_args) if @conf_args;
121 'q|quiet+' => \$quiet,
123 'signoff!' => \$chk_signoff,
124 'patch!' => \$chk_patch,
128 'subjective!' => \$check,
129 'strict!' => \$check,
130 'ignore=s' => \@ignore,
132 'show-types!' => \$show_types,
133 'max-line-length=i' => \$max_line_length,
135 'summary!' => \$summary,
136 'mailback!' => \$mailback,
137 'summary-file!' => \$summary_file,
139 'fix-inplace!' => \$fix_inplace,
140 'ignore-perl-version!' => \$ignore_perl_version,
141 'debug=s' => \%debug,
142 'test-only=s' => \$tst_only,
149 $fix = 1 if ($fix_inplace);
150 $check_orig = $check;
154 if ($^V && $^V lt $minimum_perl_version) {
155 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
156 if (!$ignore_perl_version) {
162 print "$P: no input files\n";
166 sub hash_save_array_words {
167 my ($hashRef, $arrayRef) = @_;
169 my @array = split(/,/, join(',', @$arrayRef));
170 foreach my $word (@array) {
171 $word =~ s/\s*\n?$//g;
174 $word =~ tr/[a-z]/[A-Z]/;
176 next if ($word =~ m/^\s*#/);
177 next if ($word =~ m/^\s*$/);
183 sub hash_show_words {
184 my ($hashRef, $prefix) = @_;
186 if ($quiet == 0 && keys %$hashRef) {
187 print "NOTE: $prefix message types:";
188 foreach my $word (sort keys %$hashRef) {
195 hash_save_array_words(\%ignore_type, \@ignore);
196 hash_save_array_words(\%use_type, \@use);
199 my $dbg_possible = 0;
202 for my $key (keys %debug) {
204 eval "\${dbg_$key} = '$debug{$key}';";
208 my $rpt_cleaners = 0;
217 if (!top_of_kernel_tree($root)) {
218 die "$P: $root: --root does not point at a valid tree\n";
221 if (top_of_kernel_tree('.')) {
223 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
224 top_of_kernel_tree($1)) {
229 if (!defined $root) {
230 print "Must be run from the top-level dir. of a kernel tree\n";
235 my $emitted_corrupt = 0;
238 [A-Za-z_][A-Za-z\d_]*
239 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
241 our $Storage = qr{extern|static|asmlinkage};
253 our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
254 our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
255 our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
256 our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
257 our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
259 # Notes to $Attribute:
260 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
280 ____cacheline_aligned|
281 ____cacheline_aligned_in_smp|
282 ____cacheline_internodealigned_in_smp|
286 our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
287 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
288 our $Lval = qr{$Ident(?:$Member)*};
290 our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
291 our $Binary = qr{(?i)0b[01]+$Int_type?};
292 our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
293 our $Int = qr{[0-9]+$Int_type?};
294 our $Octal = qr{0[0-7]+$Int_type?};
295 our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
296 our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
297 our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
298 our $Float = qr{$Float_hex|$Float_dec|$Float_int};
299 our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
300 our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
301 our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
302 our $Arithmetic = qr{\+|-|\*|\/|%};
306 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
309 our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
312 our $NonptrTypeWithAttr;
316 our $NON_ASCII_UTF8 = qr{
317 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
318 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
319 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
320 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
321 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
322 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
323 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
327 [\x09\x0A\x0D\x20-\x7E] # ASCII
331 our $typeTypedefs = qr{(?x:
332 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
336 our $logFunctions = qr{(?x:
337 printk(?:_ratelimited|_once|)|
338 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
339 WARN(?:_RATELIMIT|_ONCE|)|
342 seq_vprintf|seq_printf|seq_puts
345 our $signature_tags = qr{(?xi:
358 qr{(?:unsigned\s+)?char},
359 qr{(?:unsigned\s+)?short},
360 qr{(?:unsigned\s+)?int},
361 qr{(?:unsigned\s+)?long},
362 qr{(?:unsigned\s+)?long\s+int},
363 qr{(?:unsigned\s+)?long\s+long},
364 qr{(?:unsigned\s+)?long\s+long\s+int},
373 qr{${Ident}_handler},
374 qr{${Ident}_handler_fn},
376 our @typeListWithAttr = (
378 qr{struct\s+$InitAttribute\s+$Ident},
379 qr{union\s+$InitAttribute\s+$Ident},
382 our @modifierList = (
386 our @mode_permission_funcs = (
388 ["module_param_(?:array|named|string)", 4],
389 ["module_param_array_named", 5],
390 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
391 ["proc_create(?:_data|)", 2],
392 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
395 #Create a search pattern for all these functions to speed up a loop below
396 our $mode_perms_search = "";
397 foreach my $entry (@mode_permission_funcs) {
398 $mode_perms_search .= '|' if ($mode_perms_search ne "");
399 $mode_perms_search .= $entry->[0];
402 our $declaration_macros = qr{(?x:
403 (?:$Storage\s+)?(?:DECLARE|DEFINE)_[A-Z]+\s*\(|
404 (?:$Storage\s+)?LIST_HEAD\s*\(
407 our $allowed_asm_includes = qr{(?x:
411 # memory.h: ARM has a custom one
414 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
415 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
416 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
417 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
419 (?:$Modifier\s+|const\s+)*
421 (?:typeof|__typeof__)\s*\([^\)]*\)|
425 (?:\s+$Modifier|\s+const)*
427 $NonptrTypeWithAttr = qr{
428 (?:$Modifier\s+|const\s+)*
430 (?:typeof|__typeof__)\s*\([^\)]*\)|
434 (?:\s+$Modifier|\s+const)*
438 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
439 (?:\s+$Inline|\s+$Modifier)*
441 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
445 our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
447 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
448 # requires at least perl version v5.10.0
449 # Any use must be runtime checked with $^V
451 our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
452 our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
453 our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
457 return "" if (!defined($string));
459 while ($string =~ /^\s*\(.*\)\s*$/) {
460 $string =~ s@^\s*\(\s*@@;
461 $string =~ s@\s*\)\s*$@@;
464 $string =~ s@\s+@ @g;
469 sub seed_camelcase_file {
472 return if (!(-f $file));
476 open(my $include_file, '<', "$file")
477 or warn "$P: Can't read '$file' $!\n";
478 my $text = <$include_file>;
479 close($include_file);
481 my @lines = split('\n', $text);
483 foreach my $line (@lines) {
484 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
485 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
487 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
489 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
495 my $camelcase_seeded = 0;
496 sub seed_camelcase_includes {
497 return if ($camelcase_seeded);
500 my $camelcase_cache = "";
501 my @include_files = ();
503 $camelcase_seeded = 1;
506 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
507 chomp $git_last_include_commit;
508 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
510 my $last_mod_date = 0;
511 $files = `find $root/include -name "*.h"`;
512 @include_files = split('\n', $files);
513 foreach my $file (@include_files) {
514 my $date = POSIX::strftime("%Y%m%d%H%M",
515 localtime((stat $file)[9]));
516 $last_mod_date = $date if ($last_mod_date < $date);
518 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
521 if ($camelcase_cache ne "" && -f $camelcase_cache) {
522 open(my $camelcase_file, '<', "$camelcase_cache")
523 or warn "$P: Can't read '$camelcase_cache' $!\n";
524 while (<$camelcase_file>) {
528 close($camelcase_file);
534 $files = `git ls-files "include/*.h"`;
535 @include_files = split('\n', $files);
538 foreach my $file (@include_files) {
539 seed_camelcase_file($file);
542 if ($camelcase_cache ne "") {
543 unlink glob ".checkpatch-camelcase.*";
544 open(my $camelcase_file, '>', "$camelcase_cache")
545 or warn "$P: Can't write '$camelcase_cache' $!\n";
546 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
547 print $camelcase_file ("$_\n");
549 close($camelcase_file);
553 sub git_commit_info {
554 my ($commit, $id, $desc) = @_;
556 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
558 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
559 $output =~ s/^\s*//gm;
560 my @lines = split("\n", $output);
562 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
563 # Maybe one day convert this block of bash into something that returns
564 # all matching commit ids, but it's very slow...
566 # echo "checking commits $1..."
567 # git rev-list --remotes | grep -i "^$1" |
568 # while read line ; do
569 # git log --format='%H %s' -1 $line |
570 # echo "commit $(cut -c 1-12,41-)"
572 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
574 $id = substr($lines[0], 0, 12);
575 $desc = substr($lines[0], 41);
581 $chk_signoff = 0 if ($file);
587 for my $filename (@ARGV) {
590 open($FILE, '-|', "diff -u /dev/null $filename") ||
591 die "$P: $filename: diff failed - $!\n";
592 } elsif ($filename eq '-') {
593 open($FILE, '<&STDIN');
595 open($FILE, '<', "$filename") ||
596 die "$P: $filename: open failed - $!\n";
598 if ($filename eq '-') {
599 $vname = 'Your patch';
608 if (!process($filename)) {
618 sub top_of_kernel_tree {
622 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
623 "README", "Documentation", "arch", "include", "drivers",
624 "fs", "init", "ipc", "kernel", "lib", "scripts",
627 foreach my $check (@tree_check) {
628 if (! -e $root . '/' . $check) {
636 my ($formatted_email) = @_;
642 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
645 $comment = $3 if defined $3;
646 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
648 $comment = $2 if defined $2;
649 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
651 $comment = $2 if defined $2;
652 $formatted_email =~ s/$address.*$//;
653 $name = $formatted_email;
655 $name =~ s/^\"|\"$//g;
656 # If there's a name left after stripping spaces and
657 # leading quotes, and the address doesn't have both
658 # leading and trailing angle brackets, the address
660 # "joe smith joe@smith.com" bad
661 # "joe smith <joe@smith.com" bad
662 if ($name ne "" && $address !~ /^<[^>]+>$/) {
670 $name =~ s/^\"|\"$//g;
671 $address = trim($address);
672 $address =~ s/^\<|\>$//g;
674 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
675 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
679 return ($name, $address, $comment);
683 my ($name, $address) = @_;
688 $name =~ s/^\"|\"$//g;
689 $address = trim($address);
691 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
692 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
697 $formatted_email = "$address";
699 $formatted_email = "$name <$address>";
702 return $formatted_email;
708 foreach my $path (split(/:/, $ENV{PATH})) {
709 if (-e "$path/$bin") {
720 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
721 if (-e "$path/$conf") {
722 return "$path/$conf";
734 for my $c (split(//, $str)) {
738 for (; ($n % 8) != 0; $n++) {
750 (my $res = shift) =~ tr/\t/ /c;
757 # Drop the diff line leader and expand tabs
759 $line = expand_tabs($line);
761 # Pick the indent from the front of the line.
762 my ($white) = ($line =~ /^(\s*)/);
764 return (length($line), length($white));
767 my $sanitise_quote = '';
769 sub sanitise_line_reset {
770 my ($in_comment) = @_;
773 $sanitise_quote = '*/';
775 $sanitise_quote = '';
788 # Always copy over the diff marker.
789 $res = substr($line, 0, 1);
791 for ($off = 1; $off < length($line); $off++) {
792 $c = substr($line, $off, 1);
794 # Comments we are wacking completly including the begin
795 # and end, all to $;.
796 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
797 $sanitise_quote = '*/';
799 substr($res, $off, 2, "$;$;");
803 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
804 $sanitise_quote = '';
805 substr($res, $off, 2, "$;$;");
809 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
810 $sanitise_quote = '//';
812 substr($res, $off, 2, $sanitise_quote);
817 # A \ in a string means ignore the next character.
818 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
820 substr($res, $off, 2, 'XX');
825 if ($c eq "'" || $c eq '"') {
826 if ($sanitise_quote eq '') {
827 $sanitise_quote = $c;
829 substr($res, $off, 1, $c);
831 } elsif ($sanitise_quote eq $c) {
832 $sanitise_quote = '';
836 #print "c<$c> SQ<$sanitise_quote>\n";
837 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
838 substr($res, $off, 1, $;);
839 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
840 substr($res, $off, 1, $;);
841 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
842 substr($res, $off, 1, 'X');
844 substr($res, $off, 1, $c);
848 if ($sanitise_quote eq '//') {
849 $sanitise_quote = '';
852 # The pathname on a #include may be surrounded by '<' and '>'.
853 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
854 my $clean = 'X' x length($1);
855 $res =~ s@\<.*\>@<$clean>@;
857 # The whole of a #error is a string.
858 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
859 my $clean = 'X' x length($1);
860 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
866 sub get_quoted_string {
867 my ($line, $rawline) = @_;
869 return "" if ($line !~ m/(\"[X]+\")/g);
870 return substr($rawline, $-[0], $+[0] - $-[0]);
873 sub ctx_statement_block {
874 my ($linenr, $remain, $off) = @_;
875 my $line = $linenr - 1;
892 @stack = (['', 0]) if ($#stack == -1);
894 #warn "CSB: blk<$blk> remain<$remain>\n";
895 # If we are about to drop off the end, pull in more
898 for (; $remain > 0; $line++) {
899 last if (!defined $lines[$line]);
900 next if ($lines[$line] =~ /^-/);
903 $blk .= $lines[$line] . "\n";
908 # Bail if there is no further context.
909 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
913 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
919 $c = substr($blk, $off, 1);
920 $remainder = substr($blk, $off);
922 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
924 # Handle nested #if/#else.
925 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
926 push(@stack, [ $type, $level ]);
927 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
928 ($type, $level) = @{$stack[$#stack - 1]};
929 } elsif ($remainder =~ /^#\s*endif\b/) {
930 ($type, $level) = @{pop(@stack)};
933 # Statement ends at the ';' or a close '}' at the
935 if ($level == 0 && $c eq ';') {
939 # An else is really a conditional as long as its not else if
940 if ($level == 0 && $coff_set == 0 &&
941 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
942 $remainder =~ /^(else)(?:\s|{)/ &&
943 $remainder !~ /^else\s+if\b/) {
944 $coff = $off + length($1) - 1;
946 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
947 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
950 if (($type eq '' || $type eq '(') && $c eq '(') {
954 if ($type eq '(' && $c eq ')') {
956 $type = ($level != 0)? '(' : '';
958 if ($level == 0 && $coff < $soff) {
961 #warn "CSB: mark coff<$coff>\n";
964 if (($type eq '' || $type eq '{') && $c eq '{') {
968 if ($type eq '{' && $c eq '}') {
970 $type = ($level != 0)? '{' : '';
973 if (substr($blk, $off + 1, 1) eq ';') {
979 # Preprocessor commands end at the newline unless escaped.
980 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
988 # We are truly at the end, so shuffle to the next line.
995 my $statement = substr($blk, $soff, $off - $soff + 1);
996 my $condition = substr($blk, $soff, $coff - $soff + 1);
998 #warn "STATEMENT<$statement>\n";
999 #warn "CONDITION<$condition>\n";
1001 #print "coff<$coff> soff<$off> loff<$loff>\n";
1003 return ($statement, $condition,
1004 $line, $remain + 1, $off - $loff + 1, $level);
1007 sub statement_lines {
1010 # Strip the diff line prefixes and rip blank lines at start and end.
1011 $stmt =~ s/(^|\n)./$1/g;
1015 my @stmt_lines = ($stmt =~ /\n/g);
1017 return $#stmt_lines + 2;
1020 sub statement_rawlines {
1023 my @stmt_lines = ($stmt =~ /\n/g);
1025 return $#stmt_lines + 2;
1028 sub statement_block_size {
1031 $stmt =~ s/(^|\n)./$1/g;
1037 my @stmt_lines = ($stmt =~ /\n/g);
1038 my @stmt_statements = ($stmt =~ /;/g);
1040 my $stmt_lines = $#stmt_lines + 2;
1041 my $stmt_statements = $#stmt_statements + 1;
1043 if ($stmt_lines > $stmt_statements) {
1046 return $stmt_statements;
1050 sub ctx_statement_full {
1051 my ($linenr, $remain, $off) = @_;
1052 my ($statement, $condition, $level);
1056 # Grab the first conditional/block pair.
1057 ($statement, $condition, $linenr, $remain, $off, $level) =
1058 ctx_statement_block($linenr, $remain, $off);
1059 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1060 push(@chunks, [ $condition, $statement ]);
1061 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1062 return ($level, $linenr, @chunks);
1065 # Pull in the following conditional/block pairs and see if they
1066 # could continue the statement.
1068 ($statement, $condition, $linenr, $remain, $off, $level) =
1069 ctx_statement_block($linenr, $remain, $off);
1070 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1071 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1073 push(@chunks, [ $condition, $statement ]);
1076 return ($level, $linenr, @chunks);
1080 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1082 my $start = $linenr - 1;
1089 my @stack = ($level);
1090 for ($line = $start; $remain > 0; $line++) {
1091 next if ($rawlines[$line] =~ /^-/);
1094 $blk .= $rawlines[$line];
1096 # Handle nested #if/#else.
1097 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1098 push(@stack, $level);
1099 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1100 $level = $stack[$#stack - 1];
1101 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1102 $level = pop(@stack);
1105 foreach my $c (split(//, $lines[$line])) {
1106 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1112 if ($c eq $close && $level > 0) {
1114 last if ($level == 0);
1115 } elsif ($c eq $open) {
1120 if (!$outer || $level <= 1) {
1121 push(@res, $rawlines[$line]);
1124 last if ($level == 0);
1127 return ($level, @res);
1129 sub ctx_block_outer {
1130 my ($linenr, $remain) = @_;
1132 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1136 my ($linenr, $remain) = @_;
1138 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1142 my ($linenr, $remain, $off) = @_;
1144 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1147 sub ctx_block_level {
1148 my ($linenr, $remain) = @_;
1150 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1152 sub ctx_statement_level {
1153 my ($linenr, $remain, $off) = @_;
1155 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1158 sub ctx_locate_comment {
1159 my ($first_line, $end_line) = @_;
1161 # Catch a comment on the end of the line itself.
1162 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1163 return $current_comment if (defined $current_comment);
1165 # Look through the context and try and figure out if there is a
1168 $current_comment = '';
1169 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1170 my $line = $rawlines[$linenr - 1];
1172 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1175 if ($line =~ m@/\*@) {
1178 if (!$in_comment && $current_comment ne '') {
1179 $current_comment = '';
1181 $current_comment .= $line . "\n" if ($in_comment);
1182 if ($line =~ m@\*/@) {
1187 chomp($current_comment);
1188 return($current_comment);
1190 sub ctx_has_comment {
1191 my ($first_line, $end_line) = @_;
1192 my $cmt = ctx_locate_comment($first_line, $end_line);
1194 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1195 ##print "CMMT: $cmt\n";
1197 return ($cmt ne '');
1201 my ($linenr, $cnt) = @_;
1203 my $offset = $linenr - 1;
1208 $line = $rawlines[$offset++];
1209 next if (defined($line) && $line =~ /^-/);
1221 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1224 $coded = sprintf("^%c", unpack('C', $2) + 64);
1233 my $av_preprocessor = 0;
1238 sub annotate_reset {
1239 $av_preprocessor = 0;
1241 @av_paren_type = ('E');
1242 $av_pend_colon = 'O';
1245 sub annotate_values {
1246 my ($stream, $type) = @_;
1249 my $var = '_' x length($stream);
1252 print "$stream\n" if ($dbg_values > 1);
1254 while (length($cur)) {
1255 @av_paren_type = ('E') if ($#av_paren_type < 0);
1256 print " <" . join('', @av_paren_type) .
1257 "> <$type> <$av_pending>" if ($dbg_values > 1);
1258 if ($cur =~ /^(\s+)/o) {
1259 print "WS($1)\n" if ($dbg_values > 1);
1260 if ($1 =~ /\n/ && $av_preprocessor) {
1261 $type = pop(@av_paren_type);
1262 $av_preprocessor = 0;
1265 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1266 print "CAST($1)\n" if ($dbg_values > 1);
1267 push(@av_paren_type, $type);
1270 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1271 print "DECLARE($1)\n" if ($dbg_values > 1);
1274 } elsif ($cur =~ /^($Modifier)\s*/) {
1275 print "MODIFIER($1)\n" if ($dbg_values > 1);
1278 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1279 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1280 $av_preprocessor = 1;
1281 push(@av_paren_type, $type);
1287 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1288 print "UNDEF($1)\n" if ($dbg_values > 1);
1289 $av_preprocessor = 1;
1290 push(@av_paren_type, $type);
1292 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1293 print "PRE_START($1)\n" if ($dbg_values > 1);
1294 $av_preprocessor = 1;
1296 push(@av_paren_type, $type);
1297 push(@av_paren_type, $type);
1300 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1301 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1302 $av_preprocessor = 1;
1304 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1308 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1309 print "PRE_END($1)\n" if ($dbg_values > 1);
1311 $av_preprocessor = 1;
1313 # Assume all arms of the conditional end as this
1314 # one does, and continue as if the #endif was not here.
1315 pop(@av_paren_type);
1316 push(@av_paren_type, $type);
1319 } elsif ($cur =~ /^(\\\n)/o) {
1320 print "PRECONT($1)\n" if ($dbg_values > 1);
1322 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1323 print "ATTR($1)\n" if ($dbg_values > 1);
1324 $av_pending = $type;
1327 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1328 print "SIZEOF($1)\n" if ($dbg_values > 1);
1334 } elsif ($cur =~ /^(if|while|for)\b/o) {
1335 print "COND($1)\n" if ($dbg_values > 1);
1339 } elsif ($cur =~/^(case)/o) {
1340 print "CASE($1)\n" if ($dbg_values > 1);
1341 $av_pend_colon = 'C';
1344 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1345 print "KEYWORD($1)\n" if ($dbg_values > 1);
1348 } elsif ($cur =~ /^(\()/o) {
1349 print "PAREN('$1')\n" if ($dbg_values > 1);
1350 push(@av_paren_type, $av_pending);
1354 } elsif ($cur =~ /^(\))/o) {
1355 my $new_type = pop(@av_paren_type);
1356 if ($new_type ne '_') {
1358 print "PAREN('$1') -> $type\n"
1359 if ($dbg_values > 1);
1361 print "PAREN('$1')\n" if ($dbg_values > 1);
1364 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1365 print "FUNC($1)\n" if ($dbg_values > 1);
1369 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1370 if (defined $2 && $type eq 'C' || $type eq 'T') {
1371 $av_pend_colon = 'B';
1372 } elsif ($type eq 'E') {
1373 $av_pend_colon = 'L';
1375 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1378 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1379 print "IDENT($1)\n" if ($dbg_values > 1);
1382 } elsif ($cur =~ /^($Assignment)/o) {
1383 print "ASSIGN($1)\n" if ($dbg_values > 1);
1386 } elsif ($cur =~/^(;|{|})/) {
1387 print "END($1)\n" if ($dbg_values > 1);
1389 $av_pend_colon = 'O';
1391 } elsif ($cur =~/^(,)/) {
1392 print "COMMA($1)\n" if ($dbg_values > 1);
1395 } elsif ($cur =~ /^(\?)/o) {
1396 print "QUESTION($1)\n" if ($dbg_values > 1);
1399 } elsif ($cur =~ /^(:)/o) {
1400 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1402 substr($var, length($res), 1, $av_pend_colon);
1403 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1408 $av_pend_colon = 'O';
1410 } elsif ($cur =~ /^(\[)/o) {
1411 print "CLOSE($1)\n" if ($dbg_values > 1);
1414 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1417 print "OPV($1)\n" if ($dbg_values > 1);
1424 substr($var, length($res), 1, $variant);
1427 } elsif ($cur =~ /^($Operators)/o) {
1428 print "OP($1)\n" if ($dbg_values > 1);
1429 if ($1 ne '++' && $1 ne '--') {
1433 } elsif ($cur =~ /(^.)/o) {
1434 print "C($1)\n" if ($dbg_values > 1);
1437 $cur = substr($cur, length($1));
1438 $res .= $type x length($1);
1442 return ($res, $var);
1446 my ($possible, $line) = @_;
1447 my $notPermitted = qr{(?:
1464 ^(?:typedef|struct|enum)\b
1466 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1467 if ($possible !~ $notPermitted) {
1468 # Check for modifiers.
1469 $possible =~ s/\s*$Storage\s*//g;
1470 $possible =~ s/\s*$Sparse\s*//g;
1471 if ($possible =~ /^\s*$/) {
1473 } elsif ($possible =~ /\s/) {
1474 $possible =~ s/\s*$Type\s*//g;
1475 for my $modifier (split(' ', $possible)) {
1476 if ($modifier !~ $notPermitted) {
1477 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1478 push(@modifierList, $modifier);
1483 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1484 push(@typeList, $possible);
1488 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1497 return defined $use_type{$type} if (scalar keys %use_type > 0);
1499 return !defined $ignore_type{$type};
1503 my ($level, $type, $msg) = @_;
1505 if (!show_type($type) ||
1506 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
1511 $line = "$prefix$level:$type: $msg\n";
1513 $line = "$prefix$level: $msg\n";
1515 $line = (split('\n', $line))[0] . "\n" if ($terse);
1517 push(our @report, $line);
1527 my ($type, $msg) = @_;
1529 if (report("ERROR", $type, $msg)) {
1537 my ($type, $msg) = @_;
1539 if (report("WARNING", $type, $msg)) {
1547 my ($type, $msg) = @_;
1549 if ($check && report("CHECK", $type, $msg)) {
1557 sub check_absolute_file {
1558 my ($absolute, $herecurr) = @_;
1559 my $file = $absolute;
1561 ##print "absolute<$absolute>\n";
1563 # See if any suffix of this path is a path within the tree.
1564 while ($file =~ s@^[^/]*/@@) {
1565 if (-f "$root/$file") {
1566 ##print "file<$file>\n";
1574 # It is, so see if the prefix is acceptable.
1575 my $prefix = $absolute;
1576 substr($prefix, -length($file)) = '';
1578 ##print "prefix<$prefix>\n";
1579 if ($prefix ne ".../") {
1580 WARN("USE_RELATIVE_PATH",
1581 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1588 $string =~ s/^\s+|\s+$//g;
1596 $string =~ s/^\s+//;
1604 $string =~ s/\s+$//;
1609 sub string_find_replace {
1610 my ($string, $find, $replace) = @_;
1612 $string =~ s/$find/$replace/g;
1620 my $source_indent = 8;
1621 my $max_spaces_before_tab = $source_indent - 1;
1622 my $spaces_to_tab = " " x $source_indent;
1624 #convert leading spaces to tabs
1625 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1626 #Remove spaces before a tab
1627 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1632 sub pos_last_openparen {
1637 my $opens = $line =~ tr/\(/\(/;
1638 my $closes = $line =~ tr/\)/\)/;
1640 my $last_openparen = 0;
1642 if (($opens == 0) || ($closes >= $opens)) {
1646 my $len = length($line);
1648 for ($pos = 0; $pos < $len; $pos++) {
1649 my $string = substr($line, $pos);
1650 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1651 $pos += length($1) - 1;
1652 } elsif (substr($line, $pos, 1) eq '(') {
1653 $last_openparen = $pos;
1654 } elsif (index($string, '(') == -1) {
1659 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
1663 my $filename = shift;
1669 my $stashrawline="";
1680 my $in_header_lines = $file ? 0 : 1;
1681 my $in_commit_log = 0; #Scanning lines before patch
1682 my $reported_maintainer_file = 0;
1683 my $non_utf8_charset = 0;
1685 my $last_blank_line = 0;
1693 # Trace the real file/line as we go.
1699 my $comment_edge = 0;
1703 my $prev_values = 'E';
1706 my %suppress_ifbraces;
1707 my %suppress_whiletrailers;
1708 my %suppress_export;
1709 my $suppress_statement = 0;
1711 my %signatures = ();
1713 # Pre-scan the patch sanitizing the lines.
1714 # Pre-scan the patch looking for any __setup documentation.
1716 my @setup_docs = ();
1719 my $camelcase_file_seeded = 0;
1721 sanitise_line_reset();
1723 foreach my $rawline (@rawlines) {
1727 push(@fixed, $rawline) if ($fix);
1729 if ($rawline=~/^\+\+\+\s+(\S+)/) {
1731 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1736 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1745 # Guestimate if this is a continuing comment. Run
1746 # the context looking for a comment "edge". If this
1747 # edge is a close comment then we must be in a comment
1751 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1752 next if (defined $rawlines[$ln - 1] &&
1753 $rawlines[$ln - 1] =~ /^-/);
1755 #print "RAW<$rawlines[$ln - 1]>\n";
1756 last if (!defined $rawlines[$ln - 1]);
1757 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1758 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1763 if (defined $edge && $edge eq '*/') {
1767 # Guestimate if this is a continuing comment. If this
1768 # is the start of a diff block and this line starts
1769 # ' *' then it is very likely a comment.
1770 if (!defined $edge &&
1771 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1776 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1777 sanitise_line_reset($in_comment);
1779 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1780 # Standardise the strings and chars within the input to
1781 # simplify matching -- only bother with positive lines.
1782 $line = sanitise_line($rawline);
1784 push(@lines, $line);
1787 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1792 #print "==>$rawline\n";
1793 #print "-->$line\n";
1795 if ($setup_docs && $line =~ /^\+/) {
1796 push(@setup_docs, $line);
1804 foreach my $line (@lines) {
1806 my $sline = $line; #copy of $line
1807 $sline =~ s/$;/ /g; #with comments as spaces
1809 my $rawline = $rawlines[$linenr - 1];
1811 #extract the line range in the file after the patch is applied
1812 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1814 $first_line = $linenr + 1;
1824 %suppress_ifbraces = ();
1825 %suppress_whiletrailers = ();
1826 %suppress_export = ();
1827 $suppress_statement = 0;
1830 # track the line number as we move through the hunk, note that
1831 # new versions of GNU diff omit the leading space on completely
1832 # blank context lines so we need to count that too.
1833 } elsif ($line =~ /^( |\+|$)/) {
1835 $realcnt-- if ($realcnt != 0);
1837 # Measure the line length and indent.
1838 ($length, $indent) = line_stats($rawline);
1840 # Track the previous line.
1841 ($prevline, $stashline) = ($stashline, $line);
1842 ($previndent, $stashindent) = ($stashindent, $indent);
1843 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1845 #warn "line<$line>\n";
1847 } elsif ($realcnt == 1) {
1851 my $hunk_line = ($realcnt != 0);
1853 #make up the handle for any error we report on this line
1854 $prefix = "$filename:$realline: " if ($emacs && $file);
1855 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1857 $here = "#$linenr: " if (!$file);
1858 $here = "#$realline: " if ($file);
1861 # extract the filename as it passes
1862 if ($line =~ /^diff --git.*?(\S+)$/) {
1864 $realfile =~ s@^([^/]*)/@@ if (!$file);
1867 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
1869 $realfile =~ s@^([^/]*)/@@ if (!$file);
1873 if (!$file && $tree && $p1_prefix ne '' &&
1874 -e "$root/$p1_prefix") {
1875 WARN("PATCH_PREFIX",
1876 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1879 if ($realfile =~ m@^include/asm/@) {
1880 ERROR("MODIFIED_INCLUDE_ASM",
1881 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1887 if ($realfile =~ m@^(drivers/net/|net/)@) {
1890 $check = $check_orig;
1895 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
1897 my $hereline = "$here\n$rawline\n";
1898 my $herecurr = "$here\n$rawline\n";
1899 my $hereprev = "$here\n$prevrawline\n$rawline\n";
1901 $cnt_lines++ if ($realcnt != 0);
1903 # Check for incorrect file permissions
1904 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1905 my $permhere = $here . "FILE: $realfile\n";
1906 if ($realfile !~ m@scripts/@ &&
1907 $realfile !~ /\.(py|pl|awk|sh)$/) {
1908 ERROR("EXECUTE_PERMISSIONS",
1909 "do not set execute permissions for source files\n" . $permhere);
1913 # Check the patch for a signoff:
1914 if ($line =~ /^\s*signed-off-by:/i) {
1919 # Check signature styles
1920 if (!$in_header_lines &&
1921 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
1922 my $space_before = $1;
1924 my $space_after = $3;
1926 my $ucfirst_sign_off = ucfirst(lc($sign_off));
1928 if ($sign_off !~ /$signature_tags/) {
1929 WARN("BAD_SIGN_OFF",
1930 "Non-standard signature: $sign_off\n" . $herecurr);
1932 if (defined $space_before && $space_before ne "") {
1933 if (WARN("BAD_SIGN_OFF",
1934 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
1936 $fixed[$linenr - 1] =
1937 "$ucfirst_sign_off $email";
1940 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
1941 if (WARN("BAD_SIGN_OFF",
1942 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
1944 $fixed[$linenr - 1] =
1945 "$ucfirst_sign_off $email";
1949 if (!defined $space_after || $space_after ne " ") {
1950 if (WARN("BAD_SIGN_OFF",
1951 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
1953 $fixed[$linenr - 1] =
1954 "$ucfirst_sign_off $email";
1958 my ($email_name, $email_address, $comment) = parse_email($email);
1959 my $suggested_email = format_email(($email_name, $email_address));
1960 if ($suggested_email eq "") {
1961 ERROR("BAD_SIGN_OFF",
1962 "Unrecognized email address: '$email'\n" . $herecurr);
1964 my $dequoted = $suggested_email;
1965 $dequoted =~ s/^"//;
1966 $dequoted =~ s/" </ </;
1967 # Don't force email to have quotes
1968 # Allow just an angle bracketed address
1969 if ("$dequoted$comment" ne $email &&
1970 "<$email_address>$comment" ne $email &&
1971 "$suggested_email$comment" ne $email) {
1972 WARN("BAD_SIGN_OFF",
1973 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
1977 # Check for duplicate signatures
1978 my $sig_nospace = $line;
1979 $sig_nospace =~ s/\s//g;
1980 $sig_nospace = lc($sig_nospace);
1981 if (defined $signatures{$sig_nospace}) {
1982 WARN("BAD_SIGN_OFF",
1983 "Duplicate signature\n" . $herecurr);
1985 $signatures{$sig_nospace} = 1;
1989 # Check for old stable address
1990 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
1991 ERROR("STABLE_ADDRESS",
1992 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
1995 # Check for unwanted Gerrit info
1996 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
1997 ERROR("GERRIT_CHANGE_ID",
1998 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2001 # Check for improperly formed commit descriptions
2002 if ($in_commit_log &&
2003 $line =~ /\bcommit\s+[0-9a-f]{5,}/i &&
2004 $line !~ /\b[Cc]ommit [0-9a-f]{12,16} \("/) {
2005 $line =~ /\b(c)ommit\s+([0-9a-f]{5,})/i;
2007 my $orig_commit = lc($2);
2008 my $id = '01234567890ab';
2009 my $desc = 'commit description';
2010 ($id, $desc) = git_commit_info($orig_commit, $id, $desc);
2011 ERROR("GIT_COMMIT_ID",
2012 "Please use 12 to 16 chars for the git commit ID like: '${init_char}ommit $id (\"$desc\")'\n" . $herecurr);
2015 # Check for added, moved or deleted files
2016 if (!$reported_maintainer_file && !$in_commit_log &&
2017 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2018 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2019 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2020 (defined($1) || defined($2))))) {
2021 $reported_maintainer_file = 1;
2022 WARN("FILE_PATH_CHANGES",
2023 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2026 # Check for wrappage within a valid hunk of the file
2027 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
2028 ERROR("CORRUPTED_PATCH",
2029 "patch seems to be corrupt (line wrapped?)\n" .
2030 $herecurr) if (!$emitted_corrupt++);
2033 # Check for absolute kernel paths.
2035 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2038 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2039 check_absolute_file($1, $herecurr)) {
2042 check_absolute_file($file, $herecurr);
2047 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2048 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
2049 $rawline !~ m/^$UTF8*$/) {
2050 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2052 my $blank = copy_spacing($rawline);
2053 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2054 my $hereptr = "$hereline$ptr\n";
2057 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
2060 # Check if it's the start of a commit log
2061 # (not a header line and we haven't seen the patch filename)
2062 if ($in_header_lines && $realfile =~ /^$/ &&
2063 !($rawline =~ /^\s+\S/ ||
2064 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
2065 $in_header_lines = 0;
2069 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2070 # declined it, i.e defined some charset where it is missing.
2071 if ($in_header_lines &&
2072 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2074 $non_utf8_charset = 1;
2077 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
2078 $rawline =~ /$NON_ASCII_UTF8/) {
2079 WARN("UTF8_BEFORE_PATCH",
2080 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2083 # ignore non-hunk lines and lines being removed
2084 next if (!$hunk_line || $line =~ /^-/);
2086 #trailing whitespace
2087 if ($line =~ /^\+.*\015/) {
2088 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2089 if (ERROR("DOS_LINE_ENDINGS",
2090 "DOS line endings\n" . $herevet) &&
2092 $fixed[$linenr - 1] =~ s/[\s\015]+$//;
2094 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2095 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2096 if (ERROR("TRAILING_WHITESPACE",
2097 "trailing whitespace\n" . $herevet) &&
2099 $fixed[$linenr - 1] =~ s/\s+$//;
2105 # Check for FSF mailing addresses.
2106 if ($rawline =~ /\bwrite to the Free/i ||
2107 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2108 $rawline =~ /\b51\s+Franklin\s+St/i) {
2109 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2110 my $msg_type = \&ERROR;
2111 $msg_type = \&CHK if ($file);
2112 &{$msg_type}("FSF_MAILING_ADDRESS",
2113 "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)
2116 # check for Kconfig help text having a real description
2117 # Only applies when adding the entry originally, after that we do not have
2118 # sufficient context to determine whether it is indeed long enough.
2119 if ($realfile =~ /Kconfig/ &&
2120 $line =~ /^\+\s*config\s+/) {
2123 my $ln = $linenr + 1;
2127 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
2128 $f = $lines[$ln - 1];
2129 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2130 $is_end = $lines[$ln - 1] =~ /^\+/;
2132 next if ($f =~ /^-/);
2133 last if (!$file && $f =~ /^\@\@/);
2135 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
2137 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
2144 next if ($f =~ /^$/);
2145 if ($f =~ /^\s*config\s/) {
2151 WARN("CONFIG_DESCRIPTION",
2152 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
2153 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2156 # discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2157 if ($realfile =~ /Kconfig/ &&
2158 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2159 WARN("CONFIG_EXPERIMENTAL",
2160 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2163 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2164 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2167 'EXTRA_AFLAGS' => 'asflags-y',
2168 'EXTRA_CFLAGS' => 'ccflags-y',
2169 'EXTRA_CPPFLAGS' => 'cppflags-y',
2170 'EXTRA_LDFLAGS' => 'ldflags-y',
2173 WARN("DEPRECATED_VARIABLE",
2174 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2177 # check for DT compatible documentation
2178 if (defined $root &&
2179 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2180 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2182 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2184 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2185 my $vp_file = $dt_path . "vendor-prefixes.txt";
2187 foreach my $compat (@compats) {
2188 my $compat2 = $compat;
2189 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2190 my $compat3 = $compat;
2191 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2192 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
2194 WARN("UNDOCUMENTED_DT_STRING",
2195 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2198 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2200 `grep -Eq "^$vendor\\b" $vp_file`;
2202 WARN("UNDOCUMENTED_DT_STRING",
2203 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2208 # check we are in a valid source file if not then ignore this hunk
2209 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
2212 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
2213 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
2214 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
2215 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
2216 $length > $max_line_length)
2219 "line over $max_line_length characters\n" . $herecurr);
2222 # Check for user-visible strings broken across lines, which breaks the ability
2223 # to grep for the string. Make exceptions when the previous string ends in a
2224 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
2225 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
2226 if ($line =~ /^\+\s*"/ &&
2227 $prevline =~ /"\s*$/ &&
2228 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
2229 WARN("SPLIT_STRING",
2230 "quoted string split across lines\n" . $hereprev);
2233 # check for spaces before a quoted newline
2234 if ($rawline =~ /^.*\".*\s\\n/) {
2235 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
2236 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
2238 $fixed[$linenr - 1] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
2243 # check for adding lines without a newline.
2244 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2245 WARN("MISSING_EOF_NEWLINE",
2246 "adding a line without newline at end of file\n" . $herecurr);
2249 # Blackfin: use hi/lo macros
2250 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2251 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2252 my $herevet = "$here\n" . cat_vet($line) . "\n";
2254 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
2256 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2257 my $herevet = "$here\n" . cat_vet($line) . "\n";
2259 "use the HI() macro, not (... >> 16)\n" . $herevet);
2263 # check we are in a valid source file C or perl if not then ignore this hunk
2264 next if ($realfile !~ /\.(h|c|pl)$/);
2266 # at the beginning of a line any tabs must come first and anything
2267 # more than 8 must use tabs.
2268 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2269 $rawline =~ /^\+\s* \s*/) {
2270 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2272 if (ERROR("CODE_INDENT",
2273 "code indent should use tabs where possible\n" . $herevet) &&
2275 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2279 # check for space before tabs.
2280 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2281 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2282 if (WARN("SPACE_BEFORE_TAB",
2283 "please, no space before tabs\n" . $herevet) &&
2285 while ($fixed[$linenr - 1] =~
2286 s/(^\+.*) {8,8}+\t/$1\t\t/) {}
2287 while ($fixed[$linenr - 1] =~
2288 s/(^\+.*) +\t/$1\t/) {}
2292 # check for && or || at the start of a line
2293 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2294 CHK("LOGICAL_CONTINUATIONS",
2295 "Logical continuations should be on the previous line\n" . $hereprev);
2298 # check multi-line statement indentation matches previous line
2299 if ($^V && $^V ge 5.10.0 &&
2300 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2301 $prevline =~ /^\+(\t*)(.*)$/;
2305 my $pos = pos_last_openparen($rest);
2307 $line =~ /^(\+| )([ \t]*)/;
2310 my $goodtabindent = $oldindent .
2313 my $goodspaceindent = $oldindent . " " x $pos;
2315 if ($newindent ne $goodtabindent &&
2316 $newindent ne $goodspaceindent) {
2318 if (CHK("PARENTHESIS_ALIGNMENT",
2319 "Alignment should match open parenthesis\n" . $hereprev) &&
2320 $fix && $line =~ /^\+/) {
2321 $fixed[$linenr - 1] =~
2322 s/^\+[ \t]*/\+$goodtabindent/;
2328 if ($line =~ /^\+.*\(\s*$Type\s*\)[ \t]+(?!$Assignment|$Arithmetic)/) {
2330 "No space is necessary after a cast\n" . $herecurr) &&
2332 $fixed[$linenr - 1] =~
2333 s/(\(\s*$Type\s*\))[ \t]+/$1/;
2337 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2338 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
2339 $rawline =~ /^\+[ \t]*\*/ &&
2341 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2342 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2345 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2346 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2347 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
2348 $rawline =~ /^\+/ && #line is new
2349 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2350 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2351 "networking block comments start with * on subsequent lines\n" . $hereprev);
2354 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2355 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2356 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2357 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2358 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
2359 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2360 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2363 # check for missing blank lines after struct/union declarations
2364 # with exceptions for various attributes and macros
2365 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2367 !($line =~ /^\+\s*$/ ||
2368 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2369 $line =~ /^\+\s*MODULE_/i ||
2370 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2371 $line =~ /^\+[a-z_]*init/ ||
2372 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2373 $line =~ /^\+\s*DECLARE/ ||
2374 $line =~ /^\+\s*__setup/)) {
2376 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev);
2379 # check for multiple consecutive blank lines
2380 if ($prevline =~ /^[\+ ]\s*$/ &&
2381 $line =~ /^\+\s*$/ &&
2382 $last_blank_line != ($linenr - 1)) {
2384 "Please don't use multiple blank lines\n" . $hereprev);
2385 $last_blank_line = $linenr;
2388 # check for missing blank lines after declarations
2389 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2390 # actual declarations
2391 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2392 # function pointer declarations
2393 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2394 # foo bar; where foo is some local typedef or #define
2395 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2396 # known declaration macros
2397 $prevline =~ /^\+\s+$declaration_macros/) &&
2398 # for "else if" which can look like "$Ident $Ident"
2399 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2400 # other possible extensions of declaration lines
2401 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2402 # not starting a section or a macro "\" extended line
2403 $prevline =~ /(?:\{\s*|\\)$/) &&
2404 # looks like a declaration
2405 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2406 # function pointer declarations
2407 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2408 # foo bar; where foo is some local typedef or #define
2409 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2410 # known declaration macros
2411 $sline =~ /^\+\s+$declaration_macros/ ||
2412 # start of struct or union or enum
2413 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
2414 # start or end of block or continuation of declaration
2415 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
2416 # bitfield continuation
2417 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
2418 # other possible extensions of declaration lines
2419 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
2420 # indentation of previous and current line are the same
2421 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
2422 WARN("LINE_SPACING",
2423 "Missing a blank line after declarations\n" . $hereprev);
2426 # check for spaces at the beginning of a line.
2428 # 1) within comments
2429 # 2) indented preprocessor commands
2431 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
2432 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2433 if (WARN("LEADING_SPACE",
2434 "please, no spaces at the start of a line\n" . $herevet) &&
2436 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2440 # check we are in a valid C source file if not then ignore this hunk
2441 next if ($realfile !~ /\.(h|c)$/);
2443 # check indentation of any line with a bare else
2444 # if the previous line is a break or return and is indented 1 tab more...
2445 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
2446 my $tabs = length($1) + 1;
2447 if ($prevline =~ /^\+\t{$tabs,$tabs}(?:break|return)\b/) {
2448 WARN("UNNECESSARY_ELSE",
2449 "else is not generally useful after a break or return\n" . $hereprev);
2453 # check indentation of a line with a break;
2454 # if the previous line is a goto or return and is indented the same # of tabs
2455 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
2457 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
2458 WARN("UNNECESSARY_BREAK",
2459 "break is not useful after a goto or return\n" . $hereprev);
2463 # discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2464 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2465 WARN("CONFIG_EXPERIMENTAL",
2466 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2469 # check for RCS/CVS revision markers
2470 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
2472 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
2475 # Blackfin: don't use __builtin_bfin_[cs]sync
2476 if ($line =~ /__builtin_bfin_csync/) {
2477 my $herevet = "$here\n" . cat_vet($line) . "\n";
2479 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
2481 if ($line =~ /__builtin_bfin_ssync/) {
2482 my $herevet = "$here\n" . cat_vet($line) . "\n";
2484 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
2487 # check for old HOTPLUG __dev<foo> section markings
2488 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2489 WARN("HOTPLUG_SECTION",
2490 "Using $1 is unnecessary\n" . $herecurr);
2493 # Check for potential 'bare' types
2494 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2496 #print "LINE<$line>\n";
2497 if ($linenr >= $suppress_statement &&
2498 $realcnt && $sline =~ /.\s*\S/) {
2499 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2500 ctx_statement_block($linenr, $realcnt, 0);
2501 $stat =~ s/\n./\n /g;
2502 $cond =~ s/\n./\n /g;
2504 #print "linenr<$linenr> <$stat>\n";
2505 # If this statement has no statement boundaries within
2506 # it there is no point in retrying a statement scan
2507 # until we hit end of it.
2508 my $frag = $stat; $frag =~ s/;+\s*$//;
2509 if ($frag !~ /(?:{|;)/) {
2510 #print "skip<$line_nr_next>\n";
2511 $suppress_statement = $line_nr_next;
2514 # Find the real next line.
2515 $realline_next = $line_nr_next;
2516 if (defined $realline_next &&
2517 (!defined $lines[$realline_next - 1] ||
2518 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2525 # Ignore goto labels.
2526 if ($s =~ /$Ident:\*$/s) {
2528 # Ignore functions being called
2529 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
2531 } elsif ($s =~ /^.\s*else\b/s) {
2533 # declarations always start with types
2534 } 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) {
2537 possible($type, "A:" . $s);
2539 # definitions in global scope can only start with types
2540 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
2541 possible($1, "B:" . $s);
2544 # any (foo ... *) is a pointer cast, and foo is a type
2545 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
2546 possible($1, "C:" . $s);
2549 # Check for any sort of function declaration.
2550 # int foo(something bar, other baz);
2551 # void (*store_gdt)(x86_descr_ptr *);
2552 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
2553 my ($name_len) = length($1);
2556 substr($ctx, 0, $name_len + 1, '');
2557 $ctx =~ s/\)[^\)]*$//;
2559 for my $arg (split(/\s*,\s*/, $ctx)) {
2560 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
2562 possible($1, "D:" . $s);
2570 # Checks which may be anchored in the context.
2573 # Check for switch () and associated case and default
2574 # statements should be at the same indent.
2575 if ($line=~/\bswitch\s*\(.*\)/) {
2578 my @ctx = ctx_block_outer($linenr, $realcnt);
2580 for my $ctx (@ctx) {
2581 my ($clen, $cindent) = line_stats($ctx);
2582 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2583 $indent != $cindent) {
2584 $err .= "$sep$ctx\n";
2591 ERROR("SWITCH_CASE_INDENT_LEVEL",
2592 "switch and case should be at the same indent\n$hereline$err");
2596 # if/while/etc brace do not go on next line, unless defining a do while loop,
2597 # or if that brace on the next line is for something else
2598 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
2599 my $pre_ctx = "$1$2";
2601 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
2603 if ($line =~ /^\+\t{6,}/) {
2604 WARN("DEEP_INDENTATION",
2605 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2608 my $ctx_cnt = $realcnt - $#ctx - 1;
2609 my $ctx = join("\n", @ctx);
2611 my $ctx_ln = $linenr;
2612 my $ctx_skip = $realcnt;
2614 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2615 defined $lines[$ctx_ln - 1] &&
2616 $lines[$ctx_ln - 1] =~ /^-/)) {
2617 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2618 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
2622 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2623 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
2625 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
2627 "that open brace { should be on the previous line\n" .
2628 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2630 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2631 $ctx =~ /\)\s*\;\s*$/ &&
2632 defined $lines[$ctx_ln - 1])
2634 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2635 if ($nindent > $indent) {
2636 WARN("TRAILING_SEMICOLON",
2637 "trailing semicolon indicates no statements, indent implies otherwise\n" .
2638 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2643 # Check relative indent for conditionals and blocks.
2644 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2645 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2646 ctx_statement_block($linenr, $realcnt, 0)
2647 if (!defined $stat);
2648 my ($s, $c) = ($stat, $cond);
2650 substr($s, 0, length($c), '');
2652 # Make sure we remove the line prefixes as we have
2653 # none on the first line, and are going to readd them
2657 # Find out how long the conditional actually is.
2658 my @newlines = ($c =~ /\n/gs);
2659 my $cond_lines = 1 + $#newlines;
2661 # We want to check the first line inside the block
2662 # starting at the end of the conditional, so remove:
2663 # 1) any blank line termination
2664 # 2) any opening brace { on end of the line
2666 my $continuation = 0;
2668 $s =~ s/^.*\bdo\b//;
2670 if ($s =~ s/^\s*\\//) {
2673 if ($s =~ s/^\s*?\n//) {
2678 # Also ignore a loop construct at the end of a
2679 # preprocessor statement.
2680 if (($prevline =~ /^.\s*#\s*define\s/ ||
2681 $prevline =~ /\\\s*$/) && $continuation == 0) {
2687 while ($cond_ptr != $cond_lines) {
2688 $cond_ptr = $cond_lines;
2690 # If we see an #else/#elif then the code
2692 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2697 # 1) blank lines, they should be at 0,
2698 # 2) preprocessor lines, and
2700 if ($continuation ||
2702 $s =~ /^\s*#\s*?/ ||
2703 $s =~ /^\s*$Ident\s*:/) {
2704 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
2705 if ($s =~ s/^.*?\n//) {
2711 my (undef, $sindent) = line_stats("+" . $s);
2712 my $stat_real = raw_line($linenr, $cond_lines);
2714 # Check if either of these lines are modified, else
2715 # this is not this patch's fault.
2716 if (!defined($stat_real) ||
2717 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2720 if (defined($stat_real) && $cond_lines > 1) {
2721 $stat_real = "[...]\n$stat_real";
2724 #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";
2726 if ($check && (($sindent % 8) != 0 ||
2727 ($sindent <= $indent && $s ne ''))) {
2728 WARN("SUSPECT_CODE_INDENT",
2729 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
2733 # Track the 'values' across context and added lines.
2734 my $opline = $line; $opline =~ s/^./ /;
2735 my ($curr_values, $curr_vars) =
2736 annotate_values($opline . "\n", $prev_values);
2737 $curr_values = $prev_values . $curr_values;
2739 my $outline = $opline; $outline =~ s/\t/ /g;
2740 print "$linenr > .$outline\n";
2741 print "$linenr > $curr_values\n";
2742 print "$linenr > $curr_vars\n";
2744 $prev_values = substr($curr_values, -1);
2746 #ignore lines not being added
2747 next if ($line =~ /^[^\+]/);
2749 # TEST: allow direct testing of the type matcher.
2751 if ($line =~ /^.\s*$Declare\s*$/) {
2753 "TEST: is type\n" . $herecurr);
2754 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
2755 ERROR("TEST_NOT_TYPE",
2756 "TEST: is not type ($1 is)\n". $herecurr);
2760 # TEST: allow direct testing of the attribute matcher.
2762 if ($line =~ /^.\s*$Modifier\s*$/) {
2764 "TEST: is attr\n" . $herecurr);
2765 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
2766 ERROR("TEST_NOT_ATTR",
2767 "TEST: is not attr ($1 is)\n". $herecurr);
2772 # check for initialisation to aggregates open brace on the next line
2773 if ($line =~ /^.\s*{/ &&
2774 $prevline =~ /(?:^|[^=])=\s*$/) {
2776 "that open brace { should be on the previous line\n" . $hereprev);
2780 # Checks which are anchored on the added line.
2783 # check for malformed paths in #include statements (uses RAW line)
2784 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
2786 if ($path =~ m{//}) {
2787 ERROR("MALFORMED_INCLUDE",
2788 "malformed #include filename\n" . $herecurr);
2790 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
2791 ERROR("UAPI_INCLUDE",
2792 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
2796 # no C99 // comments
2797 if ($line =~ m{//}) {
2798 if (ERROR("C99_COMMENTS",
2799 "do not use C99 // comments\n" . $herecurr) &&
2801 my $line = $fixed[$linenr - 1];
2802 if ($line =~ /\/\/(.*)$/) {
2803 my $comment = trim($1);
2804 $fixed[$linenr - 1] =~ s@\/\/(.*)$@/\* $comment \*/@;
2808 # Remove C99 comments.
2810 $opline =~ s@//.*@@;
2812 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2813 # the whole statement.
2814 #print "APW <$lines[$realline_next - 1]>\n";
2815 if (defined $realline_next &&
2816 exists $lines[$realline_next - 1] &&
2817 !defined $suppress_export{$realline_next} &&
2818 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2819 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2820 # Handle definitions which produce identifiers with
2823 # EXPORT_SYMBOL(something_foo);
2825 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
2826 $name =~ /^${Ident}_$2/) {
2827 #print "FOO C name<$name>\n";
2828 $suppress_export{$realline_next} = 1;
2830 } elsif ($stat !~ /(?:
2832 ^.DEFINE_$Ident\(\Q$name\E\)|
2833 ^.DECLARE_$Ident\(\Q$name\E\)|
2834 ^.LIST_HEAD\(\Q$name\E\)|
2835 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2836 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
2838 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2839 $suppress_export{$realline_next} = 2;
2841 $suppress_export{$realline_next} = 1;
2844 if (!defined $suppress_export{$linenr} &&
2845 $prevline =~ /^.\s*$/ &&
2846 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2847 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2848 #print "FOO B <$lines[$linenr - 1]>\n";
2849 $suppress_export{$linenr} = 2;
2851 if (defined $suppress_export{$linenr} &&
2852 $suppress_export{$linenr} == 2) {
2853 WARN("EXPORT_SYMBOL",
2854 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
2857 # check for global initialisers.
2858 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
2859 if (ERROR("GLOBAL_INITIALISERS",
2860 "do not initialise globals to 0 or NULL\n" .
2863 $fixed[$linenr - 1] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
2866 # check for static initialisers.
2867 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2868 if (ERROR("INITIALISED_STATIC",
2869 "do not initialise statics to 0 or NULL\n" .
2872 $fixed[$linenr - 1] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
2876 # check for static const char * arrays.
2877 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
2878 WARN("STATIC_CONST_CHAR_ARRAY",
2879 "static const char * array should probably be static const char * const\n" .
2883 # check for static char foo[] = "bar" declarations.
2884 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
2885 WARN("STATIC_CONST_CHAR_ARRAY",
2886 "static char array declaration should probably be static const char\n" .
2890 # check for non-global char *foo[] = {"bar", ...} declarations.
2891 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
2892 WARN("STATIC_CONST_CHAR_ARRAY",
2893 "char * array declaration might be better as static const\n" .
2897 # check for function declarations without arguments like "int foo()"
2898 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
2899 if (ERROR("FUNCTION_WITHOUT_ARGS",
2900 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
2902 $fixed[$linenr - 1] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
2906 # check for uses of DEFINE_PCI_DEVICE_TABLE
2907 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
2908 if (WARN("DEFINE_PCI_DEVICE_TABLE",
2909 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
2911 $fixed[$linenr - 1] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
2915 # check for new typedefs, only function parameters and sparse annotations
2917 if ($line =~ /\btypedef\s/ &&
2918 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
2919 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
2920 $line !~ /\b$typeTypedefs\b/ &&
2921 $line !~ /\b__bitwise(?:__|)\b/) {
2922 WARN("NEW_TYPEDEFS",
2923 "do not add new typedefs\n" . $herecurr);
2926 # * goes on variable not on type
2928 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2930 my ($ident, $from, $to) = ($1, $2, $2);
2932 # Should start with a space.
2933 $to =~ s/^(\S)/ $1/;
2934 # Should not end with a space.
2936 # '*'s should not have spaces between.
2937 while ($to =~ s/\*\s+\*/\*\*/) {
2940 ## print "1: from<$from> to<$to> ident<$ident>\n";
2942 if (ERROR("POINTER_LOCATION",
2943 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
2945 my $sub_from = $ident;
2946 my $sub_to = $ident;
2947 $sub_to =~ s/\Q$from\E/$to/;
2948 $fixed[$linenr - 1] =~
2949 s@\Q$sub_from\E@$sub_to@;
2953 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2955 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
2957 # Should start with a space.
2958 $to =~ s/^(\S)/ $1/;
2959 # Should not end with a space.
2961 # '*'s should not have spaces between.
2962 while ($to =~ s/\*\s+\*/\*\*/) {
2964 # Modifiers should have spaces.
2965 $to =~ s/(\b$Modifier$)/$1 /;
2967 ## print "2: from<$from> to<$to> ident<$ident>\n";
2968 if ($from ne $to && $ident !~ /^$Modifier$/) {
2969 if (ERROR("POINTER_LOCATION",
2970 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
2973 my $sub_from = $match;
2974 my $sub_to = $match;
2975 $sub_to =~ s/\Q$from\E/$to/;
2976 $fixed[$linenr - 1] =~
2977 s@\Q$sub_from\E@$sub_to@;
2982 # # no BUG() or BUG_ON()
2983 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
2984 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2985 # print "$herecurr";
2989 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
2990 WARN("LINUX_VERSION_CODE",
2991 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
2994 # check for uses of printk_ratelimit
2995 if ($line =~ /\bprintk_ratelimit\s*\(/) {
2996 WARN("PRINTK_RATELIMITED",
2997 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
3000 # printk should use KERN_* levels. Note that follow on printk's on the
3001 # same line do not need a level, so we use the current block context
3002 # to try and find and validate the current printk. In summary the current
3003 # printk includes all preceding printk's which have no newline on the end.
3004 # we assume the first bad printk is the one to report.
3005 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
3007 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3008 #print "CHECK<$lines[$ln - 1]\n";
3009 # we have a preceding printk if it ends
3010 # with "\n" ignore it, else it is to blame
3011 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3012 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3019 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3020 "printk() should include KERN_ facility level\n" . $herecurr);
3024 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3026 my $level = lc($orig);
3027 $level = "warn" if ($level eq "warning");
3028 my $level2 = $level;
3029 $level2 = "dbg" if ($level eq "debug");
3030 WARN("PREFER_PR_LEVEL",
3031 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
3034 if ($line =~ /\bpr_warning\s*\(/) {
3035 if (WARN("PREFER_PR_LEVEL",
3036 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3038 $fixed[$linenr - 1] =~
3039 s/\bpr_warning\b/pr_warn/;
3043 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3045 my $level = lc($orig);
3046 $level = "warn" if ($level eq "warning");
3047 $level = "dbg" if ($level eq "debug");
3048 WARN("PREFER_DEV_LEVEL",
3049 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3052 # function brace can't be on same line, except for #defines of do while,
3053 # or if closed on same line
3054 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
3055 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
3057 "open brace '{' following function declarations go on the next line\n" . $herecurr);
3060 # open braces for enum, union and struct go on the same line.
3061 if ($line =~ /^.\s*{/ &&
3062 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
3064 "open brace '{' following $1 go on the same line\n" . $hereprev);
3067 # missing space after union, struct or enum definition
3068 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3070 "missing space after $1 definition\n" . $herecurr) &&
3072 $fixed[$linenr - 1] =~
3073 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3077 # Function pointer declarations
3078 # check spacing between type, funcptr, and args
3079 # canonical declaration is "type (*funcptr)(args...)"
3080 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
3082 my $pre_pointer_space = $2;
3083 my $post_pointer_space = $3;
3085 my $post_funcname_space = $5;
3086 my $pre_args_space = $6;
3088 # the $Declare variable will capture all spaces after the type
3089 # so check it for a missing trailing missing space but pointer return types
3090 # don't need a space so don't warn for those.
3091 my $post_declare_space = "";
3092 if ($declare =~ /(\s+)$/) {
3093 $post_declare_space = $1;
3094 $declare = rtrim($declare);
3096 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
3098 "missing space after return type\n" . $herecurr);
3099 $post_declare_space = " ";
3102 # unnecessary space "type (*funcptr)(args...)"
3103 # This test is not currently implemented because these declarations are
3105 # int foo(int bar, ...)
3106 # and this is form shouldn't/doesn't generate a checkpatch warning.
3108 # elsif ($declare =~ /\s{2,}$/) {
3110 # "Multiple spaces after return type\n" . $herecurr);
3113 # unnecessary space "type ( *funcptr)(args...)"
3114 if (defined $pre_pointer_space &&
3115 $pre_pointer_space =~ /^\s/) {
3117 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3120 # unnecessary space "type (* funcptr)(args...)"
3121 if (defined $post_pointer_space &&
3122 $post_pointer_space =~ /^\s/) {
3124 "Unnecessary space before function pointer name\n" . $herecurr);
3127 # unnecessary space "type (*funcptr )(args...)"
3128 if (defined $post_funcname_space &&
3129 $post_funcname_space =~ /^\s/) {
3131 "Unnecessary space after function pointer name\n" . $herecurr);
3134 # unnecessary space "type (*funcptr) (args...)"
3135 if (defined $pre_args_space &&
3136 $pre_args_space =~ /^\s/) {
3138 "Unnecessary space before function pointer arguments\n" . $herecurr);
3141 if (show_type("SPACING") && $fix) {
3142 $fixed[$linenr - 1] =~
3143 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3147 # check for spacing round square brackets; allowed:
3148 # 1. with a type on the left -- int [] a;
3149 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3150 # 3. inside a curly brace -- = { [0...10] = 5 }
3151 while ($line =~ /(.*?\s)\[/g) {
3152 my ($where, $prefix) = ($-[1], $1);
3153 if ($prefix !~ /$Type\s+$/ &&
3154 ($where != 0 || $prefix !~ /^.\s+$/) &&
3155 $prefix !~ /[{,]\s+$/) {
3156 if (ERROR("BRACKET_SPACE",
3157 "space prohibited before open square bracket '['\n" . $herecurr) &&
3159 $fixed[$linenr - 1] =~
3160 s/^(\+.*?)\s+\[/$1\[/;
3165 # check for spaces between functions and their parentheses.
3166 while ($line =~ /($Ident)\s+\(/g) {
3168 my $ctx_before = substr($line, 0, $-[1]);
3169 my $ctx = "$ctx_before$name";
3171 # Ignore those directives where spaces _are_ permitted.
3173 if|for|while|switch|return|case|
3174 volatile|__volatile__|
3175 __attribute__|format|__extension__|
3178 # cpp #define statements have non-optional spaces, ie
3179 # if there is a space between the name and the open
3180 # parenthesis it is simply not a parameter group.
3181 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
3183 # cpp #elif statement condition may start with a (
3184 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
3186 # If this whole things ends with a type its most
3187 # likely a typedef for a function.
3188 } elsif ($ctx =~ /$Type$/) {
3192 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3194 $fixed[$linenr - 1] =~
3195 s/\b$name\s+\(/$name\(/;
3200 # Check operator spacing.
3201 if (!($line=~/\#\s*include/)) {
3202 my $fixed_line = "";
3206 <<=|>>=|<=|>=|==|!=|
3207 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3208 =>|->|<<|>>|<|>|=|!|~|
3209 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
3212 my @elements = split(/($ops|;)/, $opline);
3214 ## print("element count: <" . $#elements . ">\n");
3215 ## foreach my $el (@elements) {
3216 ## print("el: <$el>\n");
3219 my @fix_elements = ();
3222 foreach my $el (@elements) {
3223 push(@fix_elements, substr($rawline, $off, length($el)));
3224 $off += length($el);
3229 my $blank = copy_spacing($opline);
3230 my $last_after = -1;
3232 for (my $n = 0; $n < $#elements; $n += 2) {
3234 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3236 ## print("n: <$n> good: <$good>\n");
3238 $off += length($elements[$n]);
3240 # Pick up the preceding and succeeding characters.
3241 my $ca = substr($opline, 0, $off);
3243 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3244 $cc = substr($opline, $off + length($elements[$n + 1]));
3246 my $cb = "$ca$;$cc";
3249 $a = 'V' if ($elements[$n] ne '');
3250 $a = 'W' if ($elements[$n] =~ /\s$/);
3251 $a = 'C' if ($elements[$n] =~ /$;$/);
3252 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3253 $a = 'O' if ($elements[$n] eq '');
3254 $a = 'E' if ($ca =~ /^\s*$/);
3256 my $op = $elements[$n + 1];
3259 if (defined $elements[$n + 2]) {
3260 $c = 'V' if ($elements[$n + 2] ne '');
3261 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
3262 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
3263 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3264 $c = 'O' if ($elements[$n + 2] eq '');
3265 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
3270 my $ctx = "${a}x${c}";
3272 my $at = "(ctx:$ctx)";
3274 my $ptr = substr($blank, 0, $off) . "^";
3275 my $hereptr = "$hereline$ptr\n";
3277 # Pull out the value of this operator.
3278 my $op_type = substr($curr_values, $off + 1, 1);
3280 # Get the full operator variant.
3281 my $opv = $op . substr($curr_vars, $off, 1);
3283 # Ignore operators passed as parameters.
3284 if ($op_type ne 'V' &&
3285 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
3288 # } elsif ($op =~ /^$;+$/) {
3290 # ; should have either the end of line or a space or \ after it
3291 } elsif ($op eq ';') {
3292 if ($ctx !~ /.x[WEBC]/ &&
3293 $cc !~ /^\\/ && $cc !~ /^;/) {
3294 if (ERROR("SPACING",
3295 "space required after that '$op' $at\n" . $hereptr)) {
3296 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3302 } elsif ($op eq '//') {
3304 # : when part of a bitfield
3305 } elsif ($opv eq ':B') {
3306 # skip the bitfield test for now
3310 } elsif ($op eq '->') {
3311 if ($ctx =~ /Wx.|.xW/) {
3312 if (ERROR("SPACING",
3313 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
3314 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3315 if (defined $fix_elements[$n + 2]) {
3316 $fix_elements[$n + 2] =~ s/^\s+//;
3322 # , must have a space on the right.
3323 } elsif ($op eq ',') {
3324 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
3325 if (ERROR("SPACING",
3326 "space required after that '$op' $at\n" . $hereptr)) {
3327 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3333 # '*' as part of a type definition -- reported already.
3334 } elsif ($opv eq '*_') {
3335 #warn "'*' is part of type\n";
3337 # unary operators should have a space before and
3338 # none after. May be left adjacent to another
3339 # unary operator, or a cast
3340 } elsif ($op eq '!' || $op eq '~' ||
3341 $opv eq '*U' || $opv eq '-U' ||
3342 $opv eq '&U' || $opv eq '&&U') {
3343 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
3344 if (ERROR("SPACING",
3345 "space required before that '$op' $at\n" . $hereptr)) {
3346 if ($n != $last_after + 2) {
3347 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3352 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
3353 # A unary '*' may be const
3355 } elsif ($ctx =~ /.xW/) {
3356 if (ERROR("SPACING",
3357 "space prohibited after that '$op' $at\n" . $hereptr)) {
3358 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
3359 if (defined $fix_elements[$n + 2]) {
3360 $fix_elements[$n + 2] =~ s/^\s+//;
3366 # unary ++ and unary -- are allowed no space on one side.
3367 } elsif ($op eq '++' or $op eq '--') {
3368 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
3369 if (ERROR("SPACING",
3370 "space required one side of that '$op' $at\n" . $hereptr)) {
3371 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3375 if ($ctx =~ /Wx[BE]/ ||
3376 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
3377 if (ERROR("SPACING",
3378 "space prohibited before that '$op' $at\n" . $hereptr)) {
3379 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3383 if ($ctx =~ /ExW/) {
3384 if (ERROR("SPACING",
3385 "space prohibited after that '$op' $at\n" . $hereptr)) {
3386 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3387 if (defined $fix_elements[$n + 2]) {
3388 $fix_elements[$n + 2] =~ s/^\s+//;
3394 # << and >> may either have or not have spaces both sides
3395 } elsif ($op eq '<<' or $op eq '>>' or
3396 $op eq '&' or $op eq '^' or $op eq '|' or
3397 $op eq '+' or $op eq '-' or
3398 $op eq '*' or $op eq '/' or
3401 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
3402 if (ERROR("SPACING",
3403 "need consistent spacing around '$op' $at\n" . $hereptr)) {
3404 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3405 if (defined $fix_elements[$n + 2]) {
3406 $fix_elements[$n + 2] =~ s/^\s+//;
3412 # A colon needs no spaces before when it is
3413 # terminating a case value or a label.
3414 } elsif ($opv eq ':C' || $opv eq ':L') {
3415 if ($ctx =~ /Wx./) {
3416 if (ERROR("SPACING",
3417 "space prohibited before that '$op' $at\n" . $hereptr)) {
3418 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3423 # All the others need spaces both sides.
3424 } elsif ($ctx !~ /[EWC]x[CWE]/) {
3427 # Ignore email addresses <foo@bar>
3429 $cc =~ /^\S+\@\S+>/) ||
3431 $ca =~ /<\S+\@\S+$/))
3436 # messages are ERROR, but ?: are CHK
3438 my $msg_type = \&ERROR;
3439 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
3441 if (&{$msg_type}("SPACING",
3442 "spaces required around that '$op' $at\n" . $hereptr)) {
3443 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3444 if (defined $fix_elements[$n + 2]) {
3445 $fix_elements[$n + 2] =~ s/^\s+//;
3451 $off += length($elements[$n + 1]);
3453 ## print("n: <$n> GOOD: <$good>\n");
3455 $fixed_line = $fixed_line . $good;
3458 if (($#elements % 2) == 0) {
3459 $fixed_line = $fixed_line . $fix_elements[$#elements];
3462 if ($fix && $line_fixed && $fixed_line ne $fixed[$linenr - 1]) {
3463 $fixed[$linenr - 1] = $fixed_line;
3469 # check for whitespace before a non-naked semicolon
3470 if ($line =~ /^\+.*\S\s+;\s*$/) {
3472 "space prohibited before semicolon\n" . $herecurr) &&
3474 1 while $fixed[$linenr - 1] =~
3475 s/^(\+.*\S)\s+;/$1;/;
3479 # check for multiple assignments
3480 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
3481 CHK("MULTIPLE_ASSIGNMENTS",
3482 "multiple assignments should be avoided\n" . $herecurr);
3485 ## # check for multiple declarations, allowing for a function declaration
3487 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3488 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3490 ## # Remove any bracketed sections to ensure we do not
3491 ## # falsly report the parameters of functions.
3493 ## while ($ln =~ s/\([^\(\)]*\)//g) {
3495 ## if ($ln =~ /,/) {
3496 ## WARN("MULTIPLE_DECLARATION",
3497 ## "declaring multiple variables together should be avoided\n" . $herecurr);
3501 #need space before brace following if, while, etc
3502 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3504 if (ERROR("SPACING",
3505 "space required before the open brace '{'\n" . $herecurr) &&
3507 $fixed[$linenr - 1] =~ s/^(\+.*(?:do|\))){/$1 {/;
3511 ## # check for blank lines before declarations
3512 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3513 ## $prevrawline =~ /^.\s*$/) {
3515 ## "No blank lines before declarations\n" . $hereprev);
3519 # closing brace should have a space following it when it has anything
3521 if ($line =~ /}(?!(?:,|;|\)))\S/) {
3522 if (ERROR("SPACING",
3523 "space required after that close brace '}'\n" . $herecurr) &&
3525 $fixed[$linenr - 1] =~
3526 s/}((?!(?:,|;|\)))\S)/} $1/;
3530 # check spacing on square brackets
3531 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
3532 if (ERROR("SPACING",
3533 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3535 $fixed[$linenr - 1] =~
3539 if ($line =~ /\s\]/) {
3540 if (ERROR("SPACING",
3541 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3543 $fixed[$linenr - 1] =~
3548 # check spacing on parentheses
3549 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3550 $line !~ /for\s*\(\s+;/) {
3551 if (ERROR("SPACING",
3552 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3554 $fixed[$linenr - 1] =~
3558 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
3559 $line !~ /for\s*\(.*;\s+\)/ &&
3560 $line !~ /:\s+\)/) {
3561 if (ERROR("SPACING",
3562 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3564 $fixed[$linenr - 1] =~
3569 # check unnecessary parentheses around addressof/dereference single $Lvals
3570 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
3572 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
3573 CHK("UNNECESSARY_PARENTHESES",
3574 "Unnecessary parentheses around $1\n" . $herecurr);
3577 #goto labels aren't indented, allow a single space however
3578 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
3579 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
3580 if (WARN("INDENTED_LABEL",
3581 "labels should not be indented\n" . $herecurr) &&
3583 $fixed[$linenr - 1] =~
3588 # return is not a function
3589 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
3591 if ($^V && $^V ge 5.10.0 &&
3592 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
3594 $value = deparenthesize($value);
3595 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
3596 ERROR("RETURN_PARENTHESES",
3597 "return is not a function, parentheses are not required\n" . $herecurr);
3599 } elsif ($spacing !~ /\s+/) {
3601 "space required before the open parenthesis '('\n" . $herecurr);
3605 # unnecessary return in a void function
3606 # at end-of-function, with the previous line a single leading tab, then return;
3607 # and the line before that not a goto label target like "out:"
3608 if ($sline =~ /^[ \+]}\s*$/ &&
3609 $prevline =~ /^\+\treturn\s*;\s*$/ &&
3611 $lines[$linenr - 3] =~ /^[ +]/ &&
3612 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
3614 "void function return statements are not generally useful\n" . $hereprev);
3617 # if statements using unnecessary parentheses - ie: if ((foo == bar))
3618 if ($^V && $^V ge 5.10.0 &&
3619 $line =~ /\bif\s*((?:\(\s*){2,})/) {
3620 my $openparens = $1;
3621 my $count = $openparens =~ tr@\(@\(@;
3623 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3624 my $comp = $4; #Not $1 because of $LvalOrFunc
3625 $msg = " - maybe == should be = ?" if ($comp eq "==");
3626 WARN("UNNECESSARY_PARENTHESES",
3627 "Unnecessary parentheses$msg\n" . $herecurr);
3631 # Return of what appears to be an errno should normally be -'ve
3632 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
3634 if ($name ne 'EOF' && $name ne 'ERROR') {
3635 WARN("USE_NEGATIVE_ERRNO",
3636 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
3640 # Need a space before open parenthesis after if, while etc
3641 if ($line =~ /\b(if|while|for|switch)\(/) {
3642 if (ERROR("SPACING",
3643 "space required before the open parenthesis '('\n" . $herecurr) &&
3645 $fixed[$linenr - 1] =~
3646 s/\b(if|while|for|switch)\(/$1 \(/;
3650 # Check for illegal assignment in if conditional -- and check for trailing
3651 # statements after the conditional.
3652 if ($line =~ /do\s*(?!{)/) {
3653 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3654 ctx_statement_block($linenr, $realcnt, 0)
3655 if (!defined $stat);
3656 my ($stat_next) = ctx_statement_block($line_nr_next,
3657 $remain_next, $off_next);
3658 $stat_next =~ s/\n./\n /g;
3659 ##print "stat<$stat> stat_next<$stat_next>\n";
3661 if ($stat_next =~ /^\s*while\b/) {
3662 # If the statement carries leading newlines,
3663 # then count those as offsets.
3665 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
3667 statement_rawlines($whitespace) - 1;
3669 $suppress_whiletrailers{$line_nr_next +
3673 if (!defined $suppress_whiletrailers{$linenr} &&
3674 defined($stat) && defined($cond) &&
3675 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
3676 my ($s, $c) = ($stat, $cond);
3678 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
3679 ERROR("ASSIGN_IN_IF",
3680 "do not use assignment in if condition\n" . $herecurr);
3683 # Find out what is on the end of the line after the
3685 substr($s, 0, length($c), '');
3687 $s =~ s/$;//g; # Remove any comments
3688 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
3689 $c !~ /}\s*while\s*/)
3691 # Find out how long the conditional actually is.
3692 my @newlines = ($c =~ /\n/gs);
3693 my $cond_lines = 1 + $#newlines;
3696 $stat_real = raw_line($linenr, $cond_lines)
3697 . "\n" if ($cond_lines);
3698 if (defined($stat_real) && $cond_lines > 1) {
3699 $stat_real = "[...]\n$stat_real";
3702 ERROR("TRAILING_STATEMENTS",
3703 "trailing statements should be on next line\n" . $herecurr . $stat_real);
3707 # Check for bitwise tests written as boolean
3719 WARN("HEXADECIMAL_BOOLEAN_TEST",
3720 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
3723 # if and else should not have general statements after it
3724 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
3726 $s =~ s/$;//g; # Remove any comments
3727 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
3728 ERROR("TRAILING_STATEMENTS",
3729 "trailing statements should be on next line\n" . $herecurr);
3732 # if should not continue a brace
3733 if ($line =~ /}\s*if\b/) {
3734 ERROR("TRAILING_STATEMENTS",
3735 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
3738 # case and default should not have general statements after them
3739 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
3741 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
3745 ERROR("TRAILING_STATEMENTS",
3746 "trailing statements should be on next line\n" . $herecurr);
3749 # Check for }<nl>else {, these must be at the same
3750 # indent level to be relevant to each other.
3751 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
3752 $previndent == $indent) {
3753 ERROR("ELSE_AFTER_BRACE",
3754 "else should follow close brace '}'\n" . $hereprev);
3757 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
3758 $previndent == $indent) {
3759 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
3761 # Find out what is on the end of the line after the
3763 substr($s, 0, length($c), '');
3766 if ($s =~ /^\s*;/) {
3767 ERROR("WHILE_AFTER_BRACE",
3768 "while should follow close brace '}'\n" . $hereprev);
3772 #Specific variable tests
3773 while ($line =~ m{($Constant|$Lval)}g) {
3776 #gcc binary extension
3777 if ($var =~ /^$Binary$/) {
3778 if (WARN("GCC_BINARY_CONSTANT",
3779 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
3781 my $hexval = sprintf("0x%x", oct($var));
3782 $fixed[$linenr - 1] =~
3783 s/\b$var\b/$hexval/;
3788 if ($var !~ /^$Constant$/ &&
3789 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
3790 #Ignore Page<foo> variants
3791 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
3792 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
3793 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) {
3794 while ($var =~ m{($Ident)}g) {
3796 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
3798 seed_camelcase_includes();
3799 if (!$file && !$camelcase_file_seeded) {
3800 seed_camelcase_file($realfile);
3801 $camelcase_file_seeded = 1;
3804 if (!defined $camelcase{$word}) {
3805 $camelcase{$word} = 1;
3807 "Avoid CamelCase: <$word>\n" . $herecurr);
3813 #no spaces allowed after \ in define
3814 if ($line =~ /\#\s*define.*\\\s+$/) {
3815 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
3816 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
3818 $fixed[$linenr - 1] =~ s/\s+$//;
3822 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
3823 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
3825 my $checkfile = "include/linux/$file";
3826 if (-f "$root/$checkfile" &&
3827 $realfile ne $checkfile &&
3828 $1 !~ /$allowed_asm_includes/)
3830 if ($realfile =~ m{^arch/}) {
3831 CHK("ARCH_INCLUDE_LINUX",
3832 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
3834 WARN("INCLUDE_LINUX",
3835 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
3840 # multi-statement macros should be enclosed in a do while loop, grab the
3841 # first statement and ensure its the whole macro if its not enclosed
3842 # in a known good container
3843 if ($realfile !~ m@/vmlinux.lds.h$@ &&
3844 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
3847 my ($off, $dstat, $dcond, $rest);
3849 ($dstat, $dcond, $ln, $cnt, $off) =
3850 ctx_statement_block($linenr, $realcnt, 0);
3852 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
3853 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
3855 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
3857 $dstat =~ s/\\\n.//g;
3858 $dstat =~ s/^\s*//s;
3859 $dstat =~ s/\s*$//s;
3861 # Flatten any parentheses and braces
3862 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
3863 $dstat =~ s/\{[^\{\}]*\}/1/ ||
3864 $dstat =~ s/\[[^\[\]]*\]/1/)
3868 # Flatten any obvious string concatentation.
3869 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
3870 $dstat =~ s/$Ident\s*("X*")/$1/)
3874 my $exceptions = qr{
3886 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
3888 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
3889 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
3890 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
3891 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
3892 $dstat !~ /$exceptions/ &&
3893 $dstat !~ /^\.$Ident\s*=/ && # .foo =
3894 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
3895 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
3896 $dstat !~ /^for\s*$Constant$/ && # for (...)
3897 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
3898 $dstat !~ /^do\s*{/ && # do {...
3899 $dstat !~ /^\({/ && # ({...
3900 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
3903 my $herectx = $here . "\n";
3904 my $cnt = statement_rawlines($ctx);
3906 for (my $n = 0; $n < $cnt; $n++) {
3907 $herectx .= raw_line($linenr, $n) . "\n";
3910 if ($dstat =~ /;/) {
3911 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
3912 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
3914 ERROR("COMPLEX_MACRO",
3915 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
3919 # check for line continuations outside of #defines, preprocessor #, and asm
3922 if ($prevline !~ /^..*\\$/ &&
3923 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
3924 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
3925 $line =~ /^\+.*\\$/) {
3926 WARN("LINE_CONTINUATIONS",
3927 "Avoid unnecessary line continuations\n" . $herecurr);
3931 # do {} while (0) macro tests:
3932 # single-statement macros do not need to be enclosed in do while (0) loop,
3933 # macro should not end with a semicolon
3934 if ($^V && $^V ge 5.10.0 &&
3935 $realfile !~ m@/vmlinux.lds.h$@ &&
3936 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
3939 my ($off, $dstat, $dcond, $rest);
3941 ($dstat, $dcond, $ln, $cnt, $off) =
3942 ctx_statement_block($linenr, $realcnt, 0);
3945 $dstat =~ s/\\\n.//g;
3947 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
3952 my $cnt = statement_rawlines($ctx);
3953 my $herectx = $here . "\n";
3955 for (my $n = 0; $n < $cnt; $n++) {
3956 $herectx .= raw_line($linenr, $n) . "\n";
3959 if (($stmts =~ tr/;/;/) == 1 &&
3960 $stmts !~ /^\s*(if|while|for|switch)\b/) {
3961 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
3962 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
3964 if (defined $semis && $semis ne "") {
3965 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
3966 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
3968 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
3970 my $cnt = statement_rawlines($ctx);
3971 my $herectx = $here . "\n";
3973 for (my $n = 0; $n < $cnt; $n++) {
3974 $herectx .= raw_line($linenr, $n) . "\n";
3977 WARN("TRAILING_SEMICOLON",
3978 "macros should not use a trailing semicolon\n" . "$herectx");
3982 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3983 # all assignments may have only one of the following with an assignment:
3986 # VMLINUX_SYMBOL(...)
3987 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
3988 WARN("MISSING_VMLINUX_SYMBOL",
3989 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
3992 # check for redundant bracing round if etc
3993 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
3994 my ($level, $endln, @chunks) =
3995 ctx_statement_full($linenr, $realcnt, 1);
3996 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
3997 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3998 if ($#chunks > 0 && $level == 0) {
4002 my $herectx = $here . "\n";
4003 my $ln = $linenr - 1;
4004 for my $chunk (@chunks) {
4005 my ($cond, $block) = @{$chunk};
4007 # If the condition carries leading newlines, then count those as offsets.
4008 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4009 my $offset = statement_rawlines($whitespace) - 1;
4011 $allowed[$allow] = 0;
4012 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4014 # We have looked at and allowed this specific line.
4015 $suppress_ifbraces{$ln + $offset} = 1;
4017 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
4018 $ln += statement_rawlines($block) - 1;
4020 substr($block, 0, length($cond), '');
4022 $seen++ if ($block =~ /^\s*{/);
4024 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
4025 if (statement_lines($cond) > 1) {
4026 #print "APW: ALLOWED: cond<$cond>\n";
4027 $allowed[$allow] = 1;
4029 if ($block =~/\b(?:if|for|while)\b/) {
4030 #print "APW: ALLOWED: block<$block>\n";
4031 $allowed[$allow] = 1;
4033 if (statement_block_size($block) > 1) {
4034 #print "APW: ALLOWED: lines block<$block>\n";
4035 $allowed[$allow] = 1;
4040 my $sum_allowed = 0;
4041 foreach (@allowed) {
4044 if ($sum_allowed == 0) {
4046 "braces {} are not necessary for any arm of this statement\n" . $herectx);
4047 } elsif ($sum_allowed != $allow &&
4050 "braces {} should be used on all arms of this statement\n" . $herectx);
4055 if (!defined $suppress_ifbraces{$linenr - 1} &&
4056 $line =~ /\b(if|while|for|else)\b/) {
4059 # Check the pre-context.
4060 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
4061 #print "APW: ALLOWED: pre<$1>\n";
4065 my ($level, $endln, @chunks) =
4066 ctx_statement_full($linenr, $realcnt, $-[0]);
4068 # Check the condition.
4069 my ($cond, $block) = @{$chunks[0]};
4070 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
4071 if (defined $cond) {
4072 substr($block, 0, length($cond), '');
4074 if (statement_lines($cond) > 1) {
4075 #print "APW: ALLOWED: cond<$cond>\n";
4078 if ($block =~/\b(?:if|for|while)\b/) {
4079 #print "APW: ALLOWED: block<$block>\n";
4082 if (statement_block_size($block) > 1) {
4083 #print "APW: ALLOWED: lines block<$block>\n";
4086 # Check the post-context.
4087 if (defined $chunks[1]) {
4088 my ($cond, $block) = @{$chunks[1]};
4089 if (defined $cond) {
4090 substr($block, 0, length($cond), '');
4092 if ($block =~ /^\s*\{/) {
4093 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4097 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
4098 my $herectx = $here . "\n";
4099 my $cnt = statement_rawlines($block);
4101 for (my $n = 0; $n < $cnt; $n++) {
4102 $herectx .= raw_line($linenr, $n) . "\n";
4106 "braces {} are not necessary for single statement blocks\n" . $herectx);
4110 # check for unnecessary blank lines around braces
4111 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
4113 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
4115 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
4117 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
4120 # no volatiles please
4121 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
4122 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
4124 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
4128 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
4129 CHK("REDUNDANT_CODE",
4130 "if this code is redundant consider removing it\n" .
4134 # check for needless "if (<foo>) fn(<foo>)" uses
4135 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
4136 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
4137 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
4139 "$1(NULL) is safe this check is probably not required\n" . $hereprev);
4143 # check for unnecessary "Out of Memory" messages
4144 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
4145 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
4146 (defined $1 || defined $3) &&
4149 my $testline = $lines[$linenr - 3];
4151 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
4152 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
4154 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
4156 "Possible unnecessary 'out of memory' message\n" . $hereprev);
4160 # check for bad placement of section $InitAttribute (e.g.: __initdata)
4161 if ($line =~ /(\b$InitAttribute\b)/) {
4163 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
4166 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
4167 ERROR("MISPLACED_INIT",
4168 "$attr should be placed after $var\n" . $herecurr)) ||
4169 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
4170 WARN("MISPLACED_INIT",
4171 "$attr should be placed after $var\n" . $herecurr))) &&
4173 $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;
4178 # check for $InitAttributeData (ie: __initdata) with const
4179 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
4181 $attr =~ /($InitAttributePrefix)(.*)/;
4182 my $attr_prefix = $1;
4184 if (ERROR("INIT_ATTRIBUTE",
4185 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
4187 $fixed[$linenr - 1] =~
4188 s/$InitAttributeData/${attr_prefix}initconst/;
4192 # check for $InitAttributeConst (ie: __initconst) without const
4193 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
4195 if (ERROR("INIT_ATTRIBUTE",
4196 "Use of $attr requires a separate use of const\n" . $herecurr) &&
4198 my $lead = $fixed[$linenr - 1] =~
4199 /(^\+\s*(?:static\s+))/;
4201 $lead = "$lead " if ($lead !~ /^\+$/);
4202 $lead = "${lead}const ";
4203 $fixed[$linenr - 1] =~ s/(^\+\s*(?:static\s+))/$lead/;
4207 # don't use __constant_<foo> functions outside of include/uapi/
4208 if ($realfile !~ m@^include/uapi/@ &&
4209 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
4210 my $constant_func = $1;
4211 my $func = $constant_func;
4212 $func =~ s/^__constant_//;
4213 if (WARN("CONSTANT_CONVERSION",
4214 "$constant_func should be $func\n" . $herecurr) &&
4216 $fixed[$linenr - 1] =~ s/\b$constant_func\b/$func/g;
4220 # prefer usleep_range over udelay
4221 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
4223 # ignore udelay's < 10, however
4224 if (! ($delay < 10) ) {
4226 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4228 if ($delay > 2000) {
4230 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
4234 # warn about unexpectedly long msleep's
4235 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
4238 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4242 # check for comparisons of jiffies
4243 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
4244 WARN("JIFFIES_COMPARISON",
4245 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4248 # check for comparisons of get_jiffies_64()
4249 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
4250 WARN("JIFFIES_COMPARISON",
4251 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4254 # warn about #ifdefs in C files
4255 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
4256 # print "#ifdef in C files should be avoided\n";
4257 # print "$herecurr";
4261 # warn about spacing in #ifdefs
4262 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
4263 if (ERROR("SPACING",
4264 "exactly one space required after that #$1\n" . $herecurr) &&
4266 $fixed[$linenr - 1] =~
4267 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
4272 # check for spinlock_t definitions without a comment.
4273 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
4274 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
4276 if (!ctx_has_comment($first_line, $linenr)) {
4277 CHK("UNCOMMENTED_DEFINITION",
4278 "$1 definition without comment\n" . $herecurr);
4281 # check for memory barriers without a comment.
4282 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4283 if (!ctx_has_comment($first_line, $linenr)) {
4284 WARN("MEMORY_BARRIER",
4285 "memory barrier without comment\n" . $herecurr);
4288 # check of hardware specific defines
4289 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
4291 "architecture specific defines should be avoided\n" . $herecurr);
4294 # Check that the storage class is at the beginning of a declaration
4295 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
4296 WARN("STORAGE_CLASS",
4297 "storage class should be at the beginning of the declaration\n" . $herecurr)
4300 # check the location of the inline attribute, that it is between
4301 # storage class and type.
4302 if ($line =~ /\b$Type\s+$Inline\b/ ||
4303 $line =~ /\b$Inline\s+$Storage\b/) {
4304 ERROR("INLINE_LOCATION",
4305 "inline keyword should sit between storage class and type\n" . $herecurr);
4308 # Check for __inline__ and __inline, prefer inline
4309 if ($realfile !~ m@\binclude/uapi/@ &&
4310 $line =~ /\b(__inline__|__inline)\b/) {
4312 "plain inline is preferred over $1\n" . $herecurr) &&
4314 $fixed[$linenr - 1] =~ s/\b(__inline__|__inline)\b/inline/;
4319 # Check for __attribute__ packed, prefer __packed
4320 if ($realfile !~ m@\binclude/uapi/@ &&
4321 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
4322 WARN("PREFER_PACKED",
4323 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
4326 # Check for __attribute__ aligned, prefer __aligned
4327 if ($realfile !~ m@\binclude/uapi/@ &&
4328 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
4329 WARN("PREFER_ALIGNED",
4330 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
4333 # Check for __attribute__ format(printf, prefer __printf
4334 if ($realfile !~ m@\binclude/uapi/@ &&
4335 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
4336 if (WARN("PREFER_PRINTF",
4337 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4339 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
4344 # Check for __attribute__ format(scanf, prefer __scanf
4345 if ($realfile !~ m@\binclude/uapi/@ &&
4346 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
4347 if (WARN("PREFER_SCANF",
4348 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4350 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
4354 # check for sizeof(&)
4355 if ($line =~ /\bsizeof\s*\(\s*\&/) {
4356 WARN("SIZEOF_ADDRESS",
4357 "sizeof(& should be avoided\n" . $herecurr);
4360 # check for sizeof without parenthesis
4361 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
4362 if (WARN("SIZEOF_PARENTHESIS",
4363 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
4365 $fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
4369 # check for line continuations in quoted strings with odd counts of "
4370 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
4371 WARN("LINE_CONTINUATIONS",
4372 "Avoid line continuations in quoted strings\n" . $herecurr);
4375 # check for struct spinlock declarations
4376 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
4377 WARN("USE_SPINLOCK_T",
4378 "struct spinlock should be spinlock_t\n" . $herecurr);
4381 # check for seq_printf uses that could be seq_puts
4382 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
4383 my $fmt = get_quoted_string($line, $rawline);
4384 if ($fmt ne "" && $fmt !~ /[^\\]\%/) {
4385 if (WARN("PREFER_SEQ_PUTS",
4386 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
4388 $fixed[$linenr - 1] =~ s/\bseq_printf\b/seq_puts/;
4393 # Check for misused memsets
4394 if ($^V && $^V ge 5.10.0 &&
4396 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
4402 if ($ms_size =~ /^(0x|)0$/i) {
4404 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
4405 } elsif ($ms_size =~ /^(0x|)1$/i) {
4407 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
4411 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
4412 if ($^V && $^V ge 5.10.0 &&
4413 $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) {
4414 if (WARN("PREFER_ETHER_ADDR_COPY",
4415 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
4417 $fixed[$linenr - 1] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
4421 # typecasts on min/max could be min_t/max_t
4422 if ($^V && $^V ge 5.10.0 &&
4424 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
4425 if (defined $2 || defined $7) {
4427 my $cast1 = deparenthesize($2);
4429 my $cast2 = deparenthesize($7);
4433 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
4434 $cast = "$cast1 or $cast2";
4435 } elsif ($cast1 ne "") {
4441 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
4445 # check usleep_range arguments
4446 if ($^V && $^V ge 5.10.0 &&
4448 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
4452 WARN("USLEEP_RANGE",
4453 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4454 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
4456 WARN("USLEEP_RANGE",
4457 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4461 # check for naked sscanf
4462 if ($^V && $^V ge 5.10.0 &&
4464 $line =~ /\bsscanf\b/ &&
4465 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
4466 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
4467 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
4468 my $lc = $stat =~ tr@\n@@;
4469 $lc = $lc + $linenr;
4470 my $stat_real = raw_line($linenr, 0);
4471 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4472 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4474 WARN("NAKED_SSCANF",
4475 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
4478 # check for simple sscanf that should be kstrto<foo>
4479 if ($^V && $^V ge 5.10.0 &&
4481 $line =~ /\bsscanf\b/) {
4482 my $lc = $stat =~ tr@\n@@;
4483 $lc = $lc + $linenr;
4484 my $stat_real = raw_line($linenr, 0);
4485 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4486 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4488 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
4490 my $count = $format =~ tr@%@%@;
4492 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
4493 WARN("SSCANF_TO_KSTRTO",
4494 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
4499 # check for new externs in .h files.
4500 if ($realfile =~ /\.h$/ &&
4501 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
4502 if (CHK("AVOID_EXTERNS",
4503 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
4505 $fixed[$linenr - 1] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
4509 # check for new externs in .c files.
4510 if ($realfile =~ /\.c$/ && defined $stat &&
4511 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
4513 my $function_name = $1;
4514 my $paren_space = $2;
4517 if (defined $cond) {
4518 substr($s, 0, length($cond), '');
4520 if ($s =~ /^\s*;/ &&
4521 $function_name ne 'uninitialized_var')
4523 WARN("AVOID_EXTERNS",
4524 "externs should be avoided in .c files\n" . $herecurr);
4527 if ($paren_space =~ /\n/) {
4528 WARN("FUNCTION_ARGUMENTS",
4529 "arguments for function declarations should follow identifier\n" . $herecurr);
4532 } elsif ($realfile =~ /\.c$/ && defined $stat &&
4533 $stat =~ /^.\s*extern\s+/)
4535 WARN("AVOID_EXTERNS",
4536 "externs should be avoided in .c files\n" . $herecurr);
4539 # checks for new __setup's
4540 if ($rawline =~ /\b__setup\("([^"]*)"/) {
4543 if (!grep(/$name/, @setup_docs)) {
4544 CHK("UNDOCUMENTED_SETUP",
4545 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
4549 # check for pointless casting of kmalloc return
4550 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
4551 WARN("UNNECESSARY_CASTS",
4552 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
4556 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
4557 if ($^V && $^V ge 5.10.0 &&
4558 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
4559 CHK("ALLOC_SIZEOF_STRUCT",
4560 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
4563 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
4564 if ($^V && $^V ge 5.10.0 &&
4565 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
4569 my $newfunc = "kmalloc_array";
4570 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
4573 if ($a1 =~ /^sizeof\s*\S/) {
4577 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
4578 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
4579 if (WARN("ALLOC_WITH_MULTIPLY",
4580 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
4582 $fixed[$linenr - 1] =~ s/\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)/$1 . ' = ' . "$newfunc(" . trim($r1) . ', ' . trim($r2)/e;
4588 # check for krealloc arg reuse
4589 if ($^V && $^V ge 5.10.0 &&
4590 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
4591 WARN("KREALLOC_ARG_REUSE",
4592 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
4595 # check for alloc argument mismatch
4596 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
4597 WARN("ALLOC_ARRAY_ARGS",
4598 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
4601 # check for multiple semicolons
4602 if ($line =~ /;\s*;\s*$/) {
4603 if (WARN("ONE_SEMICOLON",
4604 "Statements terminations use 1 semicolon\n" . $herecurr) &&
4606 $fixed[$linenr - 1] =~ s/(\s*;\s*){2,}$/;/g;
4610 # check for case / default statements not preceeded by break/fallthrough/switch
4611 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
4613 my $has_statement = 0;
4615 my $prevline = $linenr;
4616 while ($prevline > 1 && $count < 3 && !$has_break) {
4618 my $rline = $rawlines[$prevline - 1];
4619 my $fline = $lines[$prevline - 1];
4620 last if ($fline =~ /^\@\@/);
4621 next if ($fline =~ /^\-/);
4622 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
4623 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
4624 next if ($fline =~ /^.[\s$;]*$/);
4627 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
4629 if (!$has_break && $has_statement) {
4630 WARN("MISSING_BREAK",
4631 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
4635 # check for switch/default statements without a break;
4636 if ($^V && $^V ge 5.10.0 &&
4638 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
4640 my $herectx = $here . "\n";
4641 my $cnt = statement_rawlines($stat);
4642 for (my $n = 0; $n < $cnt; $n++) {
4643 $herectx .= raw_line($linenr, $n) . "\n";
4645 WARN("DEFAULT_NO_BREAK",
4646 "switch default: should use break\n" . $herectx);
4649 # check for gcc specific __FUNCTION__
4650 if ($line =~ /\b__FUNCTION__\b/) {
4651 if (WARN("USE_FUNC",
4652 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
4654 $fixed[$linenr - 1] =~ s/\b__FUNCTION__\b/__func__/g;
4658 # check for use of yield()
4659 if ($line =~ /\byield\s*\(\s*\)/) {
4661 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
4664 # check for comparisons against true and false
4665 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
4673 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
4675 my $type = lc($otype);
4676 if ($type =~ /^(?:true|false)$/) {
4677 if (("$test" eq "==" && "$type" eq "true") ||
4678 ("$test" eq "!=" && "$type" eq "false")) {
4682 CHK("BOOL_COMPARISON",
4683 "Using comparison to $otype is error prone\n" . $herecurr);
4685 ## maybe suggesting a correct construct would better
4686 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
4691 # check for semaphores initialized locked
4692 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
4693 WARN("CONSIDER_COMPLETION",
4694 "consider using a completion\n" . $herecurr);
4697 # recommend kstrto* over simple_strto* and strict_strto*
4698 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
4699 WARN("CONSIDER_KSTRTO",
4700 "$1 is obsolete, use k$3 instead\n" . $herecurr);
4703 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
4704 if ($line =~ /^.\s*__initcall\s*\(/) {
4705 WARN("USE_DEVICE_INITCALL",
4706 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
4709 # check for various ops structs, ensure they are const.
4710 my $struct_ops = qr{acpi_dock_ops|
4711 address_space_operations|
4713 block_device_operations|
4718 file_lock_operations|
4728 lock_manager_operations|
4734 pipe_buf_operations|
4735 platform_hibernation_ops|
4736 platform_suspend_ops|
4741 soc_pcmcia_socket_ops|
4747 if ($line !~ /\bconst\b/ &&
4748 $line =~ /\bstruct\s+($struct_ops)\b/) {
4749 WARN("CONST_STRUCT",
4750 "struct $1 should normally be const\n" .
4754 # use of NR_CPUS is usually wrong
4755 # ignore definitions of NR_CPUS and usage to define arrays as likely right
4756 if ($line =~ /\bNR_CPUS\b/ &&
4757 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
4758 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
4759 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
4760 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
4761 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
4764 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
4767 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
4768 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
4769 ERROR("DEFINE_ARCH_HAS",
4770 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
4773 # check for %L{u,d,i} in strings
4775 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4776 $string = substr($rawline, $-[1], $+[1] - $-[1]);
4777 $string =~ s/%%/__/g;
4778 if ($string =~ /(?<!%)%L[udi]/) {
4780 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
4785 # whine mightly about in_atomic
4786 if ($line =~ /\bin_atomic\s*\(/) {
4787 if ($realfile =~ m@^drivers/@) {
4789 "do not use in_atomic in drivers\n" . $herecurr);
4790 } elsif ($realfile !~ m@^kernel/@) {
4792 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
4796 # check for lockdep_set_novalidate_class
4797 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
4798 $line =~ /__lockdep_no_validate__\s*\)/ ) {
4799 if ($realfile !~ m@^kernel/lockdep@ &&
4800 $realfile !~ m@^include/linux/lockdep@ &&
4801 $realfile !~ m@^drivers/base/core@) {
4803 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
4807 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
4808 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
4809 WARN("EXPORTED_WORLD_WRITABLE",
4810 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
4813 # Mode permission misuses where it seems decimal should be octal
4814 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
4815 if ($^V && $^V ge 5.10.0 &&
4816 $line =~ /$mode_perms_search/) {
4817 foreach my $entry (@mode_permission_funcs) {
4818 my $func = $entry->[0];
4819 my $arg_pos = $entry->[1];
4824 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
4826 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
4827 if ($line =~ /$test/) {
4829 $val = $6 if ($skip_args ne "");
4831 if ($val !~ /^0$/ &&
4832 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
4833 length($val) ne 4)) {
4834 ERROR("NON_OCTAL_PERMISSIONS",
4835 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
4842 # If we have no input at all, then there is nothing to report on
4843 # so just keep quiet.
4844 if ($#rawlines == -1) {
4848 # In mailback mode only produce a report in the negative, for
4849 # things that appear to be patches.
4850 if ($mailback && ($clean == 1 || !$is_patch)) {
4854 # This is not a patch, and we are are in 'no-patch' mode so
4856 if (!$chk_patch && !$is_patch) {
4861 ERROR("NOT_UNIFIED_DIFF",
4862 "Does not appear to be a unified-diff format patch\n");
4864 if ($is_patch && $chk_signoff && $signoff == 0) {
4865 ERROR("MISSING_SIGN_OFF",
4866 "Missing Signed-off-by: line(s)\n");
4869 print report_dump();
4870 if ($summary && !($clean == 1 && $quiet == 1)) {
4871 print "$filename " if ($summary_file);
4872 print "total: $cnt_error errors, $cnt_warn warnings, " .
4873 (($check)? "$cnt_chk checks, " : "") .
4874 "$cnt_lines lines checked\n";
4875 print "\n" if ($quiet == 0);
4880 if ($^V lt 5.10.0) {
4881 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
4882 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
4885 # If there were whitespace errors which cleanpatch can fix
4886 # then suggest that.
4887 if ($rpt_cleaners) {
4888 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
4889 print " scripts/cleanfile\n\n";
4894 hash_show_words(\%use_type, "Used");
4895 hash_show_words(\%ignore_type, "Ignored");
4897 if ($clean == 0 && $fix && "@rawlines" ne "@fixed") {
4898 my $newfile = $filename;
4899 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
4903 open($f, '>', $newfile)
4904 or die "$P: Can't open $newfile for write\n";
4905 foreach my $fixed_line (@fixed) {
4908 if ($linecount > 3) {
4909 $fixed_line =~ s/^\+//;
4910 print $f $fixed_line. "\n";
4913 print $f $fixed_line . "\n";
4920 Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
4922 Do _NOT_ trust the results written to this file.
4923 Do _NOT_ submit these changes without inspecting them for correctness.
4925 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
4926 No warranties, expressed or implied...
4932 if ($clean == 1 && $quiet == 0) {
4933 print "$vname has no obvious style problems and is ready for submission.\n"
4935 if ($clean == 0 && $quiet == 0) {
4937 $vname has style problems, please review.
4939 If any of these errors are false positives, please report
4940 them to the maintainer, see CHECKPATCH in MAINTAINERS.