2 # (c) 2001, Dave Jones. (the file handling bit)
3 # (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
4 # (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
5 # (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
6 # Licensed under the terms of the GNU GPL License version 2
13 use Term::ANSIColor qw(:constants);
16 my $D = dirname(abs_path($P));
20 use Getopt::Long qw(:config no_auto_abbrev);
50 my $configuration_file = ".checkpatch.conf";
51 my $max_line_length = 80;
52 my $ignore_perl_version = 0;
53 my $minimum_perl_version = 5.10.0;
54 my $min_conf_desc_length = 4;
55 my $spelling_file = "$D/spelling.txt";
57 my $codespellfile = "/usr/share/codespell/dictionary.txt";
58 my $conststructsfile = "$D/const_structs.checkpatch";
59 my $typedefsfile = "";
61 my $allow_c99_comments = 1;
67 Usage: $P [OPTION]... [FILE]...
72 --no-tree run without a kernel tree
73 --no-signoff do not check for 'Signed-off-by' line
74 --patch treat FILE as patchfile (default)
75 --emacs emacs compile window format
76 --terse one line per report
77 --showfile emit diffed file position, not input file position
78 -g, --git treat FILE as a single commit or git revision range
79 single git commit with:
83 multiple git commits with:
87 git merges are ignored
88 -f, --file treat FILE as regular source file
89 --subjective, --strict enable more subjective tests
90 --list-types list the possible message types
91 --types TYPE(,TYPE2...) show only these comma separated message types
92 --ignore TYPE(,TYPE2...) ignore various comma separated message types
93 --show-types show the specific message type in the output
94 --max-line-length=n set the maximum line length, if exceeded, warn
95 --min-conf-desc-length=n set the min description length, if shorter, warn
96 --root=PATH PATH to the kernel tree root
97 --no-summary suppress the per-file summary
98 --mailback only produce a report in case of warnings/errors
99 --summary-file include the filename in summary
100 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
101 'values', 'possible', 'type', and 'attr' (default
103 --test-only=WORD report only warnings/errors containing WORD
105 --fix EXPERIMENTAL - may create horrible results
106 If correctable single-line errors exist, create
107 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
108 with potential errors corrected to the preferred
110 --fix-inplace EXPERIMENTAL - may create horrible results
111 Is the same as --fix, but overwrites the input
112 file. It's your fault if there's no backup or git
113 --ignore-perl-version override checking of perl version. expect
115 --codespell Use the codespell dictionary for spelling/typos
116 (default:/usr/share/codespell/dictionary.txt)
117 --codespellfile Use this codespell dictionary
118 --typedefsfile Read additional types from this file
119 --color[=WHEN] Use colors 'always', 'never', or only when output
120 is a terminal ('auto'). Default is 'auto'.
121 -h, --help, --version display this help and exit
123 When FILE is - read standard input.
131 return grep { !$seen{$_}++ } @_;
141 open(my $script, '<', abs_path($P)) or
142 die "$P: Can't read '$P' $!\n";
144 my $text = <$script>;
148 # Also catch when type or level is passed through a variable
149 for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
152 @types = sort(uniq(@types));
153 print("#\tMessage type\n\n");
154 foreach my $type (@types) {
155 print(++$count . "\t" . $type . "\n");
161 my $conf = which_conf($configuration_file);
164 open(my $conffile, '<', "$conf")
165 or warn "$P: Can't find a readable $configuration_file file $!\n";
167 while (<$conffile>) {
170 $line =~ s/\s*\n?$//g;
174 next if ($line =~ m/^\s*#/);
175 next if ($line =~ m/^\s*$/);
177 my @words = split(" ", $line);
178 foreach my $word (@words) {
179 last if ($word =~ m/^#/);
180 push (@conf_args, $word);
184 unshift(@ARGV, @conf_args) if @conf_args;
187 # Perl's Getopt::Long allows options to take optional arguments after a space.
188 # Prevent --color by itself from consuming other arguments
190 if ($_ eq "--color" || $_ eq "-color") {
191 $_ = "--color=$color";
196 'q|quiet+' => \$quiet,
198 'signoff!' => \$chk_signoff,
199 'patch!' => \$chk_patch,
202 'showfile!' => \$showfile,
205 'subjective!' => \$check,
206 'strict!' => \$check,
207 'ignore=s' => \@ignore,
209 'show-types!' => \$show_types,
210 'list-types!' => \$list_types,
211 'max-line-length=i' => \$max_line_length,
212 'min-conf-desc-length=i' => \$min_conf_desc_length,
214 'summary!' => \$summary,
215 'mailback!' => \$mailback,
216 'summary-file!' => \$summary_file,
218 'fix-inplace!' => \$fix_inplace,
219 'ignore-perl-version!' => \$ignore_perl_version,
220 'debug=s' => \%debug,
221 'test-only=s' => \$tst_only,
222 'codespell!' => \$codespell,
223 'codespellfile=s' => \$codespellfile,
224 'typedefsfile=s' => \$typedefsfile,
225 'color=s' => \$color,
226 'no-color' => \$color, #keep old behaviors of -nocolor
227 'nocolor' => \$color, #keep old behaviors of -nocolor
234 list_types(0) if ($list_types);
236 $fix = 1 if ($fix_inplace);
237 $check_orig = $check;
241 if ($^V && $^V lt $minimum_perl_version) {
242 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
243 if (!$ignore_perl_version) {
248 #if no filenames are given, push '-' to read patch from stdin
253 if ($color =~ /^[01]$/) {
255 } elsif ($color =~ /^always$/i) {
257 } elsif ($color =~ /^never$/i) {
259 } elsif ($color =~ /^auto$/i) {
260 $color = (-t STDOUT);
262 die "Invalid color mode: $color\n";
265 sub hash_save_array_words {
266 my ($hashRef, $arrayRef) = @_;
268 my @array = split(/,/, join(',', @$arrayRef));
269 foreach my $word (@array) {
270 $word =~ s/\s*\n?$//g;
273 $word =~ tr/[a-z]/[A-Z]/;
275 next if ($word =~ m/^\s*#/);
276 next if ($word =~ m/^\s*$/);
282 sub hash_show_words {
283 my ($hashRef, $prefix) = @_;
285 if (keys %$hashRef) {
286 print "\nNOTE: $prefix message types:";
287 foreach my $word (sort keys %$hashRef) {
294 hash_save_array_words(\%ignore_type, \@ignore);
295 hash_save_array_words(\%use_type, \@use);
298 my $dbg_possible = 0;
301 for my $key (keys %debug) {
303 eval "\${dbg_$key} = '$debug{$key}';";
307 my $rpt_cleaners = 0;
316 if (!top_of_kernel_tree($root)) {
317 die "$P: $root: --root does not point at a valid tree\n";
320 if (top_of_kernel_tree('.')) {
322 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
323 top_of_kernel_tree($1)) {
328 if (!defined $root) {
329 print "Must be run from the top-level dir. of a kernel tree\n";
334 my $emitted_corrupt = 0;
337 [A-Za-z_][A-Za-z\d_]*
338 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
340 our $Storage = qr{extern|static|asmlinkage};
353 our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
354 our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
355 our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
356 our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
357 our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
359 # Notes to $Attribute:
360 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
381 ____cacheline_aligned|
382 ____cacheline_aligned_in_smp|
383 ____cacheline_internodealigned_in_smp|
387 our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
388 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
389 our $Lval = qr{$Ident(?:$Member)*};
391 our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
392 our $Binary = qr{(?i)0b[01]+$Int_type?};
393 our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
394 our $Int = qr{[0-9]+$Int_type?};
395 our $Octal = qr{0[0-7]+$Int_type?};
396 our $String = qr{"[X\t]*"};
397 our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
398 our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
399 our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
400 our $Float = qr{$Float_hex|$Float_dec|$Float_int};
401 our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
402 our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
403 our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
404 our $Arithmetic = qr{\+|-|\*|\/|%};
408 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
411 our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
415 our $NonptrTypeMisordered;
416 our $NonptrTypeWithAttr;
420 our $DeclareMisordered;
422 our $NON_ASCII_UTF8 = qr{
423 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
424 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
425 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
426 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
427 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
428 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
429 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
433 [\x09\x0A\x0D\x20-\x7E] # ASCII
437 our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
438 our $typeOtherOSTypedefs = qr{(?x:
439 u_(?:char|short|int|long) | # bsd
440 u(?:nchar|short|int|long) # sysv
442 our $typeKernelTypedefs = qr{(?x:
443 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
446 our $typeTypedefs = qr{(?x:
448 $typeOtherOSTypedefs\b|
449 $typeKernelTypedefs\b
452 our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
454 our $logFunctions = qr{(?x:
455 printk(?:_ratelimited|_once|_deferred_once|_deferred|)|
456 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
458 WARN(?:_RATELIMIT|_ONCE|)|
461 seq_vprintf|seq_printf|seq_puts
464 our $signature_tags = qr{(?xi:
475 our @typeListMisordered = (
476 qr{char\s+(?:un)?signed},
477 qr{int\s+(?:(?:un)?signed\s+)?short\s},
478 qr{int\s+short(?:\s+(?:un)?signed)},
479 qr{short\s+int(?:\s+(?:un)?signed)},
480 qr{(?:un)?signed\s+int\s+short},
481 qr{short\s+(?:un)?signed},
482 qr{long\s+int\s+(?:un)?signed},
483 qr{int\s+long\s+(?:un)?signed},
484 qr{long\s+(?:un)?signed\s+int},
485 qr{int\s+(?:un)?signed\s+long},
486 qr{int\s+(?:un)?signed},
487 qr{int\s+long\s+long\s+(?:un)?signed},
488 qr{long\s+long\s+int\s+(?:un)?signed},
489 qr{long\s+long\s+(?:un)?signed\s+int},
490 qr{long\s+long\s+(?:un)?signed},
491 qr{long\s+(?:un)?signed},
496 qr{(?:(?:un)?signed\s+)?char},
497 qr{(?:(?:un)?signed\s+)?short\s+int},
498 qr{(?:(?:un)?signed\s+)?short},
499 qr{(?:(?:un)?signed\s+)?int},
500 qr{(?:(?:un)?signed\s+)?long\s+int},
501 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
502 qr{(?:(?:un)?signed\s+)?long\s+long},
503 qr{(?:(?:un)?signed\s+)?long},
512 qr{${Ident}_handler},
513 qr{${Ident}_handler_fn},
517 our $C90_int_types = qr{(?x:
518 long\s+long\s+int\s+(?:un)?signed|
519 long\s+long\s+(?:un)?signed\s+int|
520 long\s+long\s+(?:un)?signed|
521 (?:(?:un)?signed\s+)?long\s+long\s+int|
522 (?:(?:un)?signed\s+)?long\s+long|
523 int\s+long\s+long\s+(?:un)?signed|
524 int\s+(?:(?:un)?signed\s+)?long\s+long|
526 long\s+int\s+(?:un)?signed|
527 long\s+(?:un)?signed\s+int|
528 long\s+(?:un)?signed|
529 (?:(?:un)?signed\s+)?long\s+int|
530 (?:(?:un)?signed\s+)?long|
531 int\s+long\s+(?:un)?signed|
532 int\s+(?:(?:un)?signed\s+)?long|
535 (?:(?:un)?signed\s+)?int
538 our @typeListFile = ();
539 our @typeListWithAttr = (
541 qr{struct\s+$InitAttribute\s+$Ident},
542 qr{union\s+$InitAttribute\s+$Ident},
545 our @modifierList = (
548 our @modifierListFile = ();
550 our @mode_permission_funcs = (
552 ["module_param_(?:array|named|string)", 4],
553 ["module_param_array_named", 5],
554 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
555 ["proc_create(?:_data|)", 2],
556 ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2],
557 ["IIO_DEV_ATTR_[A-Z_]+", 1],
558 ["SENSOR_(?:DEVICE_|)ATTR_2", 2],
559 ["SENSOR_TEMPLATE(?:_2|)", 3],
563 #Create a search pattern for all these functions to speed up a loop below
564 our $mode_perms_search = "";
565 foreach my $entry (@mode_permission_funcs) {
566 $mode_perms_search .= '|' if ($mode_perms_search ne "");
567 $mode_perms_search .= $entry->[0];
569 $mode_perms_search = "(?:${mode_perms_search})";
571 our $mode_perms_world_writable = qr{
579 our %mode_permission_string_types = (
598 #Create a search pattern for all these strings to speed up a loop below
599 our $mode_perms_string_search = "";
600 foreach my $entry (keys %mode_permission_string_types) {
601 $mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
602 $mode_perms_string_search .= $entry;
604 our $single_mode_perms_string_search = "(?:${mode_perms_string_search})";
605 our $multi_mode_perms_string_search = qr{
606 ${single_mode_perms_string_search}
607 (?:\s*\|\s*${single_mode_perms_string_search})*
613 return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/);
620 while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
621 $curpos = pos($string);
624 last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
626 $to |= $mode_permission_string_types{$match};
627 $val .= '\s*\|\s*' if ($val ne "");
631 $oval =~ s/^\s*\|\s*//;
632 $oval =~ s/\s*\|\s*$//;
633 return sprintf("%04o", $to);
636 our $allowed_asm_includes = qr{(?x:
642 # memory.h: ARM has a custom one
644 # Load common spelling mistakes and build regular expression list.
648 if (open(my $spelling, '<', $spelling_file)) {
649 while (<$spelling>) {
652 $line =~ s/\s*\n?$//g;
655 next if ($line =~ m/^\s*#/);
656 next if ($line =~ m/^\s*$/);
658 my ($suspect, $fix) = split(/\|\|/, $line);
660 $spelling_fix{$suspect} = $fix;
664 warn "No typos will be found - file '$spelling_file': $!\n";
668 if (open(my $spelling, '<', $codespellfile)) {
669 while (<$spelling>) {
672 $line =~ s/\s*\n?$//g;
675 next if ($line =~ m/^\s*#/);
676 next if ($line =~ m/^\s*$/);
677 next if ($line =~ m/, disabled/i);
681 my ($suspect, $fix) = split(/->/, $line);
683 $spelling_fix{$suspect} = $fix;
687 warn "No codespell typos will be found - file '$codespellfile': $!\n";
691 $misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
694 my ($wordsRef, $file) = @_;
696 if (open(my $words, '<', $file)) {
700 $line =~ s/\s*\n?$//g;
703 next if ($line =~ m/^\s*#/);
704 next if ($line =~ m/^\s*$/);
706 print("$file: '$line' invalid - ignored\n");
710 $$wordsRef .= '|' if ($$wordsRef ne "");
720 my $const_structs = "";
721 read_words(\$const_structs, $conststructsfile)
722 or warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
724 my $typeOtherTypedefs = "";
725 if (length($typedefsfile)) {
726 read_words(\$typeOtherTypedefs, $typedefsfile)
727 or warn "No additional types will be considered - file '$typedefsfile': $!\n";
729 $typeTypedefs .= '|' . $typeOtherTypedefs if ($typeOtherTypedefs ne "");
732 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
733 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
734 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
735 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
736 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
742 (?:$Modifier\s+|const\s+)*
744 (?:typeof|__typeof__)\s*\([^\)]*\)|
748 (?:\s+$Modifier|\s+const)*
750 $NonptrTypeMisordered = qr{
751 (?:$Modifier\s+|const\s+)*
755 (?:\s+$Modifier|\s+const)*
757 $NonptrTypeWithAttr = qr{
758 (?:$Modifier\s+|const\s+)*
760 (?:typeof|__typeof__)\s*\([^\)]*\)|
764 (?:\s+$Modifier|\s+const)*
768 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
769 (?:\s+$Inline|\s+$Modifier)*
771 $TypeMisordered = qr{
772 $NonptrTypeMisordered
773 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
774 (?:\s+$Inline|\s+$Modifier)*
776 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
777 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
781 our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
783 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
784 # requires at least perl version v5.10.0
785 # Any use must be runtime checked with $^V
787 our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
788 our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
789 our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
791 our $declaration_macros = qr{(?x:
792 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
793 (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(|
794 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
799 return "" if (!defined($string));
801 while ($string =~ /^\s*\(.*\)\s*$/) {
802 $string =~ s@^\s*\(\s*@@;
803 $string =~ s@\s*\)\s*$@@;
806 $string =~ s@\s+@ @g;
811 sub seed_camelcase_file {
814 return if (!(-f $file));
818 open(my $include_file, '<', "$file")
819 or warn "$P: Can't read '$file' $!\n";
820 my $text = <$include_file>;
821 close($include_file);
823 my @lines = split('\n', $text);
825 foreach my $line (@lines) {
826 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
827 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
829 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
831 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
837 sub is_maintained_obsolete {
840 return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl"));
842 my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
844 return $status =~ /obsolete/i;
847 my $camelcase_seeded = 0;
848 sub seed_camelcase_includes {
849 return if ($camelcase_seeded);
852 my $camelcase_cache = "";
853 my @include_files = ();
855 $camelcase_seeded = 1;
858 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
859 chomp $git_last_include_commit;
860 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
862 my $last_mod_date = 0;
863 $files = `find $root/include -name "*.h"`;
864 @include_files = split('\n', $files);
865 foreach my $file (@include_files) {
866 my $date = POSIX::strftime("%Y%m%d%H%M",
867 localtime((stat $file)[9]));
868 $last_mod_date = $date if ($last_mod_date < $date);
870 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
873 if ($camelcase_cache ne "" && -f $camelcase_cache) {
874 open(my $camelcase_file, '<', "$camelcase_cache")
875 or warn "$P: Can't read '$camelcase_cache' $!\n";
876 while (<$camelcase_file>) {
880 close($camelcase_file);
886 $files = `git ls-files "include/*.h"`;
887 @include_files = split('\n', $files);
890 foreach my $file (@include_files) {
891 seed_camelcase_file($file);
894 if ($camelcase_cache ne "") {
895 unlink glob ".checkpatch-camelcase.*";
896 open(my $camelcase_file, '>', "$camelcase_cache")
897 or warn "$P: Can't write '$camelcase_cache' $!\n";
898 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
899 print $camelcase_file ("$_\n");
901 close($camelcase_file);
905 sub git_commit_info {
906 my ($commit, $id, $desc) = @_;
908 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
910 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
911 $output =~ s/^\s*//gm;
912 my @lines = split("\n", $output);
914 return ($id, $desc) if ($#lines < 0);
916 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
917 # Maybe one day convert this block of bash into something that returns
918 # all matching commit ids, but it's very slow...
920 # echo "checking commits $1..."
921 # git rev-list --remotes | grep -i "^$1" |
922 # while read line ; do
923 # git log --format='%H %s' -1 $line |
924 # echo "commit $(cut -c 1-12,41-)"
926 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
929 $id = substr($lines[0], 0, 12);
930 $desc = substr($lines[0], 41);
936 $chk_signoff = 0 if ($file);
941 my @fixed_inserted = ();
942 my @fixed_deleted = ();
945 # If input is git commits, extract all commits from the commit expressions.
946 # For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
947 die "$P: No git repository found\n" if ($git && !-e ".git");
951 foreach my $commit_expr (@ARGV) {
953 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
954 $git_range = "-$2 $1";
955 } elsif ($commit_expr =~ m/\.\./) {
956 $git_range = "$commit_expr";
958 $git_range = "-1 $commit_expr";
960 my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
961 foreach my $line (split(/\n/, $lines)) {
962 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
963 next if (!defined($1) || !defined($2));
966 unshift(@commits, $sha1);
967 $git_commits{$sha1} = $subject;
970 die "$P: no git commits after extraction!\n" if (@commits == 0);
975 for my $filename (@ARGV) {
978 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
979 die "$P: $filename: git format-patch failed - $!\n";
981 open($FILE, '-|', "diff -u /dev/null $filename") ||
982 die "$P: $filename: diff failed - $!\n";
983 } elsif ($filename eq '-') {
984 open($FILE, '<&STDIN');
986 open($FILE, '<', "$filename") ||
987 die "$P: $filename: open failed - $!\n";
989 if ($filename eq '-') {
990 $vname = 'Your patch';
992 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
1002 if ($#ARGV > 0 && $quiet == 0) {
1003 print '-' x length($vname) . "\n";
1005 print '-' x length($vname) . "\n";
1008 if (!process($filename)) {
1014 @fixed_inserted = ();
1015 @fixed_deleted = ();
1017 @modifierListFile = ();
1023 hash_show_words(\%use_type, "Used");
1024 hash_show_words(\%ignore_type, "Ignored");
1026 if ($^V lt 5.10.0) {
1029 NOTE: perl $^V is not modern enough to detect all possible issues.
1030 An upgrade to at least perl v5.10.0 is suggested.
1036 NOTE: If any of the errors are false positives, please report
1037 them to the maintainer, see CHECKPATCH in MAINTAINERS.
1044 sub top_of_kernel_tree {
1048 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
1049 "README", "Documentation", "arch", "include", "drivers",
1050 "fs", "init", "ipc", "kernel", "lib", "scripts",
1053 foreach my $check (@tree_check) {
1054 if (! -e $root . '/' . $check) {
1062 my ($formatted_email) = @_;
1068 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
1071 $comment = $3 if defined $3;
1072 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
1074 $comment = $2 if defined $2;
1075 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
1077 $comment = $2 if defined $2;
1078 $formatted_email =~ s/$address.*$//;
1079 $name = $formatted_email;
1080 $name = trim($name);
1081 $name =~ s/^\"|\"$//g;
1082 # If there's a name left after stripping spaces and
1083 # leading quotes, and the address doesn't have both
1084 # leading and trailing angle brackets, the address
1086 # "joe smith joe@smith.com" bad
1087 # "joe smith <joe@smith.com" bad
1088 if ($name ne "" && $address !~ /^<[^>]+>$/) {
1095 $name = trim($name);
1096 $name =~ s/^\"|\"$//g;
1097 $address = trim($address);
1098 $address =~ s/^\<|\>$//g;
1100 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1101 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1102 $name = "\"$name\"";
1105 return ($name, $address, $comment);
1109 my ($name, $address) = @_;
1111 my $formatted_email;
1113 $name = trim($name);
1114 $name =~ s/^\"|\"$//g;
1115 $address = trim($address);
1117 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1118 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1119 $name = "\"$name\"";
1122 if ("$name" eq "") {
1123 $formatted_email = "$address";
1125 $formatted_email = "$name <$address>";
1128 return $formatted_email;
1134 foreach my $path (split(/:/, $ENV{PATH})) {
1135 if (-e "$path/$bin") {
1136 return "$path/$bin";
1146 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1147 if (-e "$path/$conf") {
1148 return "$path/$conf";
1160 for my $c (split(//, $str)) {
1164 for (; ($n % 8) != 0; $n++) {
1176 (my $res = shift) =~ tr/\t/ /c;
1183 # Drop the diff line leader and expand tabs
1185 $line = expand_tabs($line);
1187 # Pick the indent from the front of the line.
1188 my ($white) = ($line =~ /^(\s*)/);
1190 return (length($line), length($white));
1193 my $sanitise_quote = '';
1195 sub sanitise_line_reset {
1196 my ($in_comment) = @_;
1199 $sanitise_quote = '*/';
1201 $sanitise_quote = '';
1214 # Always copy over the diff marker.
1215 $res = substr($line, 0, 1);
1217 for ($off = 1; $off < length($line); $off++) {
1218 $c = substr($line, $off, 1);
1220 # Comments we are wacking completly including the begin
1221 # and end, all to $;.
1222 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1223 $sanitise_quote = '*/';
1225 substr($res, $off, 2, "$;$;");
1229 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
1230 $sanitise_quote = '';
1231 substr($res, $off, 2, "$;$;");
1235 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1236 $sanitise_quote = '//';
1238 substr($res, $off, 2, $sanitise_quote);
1243 # A \ in a string means ignore the next character.
1244 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1246 substr($res, $off, 2, 'XX');
1251 if ($c eq "'" || $c eq '"') {
1252 if ($sanitise_quote eq '') {
1253 $sanitise_quote = $c;
1255 substr($res, $off, 1, $c);
1257 } elsif ($sanitise_quote eq $c) {
1258 $sanitise_quote = '';
1262 #print "c<$c> SQ<$sanitise_quote>\n";
1263 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1264 substr($res, $off, 1, $;);
1265 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1266 substr($res, $off, 1, $;);
1267 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1268 substr($res, $off, 1, 'X');
1270 substr($res, $off, 1, $c);
1274 if ($sanitise_quote eq '//') {
1275 $sanitise_quote = '';
1278 # The pathname on a #include may be surrounded by '<' and '>'.
1279 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
1280 my $clean = 'X' x length($1);
1281 $res =~ s@\<.*\>@<$clean>@;
1283 # The whole of a #error is a string.
1284 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
1285 my $clean = 'X' x length($1);
1286 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
1289 if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1291 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1297 sub get_quoted_string {
1298 my ($line, $rawline) = @_;
1300 return "" if ($line !~ m/($String)/g);
1301 return substr($rawline, $-[0], $+[0] - $-[0]);
1304 sub ctx_statement_block {
1305 my ($linenr, $remain, $off) = @_;
1306 my $line = $linenr - 1;
1309 my $coff = $off - 1;
1323 @stack = (['', 0]) if ($#stack == -1);
1325 #warn "CSB: blk<$blk> remain<$remain>\n";
1326 # If we are about to drop off the end, pull in more
1329 for (; $remain > 0; $line++) {
1330 last if (!defined $lines[$line]);
1331 next if ($lines[$line] =~ /^-/);
1334 $blk .= $lines[$line] . "\n";
1335 $len = length($blk);
1339 # Bail if there is no further context.
1340 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1344 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1350 $c = substr($blk, $off, 1);
1351 $remainder = substr($blk, $off);
1353 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1355 # Handle nested #if/#else.
1356 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1357 push(@stack, [ $type, $level ]);
1358 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1359 ($type, $level) = @{$stack[$#stack - 1]};
1360 } elsif ($remainder =~ /^#\s*endif\b/) {
1361 ($type, $level) = @{pop(@stack)};
1364 # Statement ends at the ';' or a close '}' at the
1366 if ($level == 0 && $c eq ';') {
1370 # An else is really a conditional as long as its not else if
1371 if ($level == 0 && $coff_set == 0 &&
1372 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1373 $remainder =~ /^(else)(?:\s|{)/ &&
1374 $remainder !~ /^else\s+if\b/) {
1375 $coff = $off + length($1) - 1;
1377 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1378 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1381 if (($type eq '' || $type eq '(') && $c eq '(') {
1385 if ($type eq '(' && $c eq ')') {
1387 $type = ($level != 0)? '(' : '';
1389 if ($level == 0 && $coff < $soff) {
1392 #warn "CSB: mark coff<$coff>\n";
1395 if (($type eq '' || $type eq '{') && $c eq '{') {
1399 if ($type eq '{' && $c eq '}') {
1401 $type = ($level != 0)? '{' : '';
1404 if (substr($blk, $off + 1, 1) eq ';') {
1410 # Preprocessor commands end at the newline unless escaped.
1411 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1419 # We are truly at the end, so shuffle to the next line.
1426 my $statement = substr($blk, $soff, $off - $soff + 1);
1427 my $condition = substr($blk, $soff, $coff - $soff + 1);
1429 #warn "STATEMENT<$statement>\n";
1430 #warn "CONDITION<$condition>\n";
1432 #print "coff<$coff> soff<$off> loff<$loff>\n";
1434 return ($statement, $condition,
1435 $line, $remain + 1, $off - $loff + 1, $level);
1438 sub statement_lines {
1441 # Strip the diff line prefixes and rip blank lines at start and end.
1442 $stmt =~ s/(^|\n)./$1/g;
1446 my @stmt_lines = ($stmt =~ /\n/g);
1448 return $#stmt_lines + 2;
1451 sub statement_rawlines {
1454 my @stmt_lines = ($stmt =~ /\n/g);
1456 return $#stmt_lines + 2;
1459 sub statement_block_size {
1462 $stmt =~ s/(^|\n)./$1/g;
1468 my @stmt_lines = ($stmt =~ /\n/g);
1469 my @stmt_statements = ($stmt =~ /;/g);
1471 my $stmt_lines = $#stmt_lines + 2;
1472 my $stmt_statements = $#stmt_statements + 1;
1474 if ($stmt_lines > $stmt_statements) {
1477 return $stmt_statements;
1481 sub ctx_statement_full {
1482 my ($linenr, $remain, $off) = @_;
1483 my ($statement, $condition, $level);
1487 # Grab the first conditional/block pair.
1488 ($statement, $condition, $linenr, $remain, $off, $level) =
1489 ctx_statement_block($linenr, $remain, $off);
1490 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1491 push(@chunks, [ $condition, $statement ]);
1492 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1493 return ($level, $linenr, @chunks);
1496 # Pull in the following conditional/block pairs and see if they
1497 # could continue the statement.
1499 ($statement, $condition, $linenr, $remain, $off, $level) =
1500 ctx_statement_block($linenr, $remain, $off);
1501 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1502 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1504 push(@chunks, [ $condition, $statement ]);
1507 return ($level, $linenr, @chunks);
1511 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1513 my $start = $linenr - 1;
1520 my @stack = ($level);
1521 for ($line = $start; $remain > 0; $line++) {
1522 next if ($rawlines[$line] =~ /^-/);
1525 $blk .= $rawlines[$line];
1527 # Handle nested #if/#else.
1528 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1529 push(@stack, $level);
1530 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1531 $level = $stack[$#stack - 1];
1532 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1533 $level = pop(@stack);
1536 foreach my $c (split(//, $lines[$line])) {
1537 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1543 if ($c eq $close && $level > 0) {
1545 last if ($level == 0);
1546 } elsif ($c eq $open) {
1551 if (!$outer || $level <= 1) {
1552 push(@res, $rawlines[$line]);
1555 last if ($level == 0);
1558 return ($level, @res);
1560 sub ctx_block_outer {
1561 my ($linenr, $remain) = @_;
1563 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1567 my ($linenr, $remain) = @_;
1569 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1573 my ($linenr, $remain, $off) = @_;
1575 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1578 sub ctx_block_level {
1579 my ($linenr, $remain) = @_;
1581 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1583 sub ctx_statement_level {
1584 my ($linenr, $remain, $off) = @_;
1586 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1589 sub ctx_locate_comment {
1590 my ($first_line, $end_line) = @_;
1592 # Catch a comment on the end of the line itself.
1593 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1594 return $current_comment if (defined $current_comment);
1596 # Look through the context and try and figure out if there is a
1599 $current_comment = '';
1600 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1601 my $line = $rawlines[$linenr - 1];
1603 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1606 if ($line =~ m@/\*@) {
1609 if (!$in_comment && $current_comment ne '') {
1610 $current_comment = '';
1612 $current_comment .= $line . "\n" if ($in_comment);
1613 if ($line =~ m@\*/@) {
1618 chomp($current_comment);
1619 return($current_comment);
1621 sub ctx_has_comment {
1622 my ($first_line, $end_line) = @_;
1623 my $cmt = ctx_locate_comment($first_line, $end_line);
1625 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1626 ##print "CMMT: $cmt\n";
1628 return ($cmt ne '');
1632 my ($linenr, $cnt) = @_;
1634 my $offset = $linenr - 1;
1639 $line = $rawlines[$offset++];
1640 next if (defined($line) && $line =~ /^-/);
1652 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1655 $coded = sprintf("^%c", unpack('C', $2) + 64);
1664 my $av_preprocessor = 0;
1669 sub annotate_reset {
1670 $av_preprocessor = 0;
1672 @av_paren_type = ('E');
1673 $av_pend_colon = 'O';
1676 sub annotate_values {
1677 my ($stream, $type) = @_;
1680 my $var = '_' x length($stream);
1683 print "$stream\n" if ($dbg_values > 1);
1685 while (length($cur)) {
1686 @av_paren_type = ('E') if ($#av_paren_type < 0);
1687 print " <" . join('', @av_paren_type) .
1688 "> <$type> <$av_pending>" if ($dbg_values > 1);
1689 if ($cur =~ /^(\s+)/o) {
1690 print "WS($1)\n" if ($dbg_values > 1);
1691 if ($1 =~ /\n/ && $av_preprocessor) {
1692 $type = pop(@av_paren_type);
1693 $av_preprocessor = 0;
1696 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1697 print "CAST($1)\n" if ($dbg_values > 1);
1698 push(@av_paren_type, $type);
1701 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1702 print "DECLARE($1)\n" if ($dbg_values > 1);
1705 } elsif ($cur =~ /^($Modifier)\s*/) {
1706 print "MODIFIER($1)\n" if ($dbg_values > 1);
1709 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1710 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1711 $av_preprocessor = 1;
1712 push(@av_paren_type, $type);
1718 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1719 print "UNDEF($1)\n" if ($dbg_values > 1);
1720 $av_preprocessor = 1;
1721 push(@av_paren_type, $type);
1723 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1724 print "PRE_START($1)\n" if ($dbg_values > 1);
1725 $av_preprocessor = 1;
1727 push(@av_paren_type, $type);
1728 push(@av_paren_type, $type);
1731 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1732 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1733 $av_preprocessor = 1;
1735 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1739 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1740 print "PRE_END($1)\n" if ($dbg_values > 1);
1742 $av_preprocessor = 1;
1744 # Assume all arms of the conditional end as this
1745 # one does, and continue as if the #endif was not here.
1746 pop(@av_paren_type);
1747 push(@av_paren_type, $type);
1750 } elsif ($cur =~ /^(\\\n)/o) {
1751 print "PRECONT($1)\n" if ($dbg_values > 1);
1753 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1754 print "ATTR($1)\n" if ($dbg_values > 1);
1755 $av_pending = $type;
1758 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1759 print "SIZEOF($1)\n" if ($dbg_values > 1);
1765 } elsif ($cur =~ /^(if|while|for)\b/o) {
1766 print "COND($1)\n" if ($dbg_values > 1);
1770 } elsif ($cur =~/^(case)/o) {
1771 print "CASE($1)\n" if ($dbg_values > 1);
1772 $av_pend_colon = 'C';
1775 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1776 print "KEYWORD($1)\n" if ($dbg_values > 1);
1779 } elsif ($cur =~ /^(\()/o) {
1780 print "PAREN('$1')\n" if ($dbg_values > 1);
1781 push(@av_paren_type, $av_pending);
1785 } elsif ($cur =~ /^(\))/o) {
1786 my $new_type = pop(@av_paren_type);
1787 if ($new_type ne '_') {
1789 print "PAREN('$1') -> $type\n"
1790 if ($dbg_values > 1);
1792 print "PAREN('$1')\n" if ($dbg_values > 1);
1795 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1796 print "FUNC($1)\n" if ($dbg_values > 1);
1800 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1801 if (defined $2 && $type eq 'C' || $type eq 'T') {
1802 $av_pend_colon = 'B';
1803 } elsif ($type eq 'E') {
1804 $av_pend_colon = 'L';
1806 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1809 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1810 print "IDENT($1)\n" if ($dbg_values > 1);
1813 } elsif ($cur =~ /^($Assignment)/o) {
1814 print "ASSIGN($1)\n" if ($dbg_values > 1);
1817 } elsif ($cur =~/^(;|{|})/) {
1818 print "END($1)\n" if ($dbg_values > 1);
1820 $av_pend_colon = 'O';
1822 } elsif ($cur =~/^(,)/) {
1823 print "COMMA($1)\n" if ($dbg_values > 1);
1826 } elsif ($cur =~ /^(\?)/o) {
1827 print "QUESTION($1)\n" if ($dbg_values > 1);
1830 } elsif ($cur =~ /^(:)/o) {
1831 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1833 substr($var, length($res), 1, $av_pend_colon);
1834 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1839 $av_pend_colon = 'O';
1841 } elsif ($cur =~ /^(\[)/o) {
1842 print "CLOSE($1)\n" if ($dbg_values > 1);
1845 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1848 print "OPV($1)\n" if ($dbg_values > 1);
1855 substr($var, length($res), 1, $variant);
1858 } elsif ($cur =~ /^($Operators)/o) {
1859 print "OP($1)\n" if ($dbg_values > 1);
1860 if ($1 ne '++' && $1 ne '--') {
1864 } elsif ($cur =~ /(^.)/o) {
1865 print "C($1)\n" if ($dbg_values > 1);
1868 $cur = substr($cur, length($1));
1869 $res .= $type x length($1);
1873 return ($res, $var);
1877 my ($possible, $line) = @_;
1878 my $notPermitted = qr{(?:
1895 ^(?:typedef|struct|enum)\b
1897 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1898 if ($possible !~ $notPermitted) {
1899 # Check for modifiers.
1900 $possible =~ s/\s*$Storage\s*//g;
1901 $possible =~ s/\s*$Sparse\s*//g;
1902 if ($possible =~ /^\s*$/) {
1904 } elsif ($possible =~ /\s/) {
1905 $possible =~ s/\s*$Type\s*//g;
1906 for my $modifier (split(' ', $possible)) {
1907 if ($modifier !~ $notPermitted) {
1908 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1909 push(@modifierListFile, $modifier);
1914 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1915 push(@typeListFile, $possible);
1919 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1928 $type =~ tr/[a-z]/[A-Z]/;
1930 return defined $use_type{$type} if (scalar keys %use_type > 0);
1932 return !defined $ignore_type{$type};
1936 my ($level, $type, $msg) = @_;
1938 if (!show_type($type) ||
1939 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
1944 if ($level eq 'ERROR') {
1946 } elsif ($level eq 'WARNING') {
1952 $output .= $prefix . $level . ':';
1954 $output .= BLUE if ($color);
1955 $output .= "$type:";
1957 $output .= RESET if ($color);
1958 $output .= ' ' . $msg . "\n";
1961 my @lines = split("\n", $output, -1);
1962 splice(@lines, 1, 1);
1963 $output = join("\n", @lines);
1965 $output = (split('\n', $output))[0] . "\n" if ($terse);
1967 push(our @report, $output);
1976 sub fixup_current_range {
1977 my ($lineRef, $offset, $length) = @_;
1979 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1982 my $no = $o + $offset;
1983 my $nl = $l + $length;
1984 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1988 sub fix_inserted_deleted_lines {
1989 my ($linesRef, $insertedRef, $deletedRef) = @_;
1991 my $range_last_linenr = 0;
1992 my $delta_offset = 0;
1997 my $next_insert = 0;
1998 my $next_delete = 0;
2002 my $inserted = @{$insertedRef}[$next_insert++];
2003 my $deleted = @{$deletedRef}[$next_delete++];
2005 foreach my $old_line (@{$linesRef}) {
2007 my $line = $old_line; #don't modify the array
2008 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
2010 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
2011 $range_last_linenr = $new_linenr;
2012 fixup_current_range(\$line, $delta_offset, 0);
2015 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
2016 $deleted = @{$deletedRef}[$next_delete++];
2018 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
2021 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
2022 push(@lines, ${$inserted}{'LINE'});
2023 $inserted = @{$insertedRef}[$next_insert++];
2025 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
2029 push(@lines, $line);
2039 sub fix_insert_line {
2040 my ($linenr, $line) = @_;
2046 push(@fixed_inserted, $inserted);
2049 sub fix_delete_line {
2050 my ($linenr, $line) = @_;
2057 push(@fixed_deleted, $deleted);
2061 my ($type, $msg) = @_;
2063 if (report("ERROR", $type, $msg)) {
2071 my ($type, $msg) = @_;
2073 if (report("WARNING", $type, $msg)) {
2081 my ($type, $msg) = @_;
2083 if ($check && report("CHECK", $type, $msg)) {
2091 sub check_absolute_file {
2092 my ($absolute, $herecurr) = @_;
2093 my $file = $absolute;
2095 ##print "absolute<$absolute>\n";
2097 # See if any suffix of this path is a path within the tree.
2098 while ($file =~ s@^[^/]*/@@) {
2099 if (-f "$root/$file") {
2100 ##print "file<$file>\n";
2108 # It is, so see if the prefix is acceptable.
2109 my $prefix = $absolute;
2110 substr($prefix, -length($file)) = '';
2112 ##print "prefix<$prefix>\n";
2113 if ($prefix ne ".../") {
2114 WARN("USE_RELATIVE_PATH",
2115 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
2122 $string =~ s/^\s+|\s+$//g;
2130 $string =~ s/^\s+//;
2138 $string =~ s/\s+$//;
2143 sub string_find_replace {
2144 my ($string, $find, $replace) = @_;
2146 $string =~ s/$find/$replace/g;
2154 my $source_indent = 8;
2155 my $max_spaces_before_tab = $source_indent - 1;
2156 my $spaces_to_tab = " " x $source_indent;
2158 #convert leading spaces to tabs
2159 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2160 #Remove spaces before a tab
2161 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2166 sub pos_last_openparen {
2171 my $opens = $line =~ tr/\(/\(/;
2172 my $closes = $line =~ tr/\)/\)/;
2174 my $last_openparen = 0;
2176 if (($opens == 0) || ($closes >= $opens)) {
2180 my $len = length($line);
2182 for ($pos = 0; $pos < $len; $pos++) {
2183 my $string = substr($line, $pos);
2184 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2185 $pos += length($1) - 1;
2186 } elsif (substr($line, $pos, 1) eq '(') {
2187 $last_openparen = $pos;
2188 } elsif (index($string, '(') == -1) {
2193 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
2197 my $filename = shift;
2203 my $stashrawline="";
2213 my $in_header_lines = $file ? 0 : 1;
2214 my $in_commit_log = 0; #Scanning lines before patch
2215 my $has_commit_log = 0; #Encountered lines before patch
2216 my $commit_log_possible_stack_dump = 0;
2217 my $commit_log_long_line = 0;
2218 my $commit_log_has_diff = 0;
2219 my $reported_maintainer_file = 0;
2220 my $non_utf8_charset = 0;
2222 my $last_blank_line = 0;
2223 my $last_coalesced_string_linenr = -1;
2231 # Trace the real file/line as we go.
2236 my $context_function; #undef'd unless there's a known function
2238 my $comment_edge = 0;
2242 my $prev_values = 'E';
2245 my %suppress_ifbraces;
2246 my %suppress_whiletrailers;
2247 my %suppress_export;
2248 my $suppress_statement = 0;
2250 my %signatures = ();
2252 # Pre-scan the patch sanitizing the lines.
2253 # Pre-scan the patch looking for any __setup documentation.
2255 my @setup_docs = ();
2258 my $camelcase_file_seeded = 0;
2260 sanitise_line_reset();
2262 foreach my $rawline (@rawlines) {
2266 push(@fixed, $rawline) if ($fix);
2268 if ($rawline=~/^\+\+\+\s+(\S+)/) {
2270 if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) {
2275 if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2284 # Guestimate if this is a continuing comment. Run
2285 # the context looking for a comment "edge". If this
2286 # edge is a close comment then we must be in a comment
2290 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2291 next if (defined $rawlines[$ln - 1] &&
2292 $rawlines[$ln - 1] =~ /^-/);
2294 #print "RAW<$rawlines[$ln - 1]>\n";
2295 last if (!defined $rawlines[$ln - 1]);
2296 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2297 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2302 if (defined $edge && $edge eq '*/') {
2306 # Guestimate if this is a continuing comment. If this
2307 # is the start of a diff block and this line starts
2308 # ' *' then it is very likely a comment.
2309 if (!defined $edge &&
2310 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
2315 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2316 sanitise_line_reset($in_comment);
2318 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
2319 # Standardise the strings and chars within the input to
2320 # simplify matching -- only bother with positive lines.
2321 $line = sanitise_line($rawline);
2323 push(@lines, $line);
2326 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2331 #print "==>$rawline\n";
2332 #print "-->$line\n";
2334 if ($setup_docs && $line =~ /^\+/) {
2335 push(@setup_docs, $line);
2344 foreach my $line (@lines) {
2347 my $sline = $line; #copy of $line
2348 $sline =~ s/$;/ /g; #with comments as spaces
2350 my $rawline = $rawlines[$linenr - 1];
2352 #extract the line range in the file after the patch is applied
2353 if (!$in_commit_log &&
2354 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2357 $first_line = $linenr + 1;
2367 %suppress_ifbraces = ();
2368 %suppress_whiletrailers = ();
2369 %suppress_export = ();
2370 $suppress_statement = 0;
2371 if ($context =~ /\b(\w+)\s*\(/) {
2372 $context_function = $1;
2374 undef $context_function;
2378 # track the line number as we move through the hunk, note that
2379 # new versions of GNU diff omit the leading space on completely
2380 # blank context lines so we need to count that too.
2381 } elsif ($line =~ /^( |\+|$)/) {
2383 $realcnt-- if ($realcnt != 0);
2385 # Measure the line length and indent.
2386 ($length, $indent) = line_stats($rawline);
2388 # Track the previous line.
2389 ($prevline, $stashline) = ($stashline, $line);
2390 ($previndent, $stashindent) = ($stashindent, $indent);
2391 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2393 #warn "line<$line>\n";
2395 } elsif ($realcnt == 1) {
2399 my $hunk_line = ($realcnt != 0);
2401 $here = "#$linenr: " if (!$file);
2402 $here = "#$realline: " if ($file);
2405 # extract the filename as it passes
2406 if ($line =~ /^diff --git.*?(\S+)$/) {
2408 $realfile =~ s@^([^/]*)/@@ if (!$file);
2411 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2413 $realfile =~ s@^([^/]*)/@@ if (!$file);
2417 if (!$file && $tree && $p1_prefix ne '' &&
2418 -e "$root/$p1_prefix") {
2419 WARN("PATCH_PREFIX",
2420 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
2423 if ($realfile =~ m@^include/asm/@) {
2424 ERROR("MODIFIED_INCLUDE_ASM",
2425 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2430 #make up the handle for any error we report on this line
2432 $prefix = "$realfile:$realline: "
2435 $prefix = "$filename:$realline: ";
2437 $prefix = "$filename:$linenr: ";
2442 if (is_maintained_obsolete($realfile)) {
2444 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2446 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
2449 $check = $check_orig;
2454 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
2456 my $hereline = "$here\n$rawline\n";
2457 my $herecurr = "$here\n$rawline\n";
2458 my $hereprev = "$here\n$prevrawline\n$rawline\n";
2460 $cnt_lines++ if ($realcnt != 0);
2462 # Check if the commit log has what seems like a diff which can confuse patch
2463 if ($in_commit_log && !$commit_log_has_diff &&
2464 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2465 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2466 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2467 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2468 ERROR("DIFF_IN_COMMIT_MSG",
2469 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2470 $commit_log_has_diff = 1;
2473 # Check for incorrect file permissions
2474 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2475 my $permhere = $here . "FILE: $realfile\n";
2476 if ($realfile !~ m@scripts/@ &&
2477 $realfile !~ /\.(py|pl|awk|sh)$/) {
2478 ERROR("EXECUTE_PERMISSIONS",
2479 "do not set execute permissions for source files\n" . $permhere);
2483 # Check the patch for a signoff:
2484 if ($line =~ /^\s*signed-off-by:/i) {
2489 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2490 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2491 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2492 $reported_maintainer_file = 1;
2495 # Check signature styles
2496 if (!$in_header_lines &&
2497 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
2498 my $space_before = $1;
2500 my $space_after = $3;
2502 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2504 if ($sign_off !~ /$signature_tags/) {
2505 WARN("BAD_SIGN_OFF",
2506 "Non-standard signature: $sign_off\n" . $herecurr);
2508 if (defined $space_before && $space_before ne "") {
2509 if (WARN("BAD_SIGN_OFF",
2510 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2512 $fixed[$fixlinenr] =
2513 "$ucfirst_sign_off $email";
2516 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
2517 if (WARN("BAD_SIGN_OFF",
2518 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2520 $fixed[$fixlinenr] =
2521 "$ucfirst_sign_off $email";
2525 if (!defined $space_after || $space_after ne " ") {
2526 if (WARN("BAD_SIGN_OFF",
2527 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2529 $fixed[$fixlinenr] =
2530 "$ucfirst_sign_off $email";
2534 my ($email_name, $email_address, $comment) = parse_email($email);
2535 my $suggested_email = format_email(($email_name, $email_address));
2536 if ($suggested_email eq "") {
2537 ERROR("BAD_SIGN_OFF",
2538 "Unrecognized email address: '$email'\n" . $herecurr);
2540 my $dequoted = $suggested_email;
2541 $dequoted =~ s/^"//;
2542 $dequoted =~ s/" </ </;
2543 # Don't force email to have quotes
2544 # Allow just an angle bracketed address
2545 if ("$dequoted$comment" ne $email &&
2546 "<$email_address>$comment" ne $email &&
2547 "$suggested_email$comment" ne $email) {
2548 WARN("BAD_SIGN_OFF",
2549 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
2553 # Check for duplicate signatures
2554 my $sig_nospace = $line;
2555 $sig_nospace =~ s/\s//g;
2556 $sig_nospace = lc($sig_nospace);
2557 if (defined $signatures{$sig_nospace}) {
2558 WARN("BAD_SIGN_OFF",
2559 "Duplicate signature\n" . $herecurr);
2561 $signatures{$sig_nospace} = 1;
2565 # Check email subject for common tools that don't need to be mentioned
2566 if ($in_header_lines &&
2567 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2568 WARN("EMAIL_SUBJECT",
2569 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2572 # Check for old stable address
2573 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2574 ERROR("STABLE_ADDRESS",
2575 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2578 # Check for unwanted Gerrit info
2579 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2580 ERROR("GERRIT_CHANGE_ID",
2581 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2584 # Check if the commit log is in a possible stack dump
2585 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2586 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2587 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2589 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2590 # stack dump address
2591 $commit_log_possible_stack_dump = 1;
2594 # Check for line lengths > 75 in commit log, warn once
2595 if ($in_commit_log && !$commit_log_long_line &&
2596 length($line) > 75 &&
2597 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2598 # file delta changes
2599 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2601 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2602 # A Fixes: or Link: line
2603 $commit_log_possible_stack_dump)) {
2604 WARN("COMMIT_LOG_LONG_LINE",
2605 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2606 $commit_log_long_line = 1;
2609 # Reset possible stack dump if a blank line is found
2610 if ($in_commit_log && $commit_log_possible_stack_dump &&
2612 $commit_log_possible_stack_dump = 0;
2615 # Check for git id commit length and improperly formed commit descriptions
2616 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2617 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
2618 $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
2619 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
2620 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
2621 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2622 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
2623 my $init_char = "c";
2624 my $orig_commit = "";
2631 my $id = '0123456789ab';
2632 my $orig_desc = "commit description";
2633 my $description = "";
2635 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2637 $orig_commit = lc($2);
2638 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2639 $orig_commit = lc($1);
2642 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2643 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2644 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2645 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2646 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2649 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2650 defined $rawlines[$linenr] &&
2651 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2654 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2655 defined $rawlines[$linenr] &&
2656 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2657 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2659 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2660 $orig_desc .= " " . $1;
2664 ($id, $description) = git_commit_info($orig_commit,
2668 ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
2669 ERROR("GIT_COMMIT_ID",
2670 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2674 # Check for added, moved or deleted files
2675 if (!$reported_maintainer_file && !$in_commit_log &&
2676 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2677 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2678 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2679 (defined($1) || defined($2))))) {
2681 $reported_maintainer_file = 1;
2682 WARN("FILE_PATH_CHANGES",
2683 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2686 # Check for wrappage within a valid hunk of the file
2687 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
2688 ERROR("CORRUPTED_PATCH",
2689 "patch seems to be corrupt (line wrapped?)\n" .
2690 $herecurr) if (!$emitted_corrupt++);
2693 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2694 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
2695 $rawline !~ m/^$UTF8*$/) {
2696 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2698 my $blank = copy_spacing($rawline);
2699 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2700 my $hereptr = "$hereline$ptr\n";
2703 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
2706 # Check if it's the start of a commit log
2707 # (not a header line and we haven't seen the patch filename)
2708 if ($in_header_lines && $realfile =~ /^$/ &&
2709 !($rawline =~ /^\s+(?:\S|$)/ ||
2710 $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
2711 $in_header_lines = 0;
2713 $has_commit_log = 1;
2716 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2717 # declined it, i.e defined some charset where it is missing.
2718 if ($in_header_lines &&
2719 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2721 $non_utf8_charset = 1;
2724 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
2725 $rawline =~ /$NON_ASCII_UTF8/) {
2726 WARN("UTF8_BEFORE_PATCH",
2727 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2730 # Check for absolute kernel paths in commit message
2731 if ($tree && $in_commit_log) {
2732 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2735 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2736 check_absolute_file($1, $herecurr)) {
2739 check_absolute_file($file, $herecurr);
2744 # Check for various typo / spelling mistakes
2745 if (defined($misspellings) &&
2746 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
2747 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
2749 my $typo_fix = $spelling_fix{lc($typo)};
2750 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2751 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2752 my $msg_level = \&WARN;
2753 $msg_level = \&CHK if ($file);
2754 if (&{$msg_level}("TYPO_SPELLING",
2755 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2757 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2762 # ignore non-hunk lines and lines being removed
2763 next if (!$hunk_line || $line =~ /^-/);
2765 #trailing whitespace
2766 if ($line =~ /^\+.*\015/) {
2767 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2768 if (ERROR("DOS_LINE_ENDINGS",
2769 "DOS line endings\n" . $herevet) &&
2771 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
2773 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2774 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2775 if (ERROR("TRAILING_WHITESPACE",
2776 "trailing whitespace\n" . $herevet) &&
2778 $fixed[$fixlinenr] =~ s/\s+$//;
2784 # Check for FSF mailing addresses.
2785 if ($rawline =~ /\bwrite to the Free/i ||
2786 $rawline =~ /\b675\s+Mass\s+Ave/i ||
2787 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2788 $rawline =~ /\b51\s+Franklin\s+St/i) {
2789 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2790 my $msg_level = \&ERROR;
2791 $msg_level = \&CHK if ($file);
2792 &{$msg_level}("FSF_MAILING_ADDRESS",
2793 "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)
2796 # check for Kconfig help text having a real description
2797 # Only applies when adding the entry originally, after that we do not have
2798 # sufficient context to determine whether it is indeed long enough.
2799 if ($realfile =~ /Kconfig/ &&
2800 $line =~ /^\+\s*config\s+/) {
2803 my $ln = $linenr + 1;
2807 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
2808 $f = $lines[$ln - 1];
2809 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2810 $is_end = $lines[$ln - 1] =~ /^\+/;
2812 next if ($f =~ /^-/);
2813 last if (!$file && $f =~ /^\@\@/);
2815 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
2817 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
2824 next if ($f =~ /^$/);
2825 if ($f =~ /^\s*config\s/) {
2831 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2832 WARN("CONFIG_DESCRIPTION",
2833 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2835 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2838 # check for MAINTAINERS entries that don't have the right form
2839 if ($realfile =~ /^MAINTAINERS$/ &&
2840 $rawline =~ /^\+[A-Z]:/ &&
2841 $rawline !~ /^\+[A-Z]:\t\S/) {
2842 if (WARN("MAINTAINERS_STYLE",
2843 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
2845 $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
2849 # discourage the use of boolean for type definition attributes of Kconfig options
2850 if ($realfile =~ /Kconfig/ &&
2851 $line =~ /^\+\s*\bboolean\b/) {
2852 WARN("CONFIG_TYPE_BOOLEAN",
2853 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2856 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2857 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2860 'EXTRA_AFLAGS' => 'asflags-y',
2861 'EXTRA_CFLAGS' => 'ccflags-y',
2862 'EXTRA_CPPFLAGS' => 'cppflags-y',
2863 'EXTRA_LDFLAGS' => 'ldflags-y',
2866 WARN("DEPRECATED_VARIABLE",
2867 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2870 # check for DT compatible documentation
2871 if (defined $root &&
2872 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2873 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2875 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2877 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2878 my $vp_file = $dt_path . "vendor-prefixes.txt";
2880 foreach my $compat (@compats) {
2881 my $compat2 = $compat;
2882 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2883 my $compat3 = $compat;
2884 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2885 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
2887 WARN("UNDOCUMENTED_DT_STRING",
2888 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2891 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2893 `grep -Eq "^$vendor\\b" $vp_file`;
2895 WARN("UNDOCUMENTED_DT_STRING",
2896 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2901 # check we are in a valid source file if not then ignore this hunk
2902 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
2904 # line length limit (with some exclusions)
2906 # There are a few types of lines that may extend beyond $max_line_length:
2907 # logging functions like pr_info that end in a string
2908 # lines with a single string
2909 # #defines that are a single string
2910 # lines with an RFC3986 like URL
2912 # There are 3 different line length message types:
2913 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
2914 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2915 # LONG_LINE all other lines longer than $max_line_length
2917 # if LONG_LINE is ignored, the other 2 types are also ignored
2920 if ($line =~ /^\+/ && $length > $max_line_length) {
2921 my $msg_type = "LONG_LINE";
2923 # Check the allowed long line types first
2925 # logging functions that end in a string that starts
2926 # before $max_line_length
2927 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2928 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2931 # lines with only strings (w/ possible termination)
2932 # #defines with only strings
2933 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2934 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2937 # More special cases
2938 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
2939 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
2942 # URL ($rawline is used in case the URL is in a comment)
2943 } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) {
2946 # Otherwise set the alternate message types
2948 # a comment starts before $max_line_length
2949 } elsif ($line =~ /($;[\s$;]*)$/ &&
2950 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2951 $msg_type = "LONG_LINE_COMMENT"
2953 # a quoted string starts before $max_line_length
2954 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
2955 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2956 $msg_type = "LONG_LINE_STRING"
2959 if ($msg_type ne "" &&
2960 (show_type("LONG_LINE") || show_type($msg_type))) {
2962 "line over $max_line_length characters\n" . $herecurr);
2966 # check for adding lines without a newline.
2967 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2968 WARN("MISSING_EOF_NEWLINE",
2969 "adding a line without newline at end of file\n" . $herecurr);
2972 # Blackfin: use hi/lo macros
2973 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2974 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2975 my $herevet = "$here\n" . cat_vet($line) . "\n";
2977 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
2979 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2980 my $herevet = "$here\n" . cat_vet($line) . "\n";
2982 "use the HI() macro, not (... >> 16)\n" . $herevet);
2986 # check we are in a valid source file C or perl if not then ignore this hunk
2987 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
2989 # at the beginning of a line any tabs must come first and anything
2990 # more than 8 must use tabs.
2991 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2992 $rawline =~ /^\+\s* \s*/) {
2993 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2995 if (ERROR("CODE_INDENT",
2996 "code indent should use tabs where possible\n" . $herevet) &&
2998 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3002 # check for space before tabs.
3003 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
3004 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3005 if (WARN("SPACE_BEFORE_TAB",
3006 "please, no space before tabs\n" . $herevet) &&
3008 while ($fixed[$fixlinenr] =~
3009 s/(^\+.*) {8,8}\t/$1\t\t/) {}
3010 while ($fixed[$fixlinenr] =~
3011 s/(^\+.*) +\t/$1\t/) {}
3015 # check for && or || at the start of a line
3016 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
3017 CHK("LOGICAL_CONTINUATIONS",
3018 "Logical continuations should be on the previous line\n" . $hereprev);
3021 # check indentation starts on a tab stop
3022 if ($^V && $^V ge 5.10.0 &&
3023 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$))/) {
3024 my $indent = length($1);
3027 "Statements should start on a tabstop\n" . $herecurr) &&
3029 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
3034 # check multi-line statement indentation matches previous line
3035 if ($^V && $^V ge 5.10.0 &&
3036 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
3037 $prevline =~ /^\+(\t*)(.*)$/;
3041 my $pos = pos_last_openparen($rest);
3043 $line =~ /^(\+| )([ \t]*)/;
3046 my $goodtabindent = $oldindent .
3049 my $goodspaceindent = $oldindent . " " x $pos;
3051 if ($newindent ne $goodtabindent &&
3052 $newindent ne $goodspaceindent) {
3054 if (CHK("PARENTHESIS_ALIGNMENT",
3055 "Alignment should match open parenthesis\n" . $hereprev) &&
3056 $fix && $line =~ /^\+/) {
3057 $fixed[$fixlinenr] =~
3058 s/^\+[ \t]*/\+$goodtabindent/;
3064 # check for space after cast like "(int) foo" or "(struct foo) bar"
3065 # avoid checking a few false positives:
3066 # "sizeof(<type>)" or "__alignof__(<type>)"
3067 # function pointer declarations like "(*foo)(int) = bar;"
3068 # structure definitions like "(struct foo) { 0 };"
3069 # multiline macros that define functions
3070 # known attributes or the __attribute__ keyword
3071 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
3072 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
3074 "No space is necessary after a cast\n" . $herecurr) &&
3076 $fixed[$fixlinenr] =~
3077 s/(\(\s*$Type\s*\))[ \t]+/$1/;
3081 # Block comment styles
3082 # Networking with an initial /*
3083 if ($realfile =~ m@^(drivers/net/|net/)@ &&
3084 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
3085 $rawline =~ /^\+[ \t]*\*/ &&
3087 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
3088 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3091 # Block comments use * on subsequent lines
3092 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3093 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
3094 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
3095 $rawline =~ /^\+/ && #line is new
3096 $rawline !~ /^\+[ \t]*\*/) { #no leading *
3097 WARN("BLOCK_COMMENT_STYLE",
3098 "Block comments use * on subsequent lines\n" . $hereprev);
3101 # Block comments use */ on trailing lines
3102 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
3103 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3104 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3105 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
3106 WARN("BLOCK_COMMENT_STYLE",
3107 "Block comments use a trailing */ on a separate line\n" . $herecurr);
3110 # Block comment * alignment
3111 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3112 $line =~ /^\+[ \t]*$;/ && #leading comment
3113 $rawline =~ /^\+[ \t]*\*/ && #leading *
3114 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
3115 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
3116 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3118 $prevrawline =~ m@^\+([ \t]*/?)\*@;
3120 $oldindent = expand_tabs($1);
3122 $prevrawline =~ m@^\+(.*/?)\*@;
3123 $oldindent = expand_tabs($1);
3125 $rawline =~ m@^\+([ \t]*)\*@;
3127 $newindent = expand_tabs($newindent);
3128 if (length($oldindent) ne length($newindent)) {
3129 WARN("BLOCK_COMMENT_STYLE",
3130 "Block comments should align the * on each line\n" . $hereprev);
3134 # check for missing blank lines after struct/union declarations
3135 # with exceptions for various attributes and macros
3136 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3138 !($line =~ /^\+\s*$/ ||
3139 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3140 $line =~ /^\+\s*MODULE_/i ||
3141 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3142 $line =~ /^\+[a-z_]*init/ ||
3143 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3144 $line =~ /^\+\s*DECLARE/ ||
3145 $line =~ /^\+\s*builtin_[\w_]*driver/ ||
3146 $line =~ /^\+\s*__setup/)) {
3147 if (CHK("LINE_SPACING",
3148 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3150 fix_insert_line($fixlinenr, "\+");
3154 # check for multiple consecutive blank lines
3155 if ($prevline =~ /^[\+ ]\s*$/ &&
3156 $line =~ /^\+\s*$/ &&
3157 $last_blank_line != ($linenr - 1)) {
3158 if (CHK("LINE_SPACING",
3159 "Please don't use multiple blank lines\n" . $hereprev) &&
3161 fix_delete_line($fixlinenr, $rawline);
3164 $last_blank_line = $linenr;
3167 # check for missing blank lines after declarations
3168 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3169 # actual declarations
3170 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
3171 # function pointer declarations
3172 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3173 # foo bar; where foo is some local typedef or #define
3174 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3175 # known declaration macros
3176 $prevline =~ /^\+\s+$declaration_macros/) &&
3177 # for "else if" which can look like "$Ident $Ident"
3178 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3179 # other possible extensions of declaration lines
3180 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3181 # not starting a section or a macro "\" extended line
3182 $prevline =~ /(?:\{\s*|\\)$/) &&
3183 # looks like a declaration
3184 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
3185 # function pointer declarations
3186 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3187 # foo bar; where foo is some local typedef or #define
3188 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3189 # known declaration macros
3190 $sline =~ /^\+\s+$declaration_macros/ ||
3191 # start of struct or union or enum
3192 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
3193 # start or end of block or continuation of declaration
3194 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3195 # bitfield continuation
3196 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3197 # other possible extensions of declaration lines
3198 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3199 # indentation of previous and current line are the same
3200 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
3201 if (WARN("LINE_SPACING",
3202 "Missing a blank line after declarations\n" . $hereprev) &&
3204 fix_insert_line($fixlinenr, "\+");
3208 # check for spaces at the beginning of a line.
3210 # 1) within comments
3211 # 2) indented preprocessor commands
3213 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
3214 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3215 if (WARN("LEADING_SPACE",
3216 "please, no spaces at the start of a line\n" . $herevet) &&
3218 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3222 # check we are in a valid C source file if not then ignore this hunk
3223 next if ($realfile !~ /\.(h|c)$/);
3225 # check for unusual line ending [ or (
3226 if ($line =~ /^\+.*([\[\(])\s*$/) {
3227 CHK("OPEN_ENDED_LINE",
3228 "Lines should not end with a '$1'\n" . $herecurr);
3231 # check if this appears to be the start function declaration, save the name
3232 if ($sline =~ /^\+\{\s*$/ &&
3233 $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
3234 $context_function = $1;
3237 # check if this appears to be the end of function declaration
3238 if ($sline =~ /^\+\}\s*$/) {
3239 undef $context_function;
3242 # check indentation of any line with a bare else
3243 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
3244 # if the previous line is a break or return and is indented 1 tab more...
3245 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3246 my $tabs = length($1) + 1;
3247 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3248 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3249 defined $lines[$linenr] &&
3250 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
3251 WARN("UNNECESSARY_ELSE",
3252 "else is not generally useful after a break or return\n" . $hereprev);
3256 # check indentation of a line with a break;
3257 # if the previous line is a goto or return and is indented the same # of tabs
3258 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3260 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3261 WARN("UNNECESSARY_BREAK",
3262 "break is not useful after a goto or return\n" . $hereprev);
3266 # check for RCS/CVS revision markers
3267 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
3269 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
3272 # Blackfin: don't use __builtin_bfin_[cs]sync
3273 if ($line =~ /__builtin_bfin_csync/) {
3274 my $herevet = "$here\n" . cat_vet($line) . "\n";
3276 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
3278 if ($line =~ /__builtin_bfin_ssync/) {
3279 my $herevet = "$here\n" . cat_vet($line) . "\n";
3281 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
3284 # check for old HOTPLUG __dev<foo> section markings
3285 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3286 WARN("HOTPLUG_SECTION",
3287 "Using $1 is unnecessary\n" . $herecurr);
3290 # Check for potential 'bare' types
3291 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3293 #print "LINE<$line>\n";
3294 if ($linenr > $suppress_statement &&
3295 $realcnt && $sline =~ /.\s*\S/) {
3296 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3297 ctx_statement_block($linenr, $realcnt, 0);
3298 $stat =~ s/\n./\n /g;
3299 $cond =~ s/\n./\n /g;
3301 #print "linenr<$linenr> <$stat>\n";
3302 # If this statement has no statement boundaries within
3303 # it there is no point in retrying a statement scan
3304 # until we hit end of it.
3305 my $frag = $stat; $frag =~ s/;+\s*$//;
3306 if ($frag !~ /(?:{|;)/) {
3307 #print "skip<$line_nr_next>\n";
3308 $suppress_statement = $line_nr_next;
3311 # Find the real next line.
3312 $realline_next = $line_nr_next;
3313 if (defined $realline_next &&
3314 (!defined $lines[$realline_next - 1] ||
3315 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3322 # Ignore goto labels.
3323 if ($s =~ /$Ident:\*$/s) {
3325 # Ignore functions being called
3326 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
3328 } elsif ($s =~ /^.\s*else\b/s) {
3330 # declarations always start with types
3331 } 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) {
3334 possible($type, "A:" . $s);
3336 # definitions in global scope can only start with types
3337 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
3338 possible($1, "B:" . $s);
3341 # any (foo ... *) is a pointer cast, and foo is a type
3342 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
3343 possible($1, "C:" . $s);
3346 # Check for any sort of function declaration.
3347 # int foo(something bar, other baz);
3348 # void (*store_gdt)(x86_descr_ptr *);
3349 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3350 my ($name_len) = length($1);
3353 substr($ctx, 0, $name_len + 1, '');
3354 $ctx =~ s/\)[^\)]*$//;
3356 for my $arg (split(/\s*,\s*/, $ctx)) {
3357 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3359 possible($1, "D:" . $s);
3367 # Checks which may be anchored in the context.
3370 # Check for switch () and associated case and default
3371 # statements should be at the same indent.
3372 if ($line=~/\bswitch\s*\(.*\)/) {
3375 my @ctx = ctx_block_outer($linenr, $realcnt);
3377 for my $ctx (@ctx) {
3378 my ($clen, $cindent) = line_stats($ctx);
3379 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3380 $indent != $cindent) {
3381 $err .= "$sep$ctx\n";
3388 ERROR("SWITCH_CASE_INDENT_LEVEL",
3389 "switch and case should be at the same indent\n$hereline$err");
3393 # if/while/etc brace do not go on next line, unless defining a do while loop,
3394 # or if that brace on the next line is for something else
3395 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3396 my $pre_ctx = "$1$2";
3398 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
3400 if ($line =~ /^\+\t{6,}/) {
3401 WARN("DEEP_INDENTATION",
3402 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3405 my $ctx_cnt = $realcnt - $#ctx - 1;
3406 my $ctx = join("\n", @ctx);
3408 my $ctx_ln = $linenr;
3409 my $ctx_skip = $realcnt;
3411 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3412 defined $lines[$ctx_ln - 1] &&
3413 $lines[$ctx_ln - 1] =~ /^-/)) {
3414 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3415 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
3419 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3420 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3422 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
3424 "that open brace { should be on the previous line\n" .
3425 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3427 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3428 $ctx =~ /\)\s*\;\s*$/ &&
3429 defined $lines[$ctx_ln - 1])
3431 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3432 if ($nindent > $indent) {
3433 WARN("TRAILING_SEMICOLON",
3434 "trailing semicolon indicates no statements, indent implies otherwise\n" .
3435 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3440 # Check relative indent for conditionals and blocks.
3441 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3442 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3443 ctx_statement_block($linenr, $realcnt, 0)
3444 if (!defined $stat);
3445 my ($s, $c) = ($stat, $cond);
3447 substr($s, 0, length($c), '');
3449 # remove inline comments
3453 # Find out how long the conditional actually is.
3454 my @newlines = ($c =~ /\n/gs);
3455 my $cond_lines = 1 + $#newlines;
3457 # Make sure we remove the line prefixes as we have
3458 # none on the first line, and are going to readd them
3461 while ($s =~ /\n\s+\\\n/) {
3462 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3465 # We want to check the first line inside the block
3466 # starting at the end of the conditional, so remove:
3467 # 1) any blank line termination
3468 # 2) any opening brace { on end of the line
3470 my $continuation = 0;
3472 $s =~ s/^.*\bdo\b//;
3474 if ($s =~ s/^\s*\\//) {
3477 if ($s =~ s/^\s*?\n//) {
3482 # Also ignore a loop construct at the end of a
3483 # preprocessor statement.
3484 if (($prevline =~ /^.\s*#\s*define\s/ ||
3485 $prevline =~ /\\\s*$/) && $continuation == 0) {
3491 while ($cond_ptr != $cond_lines) {
3492 $cond_ptr = $cond_lines;
3494 # If we see an #else/#elif then the code
3496 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3501 # 1) blank lines, they should be at 0,
3502 # 2) preprocessor lines, and
3504 if ($continuation ||
3506 $s =~ /^\s*#\s*?/ ||
3507 $s =~ /^\s*$Ident\s*:/) {
3508 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
3509 if ($s =~ s/^.*?\n//) {
3515 my (undef, $sindent) = line_stats("+" . $s);
3516 my $stat_real = raw_line($linenr, $cond_lines);
3518 # Check if either of these lines are modified, else
3519 # this is not this patch's fault.
3520 if (!defined($stat_real) ||
3521 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3524 if (defined($stat_real) && $cond_lines > 1) {
3525 $stat_real = "[...]\n$stat_real";
3528 #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";
3530 if ($check && $s ne '' &&
3531 (($sindent % 8) != 0 ||
3532 ($sindent < $indent) ||
3533 ($sindent == $indent &&
3534 ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
3535 ($sindent > $indent + 8))) {
3536 WARN("SUSPECT_CODE_INDENT",
3537 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3541 # Track the 'values' across context and added lines.
3542 my $opline = $line; $opline =~ s/^./ /;
3543 my ($curr_values, $curr_vars) =
3544 annotate_values($opline . "\n", $prev_values);
3545 $curr_values = $prev_values . $curr_values;
3547 my $outline = $opline; $outline =~ s/\t/ /g;
3548 print "$linenr > .$outline\n";
3549 print "$linenr > $curr_values\n";
3550 print "$linenr > $curr_vars\n";
3552 $prev_values = substr($curr_values, -1);
3554 #ignore lines not being added
3555 next if ($line =~ /^[^\+]/);
3557 # check for dereferences that span multiple lines
3558 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
3559 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
3560 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
3562 $line =~ /^.\s*($Lval)/;
3565 WARN("MULTILINE_DEREFERENCE",
3566 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
3569 # check for declarations of signed or unsigned without int
3570 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3573 $var = "" if (!defined $var);
3574 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
3578 $pointer = "" if (!defined $pointer);
3580 if (WARN("UNSPECIFIED_INT",
3581 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3583 my $decl = trim($sign) . " int ";
3584 my $comp_pointer = $pointer;
3585 $comp_pointer =~ s/\s//g;
3586 $decl .= $comp_pointer;
3587 $decl = rtrim($decl) if ($var eq "");
3588 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
3593 # TEST: allow direct testing of the type matcher.
3595 if ($line =~ /^.\s*$Declare\s*$/) {
3597 "TEST: is type\n" . $herecurr);
3598 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
3599 ERROR("TEST_NOT_TYPE",
3600 "TEST: is not type ($1 is)\n". $herecurr);
3604 # TEST: allow direct testing of the attribute matcher.
3606 if ($line =~ /^.\s*$Modifier\s*$/) {
3608 "TEST: is attr\n" . $herecurr);
3609 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
3610 ERROR("TEST_NOT_ATTR",
3611 "TEST: is not attr ($1 is)\n". $herecurr);
3616 # check for initialisation to aggregates open brace on the next line
3617 if ($line =~ /^.\s*{/ &&
3618 $prevline =~ /(?:^|[^=])=\s*$/) {
3619 if (ERROR("OPEN_BRACE",
3620 "that open brace { should be on the previous line\n" . $hereprev) &&
3621 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3622 fix_delete_line($fixlinenr - 1, $prevrawline);
3623 fix_delete_line($fixlinenr, $rawline);
3624 my $fixedline = $prevrawline;
3625 $fixedline =~ s/\s*=\s*$/ = {/;
3626 fix_insert_line($fixlinenr, $fixedline);
3628 $fixedline =~ s/^(.\s*)\{\s*/$1/;
3629 fix_insert_line($fixlinenr, $fixedline);
3634 # Checks which are anchored on the added line.
3637 # check for malformed paths in #include statements (uses RAW line)
3638 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
3640 if ($path =~ m{//}) {
3641 ERROR("MALFORMED_INCLUDE",
3642 "malformed #include filename\n" . $herecurr);
3644 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3645 ERROR("UAPI_INCLUDE",
3646 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
3650 # no C99 // comments
3651 if ($line =~ m{//}) {
3652 if (ERROR("C99_COMMENTS",
3653 "do not use C99 // comments\n" . $herecurr) &&
3655 my $line = $fixed[$fixlinenr];
3656 if ($line =~ /\/\/(.*)$/) {
3657 my $comment = trim($1);
3658 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
3662 # Remove C99 comments.
3664 $opline =~ s@//.*@@;
3666 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3667 # the whole statement.
3668 #print "APW <$lines[$realline_next - 1]>\n";
3669 if (defined $realline_next &&
3670 exists $lines[$realline_next - 1] &&
3671 !defined $suppress_export{$realline_next} &&
3672 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3673 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3674 # Handle definitions which produce identifiers with
3677 # EXPORT_SYMBOL(something_foo);
3679 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
3680 $name =~ /^${Ident}_$2/) {
3681 #print "FOO C name<$name>\n";
3682 $suppress_export{$realline_next} = 1;
3684 } elsif ($stat !~ /(?:
3686 ^.DEFINE_$Ident\(\Q$name\E\)|
3687 ^.DECLARE_$Ident\(\Q$name\E\)|
3688 ^.LIST_HEAD\(\Q$name\E\)|
3689 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3690 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
3692 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3693 $suppress_export{$realline_next} = 2;
3695 $suppress_export{$realline_next} = 1;
3698 if (!defined $suppress_export{$linenr} &&
3699 $prevline =~ /^.\s*$/ &&
3700 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3701 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3702 #print "FOO B <$lines[$linenr - 1]>\n";
3703 $suppress_export{$linenr} = 2;
3705 if (defined $suppress_export{$linenr} &&
3706 $suppress_export{$linenr} == 2) {
3707 WARN("EXPORT_SYMBOL",
3708 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
3711 # check for global initialisers.
3712 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
3713 if (ERROR("GLOBAL_INITIALISERS",
3714 "do not initialise globals to $1\n" . $herecurr) &&
3716 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
3719 # check for static initialisers.
3720 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
3721 if (ERROR("INITIALISED_STATIC",
3722 "do not initialise statics to $1\n" .
3725 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
3729 # check for misordered declarations of char/short/int/long with signed/unsigned
3730 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3732 WARN("MISORDERED_TYPE",
3733 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3736 # check for static const char * arrays.
3737 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
3738 WARN("STATIC_CONST_CHAR_ARRAY",
3739 "static const char * array should probably be static const char * const\n" .
3743 # check for static char foo[] = "bar" declarations.
3744 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
3745 WARN("STATIC_CONST_CHAR_ARRAY",
3746 "static char array declaration should probably be static const char\n" .
3750 # check for const <foo> const where <foo> is not a pointer or array type
3751 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3753 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3755 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3756 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3758 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3762 # check for non-global char *foo[] = {"bar", ...} declarations.
3763 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3764 WARN("STATIC_CONST_CHAR_ARRAY",
3765 "char * array declaration might be better as static const\n" .
3769 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3770 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3772 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3774 if (WARN("ARRAY_SIZE",
3775 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3777 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3782 # check for function declarations without arguments like "int foo()"
3783 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3784 if (ERROR("FUNCTION_WITHOUT_ARGS",
3785 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3787 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
3791 # check for new typedefs, only function parameters and sparse annotations
3793 if ($line =~ /\btypedef\s/ &&
3794 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
3795 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
3796 $line !~ /\b$typeTypedefs\b/ &&
3797 $line !~ /\b__bitwise\b/) {
3798 WARN("NEW_TYPEDEFS",
3799 "do not add new typedefs\n" . $herecurr);
3802 # * goes on variable not on type
3804 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3806 my ($ident, $from, $to) = ($1, $2, $2);
3808 # Should start with a space.
3809 $to =~ s/^(\S)/ $1/;
3810 # Should not end with a space.
3812 # '*'s should not have spaces between.
3813 while ($to =~ s/\*\s+\*/\*\*/) {
3816 ## print "1: from<$from> to<$to> ident<$ident>\n";
3818 if (ERROR("POINTER_LOCATION",
3819 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3821 my $sub_from = $ident;
3822 my $sub_to = $ident;
3823 $sub_to =~ s/\Q$from\E/$to/;
3824 $fixed[$fixlinenr] =~
3825 s@\Q$sub_from\E@$sub_to@;
3829 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3831 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
3833 # Should start with a space.
3834 $to =~ s/^(\S)/ $1/;
3835 # Should not end with a space.
3837 # '*'s should not have spaces between.
3838 while ($to =~ s/\*\s+\*/\*\*/) {
3840 # Modifiers should have spaces.
3841 $to =~ s/(\b$Modifier$)/$1 /;
3843 ## print "2: from<$from> to<$to> ident<$ident>\n";
3844 if ($from ne $to && $ident !~ /^$Modifier$/) {
3845 if (ERROR("POINTER_LOCATION",
3846 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3849 my $sub_from = $match;
3850 my $sub_to = $match;
3851 $sub_to =~ s/\Q$from\E/$to/;
3852 $fixed[$fixlinenr] =~
3853 s@\Q$sub_from\E@$sub_to@;
3858 # avoid BUG() or BUG_ON()
3859 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
3860 my $msg_level = \&WARN;
3861 $msg_level = \&CHK if ($file);
3862 &{$msg_level}("AVOID_BUG",
3863 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3866 # avoid LINUX_VERSION_CODE
3867 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
3868 WARN("LINUX_VERSION_CODE",
3869 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3872 # check for uses of printk_ratelimit
3873 if ($line =~ /\bprintk_ratelimit\s*\(/) {
3874 WARN("PRINTK_RATELIMITED",
3875 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
3878 # printk should use KERN_* levels
3879 if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
3880 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3881 "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
3884 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3886 my $level = lc($orig);
3887 $level = "warn" if ($level eq "warning");
3888 my $level2 = $level;
3889 $level2 = "dbg" if ($level eq "debug");
3890 WARN("PREFER_PR_LEVEL",
3891 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
3894 if ($line =~ /\bpr_warning\s*\(/) {
3895 if (WARN("PREFER_PR_LEVEL",
3896 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3898 $fixed[$fixlinenr] =~
3899 s/\bpr_warning\b/pr_warn/;
3903 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3905 my $level = lc($orig);
3906 $level = "warn" if ($level eq "warning");
3907 $level = "dbg" if ($level eq "debug");
3908 WARN("PREFER_DEV_LEVEL",
3909 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3912 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
3913 # number of false positives, but assembly files are not checked, so at
3914 # least the arch entry code will not trigger this warning.
3915 if ($line =~ /\bENOSYS\b/) {
3917 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3920 # function brace can't be on same line, except for #defines of do while,
3921 # or if closed on same line
3922 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
3923 !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) {
3924 if (ERROR("OPEN_BRACE",
3925 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3927 fix_delete_line($fixlinenr, $rawline);
3928 my $fixed_line = $rawline;
3929 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3932 fix_insert_line($fixlinenr, ltrim($line1));
3933 fix_insert_line($fixlinenr, "\+{");
3934 if ($line2 !~ /^\s*$/) {
3935 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3940 # open braces for enum, union and struct go on the same line.
3941 if ($line =~ /^.\s*{/ &&
3942 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
3943 if (ERROR("OPEN_BRACE",
3944 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3945 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3946 fix_delete_line($fixlinenr - 1, $prevrawline);
3947 fix_delete_line($fixlinenr, $rawline);
3948 my $fixedline = rtrim($prevrawline) . " {";
3949 fix_insert_line($fixlinenr, $fixedline);
3950 $fixedline = $rawline;
3951 $fixedline =~ s/^(.\s*)\{\s*/$1\t/;
3952 if ($fixedline !~ /^\+\s*$/) {
3953 fix_insert_line($fixlinenr, $fixedline);
3958 # missing space after union, struct or enum definition
3959 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3961 "missing space after $1 definition\n" . $herecurr) &&
3963 $fixed[$fixlinenr] =~
3964 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3968 # Function pointer declarations
3969 # check spacing between type, funcptr, and args
3970 # canonical declaration is "type (*funcptr)(args...)"
3971 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
3973 my $pre_pointer_space = $2;
3974 my $post_pointer_space = $3;
3976 my $post_funcname_space = $5;
3977 my $pre_args_space = $6;
3979 # the $Declare variable will capture all spaces after the type
3980 # so check it for a missing trailing missing space but pointer return types
3981 # don't need a space so don't warn for those.
3982 my $post_declare_space = "";
3983 if ($declare =~ /(\s+)$/) {
3984 $post_declare_space = $1;
3985 $declare = rtrim($declare);
3987 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
3989 "missing space after return type\n" . $herecurr);
3990 $post_declare_space = " ";
3993 # unnecessary space "type (*funcptr)(args...)"
3994 # This test is not currently implemented because these declarations are
3996 # int foo(int bar, ...)
3997 # and this is form shouldn't/doesn't generate a checkpatch warning.
3999 # elsif ($declare =~ /\s{2,}$/) {
4001 # "Multiple spaces after return type\n" . $herecurr);
4004 # unnecessary space "type ( *funcptr)(args...)"
4005 if (defined $pre_pointer_space &&
4006 $pre_pointer_space =~ /^\s/) {
4008 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
4011 # unnecessary space "type (* funcptr)(args...)"
4012 if (defined $post_pointer_space &&
4013 $post_pointer_space =~ /^\s/) {
4015 "Unnecessary space before function pointer name\n" . $herecurr);
4018 # unnecessary space "type (*funcptr )(args...)"
4019 if (defined $post_funcname_space &&
4020 $post_funcname_space =~ /^\s/) {
4022 "Unnecessary space after function pointer name\n" . $herecurr);
4025 # unnecessary space "type (*funcptr) (args...)"
4026 if (defined $pre_args_space &&
4027 $pre_args_space =~ /^\s/) {
4029 "Unnecessary space before function pointer arguments\n" . $herecurr);
4032 if (show_type("SPACING") && $fix) {
4033 $fixed[$fixlinenr] =~
4034 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
4038 # check for spacing round square brackets; allowed:
4039 # 1. with a type on the left -- int [] a;
4040 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4041 # 3. inside a curly brace -- = { [0...10] = 5 }
4042 while ($line =~ /(.*?\s)\[/g) {
4043 my ($where, $prefix) = ($-[1], $1);
4044 if ($prefix !~ /$Type\s+$/ &&
4045 ($where != 0 || $prefix !~ /^.\s+$/) &&
4046 $prefix !~ /[{,]\s+$/) {
4047 if (ERROR("BRACKET_SPACE",
4048 "space prohibited before open square bracket '['\n" . $herecurr) &&
4050 $fixed[$fixlinenr] =~
4051 s/^(\+.*?)\s+\[/$1\[/;
4056 # check for spaces between functions and their parentheses.
4057 while ($line =~ /($Ident)\s+\(/g) {
4059 my $ctx_before = substr($line, 0, $-[1]);
4060 my $ctx = "$ctx_before$name";
4062 # Ignore those directives where spaces _are_ permitted.
4064 if|for|while|switch|return|case|
4065 volatile|__volatile__|
4066 __attribute__|format|__extension__|
4069 # cpp #define statements have non-optional spaces, ie
4070 # if there is a space between the name and the open
4071 # parenthesis it is simply not a parameter group.
4072 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
4074 # cpp #elif statement condition may start with a (
4075 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
4077 # If this whole things ends with a type its most
4078 # likely a typedef for a function.
4079 } elsif ($ctx =~ /$Type$/) {
4083 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
4085 $fixed[$fixlinenr] =~
4086 s/\b$name\s+\(/$name\(/;
4091 # Check operator spacing.
4092 if (!($line=~/\#\s*include/)) {
4093 my $fixed_line = "";
4097 <<=|>>=|<=|>=|==|!=|
4098 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4099 =>|->|<<|>>|<|>|=|!|~|
4100 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
4103 my @elements = split(/($ops|;)/, $opline);
4105 ## print("element count: <" . $#elements . ">\n");
4106 ## foreach my $el (@elements) {
4107 ## print("el: <$el>\n");
4110 my @fix_elements = ();
4113 foreach my $el (@elements) {
4114 push(@fix_elements, substr($rawline, $off, length($el)));
4115 $off += length($el);
4120 my $blank = copy_spacing($opline);
4121 my $last_after = -1;
4123 for (my $n = 0; $n < $#elements; $n += 2) {
4125 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4127 ## print("n: <$n> good: <$good>\n");
4129 $off += length($elements[$n]);
4131 # Pick up the preceding and succeeding characters.
4132 my $ca = substr($opline, 0, $off);
4134 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4135 $cc = substr($opline, $off + length($elements[$n + 1]));
4137 my $cb = "$ca$;$cc";
4140 $a = 'V' if ($elements[$n] ne '');
4141 $a = 'W' if ($elements[$n] =~ /\s$/);
4142 $a = 'C' if ($elements[$n] =~ /$;$/);
4143 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4144 $a = 'O' if ($elements[$n] eq '');
4145 $a = 'E' if ($ca =~ /^\s*$/);
4147 my $op = $elements[$n + 1];
4150 if (defined $elements[$n + 2]) {
4151 $c = 'V' if ($elements[$n + 2] ne '');
4152 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
4153 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
4154 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4155 $c = 'O' if ($elements[$n + 2] eq '');
4156 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
4161 my $ctx = "${a}x${c}";
4163 my $at = "(ctx:$ctx)";
4165 my $ptr = substr($blank, 0, $off) . "^";
4166 my $hereptr = "$hereline$ptr\n";
4168 # Pull out the value of this operator.
4169 my $op_type = substr($curr_values, $off + 1, 1);
4171 # Get the full operator variant.
4172 my $opv = $op . substr($curr_vars, $off, 1);
4174 # Ignore operators passed as parameters.
4175 if ($op_type ne 'V' &&
4176 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
4179 # } elsif ($op =~ /^$;+$/) {
4181 # ; should have either the end of line or a space or \ after it
4182 } elsif ($op eq ';') {
4183 if ($ctx !~ /.x[WEBC]/ &&
4184 $cc !~ /^\\/ && $cc !~ /^;/) {
4185 if (ERROR("SPACING",
4186 "space required after that '$op' $at\n" . $hereptr)) {
4187 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
4193 } elsif ($op eq '//') {
4195 # : when part of a bitfield
4196 } elsif ($opv eq ':B') {
4197 # skip the bitfield test for now
4201 } elsif ($op eq '->') {
4202 if ($ctx =~ /Wx.|.xW/) {
4203 if (ERROR("SPACING",
4204 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
4205 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4206 if (defined $fix_elements[$n + 2]) {
4207 $fix_elements[$n + 2] =~ s/^\s+//;
4213 # , must not have a space before and must have a space on the right.
4214 } elsif ($op eq ',') {
4215 my $rtrim_before = 0;
4216 my $space_after = 0;
4217 if ($ctx =~ /Wx./) {
4218 if (ERROR("SPACING",
4219 "space prohibited before that '$op' $at\n" . $hereptr)) {
4224 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
4225 if (ERROR("SPACING",
4226 "space required after that '$op' $at\n" . $hereptr)) {
4232 if ($rtrim_before || $space_after) {
4233 if ($rtrim_before) {
4234 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4236 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4243 # '*' as part of a type definition -- reported already.
4244 } elsif ($opv eq '*_') {
4245 #warn "'*' is part of type\n";
4247 # unary operators should have a space before and
4248 # none after. May be left adjacent to another
4249 # unary operator, or a cast
4250 } elsif ($op eq '!' || $op eq '~' ||
4251 $opv eq '*U' || $opv eq '-U' ||
4252 $opv eq '&U' || $opv eq '&&U') {
4253 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
4254 if (ERROR("SPACING",
4255 "space required before that '$op' $at\n" . $hereptr)) {
4256 if ($n != $last_after + 2) {
4257 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4262 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
4263 # A unary '*' may be const
4265 } elsif ($ctx =~ /.xW/) {
4266 if (ERROR("SPACING",
4267 "space prohibited after that '$op' $at\n" . $hereptr)) {
4268 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
4269 if (defined $fix_elements[$n + 2]) {
4270 $fix_elements[$n + 2] =~ s/^\s+//;
4276 # unary ++ and unary -- are allowed no space on one side.
4277 } elsif ($op eq '++' or $op eq '--') {
4278 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
4279 if (ERROR("SPACING",
4280 "space required one side of that '$op' $at\n" . $hereptr)) {
4281 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
4285 if ($ctx =~ /Wx[BE]/ ||
4286 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
4287 if (ERROR("SPACING",
4288 "space prohibited before that '$op' $at\n" . $hereptr)) {
4289 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4293 if ($ctx =~ /ExW/) {
4294 if (ERROR("SPACING",
4295 "space prohibited after that '$op' $at\n" . $hereptr)) {
4296 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4297 if (defined $fix_elements[$n + 2]) {
4298 $fix_elements[$n + 2] =~ s/^\s+//;
4304 # << and >> may either have or not have spaces both sides
4305 } elsif ($op eq '<<' or $op eq '>>' or
4306 $op eq '&' or $op eq '^' or $op eq '|' or
4307 $op eq '+' or $op eq '-' or
4308 $op eq '*' or $op eq '/' or
4312 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4314 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4315 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4316 $fix_elements[$n + 2] =~ s/^\s+//;
4319 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4321 "space preferred before that '$op' $at\n" . $hereptr)) {
4322 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4326 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
4327 if (ERROR("SPACING",
4328 "need consistent spacing around '$op' $at\n" . $hereptr)) {
4329 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4330 if (defined $fix_elements[$n + 2]) {
4331 $fix_elements[$n + 2] =~ s/^\s+//;
4337 # A colon needs no spaces before when it is
4338 # terminating a case value or a label.
4339 } elsif ($opv eq ':C' || $opv eq ':L') {
4340 if ($ctx =~ /Wx./) {
4341 if (ERROR("SPACING",
4342 "space prohibited before that '$op' $at\n" . $hereptr)) {
4343 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4348 # All the others need spaces both sides.
4349 } elsif ($ctx !~ /[EWC]x[CWE]/) {
4352 # Ignore email addresses <foo@bar>
4354 $cc =~ /^\S+\@\S+>/) ||
4356 $ca =~ /<\S+\@\S+$/))
4361 # for asm volatile statements
4362 # ignore a colon with another
4363 # colon immediately before or after
4365 ($ca =~ /:$/ || $cc =~ /^:/)) {
4369 # messages are ERROR, but ?: are CHK
4371 my $msg_level = \&ERROR;
4372 $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4374 if (&{$msg_level}("SPACING",
4375 "spaces required around that '$op' $at\n" . $hereptr)) {
4376 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4377 if (defined $fix_elements[$n + 2]) {
4378 $fix_elements[$n + 2] =~ s/^\s+//;
4384 $off += length($elements[$n + 1]);
4386 ## print("n: <$n> GOOD: <$good>\n");
4388 $fixed_line = $fixed_line . $good;
4391 if (($#elements % 2) == 0) {
4392 $fixed_line = $fixed_line . $fix_elements[$#elements];
4395 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4396 $fixed[$fixlinenr] = $fixed_line;
4402 # check for whitespace before a non-naked semicolon
4403 if ($line =~ /^\+.*\S\s+;\s*$/) {
4405 "space prohibited before semicolon\n" . $herecurr) &&
4407 1 while $fixed[$fixlinenr] =~
4408 s/^(\+.*\S)\s+;/$1;/;
4412 # check for multiple assignments
4413 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
4414 CHK("MULTIPLE_ASSIGNMENTS",
4415 "multiple assignments should be avoided\n" . $herecurr);
4418 ## # check for multiple declarations, allowing for a function declaration
4420 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4421 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4423 ## # Remove any bracketed sections to ensure we do not
4424 ## # falsly report the parameters of functions.
4426 ## while ($ln =~ s/\([^\(\)]*\)//g) {
4428 ## if ($ln =~ /,/) {
4429 ## WARN("MULTIPLE_DECLARATION",
4430 ## "declaring multiple variables together should be avoided\n" . $herecurr);
4434 #need space before brace following if, while, etc
4435 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
4437 if (ERROR("SPACING",
4438 "space required before the open brace '{'\n" . $herecurr) &&
4440 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\)))\{/$1 {/;
4444 ## # check for blank lines before declarations
4445 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4446 ## $prevrawline =~ /^.\s*$/) {
4448 ## "No blank lines before declarations\n" . $hereprev);
4452 # closing brace should have a space following it when it has anything
4454 if ($line =~ /}(?!(?:,|;|\)))\S/) {
4455 if (ERROR("SPACING",
4456 "space required after that close brace '}'\n" . $herecurr) &&
4458 $fixed[$fixlinenr] =~
4459 s/}((?!(?:,|;|\)))\S)/} $1/;
4463 # check spacing on square brackets
4464 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
4465 if (ERROR("SPACING",
4466 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4468 $fixed[$fixlinenr] =~
4472 if ($line =~ /\s\]/) {
4473 if (ERROR("SPACING",
4474 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4476 $fixed[$fixlinenr] =~
4481 # check spacing on parentheses
4482 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4483 $line !~ /for\s*\(\s+;/) {
4484 if (ERROR("SPACING",
4485 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4487 $fixed[$fixlinenr] =~
4491 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
4492 $line !~ /for\s*\(.*;\s+\)/ &&
4493 $line !~ /:\s+\)/) {
4494 if (ERROR("SPACING",
4495 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4497 $fixed[$fixlinenr] =~
4502 # check unnecessary parentheses around addressof/dereference single $Lvals
4503 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4505 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
4507 if (CHK("UNNECESSARY_PARENTHESES",
4508 "Unnecessary parentheses around $var\n" . $herecurr) &&
4510 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4514 # check for unnecessary parentheses around function pointer uses
4515 # ie: (foo->bar)(); should be foo->bar();
4516 # but not "if (foo->bar) (" to avoid some false positives
4517 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4519 if (CHK("UNNECESSARY_PARENTHESES",
4520 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4522 my $var2 = deparenthesize($var);
4524 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4528 # check for unnecessary parentheses around comparisons in if uses
4529 if ($^V && $^V ge 5.10.0 && defined($stat) &&
4530 $stat =~ /(^.\s*if\s*($balanced_parens))/) {
4532 my $test = substr($2, 1, -1);
4534 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4536 # avoid parentheses around potential macro args
4537 next if ($match =~ /^\s*\w+\s*$/);
4538 if (!defined($herectx)) {
4539 $herectx = $here . "\n";
4540 my $cnt = statement_rawlines($if_stat);
4541 for (my $n = 0; $n < $cnt; $n++) {
4542 my $rl = raw_line($linenr, $n);
4543 $herectx .= $rl . "\n";
4544 last if $rl =~ /^[ \+].*\{/;
4547 CHK("UNNECESSARY_PARENTHESES",
4548 "Unnecessary parentheses around '$match'\n" . $herectx);
4552 #goto labels aren't indented, allow a single space however
4553 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
4554 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
4555 if (WARN("INDENTED_LABEL",
4556 "labels should not be indented\n" . $herecurr) &&
4558 $fixed[$fixlinenr] =~
4563 # return is not a function
4564 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
4566 if ($^V && $^V ge 5.10.0 &&
4567 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4569 $value = deparenthesize($value);
4570 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4571 ERROR("RETURN_PARENTHESES",
4572 "return is not a function, parentheses are not required\n" . $herecurr);
4574 } elsif ($spacing !~ /\s+/) {
4576 "space required before the open parenthesis '('\n" . $herecurr);
4580 # unnecessary return in a void function
4581 # at end-of-function, with the previous line a single leading tab, then return;
4582 # and the line before that not a goto label target like "out:"
4583 if ($sline =~ /^[ \+]}\s*$/ &&
4584 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4586 $lines[$linenr - 3] =~ /^[ +]/ &&
4587 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
4589 "void function return statements are not generally useful\n" . $hereprev);
4592 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4593 if ($^V && $^V ge 5.10.0 &&
4594 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4595 my $openparens = $1;
4596 my $count = $openparens =~ tr@\(@\(@;
4598 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4599 my $comp = $4; #Not $1 because of $LvalOrFunc
4600 $msg = " - maybe == should be = ?" if ($comp eq "==");
4601 WARN("UNNECESSARY_PARENTHESES",
4602 "Unnecessary parentheses$msg\n" . $herecurr);
4606 # comparisons with a constant or upper case identifier on the left
4607 # avoid cases like "foo + BAR < baz"
4608 # only fix matches surrounded by parentheses to avoid incorrect
4609 # conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4610 if ($^V && $^V ge 5.10.0 &&
4611 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4616 my $newcomp = $comp;
4617 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
4618 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4619 WARN("CONSTANT_COMPARISON",
4620 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4624 } elsif ($comp eq "<=") {
4626 } elsif ($comp eq ">") {
4628 } elsif ($comp eq ">=") {
4631 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4635 # Return of what appears to be an errno should normally be negative
4636 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
4638 if ($name ne 'EOF' && $name ne 'ERROR') {
4639 WARN("USE_NEGATIVE_ERRNO",
4640 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
4644 # Need a space before open parenthesis after if, while etc
4645 if ($line =~ /\b(if|while|for|switch)\(/) {
4646 if (ERROR("SPACING",
4647 "space required before the open parenthesis '('\n" . $herecurr) &&
4649 $fixed[$fixlinenr] =~
4650 s/\b(if|while|for|switch)\(/$1 \(/;
4654 # Check for illegal assignment in if conditional -- and check for trailing
4655 # statements after the conditional.
4656 if ($line =~ /do\s*(?!{)/) {
4657 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4658 ctx_statement_block($linenr, $realcnt, 0)
4659 if (!defined $stat);
4660 my ($stat_next) = ctx_statement_block($line_nr_next,
4661 $remain_next, $off_next);
4662 $stat_next =~ s/\n./\n /g;
4663 ##print "stat<$stat> stat_next<$stat_next>\n";
4665 if ($stat_next =~ /^\s*while\b/) {
4666 # If the statement carries leading newlines,
4667 # then count those as offsets.
4669 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4671 statement_rawlines($whitespace) - 1;
4673 $suppress_whiletrailers{$line_nr_next +
4677 if (!defined $suppress_whiletrailers{$linenr} &&
4678 defined($stat) && defined($cond) &&
4679 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
4680 my ($s, $c) = ($stat, $cond);
4682 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
4683 ERROR("ASSIGN_IN_IF",
4684 "do not use assignment in if condition\n" . $herecurr);
4687 # Find out what is on the end of the line after the
4689 substr($s, 0, length($c), '');
4691 $s =~ s/$;//g; # Remove any comments
4692 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4693 $c !~ /}\s*while\s*/)
4695 # Find out how long the conditional actually is.
4696 my @newlines = ($c =~ /\n/gs);
4697 my $cond_lines = 1 + $#newlines;
4700 $stat_real = raw_line($linenr, $cond_lines)
4701 . "\n" if ($cond_lines);
4702 if (defined($stat_real) && $cond_lines > 1) {
4703 $stat_real = "[...]\n$stat_real";
4706 ERROR("TRAILING_STATEMENTS",
4707 "trailing statements should be on next line\n" . $herecurr . $stat_real);
4711 # Check for bitwise tests written as boolean
4723 WARN("HEXADECIMAL_BOOLEAN_TEST",
4724 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
4727 # if and else should not have general statements after it
4728 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4730 $s =~ s/$;//g; # Remove any comments
4731 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
4732 ERROR("TRAILING_STATEMENTS",
4733 "trailing statements should be on next line\n" . $herecurr);
4736 # if should not continue a brace
4737 if ($line =~ /}\s*if\b/) {
4738 ERROR("TRAILING_STATEMENTS",
4739 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
4742 # case and default should not have general statements after them
4743 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4745 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
4749 ERROR("TRAILING_STATEMENTS",
4750 "trailing statements should be on next line\n" . $herecurr);
4753 # Check for }<nl>else {, these must be at the same
4754 # indent level to be relevant to each other.
4755 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4756 $previndent == $indent) {
4757 if (ERROR("ELSE_AFTER_BRACE",
4758 "else should follow close brace '}'\n" . $hereprev) &&
4759 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4760 fix_delete_line($fixlinenr - 1, $prevrawline);
4761 fix_delete_line($fixlinenr, $rawline);
4762 my $fixedline = $prevrawline;
4763 $fixedline =~ s/}\s*$//;
4764 if ($fixedline !~ /^\+\s*$/) {
4765 fix_insert_line($fixlinenr, $fixedline);
4767 $fixedline = $rawline;
4768 $fixedline =~ s/^(.\s*)else/$1} else/;
4769 fix_insert_line($fixlinenr, $fixedline);
4773 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4774 $previndent == $indent) {
4775 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4777 # Find out what is on the end of the line after the
4779 substr($s, 0, length($c), '');
4782 if ($s =~ /^\s*;/) {
4783 if (ERROR("WHILE_AFTER_BRACE",
4784 "while should follow close brace '}'\n" . $hereprev) &&
4785 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4786 fix_delete_line($fixlinenr - 1, $prevrawline);
4787 fix_delete_line($fixlinenr, $rawline);
4788 my $fixedline = $prevrawline;
4789 my $trailing = $rawline;
4790 $trailing =~ s/^\+//;
4791 $trailing = trim($trailing);
4792 $fixedline =~ s/}\s*$/} $trailing/;
4793 fix_insert_line($fixlinenr, $fixedline);
4798 #Specific variable tests
4799 while ($line =~ m{($Constant|$Lval)}g) {
4802 #gcc binary extension
4803 if ($var =~ /^$Binary$/) {
4804 if (WARN("GCC_BINARY_CONSTANT",
4805 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4807 my $hexval = sprintf("0x%x", oct($var));
4808 $fixed[$fixlinenr] =~
4809 s/\b$var\b/$hexval/;
4814 if ($var !~ /^$Constant$/ &&
4815 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
4816 #Ignore Page<foo> variants
4817 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
4818 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4819 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4820 #Ignore some three character SI units explicitly, like MiB and KHz
4821 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
4822 while ($var =~ m{($Ident)}g) {
4824 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
4826 seed_camelcase_includes();
4827 if (!$file && !$camelcase_file_seeded) {
4828 seed_camelcase_file($realfile);
4829 $camelcase_file_seeded = 1;
4832 if (!defined $camelcase{$word}) {
4833 $camelcase{$word} = 1;
4835 "Avoid CamelCase: <$word>\n" . $herecurr);
4841 #no spaces allowed after \ in define
4842 if ($line =~ /\#\s*define.*\\\s+$/) {
4843 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4844 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4846 $fixed[$fixlinenr] =~ s/\s+$//;
4850 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4851 # itself <asm/foo.h> (uses RAW line)
4852 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
4854 my $checkfile = "include/linux/$file";
4855 if (-f "$root/$checkfile" &&
4856 $realfile ne $checkfile &&
4857 $1 !~ /$allowed_asm_includes/)
4859 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4860 if ($asminclude > 0) {
4861 if ($realfile =~ m{^arch/}) {
4862 CHK("ARCH_INCLUDE_LINUX",
4863 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4865 WARN("INCLUDE_LINUX",
4866 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4872 # multi-statement macros should be enclosed in a do while loop, grab the
4873 # first statement and ensure its the whole macro if its not enclosed
4874 # in a known good container
4875 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4876 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
4879 my ($off, $dstat, $dcond, $rest);
4881 my $has_flow_statement = 0;
4882 my $has_arg_concat = 0;
4883 ($dstat, $dcond, $ln, $cnt, $off) =
4884 ctx_statement_block($linenr, $realcnt, 0);
4886 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4887 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4889 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
4890 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
4892 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
4893 my $define_args = $1;
4894 my $define_stmt = $dstat;
4897 if (defined $define_args && $define_args ne "") {
4898 $define_args = substr($define_args, 1, length($define_args) - 2);
4899 $define_args =~ s/\s*//g;
4900 @def_args = split(",", $define_args);
4904 $dstat =~ s/\\\n.//g;
4905 $dstat =~ s/^\s*//s;
4906 $dstat =~ s/\s*$//s;
4908 # Flatten any parentheses and braces
4909 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4910 $dstat =~ s/\{[^\{\}]*\}/1/ ||
4911 $dstat =~ s/.\[[^\[\]]*\]/1/)
4915 # Flatten any obvious string concatentation.
4916 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4917 $dstat =~ s/$Ident\s*($String)/$1/)
4921 # Make asm volatile uses seem like a generic function
4922 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
4924 my $exceptions = qr{
4937 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4940 my $herectx = $here . "\n";
4941 my $stmt_cnt = statement_rawlines($ctx);
4943 for (my $n = 0; $n < $stmt_cnt; $n++) {
4944 $herectx .= raw_line($linenr, $n) . "\n";
4948 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4949 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
4950 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4951 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
4952 $dstat !~ /$exceptions/ &&
4953 $dstat !~ /^\.$Ident\s*=/ && # .foo =
4954 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
4955 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
4956 $dstat !~ /^for\s*$Constant$/ && # for (...)
4957 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4958 $dstat !~ /^do\s*{/ && # do {...
4959 $dstat !~ /^\(\{/ && # ({...
4960 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
4962 if ($dstat =~ /^\s*if\b/) {
4963 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4964 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
4965 } elsif ($dstat =~ /;/) {
4966 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4967 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4969 ERROR("COMPLEX_MACRO",
4970 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
4975 # Make $define_stmt single line, comment-free, etc
4976 my @stmt_array = split('\n', $define_stmt);
4979 foreach my $l (@stmt_array) {
4984 } elsif ($l =~ /^[\+ ]/) {
4985 $define_stmt .= substr($l, 1);
4988 $define_stmt =~ s/$;//g;
4989 $define_stmt =~ s/\s+/ /g;
4990 $define_stmt = trim($define_stmt);
4992 # check if any macro arguments are reused (ignore '...' and 'type')
4993 foreach my $arg (@def_args) {
4994 next if ($arg =~ /\.\.\./);
4995 next if ($arg =~ /^type$/i);
4996 my $tmp_stmt = $define_stmt;
4997 $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
4998 $tmp_stmt =~ s/\#+\s*$arg\b//g;
4999 $tmp_stmt =~ s/\b$arg\s*\#\#//g;
5000 my $use_cnt = $tmp_stmt =~ s/\b$arg\b//g;
5002 CHK("MACRO_ARG_REUSE",
5003 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
5005 # check if any macro arguments may have other precedence issues
5006 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
5007 ((defined($1) && $1 ne ',') ||
5008 (defined($2) && $2 ne ','))) {
5009 CHK("MACRO_ARG_PRECEDENCE",
5010 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
5014 # check for macros with flow control, but without ## concatenation
5015 # ## concatenation is commonly a macro that defines a function so ignore those
5016 if ($has_flow_statement && !$has_arg_concat) {
5017 my $herectx = $here . "\n";
5018 my $cnt = statement_rawlines($ctx);
5020 for (my $n = 0; $n < $cnt; $n++) {
5021 $herectx .= raw_line($linenr, $n) . "\n";
5023 WARN("MACRO_WITH_FLOW_CONTROL",
5024 "Macros with flow control statements should be avoided\n" . "$herectx");
5027 # check for line continuations outside of #defines, preprocessor #, and asm
5030 if ($prevline !~ /^..*\\$/ &&
5031 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
5032 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
5033 $line =~ /^\+.*\\$/) {
5034 WARN("LINE_CONTINUATIONS",
5035 "Avoid unnecessary line continuations\n" . $herecurr);
5039 # do {} while (0) macro tests:
5040 # single-statement macros do not need to be enclosed in do while (0) loop,
5041 # macro should not end with a semicolon
5042 if ($^V && $^V ge 5.10.0 &&
5043 $realfile !~ m@/vmlinux.lds.h$@ &&
5044 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
5047 my ($off, $dstat, $dcond, $rest);
5049 ($dstat, $dcond, $ln, $cnt, $off) =
5050 ctx_statement_block($linenr, $realcnt, 0);
5053 $dstat =~ s/\\\n.//g;
5056 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5061 my $cnt = statement_rawlines($ctx);
5062 my $herectx = $here . "\n";
5064 for (my $n = 0; $n < $cnt; $n++) {
5065 $herectx .= raw_line($linenr, $n) . "\n";
5068 if (($stmts =~ tr/;/;/) == 1 &&
5069 $stmts !~ /^\s*(if|while|for|switch)\b/) {
5070 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
5071 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
5073 if (defined $semis && $semis ne "") {
5074 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
5075 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
5077 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
5079 my $cnt = statement_rawlines($ctx);
5080 my $herectx = $here . "\n";
5082 for (my $n = 0; $n < $cnt; $n++) {
5083 $herectx .= raw_line($linenr, $n) . "\n";
5086 WARN("TRAILING_SEMICOLON",
5087 "macros should not use a trailing semicolon\n" . "$herectx");
5091 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
5092 # all assignments may have only one of the following with an assignment:
5095 # VMLINUX_SYMBOL(...)
5096 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
5097 WARN("MISSING_VMLINUX_SYMBOL",
5098 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
5101 # check for redundant bracing round if etc
5102 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
5103 my ($level, $endln, @chunks) =
5104 ctx_statement_full($linenr, $realcnt, 1);
5105 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
5106 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5107 if ($#chunks > 0 && $level == 0) {
5111 my $herectx = $here . "\n";
5112 my $ln = $linenr - 1;
5113 for my $chunk (@chunks) {
5114 my ($cond, $block) = @{$chunk};
5116 # If the condition carries leading newlines, then count those as offsets.
5117 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5118 my $offset = statement_rawlines($whitespace) - 1;
5120 $allowed[$allow] = 0;
5121 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5123 # We have looked at and allowed this specific line.
5124 $suppress_ifbraces{$ln + $offset} = 1;
5126 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
5127 $ln += statement_rawlines($block) - 1;
5129 substr($block, 0, length($cond), '');
5131 $seen++ if ($block =~ /^\s*{/);
5133 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5134 if (statement_lines($cond) > 1) {
5135 #print "APW: ALLOWED: cond<$cond>\n";
5136 $allowed[$allow] = 1;
5138 if ($block =~/\b(?:if|for|while)\b/) {
5139 #print "APW: ALLOWED: block<$block>\n";
5140 $allowed[$allow] = 1;
5142 if (statement_block_size($block) > 1) {
5143 #print "APW: ALLOWED: lines block<$block>\n";
5144 $allowed[$allow] = 1;
5149 my $sum_allowed = 0;
5150 foreach (@allowed) {
5153 if ($sum_allowed == 0) {
5155 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5156 } elsif ($sum_allowed != $allow &&
5159 "braces {} should be used on all arms of this statement\n" . $herectx);
5164 if (!defined $suppress_ifbraces{$linenr - 1} &&
5165 $line =~ /\b(if|while|for|else)\b/) {
5168 # Check the pre-context.
5169 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5170 #print "APW: ALLOWED: pre<$1>\n";
5174 my ($level, $endln, @chunks) =
5175 ctx_statement_full($linenr, $realcnt, $-[0]);
5177 # Check the condition.
5178 my ($cond, $block) = @{$chunks[0]};
5179 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5180 if (defined $cond) {
5181 substr($block, 0, length($cond), '');
5183 if (statement_lines($cond) > 1) {
5184 #print "APW: ALLOWED: cond<$cond>\n";
5187 if ($block =~/\b(?:if|for|while)\b/) {
5188 #print "APW: ALLOWED: block<$block>\n";
5191 if (statement_block_size($block) > 1) {
5192 #print "APW: ALLOWED: lines block<$block>\n";
5195 # Check the post-context.
5196 if (defined $chunks[1]) {
5197 my ($cond, $block) = @{$chunks[1]};
5198 if (defined $cond) {
5199 substr($block, 0, length($cond), '');
5201 if ($block =~ /^\s*\{/) {
5202 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5206 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
5207 my $herectx = $here . "\n";
5208 my $cnt = statement_rawlines($block);
5210 for (my $n = 0; $n < $cnt; $n++) {
5211 $herectx .= raw_line($linenr, $n) . "\n";
5215 "braces {} are not necessary for single statement blocks\n" . $herectx);
5219 # check for single line unbalanced braces
5220 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
5221 $sline =~ /^.\s*else\s*\{\s*$/) {
5222 CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
5225 # check for unnecessary blank lines around braces
5226 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
5228 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5229 $fix && $prevrawline =~ /^\+/) {
5230 fix_delete_line($fixlinenr - 1, $prevrawline);
5233 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
5235 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5237 fix_delete_line($fixlinenr, $rawline);
5241 # no volatiles please
5242 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5243 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
5245 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
5248 # Check for user-visible strings broken across lines, which breaks the ability
5249 # to grep for the string. Make exceptions when the previous string ends in a
5250 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5251 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
5252 if ($line =~ /^\+\s*$String/ &&
5253 $prevline =~ /"\s*$/ &&
5254 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5255 if (WARN("SPLIT_STRING",
5256 "quoted string split across lines\n" . $hereprev) &&
5258 $prevrawline =~ /^\+.*"\s*$/ &&
5259 $last_coalesced_string_linenr != $linenr - 1) {
5260 my $extracted_string = get_quoted_string($line, $rawline);
5261 my $comma_close = "";
5262 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5266 fix_delete_line($fixlinenr - 1, $prevrawline);
5267 fix_delete_line($fixlinenr, $rawline);
5268 my $fixedline = $prevrawline;
5269 $fixedline =~ s/"\s*$//;
5270 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5271 fix_insert_line($fixlinenr - 1, $fixedline);
5272 $fixedline = $rawline;
5273 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5274 if ($fixedline !~ /\+\s*$/) {
5275 fix_insert_line($fixlinenr, $fixedline);
5277 $last_coalesced_string_linenr = $linenr;
5281 # check for missing a space in a string concatenation
5282 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5283 WARN('MISSING_SPACE',
5284 "break quoted strings at a space character\n" . $hereprev);
5287 # check for an embedded function name in a string when the function is known
5288 # This does not work very well for -f --file checking as it depends on patch
5289 # context providing the function name or a single line form for in-file
5290 # function declarations
5291 if ($line =~ /^\+.*$String/ &&
5292 defined($context_function) &&
5293 get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
5294 length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
5295 WARN("EMBEDDED_FUNCTION_NAME",
5296 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
5299 # check for spaces before a quoted newline
5300 if ($rawline =~ /^.*\".*\s\\n/) {
5301 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5302 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5304 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5309 # concatenated string without spaces between elements
5310 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
5311 CHK("CONCATENATED_STRING",
5312 "Concatenated strings should use spaces between elements\n" . $herecurr);
5315 # uncoalesced string fragments
5316 if ($line =~ /$String\s*"/) {
5317 WARN("STRING_FRAGMENTS",
5318 "Consecutive strings are generally better as a single string\n" . $herecurr);
5321 # check for non-standard and hex prefixed decimal printf formats
5322 my $show_L = 1; #don't show the same defect twice
5324 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
5325 my $string = substr($rawline, $-[1], $+[1] - $-[1]);
5326 $string =~ s/%%/__/g;
5328 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
5330 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
5334 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
5336 "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
5339 # check for 0x<decimal>
5340 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
5341 ERROR("PRINTF_0XDECIMAL",
5342 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5346 # check for line continuations in quoted strings with odd counts of "
5347 if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
5348 WARN("LINE_CONTINUATIONS",
5349 "Avoid line continuations in quoted strings\n" . $herecurr);
5353 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
5354 CHK("REDUNDANT_CODE",
5355 "if this code is redundant consider removing it\n" .
5359 # check for needless "if (<foo>) fn(<foo>)" uses
5360 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
5361 my $tested = quotemeta($1);
5362 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5363 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5365 if (WARN('NEEDLESS_IF',
5366 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5369 my $leading_tabs = "";
5370 my $new_leading_tabs = "";
5371 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5376 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5377 $new_leading_tabs = $1;
5378 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5385 fix_delete_line($fixlinenr - 1, $prevrawline);
5386 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5392 # check for unnecessary "Out of Memory" messages
5393 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5394 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5395 (defined $1 || defined $3) &&
5398 my $testline = $lines[$linenr - 3];
5400 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5401 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5403 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)/) {
5405 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5409 # check for logging functions with KERN_<LEVEL>
5410 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
5411 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5413 if (WARN("UNNECESSARY_KERN_LEVEL",
5414 "Possible unnecessary $level\n" . $herecurr) &&
5416 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5420 # check for logging continuations
5421 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
5422 WARN("LOGGING_CONTINUATION",
5423 "Avoid logging continuation uses where feasible\n" . $herecurr);
5426 # check for mask then right shift without a parentheses
5427 if ($^V && $^V ge 5.10.0 &&
5428 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5429 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5430 WARN("MASK_THEN_SHIFT",
5431 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5434 # check for pointer comparisons to NULL
5435 if ($^V && $^V ge 5.10.0) {
5436 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5439 $equal = "" if ($4 eq "!=");
5440 if (CHK("COMPARISON_TO_NULL",
5441 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5443 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5448 # check for bad placement of section $InitAttribute (e.g.: __initdata)
5449 if ($line =~ /(\b$InitAttribute\b)/) {
5451 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5454 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5455 ERROR("MISPLACED_INIT",
5456 "$attr should be placed after $var\n" . $herecurr)) ||
5457 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5458 WARN("MISPLACED_INIT",
5459 "$attr should be placed after $var\n" . $herecurr))) &&
5461 $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;
5466 # check for $InitAttributeData (ie: __initdata) with const
5467 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5469 $attr =~ /($InitAttributePrefix)(.*)/;
5470 my $attr_prefix = $1;
5472 if (ERROR("INIT_ATTRIBUTE",
5473 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5475 $fixed[$fixlinenr] =~
5476 s/$InitAttributeData/${attr_prefix}initconst/;
5480 # check for $InitAttributeConst (ie: __initconst) without const
5481 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5483 if (ERROR("INIT_ATTRIBUTE",
5484 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5486 my $lead = $fixed[$fixlinenr] =~
5487 /(^\+\s*(?:static\s+))/;
5489 $lead = "$lead " if ($lead !~ /^\+$/);
5490 $lead = "${lead}const ";
5491 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
5495 # check for __read_mostly with const non-pointer (should just be const)
5496 if ($line =~ /\b__read_mostly\b/ &&
5497 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5498 if (ERROR("CONST_READ_MOSTLY",
5499 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5501 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5505 # don't use __constant_<foo> functions outside of include/uapi/
5506 if ($realfile !~ m@^include/uapi/@ &&
5507 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5508 my $constant_func = $1;
5509 my $func = $constant_func;
5510 $func =~ s/^__constant_//;
5511 if (WARN("CONSTANT_CONVERSION",
5512 "$constant_func should be $func\n" . $herecurr) &&
5514 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
5518 # prefer usleep_range over udelay
5519 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
5521 # ignore udelay's < 10, however
5522 if (! ($delay < 10) ) {
5524 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5526 if ($delay > 2000) {
5528 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
5532 # warn about unexpectedly long msleep's
5533 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5536 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5540 # check for comparisons of jiffies
5541 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5542 WARN("JIFFIES_COMPARISON",
5543 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5546 # check for comparisons of get_jiffies_64()
5547 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5548 WARN("JIFFIES_COMPARISON",
5549 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5552 # warn about #ifdefs in C files
5553 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5554 # print "#ifdef in C files should be avoided\n";
5555 # print "$herecurr";
5559 # warn about spacing in #ifdefs
5560 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
5561 if (ERROR("SPACING",
5562 "exactly one space required after that #$1\n" . $herecurr) &&
5564 $fixed[$fixlinenr] =~
5565 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5570 # check for spinlock_t definitions without a comment.
5571 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5572 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
5574 if (!ctx_has_comment($first_line, $linenr)) {
5575 CHK("UNCOMMENTED_DEFINITION",
5576 "$1 definition without comment\n" . $herecurr);
5579 # check for memory barriers without a comment.
5585 read_barrier_depends
5587 my $barrier_stems = qr{
5595 my $all_barriers = qr{
5597 smp_(?:$barrier_stems)|
5598 virt_(?:$barrier_stems)
5601 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
5602 if (!ctx_has_comment($first_line, $linenr)) {
5603 WARN("MEMORY_BARRIER",
5604 "memory barrier without comment\n" . $herecurr);
5608 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5610 if ($realfile !~ m@^include/asm-generic/@ &&
5611 $realfile !~ m@/barrier\.h$@ &&
5612 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5613 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5614 WARN("MEMORY_BARRIER",
5615 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5618 # check for waitqueue_active without a comment.
5619 if ($line =~ /\bwaitqueue_active\s*\(/) {
5620 if (!ctx_has_comment($first_line, $linenr)) {
5621 WARN("WAITQUEUE_ACTIVE",
5622 "waitqueue_active without comment\n" . $herecurr);
5626 # check for smp_read_barrier_depends and read_barrier_depends
5627 if (!$file && $line =~ /\b(smp_|)read_barrier_depends\s*\(/) {
5628 WARN("READ_BARRIER_DEPENDS",
5629 "$1read_barrier_depends should only be used in READ_ONCE or DEC Alpha code\n" . $herecurr);
5632 # check of hardware specific defines
5633 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5635 "architecture specific defines should be avoided\n" . $herecurr);
5638 # check that the storage class is not after a type
5639 if ($line =~ /\b($Type)\s+($Storage)\b/) {
5640 WARN("STORAGE_CLASS",
5641 "storage class '$2' should be located before type '$1'\n" . $herecurr);
5643 # Check that the storage class is at the beginning of a declaration
5644 if ($line =~ /\b$Storage\b/ &&
5645 $line !~ /^.\s*$Storage/ &&
5646 $line =~ /^.\s*(.+?)\$Storage\s/ &&
5647 $1 !~ /[\,\)]\s*$/) {
5648 WARN("STORAGE_CLASS",
5649 "storage class should be at the beginning of the declaration\n" . $herecurr);
5652 # check the location of the inline attribute, that it is between
5653 # storage class and type.
5654 if ($line =~ /\b$Type\s+$Inline\b/ ||
5655 $line =~ /\b$Inline\s+$Storage\b/) {
5656 ERROR("INLINE_LOCATION",
5657 "inline keyword should sit between storage class and type\n" . $herecurr);
5660 # Check for __inline__ and __inline, prefer inline
5661 if ($realfile !~ m@\binclude/uapi/@ &&
5662 $line =~ /\b(__inline__|__inline)\b/) {
5664 "plain inline is preferred over $1\n" . $herecurr) &&
5666 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
5671 # Check for __attribute__ packed, prefer __packed
5672 if ($realfile !~ m@\binclude/uapi/@ &&
5673 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
5674 WARN("PREFER_PACKED",
5675 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
5678 # Check for __attribute__ aligned, prefer __aligned
5679 if ($realfile !~ m@\binclude/uapi/@ &&
5680 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
5681 WARN("PREFER_ALIGNED",
5682 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
5685 # Check for __attribute__ format(printf, prefer __printf
5686 if ($realfile !~ m@\binclude/uapi/@ &&
5687 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
5688 if (WARN("PREFER_PRINTF",
5689 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5691 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5696 # Check for __attribute__ format(scanf, prefer __scanf
5697 if ($realfile !~ m@\binclude/uapi/@ &&
5698 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
5699 if (WARN("PREFER_SCANF",
5700 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5702 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5706 # Check for __attribute__ weak, or __weak declarations (may have link issues)
5707 if ($^V && $^V ge 5.10.0 &&
5708 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5709 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5710 $line =~ /\b__weak\b/)) {
5711 ERROR("WEAK_DECLARATION",
5712 "Using weak declarations can have unintended link defects\n" . $herecurr);
5715 # check for c99 types like uint8_t used outside of uapi/ and tools/
5716 if ($realfile !~ m@\binclude/uapi/@ &&
5717 $realfile !~ m@\btools/@ &&
5718 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5720 if ($type =~ /\b($typeC99Typedefs)\b/) {
5722 my $kernel_type = 'u';
5723 $kernel_type = 's' if ($type =~ /^_*[si]/);
5726 if (CHK("PREFER_KERNEL_TYPES",
5727 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5729 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5734 # check for cast of C90 native int or longer types constants
5735 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5738 if (WARN("TYPECAST_INT_CONSTANT",
5739 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5742 my $newconst = $const;
5743 $newconst =~ s/${Int_type}$//;
5744 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5745 if ($cast =~ /\blong\s+long\b/) {
5747 } elsif ($cast =~ /\blong\b/) {
5750 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5754 # check for sizeof(&)
5755 if ($line =~ /\bsizeof\s*\(\s*\&/) {
5756 WARN("SIZEOF_ADDRESS",
5757 "sizeof(& should be avoided\n" . $herecurr);
5760 # check for sizeof without parenthesis
5761 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
5762 if (WARN("SIZEOF_PARENTHESIS",
5763 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5765 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5769 # check for struct spinlock declarations
5770 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5771 WARN("USE_SPINLOCK_T",
5772 "struct spinlock should be spinlock_t\n" . $herecurr);
5775 # check for seq_printf uses that could be seq_puts
5776 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
5777 my $fmt = get_quoted_string($line, $rawline);
5780 if (WARN("PREFER_SEQ_PUTS",
5781 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5783 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
5788 # check for vsprintf extension %p<foo> misuses
5789 if ($^V && $^V ge 5.10.0 &&
5791 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
5792 $1 !~ /^_*volatile_*$/) {
5793 my $bad_extension = "";
5794 my $lc = $stat =~ tr@\n@@;
5795 $lc = $lc + $linenr;
5796 for (my $count = $linenr; $count <= $lc; $count++) {
5797 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
5799 if ($fmt =~ /(\%[\*\d\.]*p(?![\WSsBKRraEhMmIiUDdgVCbGNOx]).)/) {
5800 $bad_extension = $1;
5804 if ($bad_extension ne "") {
5805 my $stat_real = raw_line($linenr, 0);
5806 my $ext_type = "Invalid";
5808 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5809 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5811 if ($bad_extension =~ /p[Ff]/) {
5812 $ext_type = "Deprecated";
5813 $use = " - use %pS instead";
5814 $use =~ s/pS/ps/ if ($bad_extension =~ /pf/);
5816 WARN("VSPRINTF_POINTER_EXTENSION",
5817 "$ext_type vsprintf pointer extension '$bad_extension'$use\n" . "$here\n$stat_real\n");
5821 # Check for misused memsets
5822 if ($^V && $^V ge 5.10.0 &&
5824 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
5830 if ($ms_size =~ /^(0x|)0$/i) {
5832 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
5833 } elsif ($ms_size =~ /^(0x|)1$/i) {
5835 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5839 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5840 # if ($^V && $^V ge 5.10.0 &&
5842 # $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5843 # if (WARN("PREFER_ETHER_ADDR_COPY",
5844 # "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5846 # $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5850 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5851 # if ($^V && $^V ge 5.10.0 &&
5853 # $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5854 # WARN("PREFER_ETHER_ADDR_EQUAL",
5855 # "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5858 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5859 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5860 # if ($^V && $^V ge 5.10.0 &&
5862 # $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5866 # if ($ms_val =~ /^(?:0x|)0+$/i) {
5867 # if (WARN("PREFER_ETH_ZERO_ADDR",
5868 # "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5870 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5872 # } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5873 # if (WARN("PREFER_ETH_BROADCAST_ADDR",
5874 # "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5876 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5881 # typecasts on min/max could be min_t/max_t
5882 if ($^V && $^V ge 5.10.0 &&
5884 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
5885 if (defined $2 || defined $7) {
5887 my $cast1 = deparenthesize($2);
5889 my $cast2 = deparenthesize($7);
5893 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
5894 $cast = "$cast1 or $cast2";
5895 } elsif ($cast1 ne "") {
5901 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
5905 # check usleep_range arguments
5906 if ($^V && $^V ge 5.10.0 &&
5908 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5912 WARN("USLEEP_RANGE",
5913 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5914 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5916 WARN("USLEEP_RANGE",
5917 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5921 # check for naked sscanf
5922 if ($^V && $^V ge 5.10.0 &&
5924 $line =~ /\bsscanf\b/ &&
5925 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5926 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5927 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5928 my $lc = $stat =~ tr@\n@@;
5929 $lc = $lc + $linenr;
5930 my $stat_real = raw_line($linenr, 0);
5931 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5932 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5934 WARN("NAKED_SSCANF",
5935 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5938 # check for simple sscanf that should be kstrto<foo>
5939 if ($^V && $^V ge 5.10.0 &&
5941 $line =~ /\bsscanf\b/) {
5942 my $lc = $stat =~ tr@\n@@;
5943 $lc = $lc + $linenr;
5944 my $stat_real = raw_line($linenr, 0);
5945 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5946 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5948 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5950 my $count = $format =~ tr@%@%@;
5952 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5953 WARN("SSCANF_TO_KSTRTO",
5954 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5959 # check for new externs in .h files.
5960 if ($realfile =~ /\.h$/ &&
5961 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
5962 if (CHK("AVOID_EXTERNS",
5963 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
5965 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
5969 # check for new externs in .c files.
5970 if ($realfile =~ /\.c$/ && defined $stat &&
5971 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
5973 my $function_name = $1;
5974 my $paren_space = $2;
5977 if (defined $cond) {
5978 substr($s, 0, length($cond), '');
5980 if ($s =~ /^\s*;/ &&
5981 $function_name ne 'uninitialized_var')
5983 WARN("AVOID_EXTERNS",
5984 "externs should be avoided in .c files\n" . $herecurr);
5987 if ($paren_space =~ /\n/) {
5988 WARN("FUNCTION_ARGUMENTS",
5989 "arguments for function declarations should follow identifier\n" . $herecurr);
5992 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5993 $stat =~ /^.\s*extern\s+/)
5995 WARN("AVOID_EXTERNS",
5996 "externs should be avoided in .c files\n" . $herecurr);
5999 # check for function declarations that have arguments without identifier names
6000 if (defined $stat &&
6001 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
6003 my $args = trim($1);
6004 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
6006 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
6007 WARN("FUNCTION_ARGUMENTS",
6008 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
6013 # check for function definitions
6014 if ($^V && $^V ge 5.10.0 &&
6016 $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
6017 $context_function = $1;
6019 # check for multiline function definition with misplaced open brace
6021 my $cnt = statement_rawlines($stat);
6022 my $herectx = $here . "\n";
6023 for (my $n = 0; $n < $cnt; $n++) {
6024 my $rl = raw_line($linenr, $n);
6025 $herectx .= $rl . "\n";
6026 $ok = 1 if ($rl =~ /^[ \+]\{/);
6027 $ok = 1 if ($rl =~ /\{/ && $n == 0);
6028 last if $rl =~ /^[ \+].*\{/;
6032 "open brace '{' following function definitions go on the next line\n" . $herectx);
6036 # checks for new __setup's
6037 if ($rawline =~ /\b__setup\("([^"]*)"/) {
6040 if (!grep(/$name/, @setup_docs)) {
6041 CHK("UNDOCUMENTED_SETUP",
6042 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
6046 # check for pointless casting of kmalloc return
6047 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
6048 WARN("UNNECESSARY_CASTS",
6049 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
6053 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6054 if ($^V && $^V ge 5.10.0 &&
6055 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6056 CHK("ALLOC_SIZEOF_STRUCT",
6057 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
6060 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6061 if ($^V && $^V ge 5.10.0 &&
6063 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
6067 my $newfunc = "kmalloc_array";
6068 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
6071 if ($a1 =~ /^sizeof\s*\S/) {
6075 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
6076 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
6078 my $herectx = $here . "\n";
6079 my $cnt = statement_rawlines($stat);
6080 for (my $n = 0; $n < $cnt; $n++) {
6081 $herectx .= raw_line($linenr, $n) . "\n";
6083 if (WARN("ALLOC_WITH_MULTIPLY",
6084 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
6087 $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;
6092 # check for krealloc arg reuse
6093 if ($^V && $^V ge 5.10.0 &&
6094 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
6095 WARN("KREALLOC_ARG_REUSE",
6096 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
6099 # check for alloc argument mismatch
6100 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
6101 WARN("ALLOC_ARRAY_ARGS",
6102 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
6105 # check for multiple semicolons
6106 if ($line =~ /;\s*;\s*$/) {
6107 if (WARN("ONE_SEMICOLON",
6108 "Statements terminations use 1 semicolon\n" . $herecurr) &&
6110 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
6114 # check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6115 if ($realfile !~ m@^include/uapi/@ &&
6116 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
6118 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
6119 if (CHK("BIT_MACRO",
6120 "Prefer using the BIT$ull macro\n" . $herecurr) &&
6122 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
6126 # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6127 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6129 if (WARN("PREFER_IS_ENABLED",
6130 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
6132 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
6136 # check for case / default statements not preceded by break/fallthrough/switch
6137 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
6139 my $has_statement = 0;
6141 my $prevline = $linenr;
6142 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
6144 my $rline = $rawlines[$prevline - 1];
6145 my $fline = $lines[$prevline - 1];
6146 last if ($fline =~ /^\@\@/);
6147 next if ($fline =~ /^\-/);
6148 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
6149 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
6150 next if ($fline =~ /^.[\s$;]*$/);
6153 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/);
6155 if (!$has_break && $has_statement) {
6156 WARN("MISSING_BREAK",
6157 "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr);
6161 # check for switch/default statements without a break;
6162 if ($^V && $^V ge 5.10.0 &&
6164 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
6166 my $herectx = $here . "\n";
6167 my $cnt = statement_rawlines($stat);
6168 for (my $n = 0; $n < $cnt; $n++) {
6169 $herectx .= raw_line($linenr, $n) . "\n";
6171 WARN("DEFAULT_NO_BREAK",
6172 "switch default: should use break\n" . $herectx);
6175 # check for gcc specific __FUNCTION__
6176 if ($line =~ /\b__FUNCTION__\b/) {
6177 if (WARN("USE_FUNC",
6178 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
6180 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
6184 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
6185 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
6187 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
6190 # check for use of yield()
6191 if ($line =~ /\byield\s*\(\s*\)/) {
6193 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
6196 # check for comparisons against true and false
6197 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6205 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6207 my $type = lc($otype);
6208 if ($type =~ /^(?:true|false)$/) {
6209 if (("$test" eq "==" && "$type" eq "true") ||
6210 ("$test" eq "!=" && "$type" eq "false")) {
6214 CHK("BOOL_COMPARISON",
6215 "Using comparison to $otype is error prone\n" . $herecurr);
6217 ## maybe suggesting a correct construct would better
6218 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6223 # check for semaphores initialized locked
6224 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
6225 WARN("CONSIDER_COMPLETION",
6226 "consider using a completion\n" . $herecurr);
6229 # recommend kstrto* over simple_strto* and strict_strto*
6230 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
6231 WARN("CONSIDER_KSTRTO",
6232 "$1 is obsolete, use k$3 instead\n" . $herecurr);
6235 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
6236 if ($line =~ /^.\s*__initcall\s*\(/) {
6237 WARN("USE_DEVICE_INITCALL",
6238 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
6241 # check for various structs that are normally const (ops, kgdb, device_tree)
6242 # and avoid what seem like struct definitions 'struct foo {'
6243 if ($line !~ /\bconst\b/ &&
6244 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
6245 WARN("CONST_STRUCT",
6246 "struct $1 should normally be const\n" . $herecurr);
6249 # use of NR_CPUS is usually wrong
6250 # ignore definitions of NR_CPUS and usage to define arrays as likely right
6251 if ($line =~ /\bNR_CPUS\b/ &&
6252 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6253 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
6254 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6255 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6256 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
6259 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
6262 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6263 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6264 ERROR("DEFINE_ARCH_HAS",
6265 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6268 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
6269 if ($^V && $^V ge 5.10.0 &&
6270 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6271 WARN("LIKELY_MISUSE",
6272 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6275 # whine mightly about in_atomic
6276 if ($line =~ /\bin_atomic\s*\(/) {
6277 if ($realfile =~ m@^drivers/@) {
6279 "do not use in_atomic in drivers\n" . $herecurr);
6280 } elsif ($realfile !~ m@^kernel/@) {
6282 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
6286 # check for mutex_trylock_recursive usage
6287 if ($line =~ /mutex_trylock_recursive/) {
6289 "recursive locking is bad, do not use this ever.\n" . $herecurr);
6292 # check for lockdep_set_novalidate_class
6293 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6294 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6295 if ($realfile !~ m@^kernel/lockdep@ &&
6296 $realfile !~ m@^include/linux/lockdep@ &&
6297 $realfile !~ m@^drivers/base/core@) {
6299 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
6303 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6304 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
6305 WARN("EXPORTED_WORLD_WRITABLE",
6306 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6309 # check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6310 # and whether or not function naming is typical and if
6311 # DEVICE_ATTR permissions uses are unusual too
6312 if ($^V && $^V ge 5.10.0 &&
6314 $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*\)/) {
6319 my $octal_perms = perms_to_octal($perms);
6320 if ($show =~ /^${var}_show$/ &&
6321 $store =~ /^${var}_store$/ &&
6322 $octal_perms eq "0644") {
6323 if (WARN("DEVICE_ATTR_RW",
6324 "Use DEVICE_ATTR_RW\n" . $herecurr) &&
6326 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6328 } elsif ($show =~ /^${var}_show$/ &&
6329 $store =~ /^NULL$/ &&
6330 $octal_perms eq "0444") {
6331 if (WARN("DEVICE_ATTR_RO",
6332 "Use DEVICE_ATTR_RO\n" . $herecurr) &&
6334 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6336 } elsif ($show =~ /^NULL$/ &&
6337 $store =~ /^${var}_store$/ &&
6338 $octal_perms eq "0200") {
6339 if (WARN("DEVICE_ATTR_WO",
6340 "Use DEVICE_ATTR_WO\n" . $herecurr) &&
6342 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6344 } elsif ($octal_perms eq "0644" ||
6345 $octal_perms eq "0444" ||
6346 $octal_perms eq "0200") {
6347 my $newshow = "$show";
6348 $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show");
6349 my $newstore = $store;
6350 $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store");
6352 if ($show ne $newshow) {
6353 $rename .= " '$show' to '$newshow'";
6355 if ($store ne $newstore) {
6356 $rename .= " '$store' to '$newstore'";
6358 WARN("DEVICE_ATTR_FUNCTIONS",
6359 "Consider renaming function(s)$rename\n" . $herecurr);
6361 WARN("DEVICE_ATTR_PERMS",
6362 "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr);
6366 # Mode permission misuses where it seems decimal should be octal
6367 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6368 # o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6369 # specific definition of not visible in sysfs.
6370 # o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6371 # use the default permissions
6372 if ($^V && $^V ge 5.10.0 &&
6374 $line =~ /$mode_perms_search/) {
6375 foreach my $entry (@mode_permission_funcs) {
6376 my $func = $entry->[0];
6377 my $arg_pos = $entry->[1];
6379 my $lc = $stat =~ tr@\n@@;
6380 $lc = $lc + $linenr;
6381 my $stat_real = raw_line($linenr, 0);
6382 for (my $count = $linenr + 1; $count <= $lc; $count++) {
6383 $stat_real = $stat_real . "\n" . raw_line($count, 0);
6389 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6391 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
6392 if ($stat =~ /$test/) {
6394 $val = $6 if ($skip_args ne "");
6395 if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
6396 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6397 ($val =~ /^$Octal$/ && length($val) ne 4))) {
6398 ERROR("NON_OCTAL_PERMISSIONS",
6399 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
6401 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
6402 ERROR("EXPORTED_WORLD_WRITABLE",
6403 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
6409 # check for uses of S_<PERMS> that could be octal for readability
6410 if ($line =~ /\b($multi_mode_perms_string_search)\b/) {
6412 my $octal = perms_to_octal($oval);
6413 if (WARN("SYMBOLIC_PERMS",
6414 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6416 $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
6420 # validate content of MODULE_LICENSE against list from include/linux/module.h
6421 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6422 my $extracted_string = get_quoted_string($line, $rawline);
6423 my $valid_licenses = qr{
6426 GPL\ and\ additional\ rights|
6432 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6433 WARN("MODULE_LICENSE",
6434 "unknown module license " . $extracted_string . "\n" . $herecurr);
6439 # If we have no input at all, then there is nothing to report on
6440 # so just keep quiet.
6441 if ($#rawlines == -1) {
6445 # In mailback mode only produce a report in the negative, for
6446 # things that appear to be patches.
6447 if ($mailback && ($clean == 1 || !$is_patch)) {
6451 # This is not a patch, and we are are in 'no-patch' mode so
6453 if (!$chk_patch && !$is_patch) {
6457 if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
6458 ERROR("NOT_UNIFIED_DIFF",
6459 "Does not appear to be a unified-diff format patch\n");
6461 if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) {
6462 ERROR("MISSING_SIGN_OFF",
6463 "Missing Signed-off-by: line(s)\n");
6466 print report_dump();
6467 if ($summary && !($clean == 1 && $quiet == 1)) {
6468 print "$filename " if ($summary_file);
6469 print "total: $cnt_error errors, $cnt_warn warnings, " .
6470 (($check)? "$cnt_chk checks, " : "") .
6471 "$cnt_lines lines checked\n";
6475 # If there were any defects found and not already fixing them
6476 if (!$clean and !$fix) {
6479 NOTE: For some of the reported defects, checkpatch may be able to
6480 mechanically convert to the typical style using --fix or --fix-inplace.
6483 # If there were whitespace errors which cleanpatch can fix
6484 # then suggest that.
6485 if ($rpt_cleaners) {
6489 NOTE: Whitespace errors detected.
6490 You may wish to use scripts/cleanpatch or scripts/cleanfile
6495 if ($clean == 0 && $fix &&
6496 ("@rawlines" ne "@fixed" ||
6497 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
6498 my $newfile = $filename;
6499 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
6503 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6505 open($f, '>', $newfile)
6506 or die "$P: Can't open $newfile for write\n";
6507 foreach my $fixed_line (@fixed) {
6510 if ($linecount > 3) {
6511 $fixed_line =~ s/^\+//;
6512 print $f $fixed_line . "\n";
6515 print $f $fixed_line . "\n";
6523 Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6525 Do _NOT_ trust the results written to this file.
6526 Do _NOT_ submit these changes without inspecting them for correctness.
6528 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6529 No warranties, expressed or implied...
6537 print "$vname has no obvious style problems and is ready for submission.\n";
6539 print "$vname has style problems, please review.\n";