2 # SPDX-License-Identifier: GPL-2.0
4 # (c) 2001, Dave Jones. (the file handling bit)
5 # (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
6 # (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
7 # (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
8 # (c) 2010-2018 Joe Perches <joe@perches.com>
15 use Term::ANSIColor qw(:constants);
16 use Encode qw(decode encode);
19 my $D = dirname(abs_path($P));
23 use Getopt::Long qw(:config no_auto_abbrev);
53 my $configuration_file = ".checkpatch.conf";
54 my $max_line_length = 80;
55 my $ignore_perl_version = 0;
56 my $minimum_perl_version = 5.10.0;
57 my $min_conf_desc_length = 4;
58 my $spelling_file = "$D/spelling.txt";
60 my $codespellfile = "/usr/share/codespell/dictionary.txt";
61 my $conststructsfile = "$D/const_structs.checkpatch";
62 my $typedefsfile = "";
64 my $allow_c99_comments = 1;
70 Usage: $P [OPTION]... [FILE]...
75 --no-tree run without a kernel tree
76 --no-signoff do not check for 'Signed-off-by' line
77 --patch treat FILE as patchfile (default)
78 --emacs emacs compile window format
79 --terse one line per report
80 --showfile emit diffed file position, not input file position
81 -g, --git treat FILE as a single commit or git revision range
82 single git commit with:
86 multiple git commits with:
90 git merges are ignored
91 -f, --file treat FILE as regular source file
92 --subjective, --strict enable more subjective tests
93 --list-types list the possible message types
94 --types TYPE(,TYPE2...) show only these comma separated message types
95 --ignore TYPE(,TYPE2...) ignore various comma separated message types
96 --show-types show the specific message type in the output
97 --max-line-length=n set the maximum line length, if exceeded, warn
98 --min-conf-desc-length=n set the min description length, if shorter, warn
99 --root=PATH PATH to the kernel tree root
100 --no-summary suppress the per-file summary
101 --mailback only produce a report in case of warnings/errors
102 --summary-file include the filename in summary
103 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
104 'values', 'possible', 'type', and 'attr' (default
106 --test-only=WORD report only warnings/errors containing WORD
108 --fix EXPERIMENTAL - may create horrible results
109 If correctable single-line errors exist, create
110 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
111 with potential errors corrected to the preferred
113 --fix-inplace EXPERIMENTAL - may create horrible results
114 Is the same as --fix, but overwrites the input
115 file. It's your fault if there's no backup or git
116 --ignore-perl-version override checking of perl version. expect
118 --codespell Use the codespell dictionary for spelling/typos
119 (default:/usr/share/codespell/dictionary.txt)
120 --codespellfile Use this codespell dictionary
121 --typedefsfile Read additional types from this file
122 --color[=WHEN] Use colors 'always', 'never', or only when output
123 is a terminal ('auto'). Default is 'auto'.
124 -h, --help, --version display this help and exit
126 When FILE is - read standard input.
134 return grep { !$seen{$_}++ } @_;
144 open(my $script, '<', abs_path($P)) or
145 die "$P: Can't read '$P' $!\n";
147 my $text = <$script>;
151 # Also catch when type or level is passed through a variable
152 for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
155 @types = sort(uniq(@types));
156 print("#\tMessage type\n\n");
157 foreach my $type (@types) {
158 print(++$count . "\t" . $type . "\n");
164 my $conf = which_conf($configuration_file);
167 open(my $conffile, '<', "$conf")
168 or warn "$P: Can't find a readable $configuration_file file $!\n";
170 while (<$conffile>) {
173 $line =~ s/\s*\n?$//g;
177 next if ($line =~ m/^\s*#/);
178 next if ($line =~ m/^\s*$/);
180 my @words = split(" ", $line);
181 foreach my $word (@words) {
182 last if ($word =~ m/^#/);
183 push (@conf_args, $word);
187 unshift(@ARGV, @conf_args) if @conf_args;
190 # Perl's Getopt::Long allows options to take optional arguments after a space.
191 # Prevent --color by itself from consuming other arguments
193 if ($_ eq "--color" || $_ eq "-color") {
194 $_ = "--color=$color";
199 'q|quiet+' => \$quiet,
201 'signoff!' => \$chk_signoff,
202 'patch!' => \$chk_patch,
205 'showfile!' => \$showfile,
208 'subjective!' => \$check,
209 'strict!' => \$check,
210 'ignore=s' => \@ignore,
212 'show-types!' => \$show_types,
213 'list-types!' => \$list_types,
214 'max-line-length=i' => \$max_line_length,
215 'min-conf-desc-length=i' => \$min_conf_desc_length,
217 'summary!' => \$summary,
218 'mailback!' => \$mailback,
219 'summary-file!' => \$summary_file,
221 'fix-inplace!' => \$fix_inplace,
222 'ignore-perl-version!' => \$ignore_perl_version,
223 'debug=s' => \%debug,
224 'test-only=s' => \$tst_only,
225 'codespell!' => \$codespell,
226 'codespellfile=s' => \$codespellfile,
227 'typedefsfile=s' => \$typedefsfile,
228 'color=s' => \$color,
229 'no-color' => \$color, #keep old behaviors of -nocolor
230 'nocolor' => \$color, #keep old behaviors of -nocolor
237 list_types(0) if ($list_types);
239 $fix = 1 if ($fix_inplace);
240 $check_orig = $check;
244 my $perl_version_ok = 1;
245 if ($^V && $^V lt $minimum_perl_version) {
246 $perl_version_ok = 0;
247 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
248 exit(1) if (!$ignore_perl_version);
251 #if no filenames are given, push '-' to read patch from stdin
256 if ($color =~ /^[01]$/) {
258 } elsif ($color =~ /^always$/i) {
260 } elsif ($color =~ /^never$/i) {
262 } elsif ($color =~ /^auto$/i) {
263 $color = (-t STDOUT);
265 die "Invalid color mode: $color\n";
268 sub hash_save_array_words {
269 my ($hashRef, $arrayRef) = @_;
271 my @array = split(/,/, join(',', @$arrayRef));
272 foreach my $word (@array) {
273 $word =~ s/\s*\n?$//g;
276 $word =~ tr/[a-z]/[A-Z]/;
278 next if ($word =~ m/^\s*#/);
279 next if ($word =~ m/^\s*$/);
285 sub hash_show_words {
286 my ($hashRef, $prefix) = @_;
288 if (keys %$hashRef) {
289 print "\nNOTE: $prefix message types:";
290 foreach my $word (sort keys %$hashRef) {
297 hash_save_array_words(\%ignore_type, \@ignore);
298 hash_save_array_words(\%use_type, \@use);
301 my $dbg_possible = 0;
304 for my $key (keys %debug) {
306 eval "\${dbg_$key} = '$debug{$key}';";
310 my $rpt_cleaners = 0;
319 if (!top_of_kernel_tree($root)) {
320 die "$P: $root: --root does not point at a valid tree\n";
323 if (top_of_kernel_tree('.')) {
325 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
326 top_of_kernel_tree($1)) {
331 if (!defined $root) {
332 print "Must be run from the top-level dir. of a kernel tree\n";
337 my $emitted_corrupt = 0;
340 [A-Za-z_][A-Za-z\d_]*
341 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
343 our $Storage = qr{extern|static|asmlinkage};
357 our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
358 our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
359 our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
360 our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
361 our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
363 # Notes to $Attribute:
364 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
385 ____cacheline_aligned|
386 ____cacheline_aligned_in_smp|
387 ____cacheline_internodealigned_in_smp|
391 our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
392 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
393 our $Lval = qr{$Ident(?:$Member)*};
395 our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
396 our $Binary = qr{(?i)0b[01]+$Int_type?};
397 our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
398 our $Int = qr{[0-9]+$Int_type?};
399 our $Octal = qr{0[0-7]+$Int_type?};
400 our $String = qr{"[X\t]*"};
401 our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
402 our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
403 our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
404 our $Float = qr{$Float_hex|$Float_dec|$Float_int};
405 our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
406 our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
407 our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
408 our $Arithmetic = qr{\+|-|\*|\/|%};
412 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
415 our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
419 our $NonptrTypeMisordered;
420 our $NonptrTypeWithAttr;
424 our $DeclareMisordered;
426 our $NON_ASCII_UTF8 = qr{
427 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
428 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
429 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
430 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
431 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
432 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
433 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
437 [\x09\x0A\x0D\x20-\x7E] # ASCII
441 our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
442 our $typeOtherOSTypedefs = qr{(?x:
443 u_(?:char|short|int|long) | # bsd
444 u(?:nchar|short|int|long) # sysv
446 our $typeKernelTypedefs = qr{(?x:
447 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
450 our $typeTypedefs = qr{(?x:
452 $typeOtherOSTypedefs\b|
453 $typeKernelTypedefs\b
456 our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
458 our $logFunctions = qr{(?x:
459 printk(?:_ratelimited|_once|_deferred_once|_deferred|)|
460 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
462 WARN(?:_RATELIMIT|_ONCE|)|
465 seq_vprintf|seq_printf|seq_puts
468 our $signature_tags = qr{(?xi:
479 our @typeListMisordered = (
480 qr{char\s+(?:un)?signed},
481 qr{int\s+(?:(?:un)?signed\s+)?short\s},
482 qr{int\s+short(?:\s+(?:un)?signed)},
483 qr{short\s+int(?:\s+(?:un)?signed)},
484 qr{(?:un)?signed\s+int\s+short},
485 qr{short\s+(?:un)?signed},
486 qr{long\s+int\s+(?:un)?signed},
487 qr{int\s+long\s+(?:un)?signed},
488 qr{long\s+(?:un)?signed\s+int},
489 qr{int\s+(?:un)?signed\s+long},
490 qr{int\s+(?:un)?signed},
491 qr{int\s+long\s+long\s+(?:un)?signed},
492 qr{long\s+long\s+int\s+(?:un)?signed},
493 qr{long\s+long\s+(?:un)?signed\s+int},
494 qr{long\s+long\s+(?:un)?signed},
495 qr{long\s+(?:un)?signed},
500 qr{(?:(?:un)?signed\s+)?char},
501 qr{(?:(?:un)?signed\s+)?short\s+int},
502 qr{(?:(?:un)?signed\s+)?short},
503 qr{(?:(?:un)?signed\s+)?int},
504 qr{(?:(?:un)?signed\s+)?long\s+int},
505 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
506 qr{(?:(?:un)?signed\s+)?long\s+long},
507 qr{(?:(?:un)?signed\s+)?long},
516 qr{${Ident}_handler},
517 qr{${Ident}_handler_fn},
521 our $C90_int_types = qr{(?x:
522 long\s+long\s+int\s+(?:un)?signed|
523 long\s+long\s+(?:un)?signed\s+int|
524 long\s+long\s+(?:un)?signed|
525 (?:(?:un)?signed\s+)?long\s+long\s+int|
526 (?:(?:un)?signed\s+)?long\s+long|
527 int\s+long\s+long\s+(?:un)?signed|
528 int\s+(?:(?:un)?signed\s+)?long\s+long|
530 long\s+int\s+(?:un)?signed|
531 long\s+(?:un)?signed\s+int|
532 long\s+(?:un)?signed|
533 (?:(?:un)?signed\s+)?long\s+int|
534 (?:(?:un)?signed\s+)?long|
535 int\s+long\s+(?:un)?signed|
536 int\s+(?:(?:un)?signed\s+)?long|
539 (?:(?:un)?signed\s+)?int
542 our @typeListFile = ();
543 our @typeListWithAttr = (
545 qr{struct\s+$InitAttribute\s+$Ident},
546 qr{union\s+$InitAttribute\s+$Ident},
549 our @modifierList = (
552 our @modifierListFile = ();
554 our @mode_permission_funcs = (
556 ["module_param_(?:array|named|string)", 4],
557 ["module_param_array_named", 5],
558 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
559 ["proc_create(?:_data|)", 2],
560 ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2],
561 ["IIO_DEV_ATTR_[A-Z_]+", 1],
562 ["SENSOR_(?:DEVICE_|)ATTR_2", 2],
563 ["SENSOR_TEMPLATE(?:_2|)", 3],
567 #Create a search pattern for all these functions to speed up a loop below
568 our $mode_perms_search = "";
569 foreach my $entry (@mode_permission_funcs) {
570 $mode_perms_search .= '|' if ($mode_perms_search ne "");
571 $mode_perms_search .= $entry->[0];
573 $mode_perms_search = "(?:${mode_perms_search})";
575 our $mode_perms_world_writable = qr{
583 our %mode_permission_string_types = (
602 #Create a search pattern for all these strings to speed up a loop below
603 our $mode_perms_string_search = "";
604 foreach my $entry (keys %mode_permission_string_types) {
605 $mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
606 $mode_perms_string_search .= $entry;
608 our $single_mode_perms_string_search = "(?:${mode_perms_string_search})";
609 our $multi_mode_perms_string_search = qr{
610 ${single_mode_perms_string_search}
611 (?:\s*\|\s*${single_mode_perms_string_search})*
617 return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/);
624 while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
625 $curpos = pos($string);
628 last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
630 $to |= $mode_permission_string_types{$match};
631 $val .= '\s*\|\s*' if ($val ne "");
635 $oval =~ s/^\s*\|\s*//;
636 $oval =~ s/\s*\|\s*$//;
637 return sprintf("%04o", $to);
640 our $allowed_asm_includes = qr{(?x:
646 # memory.h: ARM has a custom one
648 # Load common spelling mistakes and build regular expression list.
652 if (open(my $spelling, '<', $spelling_file)) {
653 while (<$spelling>) {
656 $line =~ s/\s*\n?$//g;
659 next if ($line =~ m/^\s*#/);
660 next if ($line =~ m/^\s*$/);
662 my ($suspect, $fix) = split(/\|\|/, $line);
664 $spelling_fix{$suspect} = $fix;
668 warn "No typos will be found - file '$spelling_file': $!\n";
672 if (open(my $spelling, '<', $codespellfile)) {
673 while (<$spelling>) {
676 $line =~ s/\s*\n?$//g;
679 next if ($line =~ m/^\s*#/);
680 next if ($line =~ m/^\s*$/);
681 next if ($line =~ m/, disabled/i);
685 my ($suspect, $fix) = split(/->/, $line);
687 $spelling_fix{$suspect} = $fix;
691 warn "No codespell typos will be found - file '$codespellfile': $!\n";
695 $misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
698 my ($wordsRef, $file) = @_;
700 if (open(my $words, '<', $file)) {
704 $line =~ s/\s*\n?$//g;
707 next if ($line =~ m/^\s*#/);
708 next if ($line =~ m/^\s*$/);
710 print("$file: '$line' invalid - ignored\n");
714 $$wordsRef .= '|' if ($$wordsRef ne "");
724 my $const_structs = "";
725 read_words(\$const_structs, $conststructsfile)
726 or warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
728 my $typeOtherTypedefs = "";
729 if (length($typedefsfile)) {
730 read_words(\$typeOtherTypedefs, $typedefsfile)
731 or warn "No additional types will be considered - file '$typedefsfile': $!\n";
733 $typeTypedefs .= '|' . $typeOtherTypedefs if ($typeOtherTypedefs ne "");
736 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
737 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
738 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
739 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
740 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
746 (?:$Modifier\s+|const\s+)*
748 (?:typeof|__typeof__)\s*\([^\)]*\)|
752 (?:\s+$Modifier|\s+const)*
754 $NonptrTypeMisordered = qr{
755 (?:$Modifier\s+|const\s+)*
759 (?:\s+$Modifier|\s+const)*
761 $NonptrTypeWithAttr = qr{
762 (?:$Modifier\s+|const\s+)*
764 (?:typeof|__typeof__)\s*\([^\)]*\)|
768 (?:\s+$Modifier|\s+const)*
772 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
773 (?:\s+$Inline|\s+$Modifier)*
775 $TypeMisordered = qr{
776 $NonptrTypeMisordered
777 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
778 (?:\s+$Inline|\s+$Modifier)*
780 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
781 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
785 our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
787 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
788 # requires at least perl version v5.10.0
789 # Any use must be runtime checked with $^V
791 our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
792 our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
793 our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
795 our $declaration_macros = qr{(?x:
796 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
797 (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(|
798 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(|
799 (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\(
804 return "" if (!defined($string));
806 while ($string =~ /^\s*\(.*\)\s*$/) {
807 $string =~ s@^\s*\(\s*@@;
808 $string =~ s@\s*\)\s*$@@;
811 $string =~ s@\s+@ @g;
816 sub seed_camelcase_file {
819 return if (!(-f $file));
823 open(my $include_file, '<', "$file")
824 or warn "$P: Can't read '$file' $!\n";
825 my $text = <$include_file>;
826 close($include_file);
828 my @lines = split('\n', $text);
830 foreach my $line (@lines) {
831 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
832 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
834 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
836 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
842 sub is_maintained_obsolete {
845 return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl"));
847 my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
849 return $status =~ /obsolete/i;
852 my $camelcase_seeded = 0;
853 sub seed_camelcase_includes {
854 return if ($camelcase_seeded);
857 my $camelcase_cache = "";
858 my @include_files = ();
860 $camelcase_seeded = 1;
863 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
864 chomp $git_last_include_commit;
865 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
867 my $last_mod_date = 0;
868 $files = `find $root/include -name "*.h"`;
869 @include_files = split('\n', $files);
870 foreach my $file (@include_files) {
871 my $date = POSIX::strftime("%Y%m%d%H%M",
872 localtime((stat $file)[9]));
873 $last_mod_date = $date if ($last_mod_date < $date);
875 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
878 if ($camelcase_cache ne "" && -f $camelcase_cache) {
879 open(my $camelcase_file, '<', "$camelcase_cache")
880 or warn "$P: Can't read '$camelcase_cache' $!\n";
881 while (<$camelcase_file>) {
885 close($camelcase_file);
891 $files = `git ls-files "include/*.h"`;
892 @include_files = split('\n', $files);
895 foreach my $file (@include_files) {
896 seed_camelcase_file($file);
899 if ($camelcase_cache ne "") {
900 unlink glob ".checkpatch-camelcase.*";
901 open(my $camelcase_file, '>', "$camelcase_cache")
902 or warn "$P: Can't write '$camelcase_cache' $!\n";
903 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
904 print $camelcase_file ("$_\n");
906 close($camelcase_file);
910 sub git_commit_info {
911 my ($commit, $id, $desc) = @_;
913 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
915 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
916 $output =~ s/^\s*//gm;
917 my @lines = split("\n", $output);
919 return ($id, $desc) if ($#lines < 0);
921 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
922 # Maybe one day convert this block of bash into something that returns
923 # all matching commit ids, but it's very slow...
925 # echo "checking commits $1..."
926 # git rev-list --remotes | grep -i "^$1" |
927 # while read line ; do
928 # git log --format='%H %s' -1 $line |
929 # echo "commit $(cut -c 1-12,41-)"
931 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
934 $id = substr($lines[0], 0, 12);
935 $desc = substr($lines[0], 41);
941 $chk_signoff = 0 if ($file);
946 my @fixed_inserted = ();
947 my @fixed_deleted = ();
950 # If input is git commits, extract all commits from the commit expressions.
951 # For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
952 die "$P: No git repository found\n" if ($git && !-e ".git");
956 foreach my $commit_expr (@ARGV) {
958 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
959 $git_range = "-$2 $1";
960 } elsif ($commit_expr =~ m/\.\./) {
961 $git_range = "$commit_expr";
963 $git_range = "-1 $commit_expr";
965 my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
966 foreach my $line (split(/\n/, $lines)) {
967 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
968 next if (!defined($1) || !defined($2));
971 unshift(@commits, $sha1);
972 $git_commits{$sha1} = $subject;
975 die "$P: no git commits after extraction!\n" if (@commits == 0);
980 for my $filename (@ARGV) {
983 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
984 die "$P: $filename: git format-patch failed - $!\n";
986 open($FILE, '-|', "diff -u /dev/null $filename") ||
987 die "$P: $filename: diff failed - $!\n";
988 } elsif ($filename eq '-') {
989 open($FILE, '<&STDIN');
991 open($FILE, '<', "$filename") ||
992 die "$P: $filename: open failed - $!\n";
994 if ($filename eq '-') {
995 $vname = 'Your patch';
997 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
1003 push(@rawlines, $_);
1007 if ($#ARGV > 0 && $quiet == 0) {
1008 print '-' x length($vname) . "\n";
1010 print '-' x length($vname) . "\n";
1013 if (!process($filename)) {
1019 @fixed_inserted = ();
1020 @fixed_deleted = ();
1022 @modifierListFile = ();
1028 hash_show_words(\%use_type, "Used");
1029 hash_show_words(\%ignore_type, "Ignored");
1031 if (!$perl_version_ok) {
1034 NOTE: perl $^V is not modern enough to detect all possible issues.
1035 An upgrade to at least perl $minimum_perl_version is suggested.
1041 NOTE: If any of the errors are false positives, please report
1042 them to the maintainer, see CHECKPATCH in MAINTAINERS.
1049 sub top_of_kernel_tree {
1053 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
1054 "README", "Documentation", "arch", "include", "drivers",
1055 "fs", "init", "ipc", "kernel", "lib", "scripts",
1058 foreach my $check (@tree_check) {
1059 if (! -e $root . '/' . $check) {
1067 my ($formatted_email) = @_;
1073 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
1076 $comment = $3 if defined $3;
1077 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
1079 $comment = $2 if defined $2;
1080 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
1082 $comment = $2 if defined $2;
1083 $formatted_email =~ s/\Q$address\E.*$//;
1084 $name = $formatted_email;
1085 $name = trim($name);
1086 $name =~ s/^\"|\"$//g;
1087 # If there's a name left after stripping spaces and
1088 # leading quotes, and the address doesn't have both
1089 # leading and trailing angle brackets, the address
1091 # "joe smith joe@smith.com" bad
1092 # "joe smith <joe@smith.com" bad
1093 if ($name ne "" && $address !~ /^<[^>]+>$/) {
1100 $name = trim($name);
1101 $name =~ s/^\"|\"$//g;
1102 $address = trim($address);
1103 $address =~ s/^\<|\>$//g;
1105 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1106 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1107 $name = "\"$name\"";
1110 return ($name, $address, $comment);
1114 my ($name, $address) = @_;
1116 my $formatted_email;
1118 $name = trim($name);
1119 $name =~ s/^\"|\"$//g;
1120 $address = trim($address);
1122 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1123 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1124 $name = "\"$name\"";
1127 if ("$name" eq "") {
1128 $formatted_email = "$address";
1130 $formatted_email = "$name <$address>";
1133 return $formatted_email;
1139 foreach my $path (split(/:/, $ENV{PATH})) {
1140 if (-e "$path/$bin") {
1141 return "$path/$bin";
1151 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1152 if (-e "$path/$conf") {
1153 return "$path/$conf";
1165 for my $c (split(//, $str)) {
1169 for (; ($n % 8) != 0; $n++) {
1181 (my $res = shift) =~ tr/\t/ /c;
1188 # Drop the diff line leader and expand tabs
1190 $line = expand_tabs($line);
1192 # Pick the indent from the front of the line.
1193 my ($white) = ($line =~ /^(\s*)/);
1195 return (length($line), length($white));
1198 my $sanitise_quote = '';
1200 sub sanitise_line_reset {
1201 my ($in_comment) = @_;
1204 $sanitise_quote = '*/';
1206 $sanitise_quote = '';
1219 # Always copy over the diff marker.
1220 $res = substr($line, 0, 1);
1222 for ($off = 1; $off < length($line); $off++) {
1223 $c = substr($line, $off, 1);
1225 # Comments we are whacking completely including the begin
1226 # and end, all to $;.
1227 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1228 $sanitise_quote = '*/';
1230 substr($res, $off, 2, "$;$;");
1234 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
1235 $sanitise_quote = '';
1236 substr($res, $off, 2, "$;$;");
1240 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1241 $sanitise_quote = '//';
1243 substr($res, $off, 2, $sanitise_quote);
1248 # A \ in a string means ignore the next character.
1249 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1251 substr($res, $off, 2, 'XX');
1256 if ($c eq "'" || $c eq '"') {
1257 if ($sanitise_quote eq '') {
1258 $sanitise_quote = $c;
1260 substr($res, $off, 1, $c);
1262 } elsif ($sanitise_quote eq $c) {
1263 $sanitise_quote = '';
1267 #print "c<$c> SQ<$sanitise_quote>\n";
1268 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1269 substr($res, $off, 1, $;);
1270 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1271 substr($res, $off, 1, $;);
1272 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1273 substr($res, $off, 1, 'X');
1275 substr($res, $off, 1, $c);
1279 if ($sanitise_quote eq '//') {
1280 $sanitise_quote = '';
1283 # The pathname on a #include may be surrounded by '<' and '>'.
1284 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
1285 my $clean = 'X' x length($1);
1286 $res =~ s@\<.*\>@<$clean>@;
1288 # The whole of a #error is a string.
1289 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
1290 my $clean = 'X' x length($1);
1291 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
1294 if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1296 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1302 sub get_quoted_string {
1303 my ($line, $rawline) = @_;
1305 return "" if (!defined($line) || !defined($rawline));
1306 return "" if ($line !~ m/($String)/g);
1307 return substr($rawline, $-[0], $+[0] - $-[0]);
1310 sub ctx_statement_block {
1311 my ($linenr, $remain, $off) = @_;
1312 my $line = $linenr - 1;
1315 my $coff = $off - 1;
1329 @stack = (['', 0]) if ($#stack == -1);
1331 #warn "CSB: blk<$blk> remain<$remain>\n";
1332 # If we are about to drop off the end, pull in more
1335 for (; $remain > 0; $line++) {
1336 last if (!defined $lines[$line]);
1337 next if ($lines[$line] =~ /^-/);
1340 $blk .= $lines[$line] . "\n";
1341 $len = length($blk);
1345 # Bail if there is no further context.
1346 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1350 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1356 $c = substr($blk, $off, 1);
1357 $remainder = substr($blk, $off);
1359 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1361 # Handle nested #if/#else.
1362 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1363 push(@stack, [ $type, $level ]);
1364 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1365 ($type, $level) = @{$stack[$#stack - 1]};
1366 } elsif ($remainder =~ /^#\s*endif\b/) {
1367 ($type, $level) = @{pop(@stack)};
1370 # Statement ends at the ';' or a close '}' at the
1372 if ($level == 0 && $c eq ';') {
1376 # An else is really a conditional as long as its not else if
1377 if ($level == 0 && $coff_set == 0 &&
1378 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1379 $remainder =~ /^(else)(?:\s|{)/ &&
1380 $remainder !~ /^else\s+if\b/) {
1381 $coff = $off + length($1) - 1;
1383 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1384 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1387 if (($type eq '' || $type eq '(') && $c eq '(') {
1391 if ($type eq '(' && $c eq ')') {
1393 $type = ($level != 0)? '(' : '';
1395 if ($level == 0 && $coff < $soff) {
1398 #warn "CSB: mark coff<$coff>\n";
1401 if (($type eq '' || $type eq '{') && $c eq '{') {
1405 if ($type eq '{' && $c eq '}') {
1407 $type = ($level != 0)? '{' : '';
1410 if (substr($blk, $off + 1, 1) eq ';') {
1416 # Preprocessor commands end at the newline unless escaped.
1417 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1425 # We are truly at the end, so shuffle to the next line.
1432 my $statement = substr($blk, $soff, $off - $soff + 1);
1433 my $condition = substr($blk, $soff, $coff - $soff + 1);
1435 #warn "STATEMENT<$statement>\n";
1436 #warn "CONDITION<$condition>\n";
1438 #print "coff<$coff> soff<$off> loff<$loff>\n";
1440 return ($statement, $condition,
1441 $line, $remain + 1, $off - $loff + 1, $level);
1444 sub statement_lines {
1447 # Strip the diff line prefixes and rip blank lines at start and end.
1448 $stmt =~ s/(^|\n)./$1/g;
1452 my @stmt_lines = ($stmt =~ /\n/g);
1454 return $#stmt_lines + 2;
1457 sub statement_rawlines {
1460 my @stmt_lines = ($stmt =~ /\n/g);
1462 return $#stmt_lines + 2;
1465 sub statement_block_size {
1468 $stmt =~ s/(^|\n)./$1/g;
1474 my @stmt_lines = ($stmt =~ /\n/g);
1475 my @stmt_statements = ($stmt =~ /;/g);
1477 my $stmt_lines = $#stmt_lines + 2;
1478 my $stmt_statements = $#stmt_statements + 1;
1480 if ($stmt_lines > $stmt_statements) {
1483 return $stmt_statements;
1487 sub ctx_statement_full {
1488 my ($linenr, $remain, $off) = @_;
1489 my ($statement, $condition, $level);
1493 # Grab the first conditional/block pair.
1494 ($statement, $condition, $linenr, $remain, $off, $level) =
1495 ctx_statement_block($linenr, $remain, $off);
1496 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1497 push(@chunks, [ $condition, $statement ]);
1498 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1499 return ($level, $linenr, @chunks);
1502 # Pull in the following conditional/block pairs and see if they
1503 # could continue the statement.
1505 ($statement, $condition, $linenr, $remain, $off, $level) =
1506 ctx_statement_block($linenr, $remain, $off);
1507 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1508 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1510 push(@chunks, [ $condition, $statement ]);
1513 return ($level, $linenr, @chunks);
1517 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1519 my $start = $linenr - 1;
1526 my @stack = ($level);
1527 for ($line = $start; $remain > 0; $line++) {
1528 next if ($rawlines[$line] =~ /^-/);
1531 $blk .= $rawlines[$line];
1533 # Handle nested #if/#else.
1534 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1535 push(@stack, $level);
1536 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1537 $level = $stack[$#stack - 1];
1538 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1539 $level = pop(@stack);
1542 foreach my $c (split(//, $lines[$line])) {
1543 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1549 if ($c eq $close && $level > 0) {
1551 last if ($level == 0);
1552 } elsif ($c eq $open) {
1557 if (!$outer || $level <= 1) {
1558 push(@res, $rawlines[$line]);
1561 last if ($level == 0);
1564 return ($level, @res);
1566 sub ctx_block_outer {
1567 my ($linenr, $remain) = @_;
1569 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1573 my ($linenr, $remain) = @_;
1575 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1579 my ($linenr, $remain, $off) = @_;
1581 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1584 sub ctx_block_level {
1585 my ($linenr, $remain) = @_;
1587 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1589 sub ctx_statement_level {
1590 my ($linenr, $remain, $off) = @_;
1592 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1595 sub ctx_locate_comment {
1596 my ($first_line, $end_line) = @_;
1598 # Catch a comment on the end of the line itself.
1599 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1600 return $current_comment if (defined $current_comment);
1602 # Look through the context and try and figure out if there is a
1605 $current_comment = '';
1606 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1607 my $line = $rawlines[$linenr - 1];
1609 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1612 if ($line =~ m@/\*@) {
1615 if (!$in_comment && $current_comment ne '') {
1616 $current_comment = '';
1618 $current_comment .= $line . "\n" if ($in_comment);
1619 if ($line =~ m@\*/@) {
1624 chomp($current_comment);
1625 return($current_comment);
1627 sub ctx_has_comment {
1628 my ($first_line, $end_line) = @_;
1629 my $cmt = ctx_locate_comment($first_line, $end_line);
1631 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1632 ##print "CMMT: $cmt\n";
1634 return ($cmt ne '');
1638 my ($linenr, $cnt) = @_;
1640 my $offset = $linenr - 1;
1645 $line = $rawlines[$offset++];
1646 next if (defined($line) && $line =~ /^-/);
1654 my ($linenr, $lc) = @_;
1656 my $stat_real = raw_line($linenr, 0);
1657 for (my $count = $linenr + 1; $count <= $lc; $count++) {
1658 $stat_real = $stat_real . "\n" . raw_line($count, 0);
1665 my ($linenr, $cnt, $here) = @_;
1667 my $herectx = $here . "\n";
1668 for (my $n = 0; $n < $cnt; $n++) {
1669 $herectx .= raw_line($linenr, $n) . "\n";
1680 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1683 $coded = sprintf("^%c", unpack('C', $2) + 64);
1692 my $av_preprocessor = 0;
1697 sub annotate_reset {
1698 $av_preprocessor = 0;
1700 @av_paren_type = ('E');
1701 $av_pend_colon = 'O';
1704 sub annotate_values {
1705 my ($stream, $type) = @_;
1708 my $var = '_' x length($stream);
1711 print "$stream\n" if ($dbg_values > 1);
1713 while (length($cur)) {
1714 @av_paren_type = ('E') if ($#av_paren_type < 0);
1715 print " <" . join('', @av_paren_type) .
1716 "> <$type> <$av_pending>" if ($dbg_values > 1);
1717 if ($cur =~ /^(\s+)/o) {
1718 print "WS($1)\n" if ($dbg_values > 1);
1719 if ($1 =~ /\n/ && $av_preprocessor) {
1720 $type = pop(@av_paren_type);
1721 $av_preprocessor = 0;
1724 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1725 print "CAST($1)\n" if ($dbg_values > 1);
1726 push(@av_paren_type, $type);
1729 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1730 print "DECLARE($1)\n" if ($dbg_values > 1);
1733 } elsif ($cur =~ /^($Modifier)\s*/) {
1734 print "MODIFIER($1)\n" if ($dbg_values > 1);
1737 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1738 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1739 $av_preprocessor = 1;
1740 push(@av_paren_type, $type);
1746 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1747 print "UNDEF($1)\n" if ($dbg_values > 1);
1748 $av_preprocessor = 1;
1749 push(@av_paren_type, $type);
1751 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1752 print "PRE_START($1)\n" if ($dbg_values > 1);
1753 $av_preprocessor = 1;
1755 push(@av_paren_type, $type);
1756 push(@av_paren_type, $type);
1759 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1760 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1761 $av_preprocessor = 1;
1763 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1767 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1768 print "PRE_END($1)\n" if ($dbg_values > 1);
1770 $av_preprocessor = 1;
1772 # Assume all arms of the conditional end as this
1773 # one does, and continue as if the #endif was not here.
1774 pop(@av_paren_type);
1775 push(@av_paren_type, $type);
1778 } elsif ($cur =~ /^(\\\n)/o) {
1779 print "PRECONT($1)\n" if ($dbg_values > 1);
1781 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1782 print "ATTR($1)\n" if ($dbg_values > 1);
1783 $av_pending = $type;
1786 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1787 print "SIZEOF($1)\n" if ($dbg_values > 1);
1793 } elsif ($cur =~ /^(if|while|for)\b/o) {
1794 print "COND($1)\n" if ($dbg_values > 1);
1798 } elsif ($cur =~/^(case)/o) {
1799 print "CASE($1)\n" if ($dbg_values > 1);
1800 $av_pend_colon = 'C';
1803 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1804 print "KEYWORD($1)\n" if ($dbg_values > 1);
1807 } elsif ($cur =~ /^(\()/o) {
1808 print "PAREN('$1')\n" if ($dbg_values > 1);
1809 push(@av_paren_type, $av_pending);
1813 } elsif ($cur =~ /^(\))/o) {
1814 my $new_type = pop(@av_paren_type);
1815 if ($new_type ne '_') {
1817 print "PAREN('$1') -> $type\n"
1818 if ($dbg_values > 1);
1820 print "PAREN('$1')\n" if ($dbg_values > 1);
1823 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1824 print "FUNC($1)\n" if ($dbg_values > 1);
1828 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1829 if (defined $2 && $type eq 'C' || $type eq 'T') {
1830 $av_pend_colon = 'B';
1831 } elsif ($type eq 'E') {
1832 $av_pend_colon = 'L';
1834 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1837 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1838 print "IDENT($1)\n" if ($dbg_values > 1);
1841 } elsif ($cur =~ /^($Assignment)/o) {
1842 print "ASSIGN($1)\n" if ($dbg_values > 1);
1845 } elsif ($cur =~/^(;|{|})/) {
1846 print "END($1)\n" if ($dbg_values > 1);
1848 $av_pend_colon = 'O';
1850 } elsif ($cur =~/^(,)/) {
1851 print "COMMA($1)\n" if ($dbg_values > 1);
1854 } elsif ($cur =~ /^(\?)/o) {
1855 print "QUESTION($1)\n" if ($dbg_values > 1);
1858 } elsif ($cur =~ /^(:)/o) {
1859 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1861 substr($var, length($res), 1, $av_pend_colon);
1862 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1867 $av_pend_colon = 'O';
1869 } elsif ($cur =~ /^(\[)/o) {
1870 print "CLOSE($1)\n" if ($dbg_values > 1);
1873 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1876 print "OPV($1)\n" if ($dbg_values > 1);
1883 substr($var, length($res), 1, $variant);
1886 } elsif ($cur =~ /^($Operators)/o) {
1887 print "OP($1)\n" if ($dbg_values > 1);
1888 if ($1 ne '++' && $1 ne '--') {
1892 } elsif ($cur =~ /(^.)/o) {
1893 print "C($1)\n" if ($dbg_values > 1);
1896 $cur = substr($cur, length($1));
1897 $res .= $type x length($1);
1901 return ($res, $var);
1905 my ($possible, $line) = @_;
1906 my $notPermitted = qr{(?:
1923 ^(?:typedef|struct|enum)\b
1925 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1926 if ($possible !~ $notPermitted) {
1927 # Check for modifiers.
1928 $possible =~ s/\s*$Storage\s*//g;
1929 $possible =~ s/\s*$Sparse\s*//g;
1930 if ($possible =~ /^\s*$/) {
1932 } elsif ($possible =~ /\s/) {
1933 $possible =~ s/\s*$Type\s*//g;
1934 for my $modifier (split(' ', $possible)) {
1935 if ($modifier !~ $notPermitted) {
1936 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1937 push(@modifierListFile, $modifier);
1942 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1943 push(@typeListFile, $possible);
1947 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1956 $type =~ tr/[a-z]/[A-Z]/;
1958 return defined $use_type{$type} if (scalar keys %use_type > 0);
1960 return !defined $ignore_type{$type};
1964 my ($level, $type, $msg) = @_;
1966 if (!show_type($type) ||
1967 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
1972 if ($level eq 'ERROR') {
1974 } elsif ($level eq 'WARNING') {
1980 $output .= $prefix . $level . ':';
1982 $output .= BLUE if ($color);
1983 $output .= "$type:";
1985 $output .= RESET if ($color);
1986 $output .= ' ' . $msg . "\n";
1989 my @lines = split("\n", $output, -1);
1990 splice(@lines, 1, 1);
1991 $output = join("\n", @lines);
1993 $output = (split('\n', $output))[0] . "\n" if ($terse);
1995 push(our @report, $output);
2004 sub fixup_current_range {
2005 my ($lineRef, $offset, $length) = @_;
2007 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
2010 my $no = $o + $offset;
2011 my $nl = $l + $length;
2012 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
2016 sub fix_inserted_deleted_lines {
2017 my ($linesRef, $insertedRef, $deletedRef) = @_;
2019 my $range_last_linenr = 0;
2020 my $delta_offset = 0;
2025 my $next_insert = 0;
2026 my $next_delete = 0;
2030 my $inserted = @{$insertedRef}[$next_insert++];
2031 my $deleted = @{$deletedRef}[$next_delete++];
2033 foreach my $old_line (@{$linesRef}) {
2035 my $line = $old_line; #don't modify the array
2036 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
2038 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
2039 $range_last_linenr = $new_linenr;
2040 fixup_current_range(\$line, $delta_offset, 0);
2043 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
2044 $deleted = @{$deletedRef}[$next_delete++];
2046 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
2049 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
2050 push(@lines, ${$inserted}{'LINE'});
2051 $inserted = @{$insertedRef}[$next_insert++];
2053 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
2057 push(@lines, $line);
2067 sub fix_insert_line {
2068 my ($linenr, $line) = @_;
2074 push(@fixed_inserted, $inserted);
2077 sub fix_delete_line {
2078 my ($linenr, $line) = @_;
2085 push(@fixed_deleted, $deleted);
2089 my ($type, $msg) = @_;
2091 if (report("ERROR", $type, $msg)) {
2099 my ($type, $msg) = @_;
2101 if (report("WARNING", $type, $msg)) {
2109 my ($type, $msg) = @_;
2111 if ($check && report("CHECK", $type, $msg)) {
2119 sub check_absolute_file {
2120 my ($absolute, $herecurr) = @_;
2121 my $file = $absolute;
2123 ##print "absolute<$absolute>\n";
2125 # See if any suffix of this path is a path within the tree.
2126 while ($file =~ s@^[^/]*/@@) {
2127 if (-f "$root/$file") {
2128 ##print "file<$file>\n";
2136 # It is, so see if the prefix is acceptable.
2137 my $prefix = $absolute;
2138 substr($prefix, -length($file)) = '';
2140 ##print "prefix<$prefix>\n";
2141 if ($prefix ne ".../") {
2142 WARN("USE_RELATIVE_PATH",
2143 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
2150 $string =~ s/^\s+|\s+$//g;
2158 $string =~ s/^\s+//;
2166 $string =~ s/\s+$//;
2171 sub string_find_replace {
2172 my ($string, $find, $replace) = @_;
2174 $string =~ s/$find/$replace/g;
2182 my $source_indent = 8;
2183 my $max_spaces_before_tab = $source_indent - 1;
2184 my $spaces_to_tab = " " x $source_indent;
2186 #convert leading spaces to tabs
2187 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2188 #Remove spaces before a tab
2189 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2194 sub pos_last_openparen {
2199 my $opens = $line =~ tr/\(/\(/;
2200 my $closes = $line =~ tr/\)/\)/;
2202 my $last_openparen = 0;
2204 if (($opens == 0) || ($closes >= $opens)) {
2208 my $len = length($line);
2210 for ($pos = 0; $pos < $len; $pos++) {
2211 my $string = substr($line, $pos);
2212 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2213 $pos += length($1) - 1;
2214 } elsif (substr($line, $pos, 1) eq '(') {
2215 $last_openparen = $pos;
2216 } elsif (index($string, '(') == -1) {
2221 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
2225 my $filename = shift;
2231 my $stashrawline="";
2241 my $authorsignoff = 0;
2243 my $in_header_lines = $file ? 0 : 1;
2244 my $in_commit_log = 0; #Scanning lines before patch
2245 my $has_commit_log = 0; #Encountered lines before patch
2246 my $commit_log_possible_stack_dump = 0;
2247 my $commit_log_long_line = 0;
2248 my $commit_log_has_diff = 0;
2249 my $reported_maintainer_file = 0;
2250 my $non_utf8_charset = 0;
2252 my $last_blank_line = 0;
2253 my $last_coalesced_string_linenr = -1;
2261 # Trace the real file/line as we go.
2266 my $context_function; #undef'd unless there's a known function
2268 my $comment_edge = 0;
2272 my $prev_values = 'E';
2275 my %suppress_ifbraces;
2276 my %suppress_whiletrailers;
2277 my %suppress_export;
2278 my $suppress_statement = 0;
2280 my %signatures = ();
2282 # Pre-scan the patch sanitizing the lines.
2283 # Pre-scan the patch looking for any __setup documentation.
2285 my @setup_docs = ();
2288 my $camelcase_file_seeded = 0;
2290 my $checklicenseline = 1;
2292 sanitise_line_reset();
2294 foreach my $rawline (@rawlines) {
2298 push(@fixed, $rawline) if ($fix);
2300 if ($rawline=~/^\+\+\+\s+(\S+)/) {
2302 if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) {
2307 if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2316 # Guestimate if this is a continuing comment. Run
2317 # the context looking for a comment "edge". If this
2318 # edge is a close comment then we must be in a comment
2322 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2323 next if (defined $rawlines[$ln - 1] &&
2324 $rawlines[$ln - 1] =~ /^-/);
2326 #print "RAW<$rawlines[$ln - 1]>\n";
2327 last if (!defined $rawlines[$ln - 1]);
2328 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2329 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2334 if (defined $edge && $edge eq '*/') {
2338 # Guestimate if this is a continuing comment. If this
2339 # is the start of a diff block and this line starts
2340 # ' *' then it is very likely a comment.
2341 if (!defined $edge &&
2342 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
2347 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2348 sanitise_line_reset($in_comment);
2350 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
2351 # Standardise the strings and chars within the input to
2352 # simplify matching -- only bother with positive lines.
2353 $line = sanitise_line($rawline);
2355 push(@lines, $line);
2358 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2363 #print "==>$rawline\n";
2364 #print "-->$line\n";
2366 if ($setup_docs && $line =~ /^\+/) {
2367 push(@setup_docs, $line);
2376 foreach my $line (@lines) {
2379 my $sline = $line; #copy of $line
2380 $sline =~ s/$;/ /g; #with comments as spaces
2382 my $rawline = $rawlines[$linenr - 1];
2384 # check if it's a mode change, rename or start of a patch
2385 if (!$in_commit_log &&
2386 ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ ||
2387 ($line =~ /^rename (?:from|to) \S+\s*$/ ||
2388 $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) {
2392 #extract the line range in the file after the patch is applied
2393 if (!$in_commit_log &&
2394 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2397 $first_line = $linenr + 1;
2407 %suppress_ifbraces = ();
2408 %suppress_whiletrailers = ();
2409 %suppress_export = ();
2410 $suppress_statement = 0;
2411 if ($context =~ /\b(\w+)\s*\(/) {
2412 $context_function = $1;
2414 undef $context_function;
2418 # track the line number as we move through the hunk, note that
2419 # new versions of GNU diff omit the leading space on completely
2420 # blank context lines so we need to count that too.
2421 } elsif ($line =~ /^( |\+|$)/) {
2423 $realcnt-- if ($realcnt != 0);
2425 # Measure the line length and indent.
2426 ($length, $indent) = line_stats($rawline);
2428 # Track the previous line.
2429 ($prevline, $stashline) = ($stashline, $line);
2430 ($previndent, $stashindent) = ($stashindent, $indent);
2431 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2433 #warn "line<$line>\n";
2435 } elsif ($realcnt == 1) {
2439 my $hunk_line = ($realcnt != 0);
2441 $here = "#$linenr: " if (!$file);
2442 $here = "#$realline: " if ($file);
2445 # extract the filename as it passes
2446 if ($line =~ /^diff --git.*?(\S+)$/) {
2448 $realfile =~ s@^([^/]*)/@@ if (!$file);
2451 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2453 $realfile =~ s@^([^/]*)/@@ if (!$file);
2457 if (!$file && $tree && $p1_prefix ne '' &&
2458 -e "$root/$p1_prefix") {
2459 WARN("PATCH_PREFIX",
2460 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
2463 if ($realfile =~ m@^include/asm/@) {
2464 ERROR("MODIFIED_INCLUDE_ASM",
2465 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2470 #make up the handle for any error we report on this line
2472 $prefix = "$realfile:$realline: "
2475 $prefix = "$filename:$realline: ";
2477 $prefix = "$filename:$linenr: ";
2482 if (is_maintained_obsolete($realfile)) {
2484 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2486 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
2489 $check = $check_orig;
2491 $checklicenseline = 1;
2495 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
2497 my $hereline = "$here\n$rawline\n";
2498 my $herecurr = "$here\n$rawline\n";
2499 my $hereprev = "$here\n$prevrawline\n$rawline\n";
2501 $cnt_lines++ if ($realcnt != 0);
2503 # Check if the commit log has what seems like a diff which can confuse patch
2504 if ($in_commit_log && !$commit_log_has_diff &&
2505 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2506 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2507 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2508 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2509 ERROR("DIFF_IN_COMMIT_MSG",
2510 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2511 $commit_log_has_diff = 1;
2514 # Check for incorrect file permissions
2515 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2516 my $permhere = $here . "FILE: $realfile\n";
2517 if ($realfile !~ m@scripts/@ &&
2518 $realfile !~ /\.(py|pl|awk|sh)$/) {
2519 ERROR("EXECUTE_PERMISSIONS",
2520 "do not set execute permissions for source files\n" . $permhere);
2524 # Check the patch for a From:
2525 if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) {
2527 $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i);
2531 # Check the patch for a signoff:
2532 if ($line =~ /^\s*signed-off-by:/i) {
2535 if ($author ne '') {
2538 if ($l =~ /^\s*signed-off-by:\s*\Q$author\E/i) {
2544 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2545 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2546 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2547 $reported_maintainer_file = 1;
2550 # Check signature styles
2551 if (!$in_header_lines &&
2552 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
2553 my $space_before = $1;
2555 my $space_after = $3;
2557 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2559 if ($sign_off !~ /$signature_tags/) {
2560 WARN("BAD_SIGN_OFF",
2561 "Non-standard signature: $sign_off\n" . $herecurr);
2563 if (defined $space_before && $space_before ne "") {
2564 if (WARN("BAD_SIGN_OFF",
2565 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2567 $fixed[$fixlinenr] =
2568 "$ucfirst_sign_off $email";
2571 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
2572 if (WARN("BAD_SIGN_OFF",
2573 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2575 $fixed[$fixlinenr] =
2576 "$ucfirst_sign_off $email";
2580 if (!defined $space_after || $space_after ne " ") {
2581 if (WARN("BAD_SIGN_OFF",
2582 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2584 $fixed[$fixlinenr] =
2585 "$ucfirst_sign_off $email";
2589 my ($email_name, $email_address, $comment) = parse_email($email);
2590 my $suggested_email = format_email(($email_name, $email_address));
2591 if ($suggested_email eq "") {
2592 ERROR("BAD_SIGN_OFF",
2593 "Unrecognized email address: '$email'\n" . $herecurr);
2595 my $dequoted = $suggested_email;
2596 $dequoted =~ s/^"//;
2597 $dequoted =~ s/" </ </;
2598 # Don't force email to have quotes
2599 # Allow just an angle bracketed address
2600 if ("$dequoted$comment" ne $email &&
2601 "<$email_address>$comment" ne $email &&
2602 "$suggested_email$comment" ne $email) {
2603 WARN("BAD_SIGN_OFF",
2604 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
2608 # Check for duplicate signatures
2609 my $sig_nospace = $line;
2610 $sig_nospace =~ s/\s//g;
2611 $sig_nospace = lc($sig_nospace);
2612 if (defined $signatures{$sig_nospace}) {
2613 WARN("BAD_SIGN_OFF",
2614 "Duplicate signature\n" . $herecurr);
2616 $signatures{$sig_nospace} = 1;
2620 # Check email subject for common tools that don't need to be mentioned
2621 if ($in_header_lines &&
2622 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2623 WARN("EMAIL_SUBJECT",
2624 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2627 # Check for unwanted Gerrit info
2628 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2629 ERROR("GERRIT_CHANGE_ID",
2630 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2633 # Check if the commit log is in a possible stack dump
2634 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2635 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2636 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2638 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2639 # stack dump address
2640 $commit_log_possible_stack_dump = 1;
2643 # Check for line lengths > 75 in commit log, warn once
2644 if ($in_commit_log && !$commit_log_long_line &&
2645 length($line) > 75 &&
2646 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2647 # file delta changes
2648 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2650 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2651 # A Fixes: or Link: line
2652 $commit_log_possible_stack_dump)) {
2653 WARN("COMMIT_LOG_LONG_LINE",
2654 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2655 $commit_log_long_line = 1;
2658 # Reset possible stack dump if a blank line is found
2659 if ($in_commit_log && $commit_log_possible_stack_dump &&
2661 $commit_log_possible_stack_dump = 0;
2664 # Check for git id commit length and improperly formed commit descriptions
2665 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2666 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
2667 $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
2668 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
2669 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
2670 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2671 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
2672 my $init_char = "c";
2673 my $orig_commit = "";
2680 my $id = '0123456789ab';
2681 my $orig_desc = "commit description";
2682 my $description = "";
2684 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2686 $orig_commit = lc($2);
2687 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2688 $orig_commit = lc($1);
2691 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2692 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2693 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2694 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2695 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2698 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2699 defined $rawlines[$linenr] &&
2700 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2703 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2704 defined $rawlines[$linenr] &&
2705 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2706 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2708 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2709 $orig_desc .= " " . $1;
2713 ($id, $description) = git_commit_info($orig_commit,
2717 ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
2718 ERROR("GIT_COMMIT_ID",
2719 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2723 # Check for added, moved or deleted files
2724 if (!$reported_maintainer_file && !$in_commit_log &&
2725 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2726 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2727 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2728 (defined($1) || defined($2))))) {
2730 $reported_maintainer_file = 1;
2731 WARN("FILE_PATH_CHANGES",
2732 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2735 # Check for wrappage within a valid hunk of the file
2736 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
2737 ERROR("CORRUPTED_PATCH",
2738 "patch seems to be corrupt (line wrapped?)\n" .
2739 $herecurr) if (!$emitted_corrupt++);
2742 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2743 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
2744 $rawline !~ m/^$UTF8*$/) {
2745 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2747 my $blank = copy_spacing($rawline);
2748 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2749 my $hereptr = "$hereline$ptr\n";
2752 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
2755 # Check if it's the start of a commit log
2756 # (not a header line and we haven't seen the patch filename)
2757 if ($in_header_lines && $realfile =~ /^$/ &&
2758 !($rawline =~ /^\s+(?:\S|$)/ ||
2759 $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
2760 $in_header_lines = 0;
2762 $has_commit_log = 1;
2765 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2766 # declined it, i.e defined some charset where it is missing.
2767 if ($in_header_lines &&
2768 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2770 $non_utf8_charset = 1;
2773 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
2774 $rawline =~ /$NON_ASCII_UTF8/) {
2775 WARN("UTF8_BEFORE_PATCH",
2776 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2779 # Check for absolute kernel paths in commit message
2780 if ($tree && $in_commit_log) {
2781 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2784 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2785 check_absolute_file($1, $herecurr)) {
2788 check_absolute_file($file, $herecurr);
2793 # Check for various typo / spelling mistakes
2794 if (defined($misspellings) &&
2795 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
2796 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
2798 my $typo_fix = $spelling_fix{lc($typo)};
2799 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2800 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2801 my $msg_level = \&WARN;
2802 $msg_level = \&CHK if ($file);
2803 if (&{$msg_level}("TYPO_SPELLING",
2804 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2806 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2811 # ignore non-hunk lines and lines being removed
2812 next if (!$hunk_line || $line =~ /^-/);
2814 #trailing whitespace
2815 if ($line =~ /^\+.*\015/) {
2816 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2817 if (ERROR("DOS_LINE_ENDINGS",
2818 "DOS line endings\n" . $herevet) &&
2820 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
2822 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2823 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2824 if (ERROR("TRAILING_WHITESPACE",
2825 "trailing whitespace\n" . $herevet) &&
2827 $fixed[$fixlinenr] =~ s/\s+$//;
2833 # Check for FSF mailing addresses.
2834 if ($rawline =~ /\bwrite to the Free/i ||
2835 $rawline =~ /\b675\s+Mass\s+Ave/i ||
2836 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2837 $rawline =~ /\b51\s+Franklin\s+St/i) {
2838 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2839 my $msg_level = \&ERROR;
2840 $msg_level = \&CHK if ($file);
2841 &{$msg_level}("FSF_MAILING_ADDRESS",
2842 "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)
2845 # check for Kconfig help text having a real description
2846 # Only applies when adding the entry originally, after that we do not have
2847 # sufficient context to determine whether it is indeed long enough.
2848 if ($realfile =~ /Kconfig/ &&
2849 # 'choice' is usually the last thing on the line (though
2850 # Kconfig supports named choices), so use a word boundary
2851 # (\b) rather than a whitespace character (\s)
2852 $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) {
2855 my $ln = $linenr + 1;
2859 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
2860 $f = $lines[$ln - 1];
2861 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2862 $is_end = $lines[$ln - 1] =~ /^\+/;
2864 next if ($f =~ /^-/);
2865 last if (!$file && $f =~ /^\@\@/);
2867 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
2869 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) {
2870 if ($lines[$ln - 1] =~ "---help---") {
2871 WARN("CONFIG_DESCRIPTION",
2872 "prefer 'help' over '---help---' for new help texts\n" . $herecurr);
2880 next if ($f =~ /^$/);
2882 # This only checks context lines in the patch
2883 # and so hopefully shouldn't trigger false
2884 # positives, even though some of these are
2885 # common words in help texts
2886 if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice|
2887 if|endif|menu|endmenu|source)\b/x) {
2893 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2894 WARN("CONFIG_DESCRIPTION",
2895 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2897 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2900 # check for MAINTAINERS entries that don't have the right form
2901 if ($realfile =~ /^MAINTAINERS$/ &&
2902 $rawline =~ /^\+[A-Z]:/ &&
2903 $rawline !~ /^\+[A-Z]:\t\S/) {
2904 if (WARN("MAINTAINERS_STYLE",
2905 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
2907 $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
2911 # discourage the use of boolean for type definition attributes of Kconfig options
2912 if ($realfile =~ /Kconfig/ &&
2913 $line =~ /^\+\s*\bboolean\b/) {
2914 WARN("CONFIG_TYPE_BOOLEAN",
2915 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2918 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2919 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2922 'EXTRA_AFLAGS' => 'asflags-y',
2923 'EXTRA_CFLAGS' => 'ccflags-y',
2924 'EXTRA_CPPFLAGS' => 'cppflags-y',
2925 'EXTRA_LDFLAGS' => 'ldflags-y',
2928 WARN("DEPRECATED_VARIABLE",
2929 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2932 # check for DT compatible documentation
2933 if (defined $root &&
2934 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2935 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2937 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2939 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2940 my $vp_file = $dt_path . "vendor-prefixes.txt";
2942 foreach my $compat (@compats) {
2943 my $compat2 = $compat;
2944 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2945 my $compat3 = $compat;
2946 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2947 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
2949 WARN("UNDOCUMENTED_DT_STRING",
2950 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2953 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2955 `grep -Eq "^$vendor\\b" $vp_file`;
2957 WARN("UNDOCUMENTED_DT_STRING",
2958 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2963 # check for using SPDX license tag at beginning of files
2964 if ($realline == $checklicenseline) {
2965 if ($rawline =~ /^[ \+]\s*\#\!\s*\//) {
2966 $checklicenseline = 2;
2967 } elsif ($rawline =~ /^\+/) {
2969 if ($realfile =~ /\.(h|s|S)$/) {
2971 } elsif ($realfile =~ /\.(c|dts|dtsi)$/) {
2973 } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc)$/) {
2975 } elsif ($realfile =~ /\.rst$/) {
2979 if ($comment !~ /^$/ &&
2980 $rawline !~ /^\+\Q$comment\E SPDX-License-Identifier: /) {
2981 WARN("SPDX_LICENSE_TAG",
2982 "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr);
2987 # check we are in a valid source file if not then ignore this hunk
2988 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
2990 # line length limit (with some exclusions)
2992 # There are a few types of lines that may extend beyond $max_line_length:
2993 # logging functions like pr_info that end in a string
2994 # lines with a single string
2995 # #defines that are a single string
2996 # lines with an RFC3986 like URL
2998 # There are 3 different line length message types:
2999 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
3000 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
3001 # LONG_LINE all other lines longer than $max_line_length
3003 # if LONG_LINE is ignored, the other 2 types are also ignored
3006 if ($line =~ /^\+/ && $length > $max_line_length) {
3007 my $msg_type = "LONG_LINE";
3009 # Check the allowed long line types first
3011 # logging functions that end in a string that starts
3012 # before $max_line_length
3013 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3014 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3017 # lines with only strings (w/ possible termination)
3018 # #defines with only strings
3019 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
3020 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
3023 # More special cases
3024 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
3025 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
3028 # URL ($rawline is used in case the URL is in a comment)
3029 } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) {
3032 # Otherwise set the alternate message types
3034 # a comment starts before $max_line_length
3035 } elsif ($line =~ /($;[\s$;]*)$/ &&
3036 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3037 $msg_type = "LONG_LINE_COMMENT"
3039 # a quoted string starts before $max_line_length
3040 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
3041 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3042 $msg_type = "LONG_LINE_STRING"
3045 if ($msg_type ne "" &&
3046 (show_type("LONG_LINE") || show_type($msg_type))) {
3048 "line over $max_line_length characters\n" . $herecurr);
3052 # check for adding lines without a newline.
3053 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
3054 WARN("MISSING_EOF_NEWLINE",
3055 "adding a line without newline at end of file\n" . $herecurr);
3058 # check we are in a valid source file C or perl if not then ignore this hunk
3059 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
3061 # at the beginning of a line any tabs must come first and anything
3062 # more than 8 must use tabs.
3063 if ($rawline =~ /^\+\s* \t\s*\S/ ||
3064 $rawline =~ /^\+\s* \s*/) {
3065 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3067 if (ERROR("CODE_INDENT",
3068 "code indent should use tabs where possible\n" . $herevet) &&
3070 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3074 # check for space before tabs.
3075 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
3076 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3077 if (WARN("SPACE_BEFORE_TAB",
3078 "please, no space before tabs\n" . $herevet) &&
3080 while ($fixed[$fixlinenr] =~
3081 s/(^\+.*) {8,8}\t/$1\t\t/) {}
3082 while ($fixed[$fixlinenr] =~
3083 s/(^\+.*) +\t/$1\t/) {}
3087 # check for assignments on the start of a line
3088 if ($sline =~ /^\+\s+($Assignment)[^=]/) {
3089 CHK("ASSIGNMENT_CONTINUATIONS",
3090 "Assignment operator '$1' should be on the previous line\n" . $hereprev);
3093 # check for && or || at the start of a line
3094 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
3095 CHK("LOGICAL_CONTINUATIONS",
3096 "Logical continuations should be on the previous line\n" . $hereprev);
3099 # check indentation starts on a tab stop
3100 if ($perl_version_ok &&
3101 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
3102 my $indent = length($1);
3105 "Statements should start on a tabstop\n" . $herecurr) &&
3107 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
3112 # check multi-line statement indentation matches previous line
3113 if ($perl_version_ok &&
3114 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
3115 $prevline =~ /^\+(\t*)(.*)$/;
3119 my $pos = pos_last_openparen($rest);
3121 $line =~ /^(\+| )([ \t]*)/;
3124 my $goodtabindent = $oldindent .
3127 my $goodspaceindent = $oldindent . " " x $pos;
3129 if ($newindent ne $goodtabindent &&
3130 $newindent ne $goodspaceindent) {
3132 if (CHK("PARENTHESIS_ALIGNMENT",
3133 "Alignment should match open parenthesis\n" . $hereprev) &&
3134 $fix && $line =~ /^\+/) {
3135 $fixed[$fixlinenr] =~
3136 s/^\+[ \t]*/\+$goodtabindent/;
3142 # check for space after cast like "(int) foo" or "(struct foo) bar"
3143 # avoid checking a few false positives:
3144 # "sizeof(<type>)" or "__alignof__(<type>)"
3145 # function pointer declarations like "(*foo)(int) = bar;"
3146 # structure definitions like "(struct foo) { 0 };"
3147 # multiline macros that define functions
3148 # known attributes or the __attribute__ keyword
3149 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
3150 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
3152 "No space is necessary after a cast\n" . $herecurr) &&
3154 $fixed[$fixlinenr] =~
3155 s/(\(\s*$Type\s*\))[ \t]+/$1/;
3159 # Block comment styles
3160 # Networking with an initial /*
3161 if ($realfile =~ m@^(drivers/net/|net/)@ &&
3162 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
3163 $rawline =~ /^\+[ \t]*\*/ &&
3165 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
3166 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3169 # Block comments use * on subsequent lines
3170 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3171 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
3172 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
3173 $rawline =~ /^\+/ && #line is new
3174 $rawline !~ /^\+[ \t]*\*/) { #no leading *
3175 WARN("BLOCK_COMMENT_STYLE",
3176 "Block comments use * on subsequent lines\n" . $hereprev);
3179 # Block comments use */ on trailing lines
3180 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
3181 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3182 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3183 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
3184 WARN("BLOCK_COMMENT_STYLE",
3185 "Block comments use a trailing */ on a separate line\n" . $herecurr);
3188 # Block comment * alignment
3189 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3190 $line =~ /^\+[ \t]*$;/ && #leading comment
3191 $rawline =~ /^\+[ \t]*\*/ && #leading *
3192 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
3193 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
3194 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3196 $prevrawline =~ m@^\+([ \t]*/?)\*@;
3198 $oldindent = expand_tabs($1);
3200 $prevrawline =~ m@^\+(.*/?)\*@;
3201 $oldindent = expand_tabs($1);
3203 $rawline =~ m@^\+([ \t]*)\*@;
3205 $newindent = expand_tabs($newindent);
3206 if (length($oldindent) ne length($newindent)) {
3207 WARN("BLOCK_COMMENT_STYLE",
3208 "Block comments should align the * on each line\n" . $hereprev);
3212 # check for missing blank lines after struct/union declarations
3213 # with exceptions for various attributes and macros
3214 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3216 !($line =~ /^\+\s*$/ ||
3217 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3218 $line =~ /^\+\s*MODULE_/i ||
3219 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3220 $line =~ /^\+[a-z_]*init/ ||
3221 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3222 $line =~ /^\+\s*DECLARE/ ||
3223 $line =~ /^\+\s*builtin_[\w_]*driver/ ||
3224 $line =~ /^\+\s*__setup/)) {
3225 if (CHK("LINE_SPACING",
3226 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3228 fix_insert_line($fixlinenr, "\+");
3232 # check for multiple consecutive blank lines
3233 if ($prevline =~ /^[\+ ]\s*$/ &&
3234 $line =~ /^\+\s*$/ &&
3235 $last_blank_line != ($linenr - 1)) {
3236 if (CHK("LINE_SPACING",
3237 "Please don't use multiple blank lines\n" . $hereprev) &&
3239 fix_delete_line($fixlinenr, $rawline);
3242 $last_blank_line = $linenr;
3245 # check for missing blank lines after declarations
3246 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3247 # actual declarations
3248 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
3249 # function pointer declarations
3250 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3251 # foo bar; where foo is some local typedef or #define
3252 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3253 # known declaration macros
3254 $prevline =~ /^\+\s+$declaration_macros/) &&
3255 # for "else if" which can look like "$Ident $Ident"
3256 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3257 # other possible extensions of declaration lines
3258 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3259 # not starting a section or a macro "\" extended line
3260 $prevline =~ /(?:\{\s*|\\)$/) &&
3261 # looks like a declaration
3262 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
3263 # function pointer declarations
3264 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3265 # foo bar; where foo is some local typedef or #define
3266 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3267 # known declaration macros
3268 $sline =~ /^\+\s+$declaration_macros/ ||
3269 # start of struct or union or enum
3270 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
3271 # start or end of block or continuation of declaration
3272 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3273 # bitfield continuation
3274 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3275 # other possible extensions of declaration lines
3276 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3277 # indentation of previous and current line are the same
3278 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
3279 if (WARN("LINE_SPACING",
3280 "Missing a blank line after declarations\n" . $hereprev) &&
3282 fix_insert_line($fixlinenr, "\+");
3286 # check for spaces at the beginning of a line.
3288 # 1) within comments
3289 # 2) indented preprocessor commands
3291 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
3292 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3293 if (WARN("LEADING_SPACE",
3294 "please, no spaces at the start of a line\n" . $herevet) &&
3296 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3300 # check we are in a valid C source file if not then ignore this hunk
3301 next if ($realfile !~ /\.(h|c)$/);
3303 # check for unusual line ending [ or (
3304 if ($line =~ /^\+.*([\[\(])\s*$/) {
3305 CHK("OPEN_ENDED_LINE",
3306 "Lines should not end with a '$1'\n" . $herecurr);
3309 # check if this appears to be the start function declaration, save the name
3310 if ($sline =~ /^\+\{\s*$/ &&
3311 $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
3312 $context_function = $1;
3315 # check if this appears to be the end of function declaration
3316 if ($sline =~ /^\+\}\s*$/) {
3317 undef $context_function;
3320 # check indentation of any line with a bare else
3321 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
3322 # if the previous line is a break or return and is indented 1 tab more...
3323 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3324 my $tabs = length($1) + 1;
3325 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3326 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3327 defined $lines[$linenr] &&
3328 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
3329 WARN("UNNECESSARY_ELSE",
3330 "else is not generally useful after a break or return\n" . $hereprev);
3334 # check indentation of a line with a break;
3335 # if the previous line is a goto or return and is indented the same # of tabs
3336 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3338 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3339 WARN("UNNECESSARY_BREAK",
3340 "break is not useful after a goto or return\n" . $hereprev);
3344 # check for RCS/CVS revision markers
3345 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
3347 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
3350 # check for old HOTPLUG __dev<foo> section markings
3351 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3352 WARN("HOTPLUG_SECTION",
3353 "Using $1 is unnecessary\n" . $herecurr);
3356 # Check for potential 'bare' types
3357 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3359 #print "LINE<$line>\n";
3360 if ($linenr > $suppress_statement &&
3361 $realcnt && $sline =~ /.\s*\S/) {
3362 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3363 ctx_statement_block($linenr, $realcnt, 0);
3364 $stat =~ s/\n./\n /g;
3365 $cond =~ s/\n./\n /g;
3367 #print "linenr<$linenr> <$stat>\n";
3368 # If this statement has no statement boundaries within
3369 # it there is no point in retrying a statement scan
3370 # until we hit end of it.
3371 my $frag = $stat; $frag =~ s/;+\s*$//;
3372 if ($frag !~ /(?:{|;)/) {
3373 #print "skip<$line_nr_next>\n";
3374 $suppress_statement = $line_nr_next;
3377 # Find the real next line.
3378 $realline_next = $line_nr_next;
3379 if (defined $realline_next &&
3380 (!defined $lines[$realline_next - 1] ||
3381 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3388 # Ignore goto labels.
3389 if ($s =~ /$Ident:\*$/s) {
3391 # Ignore functions being called
3392 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
3394 } elsif ($s =~ /^.\s*else\b/s) {
3396 # declarations always start with types
3397 } 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) {
3400 possible($type, "A:" . $s);
3402 # definitions in global scope can only start with types
3403 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
3404 possible($1, "B:" . $s);
3407 # any (foo ... *) is a pointer cast, and foo is a type
3408 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
3409 possible($1, "C:" . $s);
3412 # Check for any sort of function declaration.
3413 # int foo(something bar, other baz);
3414 # void (*store_gdt)(x86_descr_ptr *);
3415 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3416 my ($name_len) = length($1);
3419 substr($ctx, 0, $name_len + 1, '');
3420 $ctx =~ s/\)[^\)]*$//;
3422 for my $arg (split(/\s*,\s*/, $ctx)) {
3423 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3425 possible($1, "D:" . $s);
3433 # Checks which may be anchored in the context.
3436 # Check for switch () and associated case and default
3437 # statements should be at the same indent.
3438 if ($line=~/\bswitch\s*\(.*\)/) {
3441 my @ctx = ctx_block_outer($linenr, $realcnt);
3443 for my $ctx (@ctx) {
3444 my ($clen, $cindent) = line_stats($ctx);
3445 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3446 $indent != $cindent) {
3447 $err .= "$sep$ctx\n";
3454 ERROR("SWITCH_CASE_INDENT_LEVEL",
3455 "switch and case should be at the same indent\n$hereline$err");
3459 # if/while/etc brace do not go on next line, unless defining a do while loop,
3460 # or if that brace on the next line is for something else
3461 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3462 my $pre_ctx = "$1$2";
3464 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
3466 if ($line =~ /^\+\t{6,}/) {
3467 WARN("DEEP_INDENTATION",
3468 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3471 my $ctx_cnt = $realcnt - $#ctx - 1;
3472 my $ctx = join("\n", @ctx);
3474 my $ctx_ln = $linenr;
3475 my $ctx_skip = $realcnt;
3477 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3478 defined $lines[$ctx_ln - 1] &&
3479 $lines[$ctx_ln - 1] =~ /^-/)) {
3480 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3481 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
3485 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3486 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3488 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
3490 "that open brace { should be on the previous line\n" .
3491 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3493 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3494 $ctx =~ /\)\s*\;\s*$/ &&
3495 defined $lines[$ctx_ln - 1])
3497 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3498 if ($nindent > $indent) {
3499 WARN("TRAILING_SEMICOLON",
3500 "trailing semicolon indicates no statements, indent implies otherwise\n" .
3501 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3506 # Check relative indent for conditionals and blocks.
3507 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3508 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3509 ctx_statement_block($linenr, $realcnt, 0)
3510 if (!defined $stat);
3511 my ($s, $c) = ($stat, $cond);
3513 substr($s, 0, length($c), '');
3515 # remove inline comments
3519 # Find out how long the conditional actually is.
3520 my @newlines = ($c =~ /\n/gs);
3521 my $cond_lines = 1 + $#newlines;
3523 # Make sure we remove the line prefixes as we have
3524 # none on the first line, and are going to readd them
3527 while ($s =~ /\n\s+\\\n/) {
3528 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3531 # We want to check the first line inside the block
3532 # starting at the end of the conditional, so remove:
3533 # 1) any blank line termination
3534 # 2) any opening brace { on end of the line
3536 my $continuation = 0;
3538 $s =~ s/^.*\bdo\b//;
3540 if ($s =~ s/^\s*\\//) {
3543 if ($s =~ s/^\s*?\n//) {
3548 # Also ignore a loop construct at the end of a
3549 # preprocessor statement.
3550 if (($prevline =~ /^.\s*#\s*define\s/ ||
3551 $prevline =~ /\\\s*$/) && $continuation == 0) {
3557 while ($cond_ptr != $cond_lines) {
3558 $cond_ptr = $cond_lines;
3560 # If we see an #else/#elif then the code
3562 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3567 # 1) blank lines, they should be at 0,
3568 # 2) preprocessor lines, and
3570 if ($continuation ||
3572 $s =~ /^\s*#\s*?/ ||
3573 $s =~ /^\s*$Ident\s*:/) {
3574 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
3575 if ($s =~ s/^.*?\n//) {
3581 my (undef, $sindent) = line_stats("+" . $s);
3582 my $stat_real = raw_line($linenr, $cond_lines);
3584 # Check if either of these lines are modified, else
3585 # this is not this patch's fault.
3586 if (!defined($stat_real) ||
3587 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3590 if (defined($stat_real) && $cond_lines > 1) {
3591 $stat_real = "[...]\n$stat_real";
3594 #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";
3596 if ($check && $s ne '' &&
3597 (($sindent % 8) != 0 ||
3598 ($sindent < $indent) ||
3599 ($sindent == $indent &&
3600 ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
3601 ($sindent > $indent + 8))) {
3602 WARN("SUSPECT_CODE_INDENT",
3603 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3607 # Track the 'values' across context and added lines.
3608 my $opline = $line; $opline =~ s/^./ /;
3609 my ($curr_values, $curr_vars) =
3610 annotate_values($opline . "\n", $prev_values);
3611 $curr_values = $prev_values . $curr_values;
3613 my $outline = $opline; $outline =~ s/\t/ /g;
3614 print "$linenr > .$outline\n";
3615 print "$linenr > $curr_values\n";
3616 print "$linenr > $curr_vars\n";
3618 $prev_values = substr($curr_values, -1);
3620 #ignore lines not being added
3621 next if ($line =~ /^[^\+]/);
3623 # check for dereferences that span multiple lines
3624 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
3625 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
3626 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
3628 $line =~ /^.\s*($Lval)/;
3631 WARN("MULTILINE_DEREFERENCE",
3632 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
3635 # check for declarations of signed or unsigned without int
3636 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3639 $var = "" if (!defined $var);
3640 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
3644 $pointer = "" if (!defined $pointer);
3646 if (WARN("UNSPECIFIED_INT",
3647 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3649 my $decl = trim($sign) . " int ";
3650 my $comp_pointer = $pointer;
3651 $comp_pointer =~ s/\s//g;
3652 $decl .= $comp_pointer;
3653 $decl = rtrim($decl) if ($var eq "");
3654 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
3659 # TEST: allow direct testing of the type matcher.
3661 if ($line =~ /^.\s*$Declare\s*$/) {
3663 "TEST: is type\n" . $herecurr);
3664 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
3665 ERROR("TEST_NOT_TYPE",
3666 "TEST: is not type ($1 is)\n". $herecurr);
3670 # TEST: allow direct testing of the attribute matcher.
3672 if ($line =~ /^.\s*$Modifier\s*$/) {
3674 "TEST: is attr\n" . $herecurr);
3675 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
3676 ERROR("TEST_NOT_ATTR",
3677 "TEST: is not attr ($1 is)\n". $herecurr);
3682 # check for initialisation to aggregates open brace on the next line
3683 if ($line =~ /^.\s*{/ &&
3684 $prevline =~ /(?:^|[^=])=\s*$/) {
3685 if (ERROR("OPEN_BRACE",
3686 "that open brace { should be on the previous line\n" . $hereprev) &&
3687 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3688 fix_delete_line($fixlinenr - 1, $prevrawline);
3689 fix_delete_line($fixlinenr, $rawline);
3690 my $fixedline = $prevrawline;
3691 $fixedline =~ s/\s*=\s*$/ = {/;
3692 fix_insert_line($fixlinenr, $fixedline);
3694 $fixedline =~ s/^(.\s*)\{\s*/$1/;
3695 fix_insert_line($fixlinenr, $fixedline);
3700 # Checks which are anchored on the added line.
3703 # check for malformed paths in #include statements (uses RAW line)
3704 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
3706 if ($path =~ m{//}) {
3707 ERROR("MALFORMED_INCLUDE",
3708 "malformed #include filename\n" . $herecurr);
3710 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3711 ERROR("UAPI_INCLUDE",
3712 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
3716 # no C99 // comments
3717 if ($line =~ m{//}) {
3718 if (ERROR("C99_COMMENTS",
3719 "do not use C99 // comments\n" . $herecurr) &&
3721 my $line = $fixed[$fixlinenr];
3722 if ($line =~ /\/\/(.*)$/) {
3723 my $comment = trim($1);
3724 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
3728 # Remove C99 comments.
3730 $opline =~ s@//.*@@;
3732 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3733 # the whole statement.
3734 #print "APW <$lines[$realline_next - 1]>\n";
3735 if (defined $realline_next &&
3736 exists $lines[$realline_next - 1] &&
3737 !defined $suppress_export{$realline_next} &&
3738 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3739 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3740 # Handle definitions which produce identifiers with
3743 # EXPORT_SYMBOL(something_foo);
3745 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
3746 $name =~ /^${Ident}_$2/) {
3747 #print "FOO C name<$name>\n";
3748 $suppress_export{$realline_next} = 1;
3750 } elsif ($stat !~ /(?:
3752 ^.DEFINE_$Ident\(\Q$name\E\)|
3753 ^.DECLARE_$Ident\(\Q$name\E\)|
3754 ^.LIST_HEAD\(\Q$name\E\)|
3755 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3756 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
3758 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3759 $suppress_export{$realline_next} = 2;
3761 $suppress_export{$realline_next} = 1;
3764 if (!defined $suppress_export{$linenr} &&
3765 $prevline =~ /^.\s*$/ &&
3766 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3767 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3768 #print "FOO B <$lines[$linenr - 1]>\n";
3769 $suppress_export{$linenr} = 2;
3771 if (defined $suppress_export{$linenr} &&
3772 $suppress_export{$linenr} == 2) {
3773 WARN("EXPORT_SYMBOL",
3774 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
3777 # check for global initialisers.
3778 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
3779 if (ERROR("GLOBAL_INITIALISERS",
3780 "do not initialise globals to $1\n" . $herecurr) &&
3782 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
3785 # check for static initialisers.
3786 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
3787 if (ERROR("INITIALISED_STATIC",
3788 "do not initialise statics to $1\n" .
3791 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
3795 # check for misordered declarations of char/short/int/long with signed/unsigned
3796 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3798 WARN("MISORDERED_TYPE",
3799 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3802 # check for static const char * arrays.
3803 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
3804 WARN("STATIC_CONST_CHAR_ARRAY",
3805 "static const char * array should probably be static const char * const\n" .
3809 # check for static char foo[] = "bar" declarations.
3810 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
3811 WARN("STATIC_CONST_CHAR_ARRAY",
3812 "static char array declaration should probably be static const char\n" .
3816 # check for const <foo> const where <foo> is not a pointer or array type
3817 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3819 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3821 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3822 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3824 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3828 # check for non-global char *foo[] = {"bar", ...} declarations.
3829 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3830 WARN("STATIC_CONST_CHAR_ARRAY",
3831 "char * array declaration might be better as static const\n" .
3835 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3836 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3838 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3840 if (WARN("ARRAY_SIZE",
3841 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3843 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3848 # check for function declarations without arguments like "int foo()"
3849 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3850 if (ERROR("FUNCTION_WITHOUT_ARGS",
3851 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3853 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
3857 # check for new typedefs, only function parameters and sparse annotations
3859 if ($line =~ /\btypedef\s/ &&
3860 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
3861 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
3862 $line !~ /\b$typeTypedefs\b/ &&
3863 $line !~ /\b__bitwise\b/) {
3864 WARN("NEW_TYPEDEFS",
3865 "do not add new typedefs\n" . $herecurr);
3868 # * goes on variable not on type
3870 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3872 my ($ident, $from, $to) = ($1, $2, $2);
3874 # Should start with a space.
3875 $to =~ s/^(\S)/ $1/;
3876 # Should not end with a space.
3878 # '*'s should not have spaces between.
3879 while ($to =~ s/\*\s+\*/\*\*/) {
3882 ## print "1: from<$from> to<$to> ident<$ident>\n";
3884 if (ERROR("POINTER_LOCATION",
3885 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3887 my $sub_from = $ident;
3888 my $sub_to = $ident;
3889 $sub_to =~ s/\Q$from\E/$to/;
3890 $fixed[$fixlinenr] =~
3891 s@\Q$sub_from\E@$sub_to@;
3895 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3897 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
3899 # Should start with a space.
3900 $to =~ s/^(\S)/ $1/;
3901 # Should not end with a space.
3903 # '*'s should not have spaces between.
3904 while ($to =~ s/\*\s+\*/\*\*/) {
3906 # Modifiers should have spaces.
3907 $to =~ s/(\b$Modifier$)/$1 /;
3909 ## print "2: from<$from> to<$to> ident<$ident>\n";
3910 if ($from ne $to && $ident !~ /^$Modifier$/) {
3911 if (ERROR("POINTER_LOCATION",
3912 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3915 my $sub_from = $match;
3916 my $sub_to = $match;
3917 $sub_to =~ s/\Q$from\E/$to/;
3918 $fixed[$fixlinenr] =~
3919 s@\Q$sub_from\E@$sub_to@;
3924 # avoid BUG() or BUG_ON()
3925 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
3926 my $msg_level = \&WARN;
3927 $msg_level = \&CHK if ($file);
3928 &{$msg_level}("AVOID_BUG",
3929 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3932 # avoid LINUX_VERSION_CODE
3933 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
3934 WARN("LINUX_VERSION_CODE",
3935 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3938 # check for uses of printk_ratelimit
3939 if ($line =~ /\bprintk_ratelimit\s*\(/) {
3940 WARN("PRINTK_RATELIMITED",
3941 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
3944 # printk should use KERN_* levels
3945 if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
3946 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3947 "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
3950 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3952 my $level = lc($orig);
3953 $level = "warn" if ($level eq "warning");
3954 my $level2 = $level;
3955 $level2 = "dbg" if ($level eq "debug");
3956 WARN("PREFER_PR_LEVEL",
3957 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
3960 if ($line =~ /\bpr_warning\s*\(/) {
3961 if (WARN("PREFER_PR_LEVEL",
3962 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3964 $fixed[$fixlinenr] =~
3965 s/\bpr_warning\b/pr_warn/;
3969 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3971 my $level = lc($orig);
3972 $level = "warn" if ($level eq "warning");
3973 $level = "dbg" if ($level eq "debug");
3974 WARN("PREFER_DEV_LEVEL",
3975 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3978 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
3979 # number of false positives, but assembly files are not checked, so at
3980 # least the arch entry code will not trigger this warning.
3981 if ($line =~ /\bENOSYS\b/) {
3983 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3986 # function brace can't be on same line, except for #defines of do while,
3987 # or if closed on same line
3988 if ($perl_version_ok &&
3989 $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ &&
3990 $sline !~ /\#\s*define\b.*do\s*\{/ &&
3992 if (ERROR("OPEN_BRACE",
3993 "open brace '{' following function definitions go on the next line\n" . $herecurr) &&
3995 fix_delete_line($fixlinenr, $rawline);
3996 my $fixed_line = $rawline;
3997 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
4000 fix_insert_line($fixlinenr, ltrim($line1));
4001 fix_insert_line($fixlinenr, "\+{");
4002 if ($line2 !~ /^\s*$/) {
4003 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
4008 # open braces for enum, union and struct go on the same line.
4009 if ($line =~ /^.\s*{/ &&
4010 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
4011 if (ERROR("OPEN_BRACE",
4012 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
4013 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4014 fix_delete_line($fixlinenr - 1, $prevrawline);
4015 fix_delete_line($fixlinenr, $rawline);
4016 my $fixedline = rtrim($prevrawline) . " {";
4017 fix_insert_line($fixlinenr, $fixedline);
4018 $fixedline = $rawline;
4019 $fixedline =~ s/^(.\s*)\{\s*/$1\t/;
4020 if ($fixedline !~ /^\+\s*$/) {
4021 fix_insert_line($fixlinenr, $fixedline);
4026 # missing space after union, struct or enum definition
4027 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
4029 "missing space after $1 definition\n" . $herecurr) &&
4031 $fixed[$fixlinenr] =~
4032 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
4036 # Function pointer declarations
4037 # check spacing between type, funcptr, and args
4038 # canonical declaration is "type (*funcptr)(args...)"
4039 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
4041 my $pre_pointer_space = $2;
4042 my $post_pointer_space = $3;
4044 my $post_funcname_space = $5;
4045 my $pre_args_space = $6;
4047 # the $Declare variable will capture all spaces after the type
4048 # so check it for a missing trailing missing space but pointer return types
4049 # don't need a space so don't warn for those.
4050 my $post_declare_space = "";
4051 if ($declare =~ /(\s+)$/) {
4052 $post_declare_space = $1;
4053 $declare = rtrim($declare);
4055 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
4057 "missing space after return type\n" . $herecurr);
4058 $post_declare_space = " ";
4061 # unnecessary space "type (*funcptr)(args...)"
4062 # This test is not currently implemented because these declarations are
4064 # int foo(int bar, ...)
4065 # and this is form shouldn't/doesn't generate a checkpatch warning.
4067 # elsif ($declare =~ /\s{2,}$/) {
4069 # "Multiple spaces after return type\n" . $herecurr);
4072 # unnecessary space "type ( *funcptr)(args...)"
4073 if (defined $pre_pointer_space &&
4074 $pre_pointer_space =~ /^\s/) {
4076 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
4079 # unnecessary space "type (* funcptr)(args...)"
4080 if (defined $post_pointer_space &&
4081 $post_pointer_space =~ /^\s/) {
4083 "Unnecessary space before function pointer name\n" . $herecurr);
4086 # unnecessary space "type (*funcptr )(args...)"
4087 if (defined $post_funcname_space &&
4088 $post_funcname_space =~ /^\s/) {
4090 "Unnecessary space after function pointer name\n" . $herecurr);
4093 # unnecessary space "type (*funcptr) (args...)"
4094 if (defined $pre_args_space &&
4095 $pre_args_space =~ /^\s/) {
4097 "Unnecessary space before function pointer arguments\n" . $herecurr);
4100 if (show_type("SPACING") && $fix) {
4101 $fixed[$fixlinenr] =~
4102 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
4106 # check for spacing round square brackets; allowed:
4107 # 1. with a type on the left -- int [] a;
4108 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4109 # 3. inside a curly brace -- = { [0...10] = 5 }
4110 while ($line =~ /(.*?\s)\[/g) {
4111 my ($where, $prefix) = ($-[1], $1);
4112 if ($prefix !~ /$Type\s+$/ &&
4113 ($where != 0 || $prefix !~ /^.\s+$/) &&
4114 $prefix !~ /[{,:]\s+$/) {
4115 if (ERROR("BRACKET_SPACE",
4116 "space prohibited before open square bracket '['\n" . $herecurr) &&
4118 $fixed[$fixlinenr] =~
4119 s/^(\+.*?)\s+\[/$1\[/;
4124 # check for spaces between functions and their parentheses.
4125 while ($line =~ /($Ident)\s+\(/g) {
4127 my $ctx_before = substr($line, 0, $-[1]);
4128 my $ctx = "$ctx_before$name";
4130 # Ignore those directives where spaces _are_ permitted.
4132 if|for|while|switch|return|case|
4133 volatile|__volatile__|
4134 __attribute__|format|__extension__|
4137 # cpp #define statements have non-optional spaces, ie
4138 # if there is a space between the name and the open
4139 # parenthesis it is simply not a parameter group.
4140 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
4142 # cpp #elif statement condition may start with a (
4143 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
4145 # If this whole things ends with a type its most
4146 # likely a typedef for a function.
4147 } elsif ($ctx =~ /$Type$/) {
4151 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
4153 $fixed[$fixlinenr] =~
4154 s/\b$name\s+\(/$name\(/;
4159 # Check operator spacing.
4160 if (!($line=~/\#\s*include/)) {
4161 my $fixed_line = "";
4165 <<=|>>=|<=|>=|==|!=|
4166 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4167 =>|->|<<|>>|<|>|=|!|~|
4168 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
4171 my @elements = split(/($ops|;)/, $opline);
4173 ## print("element count: <" . $#elements . ">\n");
4174 ## foreach my $el (@elements) {
4175 ## print("el: <$el>\n");
4178 my @fix_elements = ();
4181 foreach my $el (@elements) {
4182 push(@fix_elements, substr($rawline, $off, length($el)));
4183 $off += length($el);
4188 my $blank = copy_spacing($opline);
4189 my $last_after = -1;
4191 for (my $n = 0; $n < $#elements; $n += 2) {
4193 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4195 ## print("n: <$n> good: <$good>\n");
4197 $off += length($elements[$n]);
4199 # Pick up the preceding and succeeding characters.
4200 my $ca = substr($opline, 0, $off);
4202 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4203 $cc = substr($opline, $off + length($elements[$n + 1]));
4205 my $cb = "$ca$;$cc";
4208 $a = 'V' if ($elements[$n] ne '');
4209 $a = 'W' if ($elements[$n] =~ /\s$/);
4210 $a = 'C' if ($elements[$n] =~ /$;$/);
4211 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4212 $a = 'O' if ($elements[$n] eq '');
4213 $a = 'E' if ($ca =~ /^\s*$/);
4215 my $op = $elements[$n + 1];
4218 if (defined $elements[$n + 2]) {
4219 $c = 'V' if ($elements[$n + 2] ne '');
4220 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
4221 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
4222 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4223 $c = 'O' if ($elements[$n + 2] eq '');
4224 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
4229 my $ctx = "${a}x${c}";
4231 my $at = "(ctx:$ctx)";
4233 my $ptr = substr($blank, 0, $off) . "^";
4234 my $hereptr = "$hereline$ptr\n";
4236 # Pull out the value of this operator.
4237 my $op_type = substr($curr_values, $off + 1, 1);
4239 # Get the full operator variant.
4240 my $opv = $op . substr($curr_vars, $off, 1);
4242 # Ignore operators passed as parameters.
4243 if ($op_type ne 'V' &&
4244 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
4247 # } elsif ($op =~ /^$;+$/) {
4249 # ; should have either the end of line or a space or \ after it
4250 } elsif ($op eq ';') {
4251 if ($ctx !~ /.x[WEBC]/ &&
4252 $cc !~ /^\\/ && $cc !~ /^;/) {
4253 if (ERROR("SPACING",
4254 "space required after that '$op' $at\n" . $hereptr)) {
4255 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
4261 } elsif ($op eq '//') {
4263 # : when part of a bitfield
4264 } elsif ($opv eq ':B') {
4265 # skip the bitfield test for now
4269 } elsif ($op eq '->') {
4270 if ($ctx =~ /Wx.|.xW/) {
4271 if (ERROR("SPACING",
4272 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
4273 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4274 if (defined $fix_elements[$n + 2]) {
4275 $fix_elements[$n + 2] =~ s/^\s+//;
4281 # , must not have a space before and must have a space on the right.
4282 } elsif ($op eq ',') {
4283 my $rtrim_before = 0;
4284 my $space_after = 0;
4285 if ($ctx =~ /Wx./) {
4286 if (ERROR("SPACING",
4287 "space prohibited before that '$op' $at\n" . $hereptr)) {
4292 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
4293 if (ERROR("SPACING",
4294 "space required after that '$op' $at\n" . $hereptr)) {
4300 if ($rtrim_before || $space_after) {
4301 if ($rtrim_before) {
4302 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4304 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4311 # '*' as part of a type definition -- reported already.
4312 } elsif ($opv eq '*_') {
4313 #warn "'*' is part of type\n";
4315 # unary operators should have a space before and
4316 # none after. May be left adjacent to another
4317 # unary operator, or a cast
4318 } elsif ($op eq '!' || $op eq '~' ||
4319 $opv eq '*U' || $opv eq '-U' ||
4320 $opv eq '&U' || $opv eq '&&U') {
4321 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
4322 if (ERROR("SPACING",
4323 "space required before that '$op' $at\n" . $hereptr)) {
4324 if ($n != $last_after + 2) {
4325 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4330 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
4331 # A unary '*' may be const
4333 } elsif ($ctx =~ /.xW/) {
4334 if (ERROR("SPACING",
4335 "space prohibited after that '$op' $at\n" . $hereptr)) {
4336 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
4337 if (defined $fix_elements[$n + 2]) {
4338 $fix_elements[$n + 2] =~ s/^\s+//;
4344 # unary ++ and unary -- are allowed no space on one side.
4345 } elsif ($op eq '++' or $op eq '--') {
4346 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
4347 if (ERROR("SPACING",
4348 "space required one side of that '$op' $at\n" . $hereptr)) {
4349 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
4353 if ($ctx =~ /Wx[BE]/ ||
4354 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
4355 if (ERROR("SPACING",
4356 "space prohibited before that '$op' $at\n" . $hereptr)) {
4357 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4361 if ($ctx =~ /ExW/) {
4362 if (ERROR("SPACING",
4363 "space prohibited after that '$op' $at\n" . $hereptr)) {
4364 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4365 if (defined $fix_elements[$n + 2]) {
4366 $fix_elements[$n + 2] =~ s/^\s+//;
4372 # << and >> may either have or not have spaces both sides
4373 } elsif ($op eq '<<' or $op eq '>>' or
4374 $op eq '&' or $op eq '^' or $op eq '|' or
4375 $op eq '+' or $op eq '-' or
4376 $op eq '*' or $op eq '/' or
4380 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4382 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4383 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4384 $fix_elements[$n + 2] =~ s/^\s+//;
4387 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4389 "space preferred before that '$op' $at\n" . $hereptr)) {
4390 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4394 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
4395 if (ERROR("SPACING",
4396 "need consistent spacing around '$op' $at\n" . $hereptr)) {
4397 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4398 if (defined $fix_elements[$n + 2]) {
4399 $fix_elements[$n + 2] =~ s/^\s+//;
4405 # A colon needs no spaces before when it is
4406 # terminating a case value or a label.
4407 } elsif ($opv eq ':C' || $opv eq ':L') {
4408 if ($ctx =~ /Wx./) {
4409 if (ERROR("SPACING",
4410 "space prohibited before that '$op' $at\n" . $hereptr)) {
4411 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4416 # All the others need spaces both sides.
4417 } elsif ($ctx !~ /[EWC]x[CWE]/) {
4420 # Ignore email addresses <foo@bar>
4422 $cc =~ /^\S+\@\S+>/) ||
4424 $ca =~ /<\S+\@\S+$/))
4429 # for asm volatile statements
4430 # ignore a colon with another
4431 # colon immediately before or after
4433 ($ca =~ /:$/ || $cc =~ /^:/)) {
4437 # messages are ERROR, but ?: are CHK
4439 my $msg_level = \&ERROR;
4440 $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4442 if (&{$msg_level}("SPACING",
4443 "spaces required around that '$op' $at\n" . $hereptr)) {
4444 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4445 if (defined $fix_elements[$n + 2]) {
4446 $fix_elements[$n + 2] =~ s/^\s+//;
4452 $off += length($elements[$n + 1]);
4454 ## print("n: <$n> GOOD: <$good>\n");
4456 $fixed_line = $fixed_line . $good;
4459 if (($#elements % 2) == 0) {
4460 $fixed_line = $fixed_line . $fix_elements[$#elements];
4463 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4464 $fixed[$fixlinenr] = $fixed_line;
4470 # check for whitespace before a non-naked semicolon
4471 if ($line =~ /^\+.*\S\s+;\s*$/) {
4473 "space prohibited before semicolon\n" . $herecurr) &&
4475 1 while $fixed[$fixlinenr] =~
4476 s/^(\+.*\S)\s+;/$1;/;
4480 # check for multiple assignments
4481 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
4482 CHK("MULTIPLE_ASSIGNMENTS",
4483 "multiple assignments should be avoided\n" . $herecurr);
4486 ## # check for multiple declarations, allowing for a function declaration
4488 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4489 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4491 ## # Remove any bracketed sections to ensure we do not
4492 ## # falsly report the parameters of functions.
4494 ## while ($ln =~ s/\([^\(\)]*\)//g) {
4496 ## if ($ln =~ /,/) {
4497 ## WARN("MULTIPLE_DECLARATION",
4498 ## "declaring multiple variables together should be avoided\n" . $herecurr);
4502 #need space before brace following if, while, etc
4503 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
4505 if (ERROR("SPACING",
4506 "space required before the open brace '{'\n" . $herecurr) &&
4508 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\)))\{/$1 {/;
4512 ## # check for blank lines before declarations
4513 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4514 ## $prevrawline =~ /^.\s*$/) {
4516 ## "No blank lines before declarations\n" . $hereprev);
4520 # closing brace should have a space following it when it has anything
4522 if ($line =~ /}(?!(?:,|;|\)))\S/) {
4523 if (ERROR("SPACING",
4524 "space required after that close brace '}'\n" . $herecurr) &&
4526 $fixed[$fixlinenr] =~
4527 s/}((?!(?:,|;|\)))\S)/} $1/;
4531 # check spacing on square brackets
4532 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
4533 if (ERROR("SPACING",
4534 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4536 $fixed[$fixlinenr] =~
4540 if ($line =~ /\s\]/) {
4541 if (ERROR("SPACING",
4542 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4544 $fixed[$fixlinenr] =~
4549 # check spacing on parentheses
4550 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4551 $line !~ /for\s*\(\s+;/) {
4552 if (ERROR("SPACING",
4553 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4555 $fixed[$fixlinenr] =~
4559 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
4560 $line !~ /for\s*\(.*;\s+\)/ &&
4561 $line !~ /:\s+\)/) {
4562 if (ERROR("SPACING",
4563 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4565 $fixed[$fixlinenr] =~
4570 # check unnecessary parentheses around addressof/dereference single $Lvals
4571 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4573 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
4575 if (CHK("UNNECESSARY_PARENTHESES",
4576 "Unnecessary parentheses around $var\n" . $herecurr) &&
4578 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4582 # check for unnecessary parentheses around function pointer uses
4583 # ie: (foo->bar)(); should be foo->bar();
4584 # but not "if (foo->bar) (" to avoid some false positives
4585 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4587 if (CHK("UNNECESSARY_PARENTHESES",
4588 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4590 my $var2 = deparenthesize($var);
4592 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4596 # check for unnecessary parentheses around comparisons in if uses
4597 # when !drivers/staging or command-line uses --strict
4598 if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) &&
4599 $perl_version_ok && defined($stat) &&
4600 $stat =~ /(^.\s*if\s*($balanced_parens))/) {
4602 my $test = substr($2, 1, -1);
4604 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4606 # avoid parentheses around potential macro args
4607 next if ($match =~ /^\s*\w+\s*$/);
4608 if (!defined($herectx)) {
4609 $herectx = $here . "\n";
4610 my $cnt = statement_rawlines($if_stat);
4611 for (my $n = 0; $n < $cnt; $n++) {
4612 my $rl = raw_line($linenr, $n);
4613 $herectx .= $rl . "\n";
4614 last if $rl =~ /^[ \+].*\{/;
4617 CHK("UNNECESSARY_PARENTHESES",
4618 "Unnecessary parentheses around '$match'\n" . $herectx);
4622 #goto labels aren't indented, allow a single space however
4623 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
4624 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
4625 if (WARN("INDENTED_LABEL",
4626 "labels should not be indented\n" . $herecurr) &&
4628 $fixed[$fixlinenr] =~
4633 # return is not a function
4634 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
4636 if ($perl_version_ok &&
4637 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4639 $value = deparenthesize($value);
4640 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4641 ERROR("RETURN_PARENTHESES",
4642 "return is not a function, parentheses are not required\n" . $herecurr);
4644 } elsif ($spacing !~ /\s+/) {
4646 "space required before the open parenthesis '('\n" . $herecurr);
4650 # unnecessary return in a void function
4651 # at end-of-function, with the previous line a single leading tab, then return;
4652 # and the line before that not a goto label target like "out:"
4653 if ($sline =~ /^[ \+]}\s*$/ &&
4654 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4656 $lines[$linenr - 3] =~ /^[ +]/ &&
4657 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
4659 "void function return statements are not generally useful\n" . $hereprev);
4662 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4663 if ($perl_version_ok &&
4664 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4665 my $openparens = $1;
4666 my $count = $openparens =~ tr@\(@\(@;
4668 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4669 my $comp = $4; #Not $1 because of $LvalOrFunc
4670 $msg = " - maybe == should be = ?" if ($comp eq "==");
4671 WARN("UNNECESSARY_PARENTHESES",
4672 "Unnecessary parentheses$msg\n" . $herecurr);
4676 # comparisons with a constant or upper case identifier on the left
4677 # avoid cases like "foo + BAR < baz"
4678 # only fix matches surrounded by parentheses to avoid incorrect
4679 # conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4680 if ($perl_version_ok &&
4681 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4686 my $newcomp = $comp;
4687 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
4688 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4689 WARN("CONSTANT_COMPARISON",
4690 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4694 } elsif ($comp eq "<=") {
4696 } elsif ($comp eq ">") {
4698 } elsif ($comp eq ">=") {
4701 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4705 # Return of what appears to be an errno should normally be negative
4706 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
4708 if ($name ne 'EOF' && $name ne 'ERROR') {
4709 WARN("USE_NEGATIVE_ERRNO",
4710 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
4714 # Need a space before open parenthesis after if, while etc
4715 if ($line =~ /\b(if|while|for|switch)\(/) {
4716 if (ERROR("SPACING",
4717 "space required before the open parenthesis '('\n" . $herecurr) &&
4719 $fixed[$fixlinenr] =~
4720 s/\b(if|while|for|switch)\(/$1 \(/;
4724 # Check for illegal assignment in if conditional -- and check for trailing
4725 # statements after the conditional.
4726 if ($line =~ /do\s*(?!{)/) {
4727 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4728 ctx_statement_block($linenr, $realcnt, 0)
4729 if (!defined $stat);
4730 my ($stat_next) = ctx_statement_block($line_nr_next,
4731 $remain_next, $off_next);
4732 $stat_next =~ s/\n./\n /g;
4733 ##print "stat<$stat> stat_next<$stat_next>\n";
4735 if ($stat_next =~ /^\s*while\b/) {
4736 # If the statement carries leading newlines,
4737 # then count those as offsets.
4739 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4741 statement_rawlines($whitespace) - 1;
4743 $suppress_whiletrailers{$line_nr_next +
4747 if (!defined $suppress_whiletrailers{$linenr} &&
4748 defined($stat) && defined($cond) &&
4749 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
4750 my ($s, $c) = ($stat, $cond);
4752 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
4753 ERROR("ASSIGN_IN_IF",
4754 "do not use assignment in if condition\n" . $herecurr);
4757 # Find out what is on the end of the line after the
4759 substr($s, 0, length($c), '');
4761 $s =~ s/$;//g; # Remove any comments
4762 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4763 $c !~ /}\s*while\s*/)
4765 # Find out how long the conditional actually is.
4766 my @newlines = ($c =~ /\n/gs);
4767 my $cond_lines = 1 + $#newlines;
4770 $stat_real = raw_line($linenr, $cond_lines)
4771 . "\n" if ($cond_lines);
4772 if (defined($stat_real) && $cond_lines > 1) {
4773 $stat_real = "[...]\n$stat_real";
4776 ERROR("TRAILING_STATEMENTS",
4777 "trailing statements should be on next line\n" . $herecurr . $stat_real);
4781 # Check for bitwise tests written as boolean
4793 WARN("HEXADECIMAL_BOOLEAN_TEST",
4794 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
4797 # if and else should not have general statements after it
4798 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4800 $s =~ s/$;//g; # Remove any comments
4801 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
4802 ERROR("TRAILING_STATEMENTS",
4803 "trailing statements should be on next line\n" . $herecurr);
4806 # if should not continue a brace
4807 if ($line =~ /}\s*if\b/) {
4808 ERROR("TRAILING_STATEMENTS",
4809 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
4812 # case and default should not have general statements after them
4813 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4815 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
4819 ERROR("TRAILING_STATEMENTS",
4820 "trailing statements should be on next line\n" . $herecurr);
4823 # Check for }<nl>else {, these must be at the same
4824 # indent level to be relevant to each other.
4825 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4826 $previndent == $indent) {
4827 if (ERROR("ELSE_AFTER_BRACE",
4828 "else should follow close brace '}'\n" . $hereprev) &&
4829 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4830 fix_delete_line($fixlinenr - 1, $prevrawline);
4831 fix_delete_line($fixlinenr, $rawline);
4832 my $fixedline = $prevrawline;
4833 $fixedline =~ s/}\s*$//;
4834 if ($fixedline !~ /^\+\s*$/) {
4835 fix_insert_line($fixlinenr, $fixedline);
4837 $fixedline = $rawline;
4838 $fixedline =~ s/^(.\s*)else/$1} else/;
4839 fix_insert_line($fixlinenr, $fixedline);
4843 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4844 $previndent == $indent) {
4845 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4847 # Find out what is on the end of the line after the
4849 substr($s, 0, length($c), '');
4852 if ($s =~ /^\s*;/) {
4853 if (ERROR("WHILE_AFTER_BRACE",
4854 "while should follow close brace '}'\n" . $hereprev) &&
4855 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4856 fix_delete_line($fixlinenr - 1, $prevrawline);
4857 fix_delete_line($fixlinenr, $rawline);
4858 my $fixedline = $prevrawline;
4859 my $trailing = $rawline;
4860 $trailing =~ s/^\+//;
4861 $trailing = trim($trailing);
4862 $fixedline =~ s/}\s*$/} $trailing/;
4863 fix_insert_line($fixlinenr, $fixedline);
4868 #Specific variable tests
4869 while ($line =~ m{($Constant|$Lval)}g) {
4872 #gcc binary extension
4873 if ($var =~ /^$Binary$/) {
4874 if (WARN("GCC_BINARY_CONSTANT",
4875 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4877 my $hexval = sprintf("0x%x", oct($var));
4878 $fixed[$fixlinenr] =~
4879 s/\b$var\b/$hexval/;
4884 if ($var !~ /^$Constant$/ &&
4885 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
4886 #Ignore Page<foo> variants
4887 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
4888 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4889 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4890 #Ignore some three character SI units explicitly, like MiB and KHz
4891 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
4892 while ($var =~ m{($Ident)}g) {
4894 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
4896 seed_camelcase_includes();
4897 if (!$file && !$camelcase_file_seeded) {
4898 seed_camelcase_file($realfile);
4899 $camelcase_file_seeded = 1;
4902 if (!defined $camelcase{$word}) {
4903 $camelcase{$word} = 1;
4905 "Avoid CamelCase: <$word>\n" . $herecurr);
4911 #no spaces allowed after \ in define
4912 if ($line =~ /\#\s*define.*\\\s+$/) {
4913 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4914 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4916 $fixed[$fixlinenr] =~ s/\s+$//;
4920 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4921 # itself <asm/foo.h> (uses RAW line)
4922 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
4924 my $checkfile = "include/linux/$file";
4925 if (-f "$root/$checkfile" &&
4926 $realfile ne $checkfile &&
4927 $1 !~ /$allowed_asm_includes/)
4929 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4930 if ($asminclude > 0) {
4931 if ($realfile =~ m{^arch/}) {
4932 CHK("ARCH_INCLUDE_LINUX",
4933 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4935 WARN("INCLUDE_LINUX",
4936 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4942 # multi-statement macros should be enclosed in a do while loop, grab the
4943 # first statement and ensure its the whole macro if its not enclosed
4944 # in a known good container
4945 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4946 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
4949 my ($off, $dstat, $dcond, $rest);
4951 my $has_flow_statement = 0;
4952 my $has_arg_concat = 0;
4953 ($dstat, $dcond, $ln, $cnt, $off) =
4954 ctx_statement_block($linenr, $realcnt, 0);
4956 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4957 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4959 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
4960 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
4962 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
4963 my $define_args = $1;
4964 my $define_stmt = $dstat;
4967 if (defined $define_args && $define_args ne "") {
4968 $define_args = substr($define_args, 1, length($define_args) - 2);
4969 $define_args =~ s/\s*//g;
4970 $define_args =~ s/\\\+?//g;
4971 @def_args = split(",", $define_args);
4975 $dstat =~ s/\\\n.//g;
4976 $dstat =~ s/^\s*//s;
4977 $dstat =~ s/\s*$//s;
4979 # Flatten any parentheses and braces
4980 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4981 $dstat =~ s/\{[^\{\}]*\}/1/ ||
4982 $dstat =~ s/.\[[^\[\]]*\]/1/)
4986 # Flatten any obvious string concatentation.
4987 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4988 $dstat =~ s/$Ident\s*($String)/$1/)
4992 # Make asm volatile uses seem like a generic function
4993 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
4995 my $exceptions = qr{
5008 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
5011 my $stmt_cnt = statement_rawlines($ctx);
5012 my $herectx = get_stat_here($linenr, $stmt_cnt, $here);
5015 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
5016 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
5017 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
5018 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
5019 $dstat !~ /$exceptions/ &&
5020 $dstat !~ /^\.$Ident\s*=/ && # .foo =
5021 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
5022 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
5023 $dstat !~ /^for\s*$Constant$/ && # for (...)
5024 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
5025 $dstat !~ /^do\s*{/ && # do {...
5026 $dstat !~ /^\(\{/ && # ({...
5027 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
5029 if ($dstat =~ /^\s*if\b/) {
5030 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5031 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5032 } elsif ($dstat =~ /;/) {
5033 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5034 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
5036 ERROR("COMPLEX_MACRO",
5037 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
5042 # Make $define_stmt single line, comment-free, etc
5043 my @stmt_array = split('\n', $define_stmt);
5046 foreach my $l (@stmt_array) {
5051 } elsif ($l =~ /^[\+ ]/) {
5052 $define_stmt .= substr($l, 1);
5055 $define_stmt =~ s/$;//g;
5056 $define_stmt =~ s/\s+/ /g;
5057 $define_stmt = trim($define_stmt);
5059 # check if any macro arguments are reused (ignore '...' and 'type')
5060 foreach my $arg (@def_args) {
5061 next if ($arg =~ /\.\.\./);
5062 next if ($arg =~ /^type$/i);
5063 my $tmp_stmt = $define_stmt;
5064 $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
5065 $tmp_stmt =~ s/\#+\s*$arg\b//g;
5066 $tmp_stmt =~ s/\b$arg\s*\#\#//g;
5067 my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g;
5069 CHK("MACRO_ARG_REUSE",
5070 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
5072 # check if any macro arguments may have other precedence issues
5073 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
5074 ((defined($1) && $1 ne ',') ||
5075 (defined($2) && $2 ne ','))) {
5076 CHK("MACRO_ARG_PRECEDENCE",
5077 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
5081 # check for macros with flow control, but without ## concatenation
5082 # ## concatenation is commonly a macro that defines a function so ignore those
5083 if ($has_flow_statement && !$has_arg_concat) {
5084 my $cnt = statement_rawlines($ctx);
5085 my $herectx = get_stat_here($linenr, $cnt, $here);
5087 WARN("MACRO_WITH_FLOW_CONTROL",
5088 "Macros with flow control statements should be avoided\n" . "$herectx");
5091 # check for line continuations outside of #defines, preprocessor #, and asm
5094 if ($prevline !~ /^..*\\$/ &&
5095 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
5096 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
5097 $line =~ /^\+.*\\$/) {
5098 WARN("LINE_CONTINUATIONS",
5099 "Avoid unnecessary line continuations\n" . $herecurr);
5103 # do {} while (0) macro tests:
5104 # single-statement macros do not need to be enclosed in do while (0) loop,
5105 # macro should not end with a semicolon
5106 if ($perl_version_ok &&
5107 $realfile !~ m@/vmlinux.lds.h$@ &&
5108 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
5111 my ($off, $dstat, $dcond, $rest);
5113 ($dstat, $dcond, $ln, $cnt, $off) =
5114 ctx_statement_block($linenr, $realcnt, 0);
5117 $dstat =~ s/\\\n.//g;
5120 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5125 my $cnt = statement_rawlines($ctx);
5126 my $herectx = get_stat_here($linenr, $cnt, $here);
5128 if (($stmts =~ tr/;/;/) == 1 &&
5129 $stmts !~ /^\s*(if|while|for|switch)\b/) {
5130 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
5131 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
5133 if (defined $semis && $semis ne "") {
5134 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
5135 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
5137 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
5139 my $cnt = statement_rawlines($ctx);
5140 my $herectx = get_stat_here($linenr, $cnt, $here);
5142 WARN("TRAILING_SEMICOLON",
5143 "macros should not use a trailing semicolon\n" . "$herectx");
5147 # check for redundant bracing round if etc
5148 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
5149 my ($level, $endln, @chunks) =
5150 ctx_statement_full($linenr, $realcnt, 1);
5151 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
5152 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5153 if ($#chunks > 0 && $level == 0) {
5157 my $herectx = $here . "\n";
5158 my $ln = $linenr - 1;
5159 for my $chunk (@chunks) {
5160 my ($cond, $block) = @{$chunk};
5162 # If the condition carries leading newlines, then count those as offsets.
5163 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5164 my $offset = statement_rawlines($whitespace) - 1;
5166 $allowed[$allow] = 0;
5167 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5169 # We have looked at and allowed this specific line.
5170 $suppress_ifbraces{$ln + $offset} = 1;
5172 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
5173 $ln += statement_rawlines($block) - 1;
5175 substr($block, 0, length($cond), '');
5177 $seen++ if ($block =~ /^\s*{/);
5179 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5180 if (statement_lines($cond) > 1) {
5181 #print "APW: ALLOWED: cond<$cond>\n";
5182 $allowed[$allow] = 1;
5184 if ($block =~/\b(?:if|for|while)\b/) {
5185 #print "APW: ALLOWED: block<$block>\n";
5186 $allowed[$allow] = 1;
5188 if (statement_block_size($block) > 1) {
5189 #print "APW: ALLOWED: lines block<$block>\n";
5190 $allowed[$allow] = 1;
5195 my $sum_allowed = 0;
5196 foreach (@allowed) {
5199 if ($sum_allowed == 0) {
5201 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5202 } elsif ($sum_allowed != $allow &&
5205 "braces {} should be used on all arms of this statement\n" . $herectx);
5210 if (!defined $suppress_ifbraces{$linenr - 1} &&
5211 $line =~ /\b(if|while|for|else)\b/) {
5214 # Check the pre-context.
5215 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5216 #print "APW: ALLOWED: pre<$1>\n";
5220 my ($level, $endln, @chunks) =
5221 ctx_statement_full($linenr, $realcnt, $-[0]);
5223 # Check the condition.
5224 my ($cond, $block) = @{$chunks[0]};
5225 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5226 if (defined $cond) {
5227 substr($block, 0, length($cond), '');
5229 if (statement_lines($cond) > 1) {
5230 #print "APW: ALLOWED: cond<$cond>\n";
5233 if ($block =~/\b(?:if|for|while)\b/) {
5234 #print "APW: ALLOWED: block<$block>\n";
5237 if (statement_block_size($block) > 1) {
5238 #print "APW: ALLOWED: lines block<$block>\n";
5241 # Check the post-context.
5242 if (defined $chunks[1]) {
5243 my ($cond, $block) = @{$chunks[1]};
5244 if (defined $cond) {
5245 substr($block, 0, length($cond), '');
5247 if ($block =~ /^\s*\{/) {
5248 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5252 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
5253 my $cnt = statement_rawlines($block);
5254 my $herectx = get_stat_here($linenr, $cnt, $here);
5257 "braces {} are not necessary for single statement blocks\n" . $herectx);
5261 # check for single line unbalanced braces
5262 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
5263 $sline =~ /^.\s*else\s*\{\s*$/) {
5264 CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
5267 # check for unnecessary blank lines around braces
5268 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
5270 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5271 $fix && $prevrawline =~ /^\+/) {
5272 fix_delete_line($fixlinenr - 1, $prevrawline);
5275 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
5277 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5279 fix_delete_line($fixlinenr, $rawline);
5283 # no volatiles please
5284 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5285 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
5287 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
5290 # Check for user-visible strings broken across lines, which breaks the ability
5291 # to grep for the string. Make exceptions when the previous string ends in a
5292 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5293 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
5294 if ($line =~ /^\+\s*$String/ &&
5295 $prevline =~ /"\s*$/ &&
5296 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5297 if (WARN("SPLIT_STRING",
5298 "quoted string split across lines\n" . $hereprev) &&
5300 $prevrawline =~ /^\+.*"\s*$/ &&
5301 $last_coalesced_string_linenr != $linenr - 1) {
5302 my $extracted_string = get_quoted_string($line, $rawline);
5303 my $comma_close = "";
5304 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5308 fix_delete_line($fixlinenr - 1, $prevrawline);
5309 fix_delete_line($fixlinenr, $rawline);
5310 my $fixedline = $prevrawline;
5311 $fixedline =~ s/"\s*$//;
5312 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5313 fix_insert_line($fixlinenr - 1, $fixedline);
5314 $fixedline = $rawline;
5315 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5316 if ($fixedline !~ /\+\s*$/) {
5317 fix_insert_line($fixlinenr, $fixedline);
5319 $last_coalesced_string_linenr = $linenr;
5323 # check for missing a space in a string concatenation
5324 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5325 WARN('MISSING_SPACE',
5326 "break quoted strings at a space character\n" . $hereprev);
5329 # check for an embedded function name in a string when the function is known
5330 # This does not work very well for -f --file checking as it depends on patch
5331 # context providing the function name or a single line form for in-file
5332 # function declarations
5333 if ($line =~ /^\+.*$String/ &&
5334 defined($context_function) &&
5335 get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
5336 length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
5337 WARN("EMBEDDED_FUNCTION_NAME",
5338 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
5341 # check for spaces before a quoted newline
5342 if ($rawline =~ /^.*\".*\s\\n/) {
5343 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5344 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5346 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5351 # concatenated string without spaces between elements
5352 if ($line =~ /$String[A-Za-z0-9_]/ || $line =~ /[A-Za-z0-9_]$String/) {
5353 if (CHK("CONCATENATED_STRING",
5354 "Concatenated strings should use spaces between elements\n" . $herecurr) &&
5356 while ($line =~ /($String)/g) {
5357 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5358 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/;
5359 $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/;
5364 # uncoalesced string fragments
5365 if ($line =~ /$String\s*"/) {
5366 if (WARN("STRING_FRAGMENTS",
5367 "Consecutive strings are generally better as a single string\n" . $herecurr) &&
5369 while ($line =~ /($String)(?=\s*")/g) {
5370 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5371 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e;
5376 # check for non-standard and hex prefixed decimal printf formats
5377 my $show_L = 1; #don't show the same defect twice
5379 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
5380 my $string = substr($rawline, $-[1], $+[1] - $-[1]);
5381 $string =~ s/%%/__/g;
5383 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
5385 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
5389 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
5391 "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
5394 # check for 0x<decimal>
5395 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
5396 ERROR("PRINTF_0XDECIMAL",
5397 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5401 # check for line continuations in quoted strings with odd counts of "
5402 if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
5403 WARN("LINE_CONTINUATIONS",
5404 "Avoid line continuations in quoted strings\n" . $herecurr);
5408 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
5409 CHK("REDUNDANT_CODE",
5410 "if this code is redundant consider removing it\n" .
5414 # check for needless "if (<foo>) fn(<foo>)" uses
5415 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
5416 my $tested = quotemeta($1);
5417 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5418 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5420 if (WARN('NEEDLESS_IF',
5421 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5424 my $leading_tabs = "";
5425 my $new_leading_tabs = "";
5426 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5431 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5432 $new_leading_tabs = $1;
5433 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5440 fix_delete_line($fixlinenr - 1, $prevrawline);
5441 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5447 # check for unnecessary "Out of Memory" messages
5448 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5449 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5450 (defined $1 || defined $3) &&
5453 my $testline = $lines[$linenr - 3];
5455 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5456 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5458 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|kmemdup|(?:dev_)?alloc_skb)/) {
5460 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5464 # check for logging functions with KERN_<LEVEL>
5465 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
5466 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5468 if (WARN("UNNECESSARY_KERN_LEVEL",
5469 "Possible unnecessary $level\n" . $herecurr) &&
5471 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5475 # check for logging continuations
5476 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
5477 WARN("LOGGING_CONTINUATION",
5478 "Avoid logging continuation uses where feasible\n" . $herecurr);
5481 # check for mask then right shift without a parentheses
5482 if ($perl_version_ok &&
5483 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5484 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5485 WARN("MASK_THEN_SHIFT",
5486 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5489 # check for pointer comparisons to NULL
5490 if ($perl_version_ok) {
5491 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5494 $equal = "" if ($4 eq "!=");
5495 if (CHK("COMPARISON_TO_NULL",
5496 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5498 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5503 # check for bad placement of section $InitAttribute (e.g.: __initdata)
5504 if ($line =~ /(\b$InitAttribute\b)/) {
5506 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5509 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5510 ERROR("MISPLACED_INIT",
5511 "$attr should be placed after $var\n" . $herecurr)) ||
5512 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5513 WARN("MISPLACED_INIT",
5514 "$attr should be placed after $var\n" . $herecurr))) &&
5516 $fixed[$fixlinenr] =~ 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;
5521 # check for $InitAttributeData (ie: __initdata) with const
5522 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5524 $attr =~ /($InitAttributePrefix)(.*)/;
5525 my $attr_prefix = $1;
5527 if (ERROR("INIT_ATTRIBUTE",
5528 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5530 $fixed[$fixlinenr] =~
5531 s/$InitAttributeData/${attr_prefix}initconst/;
5535 # check for $InitAttributeConst (ie: __initconst) without const
5536 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5538 if (ERROR("INIT_ATTRIBUTE",
5539 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5541 my $lead = $fixed[$fixlinenr] =~
5542 /(^\+\s*(?:static\s+))/;
5544 $lead = "$lead " if ($lead !~ /^\+$/);
5545 $lead = "${lead}const ";
5546 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
5550 # check for __read_mostly with const non-pointer (should just be const)
5551 if ($line =~ /\b__read_mostly\b/ &&
5552 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5553 if (ERROR("CONST_READ_MOSTLY",
5554 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5556 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5560 # don't use __constant_<foo> functions outside of include/uapi/
5561 if ($realfile !~ m@^include/uapi/@ &&
5562 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5563 my $constant_func = $1;
5564 my $func = $constant_func;
5565 $func =~ s/^__constant_//;
5566 if (WARN("CONSTANT_CONVERSION",
5567 "$constant_func should be $func\n" . $herecurr) &&
5569 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
5573 # prefer usleep_range over udelay
5574 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
5576 # ignore udelay's < 10, however
5577 if (! ($delay < 10) ) {
5579 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5581 if ($delay > 2000) {
5583 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
5587 # warn about unexpectedly long msleep's
5588 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5591 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5595 # check for comparisons of jiffies
5596 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5597 WARN("JIFFIES_COMPARISON",
5598 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5601 # check for comparisons of get_jiffies_64()
5602 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5603 WARN("JIFFIES_COMPARISON",
5604 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5607 # warn about #ifdefs in C files
5608 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5609 # print "#ifdef in C files should be avoided\n";
5610 # print "$herecurr";
5614 # warn about spacing in #ifdefs
5615 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
5616 if (ERROR("SPACING",
5617 "exactly one space required after that #$1\n" . $herecurr) &&
5619 $fixed[$fixlinenr] =~
5620 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5625 # check for spinlock_t definitions without a comment.
5626 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5627 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
5629 if (!ctx_has_comment($first_line, $linenr)) {
5630 CHK("UNCOMMENTED_DEFINITION",
5631 "$1 definition without comment\n" . $herecurr);
5634 # check for memory barriers without a comment.
5640 read_barrier_depends
5642 my $barrier_stems = qr{
5650 my $all_barriers = qr{
5652 smp_(?:$barrier_stems)|
5653 virt_(?:$barrier_stems)
5656 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
5657 if (!ctx_has_comment($first_line, $linenr)) {
5658 WARN("MEMORY_BARRIER",
5659 "memory barrier without comment\n" . $herecurr);
5663 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5665 if ($realfile !~ m@^include/asm-generic/@ &&
5666 $realfile !~ m@/barrier\.h$@ &&
5667 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5668 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5669 WARN("MEMORY_BARRIER",
5670 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5673 # check for waitqueue_active without a comment.
5674 if ($line =~ /\bwaitqueue_active\s*\(/) {
5675 if (!ctx_has_comment($first_line, $linenr)) {
5676 WARN("WAITQUEUE_ACTIVE",
5677 "waitqueue_active without comment\n" . $herecurr);
5681 # check for smp_read_barrier_depends and read_barrier_depends
5682 if (!$file && $line =~ /\b(smp_|)read_barrier_depends\s*\(/) {
5683 WARN("READ_BARRIER_DEPENDS",
5684 "$1read_barrier_depends should only be used in READ_ONCE or DEC Alpha code\n" . $herecurr);
5687 # check of hardware specific defines
5688 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5690 "architecture specific defines should be avoided\n" . $herecurr);
5693 # check that the storage class is not after a type
5694 if ($line =~ /\b($Type)\s+($Storage)\b/) {
5695 WARN("STORAGE_CLASS",
5696 "storage class '$2' should be located before type '$1'\n" . $herecurr);
5698 # Check that the storage class is at the beginning of a declaration
5699 if ($line =~ /\b$Storage\b/ &&
5700 $line !~ /^.\s*$Storage/ &&
5701 $line =~ /^.\s*(.+?)\$Storage\s/ &&
5702 $1 !~ /[\,\)]\s*$/) {
5703 WARN("STORAGE_CLASS",
5704 "storage class should be at the beginning of the declaration\n" . $herecurr);
5707 # check the location of the inline attribute, that it is between
5708 # storage class and type.
5709 if ($line =~ /\b$Type\s+$Inline\b/ ||
5710 $line =~ /\b$Inline\s+$Storage\b/) {
5711 ERROR("INLINE_LOCATION",
5712 "inline keyword should sit between storage class and type\n" . $herecurr);
5715 # Check for __inline__ and __inline, prefer inline
5716 if ($realfile !~ m@\binclude/uapi/@ &&
5717 $line =~ /\b(__inline__|__inline)\b/) {
5719 "plain inline is preferred over $1\n" . $herecurr) &&
5721 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
5726 # Check for __attribute__ packed, prefer __packed
5727 if ($realfile !~ m@\binclude/uapi/@ &&
5728 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
5729 WARN("PREFER_PACKED",
5730 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
5733 # Check for __attribute__ aligned, prefer __aligned
5734 if ($realfile !~ m@\binclude/uapi/@ &&
5735 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
5736 WARN("PREFER_ALIGNED",
5737 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
5740 # Check for __attribute__ format(printf, prefer __printf
5741 if ($realfile !~ m@\binclude/uapi/@ &&
5742 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
5743 if (WARN("PREFER_PRINTF",
5744 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5746 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5751 # Check for __attribute__ format(scanf, prefer __scanf
5752 if ($realfile !~ m@\binclude/uapi/@ &&
5753 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
5754 if (WARN("PREFER_SCANF",
5755 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5757 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5761 # Check for __attribute__ weak, or __weak declarations (may have link issues)
5762 if ($perl_version_ok &&
5763 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5764 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5765 $line =~ /\b__weak\b/)) {
5766 ERROR("WEAK_DECLARATION",
5767 "Using weak declarations can have unintended link defects\n" . $herecurr);
5770 # check for c99 types like uint8_t used outside of uapi/ and tools/
5771 if ($realfile !~ m@\binclude/uapi/@ &&
5772 $realfile !~ m@\btools/@ &&
5773 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5775 if ($type =~ /\b($typeC99Typedefs)\b/) {
5777 my $kernel_type = 'u';
5778 $kernel_type = 's' if ($type =~ /^_*[si]/);
5781 if (CHK("PREFER_KERNEL_TYPES",
5782 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5784 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5789 # check for cast of C90 native int or longer types constants
5790 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5793 if (WARN("TYPECAST_INT_CONSTANT",
5794 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5797 my $newconst = $const;
5798 $newconst =~ s/${Int_type}$//;
5799 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5800 if ($cast =~ /\blong\s+long\b/) {
5802 } elsif ($cast =~ /\blong\b/) {
5805 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5809 # check for sizeof(&)
5810 if ($line =~ /\bsizeof\s*\(\s*\&/) {
5811 WARN("SIZEOF_ADDRESS",
5812 "sizeof(& should be avoided\n" . $herecurr);
5815 # check for sizeof without parenthesis
5816 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
5817 if (WARN("SIZEOF_PARENTHESIS",
5818 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5820 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5824 # check for struct spinlock declarations
5825 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5826 WARN("USE_SPINLOCK_T",
5827 "struct spinlock should be spinlock_t\n" . $herecurr);
5830 # check for seq_printf uses that could be seq_puts
5831 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
5832 my $fmt = get_quoted_string($line, $rawline);
5835 if (WARN("PREFER_SEQ_PUTS",
5836 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5838 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
5843 # check for vsprintf extension %p<foo> misuses
5844 if ($perl_version_ok &&
5846 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
5847 $1 !~ /^_*volatile_*$/) {
5850 my $lc = $stat =~ tr@\n@@;
5851 $lc = $lc + $linenr;
5852 for (my $count = $linenr; $count <= $lc; $count++) {
5855 my $bad_specifier = "";
5856 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
5859 while ($fmt =~ /(\%[\*\d\.]*p(\w))/g) {
5862 if ($extension !~ /[SsBKRraEhMmIiUDdgVCbGNOx]/) {
5863 $bad_specifier = $specifier;
5866 if ($extension eq "x" && !defined($stat_real)) {
5867 if (!defined($stat_real)) {
5868 $stat_real = get_stat_real($linenr, $lc);
5870 WARN("VSPRINTF_SPECIFIER_PX",
5871 "Using vsprintf specifier '\%px' potentially exposes the kernel memory layout, if you don't really need the address please consider using '\%p'.\n" . "$here\n$stat_real\n");
5874 if ($bad_specifier ne "") {
5875 my $stat_real = get_stat_real($linenr, $lc);
5876 my $ext_type = "Invalid";
5878 if ($bad_specifier =~ /p[Ff]/) {
5879 $ext_type = "Deprecated";
5880 $use = " - use %pS instead";
5881 $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/);
5884 WARN("VSPRINTF_POINTER_EXTENSION",
5885 "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n");
5890 # Check for misused memsets
5891 if ($perl_version_ok &&
5893 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
5899 if ($ms_size =~ /^(0x|)0$/i) {
5901 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
5902 } elsif ($ms_size =~ /^(0x|)1$/i) {
5904 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5908 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5909 # if ($perl_version_ok &&
5911 # $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5912 # if (WARN("PREFER_ETHER_ADDR_COPY",
5913 # "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5915 # $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5919 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5920 # if ($perl_version_ok &&
5922 # $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5923 # WARN("PREFER_ETHER_ADDR_EQUAL",
5924 # "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5927 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5928 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5929 # if ($perl_version_ok &&
5931 # $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5935 # if ($ms_val =~ /^(?:0x|)0+$/i) {
5936 # if (WARN("PREFER_ETH_ZERO_ADDR",
5937 # "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5939 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5941 # } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5942 # if (WARN("PREFER_ETH_BROADCAST_ADDR",
5943 # "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5945 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5950 # typecasts on min/max could be min_t/max_t
5951 if ($perl_version_ok &&
5953 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
5954 if (defined $2 || defined $7) {
5956 my $cast1 = deparenthesize($2);
5958 my $cast2 = deparenthesize($7);
5962 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
5963 $cast = "$cast1 or $cast2";
5964 } elsif ($cast1 ne "") {
5970 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
5974 # check usleep_range arguments
5975 if ($perl_version_ok &&
5977 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5981 WARN("USLEEP_RANGE",
5982 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5983 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5985 WARN("USLEEP_RANGE",
5986 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5990 # check for naked sscanf
5991 if ($perl_version_ok &&
5993 $line =~ /\bsscanf\b/ &&
5994 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5995 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5996 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5997 my $lc = $stat =~ tr@\n@@;
5998 $lc = $lc + $linenr;
5999 my $stat_real = get_stat_real($linenr, $lc);
6000 WARN("NAKED_SSCANF",
6001 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
6004 # check for simple sscanf that should be kstrto<foo>
6005 if ($perl_version_ok &&
6007 $line =~ /\bsscanf\b/) {
6008 my $lc = $stat =~ tr@\n@@;
6009 $lc = $lc + $linenr;
6010 my $stat_real = get_stat_real($linenr, $lc);
6011 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
6013 my $count = $format =~ tr@%@%@;
6015 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
6016 WARN("SSCANF_TO_KSTRTO",
6017 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
6022 # check for new externs in .h files.
6023 if ($realfile =~ /\.h$/ &&
6024 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
6025 if (CHK("AVOID_EXTERNS",
6026 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
6028 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
6032 # check for new externs in .c files.
6033 if ($realfile =~ /\.c$/ && defined $stat &&
6034 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
6036 my $function_name = $1;
6037 my $paren_space = $2;
6040 if (defined $cond) {
6041 substr($s, 0, length($cond), '');
6043 if ($s =~ /^\s*;/ &&
6044 $function_name ne 'uninitialized_var')
6046 WARN("AVOID_EXTERNS",
6047 "externs should be avoided in .c files\n" . $herecurr);
6050 if ($paren_space =~ /\n/) {
6051 WARN("FUNCTION_ARGUMENTS",
6052 "arguments for function declarations should follow identifier\n" . $herecurr);
6055 } elsif ($realfile =~ /\.c$/ && defined $stat &&
6056 $stat =~ /^.\s*extern\s+/)
6058 WARN("AVOID_EXTERNS",
6059 "externs should be avoided in .c files\n" . $herecurr);
6062 # check for function declarations that have arguments without identifier names
6063 if (defined $stat &&
6064 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
6066 my $args = trim($1);
6067 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
6069 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
6070 WARN("FUNCTION_ARGUMENTS",
6071 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
6076 # check for function definitions
6077 if ($perl_version_ok &&
6079 $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
6080 $context_function = $1;
6082 # check for multiline function definition with misplaced open brace
6084 my $cnt = statement_rawlines($stat);
6085 my $herectx = $here . "\n";
6086 for (my $n = 0; $n < $cnt; $n++) {
6087 my $rl = raw_line($linenr, $n);
6088 $herectx .= $rl . "\n";
6089 $ok = 1 if ($rl =~ /^[ \+]\{/);
6090 $ok = 1 if ($rl =~ /\{/ && $n == 0);
6091 last if $rl =~ /^[ \+].*\{/;
6095 "open brace '{' following function definitions go on the next line\n" . $herectx);
6099 # checks for new __setup's
6100 if ($rawline =~ /\b__setup\("([^"]*)"/) {
6103 if (!grep(/$name/, @setup_docs)) {
6104 CHK("UNDOCUMENTED_SETUP",
6105 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
6109 # check for pointless casting of kmalloc return
6110 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
6111 WARN("UNNECESSARY_CASTS",
6112 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
6116 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6117 if ($perl_version_ok &&
6118 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6119 CHK("ALLOC_SIZEOF_STRUCT",
6120 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
6123 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6124 if ($perl_version_ok &&
6126 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
6130 my $newfunc = "kmalloc_array";
6131 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
6134 if ($a1 =~ /^sizeof\s*\S/) {
6138 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
6139 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
6140 my $cnt = statement_rawlines($stat);
6141 my $herectx = get_stat_here($linenr, $cnt, $here);
6143 if (WARN("ALLOC_WITH_MULTIPLY",
6144 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
6147 $fixed[$fixlinenr] =~ s/\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)/$1 . ' = ' . "$newfunc(" . trim($r1) . ', ' . trim($r2)/e;
6152 # check for krealloc arg reuse
6153 if ($perl_version_ok &&
6154 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
6155 WARN("KREALLOC_ARG_REUSE",
6156 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
6159 # check for alloc argument mismatch
6160 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
6161 WARN("ALLOC_ARRAY_ARGS",
6162 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
6165 # check for multiple semicolons
6166 if ($line =~ /;\s*;\s*$/) {
6167 if (WARN("ONE_SEMICOLON",
6168 "Statements terminations use 1 semicolon\n" . $herecurr) &&
6170 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
6174 # check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6175 if ($realfile !~ m@^include/uapi/@ &&
6176 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
6178 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
6179 if (CHK("BIT_MACRO",
6180 "Prefer using the BIT$ull macro\n" . $herecurr) &&
6182 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
6186 # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6187 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6189 if (WARN("PREFER_IS_ENABLED",
6190 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
6192 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
6196 # check for case / default statements not preceded by break/fallthrough/switch
6197 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
6199 my $has_statement = 0;
6201 my $prevline = $linenr;
6202 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
6204 my $rline = $rawlines[$prevline - 1];
6205 my $fline = $lines[$prevline - 1];
6206 last if ($fline =~ /^\@\@/);
6207 next if ($fline =~ /^\-/);
6208 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
6209 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
6210 next if ($fline =~ /^.[\s$;]*$/);
6213 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/);
6215 if (!$has_break && $has_statement) {
6216 WARN("MISSING_BREAK",
6217 "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr);
6221 # check for switch/default statements without a break;
6222 if ($perl_version_ok &&
6224 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
6225 my $cnt = statement_rawlines($stat);
6226 my $herectx = get_stat_here($linenr, $cnt, $here);
6228 WARN("DEFAULT_NO_BREAK",
6229 "switch default: should use break\n" . $herectx);
6232 # check for gcc specific __FUNCTION__
6233 if ($line =~ /\b__FUNCTION__\b/) {
6234 if (WARN("USE_FUNC",
6235 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
6237 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
6241 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
6242 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
6244 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
6247 # check for use of yield()
6248 if ($line =~ /\byield\s*\(\s*\)/) {
6250 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
6253 # check for comparisons against true and false
6254 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6262 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6264 my $type = lc($otype);
6265 if ($type =~ /^(?:true|false)$/) {
6266 if (("$test" eq "==" && "$type" eq "true") ||
6267 ("$test" eq "!=" && "$type" eq "false")) {
6271 CHK("BOOL_COMPARISON",
6272 "Using comparison to $otype is error prone\n" . $herecurr);
6274 ## maybe suggesting a correct construct would better
6275 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6280 # check for bool bitfields
6281 if ($sline =~ /^.\s+bool\s*$Ident\s*:\s*\d+\s*;/) {
6282 WARN("BOOL_BITFIELD",
6283 "Avoid using bool as bitfield. Prefer bool bitfields as unsigned int or u<8|16|32>\n" . $herecurr);
6286 # check for bool use in .h files
6287 if ($realfile =~ /\.h$/ &&
6288 $sline =~ /^.\s+bool\s*$Ident\s*(?::\s*d+\s*)?;/) {
6290 "Avoid using bool structure members because of possible alignment issues - see: https://lkml.org/lkml/2017/11/21/384\n" . $herecurr);
6293 # check for semaphores initialized locked
6294 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
6295 WARN("CONSIDER_COMPLETION",
6296 "consider using a completion\n" . $herecurr);
6299 # recommend kstrto* over simple_strto* and strict_strto*
6300 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
6301 WARN("CONSIDER_KSTRTO",
6302 "$1 is obsolete, use k$3 instead\n" . $herecurr);
6305 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
6306 if ($line =~ /^.\s*__initcall\s*\(/) {
6307 WARN("USE_DEVICE_INITCALL",
6308 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
6311 # check for various structs that are normally const (ops, kgdb, device_tree)
6312 # and avoid what seem like struct definitions 'struct foo {'
6313 if ($line !~ /\bconst\b/ &&
6314 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
6315 WARN("CONST_STRUCT",
6316 "struct $1 should normally be const\n" . $herecurr);
6319 # use of NR_CPUS is usually wrong
6320 # ignore definitions of NR_CPUS and usage to define arrays as likely right
6321 if ($line =~ /\bNR_CPUS\b/ &&
6322 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6323 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
6324 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6325 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6326 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
6329 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
6332 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6333 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6334 ERROR("DEFINE_ARCH_HAS",
6335 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6338 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
6339 if ($perl_version_ok &&
6340 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6341 WARN("LIKELY_MISUSE",
6342 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6345 # whine mightly about in_atomic
6346 if ($line =~ /\bin_atomic\s*\(/) {
6347 if ($realfile =~ m@^drivers/@) {
6349 "do not use in_atomic in drivers\n" . $herecurr);
6350 } elsif ($realfile !~ m@^kernel/@) {
6352 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
6356 # check for mutex_trylock_recursive usage
6357 if ($line =~ /mutex_trylock_recursive/) {
6359 "recursive locking is bad, do not use this ever.\n" . $herecurr);
6362 # check for lockdep_set_novalidate_class
6363 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6364 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6365 if ($realfile !~ m@^kernel/lockdep@ &&
6366 $realfile !~ m@^include/linux/lockdep@ &&
6367 $realfile !~ m@^drivers/base/core@) {
6369 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
6373 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6374 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
6375 WARN("EXPORTED_WORLD_WRITABLE",
6376 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6379 # check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6380 # and whether or not function naming is typical and if
6381 # DEVICE_ATTR permissions uses are unusual too
6382 if ($perl_version_ok &&
6384 $stat =~ /\bDEVICE_ATTR\s*\(\s*(\w+)\s*,\s*\(?\s*(\s*(?:${multi_mode_perms_string_search}|0[0-7]{3,3})\s*)\s*\)?\s*,\s*(\w+)\s*,\s*(\w+)\s*\)/) {
6389 my $octal_perms = perms_to_octal($perms);
6390 if ($show =~ /^${var}_show$/ &&
6391 $store =~ /^${var}_store$/ &&
6392 $octal_perms eq "0644") {
6393 if (WARN("DEVICE_ATTR_RW",
6394 "Use DEVICE_ATTR_RW\n" . $herecurr) &&
6396 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6398 } elsif ($show =~ /^${var}_show$/ &&
6399 $store =~ /^NULL$/ &&
6400 $octal_perms eq "0444") {
6401 if (WARN("DEVICE_ATTR_RO",
6402 "Use DEVICE_ATTR_RO\n" . $herecurr) &&
6404 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6406 } elsif ($show =~ /^NULL$/ &&
6407 $store =~ /^${var}_store$/ &&
6408 $octal_perms eq "0200") {
6409 if (WARN("DEVICE_ATTR_WO",
6410 "Use DEVICE_ATTR_WO\n" . $herecurr) &&
6412 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6414 } elsif ($octal_perms eq "0644" ||
6415 $octal_perms eq "0444" ||
6416 $octal_perms eq "0200") {
6417 my $newshow = "$show";
6418 $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show");
6419 my $newstore = $store;
6420 $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store");
6422 if ($show ne $newshow) {
6423 $rename .= " '$show' to '$newshow'";
6425 if ($store ne $newstore) {
6426 $rename .= " '$store' to '$newstore'";
6428 WARN("DEVICE_ATTR_FUNCTIONS",
6429 "Consider renaming function(s)$rename\n" . $herecurr);
6431 WARN("DEVICE_ATTR_PERMS",
6432 "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr);
6436 # Mode permission misuses where it seems decimal should be octal
6437 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6438 # o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6439 # specific definition of not visible in sysfs.
6440 # o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6441 # use the default permissions
6442 if ($perl_version_ok &&
6444 $line =~ /$mode_perms_search/) {
6445 foreach my $entry (@mode_permission_funcs) {
6446 my $func = $entry->[0];
6447 my $arg_pos = $entry->[1];
6449 my $lc = $stat =~ tr@\n@@;
6450 $lc = $lc + $linenr;
6451 my $stat_real = get_stat_real($linenr, $lc);
6456 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6458 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
6459 if ($stat =~ /$test/) {
6461 $val = $6 if ($skip_args ne "");
6462 if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
6463 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6464 ($val =~ /^$Octal$/ && length($val) ne 4))) {
6465 ERROR("NON_OCTAL_PERMISSIONS",
6466 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
6468 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
6469 ERROR("EXPORTED_WORLD_WRITABLE",
6470 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
6476 # check for uses of S_<PERMS> that could be octal for readability
6477 while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) {
6479 my $octal = perms_to_octal($oval);
6480 if (WARN("SYMBOLIC_PERMS",
6481 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6483 $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
6487 # validate content of MODULE_LICENSE against list from include/linux/module.h
6488 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6489 my $extracted_string = get_quoted_string($line, $rawline);
6490 my $valid_licenses = qr{
6493 GPL\ and\ additional\ rights|
6499 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6500 WARN("MODULE_LICENSE",
6501 "unknown module license " . $extracted_string . "\n" . $herecurr);
6506 # If we have no input at all, then there is nothing to report on
6507 # so just keep quiet.
6508 if ($#rawlines == -1) {
6512 # In mailback mode only produce a report in the negative, for
6513 # things that appear to be patches.
6514 if ($mailback && ($clean == 1 || !$is_patch)) {
6518 # This is not a patch, and we are are in 'no-patch' mode so
6520 if (!$chk_patch && !$is_patch) {
6524 if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
6525 ERROR("NOT_UNIFIED_DIFF",
6526 "Does not appear to be a unified-diff format patch\n");
6528 if ($is_patch && $has_commit_log && $chk_signoff) {
6529 if ($signoff == 0) {
6530 ERROR("MISSING_SIGN_OFF",
6531 "Missing Signed-off-by: line(s)\n");
6532 } elsif (!$authorsignoff) {
6533 WARN("NO_AUTHOR_SIGN_OFF",
6534 "Missing Signed-off-by: line by nominal patch author '$author'\n");
6538 print report_dump();
6539 if ($summary && !($clean == 1 && $quiet == 1)) {
6540 print "$filename " if ($summary_file);
6541 print "total: $cnt_error errors, $cnt_warn warnings, " .
6542 (($check)? "$cnt_chk checks, " : "") .
6543 "$cnt_lines lines checked\n";
6547 # If there were any defects found and not already fixing them
6548 if (!$clean and !$fix) {
6551 NOTE: For some of the reported defects, checkpatch may be able to
6552 mechanically convert to the typical style using --fix or --fix-inplace.
6555 # If there were whitespace errors which cleanpatch can fix
6556 # then suggest that.
6557 if ($rpt_cleaners) {
6561 NOTE: Whitespace errors detected.
6562 You may wish to use scripts/cleanpatch or scripts/cleanfile
6567 if ($clean == 0 && $fix &&
6568 ("@rawlines" ne "@fixed" ||
6569 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
6570 my $newfile = $filename;
6571 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
6575 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6577 open($f, '>', $newfile)
6578 or die "$P: Can't open $newfile for write\n";
6579 foreach my $fixed_line (@fixed) {
6582 if ($linecount > 3) {
6583 $fixed_line =~ s/^\+//;
6584 print $f $fixed_line . "\n";
6587 print $f $fixed_line . "\n";
6595 Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6597 Do _NOT_ trust the results written to this file.
6598 Do _NOT_ submit these changes without inspecting them for correctness.
6600 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6601 No warranties, expressed or implied...
6609 print "$vname has no obvious style problems and is ready for submission.\n";
6611 print "$vname has style problems, please review.\n";