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*\[\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 $chk_signoff = 0 if ($file);
559 for my $filename (@ARGV) {
562 open($FILE, '-|', "diff -u /dev/null $filename") ||
563 die "$P: $filename: diff failed - $!\n";
564 } elsif ($filename eq '-') {
565 open($FILE, '<&STDIN');
567 open($FILE, '<', "$filename") ||
568 die "$P: $filename: open failed - $!\n";
570 if ($filename eq '-') {
571 $vname = 'Your patch';
580 if (!process($filename)) {
590 sub top_of_kernel_tree {
594 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
595 "README", "Documentation", "arch", "include", "drivers",
596 "fs", "init", "ipc", "kernel", "lib", "scripts",
599 foreach my $check (@tree_check) {
600 if (! -e $root . '/' . $check) {
608 my ($formatted_email) = @_;
614 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
617 $comment = $3 if defined $3;
618 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
620 $comment = $2 if defined $2;
621 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
623 $comment = $2 if defined $2;
624 $formatted_email =~ s/$address.*$//;
625 $name = $formatted_email;
627 $name =~ s/^\"|\"$//g;
628 # If there's a name left after stripping spaces and
629 # leading quotes, and the address doesn't have both
630 # leading and trailing angle brackets, the address
632 # "joe smith joe@smith.com" bad
633 # "joe smith <joe@smith.com" bad
634 if ($name ne "" && $address !~ /^<[^>]+>$/) {
642 $name =~ s/^\"|\"$//g;
643 $address = trim($address);
644 $address =~ s/^\<|\>$//g;
646 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
647 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
651 return ($name, $address, $comment);
655 my ($name, $address) = @_;
660 $name =~ s/^\"|\"$//g;
661 $address = trim($address);
663 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
664 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
669 $formatted_email = "$address";
671 $formatted_email = "$name <$address>";
674 return $formatted_email;
680 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
681 if (-e "$path/$conf") {
682 return "$path/$conf";
694 for my $c (split(//, $str)) {
698 for (; ($n % 8) != 0; $n++) {
710 (my $res = shift) =~ tr/\t/ /c;
717 # Drop the diff line leader and expand tabs
719 $line = expand_tabs($line);
721 # Pick the indent from the front of the line.
722 my ($white) = ($line =~ /^(\s*)/);
724 return (length($line), length($white));
727 my $sanitise_quote = '';
729 sub sanitise_line_reset {
730 my ($in_comment) = @_;
733 $sanitise_quote = '*/';
735 $sanitise_quote = '';
748 # Always copy over the diff marker.
749 $res = substr($line, 0, 1);
751 for ($off = 1; $off < length($line); $off++) {
752 $c = substr($line, $off, 1);
754 # Comments we are wacking completly including the begin
755 # and end, all to $;.
756 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
757 $sanitise_quote = '*/';
759 substr($res, $off, 2, "$;$;");
763 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
764 $sanitise_quote = '';
765 substr($res, $off, 2, "$;$;");
769 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
770 $sanitise_quote = '//';
772 substr($res, $off, 2, $sanitise_quote);
777 # A \ in a string means ignore the next character.
778 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
780 substr($res, $off, 2, 'XX');
785 if ($c eq "'" || $c eq '"') {
786 if ($sanitise_quote eq '') {
787 $sanitise_quote = $c;
789 substr($res, $off, 1, $c);
791 } elsif ($sanitise_quote eq $c) {
792 $sanitise_quote = '';
796 #print "c<$c> SQ<$sanitise_quote>\n";
797 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
798 substr($res, $off, 1, $;);
799 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
800 substr($res, $off, 1, $;);
801 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
802 substr($res, $off, 1, 'X');
804 substr($res, $off, 1, $c);
808 if ($sanitise_quote eq '//') {
809 $sanitise_quote = '';
812 # The pathname on a #include may be surrounded by '<' and '>'.
813 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
814 my $clean = 'X' x length($1);
815 $res =~ s@\<.*\>@<$clean>@;
817 # The whole of a #error is a string.
818 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
819 my $clean = 'X' x length($1);
820 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
826 sub get_quoted_string {
827 my ($line, $rawline) = @_;
829 return "" if ($line !~ m/(\"[X]+\")/g);
830 return substr($rawline, $-[0], $+[0] - $-[0]);
833 sub ctx_statement_block {
834 my ($linenr, $remain, $off) = @_;
835 my $line = $linenr - 1;
852 @stack = (['', 0]) if ($#stack == -1);
854 #warn "CSB: blk<$blk> remain<$remain>\n";
855 # If we are about to drop off the end, pull in more
858 for (; $remain > 0; $line++) {
859 last if (!defined $lines[$line]);
860 next if ($lines[$line] =~ /^-/);
863 $blk .= $lines[$line] . "\n";
868 # Bail if there is no further context.
869 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
873 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
879 $c = substr($blk, $off, 1);
880 $remainder = substr($blk, $off);
882 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
884 # Handle nested #if/#else.
885 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
886 push(@stack, [ $type, $level ]);
887 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
888 ($type, $level) = @{$stack[$#stack - 1]};
889 } elsif ($remainder =~ /^#\s*endif\b/) {
890 ($type, $level) = @{pop(@stack)};
893 # Statement ends at the ';' or a close '}' at the
895 if ($level == 0 && $c eq ';') {
899 # An else is really a conditional as long as its not else if
900 if ($level == 0 && $coff_set == 0 &&
901 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
902 $remainder =~ /^(else)(?:\s|{)/ &&
903 $remainder !~ /^else\s+if\b/) {
904 $coff = $off + length($1) - 1;
906 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
907 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
910 if (($type eq '' || $type eq '(') && $c eq '(') {
914 if ($type eq '(' && $c eq ')') {
916 $type = ($level != 0)? '(' : '';
918 if ($level == 0 && $coff < $soff) {
921 #warn "CSB: mark coff<$coff>\n";
924 if (($type eq '' || $type eq '{') && $c eq '{') {
928 if ($type eq '{' && $c eq '}') {
930 $type = ($level != 0)? '{' : '';
933 if (substr($blk, $off + 1, 1) eq ';') {
939 # Preprocessor commands end at the newline unless escaped.
940 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
948 # We are truly at the end, so shuffle to the next line.
955 my $statement = substr($blk, $soff, $off - $soff + 1);
956 my $condition = substr($blk, $soff, $coff - $soff + 1);
958 #warn "STATEMENT<$statement>\n";
959 #warn "CONDITION<$condition>\n";
961 #print "coff<$coff> soff<$off> loff<$loff>\n";
963 return ($statement, $condition,
964 $line, $remain + 1, $off - $loff + 1, $level);
967 sub statement_lines {
970 # Strip the diff line prefixes and rip blank lines at start and end.
971 $stmt =~ s/(^|\n)./$1/g;
975 my @stmt_lines = ($stmt =~ /\n/g);
977 return $#stmt_lines + 2;
980 sub statement_rawlines {
983 my @stmt_lines = ($stmt =~ /\n/g);
985 return $#stmt_lines + 2;
988 sub statement_block_size {
991 $stmt =~ s/(^|\n)./$1/g;
997 my @stmt_lines = ($stmt =~ /\n/g);
998 my @stmt_statements = ($stmt =~ /;/g);
1000 my $stmt_lines = $#stmt_lines + 2;
1001 my $stmt_statements = $#stmt_statements + 1;
1003 if ($stmt_lines > $stmt_statements) {
1006 return $stmt_statements;
1010 sub ctx_statement_full {
1011 my ($linenr, $remain, $off) = @_;
1012 my ($statement, $condition, $level);
1016 # Grab the first conditional/block pair.
1017 ($statement, $condition, $linenr, $remain, $off, $level) =
1018 ctx_statement_block($linenr, $remain, $off);
1019 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1020 push(@chunks, [ $condition, $statement ]);
1021 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1022 return ($level, $linenr, @chunks);
1025 # Pull in the following conditional/block pairs and see if they
1026 # could continue the statement.
1028 ($statement, $condition, $linenr, $remain, $off, $level) =
1029 ctx_statement_block($linenr, $remain, $off);
1030 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1031 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1033 push(@chunks, [ $condition, $statement ]);
1036 return ($level, $linenr, @chunks);
1040 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1042 my $start = $linenr - 1;
1049 my @stack = ($level);
1050 for ($line = $start; $remain > 0; $line++) {
1051 next if ($rawlines[$line] =~ /^-/);
1054 $blk .= $rawlines[$line];
1056 # Handle nested #if/#else.
1057 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1058 push(@stack, $level);
1059 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1060 $level = $stack[$#stack - 1];
1061 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1062 $level = pop(@stack);
1065 foreach my $c (split(//, $lines[$line])) {
1066 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1072 if ($c eq $close && $level > 0) {
1074 last if ($level == 0);
1075 } elsif ($c eq $open) {
1080 if (!$outer || $level <= 1) {
1081 push(@res, $rawlines[$line]);
1084 last if ($level == 0);
1087 return ($level, @res);
1089 sub ctx_block_outer {
1090 my ($linenr, $remain) = @_;
1092 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1096 my ($linenr, $remain) = @_;
1098 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1102 my ($linenr, $remain, $off) = @_;
1104 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1107 sub ctx_block_level {
1108 my ($linenr, $remain) = @_;
1110 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1112 sub ctx_statement_level {
1113 my ($linenr, $remain, $off) = @_;
1115 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1118 sub ctx_locate_comment {
1119 my ($first_line, $end_line) = @_;
1121 # Catch a comment on the end of the line itself.
1122 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1123 return $current_comment if (defined $current_comment);
1125 # Look through the context and try and figure out if there is a
1128 $current_comment = '';
1129 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1130 my $line = $rawlines[$linenr - 1];
1132 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1135 if ($line =~ m@/\*@) {
1138 if (!$in_comment && $current_comment ne '') {
1139 $current_comment = '';
1141 $current_comment .= $line . "\n" if ($in_comment);
1142 if ($line =~ m@\*/@) {
1147 chomp($current_comment);
1148 return($current_comment);
1150 sub ctx_has_comment {
1151 my ($first_line, $end_line) = @_;
1152 my $cmt = ctx_locate_comment($first_line, $end_line);
1154 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1155 ##print "CMMT: $cmt\n";
1157 return ($cmt ne '');
1161 my ($linenr, $cnt) = @_;
1163 my $offset = $linenr - 1;
1168 $line = $rawlines[$offset++];
1169 next if (defined($line) && $line =~ /^-/);
1181 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1184 $coded = sprintf("^%c", unpack('C', $2) + 64);
1193 my $av_preprocessor = 0;
1198 sub annotate_reset {
1199 $av_preprocessor = 0;
1201 @av_paren_type = ('E');
1202 $av_pend_colon = 'O';
1205 sub annotate_values {
1206 my ($stream, $type) = @_;
1209 my $var = '_' x length($stream);
1212 print "$stream\n" if ($dbg_values > 1);
1214 while (length($cur)) {
1215 @av_paren_type = ('E') if ($#av_paren_type < 0);
1216 print " <" . join('', @av_paren_type) .
1217 "> <$type> <$av_pending>" if ($dbg_values > 1);
1218 if ($cur =~ /^(\s+)/o) {
1219 print "WS($1)\n" if ($dbg_values > 1);
1220 if ($1 =~ /\n/ && $av_preprocessor) {
1221 $type = pop(@av_paren_type);
1222 $av_preprocessor = 0;
1225 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1226 print "CAST($1)\n" if ($dbg_values > 1);
1227 push(@av_paren_type, $type);
1230 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1231 print "DECLARE($1)\n" if ($dbg_values > 1);
1234 } elsif ($cur =~ /^($Modifier)\s*/) {
1235 print "MODIFIER($1)\n" if ($dbg_values > 1);
1238 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1239 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1240 $av_preprocessor = 1;
1241 push(@av_paren_type, $type);
1247 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1248 print "UNDEF($1)\n" if ($dbg_values > 1);
1249 $av_preprocessor = 1;
1250 push(@av_paren_type, $type);
1252 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1253 print "PRE_START($1)\n" if ($dbg_values > 1);
1254 $av_preprocessor = 1;
1256 push(@av_paren_type, $type);
1257 push(@av_paren_type, $type);
1260 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1261 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1262 $av_preprocessor = 1;
1264 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1268 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1269 print "PRE_END($1)\n" if ($dbg_values > 1);
1271 $av_preprocessor = 1;
1273 # Assume all arms of the conditional end as this
1274 # one does, and continue as if the #endif was not here.
1275 pop(@av_paren_type);
1276 push(@av_paren_type, $type);
1279 } elsif ($cur =~ /^(\\\n)/o) {
1280 print "PRECONT($1)\n" if ($dbg_values > 1);
1282 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1283 print "ATTR($1)\n" if ($dbg_values > 1);
1284 $av_pending = $type;
1287 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1288 print "SIZEOF($1)\n" if ($dbg_values > 1);
1294 } elsif ($cur =~ /^(if|while|for)\b/o) {
1295 print "COND($1)\n" if ($dbg_values > 1);
1299 } elsif ($cur =~/^(case)/o) {
1300 print "CASE($1)\n" if ($dbg_values > 1);
1301 $av_pend_colon = 'C';
1304 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1305 print "KEYWORD($1)\n" if ($dbg_values > 1);
1308 } elsif ($cur =~ /^(\()/o) {
1309 print "PAREN('$1')\n" if ($dbg_values > 1);
1310 push(@av_paren_type, $av_pending);
1314 } elsif ($cur =~ /^(\))/o) {
1315 my $new_type = pop(@av_paren_type);
1316 if ($new_type ne '_') {
1318 print "PAREN('$1') -> $type\n"
1319 if ($dbg_values > 1);
1321 print "PAREN('$1')\n" if ($dbg_values > 1);
1324 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1325 print "FUNC($1)\n" if ($dbg_values > 1);
1329 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1330 if (defined $2 && $type eq 'C' || $type eq 'T') {
1331 $av_pend_colon = 'B';
1332 } elsif ($type eq 'E') {
1333 $av_pend_colon = 'L';
1335 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1338 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1339 print "IDENT($1)\n" if ($dbg_values > 1);
1342 } elsif ($cur =~ /^($Assignment)/o) {
1343 print "ASSIGN($1)\n" if ($dbg_values > 1);
1346 } elsif ($cur =~/^(;|{|})/) {
1347 print "END($1)\n" if ($dbg_values > 1);
1349 $av_pend_colon = 'O';
1351 } elsif ($cur =~/^(,)/) {
1352 print "COMMA($1)\n" if ($dbg_values > 1);
1355 } elsif ($cur =~ /^(\?)/o) {
1356 print "QUESTION($1)\n" if ($dbg_values > 1);
1359 } elsif ($cur =~ /^(:)/o) {
1360 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1362 substr($var, length($res), 1, $av_pend_colon);
1363 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1368 $av_pend_colon = 'O';
1370 } elsif ($cur =~ /^(\[)/o) {
1371 print "CLOSE($1)\n" if ($dbg_values > 1);
1374 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1377 print "OPV($1)\n" if ($dbg_values > 1);
1384 substr($var, length($res), 1, $variant);
1387 } elsif ($cur =~ /^($Operators)/o) {
1388 print "OP($1)\n" if ($dbg_values > 1);
1389 if ($1 ne '++' && $1 ne '--') {
1393 } elsif ($cur =~ /(^.)/o) {
1394 print "C($1)\n" if ($dbg_values > 1);
1397 $cur = substr($cur, length($1));
1398 $res .= $type x length($1);
1402 return ($res, $var);
1406 my ($possible, $line) = @_;
1407 my $notPermitted = qr{(?:
1424 ^(?:typedef|struct|enum)\b
1426 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1427 if ($possible !~ $notPermitted) {
1428 # Check for modifiers.
1429 $possible =~ s/\s*$Storage\s*//g;
1430 $possible =~ s/\s*$Sparse\s*//g;
1431 if ($possible =~ /^\s*$/) {
1433 } elsif ($possible =~ /\s/) {
1434 $possible =~ s/\s*$Type\s*//g;
1435 for my $modifier (split(' ', $possible)) {
1436 if ($modifier !~ $notPermitted) {
1437 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1438 push(@modifierList, $modifier);
1443 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1444 push(@typeList, $possible);
1448 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1457 return defined $use_type{$type} if (scalar keys %use_type > 0);
1459 return !defined $ignore_type{$type};
1463 my ($level, $type, $msg) = @_;
1465 if (!show_type($type) ||
1466 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
1471 $line = "$prefix$level:$type: $msg\n";
1473 $line = "$prefix$level: $msg\n";
1475 $line = (split('\n', $line))[0] . "\n" if ($terse);
1477 push(our @report, $line);
1487 my ($type, $msg) = @_;
1489 if (report("ERROR", $type, $msg)) {
1497 my ($type, $msg) = @_;
1499 if (report("WARNING", $type, $msg)) {
1507 my ($type, $msg) = @_;
1509 if ($check && report("CHECK", $type, $msg)) {
1517 sub check_absolute_file {
1518 my ($absolute, $herecurr) = @_;
1519 my $file = $absolute;
1521 ##print "absolute<$absolute>\n";
1523 # See if any suffix of this path is a path within the tree.
1524 while ($file =~ s@^[^/]*/@@) {
1525 if (-f "$root/$file") {
1526 ##print "file<$file>\n";
1534 # It is, so see if the prefix is acceptable.
1535 my $prefix = $absolute;
1536 substr($prefix, -length($file)) = '';
1538 ##print "prefix<$prefix>\n";
1539 if ($prefix ne ".../") {
1540 WARN("USE_RELATIVE_PATH",
1541 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1548 $string =~ s/^\s+|\s+$//g;
1556 $string =~ s/^\s+//;
1564 $string =~ s/\s+$//;
1569 sub string_find_replace {
1570 my ($string, $find, $replace) = @_;
1572 $string =~ s/$find/$replace/g;
1580 my $source_indent = 8;
1581 my $max_spaces_before_tab = $source_indent - 1;
1582 my $spaces_to_tab = " " x $source_indent;
1584 #convert leading spaces to tabs
1585 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1586 #Remove spaces before a tab
1587 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1592 sub pos_last_openparen {
1597 my $opens = $line =~ tr/\(/\(/;
1598 my $closes = $line =~ tr/\)/\)/;
1600 my $last_openparen = 0;
1602 if (($opens == 0) || ($closes >= $opens)) {
1606 my $len = length($line);
1608 for ($pos = 0; $pos < $len; $pos++) {
1609 my $string = substr($line, $pos);
1610 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1611 $pos += length($1) - 1;
1612 } elsif (substr($line, $pos, 1) eq '(') {
1613 $last_openparen = $pos;
1614 } elsif (index($string, '(') == -1) {
1619 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
1623 my $filename = shift;
1629 my $stashrawline="";
1640 my $in_header_lines = 1;
1641 my $in_commit_log = 0; #Scanning lines before patch
1643 my $non_utf8_charset = 0;
1651 # Trace the real file/line as we go.
1657 my $comment_edge = 0;
1661 my $prev_values = 'E';
1664 my %suppress_ifbraces;
1665 my %suppress_whiletrailers;
1666 my %suppress_export;
1667 my $suppress_statement = 0;
1669 my %signatures = ();
1671 # Pre-scan the patch sanitizing the lines.
1672 # Pre-scan the patch looking for any __setup documentation.
1674 my @setup_docs = ();
1677 my $camelcase_file_seeded = 0;
1679 sanitise_line_reset();
1681 foreach my $rawline (@rawlines) {
1685 push(@fixed, $rawline) if ($fix);
1687 if ($rawline=~/^\+\+\+\s+(\S+)/) {
1689 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1694 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1703 # Guestimate if this is a continuing comment. Run
1704 # the context looking for a comment "edge". If this
1705 # edge is a close comment then we must be in a comment
1709 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1710 next if (defined $rawlines[$ln - 1] &&
1711 $rawlines[$ln - 1] =~ /^-/);
1713 #print "RAW<$rawlines[$ln - 1]>\n";
1714 last if (!defined $rawlines[$ln - 1]);
1715 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1716 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1721 if (defined $edge && $edge eq '*/') {
1725 # Guestimate if this is a continuing comment. If this
1726 # is the start of a diff block and this line starts
1727 # ' *' then it is very likely a comment.
1728 if (!defined $edge &&
1729 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1734 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1735 sanitise_line_reset($in_comment);
1737 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1738 # Standardise the strings and chars within the input to
1739 # simplify matching -- only bother with positive lines.
1740 $line = sanitise_line($rawline);
1742 push(@lines, $line);
1745 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1750 #print "==>$rawline\n";
1751 #print "-->$line\n";
1753 if ($setup_docs && $line =~ /^\+/) {
1754 push(@setup_docs, $line);
1762 foreach my $line (@lines) {
1764 my $sline = $line; #copy of $line
1765 $sline =~ s/$;/ /g; #with comments as spaces
1767 my $rawline = $rawlines[$linenr - 1];
1769 #extract the line range in the file after the patch is applied
1770 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1772 $first_line = $linenr + 1;
1782 %suppress_ifbraces = ();
1783 %suppress_whiletrailers = ();
1784 %suppress_export = ();
1785 $suppress_statement = 0;
1788 # track the line number as we move through the hunk, note that
1789 # new versions of GNU diff omit the leading space on completely
1790 # blank context lines so we need to count that too.
1791 } elsif ($line =~ /^( |\+|$)/) {
1793 $realcnt-- if ($realcnt != 0);
1795 # Measure the line length and indent.
1796 ($length, $indent) = line_stats($rawline);
1798 # Track the previous line.
1799 ($prevline, $stashline) = ($stashline, $line);
1800 ($previndent, $stashindent) = ($stashindent, $indent);
1801 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1803 #warn "line<$line>\n";
1805 } elsif ($realcnt == 1) {
1809 my $hunk_line = ($realcnt != 0);
1811 #make up the handle for any error we report on this line
1812 $prefix = "$filename:$realline: " if ($emacs && $file);
1813 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1815 $here = "#$linenr: " if (!$file);
1816 $here = "#$realline: " if ($file);
1819 # extract the filename as it passes
1820 if ($line =~ /^diff --git.*?(\S+)$/) {
1822 $realfile =~ s@^([^/]*)/@@ if (!$file);
1825 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
1827 $realfile =~ s@^([^/]*)/@@ if (!$file);
1831 if (!$file && $tree && $p1_prefix ne '' &&
1832 -e "$root/$p1_prefix") {
1833 WARN("PATCH_PREFIX",
1834 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1837 if ($realfile =~ m@^include/asm/@) {
1838 ERROR("MODIFIED_INCLUDE_ASM",
1839 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1845 if ($realfile =~ m@^(drivers/net/|net/)@) {
1848 $check = $check_orig;
1853 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
1855 my $hereline = "$here\n$rawline\n";
1856 my $herecurr = "$here\n$rawline\n";
1857 my $hereprev = "$here\n$prevrawline\n$rawline\n";
1859 $cnt_lines++ if ($realcnt != 0);
1861 # Check for incorrect file permissions
1862 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1863 my $permhere = $here . "FILE: $realfile\n";
1864 if ($realfile !~ m@scripts/@ &&
1865 $realfile !~ /\.(py|pl|awk|sh)$/) {
1866 ERROR("EXECUTE_PERMISSIONS",
1867 "do not set execute permissions for source files\n" . $permhere);
1871 # Check the patch for a signoff:
1872 if ($line =~ /^\s*signed-off-by:/i) {
1877 # Check signature styles
1878 if (!$in_header_lines &&
1879 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
1880 my $space_before = $1;
1882 my $space_after = $3;
1884 my $ucfirst_sign_off = ucfirst(lc($sign_off));
1886 if ($sign_off !~ /$signature_tags/) {
1887 WARN("BAD_SIGN_OFF",
1888 "Non-standard signature: $sign_off\n" . $herecurr);
1890 if (defined $space_before && $space_before ne "") {
1891 if (WARN("BAD_SIGN_OFF",
1892 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
1894 $fixed[$linenr - 1] =
1895 "$ucfirst_sign_off $email";
1898 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
1899 if (WARN("BAD_SIGN_OFF",
1900 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
1902 $fixed[$linenr - 1] =
1903 "$ucfirst_sign_off $email";
1907 if (!defined $space_after || $space_after ne " ") {
1908 if (WARN("BAD_SIGN_OFF",
1909 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
1911 $fixed[$linenr - 1] =
1912 "$ucfirst_sign_off $email";
1916 my ($email_name, $email_address, $comment) = parse_email($email);
1917 my $suggested_email = format_email(($email_name, $email_address));
1918 if ($suggested_email eq "") {
1919 ERROR("BAD_SIGN_OFF",
1920 "Unrecognized email address: '$email'\n" . $herecurr);
1922 my $dequoted = $suggested_email;
1923 $dequoted =~ s/^"//;
1924 $dequoted =~ s/" </ </;
1925 # Don't force email to have quotes
1926 # Allow just an angle bracketed address
1927 if ("$dequoted$comment" ne $email &&
1928 "<$email_address>$comment" ne $email &&
1929 "$suggested_email$comment" ne $email) {
1930 WARN("BAD_SIGN_OFF",
1931 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
1935 # Check for duplicate signatures
1936 my $sig_nospace = $line;
1937 $sig_nospace =~ s/\s//g;
1938 $sig_nospace = lc($sig_nospace);
1939 if (defined $signatures{$sig_nospace}) {
1940 WARN("BAD_SIGN_OFF",
1941 "Duplicate signature\n" . $herecurr);
1943 $signatures{$sig_nospace} = 1;
1947 # Check for unwanted Gerrit info
1948 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
1949 ERROR("GERRIT_CHANGE_ID",
1950 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
1953 # Check for wrappage within a valid hunk of the file
1954 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1955 ERROR("CORRUPTED_PATCH",
1956 "patch seems to be corrupt (line wrapped?)\n" .
1957 $herecurr) if (!$emitted_corrupt++);
1960 # Check for absolute kernel paths.
1962 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1965 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1966 check_absolute_file($1, $herecurr)) {
1969 check_absolute_file($file, $herecurr);
1974 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1975 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1976 $rawline !~ m/^$UTF8*$/) {
1977 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1979 my $blank = copy_spacing($rawline);
1980 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1981 my $hereptr = "$hereline$ptr\n";
1984 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1987 # Check if it's the start of a commit log
1988 # (not a header line and we haven't seen the patch filename)
1989 if ($in_header_lines && $realfile =~ /^$/ &&
1990 $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
1991 $in_header_lines = 0;
1995 # Check if there is UTF-8 in a commit log when a mail header has explicitly
1996 # declined it, i.e defined some charset where it is missing.
1997 if ($in_header_lines &&
1998 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2000 $non_utf8_charset = 1;
2003 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
2004 $rawline =~ /$NON_ASCII_UTF8/) {
2005 WARN("UTF8_BEFORE_PATCH",
2006 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2009 # ignore non-hunk lines and lines being removed
2010 next if (!$hunk_line || $line =~ /^-/);
2012 #trailing whitespace
2013 if ($line =~ /^\+.*\015/) {
2014 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2015 if (ERROR("DOS_LINE_ENDINGS",
2016 "DOS line endings\n" . $herevet) &&
2018 $fixed[$linenr - 1] =~ s/[\s\015]+$//;
2020 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2021 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2022 if (ERROR("TRAILING_WHITESPACE",
2023 "trailing whitespace\n" . $herevet) &&
2025 $fixed[$linenr - 1] =~ s/\s+$//;
2031 # Check for FSF mailing addresses.
2032 if ($rawline =~ /\bwrite to the Free/i ||
2033 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2034 $rawline =~ /\b51\s+Franklin\s+St/i) {
2035 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2036 my $msg_type = \&ERROR;
2037 $msg_type = \&CHK if ($file);
2038 &{$msg_type}("FSF_MAILING_ADDRESS",
2039 "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)
2042 # check for Kconfig help text having a real description
2043 # Only applies when adding the entry originally, after that we do not have
2044 # sufficient context to determine whether it is indeed long enough.
2045 if ($realfile =~ /Kconfig/ &&
2046 $line =~ /.\s*config\s+/) {
2049 my $ln = $linenr + 1;
2053 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
2054 $f = $lines[$ln - 1];
2055 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2056 $is_end = $lines[$ln - 1] =~ /^\+/;
2058 next if ($f =~ /^-/);
2060 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
2062 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
2069 next if ($f =~ /^$/);
2070 if ($f =~ /^\s*config\s/) {
2076 WARN("CONFIG_DESCRIPTION",
2077 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
2078 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2081 # discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2082 if ($realfile =~ /Kconfig/ &&
2083 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2084 WARN("CONFIG_EXPERIMENTAL",
2085 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2088 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2089 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2092 'EXTRA_AFLAGS' => 'asflags-y',
2093 'EXTRA_CFLAGS' => 'ccflags-y',
2094 'EXTRA_CPPFLAGS' => 'cppflags-y',
2095 'EXTRA_LDFLAGS' => 'ldflags-y',
2098 WARN("DEPRECATED_VARIABLE",
2099 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2102 # check for DT compatible documentation
2103 if (defined $root &&
2104 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2105 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2107 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2109 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2110 my $vp_file = $dt_path . "vendor-prefixes.txt";
2112 foreach my $compat (@compats) {
2113 my $compat2 = $compat;
2114 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2115 my $compat3 = $compat;
2116 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2117 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
2119 WARN("UNDOCUMENTED_DT_STRING",
2120 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2123 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2125 `grep -Eq "^$vendor\\b" $vp_file`;
2127 WARN("UNDOCUMENTED_DT_STRING",
2128 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2133 # check we are in a valid source file if not then ignore this hunk
2134 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
2137 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
2138 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
2139 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
2140 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
2141 $length > $max_line_length)
2144 "line over $max_line_length characters\n" . $herecurr);
2147 # Check for user-visible strings broken across lines, which breaks the ability
2148 # to grep for the string. Make exceptions when the previous string ends in a
2149 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
2150 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
2151 if ($line =~ /^\+\s*"/ &&
2152 $prevline =~ /"\s*$/ &&
2153 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
2154 WARN("SPLIT_STRING",
2155 "quoted string split across lines\n" . $hereprev);
2158 # check for spaces before a quoted newline
2159 if ($rawline =~ /^.*\".*\s\\n/) {
2160 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
2161 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
2163 $fixed[$linenr - 1] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
2168 # check for adding lines without a newline.
2169 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2170 WARN("MISSING_EOF_NEWLINE",
2171 "adding a line without newline at end of file\n" . $herecurr);
2174 # Blackfin: use hi/lo macros
2175 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2176 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2177 my $herevet = "$here\n" . cat_vet($line) . "\n";
2179 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
2181 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2182 my $herevet = "$here\n" . cat_vet($line) . "\n";
2184 "use the HI() macro, not (... >> 16)\n" . $herevet);
2188 # check we are in a valid source file C or perl if not then ignore this hunk
2189 next if ($realfile !~ /\.(h|c|pl)$/);
2191 # at the beginning of a line any tabs must come first and anything
2192 # more than 8 must use tabs.
2193 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2194 $rawline =~ /^\+\s* \s*/) {
2195 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2197 if (ERROR("CODE_INDENT",
2198 "code indent should use tabs where possible\n" . $herevet) &&
2200 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2204 # check for space before tabs.
2205 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2206 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2207 if (WARN("SPACE_BEFORE_TAB",
2208 "please, no space before tabs\n" . $herevet) &&
2210 while ($fixed[$linenr - 1] =~
2211 s/(^\+.*) {8,8}+\t/$1\t\t/) {}
2212 while ($fixed[$linenr - 1] =~
2213 s/(^\+.*) +\t/$1\t/) {}
2217 # check for && or || at the start of a line
2218 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2219 CHK("LOGICAL_CONTINUATIONS",
2220 "Logical continuations should be on the previous line\n" . $hereprev);
2223 # check multi-line statement indentation matches previous line
2224 if ($^V && $^V ge 5.10.0 &&
2225 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2226 $prevline =~ /^\+(\t*)(.*)$/;
2230 my $pos = pos_last_openparen($rest);
2232 $line =~ /^(\+| )([ \t]*)/;
2235 my $goodtabindent = $oldindent .
2238 my $goodspaceindent = $oldindent . " " x $pos;
2240 if ($newindent ne $goodtabindent &&
2241 $newindent ne $goodspaceindent) {
2243 if (CHK("PARENTHESIS_ALIGNMENT",
2244 "Alignment should match open parenthesis\n" . $hereprev) &&
2245 $fix && $line =~ /^\+/) {
2246 $fixed[$linenr - 1] =~
2247 s/^\+[ \t]*/\+$goodtabindent/;
2253 if ($line =~ /^\+.*\*[ \t]*\)[ \t]+(?!$Assignment|$Arithmetic)/) {
2255 "No space is necessary after a cast\n" . $hereprev) &&
2257 $fixed[$linenr - 1] =~
2258 s/^(\+.*\*[ \t]*\))[ \t]+/$1/;
2262 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2263 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
2264 $rawline =~ /^\+[ \t]*\*/ &&
2266 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2267 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2270 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2271 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2272 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
2273 $rawline =~ /^\+/ && #line is new
2274 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2275 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2276 "networking block comments start with * on subsequent lines\n" . $hereprev);
2279 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2280 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2281 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2282 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2283 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
2284 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2285 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2288 # check for missing blank lines after declarations
2289 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2290 # actual declarations
2291 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2292 # foo bar; where foo is some local typedef or #define
2293 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2294 # known declaration macros
2295 $prevline =~ /^\+\s+$declaration_macros/) &&
2296 # for "else if" which can look like "$Ident $Ident"
2297 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2298 # other possible extensions of declaration lines
2299 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2300 # not starting a section or a macro "\" extended line
2301 $prevline =~ /(?:\{\s*|\\)$/) &&
2302 # looks like a declaration
2303 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2304 # foo bar; where foo is some local typedef or #define
2305 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2306 # known declaration macros
2307 $sline =~ /^\+\s+$declaration_macros/ ||
2308 # start of struct or union or enum
2309 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
2310 # start or end of block or continuation of declaration
2311 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
2312 # bitfield continuation
2313 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
2314 # other possible extensions of declaration lines
2315 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
2316 # indentation of previous and current line are the same
2317 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
2319 "Missing a blank line after declarations\n" . $hereprev);
2322 # check for spaces at the beginning of a line.
2324 # 1) within comments
2325 # 2) indented preprocessor commands
2327 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
2328 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2329 if (WARN("LEADING_SPACE",
2330 "please, no spaces at the start of a line\n" . $herevet) &&
2332 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2336 # check we are in a valid C source file if not then ignore this hunk
2337 next if ($realfile !~ /\.(h|c)$/);
2339 # discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2340 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2341 WARN("CONFIG_EXPERIMENTAL",
2342 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2345 # check for RCS/CVS revision markers
2346 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
2348 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
2351 # Blackfin: don't use __builtin_bfin_[cs]sync
2352 if ($line =~ /__builtin_bfin_csync/) {
2353 my $herevet = "$here\n" . cat_vet($line) . "\n";
2355 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
2357 if ($line =~ /__builtin_bfin_ssync/) {
2358 my $herevet = "$here\n" . cat_vet($line) . "\n";
2360 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
2363 # check for old HOTPLUG __dev<foo> section markings
2364 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2365 WARN("HOTPLUG_SECTION",
2366 "Using $1 is unnecessary\n" . $herecurr);
2369 # Check for potential 'bare' types
2370 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2372 #print "LINE<$line>\n";
2373 if ($linenr >= $suppress_statement &&
2374 $realcnt && $sline =~ /.\s*\S/) {
2375 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2376 ctx_statement_block($linenr, $realcnt, 0);
2377 $stat =~ s/\n./\n /g;
2378 $cond =~ s/\n./\n /g;
2380 #print "linenr<$linenr> <$stat>\n";
2381 # If this statement has no statement boundaries within
2382 # it there is no point in retrying a statement scan
2383 # until we hit end of it.
2384 my $frag = $stat; $frag =~ s/;+\s*$//;
2385 if ($frag !~ /(?:{|;)/) {
2386 #print "skip<$line_nr_next>\n";
2387 $suppress_statement = $line_nr_next;
2390 # Find the real next line.
2391 $realline_next = $line_nr_next;
2392 if (defined $realline_next &&
2393 (!defined $lines[$realline_next - 1] ||
2394 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2401 # Ignore goto labels.
2402 if ($s =~ /$Ident:\*$/s) {
2404 # Ignore functions being called
2405 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
2407 } elsif ($s =~ /^.\s*else\b/s) {
2409 # declarations always start with types
2410 } 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) {
2413 possible($type, "A:" . $s);
2415 # definitions in global scope can only start with types
2416 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
2417 possible($1, "B:" . $s);
2420 # any (foo ... *) is a pointer cast, and foo is a type
2421 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
2422 possible($1, "C:" . $s);
2425 # Check for any sort of function declaration.
2426 # int foo(something bar, other baz);
2427 # void (*store_gdt)(x86_descr_ptr *);
2428 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
2429 my ($name_len) = length($1);
2432 substr($ctx, 0, $name_len + 1, '');
2433 $ctx =~ s/\)[^\)]*$//;
2435 for my $arg (split(/\s*,\s*/, $ctx)) {
2436 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
2438 possible($1, "D:" . $s);
2446 # Checks which may be anchored in the context.
2449 # Check for switch () and associated case and default
2450 # statements should be at the same indent.
2451 if ($line=~/\bswitch\s*\(.*\)/) {
2454 my @ctx = ctx_block_outer($linenr, $realcnt);
2456 for my $ctx (@ctx) {
2457 my ($clen, $cindent) = line_stats($ctx);
2458 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2459 $indent != $cindent) {
2460 $err .= "$sep$ctx\n";
2467 ERROR("SWITCH_CASE_INDENT_LEVEL",
2468 "switch and case should be at the same indent\n$hereline$err");
2472 # if/while/etc brace do not go on next line, unless defining a do while loop,
2473 # or if that brace on the next line is for something else
2474 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
2475 my $pre_ctx = "$1$2";
2477 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
2479 if ($line =~ /^\+\t{6,}/) {
2480 WARN("DEEP_INDENTATION",
2481 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2484 my $ctx_cnt = $realcnt - $#ctx - 1;
2485 my $ctx = join("\n", @ctx);
2487 my $ctx_ln = $linenr;
2488 my $ctx_skip = $realcnt;
2490 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2491 defined $lines[$ctx_ln - 1] &&
2492 $lines[$ctx_ln - 1] =~ /^-/)) {
2493 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2494 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
2498 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2499 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
2501 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
2503 "that open brace { should be on the previous line\n" .
2504 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2506 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2507 $ctx =~ /\)\s*\;\s*$/ &&
2508 defined $lines[$ctx_ln - 1])
2510 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2511 if ($nindent > $indent) {
2512 WARN("TRAILING_SEMICOLON",
2513 "trailing semicolon indicates no statements, indent implies otherwise\n" .
2514 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2519 # Check relative indent for conditionals and blocks.
2520 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2521 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2522 ctx_statement_block($linenr, $realcnt, 0)
2523 if (!defined $stat);
2524 my ($s, $c) = ($stat, $cond);
2526 substr($s, 0, length($c), '');
2528 # Make sure we remove the line prefixes as we have
2529 # none on the first line, and are going to readd them
2533 # Find out how long the conditional actually is.
2534 my @newlines = ($c =~ /\n/gs);
2535 my $cond_lines = 1 + $#newlines;
2537 # We want to check the first line inside the block
2538 # starting at the end of the conditional, so remove:
2539 # 1) any blank line termination
2540 # 2) any opening brace { on end of the line
2542 my $continuation = 0;
2544 $s =~ s/^.*\bdo\b//;
2546 if ($s =~ s/^\s*\\//) {
2549 if ($s =~ s/^\s*?\n//) {
2554 # Also ignore a loop construct at the end of a
2555 # preprocessor statement.
2556 if (($prevline =~ /^.\s*#\s*define\s/ ||
2557 $prevline =~ /\\\s*$/) && $continuation == 0) {
2563 while ($cond_ptr != $cond_lines) {
2564 $cond_ptr = $cond_lines;
2566 # If we see an #else/#elif then the code
2568 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2573 # 1) blank lines, they should be at 0,
2574 # 2) preprocessor lines, and
2576 if ($continuation ||
2578 $s =~ /^\s*#\s*?/ ||
2579 $s =~ /^\s*$Ident\s*:/) {
2580 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
2581 if ($s =~ s/^.*?\n//) {
2587 my (undef, $sindent) = line_stats("+" . $s);
2588 my $stat_real = raw_line($linenr, $cond_lines);
2590 # Check if either of these lines are modified, else
2591 # this is not this patch's fault.
2592 if (!defined($stat_real) ||
2593 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2596 if (defined($stat_real) && $cond_lines > 1) {
2597 $stat_real = "[...]\n$stat_real";
2600 #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";
2602 if ($check && (($sindent % 8) != 0 ||
2603 ($sindent <= $indent && $s ne ''))) {
2604 WARN("SUSPECT_CODE_INDENT",
2605 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
2609 # Track the 'values' across context and added lines.
2610 my $opline = $line; $opline =~ s/^./ /;
2611 my ($curr_values, $curr_vars) =
2612 annotate_values($opline . "\n", $prev_values);
2613 $curr_values = $prev_values . $curr_values;
2615 my $outline = $opline; $outline =~ s/\t/ /g;
2616 print "$linenr > .$outline\n";
2617 print "$linenr > $curr_values\n";
2618 print "$linenr > $curr_vars\n";
2620 $prev_values = substr($curr_values, -1);
2622 #ignore lines not being added
2623 next if ($line =~ /^[^\+]/);
2625 # TEST: allow direct testing of the type matcher.
2627 if ($line =~ /^.\s*$Declare\s*$/) {
2629 "TEST: is type\n" . $herecurr);
2630 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
2631 ERROR("TEST_NOT_TYPE",
2632 "TEST: is not type ($1 is)\n". $herecurr);
2636 # TEST: allow direct testing of the attribute matcher.
2638 if ($line =~ /^.\s*$Modifier\s*$/) {
2640 "TEST: is attr\n" . $herecurr);
2641 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
2642 ERROR("TEST_NOT_ATTR",
2643 "TEST: is not attr ($1 is)\n". $herecurr);
2648 # check for initialisation to aggregates open brace on the next line
2649 if ($line =~ /^.\s*{/ &&
2650 $prevline =~ /(?:^|[^=])=\s*$/) {
2652 "that open brace { should be on the previous line\n" . $hereprev);
2656 # Checks which are anchored on the added line.
2659 # check for malformed paths in #include statements (uses RAW line)
2660 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
2662 if ($path =~ m{//}) {
2663 ERROR("MALFORMED_INCLUDE",
2664 "malformed #include filename\n" . $herecurr);
2666 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
2667 ERROR("UAPI_INCLUDE",
2668 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
2672 # no C99 // comments
2673 if ($line =~ m{//}) {
2674 if (ERROR("C99_COMMENTS",
2675 "do not use C99 // comments\n" . $herecurr) &&
2677 my $line = $fixed[$linenr - 1];
2678 if ($line =~ /\/\/(.*)$/) {
2679 my $comment = trim($1);
2680 $fixed[$linenr - 1] =~ s@\/\/(.*)$@/\* $comment \*/@;
2684 # Remove C99 comments.
2686 $opline =~ s@//.*@@;
2688 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2689 # the whole statement.
2690 #print "APW <$lines[$realline_next - 1]>\n";
2691 if (defined $realline_next &&
2692 exists $lines[$realline_next - 1] &&
2693 !defined $suppress_export{$realline_next} &&
2694 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2695 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2696 # Handle definitions which produce identifiers with
2699 # EXPORT_SYMBOL(something_foo);
2701 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
2702 $name =~ /^${Ident}_$2/) {
2703 #print "FOO C name<$name>\n";
2704 $suppress_export{$realline_next} = 1;
2706 } elsif ($stat !~ /(?:
2708 ^.DEFINE_$Ident\(\Q$name\E\)|
2709 ^.DECLARE_$Ident\(\Q$name\E\)|
2710 ^.LIST_HEAD\(\Q$name\E\)|
2711 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2712 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
2714 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2715 $suppress_export{$realline_next} = 2;
2717 $suppress_export{$realline_next} = 1;
2720 if (!defined $suppress_export{$linenr} &&
2721 $prevline =~ /^.\s*$/ &&
2722 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2723 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2724 #print "FOO B <$lines[$linenr - 1]>\n";
2725 $suppress_export{$linenr} = 2;
2727 if (defined $suppress_export{$linenr} &&
2728 $suppress_export{$linenr} == 2) {
2729 WARN("EXPORT_SYMBOL",
2730 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
2733 # check for global initialisers.
2734 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
2735 if (ERROR("GLOBAL_INITIALISERS",
2736 "do not initialise globals to 0 or NULL\n" .
2739 $fixed[$linenr - 1] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
2742 # check for static initialisers.
2743 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2744 if (ERROR("INITIALISED_STATIC",
2745 "do not initialise statics to 0 or NULL\n" .
2748 $fixed[$linenr - 1] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
2752 # check for static const char * arrays.
2753 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
2754 WARN("STATIC_CONST_CHAR_ARRAY",
2755 "static const char * array should probably be static const char * const\n" .
2759 # check for static char foo[] = "bar" declarations.
2760 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
2761 WARN("STATIC_CONST_CHAR_ARRAY",
2762 "static char array declaration should probably be static const char\n" .
2766 # check for non-global char *foo[] = {"bar", ...} declarations.
2767 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
2768 WARN("STATIC_CONST_CHAR_ARRAY",
2769 "char * array declaration might be better as static const\n" .
2773 # check for function declarations without arguments like "int foo()"
2774 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
2775 if (ERROR("FUNCTION_WITHOUT_ARGS",
2776 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
2778 $fixed[$linenr - 1] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
2782 # check for uses of DEFINE_PCI_DEVICE_TABLE
2783 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
2784 if (WARN("DEFINE_PCI_DEVICE_TABLE",
2785 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
2787 $fixed[$linenr - 1] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
2791 # check for new typedefs, only function parameters and sparse annotations
2793 if ($line =~ /\btypedef\s/ &&
2794 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
2795 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
2796 $line !~ /\b$typeTypedefs\b/ &&
2797 $line !~ /\b__bitwise(?:__|)\b/) {
2798 WARN("NEW_TYPEDEFS",
2799 "do not add new typedefs\n" . $herecurr);
2802 # * goes on variable not on type
2804 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2806 my ($ident, $from, $to) = ($1, $2, $2);
2808 # Should start with a space.
2809 $to =~ s/^(\S)/ $1/;
2810 # Should not end with a space.
2812 # '*'s should not have spaces between.
2813 while ($to =~ s/\*\s+\*/\*\*/) {
2816 ## print "1: from<$from> to<$to> ident<$ident>\n";
2818 if (ERROR("POINTER_LOCATION",
2819 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
2821 my $sub_from = $ident;
2822 my $sub_to = $ident;
2823 $sub_to =~ s/\Q$from\E/$to/;
2824 $fixed[$linenr - 1] =~
2825 s@\Q$sub_from\E@$sub_to@;
2829 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2831 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
2833 # Should start with a space.
2834 $to =~ s/^(\S)/ $1/;
2835 # Should not end with a space.
2837 # '*'s should not have spaces between.
2838 while ($to =~ s/\*\s+\*/\*\*/) {
2840 # Modifiers should have spaces.
2841 $to =~ s/(\b$Modifier$)/$1 /;
2843 ## print "2: from<$from> to<$to> ident<$ident>\n";
2844 if ($from ne $to && $ident !~ /^$Modifier$/) {
2845 if (ERROR("POINTER_LOCATION",
2846 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
2849 my $sub_from = $match;
2850 my $sub_to = $match;
2851 $sub_to =~ s/\Q$from\E/$to/;
2852 $fixed[$linenr - 1] =~
2853 s@\Q$sub_from\E@$sub_to@;
2858 # # no BUG() or BUG_ON()
2859 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
2860 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2861 # print "$herecurr";
2865 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
2866 WARN("LINUX_VERSION_CODE",
2867 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
2870 # check for uses of printk_ratelimit
2871 if ($line =~ /\bprintk_ratelimit\s*\(/) {
2872 WARN("PRINTK_RATELIMITED",
2873 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
2876 # printk should use KERN_* levels. Note that follow on printk's on the
2877 # same line do not need a level, so we use the current block context
2878 # to try and find and validate the current printk. In summary the current
2879 # printk includes all preceding printk's which have no newline on the end.
2880 # we assume the first bad printk is the one to report.
2881 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
2883 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2884 #print "CHECK<$lines[$ln - 1]\n";
2885 # we have a preceding printk if it ends
2886 # with "\n" ignore it, else it is to blame
2887 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2888 if ($rawlines[$ln - 1] !~ m{\\n"}) {
2895 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2896 "printk() should include KERN_ facility level\n" . $herecurr);
2900 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
2902 my $level = lc($orig);
2903 $level = "warn" if ($level eq "warning");
2904 my $level2 = $level;
2905 $level2 = "dbg" if ($level eq "debug");
2906 WARN("PREFER_PR_LEVEL",
2907 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
2910 if ($line =~ /\bpr_warning\s*\(/) {
2911 if (WARN("PREFER_PR_LEVEL",
2912 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
2914 $fixed[$linenr - 1] =~
2915 s/\bpr_warning\b/pr_warn/;
2919 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
2921 my $level = lc($orig);
2922 $level = "warn" if ($level eq "warning");
2923 $level = "dbg" if ($level eq "debug");
2924 WARN("PREFER_DEV_LEVEL",
2925 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
2928 # function brace can't be on same line, except for #defines of do while,
2929 # or if closed on same line
2930 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2931 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
2933 "open brace '{' following function declarations go on the next line\n" . $herecurr);
2936 # open braces for enum, union and struct go on the same line.
2937 if ($line =~ /^.\s*{/ &&
2938 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
2940 "open brace '{' following $1 go on the same line\n" . $hereprev);
2943 # missing space after union, struct or enum definition
2944 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
2946 "missing space after $1 definition\n" . $herecurr) &&
2948 $fixed[$linenr - 1] =~
2949 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
2953 # Function pointer declarations
2954 # check spacing between type, funcptr, and args
2955 # canonical declaration is "type (*funcptr)(args...)"
2956 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
2958 my $pre_pointer_space = $2;
2959 my $post_pointer_space = $3;
2961 my $post_funcname_space = $5;
2962 my $pre_args_space = $6;
2964 # the $Declare variable will capture all spaces after the type
2965 # so check it for a missing trailing missing space but pointer return types
2966 # don't need a space so don't warn for those.
2967 my $post_declare_space = "";
2968 if ($declare =~ /(\s+)$/) {
2969 $post_declare_space = $1;
2970 $declare = rtrim($declare);
2972 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
2974 "missing space after return type\n" . $herecurr);
2975 $post_declare_space = " ";
2978 # unnecessary space "type (*funcptr)(args...)"
2979 # This test is not currently implemented because these declarations are
2981 # int foo(int bar, ...)
2982 # and this is form shouldn't/doesn't generate a checkpatch warning.
2984 # elsif ($declare =~ /\s{2,}$/) {
2986 # "Multiple spaces after return type\n" . $herecurr);
2989 # unnecessary space "type ( *funcptr)(args...)"
2990 if (defined $pre_pointer_space &&
2991 $pre_pointer_space =~ /^\s/) {
2993 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
2996 # unnecessary space "type (* funcptr)(args...)"
2997 if (defined $post_pointer_space &&
2998 $post_pointer_space =~ /^\s/) {
3000 "Unnecessary space before function pointer name\n" . $herecurr);
3003 # unnecessary space "type (*funcptr )(args...)"
3004 if (defined $post_funcname_space &&
3005 $post_funcname_space =~ /^\s/) {
3007 "Unnecessary space after function pointer name\n" . $herecurr);
3010 # unnecessary space "type (*funcptr) (args...)"
3011 if (defined $pre_args_space &&
3012 $pre_args_space =~ /^\s/) {
3014 "Unnecessary space before function pointer arguments\n" . $herecurr);
3017 if (show_type("SPACING") && $fix) {
3018 $fixed[$linenr - 1] =~
3019 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3023 # check for spacing round square brackets; allowed:
3024 # 1. with a type on the left -- int [] a;
3025 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3026 # 3. inside a curly brace -- = { [0...10] = 5 }
3027 while ($line =~ /(.*?\s)\[/g) {
3028 my ($where, $prefix) = ($-[1], $1);
3029 if ($prefix !~ /$Type\s+$/ &&
3030 ($where != 0 || $prefix !~ /^.\s+$/) &&
3031 $prefix !~ /[{,]\s+$/) {
3032 if (ERROR("BRACKET_SPACE",
3033 "space prohibited before open square bracket '['\n" . $herecurr) &&
3035 $fixed[$linenr - 1] =~
3036 s/^(\+.*?)\s+\[/$1\[/;
3041 # check for spaces between functions and their parentheses.
3042 while ($line =~ /($Ident)\s+\(/g) {
3044 my $ctx_before = substr($line, 0, $-[1]);
3045 my $ctx = "$ctx_before$name";
3047 # Ignore those directives where spaces _are_ permitted.
3049 if|for|while|switch|return|case|
3050 volatile|__volatile__|
3051 __attribute__|format|__extension__|
3054 # cpp #define statements have non-optional spaces, ie
3055 # if there is a space between the name and the open
3056 # parenthesis it is simply not a parameter group.
3057 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
3059 # cpp #elif statement condition may start with a (
3060 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
3062 # If this whole things ends with a type its most
3063 # likely a typedef for a function.
3064 } elsif ($ctx =~ /$Type$/) {
3068 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3070 $fixed[$linenr - 1] =~
3071 s/\b$name\s+\(/$name\(/;
3076 # Check operator spacing.
3077 if (!($line=~/\#\s*include/)) {
3078 my $fixed_line = "";
3082 <<=|>>=|<=|>=|==|!=|
3083 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3084 =>|->|<<|>>|<|>|=|!|~|
3085 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
3088 my @elements = split(/($ops|;)/, $opline);
3090 ## print("element count: <" . $#elements . ">\n");
3091 ## foreach my $el (@elements) {
3092 ## print("el: <$el>\n");
3095 my @fix_elements = ();
3098 foreach my $el (@elements) {
3099 push(@fix_elements, substr($rawline, $off, length($el)));
3100 $off += length($el);
3105 my $blank = copy_spacing($opline);
3106 my $last_after = -1;
3108 for (my $n = 0; $n < $#elements; $n += 2) {
3110 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3112 ## print("n: <$n> good: <$good>\n");
3114 $off += length($elements[$n]);
3116 # Pick up the preceding and succeeding characters.
3117 my $ca = substr($opline, 0, $off);
3119 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3120 $cc = substr($opline, $off + length($elements[$n + 1]));
3122 my $cb = "$ca$;$cc";
3125 $a = 'V' if ($elements[$n] ne '');
3126 $a = 'W' if ($elements[$n] =~ /\s$/);
3127 $a = 'C' if ($elements[$n] =~ /$;$/);
3128 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3129 $a = 'O' if ($elements[$n] eq '');
3130 $a = 'E' if ($ca =~ /^\s*$/);
3132 my $op = $elements[$n + 1];
3135 if (defined $elements[$n + 2]) {
3136 $c = 'V' if ($elements[$n + 2] ne '');
3137 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
3138 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
3139 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3140 $c = 'O' if ($elements[$n + 2] eq '');
3141 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
3146 my $ctx = "${a}x${c}";
3148 my $at = "(ctx:$ctx)";
3150 my $ptr = substr($blank, 0, $off) . "^";
3151 my $hereptr = "$hereline$ptr\n";
3153 # Pull out the value of this operator.
3154 my $op_type = substr($curr_values, $off + 1, 1);
3156 # Get the full operator variant.
3157 my $opv = $op . substr($curr_vars, $off, 1);
3159 # Ignore operators passed as parameters.
3160 if ($op_type ne 'V' &&
3161 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
3164 # } elsif ($op =~ /^$;+$/) {
3166 # ; should have either the end of line or a space or \ after it
3167 } elsif ($op eq ';') {
3168 if ($ctx !~ /.x[WEBC]/ &&
3169 $cc !~ /^\\/ && $cc !~ /^;/) {
3170 if (ERROR("SPACING",
3171 "space required after that '$op' $at\n" . $hereptr)) {
3172 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3178 } elsif ($op eq '//') {
3180 # : when part of a bitfield
3181 } elsif ($opv eq ':B') {
3182 # skip the bitfield test for now
3186 } elsif ($op eq '->') {
3187 if ($ctx =~ /Wx.|.xW/) {
3188 if (ERROR("SPACING",
3189 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
3190 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3191 if (defined $fix_elements[$n + 2]) {
3192 $fix_elements[$n + 2] =~ s/^\s+//;
3198 # , must have a space on the right.
3199 } elsif ($op eq ',') {
3200 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
3201 if (ERROR("SPACING",
3202 "space required after that '$op' $at\n" . $hereptr)) {
3203 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3209 # '*' as part of a type definition -- reported already.
3210 } elsif ($opv eq '*_') {
3211 #warn "'*' is part of type\n";
3213 # unary operators should have a space before and
3214 # none after. May be left adjacent to another
3215 # unary operator, or a cast
3216 } elsif ($op eq '!' || $op eq '~' ||
3217 $opv eq '*U' || $opv eq '-U' ||
3218 $opv eq '&U' || $opv eq '&&U') {
3219 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
3220 if (ERROR("SPACING",
3221 "space required before that '$op' $at\n" . $hereptr)) {
3222 if ($n != $last_after + 2) {
3223 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3228 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
3229 # A unary '*' may be const
3231 } elsif ($ctx =~ /.xW/) {
3232 if (ERROR("SPACING",
3233 "space prohibited after that '$op' $at\n" . $hereptr)) {
3234 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
3235 if (defined $fix_elements[$n + 2]) {
3236 $fix_elements[$n + 2] =~ s/^\s+//;
3242 # unary ++ and unary -- are allowed no space on one side.
3243 } elsif ($op eq '++' or $op eq '--') {
3244 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
3245 if (ERROR("SPACING",
3246 "space required one side of that '$op' $at\n" . $hereptr)) {
3247 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3251 if ($ctx =~ /Wx[BE]/ ||
3252 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
3253 if (ERROR("SPACING",
3254 "space prohibited before that '$op' $at\n" . $hereptr)) {
3255 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3259 if ($ctx =~ /ExW/) {
3260 if (ERROR("SPACING",
3261 "space prohibited after that '$op' $at\n" . $hereptr)) {
3262 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3263 if (defined $fix_elements[$n + 2]) {
3264 $fix_elements[$n + 2] =~ s/^\s+//;
3270 # << and >> may either have or not have spaces both sides
3271 } elsif ($op eq '<<' or $op eq '>>' or
3272 $op eq '&' or $op eq '^' or $op eq '|' or
3273 $op eq '+' or $op eq '-' or
3274 $op eq '*' or $op eq '/' or
3277 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
3278 if (ERROR("SPACING",
3279 "need consistent spacing around '$op' $at\n" . $hereptr)) {
3280 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3281 if (defined $fix_elements[$n + 2]) {
3282 $fix_elements[$n + 2] =~ s/^\s+//;
3288 # A colon needs no spaces before when it is
3289 # terminating a case value or a label.
3290 } elsif ($opv eq ':C' || $opv eq ':L') {
3291 if ($ctx =~ /Wx./) {
3292 if (ERROR("SPACING",
3293 "space prohibited before that '$op' $at\n" . $hereptr)) {
3294 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3299 # All the others need spaces both sides.
3300 } elsif ($ctx !~ /[EWC]x[CWE]/) {
3303 # Ignore email addresses <foo@bar>
3305 $cc =~ /^\S+\@\S+>/) ||
3307 $ca =~ /<\S+\@\S+$/))
3312 # messages are ERROR, but ?: are CHK
3314 my $msg_type = \&ERROR;
3315 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
3317 if (&{$msg_type}("SPACING",
3318 "spaces required around that '$op' $at\n" . $hereptr)) {
3319 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3320 if (defined $fix_elements[$n + 2]) {
3321 $fix_elements[$n + 2] =~ s/^\s+//;
3327 $off += length($elements[$n + 1]);
3329 ## print("n: <$n> GOOD: <$good>\n");
3331 $fixed_line = $fixed_line . $good;
3334 if (($#elements % 2) == 0) {
3335 $fixed_line = $fixed_line . $fix_elements[$#elements];
3338 if ($fix && $line_fixed && $fixed_line ne $fixed[$linenr - 1]) {
3339 $fixed[$linenr - 1] = $fixed_line;
3345 # check for whitespace before a non-naked semicolon
3346 if ($line =~ /^\+.*\S\s+;\s*$/) {
3348 "space prohibited before semicolon\n" . $herecurr) &&
3350 1 while $fixed[$linenr - 1] =~
3351 s/^(\+.*\S)\s+;/$1;/;
3355 # check for multiple assignments
3356 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
3357 CHK("MULTIPLE_ASSIGNMENTS",
3358 "multiple assignments should be avoided\n" . $herecurr);
3361 ## # check for multiple declarations, allowing for a function declaration
3363 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3364 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3366 ## # Remove any bracketed sections to ensure we do not
3367 ## # falsly report the parameters of functions.
3369 ## while ($ln =~ s/\([^\(\)]*\)//g) {
3371 ## if ($ln =~ /,/) {
3372 ## WARN("MULTIPLE_DECLARATION",
3373 ## "declaring multiple variables together should be avoided\n" . $herecurr);
3377 #need space before brace following if, while, etc
3378 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3380 if (ERROR("SPACING",
3381 "space required before the open brace '{'\n" . $herecurr) &&
3383 $fixed[$linenr - 1] =~ s/^(\+.*(?:do|\))){/$1 {/;
3387 ## # check for blank lines before declarations
3388 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3389 ## $prevrawline =~ /^.\s*$/) {
3391 ## "No blank lines before declarations\n" . $hereprev);
3395 # closing brace should have a space following it when it has anything
3397 if ($line =~ /}(?!(?:,|;|\)))\S/) {
3398 if (ERROR("SPACING",
3399 "space required after that close brace '}'\n" . $herecurr) &&
3401 $fixed[$linenr - 1] =~
3402 s/}((?!(?:,|;|\)))\S)/} $1/;
3406 # check spacing on square brackets
3407 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
3408 if (ERROR("SPACING",
3409 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3411 $fixed[$linenr - 1] =~
3415 if ($line =~ /\s\]/) {
3416 if (ERROR("SPACING",
3417 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3419 $fixed[$linenr - 1] =~
3424 # check spacing on parentheses
3425 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3426 $line !~ /for\s*\(\s+;/) {
3427 if (ERROR("SPACING",
3428 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3430 $fixed[$linenr - 1] =~
3434 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
3435 $line !~ /for\s*\(.*;\s+\)/ &&
3436 $line !~ /:\s+\)/) {
3437 if (ERROR("SPACING",
3438 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3440 $fixed[$linenr - 1] =~
3445 #goto labels aren't indented, allow a single space however
3446 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
3447 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
3448 if (WARN("INDENTED_LABEL",
3449 "labels should not be indented\n" . $herecurr) &&
3451 $fixed[$linenr - 1] =~
3456 # return is not a function
3457 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
3459 if ($^V && $^V ge 5.10.0 &&
3460 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
3462 $value = deparenthesize($value);
3463 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
3464 ERROR("RETURN_PARENTHESES",
3465 "return is not a function, parentheses are not required\n" . $herecurr);
3467 } elsif ($spacing !~ /\s+/) {
3469 "space required before the open parenthesis '('\n" . $herecurr);
3473 # unnecessary return in a void function? (a single leading tab, then return;)
3474 if ($sline =~ /^\+\treturn\s*;\s*$/ &&
3475 $prevline =~ /^\+/) {
3477 "void function return statements are not generally useful\n" . $herecurr);
3480 # if statements using unnecessary parentheses - ie: if ((foo == bar))
3481 if ($^V && $^V ge 5.10.0 &&
3482 $line =~ /\bif\s*((?:\(\s*){2,})/) {
3483 my $openparens = $1;
3484 my $count = $openparens =~ tr@\(@\(@;
3486 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3487 my $comp = $4; #Not $1 because of $LvalOrFunc
3488 $msg = " - maybe == should be = ?" if ($comp eq "==");
3489 WARN("UNNECESSARY_PARENTHESES",
3490 "Unnecessary parentheses$msg\n" . $herecurr);
3494 # Return of what appears to be an errno should normally be -'ve
3495 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
3497 if ($name ne 'EOF' && $name ne 'ERROR') {
3498 WARN("USE_NEGATIVE_ERRNO",
3499 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
3503 # Need a space before open parenthesis after if, while etc
3504 if ($line =~ /\b(if|while|for|switch)\(/) {
3505 if (ERROR("SPACING",
3506 "space required before the open parenthesis '('\n" . $herecurr) &&
3508 $fixed[$linenr - 1] =~
3509 s/\b(if|while|for|switch)\(/$1 \(/;
3513 # Check for illegal assignment in if conditional -- and check for trailing
3514 # statements after the conditional.
3515 if ($line =~ /do\s*(?!{)/) {
3516 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3517 ctx_statement_block($linenr, $realcnt, 0)
3518 if (!defined $stat);
3519 my ($stat_next) = ctx_statement_block($line_nr_next,
3520 $remain_next, $off_next);
3521 $stat_next =~ s/\n./\n /g;
3522 ##print "stat<$stat> stat_next<$stat_next>\n";
3524 if ($stat_next =~ /^\s*while\b/) {
3525 # If the statement carries leading newlines,
3526 # then count those as offsets.
3528 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
3530 statement_rawlines($whitespace) - 1;
3532 $suppress_whiletrailers{$line_nr_next +
3536 if (!defined $suppress_whiletrailers{$linenr} &&
3537 defined($stat) && defined($cond) &&
3538 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
3539 my ($s, $c) = ($stat, $cond);
3541 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
3542 ERROR("ASSIGN_IN_IF",
3543 "do not use assignment in if condition\n" . $herecurr);
3546 # Find out what is on the end of the line after the
3548 substr($s, 0, length($c), '');
3550 $s =~ s/$;//g; # Remove any comments
3551 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
3552 $c !~ /}\s*while\s*/)
3554 # Find out how long the conditional actually is.
3555 my @newlines = ($c =~ /\n/gs);
3556 my $cond_lines = 1 + $#newlines;
3559 $stat_real = raw_line($linenr, $cond_lines)
3560 . "\n" if ($cond_lines);
3561 if (defined($stat_real) && $cond_lines > 1) {
3562 $stat_real = "[...]\n$stat_real";
3565 ERROR("TRAILING_STATEMENTS",
3566 "trailing statements should be on next line\n" . $herecurr . $stat_real);
3570 # Check for bitwise tests written as boolean
3582 WARN("HEXADECIMAL_BOOLEAN_TEST",
3583 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
3586 # if and else should not have general statements after it
3587 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
3589 $s =~ s/$;//g; # Remove any comments
3590 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
3591 ERROR("TRAILING_STATEMENTS",
3592 "trailing statements should be on next line\n" . $herecurr);
3595 # if should not continue a brace
3596 if ($line =~ /}\s*if\b/) {
3597 ERROR("TRAILING_STATEMENTS",
3598 "trailing statements should be on next line\n" .
3601 # case and default should not have general statements after them
3602 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
3604 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
3608 ERROR("TRAILING_STATEMENTS",
3609 "trailing statements should be on next line\n" . $herecurr);
3612 # Check for }<nl>else {, these must be at the same
3613 # indent level to be relevant to each other.
3614 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
3615 $previndent == $indent) {
3616 ERROR("ELSE_AFTER_BRACE",
3617 "else should follow close brace '}'\n" . $hereprev);
3620 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
3621 $previndent == $indent) {
3622 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
3624 # Find out what is on the end of the line after the
3626 substr($s, 0, length($c), '');
3629 if ($s =~ /^\s*;/) {
3630 ERROR("WHILE_AFTER_BRACE",
3631 "while should follow close brace '}'\n" . $hereprev);
3635 #Specific variable tests
3636 while ($line =~ m{($Constant|$Lval)}g) {
3639 #gcc binary extension
3640 if ($var =~ /^$Binary$/) {
3641 if (WARN("GCC_BINARY_CONSTANT",
3642 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
3644 my $hexval = sprintf("0x%x", oct($var));
3645 $fixed[$linenr - 1] =~
3646 s/\b$var\b/$hexval/;
3651 if ($var !~ /^$Constant$/ &&
3652 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
3653 #Ignore Page<foo> variants
3654 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
3655 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
3656 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) {
3657 while ($var =~ m{($Ident)}g) {
3659 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
3661 seed_camelcase_includes();
3662 if (!$file && !$camelcase_file_seeded) {
3663 seed_camelcase_file($realfile);
3664 $camelcase_file_seeded = 1;
3667 if (!defined $camelcase{$word}) {
3668 $camelcase{$word} = 1;
3670 "Avoid CamelCase: <$word>\n" . $herecurr);
3676 #no spaces allowed after \ in define
3677 if ($line =~ /\#\s*define.*\\\s+$/) {
3678 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
3679 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
3681 $fixed[$linenr - 1] =~ s/\s+$//;
3685 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
3686 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
3688 my $checkfile = "include/linux/$file";
3689 if (-f "$root/$checkfile" &&
3690 $realfile ne $checkfile &&
3691 $1 !~ /$allowed_asm_includes/)
3693 if ($realfile =~ m{^arch/}) {
3694 CHK("ARCH_INCLUDE_LINUX",
3695 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
3697 WARN("INCLUDE_LINUX",
3698 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
3703 # multi-statement macros should be enclosed in a do while loop, grab the
3704 # first statement and ensure its the whole macro if its not enclosed
3705 # in a known good container
3706 if ($realfile !~ m@/vmlinux.lds.h$@ &&
3707 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
3710 my ($off, $dstat, $dcond, $rest);
3712 ($dstat, $dcond, $ln, $cnt, $off) =
3713 ctx_statement_block($linenr, $realcnt, 0);
3715 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
3716 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
3718 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
3720 $dstat =~ s/\\\n.//g;
3721 $dstat =~ s/^\s*//s;
3722 $dstat =~ s/\s*$//s;
3724 # Flatten any parentheses and braces
3725 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
3726 $dstat =~ s/\{[^\{\}]*\}/1/ ||
3727 $dstat =~ s/\[[^\[\]]*\]/1/)
3731 # Flatten any obvious string concatentation.
3732 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
3733 $dstat =~ s/$Ident\s*("X*")/$1/)
3737 my $exceptions = qr{
3749 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
3751 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
3752 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
3753 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
3754 $dstat !~ /^'X'$/ && # character constants
3755 $dstat !~ /$exceptions/ &&
3756 $dstat !~ /^\.$Ident\s*=/ && # .foo =
3757 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
3758 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
3759 $dstat !~ /^for\s*$Constant$/ && # for (...)
3760 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
3761 $dstat !~ /^do\s*{/ && # do {...
3762 $dstat !~ /^\({/ && # ({...
3763 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
3766 my $herectx = $here . "\n";
3767 my $cnt = statement_rawlines($ctx);
3769 for (my $n = 0; $n < $cnt; $n++) {
3770 $herectx .= raw_line($linenr, $n) . "\n";
3773 if ($dstat =~ /;/) {
3774 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
3775 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
3777 ERROR("COMPLEX_MACRO",
3778 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
3782 # check for line continuations outside of #defines, preprocessor #, and asm
3785 if ($prevline !~ /^..*\\$/ &&
3786 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
3787 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
3788 $line =~ /^\+.*\\$/) {
3789 WARN("LINE_CONTINUATIONS",
3790 "Avoid unnecessary line continuations\n" . $herecurr);
3794 # do {} while (0) macro tests:
3795 # single-statement macros do not need to be enclosed in do while (0) loop,
3796 # macro should not end with a semicolon
3797 if ($^V && $^V ge 5.10.0 &&
3798 $realfile !~ m@/vmlinux.lds.h$@ &&
3799 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
3802 my ($off, $dstat, $dcond, $rest);
3804 ($dstat, $dcond, $ln, $cnt, $off) =
3805 ctx_statement_block($linenr, $realcnt, 0);
3808 $dstat =~ s/\\\n.//g;
3810 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
3815 my $cnt = statement_rawlines($ctx);
3816 my $herectx = $here . "\n";
3818 for (my $n = 0; $n < $cnt; $n++) {
3819 $herectx .= raw_line($linenr, $n) . "\n";
3822 if (($stmts =~ tr/;/;/) == 1 &&
3823 $stmts !~ /^\s*(if|while|for|switch)\b/) {
3824 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
3825 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
3827 if (defined $semis && $semis ne "") {
3828 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
3829 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
3831 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
3833 my $cnt = statement_rawlines($ctx);
3834 my $herectx = $here . "\n";
3836 for (my $n = 0; $n < $cnt; $n++) {
3837 $herectx .= raw_line($linenr, $n) . "\n";
3840 WARN("TRAILING_SEMICOLON",
3841 "macros should not use a trailing semicolon\n" . "$herectx");
3845 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3846 # all assignments may have only one of the following with an assignment:
3849 # VMLINUX_SYMBOL(...)
3850 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
3851 WARN("MISSING_VMLINUX_SYMBOL",
3852 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
3855 # check for redundant bracing round if etc
3856 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
3857 my ($level, $endln, @chunks) =
3858 ctx_statement_full($linenr, $realcnt, 1);
3859 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
3860 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3861 if ($#chunks > 0 && $level == 0) {
3865 my $herectx = $here . "\n";
3866 my $ln = $linenr - 1;
3867 for my $chunk (@chunks) {
3868 my ($cond, $block) = @{$chunk};
3870 # If the condition carries leading newlines, then count those as offsets.
3871 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
3872 my $offset = statement_rawlines($whitespace) - 1;
3874 $allowed[$allow] = 0;
3875 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3877 # We have looked at and allowed this specific line.
3878 $suppress_ifbraces{$ln + $offset} = 1;
3880 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
3881 $ln += statement_rawlines($block) - 1;
3883 substr($block, 0, length($cond), '');
3885 $seen++ if ($block =~ /^\s*{/);
3887 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
3888 if (statement_lines($cond) > 1) {
3889 #print "APW: ALLOWED: cond<$cond>\n";
3890 $allowed[$allow] = 1;
3892 if ($block =~/\b(?:if|for|while)\b/) {
3893 #print "APW: ALLOWED: block<$block>\n";
3894 $allowed[$allow] = 1;
3896 if (statement_block_size($block) > 1) {
3897 #print "APW: ALLOWED: lines block<$block>\n";
3898 $allowed[$allow] = 1;
3903 my $sum_allowed = 0;
3904 foreach (@allowed) {
3907 if ($sum_allowed == 0) {
3909 "braces {} are not necessary for any arm of this statement\n" . $herectx);
3910 } elsif ($sum_allowed != $allow &&
3913 "braces {} should be used on all arms of this statement\n" . $herectx);
3918 if (!defined $suppress_ifbraces{$linenr - 1} &&
3919 $line =~ /\b(if|while|for|else)\b/) {
3922 # Check the pre-context.
3923 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
3924 #print "APW: ALLOWED: pre<$1>\n";
3928 my ($level, $endln, @chunks) =
3929 ctx_statement_full($linenr, $realcnt, $-[0]);
3931 # Check the condition.
3932 my ($cond, $block) = @{$chunks[0]};
3933 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
3934 if (defined $cond) {
3935 substr($block, 0, length($cond), '');
3937 if (statement_lines($cond) > 1) {
3938 #print "APW: ALLOWED: cond<$cond>\n";
3941 if ($block =~/\b(?:if|for|while)\b/) {
3942 #print "APW: ALLOWED: block<$block>\n";
3945 if (statement_block_size($block) > 1) {
3946 #print "APW: ALLOWED: lines block<$block>\n";
3949 # Check the post-context.
3950 if (defined $chunks[1]) {
3951 my ($cond, $block) = @{$chunks[1]};
3952 if (defined $cond) {
3953 substr($block, 0, length($cond), '');
3955 if ($block =~ /^\s*\{/) {
3956 #print "APW: ALLOWED: chunk-1 block<$block>\n";
3960 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
3961 my $herectx = $here . "\n";
3962 my $cnt = statement_rawlines($block);
3964 for (my $n = 0; $n < $cnt; $n++) {
3965 $herectx .= raw_line($linenr, $n) . "\n";
3969 "braces {} are not necessary for single statement blocks\n" . $herectx);
3973 # check for unnecessary blank lines around braces
3974 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
3976 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
3978 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
3980 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
3983 # no volatiles please
3984 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
3985 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
3987 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
3991 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
3992 CHK("REDUNDANT_CODE",
3993 "if this code is redundant consider removing it\n" .
3997 # check for needless "if (<foo>) fn(<foo>)" uses
3998 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
3999 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
4000 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
4002 "$1(NULL) is safe this check is probably not required\n" . $hereprev);
4006 # check for bad placement of section $InitAttribute (e.g.: __initdata)
4007 if ($line =~ /(\b$InitAttribute\b)/) {
4009 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
4012 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
4013 ERROR("MISPLACED_INIT",
4014 "$attr should be placed after $var\n" . $herecurr)) ||
4015 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
4016 WARN("MISPLACED_INIT",
4017 "$attr should be placed after $var\n" . $herecurr))) &&
4019 $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;
4024 # check for $InitAttributeData (ie: __initdata) with const
4025 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
4027 $attr =~ /($InitAttributePrefix)(.*)/;
4028 my $attr_prefix = $1;
4030 if (ERROR("INIT_ATTRIBUTE",
4031 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
4033 $fixed[$linenr - 1] =~
4034 s/$InitAttributeData/${attr_prefix}initconst/;
4038 # check for $InitAttributeConst (ie: __initconst) without const
4039 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
4041 if (ERROR("INIT_ATTRIBUTE",
4042 "Use of $attr requires a separate use of const\n" . $herecurr) &&
4044 my $lead = $fixed[$linenr - 1] =~
4045 /(^\+\s*(?:static\s+))/;
4047 $lead = "$lead " if ($lead !~ /^\+$/);
4048 $lead = "${lead}const ";
4049 $fixed[$linenr - 1] =~ s/(^\+\s*(?:static\s+))/$lead/;
4053 # don't use __constant_<foo> functions outside of include/uapi/
4054 if ($realfile !~ m@^include/uapi/@ &&
4055 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
4056 my $constant_func = $1;
4057 my $func = $constant_func;
4058 $func =~ s/^__constant_//;
4059 if (WARN("CONSTANT_CONVERSION",
4060 "$constant_func should be $func\n" . $herecurr) &&
4062 $fixed[$linenr - 1] =~ s/\b$constant_func\b/$func/g;
4066 # prefer usleep_range over udelay
4067 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
4069 # ignore udelay's < 10, however
4070 if (! ($delay < 10) ) {
4072 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4074 if ($delay > 2000) {
4076 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
4080 # warn about unexpectedly long msleep's
4081 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
4084 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4088 # check for comparisons of jiffies
4089 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
4090 WARN("JIFFIES_COMPARISON",
4091 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4094 # check for comparisons of get_jiffies_64()
4095 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
4096 WARN("JIFFIES_COMPARISON",
4097 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4100 # warn about #ifdefs in C files
4101 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
4102 # print "#ifdef in C files should be avoided\n";
4103 # print "$herecurr";
4107 # warn about spacing in #ifdefs
4108 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
4109 if (ERROR("SPACING",
4110 "exactly one space required after that #$1\n" . $herecurr) &&
4112 $fixed[$linenr - 1] =~
4113 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
4118 # check for spinlock_t definitions without a comment.
4119 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
4120 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
4122 if (!ctx_has_comment($first_line, $linenr)) {
4123 CHK("UNCOMMENTED_DEFINITION",
4124 "$1 definition without comment\n" . $herecurr);
4127 # check for memory barriers without a comment.
4128 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4129 if (!ctx_has_comment($first_line, $linenr)) {
4130 WARN("MEMORY_BARRIER",
4131 "memory barrier without comment\n" . $herecurr);
4134 # check of hardware specific defines
4135 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
4137 "architecture specific defines should be avoided\n" . $herecurr);
4140 # Check that the storage class is at the beginning of a declaration
4141 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
4142 WARN("STORAGE_CLASS",
4143 "storage class should be at the beginning of the declaration\n" . $herecurr)
4146 # check the location of the inline attribute, that it is between
4147 # storage class and type.
4148 if ($line =~ /\b$Type\s+$Inline\b/ ||
4149 $line =~ /\b$Inline\s+$Storage\b/) {
4150 ERROR("INLINE_LOCATION",
4151 "inline keyword should sit between storage class and type\n" . $herecurr);
4154 # Check for __inline__ and __inline, prefer inline
4155 if ($realfile !~ m@\binclude/uapi/@ &&
4156 $line =~ /\b(__inline__|__inline)\b/) {
4158 "plain inline is preferred over $1\n" . $herecurr) &&
4160 $fixed[$linenr - 1] =~ s/\b(__inline__|__inline)\b/inline/;
4165 # Check for __attribute__ packed, prefer __packed
4166 if ($realfile !~ m@\binclude/uapi/@ &&
4167 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
4168 WARN("PREFER_PACKED",
4169 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
4172 # Check for __attribute__ aligned, prefer __aligned
4173 if ($realfile !~ m@\binclude/uapi/@ &&
4174 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
4175 WARN("PREFER_ALIGNED",
4176 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
4179 # Check for __attribute__ format(printf, prefer __printf
4180 if ($realfile !~ m@\binclude/uapi/@ &&
4181 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
4182 if (WARN("PREFER_PRINTF",
4183 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4185 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
4190 # Check for __attribute__ format(scanf, prefer __scanf
4191 if ($realfile !~ m@\binclude/uapi/@ &&
4192 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
4193 if (WARN("PREFER_SCANF",
4194 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4196 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
4200 # check for sizeof(&)
4201 if ($line =~ /\bsizeof\s*\(\s*\&/) {
4202 WARN("SIZEOF_ADDRESS",
4203 "sizeof(& should be avoided\n" . $herecurr);
4206 # check for sizeof without parenthesis
4207 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
4208 if (WARN("SIZEOF_PARENTHESIS",
4209 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
4211 $fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
4215 # check for line continuations in quoted strings with odd counts of "
4216 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
4217 WARN("LINE_CONTINUATIONS",
4218 "Avoid line continuations in quoted strings\n" . $herecurr);
4221 # check for struct spinlock declarations
4222 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
4223 WARN("USE_SPINLOCK_T",
4224 "struct spinlock should be spinlock_t\n" . $herecurr);
4227 # check for seq_printf uses that could be seq_puts
4228 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
4229 my $fmt = get_quoted_string($line, $rawline);
4230 if ($fmt ne "" && $fmt !~ /[^\\]\%/) {
4231 if (WARN("PREFER_SEQ_PUTS",
4232 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
4234 $fixed[$linenr - 1] =~ s/\bseq_printf\b/seq_puts/;
4239 # Check for misused memsets
4240 if ($^V && $^V ge 5.10.0 &&
4242 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
4248 if ($ms_size =~ /^(0x|)0$/i) {
4250 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
4251 } elsif ($ms_size =~ /^(0x|)1$/i) {
4253 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
4257 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
4258 if ($^V && $^V ge 5.10.0 &&
4259 $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) {
4260 if (WARN("PREFER_ETHER_ADDR_COPY",
4261 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
4263 $fixed[$linenr - 1] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
4267 # typecasts on min/max could be min_t/max_t
4268 if ($^V && $^V ge 5.10.0 &&
4270 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
4271 if (defined $2 || defined $7) {
4273 my $cast1 = deparenthesize($2);
4275 my $cast2 = deparenthesize($7);
4279 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
4280 $cast = "$cast1 or $cast2";
4281 } elsif ($cast1 ne "") {
4287 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
4291 # check usleep_range arguments
4292 if ($^V && $^V ge 5.10.0 &&
4294 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
4298 WARN("USLEEP_RANGE",
4299 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4300 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
4302 WARN("USLEEP_RANGE",
4303 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4307 # check for naked sscanf
4308 if ($^V && $^V ge 5.10.0 &&
4310 $line =~ /\bsscanf\b/ &&
4311 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
4312 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
4313 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
4314 my $lc = $stat =~ tr@\n@@;
4315 $lc = $lc + $linenr;
4316 my $stat_real = raw_line($linenr, 0);
4317 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4318 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4320 WARN("NAKED_SSCANF",
4321 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
4324 # check for simple sscanf that should be kstrto<foo>
4325 if ($^V && $^V ge 5.10.0 &&
4327 $line =~ /\bsscanf\b/) {
4328 my $lc = $stat =~ tr@\n@@;
4329 $lc = $lc + $linenr;
4330 my $stat_real = raw_line($linenr, 0);
4331 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4332 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4334 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
4336 my $count = $format =~ tr@%@%@;
4338 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
4339 WARN("SSCANF_TO_KSTRTO",
4340 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
4345 # check for new externs in .h files.
4346 if ($realfile =~ /\.h$/ &&
4347 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
4348 if (CHK("AVOID_EXTERNS",
4349 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
4351 $fixed[$linenr - 1] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
4355 # check for new externs in .c files.
4356 if ($realfile =~ /\.c$/ && defined $stat &&
4357 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
4359 my $function_name = $1;
4360 my $paren_space = $2;
4363 if (defined $cond) {
4364 substr($s, 0, length($cond), '');
4366 if ($s =~ /^\s*;/ &&
4367 $function_name ne 'uninitialized_var')
4369 WARN("AVOID_EXTERNS",
4370 "externs should be avoided in .c files\n" . $herecurr);
4373 if ($paren_space =~ /\n/) {
4374 WARN("FUNCTION_ARGUMENTS",
4375 "arguments for function declarations should follow identifier\n" . $herecurr);
4378 } elsif ($realfile =~ /\.c$/ && defined $stat &&
4379 $stat =~ /^.\s*extern\s+/)
4381 WARN("AVOID_EXTERNS",
4382 "externs should be avoided in .c files\n" . $herecurr);
4385 # checks for new __setup's
4386 if ($rawline =~ /\b__setup\("([^"]*)"/) {
4389 if (!grep(/$name/, @setup_docs)) {
4390 CHK("UNDOCUMENTED_SETUP",
4391 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
4395 # check for pointless casting of kmalloc return
4396 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
4397 WARN("UNNECESSARY_CASTS",
4398 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
4402 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
4403 if ($^V && $^V ge 5.10.0 &&
4404 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
4405 CHK("ALLOC_SIZEOF_STRUCT",
4406 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
4409 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
4410 if ($^V && $^V ge 5.10.0 &&
4411 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)/) {
4415 my $newfunc = "kmalloc_array";
4416 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
4417 if ($a1 =~ /^sizeof\s*\S/ || $a2 =~ /^sizeof\s*\S/) {
4418 if (WARN("ALLOC_WITH_MULTIPLY",
4419 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
4423 if ($a1 =~ /^sizeof\s*\S/) {
4427 $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;
4433 # check for krealloc arg reuse
4434 if ($^V && $^V ge 5.10.0 &&
4435 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
4436 WARN("KREALLOC_ARG_REUSE",
4437 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
4440 # check for alloc argument mismatch
4441 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
4442 WARN("ALLOC_ARRAY_ARGS",
4443 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
4446 # check for multiple semicolons
4447 if ($line =~ /;\s*;\s*$/) {
4448 if (WARN("ONE_SEMICOLON",
4449 "Statements terminations use 1 semicolon\n" . $herecurr) &&
4451 $fixed[$linenr - 1] =~ s/(\s*;\s*){2,}$/;/g;
4455 # check for case / default statements not preceeded by break/fallthrough/switch
4456 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
4458 my $has_statement = 0;
4460 my $prevline = $linenr;
4461 while ($prevline > 1 && $count < 3 && !$has_break) {
4463 my $rline = $rawlines[$prevline - 1];
4464 my $fline = $lines[$prevline - 1];
4465 last if ($fline =~ /^\@\@/);
4466 next if ($fline =~ /^\-/);
4467 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
4468 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
4469 next if ($fline =~ /^.[\s$;]*$/);
4472 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
4474 if (!$has_break && $has_statement) {
4475 WARN("MISSING_BREAK",
4476 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
4480 # check for switch/default statements without a break;
4481 if ($^V && $^V ge 5.10.0 &&
4483 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
4485 my $herectx = $here . "\n";
4486 my $cnt = statement_rawlines($stat);
4487 for (my $n = 0; $n < $cnt; $n++) {
4488 $herectx .= raw_line($linenr, $n) . "\n";
4490 WARN("DEFAULT_NO_BREAK",
4491 "switch default: should use break\n" . $herectx);
4494 # check for gcc specific __FUNCTION__
4495 if ($line =~ /\b__FUNCTION__\b/) {
4496 if (WARN("USE_FUNC",
4497 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
4499 $fixed[$linenr - 1] =~ s/\b__FUNCTION__\b/__func__/g;
4503 # check for use of yield()
4504 if ($line =~ /\byield\s*\(\s*\)/) {
4506 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
4509 # check for comparisons against true and false
4510 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
4518 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
4520 my $type = lc($otype);
4521 if ($type =~ /^(?:true|false)$/) {
4522 if (("$test" eq "==" && "$type" eq "true") ||
4523 ("$test" eq "!=" && "$type" eq "false")) {
4527 CHK("BOOL_COMPARISON",
4528 "Using comparison to $otype is error prone\n" . $herecurr);
4530 ## maybe suggesting a correct construct would better
4531 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
4536 # check for semaphores initialized locked
4537 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
4538 WARN("CONSIDER_COMPLETION",
4539 "consider using a completion\n" . $herecurr);
4542 # recommend kstrto* over simple_strto* and strict_strto*
4543 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
4544 WARN("CONSIDER_KSTRTO",
4545 "$1 is obsolete, use k$3 instead\n" . $herecurr);
4548 # check for __initcall(), use device_initcall() explicitly please
4549 if ($line =~ /^.\s*__initcall\s*\(/) {
4550 WARN("USE_DEVICE_INITCALL",
4551 "please use device_initcall() instead of __initcall()\n" . $herecurr);
4554 # check for various ops structs, ensure they are const.
4555 my $struct_ops = qr{acpi_dock_ops|
4556 address_space_operations|
4558 block_device_operations|
4563 file_lock_operations|
4573 lock_manager_operations|
4579 pipe_buf_operations|
4580 platform_hibernation_ops|
4581 platform_suspend_ops|
4586 soc_pcmcia_socket_ops|
4592 if ($line !~ /\bconst\b/ &&
4593 $line =~ /\bstruct\s+($struct_ops)\b/) {
4594 WARN("CONST_STRUCT",
4595 "struct $1 should normally be const\n" .
4599 # use of NR_CPUS is usually wrong
4600 # ignore definitions of NR_CPUS and usage to define arrays as likely right
4601 if ($line =~ /\bNR_CPUS\b/ &&
4602 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
4603 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
4604 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
4605 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
4606 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
4609 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
4612 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
4613 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
4614 ERROR("DEFINE_ARCH_HAS",
4615 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
4618 # check for %L{u,d,i} in strings
4620 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4621 $string = substr($rawline, $-[1], $+[1] - $-[1]);
4622 $string =~ s/%%/__/g;
4623 if ($string =~ /(?<!%)%L[udi]/) {
4625 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
4630 # whine mightly about in_atomic
4631 if ($line =~ /\bin_atomic\s*\(/) {
4632 if ($realfile =~ m@^drivers/@) {
4634 "do not use in_atomic in drivers\n" . $herecurr);
4635 } elsif ($realfile !~ m@^kernel/@) {
4637 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
4641 # check for lockdep_set_novalidate_class
4642 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
4643 $line =~ /__lockdep_no_validate__\s*\)/ ) {
4644 if ($realfile !~ m@^kernel/lockdep@ &&
4645 $realfile !~ m@^include/linux/lockdep@ &&
4646 $realfile !~ m@^drivers/base/core@) {
4648 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
4652 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
4653 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
4654 WARN("EXPORTED_WORLD_WRITABLE",
4655 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
4658 # Mode permission misuses where it seems decimal should be octal
4659 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
4660 if ($^V && $^V ge 5.10.0 &&
4661 $line =~ /$mode_perms_search/) {
4662 foreach my $entry (@mode_permission_funcs) {
4663 my $func = $entry->[0];
4664 my $arg_pos = $entry->[1];
4669 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
4671 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
4672 if ($line =~ /$test/) {
4674 $val = $6 if ($skip_args ne "");
4676 if ($val !~ /^0$/ &&
4677 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
4678 length($val) ne 4)) {
4679 ERROR("NON_OCTAL_PERMISSIONS",
4680 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
4687 # If we have no input at all, then there is nothing to report on
4688 # so just keep quiet.
4689 if ($#rawlines == -1) {
4693 # In mailback mode only produce a report in the negative, for
4694 # things that appear to be patches.
4695 if ($mailback && ($clean == 1 || !$is_patch)) {
4699 # This is not a patch, and we are are in 'no-patch' mode so
4701 if (!$chk_patch && !$is_patch) {
4706 ERROR("NOT_UNIFIED_DIFF",
4707 "Does not appear to be a unified-diff format patch\n");
4709 if ($is_patch && $chk_signoff && $signoff == 0) {
4710 ERROR("MISSING_SIGN_OFF",
4711 "Missing Signed-off-by: line(s)\n");
4714 print report_dump();
4715 if ($summary && !($clean == 1 && $quiet == 1)) {
4716 print "$filename " if ($summary_file);
4717 print "total: $cnt_error errors, $cnt_warn warnings, " .
4718 (($check)? "$cnt_chk checks, " : "") .
4719 "$cnt_lines lines checked\n";
4720 print "\n" if ($quiet == 0);
4725 if ($^V lt 5.10.0) {
4726 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
4727 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
4730 # If there were whitespace errors which cleanpatch can fix
4731 # then suggest that.
4732 if ($rpt_cleaners) {
4733 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
4734 print " scripts/cleanfile\n\n";
4739 hash_show_words(\%use_type, "Used");
4740 hash_show_words(\%ignore_type, "Ignored");
4742 if ($clean == 0 && $fix && "@rawlines" ne "@fixed") {
4743 my $newfile = $filename;
4744 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
4748 open($f, '>', $newfile)
4749 or die "$P: Can't open $newfile for write\n";
4750 foreach my $fixed_line (@fixed) {
4753 if ($linecount > 3) {
4754 $fixed_line =~ s/^\+//;
4755 print $f $fixed_line. "\n";
4758 print $f $fixed_line . "\n";
4765 Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
4767 Do _NOT_ trust the results written to this file.
4768 Do _NOT_ submit these changes without inspecting them for correctness.
4770 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
4771 No warranties, expressed or implied...
4777 if ($clean == 1 && $quiet == 0) {
4778 print "$vname has no obvious style problems and is ready for submission.\n"
4780 if ($clean == 0 && $quiet == 0) {
4782 $vname has style problems, please review.
4784 If any of these errors are false positives, please report
4785 them to the maintainer, see CHECKPATCH in MAINTAINERS.