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
12 use Term::ANSIColor qw(:constants);
15 my $D = dirname(abs_path($P));
19 use Getopt::Long qw(:config no_auto_abbrev);
49 my $configuration_file = ".checkpatch.conf";
50 my $max_line_length = 80;
51 my $ignore_perl_version = 0;
52 my $minimum_perl_version = 5.10.0;
53 my $min_conf_desc_length = 4;
54 my $spelling_file = "$D/spelling.txt";
56 my $codespellfile = "/usr/share/codespell/dictionary.txt";
57 my $conststructsfile = "$D/const_structs.checkpatch";
59 my $allow_c99_comments = 1;
65 Usage: $P [OPTION]... [FILE]...
70 --no-tree run without a kernel tree
71 --no-signoff do not check for 'Signed-off-by' line
72 --patch treat FILE as patchfile (default)
73 --emacs emacs compile window format
74 --terse one line per report
75 --showfile emit diffed file position, not input file position
76 -g, --git treat FILE as a single commit or git revision range
77 single git commit with:
81 multiple git commits with:
85 git merges are ignored
86 -f, --file treat FILE as regular source file
87 --subjective, --strict enable more subjective tests
88 --list-types list the possible message types
89 --types TYPE(,TYPE2...) show only these comma separated message types
90 --ignore TYPE(,TYPE2...) ignore various comma separated message types
91 --show-types show the specific message type in the output
92 --max-line-length=n set the maximum line length, if exceeded, warn
93 --min-conf-desc-length=n set the min description length, if shorter, warn
94 --root=PATH PATH to the kernel tree root
95 --no-summary suppress the per-file summary
96 --mailback only produce a report in case of warnings/errors
97 --summary-file include the filename in summary
98 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
99 'values', 'possible', 'type', and 'attr' (default
101 --test-only=WORD report only warnings/errors containing WORD
103 --fix EXPERIMENTAL - may create horrible results
104 If correctable single-line errors exist, create
105 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
106 with potential errors corrected to the preferred
108 --fix-inplace EXPERIMENTAL - may create horrible results
109 Is the same as --fix, but overwrites the input
110 file. It's your fault if there's no backup or git
111 --ignore-perl-version override checking of perl version. expect
113 --codespell Use the codespell dictionary for spelling/typos
114 (default:/usr/share/codespell/dictionary.txt)
115 --codespellfile Use this codespell dictionary
116 --color Use colors when output is STDOUT (default: on)
117 -h, --help, --version display this help and exit
119 When FILE is - read standard input.
127 return grep { !$seen{$_}++ } @_;
137 open(my $script, '<', abs_path($P)) or
138 die "$P: Can't read '$P' $!\n";
140 my $text = <$script>;
144 for ($text =~ /\b(?:(?:CHK|WARN|ERROR)\s*\(\s*"([^"]+)")/g) {
147 @types = sort(uniq(@types));
148 print("#\tMessage type\n\n");
149 foreach my $type (@types) {
150 print(++$count . "\t" . $type . "\n");
156 my $conf = which_conf($configuration_file);
159 open(my $conffile, '<', "$conf")
160 or warn "$P: Can't find a readable $configuration_file file $!\n";
162 while (<$conffile>) {
165 $line =~ s/\s*\n?$//g;
169 next if ($line =~ m/^\s*#/);
170 next if ($line =~ m/^\s*$/);
172 my @words = split(" ", $line);
173 foreach my $word (@words) {
174 last if ($word =~ m/^#/);
175 push (@conf_args, $word);
179 unshift(@ARGV, @conf_args) if @conf_args;
183 'q|quiet+' => \$quiet,
185 'signoff!' => \$chk_signoff,
186 'patch!' => \$chk_patch,
189 'showfile!' => \$showfile,
192 'subjective!' => \$check,
193 'strict!' => \$check,
194 'ignore=s' => \@ignore,
196 'show-types!' => \$show_types,
197 'list-types!' => \$list_types,
198 'max-line-length=i' => \$max_line_length,
199 'min-conf-desc-length=i' => \$min_conf_desc_length,
201 'summary!' => \$summary,
202 'mailback!' => \$mailback,
203 'summary-file!' => \$summary_file,
205 'fix-inplace!' => \$fix_inplace,
206 'ignore-perl-version!' => \$ignore_perl_version,
207 'debug=s' => \%debug,
208 'test-only=s' => \$tst_only,
209 'codespell!' => \$codespell,
210 'codespellfile=s' => \$codespellfile,
218 list_types(0) if ($list_types);
220 $fix = 1 if ($fix_inplace);
221 $check_orig = $check;
225 if ($^V && $^V lt $minimum_perl_version) {
226 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
227 if (!$ignore_perl_version) {
232 #if no filenames are given, push '-' to read patch from stdin
237 sub hash_save_array_words {
238 my ($hashRef, $arrayRef) = @_;
240 my @array = split(/,/, join(',', @$arrayRef));
241 foreach my $word (@array) {
242 $word =~ s/\s*\n?$//g;
245 $word =~ tr/[a-z]/[A-Z]/;
247 next if ($word =~ m/^\s*#/);
248 next if ($word =~ m/^\s*$/);
254 sub hash_show_words {
255 my ($hashRef, $prefix) = @_;
257 if (keys %$hashRef) {
258 print "\nNOTE: $prefix message types:";
259 foreach my $word (sort keys %$hashRef) {
266 hash_save_array_words(\%ignore_type, \@ignore);
267 hash_save_array_words(\%use_type, \@use);
270 my $dbg_possible = 0;
273 for my $key (keys %debug) {
275 eval "\${dbg_$key} = '$debug{$key}';";
279 my $rpt_cleaners = 0;
288 if (!top_of_kernel_tree($root)) {
289 die "$P: $root: --root does not point at a valid tree\n";
292 if (top_of_kernel_tree('.')) {
294 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
295 top_of_kernel_tree($1)) {
300 if (!defined $root) {
301 print "Must be run from the top-level dir. of a kernel tree\n";
306 my $emitted_corrupt = 0;
309 [A-Za-z_][A-Za-z\d_]*
310 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
312 our $Storage = qr{extern|static|asmlinkage};
325 our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
326 our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
327 our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
328 our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
329 our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
331 # Notes to $Attribute:
332 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
353 ____cacheline_aligned|
354 ____cacheline_aligned_in_smp|
355 ____cacheline_internodealigned_in_smp|
359 our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
360 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
361 our $Lval = qr{$Ident(?:$Member)*};
363 our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
364 our $Binary = qr{(?i)0b[01]+$Int_type?};
365 our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
366 our $Int = qr{[0-9]+$Int_type?};
367 our $Octal = qr{0[0-7]+$Int_type?};
368 our $String = qr{"[X\t]*"};
369 our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
370 our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
371 our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
372 our $Float = qr{$Float_hex|$Float_dec|$Float_int};
373 our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
374 our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
375 our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
376 our $Arithmetic = qr{\+|-|\*|\/|%};
380 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
383 our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
387 our $NonptrTypeMisordered;
388 our $NonptrTypeWithAttr;
392 our $DeclareMisordered;
394 our $NON_ASCII_UTF8 = qr{
395 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
396 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
397 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
398 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
399 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
400 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
401 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
405 [\x09\x0A\x0D\x20-\x7E] # ASCII
409 our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
410 our $typeOtherOSTypedefs = qr{(?x:
411 u_(?:char|short|int|long) | # bsd
412 u(?:nchar|short|int|long) # sysv
414 our $typeKernelTypedefs = qr{(?x:
415 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
418 our $typeTypedefs = qr{(?x:
420 $typeOtherOSTypedefs\b|
421 $typeKernelTypedefs\b
424 our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
426 our $logFunctions = qr{(?x:
427 printk(?:_ratelimited|_once|)|
428 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
429 WARN(?:_RATELIMIT|_ONCE|)|
432 seq_vprintf|seq_printf|seq_puts
435 our $signature_tags = qr{(?xi:
446 our @typeListMisordered = (
447 qr{char\s+(?:un)?signed},
448 qr{int\s+(?:(?:un)?signed\s+)?short\s},
449 qr{int\s+short(?:\s+(?:un)?signed)},
450 qr{short\s+int(?:\s+(?:un)?signed)},
451 qr{(?:un)?signed\s+int\s+short},
452 qr{short\s+(?:un)?signed},
453 qr{long\s+int\s+(?:un)?signed},
454 qr{int\s+long\s+(?:un)?signed},
455 qr{long\s+(?:un)?signed\s+int},
456 qr{int\s+(?:un)?signed\s+long},
457 qr{int\s+(?:un)?signed},
458 qr{int\s+long\s+long\s+(?:un)?signed},
459 qr{long\s+long\s+int\s+(?:un)?signed},
460 qr{long\s+long\s+(?:un)?signed\s+int},
461 qr{long\s+long\s+(?:un)?signed},
462 qr{long\s+(?:un)?signed},
467 qr{(?:(?:un)?signed\s+)?char},
468 qr{(?:(?:un)?signed\s+)?short\s+int},
469 qr{(?:(?:un)?signed\s+)?short},
470 qr{(?:(?:un)?signed\s+)?int},
471 qr{(?:(?:un)?signed\s+)?long\s+int},
472 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
473 qr{(?:(?:un)?signed\s+)?long\s+long},
474 qr{(?:(?:un)?signed\s+)?long},
483 qr{${Ident}_handler},
484 qr{${Ident}_handler_fn},
488 our $C90_int_types = qr{(?x:
489 long\s+long\s+int\s+(?:un)?signed|
490 long\s+long\s+(?:un)?signed\s+int|
491 long\s+long\s+(?:un)?signed|
492 (?:(?:un)?signed\s+)?long\s+long\s+int|
493 (?:(?:un)?signed\s+)?long\s+long|
494 int\s+long\s+long\s+(?:un)?signed|
495 int\s+(?:(?:un)?signed\s+)?long\s+long|
497 long\s+int\s+(?:un)?signed|
498 long\s+(?:un)?signed\s+int|
499 long\s+(?:un)?signed|
500 (?:(?:un)?signed\s+)?long\s+int|
501 (?:(?:un)?signed\s+)?long|
502 int\s+long\s+(?:un)?signed|
503 int\s+(?:(?:un)?signed\s+)?long|
506 (?:(?:un)?signed\s+)?int
509 our @typeListFile = ();
510 our @typeListWithAttr = (
512 qr{struct\s+$InitAttribute\s+$Ident},
513 qr{union\s+$InitAttribute\s+$Ident},
516 our @modifierList = (
519 our @modifierListFile = ();
521 our @mode_permission_funcs = (
523 ["module_param_(?:array|named|string)", 4],
524 ["module_param_array_named", 5],
525 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
526 ["proc_create(?:_data|)", 2],
527 ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2],
528 ["IIO_DEV_ATTR_[A-Z_]+", 1],
529 ["SENSOR_(?:DEVICE_|)ATTR_2", 2],
530 ["SENSOR_TEMPLATE(?:_2|)", 3],
534 #Create a search pattern for all these functions to speed up a loop below
535 our $mode_perms_search = "";
536 foreach my $entry (@mode_permission_funcs) {
537 $mode_perms_search .= '|' if ($mode_perms_search ne "");
538 $mode_perms_search .= $entry->[0];
541 our $mode_perms_world_writable = qr{
549 our %mode_permission_string_types = (
568 #Create a search pattern for all these strings to speed up a loop below
569 our $mode_perms_string_search = "";
570 foreach my $entry (keys %mode_permission_string_types) {
571 $mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
572 $mode_perms_string_search .= $entry;
575 our $allowed_asm_includes = qr{(?x:
581 # memory.h: ARM has a custom one
583 # Load common spelling mistakes and build regular expression list.
587 if (open(my $spelling, '<', $spelling_file)) {
588 while (<$spelling>) {
591 $line =~ s/\s*\n?$//g;
594 next if ($line =~ m/^\s*#/);
595 next if ($line =~ m/^\s*$/);
597 my ($suspect, $fix) = split(/\|\|/, $line);
599 $spelling_fix{$suspect} = $fix;
603 warn "No typos will be found - file '$spelling_file': $!\n";
607 if (open(my $spelling, '<', $codespellfile)) {
608 while (<$spelling>) {
611 $line =~ s/\s*\n?$//g;
614 next if ($line =~ m/^\s*#/);
615 next if ($line =~ m/^\s*$/);
616 next if ($line =~ m/, disabled/i);
620 my ($suspect, $fix) = split(/->/, $line);
622 $spelling_fix{$suspect} = $fix;
626 warn "No codespell typos will be found - file '$codespellfile': $!\n";
630 $misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
632 my $const_structs = "";
633 if (open(my $conststructs, '<', $conststructsfile)) {
634 while (<$conststructs>) {
637 $line =~ s/\s*\n?$//g;
640 next if ($line =~ m/^\s*#/);
641 next if ($line =~ m/^\s*$/);
643 print("$conststructsfile: '$line' invalid - ignored\n");
647 $const_structs .= '|' if ($const_structs ne "");
648 $const_structs .= $line;
650 close($conststructsfile);
652 warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
656 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
657 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
658 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
659 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
660 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
666 (?:$Modifier\s+|const\s+)*
668 (?:typeof|__typeof__)\s*\([^\)]*\)|
672 (?:\s+$Modifier|\s+const)*
674 $NonptrTypeMisordered = qr{
675 (?:$Modifier\s+|const\s+)*
679 (?:\s+$Modifier|\s+const)*
681 $NonptrTypeWithAttr = qr{
682 (?:$Modifier\s+|const\s+)*
684 (?:typeof|__typeof__)\s*\([^\)]*\)|
688 (?:\s+$Modifier|\s+const)*
692 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
693 (?:\s+$Inline|\s+$Modifier)*
695 $TypeMisordered = qr{
696 $NonptrTypeMisordered
697 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
698 (?:\s+$Inline|\s+$Modifier)*
700 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
701 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
705 our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
707 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
708 # requires at least perl version v5.10.0
709 # Any use must be runtime checked with $^V
711 our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
712 our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
713 our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
715 our $declaration_macros = qr{(?x:
716 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
717 (?:$Storage\s+)?LIST_HEAD\s*\(|
718 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
723 return "" if (!defined($string));
725 while ($string =~ /^\s*\(.*\)\s*$/) {
726 $string =~ s@^\s*\(\s*@@;
727 $string =~ s@\s*\)\s*$@@;
730 $string =~ s@\s+@ @g;
735 sub seed_camelcase_file {
738 return if (!(-f $file));
742 open(my $include_file, '<', "$file")
743 or warn "$P: Can't read '$file' $!\n";
744 my $text = <$include_file>;
745 close($include_file);
747 my @lines = split('\n', $text);
749 foreach my $line (@lines) {
750 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
751 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
753 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
755 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
761 sub is_maintained_obsolete {
764 return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl"));
766 my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
768 return $status =~ /obsolete/i;
771 my $camelcase_seeded = 0;
772 sub seed_camelcase_includes {
773 return if ($camelcase_seeded);
776 my $camelcase_cache = "";
777 my @include_files = ();
779 $camelcase_seeded = 1;
782 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
783 chomp $git_last_include_commit;
784 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
786 my $last_mod_date = 0;
787 $files = `find $root/include -name "*.h"`;
788 @include_files = split('\n', $files);
789 foreach my $file (@include_files) {
790 my $date = POSIX::strftime("%Y%m%d%H%M",
791 localtime((stat $file)[9]));
792 $last_mod_date = $date if ($last_mod_date < $date);
794 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
797 if ($camelcase_cache ne "" && -f $camelcase_cache) {
798 open(my $camelcase_file, '<', "$camelcase_cache")
799 or warn "$P: Can't read '$camelcase_cache' $!\n";
800 while (<$camelcase_file>) {
804 close($camelcase_file);
810 $files = `git ls-files "include/*.h"`;
811 @include_files = split('\n', $files);
814 foreach my $file (@include_files) {
815 seed_camelcase_file($file);
818 if ($camelcase_cache ne "") {
819 unlink glob ".checkpatch-camelcase.*";
820 open(my $camelcase_file, '>', "$camelcase_cache")
821 or warn "$P: Can't write '$camelcase_cache' $!\n";
822 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
823 print $camelcase_file ("$_\n");
825 close($camelcase_file);
829 sub git_commit_info {
830 my ($commit, $id, $desc) = @_;
832 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
834 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
835 $output =~ s/^\s*//gm;
836 my @lines = split("\n", $output);
838 return ($id, $desc) if ($#lines < 0);
840 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
841 # Maybe one day convert this block of bash into something that returns
842 # all matching commit ids, but it's very slow...
844 # echo "checking commits $1..."
845 # git rev-list --remotes | grep -i "^$1" |
846 # while read line ; do
847 # git log --format='%H %s' -1 $line |
848 # echo "commit $(cut -c 1-12,41-)"
850 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
852 $id = substr($lines[0], 0, 12);
853 $desc = substr($lines[0], 41);
859 $chk_signoff = 0 if ($file);
864 my @fixed_inserted = ();
865 my @fixed_deleted = ();
868 # If input is git commits, extract all commits from the commit expressions.
869 # For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
870 die "$P: No git repository found\n" if ($git && !-e ".git");
874 foreach my $commit_expr (@ARGV) {
876 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
877 $git_range = "-$2 $1";
878 } elsif ($commit_expr =~ m/\.\./) {
879 $git_range = "$commit_expr";
881 $git_range = "-1 $commit_expr";
883 my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
884 foreach my $line (split(/\n/, $lines)) {
885 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
886 next if (!defined($1) || !defined($2));
889 unshift(@commits, $sha1);
890 $git_commits{$sha1} = $subject;
893 die "$P: no git commits after extraction!\n" if (@commits == 0);
898 for my $filename (@ARGV) {
901 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
902 die "$P: $filename: git format-patch failed - $!\n";
904 open($FILE, '-|', "diff -u /dev/null $filename") ||
905 die "$P: $filename: diff failed - $!\n";
906 } elsif ($filename eq '-') {
907 open($FILE, '<&STDIN');
909 open($FILE, '<', "$filename") ||
910 die "$P: $filename: open failed - $!\n";
912 if ($filename eq '-') {
913 $vname = 'Your patch';
915 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
925 if ($#ARGV > 0 && $quiet == 0) {
926 print '-' x length($vname) . "\n";
928 print '-' x length($vname) . "\n";
931 if (!process($filename)) {
937 @fixed_inserted = ();
940 @modifierListFile = ();
946 hash_show_words(\%use_type, "Used");
947 hash_show_words(\%ignore_type, "Ignored");
952 NOTE: perl $^V is not modern enough to detect all possible issues.
953 An upgrade to at least perl v5.10.0 is suggested.
959 NOTE: If any of the errors are false positives, please report
960 them to the maintainer, see CHECKPATCH in MAINTAINERS.
967 sub top_of_kernel_tree {
971 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
972 "README", "Documentation", "arch", "include", "drivers",
973 "fs", "init", "ipc", "kernel", "lib", "scripts",
976 foreach my $check (@tree_check) {
977 if (! -e $root . '/' . $check) {
985 my ($formatted_email) = @_;
991 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
994 $comment = $3 if defined $3;
995 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
997 $comment = $2 if defined $2;
998 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
1000 $comment = $2 if defined $2;
1001 $formatted_email =~ s/$address.*$//;
1002 $name = $formatted_email;
1003 $name = trim($name);
1004 $name =~ s/^\"|\"$//g;
1005 # If there's a name left after stripping spaces and
1006 # leading quotes, and the address doesn't have both
1007 # leading and trailing angle brackets, the address
1009 # "joe smith joe@smith.com" bad
1010 # "joe smith <joe@smith.com" bad
1011 if ($name ne "" && $address !~ /^<[^>]+>$/) {
1018 $name = trim($name);
1019 $name =~ s/^\"|\"$//g;
1020 $address = trim($address);
1021 $address =~ s/^\<|\>$//g;
1023 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1024 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1025 $name = "\"$name\"";
1028 return ($name, $address, $comment);
1032 my ($name, $address) = @_;
1034 my $formatted_email;
1036 $name = trim($name);
1037 $name =~ s/^\"|\"$//g;
1038 $address = trim($address);
1040 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1041 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1042 $name = "\"$name\"";
1045 if ("$name" eq "") {
1046 $formatted_email = "$address";
1048 $formatted_email = "$name <$address>";
1051 return $formatted_email;
1057 foreach my $path (split(/:/, $ENV{PATH})) {
1058 if (-e "$path/$bin") {
1059 return "$path/$bin";
1069 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1070 if (-e "$path/$conf") {
1071 return "$path/$conf";
1083 for my $c (split(//, $str)) {
1087 for (; ($n % 8) != 0; $n++) {
1099 (my $res = shift) =~ tr/\t/ /c;
1106 # Drop the diff line leader and expand tabs
1108 $line = expand_tabs($line);
1110 # Pick the indent from the front of the line.
1111 my ($white) = ($line =~ /^(\s*)/);
1113 return (length($line), length($white));
1116 my $sanitise_quote = '';
1118 sub sanitise_line_reset {
1119 my ($in_comment) = @_;
1122 $sanitise_quote = '*/';
1124 $sanitise_quote = '';
1137 # Always copy over the diff marker.
1138 $res = substr($line, 0, 1);
1140 for ($off = 1; $off < length($line); $off++) {
1141 $c = substr($line, $off, 1);
1143 # Comments we are wacking completly including the begin
1144 # and end, all to $;.
1145 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1146 $sanitise_quote = '*/';
1148 substr($res, $off, 2, "$;$;");
1152 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
1153 $sanitise_quote = '';
1154 substr($res, $off, 2, "$;$;");
1158 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1159 $sanitise_quote = '//';
1161 substr($res, $off, 2, $sanitise_quote);
1166 # A \ in a string means ignore the next character.
1167 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1169 substr($res, $off, 2, 'XX');
1174 if ($c eq "'" || $c eq '"') {
1175 if ($sanitise_quote eq '') {
1176 $sanitise_quote = $c;
1178 substr($res, $off, 1, $c);
1180 } elsif ($sanitise_quote eq $c) {
1181 $sanitise_quote = '';
1185 #print "c<$c> SQ<$sanitise_quote>\n";
1186 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1187 substr($res, $off, 1, $;);
1188 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1189 substr($res, $off, 1, $;);
1190 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1191 substr($res, $off, 1, 'X');
1193 substr($res, $off, 1, $c);
1197 if ($sanitise_quote eq '//') {
1198 $sanitise_quote = '';
1201 # The pathname on a #include may be surrounded by '<' and '>'.
1202 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
1203 my $clean = 'X' x length($1);
1204 $res =~ s@\<.*\>@<$clean>@;
1206 # The whole of a #error is a string.
1207 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
1208 my $clean = 'X' x length($1);
1209 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
1212 if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1214 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1220 sub get_quoted_string {
1221 my ($line, $rawline) = @_;
1223 return "" if ($line !~ m/($String)/g);
1224 return substr($rawline, $-[0], $+[0] - $-[0]);
1227 sub ctx_statement_block {
1228 my ($linenr, $remain, $off) = @_;
1229 my $line = $linenr - 1;
1232 my $coff = $off - 1;
1246 @stack = (['', 0]) if ($#stack == -1);
1248 #warn "CSB: blk<$blk> remain<$remain>\n";
1249 # If we are about to drop off the end, pull in more
1252 for (; $remain > 0; $line++) {
1253 last if (!defined $lines[$line]);
1254 next if ($lines[$line] =~ /^-/);
1257 $blk .= $lines[$line] . "\n";
1258 $len = length($blk);
1262 # Bail if there is no further context.
1263 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1267 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1273 $c = substr($blk, $off, 1);
1274 $remainder = substr($blk, $off);
1276 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1278 # Handle nested #if/#else.
1279 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1280 push(@stack, [ $type, $level ]);
1281 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1282 ($type, $level) = @{$stack[$#stack - 1]};
1283 } elsif ($remainder =~ /^#\s*endif\b/) {
1284 ($type, $level) = @{pop(@stack)};
1287 # Statement ends at the ';' or a close '}' at the
1289 if ($level == 0 && $c eq ';') {
1293 # An else is really a conditional as long as its not else if
1294 if ($level == 0 && $coff_set == 0 &&
1295 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1296 $remainder =~ /^(else)(?:\s|{)/ &&
1297 $remainder !~ /^else\s+if\b/) {
1298 $coff = $off + length($1) - 1;
1300 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1301 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1304 if (($type eq '' || $type eq '(') && $c eq '(') {
1308 if ($type eq '(' && $c eq ')') {
1310 $type = ($level != 0)? '(' : '';
1312 if ($level == 0 && $coff < $soff) {
1315 #warn "CSB: mark coff<$coff>\n";
1318 if (($type eq '' || $type eq '{') && $c eq '{') {
1322 if ($type eq '{' && $c eq '}') {
1324 $type = ($level != 0)? '{' : '';
1327 if (substr($blk, $off + 1, 1) eq ';') {
1333 # Preprocessor commands end at the newline unless escaped.
1334 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1342 # We are truly at the end, so shuffle to the next line.
1349 my $statement = substr($blk, $soff, $off - $soff + 1);
1350 my $condition = substr($blk, $soff, $coff - $soff + 1);
1352 #warn "STATEMENT<$statement>\n";
1353 #warn "CONDITION<$condition>\n";
1355 #print "coff<$coff> soff<$off> loff<$loff>\n";
1357 return ($statement, $condition,
1358 $line, $remain + 1, $off - $loff + 1, $level);
1361 sub statement_lines {
1364 # Strip the diff line prefixes and rip blank lines at start and end.
1365 $stmt =~ s/(^|\n)./$1/g;
1369 my @stmt_lines = ($stmt =~ /\n/g);
1371 return $#stmt_lines + 2;
1374 sub statement_rawlines {
1377 my @stmt_lines = ($stmt =~ /\n/g);
1379 return $#stmt_lines + 2;
1382 sub statement_block_size {
1385 $stmt =~ s/(^|\n)./$1/g;
1391 my @stmt_lines = ($stmt =~ /\n/g);
1392 my @stmt_statements = ($stmt =~ /;/g);
1394 my $stmt_lines = $#stmt_lines + 2;
1395 my $stmt_statements = $#stmt_statements + 1;
1397 if ($stmt_lines > $stmt_statements) {
1400 return $stmt_statements;
1404 sub ctx_statement_full {
1405 my ($linenr, $remain, $off) = @_;
1406 my ($statement, $condition, $level);
1410 # Grab the first conditional/block pair.
1411 ($statement, $condition, $linenr, $remain, $off, $level) =
1412 ctx_statement_block($linenr, $remain, $off);
1413 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1414 push(@chunks, [ $condition, $statement ]);
1415 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1416 return ($level, $linenr, @chunks);
1419 # Pull in the following conditional/block pairs and see if they
1420 # could continue the statement.
1422 ($statement, $condition, $linenr, $remain, $off, $level) =
1423 ctx_statement_block($linenr, $remain, $off);
1424 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1425 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1427 push(@chunks, [ $condition, $statement ]);
1430 return ($level, $linenr, @chunks);
1434 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1436 my $start = $linenr - 1;
1443 my @stack = ($level);
1444 for ($line = $start; $remain > 0; $line++) {
1445 next if ($rawlines[$line] =~ /^-/);
1448 $blk .= $rawlines[$line];
1450 # Handle nested #if/#else.
1451 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1452 push(@stack, $level);
1453 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1454 $level = $stack[$#stack - 1];
1455 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1456 $level = pop(@stack);
1459 foreach my $c (split(//, $lines[$line])) {
1460 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1466 if ($c eq $close && $level > 0) {
1468 last if ($level == 0);
1469 } elsif ($c eq $open) {
1474 if (!$outer || $level <= 1) {
1475 push(@res, $rawlines[$line]);
1478 last if ($level == 0);
1481 return ($level, @res);
1483 sub ctx_block_outer {
1484 my ($linenr, $remain) = @_;
1486 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1490 my ($linenr, $remain) = @_;
1492 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1496 my ($linenr, $remain, $off) = @_;
1498 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1501 sub ctx_block_level {
1502 my ($linenr, $remain) = @_;
1504 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1506 sub ctx_statement_level {
1507 my ($linenr, $remain, $off) = @_;
1509 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1512 sub ctx_locate_comment {
1513 my ($first_line, $end_line) = @_;
1515 # Catch a comment on the end of the line itself.
1516 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1517 return $current_comment if (defined $current_comment);
1519 # Look through the context and try and figure out if there is a
1522 $current_comment = '';
1523 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1524 my $line = $rawlines[$linenr - 1];
1526 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1529 if ($line =~ m@/\*@) {
1532 if (!$in_comment && $current_comment ne '') {
1533 $current_comment = '';
1535 $current_comment .= $line . "\n" if ($in_comment);
1536 if ($line =~ m@\*/@) {
1541 chomp($current_comment);
1542 return($current_comment);
1544 sub ctx_has_comment {
1545 my ($first_line, $end_line) = @_;
1546 my $cmt = ctx_locate_comment($first_line, $end_line);
1548 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1549 ##print "CMMT: $cmt\n";
1551 return ($cmt ne '');
1555 my ($linenr, $cnt) = @_;
1557 my $offset = $linenr - 1;
1562 $line = $rawlines[$offset++];
1563 next if (defined($line) && $line =~ /^-/);
1575 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1578 $coded = sprintf("^%c", unpack('C', $2) + 64);
1587 my $av_preprocessor = 0;
1592 sub annotate_reset {
1593 $av_preprocessor = 0;
1595 @av_paren_type = ('E');
1596 $av_pend_colon = 'O';
1599 sub annotate_values {
1600 my ($stream, $type) = @_;
1603 my $var = '_' x length($stream);
1606 print "$stream\n" if ($dbg_values > 1);
1608 while (length($cur)) {
1609 @av_paren_type = ('E') if ($#av_paren_type < 0);
1610 print " <" . join('', @av_paren_type) .
1611 "> <$type> <$av_pending>" if ($dbg_values > 1);
1612 if ($cur =~ /^(\s+)/o) {
1613 print "WS($1)\n" if ($dbg_values > 1);
1614 if ($1 =~ /\n/ && $av_preprocessor) {
1615 $type = pop(@av_paren_type);
1616 $av_preprocessor = 0;
1619 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1620 print "CAST($1)\n" if ($dbg_values > 1);
1621 push(@av_paren_type, $type);
1624 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1625 print "DECLARE($1)\n" if ($dbg_values > 1);
1628 } elsif ($cur =~ /^($Modifier)\s*/) {
1629 print "MODIFIER($1)\n" if ($dbg_values > 1);
1632 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1633 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1634 $av_preprocessor = 1;
1635 push(@av_paren_type, $type);
1641 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1642 print "UNDEF($1)\n" if ($dbg_values > 1);
1643 $av_preprocessor = 1;
1644 push(@av_paren_type, $type);
1646 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1647 print "PRE_START($1)\n" if ($dbg_values > 1);
1648 $av_preprocessor = 1;
1650 push(@av_paren_type, $type);
1651 push(@av_paren_type, $type);
1654 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1655 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1656 $av_preprocessor = 1;
1658 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1662 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1663 print "PRE_END($1)\n" if ($dbg_values > 1);
1665 $av_preprocessor = 1;
1667 # Assume all arms of the conditional end as this
1668 # one does, and continue as if the #endif was not here.
1669 pop(@av_paren_type);
1670 push(@av_paren_type, $type);
1673 } elsif ($cur =~ /^(\\\n)/o) {
1674 print "PRECONT($1)\n" if ($dbg_values > 1);
1676 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1677 print "ATTR($1)\n" if ($dbg_values > 1);
1678 $av_pending = $type;
1681 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1682 print "SIZEOF($1)\n" if ($dbg_values > 1);
1688 } elsif ($cur =~ /^(if|while|for)\b/o) {
1689 print "COND($1)\n" if ($dbg_values > 1);
1693 } elsif ($cur =~/^(case)/o) {
1694 print "CASE($1)\n" if ($dbg_values > 1);
1695 $av_pend_colon = 'C';
1698 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1699 print "KEYWORD($1)\n" if ($dbg_values > 1);
1702 } elsif ($cur =~ /^(\()/o) {
1703 print "PAREN('$1')\n" if ($dbg_values > 1);
1704 push(@av_paren_type, $av_pending);
1708 } elsif ($cur =~ /^(\))/o) {
1709 my $new_type = pop(@av_paren_type);
1710 if ($new_type ne '_') {
1712 print "PAREN('$1') -> $type\n"
1713 if ($dbg_values > 1);
1715 print "PAREN('$1')\n" if ($dbg_values > 1);
1718 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1719 print "FUNC($1)\n" if ($dbg_values > 1);
1723 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1724 if (defined $2 && $type eq 'C' || $type eq 'T') {
1725 $av_pend_colon = 'B';
1726 } elsif ($type eq 'E') {
1727 $av_pend_colon = 'L';
1729 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1732 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1733 print "IDENT($1)\n" if ($dbg_values > 1);
1736 } elsif ($cur =~ /^($Assignment)/o) {
1737 print "ASSIGN($1)\n" if ($dbg_values > 1);
1740 } elsif ($cur =~/^(;|{|})/) {
1741 print "END($1)\n" if ($dbg_values > 1);
1743 $av_pend_colon = 'O';
1745 } elsif ($cur =~/^(,)/) {
1746 print "COMMA($1)\n" if ($dbg_values > 1);
1749 } elsif ($cur =~ /^(\?)/o) {
1750 print "QUESTION($1)\n" if ($dbg_values > 1);
1753 } elsif ($cur =~ /^(:)/o) {
1754 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1756 substr($var, length($res), 1, $av_pend_colon);
1757 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1762 $av_pend_colon = 'O';
1764 } elsif ($cur =~ /^(\[)/o) {
1765 print "CLOSE($1)\n" if ($dbg_values > 1);
1768 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1771 print "OPV($1)\n" if ($dbg_values > 1);
1778 substr($var, length($res), 1, $variant);
1781 } elsif ($cur =~ /^($Operators)/o) {
1782 print "OP($1)\n" if ($dbg_values > 1);
1783 if ($1 ne '++' && $1 ne '--') {
1787 } elsif ($cur =~ /(^.)/o) {
1788 print "C($1)\n" if ($dbg_values > 1);
1791 $cur = substr($cur, length($1));
1792 $res .= $type x length($1);
1796 return ($res, $var);
1800 my ($possible, $line) = @_;
1801 my $notPermitted = qr{(?:
1818 ^(?:typedef|struct|enum)\b
1820 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1821 if ($possible !~ $notPermitted) {
1822 # Check for modifiers.
1823 $possible =~ s/\s*$Storage\s*//g;
1824 $possible =~ s/\s*$Sparse\s*//g;
1825 if ($possible =~ /^\s*$/) {
1827 } elsif ($possible =~ /\s/) {
1828 $possible =~ s/\s*$Type\s*//g;
1829 for my $modifier (split(' ', $possible)) {
1830 if ($modifier !~ $notPermitted) {
1831 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1832 push(@modifierListFile, $modifier);
1837 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1838 push(@typeListFile, $possible);
1842 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1851 return defined $use_type{$type} if (scalar keys %use_type > 0);
1853 return !defined $ignore_type{$type};
1857 my ($level, $type, $msg) = @_;
1859 if (!show_type($type) ||
1860 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
1864 if (-t STDOUT && $color) {
1865 if ($level eq 'ERROR') {
1867 } elsif ($level eq 'WARNING') {
1873 $output .= $prefix . $level . ':';
1875 $output .= BLUE if (-t STDOUT && $color);
1876 $output .= "$type:";
1878 $output .= RESET if (-t STDOUT && $color);
1879 $output .= ' ' . $msg . "\n";
1882 my @lines = split("\n", $output, -1);
1883 splice(@lines, 1, 1);
1884 $output = join("\n", @lines);
1886 $output = (split('\n', $output))[0] . "\n" if ($terse);
1888 push(our @report, $output);
1897 sub fixup_current_range {
1898 my ($lineRef, $offset, $length) = @_;
1900 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1903 my $no = $o + $offset;
1904 my $nl = $l + $length;
1905 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1909 sub fix_inserted_deleted_lines {
1910 my ($linesRef, $insertedRef, $deletedRef) = @_;
1912 my $range_last_linenr = 0;
1913 my $delta_offset = 0;
1918 my $next_insert = 0;
1919 my $next_delete = 0;
1923 my $inserted = @{$insertedRef}[$next_insert++];
1924 my $deleted = @{$deletedRef}[$next_delete++];
1926 foreach my $old_line (@{$linesRef}) {
1928 my $line = $old_line; #don't modify the array
1929 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
1931 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1932 $range_last_linenr = $new_linenr;
1933 fixup_current_range(\$line, $delta_offset, 0);
1936 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1937 $deleted = @{$deletedRef}[$next_delete++];
1939 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1942 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1943 push(@lines, ${$inserted}{'LINE'});
1944 $inserted = @{$insertedRef}[$next_insert++];
1946 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1950 push(@lines, $line);
1960 sub fix_insert_line {
1961 my ($linenr, $line) = @_;
1967 push(@fixed_inserted, $inserted);
1970 sub fix_delete_line {
1971 my ($linenr, $line) = @_;
1978 push(@fixed_deleted, $deleted);
1982 my ($type, $msg) = @_;
1984 if (report("ERROR", $type, $msg)) {
1992 my ($type, $msg) = @_;
1994 if (report("WARNING", $type, $msg)) {
2002 my ($type, $msg) = @_;
2004 if ($check && report("CHECK", $type, $msg)) {
2012 sub check_absolute_file {
2013 my ($absolute, $herecurr) = @_;
2014 my $file = $absolute;
2016 ##print "absolute<$absolute>\n";
2018 # See if any suffix of this path is a path within the tree.
2019 while ($file =~ s@^[^/]*/@@) {
2020 if (-f "$root/$file") {
2021 ##print "file<$file>\n";
2029 # It is, so see if the prefix is acceptable.
2030 my $prefix = $absolute;
2031 substr($prefix, -length($file)) = '';
2033 ##print "prefix<$prefix>\n";
2034 if ($prefix ne ".../") {
2035 WARN("USE_RELATIVE_PATH",
2036 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
2043 $string =~ s/^\s+|\s+$//g;
2051 $string =~ s/^\s+//;
2059 $string =~ s/\s+$//;
2064 sub string_find_replace {
2065 my ($string, $find, $replace) = @_;
2067 $string =~ s/$find/$replace/g;
2075 my $source_indent = 8;
2076 my $max_spaces_before_tab = $source_indent - 1;
2077 my $spaces_to_tab = " " x $source_indent;
2079 #convert leading spaces to tabs
2080 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2081 #Remove spaces before a tab
2082 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2087 sub pos_last_openparen {
2092 my $opens = $line =~ tr/\(/\(/;
2093 my $closes = $line =~ tr/\)/\)/;
2095 my $last_openparen = 0;
2097 if (($opens == 0) || ($closes >= $opens)) {
2101 my $len = length($line);
2103 for ($pos = 0; $pos < $len; $pos++) {
2104 my $string = substr($line, $pos);
2105 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2106 $pos += length($1) - 1;
2107 } elsif (substr($line, $pos, 1) eq '(') {
2108 $last_openparen = $pos;
2109 } elsif (index($string, '(') == -1) {
2114 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
2118 my $filename = shift;
2124 my $stashrawline="";
2134 my $in_header_lines = $file ? 0 : 1;
2135 my $in_commit_log = 0; #Scanning lines before patch
2136 my $has_commit_log = 0; #Encountered lines before patch
2137 my $commit_log_possible_stack_dump = 0;
2138 my $commit_log_long_line = 0;
2139 my $commit_log_has_diff = 0;
2140 my $reported_maintainer_file = 0;
2141 my $non_utf8_charset = 0;
2143 my $last_blank_line = 0;
2144 my $last_coalesced_string_linenr = -1;
2152 # Trace the real file/line as we go.
2157 my $context_function; #undef'd unless there's a known function
2159 my $comment_edge = 0;
2163 my $prev_values = 'E';
2166 my %suppress_ifbraces;
2167 my %suppress_whiletrailers;
2168 my %suppress_export;
2169 my $suppress_statement = 0;
2171 my %signatures = ();
2173 # Pre-scan the patch sanitizing the lines.
2174 # Pre-scan the patch looking for any __setup documentation.
2176 my @setup_docs = ();
2179 my $camelcase_file_seeded = 0;
2181 sanitise_line_reset();
2183 foreach my $rawline (@rawlines) {
2187 push(@fixed, $rawline) if ($fix);
2189 if ($rawline=~/^\+\+\+\s+(\S+)/) {
2191 if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) {
2196 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2206 if ($context =~ /\b(\w+)\s*\(/) {
2207 $context_function = $1;
2209 undef $context_function;
2212 # Guestimate if this is a continuing comment. Run
2213 # the context looking for a comment "edge". If this
2214 # edge is a close comment then we must be in a comment
2218 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2219 next if (defined $rawlines[$ln - 1] &&
2220 $rawlines[$ln - 1] =~ /^-/);
2222 #print "RAW<$rawlines[$ln - 1]>\n";
2223 last if (!defined $rawlines[$ln - 1]);
2224 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2225 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2230 if (defined $edge && $edge eq '*/') {
2234 # Guestimate if this is a continuing comment. If this
2235 # is the start of a diff block and this line starts
2236 # ' *' then it is very likely a comment.
2237 if (!defined $edge &&
2238 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
2243 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2244 sanitise_line_reset($in_comment);
2246 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
2247 # Standardise the strings and chars within the input to
2248 # simplify matching -- only bother with positive lines.
2249 $line = sanitise_line($rawline);
2251 push(@lines, $line);
2254 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2259 #print "==>$rawline\n";
2260 #print "-->$line\n";
2262 if ($setup_docs && $line =~ /^\+/) {
2263 push(@setup_docs, $line);
2272 foreach my $line (@lines) {
2275 my $sline = $line; #copy of $line
2276 $sline =~ s/$;/ /g; #with comments as spaces
2278 my $rawline = $rawlines[$linenr - 1];
2280 #extract the line range in the file after the patch is applied
2281 if (!$in_commit_log &&
2282 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2284 $first_line = $linenr + 1;
2294 %suppress_ifbraces = ();
2295 %suppress_whiletrailers = ();
2296 %suppress_export = ();
2297 $suppress_statement = 0;
2300 # track the line number as we move through the hunk, note that
2301 # new versions of GNU diff omit the leading space on completely
2302 # blank context lines so we need to count that too.
2303 } elsif ($line =~ /^( |\+|$)/) {
2305 $realcnt-- if ($realcnt != 0);
2307 # Measure the line length and indent.
2308 ($length, $indent) = line_stats($rawline);
2310 # Track the previous line.
2311 ($prevline, $stashline) = ($stashline, $line);
2312 ($previndent, $stashindent) = ($stashindent, $indent);
2313 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2315 #warn "line<$line>\n";
2317 } elsif ($realcnt == 1) {
2321 my $hunk_line = ($realcnt != 0);
2323 $here = "#$linenr: " if (!$file);
2324 $here = "#$realline: " if ($file);
2327 # extract the filename as it passes
2328 if ($line =~ /^diff --git.*?(\S+)$/) {
2330 $realfile =~ s@^([^/]*)/@@ if (!$file);
2333 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2335 $realfile =~ s@^([^/]*)/@@ if (!$file);
2339 if (!$file && $tree && $p1_prefix ne '' &&
2340 -e "$root/$p1_prefix") {
2341 WARN("PATCH_PREFIX",
2342 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
2345 if ($realfile =~ m@^include/asm/@) {
2346 ERROR("MODIFIED_INCLUDE_ASM",
2347 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2352 #make up the handle for any error we report on this line
2354 $prefix = "$realfile:$realline: "
2357 $prefix = "$filename:$realline: ";
2359 $prefix = "$filename:$linenr: ";
2364 if (is_maintained_obsolete($realfile)) {
2366 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2368 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
2371 $check = $check_orig;
2376 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
2378 my $hereline = "$here\n$rawline\n";
2379 my $herecurr = "$here\n$rawline\n";
2380 my $hereprev = "$here\n$prevrawline\n$rawline\n";
2382 $cnt_lines++ if ($realcnt != 0);
2384 # Check if the commit log has what seems like a diff which can confuse patch
2385 if ($in_commit_log && !$commit_log_has_diff &&
2386 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2387 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2388 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2389 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2390 ERROR("DIFF_IN_COMMIT_MSG",
2391 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2392 $commit_log_has_diff = 1;
2395 # Check for incorrect file permissions
2396 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2397 my $permhere = $here . "FILE: $realfile\n";
2398 if ($realfile !~ m@scripts/@ &&
2399 $realfile !~ /\.(py|pl|awk|sh)$/) {
2400 ERROR("EXECUTE_PERMISSIONS",
2401 "do not set execute permissions for source files\n" . $permhere);
2405 # Check the patch for a signoff:
2406 if ($line =~ /^\s*signed-off-by:/i) {
2411 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2412 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2413 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2414 $reported_maintainer_file = 1;
2417 # Check signature styles
2418 if (!$in_header_lines &&
2419 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
2420 my $space_before = $1;
2422 my $space_after = $3;
2424 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2426 if ($sign_off !~ /$signature_tags/) {
2427 WARN("BAD_SIGN_OFF",
2428 "Non-standard signature: $sign_off\n" . $herecurr);
2430 if (defined $space_before && $space_before ne "") {
2431 if (WARN("BAD_SIGN_OFF",
2432 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2434 $fixed[$fixlinenr] =
2435 "$ucfirst_sign_off $email";
2438 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
2439 if (WARN("BAD_SIGN_OFF",
2440 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2442 $fixed[$fixlinenr] =
2443 "$ucfirst_sign_off $email";
2447 if (!defined $space_after || $space_after ne " ") {
2448 if (WARN("BAD_SIGN_OFF",
2449 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2451 $fixed[$fixlinenr] =
2452 "$ucfirst_sign_off $email";
2456 my ($email_name, $email_address, $comment) = parse_email($email);
2457 my $suggested_email = format_email(($email_name, $email_address));
2458 if ($suggested_email eq "") {
2459 ERROR("BAD_SIGN_OFF",
2460 "Unrecognized email address: '$email'\n" . $herecurr);
2462 my $dequoted = $suggested_email;
2463 $dequoted =~ s/^"//;
2464 $dequoted =~ s/" </ </;
2465 # Don't force email to have quotes
2466 # Allow just an angle bracketed address
2467 if ("$dequoted$comment" ne $email &&
2468 "<$email_address>$comment" ne $email &&
2469 "$suggested_email$comment" ne $email) {
2470 WARN("BAD_SIGN_OFF",
2471 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
2475 # Check for duplicate signatures
2476 my $sig_nospace = $line;
2477 $sig_nospace =~ s/\s//g;
2478 $sig_nospace = lc($sig_nospace);
2479 if (defined $signatures{$sig_nospace}) {
2480 WARN("BAD_SIGN_OFF",
2481 "Duplicate signature\n" . $herecurr);
2483 $signatures{$sig_nospace} = 1;
2487 # Check email subject for common tools that don't need to be mentioned
2488 if ($in_header_lines &&
2489 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2490 WARN("EMAIL_SUBJECT",
2491 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2494 # Check for old stable address
2495 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2496 ERROR("STABLE_ADDRESS",
2497 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2500 # Check for unwanted Gerrit info
2501 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2502 ERROR("GERRIT_CHANGE_ID",
2503 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2506 # Check if the commit log is in a possible stack dump
2507 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2508 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2509 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2511 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2512 # stack dump address
2513 $commit_log_possible_stack_dump = 1;
2516 # Check for line lengths > 75 in commit log, warn once
2517 if ($in_commit_log && !$commit_log_long_line &&
2518 length($line) > 75 &&
2519 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2520 # file delta changes
2521 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2523 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2524 # A Fixes: or Link: line
2525 $commit_log_possible_stack_dump)) {
2526 WARN("COMMIT_LOG_LONG_LINE",
2527 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2528 $commit_log_long_line = 1;
2531 # Reset possible stack dump if a blank line is found
2532 if ($in_commit_log && $commit_log_possible_stack_dump &&
2534 $commit_log_possible_stack_dump = 0;
2537 # Check for git id commit length and improperly formed commit descriptions
2538 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2539 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
2540 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
2541 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
2542 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2543 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
2544 my $init_char = "c";
2545 my $orig_commit = "";
2552 my $id = '0123456789ab';
2553 my $orig_desc = "commit description";
2554 my $description = "";
2556 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2558 $orig_commit = lc($2);
2559 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2560 $orig_commit = lc($1);
2563 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2564 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2565 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2566 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2567 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2570 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2571 defined $rawlines[$linenr] &&
2572 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2575 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2576 defined $rawlines[$linenr] &&
2577 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2578 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2580 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2581 $orig_desc .= " " . $1;
2585 ($id, $description) = git_commit_info($orig_commit,
2588 if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) {
2589 ERROR("GIT_COMMIT_ID",
2590 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2594 # Check for added, moved or deleted files
2595 if (!$reported_maintainer_file && !$in_commit_log &&
2596 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2597 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2598 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2599 (defined($1) || defined($2))))) {
2601 $reported_maintainer_file = 1;
2602 WARN("FILE_PATH_CHANGES",
2603 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2606 # Check for wrappage within a valid hunk of the file
2607 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
2608 ERROR("CORRUPTED_PATCH",
2609 "patch seems to be corrupt (line wrapped?)\n" .
2610 $herecurr) if (!$emitted_corrupt++);
2613 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2614 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
2615 $rawline !~ m/^$UTF8*$/) {
2616 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2618 my $blank = copy_spacing($rawline);
2619 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2620 my $hereptr = "$hereline$ptr\n";
2623 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
2626 # Check if it's the start of a commit log
2627 # (not a header line and we haven't seen the patch filename)
2628 if ($in_header_lines && $realfile =~ /^$/ &&
2629 !($rawline =~ /^\s+\S/ ||
2630 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
2631 $in_header_lines = 0;
2633 $has_commit_log = 1;
2636 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2637 # declined it, i.e defined some charset where it is missing.
2638 if ($in_header_lines &&
2639 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2641 $non_utf8_charset = 1;
2644 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
2645 $rawline =~ /$NON_ASCII_UTF8/) {
2646 WARN("UTF8_BEFORE_PATCH",
2647 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2650 # Check for absolute kernel paths in commit message
2651 if ($tree && $in_commit_log) {
2652 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2655 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2656 check_absolute_file($1, $herecurr)) {
2659 check_absolute_file($file, $herecurr);
2664 # Check for various typo / spelling mistakes
2665 if (defined($misspellings) &&
2666 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
2667 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
2669 my $typo_fix = $spelling_fix{lc($typo)};
2670 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2671 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2672 my $msg_type = \&WARN;
2673 $msg_type = \&CHK if ($file);
2674 if (&{$msg_type}("TYPO_SPELLING",
2675 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2677 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2682 # ignore non-hunk lines and lines being removed
2683 next if (!$hunk_line || $line =~ /^-/);
2685 #trailing whitespace
2686 if ($line =~ /^\+.*\015/) {
2687 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2688 if (ERROR("DOS_LINE_ENDINGS",
2689 "DOS line endings\n" . $herevet) &&
2691 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
2693 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2694 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2695 if (ERROR("TRAILING_WHITESPACE",
2696 "trailing whitespace\n" . $herevet) &&
2698 $fixed[$fixlinenr] =~ s/\s+$//;
2704 # Check for FSF mailing addresses.
2705 if ($rawline =~ /\bwrite to the Free/i ||
2706 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2707 $rawline =~ /\b51\s+Franklin\s+St/i) {
2708 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2709 my $msg_type = \&ERROR;
2710 $msg_type = \&CHK if ($file);
2711 &{$msg_type}("FSF_MAILING_ADDRESS",
2712 "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)
2715 # check for Kconfig help text having a real description
2716 # Only applies when adding the entry originally, after that we do not have
2717 # sufficient context to determine whether it is indeed long enough.
2718 if ($realfile =~ /Kconfig/ &&
2719 $line =~ /^\+\s*config\s+/) {
2722 my $ln = $linenr + 1;
2726 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
2727 $f = $lines[$ln - 1];
2728 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2729 $is_end = $lines[$ln - 1] =~ /^\+/;
2731 next if ($f =~ /^-/);
2732 last if (!$file && $f =~ /^\@\@/);
2734 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
2736 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
2743 next if ($f =~ /^$/);
2744 if ($f =~ /^\s*config\s/) {
2750 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2751 WARN("CONFIG_DESCRIPTION",
2752 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2754 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2757 # discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2758 if ($realfile =~ /Kconfig/ &&
2759 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2760 WARN("CONFIG_EXPERIMENTAL",
2761 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2764 # discourage the use of boolean for type definition attributes of Kconfig options
2765 if ($realfile =~ /Kconfig/ &&
2766 $line =~ /^\+\s*\bboolean\b/) {
2767 WARN("CONFIG_TYPE_BOOLEAN",
2768 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2771 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2772 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2775 'EXTRA_AFLAGS' => 'asflags-y',
2776 'EXTRA_CFLAGS' => 'ccflags-y',
2777 'EXTRA_CPPFLAGS' => 'cppflags-y',
2778 'EXTRA_LDFLAGS' => 'ldflags-y',
2781 WARN("DEPRECATED_VARIABLE",
2782 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2785 # check for DT compatible documentation
2786 if (defined $root &&
2787 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2788 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2790 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2792 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2793 my $vp_file = $dt_path . "vendor-prefixes.txt";
2795 foreach my $compat (@compats) {
2796 my $compat2 = $compat;
2797 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2798 my $compat3 = $compat;
2799 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2800 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
2802 WARN("UNDOCUMENTED_DT_STRING",
2803 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2806 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2808 `grep -Eq "^$vendor\\b" $vp_file`;
2810 WARN("UNDOCUMENTED_DT_STRING",
2811 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2816 # check we are in a valid source file if not then ignore this hunk
2817 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
2819 # line length limit (with some exclusions)
2821 # There are a few types of lines that may extend beyond $max_line_length:
2822 # logging functions like pr_info that end in a string
2823 # lines with a single string
2824 # #defines that are a single string
2826 # There are 3 different line length message types:
2827 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength
2828 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2829 # LONG_LINE all other lines longer than $max_line_length
2831 # if LONG_LINE is ignored, the other 2 types are also ignored
2834 if ($line =~ /^\+/ && $length > $max_line_length) {
2835 my $msg_type = "LONG_LINE";
2837 # Check the allowed long line types first
2839 # logging functions that end in a string that starts
2840 # before $max_line_length
2841 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2842 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2845 # lines with only strings (w/ possible termination)
2846 # #defines with only strings
2847 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2848 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2851 # EFI_GUID is another special case
2852 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/) {
2855 # Otherwise set the alternate message types
2857 # a comment starts before $max_line_length
2858 } elsif ($line =~ /($;[\s$;]*)$/ &&
2859 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2860 $msg_type = "LONG_LINE_COMMENT"
2862 # a quoted string starts before $max_line_length
2863 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
2864 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2865 $msg_type = "LONG_LINE_STRING"
2868 if ($msg_type ne "" &&
2869 (show_type("LONG_LINE") || show_type($msg_type))) {
2871 "line over $max_line_length characters\n" . $herecurr);
2875 # check for adding lines without a newline.
2876 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2877 WARN("MISSING_EOF_NEWLINE",
2878 "adding a line without newline at end of file\n" . $herecurr);
2881 # Blackfin: use hi/lo macros
2882 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2883 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2884 my $herevet = "$here\n" . cat_vet($line) . "\n";
2886 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
2888 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2889 my $herevet = "$here\n" . cat_vet($line) . "\n";
2891 "use the HI() macro, not (... >> 16)\n" . $herevet);
2895 # check we are in a valid source file C or perl if not then ignore this hunk
2896 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
2898 # at the beginning of a line any tabs must come first and anything
2899 # more than 8 must use tabs.
2900 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2901 $rawline =~ /^\+\s* \s*/) {
2902 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2904 if (ERROR("CODE_INDENT",
2905 "code indent should use tabs where possible\n" . $herevet) &&
2907 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2911 # check for space before tabs.
2912 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2913 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2914 if (WARN("SPACE_BEFORE_TAB",
2915 "please, no space before tabs\n" . $herevet) &&
2917 while ($fixed[$fixlinenr] =~
2918 s/(^\+.*) {8,8}\t/$1\t\t/) {}
2919 while ($fixed[$fixlinenr] =~
2920 s/(^\+.*) +\t/$1\t/) {}
2924 # check for && or || at the start of a line
2925 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2926 CHK("LOGICAL_CONTINUATIONS",
2927 "Logical continuations should be on the previous line\n" . $hereprev);
2930 # check indentation starts on a tab stop
2931 if ($^V && $^V ge 5.10.0 &&
2932 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$))/) {
2933 my $indent = length($1);
2936 "Statements should start on a tabstop\n" . $herecurr) &&
2938 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
2943 # check multi-line statement indentation matches previous line
2944 if ($^V && $^V ge 5.10.0 &&
2945 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2946 $prevline =~ /^\+(\t*)(.*)$/;
2950 my $pos = pos_last_openparen($rest);
2952 $line =~ /^(\+| )([ \t]*)/;
2955 my $goodtabindent = $oldindent .
2958 my $goodspaceindent = $oldindent . " " x $pos;
2960 if ($newindent ne $goodtabindent &&
2961 $newindent ne $goodspaceindent) {
2963 if (CHK("PARENTHESIS_ALIGNMENT",
2964 "Alignment should match open parenthesis\n" . $hereprev) &&
2965 $fix && $line =~ /^\+/) {
2966 $fixed[$fixlinenr] =~
2967 s/^\+[ \t]*/\+$goodtabindent/;
2973 # check for space after cast like "(int) foo" or "(struct foo) bar"
2974 # avoid checking a few false positives:
2975 # "sizeof(<type>)" or "__alignof__(<type>)"
2976 # function pointer declarations like "(*foo)(int) = bar;"
2977 # structure definitions like "(struct foo) { 0 };"
2978 # multiline macros that define functions
2979 # known attributes or the __attribute__ keyword
2980 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
2981 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
2983 "No space is necessary after a cast\n" . $herecurr) &&
2985 $fixed[$fixlinenr] =~
2986 s/(\(\s*$Type\s*\))[ \t]+/$1/;
2990 # Block comment styles
2991 # Networking with an initial /*
2992 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2993 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
2994 $rawline =~ /^\+[ \t]*\*/ &&
2996 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2997 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3000 # Block comments use * on subsequent lines
3001 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3002 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
3003 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
3004 $rawline =~ /^\+/ && #line is new
3005 $rawline !~ /^\+[ \t]*\*/) { #no leading *
3006 WARN("BLOCK_COMMENT_STYLE",
3007 "Block comments use * on subsequent lines\n" . $hereprev);
3010 # Block comments use */ on trailing lines
3011 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
3012 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3013 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3014 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
3015 WARN("BLOCK_COMMENT_STYLE",
3016 "Block comments use a trailing */ on a separate line\n" . $herecurr);
3019 # Block comment * alignment
3020 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3021 $line =~ /^\+[ \t]*$;/ && #leading comment
3022 $rawline =~ /^\+[ \t]*\*/ && #leading *
3023 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
3024 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
3025 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3027 $prevrawline =~ m@^\+([ \t]*/?)\*@;
3029 $oldindent = expand_tabs($1);
3031 $prevrawline =~ m@^\+(.*/?)\*@;
3032 $oldindent = expand_tabs($1);
3034 $rawline =~ m@^\+([ \t]*)\*@;
3036 $newindent = expand_tabs($newindent);
3037 if (length($oldindent) ne length($newindent)) {
3038 WARN("BLOCK_COMMENT_STYLE",
3039 "Block comments should align the * on each line\n" . $hereprev);
3043 # check for missing blank lines after struct/union declarations
3044 # with exceptions for various attributes and macros
3045 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3047 !($line =~ /^\+\s*$/ ||
3048 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3049 $line =~ /^\+\s*MODULE_/i ||
3050 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3051 $line =~ /^\+[a-z_]*init/ ||
3052 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3053 $line =~ /^\+\s*DECLARE/ ||
3054 $line =~ /^\+\s*__setup/)) {
3055 if (CHK("LINE_SPACING",
3056 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3058 fix_insert_line($fixlinenr, "\+");
3062 # check for multiple consecutive blank lines
3063 if ($prevline =~ /^[\+ ]\s*$/ &&
3064 $line =~ /^\+\s*$/ &&
3065 $last_blank_line != ($linenr - 1)) {
3066 if (CHK("LINE_SPACING",
3067 "Please don't use multiple blank lines\n" . $hereprev) &&
3069 fix_delete_line($fixlinenr, $rawline);
3072 $last_blank_line = $linenr;
3075 # check for missing blank lines after declarations
3076 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3077 # actual declarations
3078 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
3079 # function pointer declarations
3080 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3081 # foo bar; where foo is some local typedef or #define
3082 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3083 # known declaration macros
3084 $prevline =~ /^\+\s+$declaration_macros/) &&
3085 # for "else if" which can look like "$Ident $Ident"
3086 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3087 # other possible extensions of declaration lines
3088 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3089 # not starting a section or a macro "\" extended line
3090 $prevline =~ /(?:\{\s*|\\)$/) &&
3091 # looks like a declaration
3092 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
3093 # function pointer declarations
3094 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3095 # foo bar; where foo is some local typedef or #define
3096 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3097 # known declaration macros
3098 $sline =~ /^\+\s+$declaration_macros/ ||
3099 # start of struct or union or enum
3100 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
3101 # start or end of block or continuation of declaration
3102 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3103 # bitfield continuation
3104 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3105 # other possible extensions of declaration lines
3106 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3107 # indentation of previous and current line are the same
3108 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
3109 if (WARN("LINE_SPACING",
3110 "Missing a blank line after declarations\n" . $hereprev) &&
3112 fix_insert_line($fixlinenr, "\+");
3116 # check for spaces at the beginning of a line.
3118 # 1) within comments
3119 # 2) indented preprocessor commands
3121 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
3122 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3123 if (WARN("LEADING_SPACE",
3124 "please, no spaces at the start of a line\n" . $herevet) &&
3126 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3130 # check we are in a valid C source file if not then ignore this hunk
3131 next if ($realfile !~ /\.(h|c)$/);
3133 # check indentation of any line with a bare else
3134 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
3135 # if the previous line is a break or return and is indented 1 tab more...
3136 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3137 my $tabs = length($1) + 1;
3138 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3139 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3140 defined $lines[$linenr] &&
3141 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
3142 WARN("UNNECESSARY_ELSE",
3143 "else is not generally useful after a break or return\n" . $hereprev);
3147 # check indentation of a line with a break;
3148 # if the previous line is a goto or return and is indented the same # of tabs
3149 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3151 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3152 WARN("UNNECESSARY_BREAK",
3153 "break is not useful after a goto or return\n" . $hereprev);
3157 # discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
3158 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
3159 WARN("CONFIG_EXPERIMENTAL",
3160 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
3163 # check for RCS/CVS revision markers
3164 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
3166 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
3169 # Blackfin: don't use __builtin_bfin_[cs]sync
3170 if ($line =~ /__builtin_bfin_csync/) {
3171 my $herevet = "$here\n" . cat_vet($line) . "\n";
3173 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
3175 if ($line =~ /__builtin_bfin_ssync/) {
3176 my $herevet = "$here\n" . cat_vet($line) . "\n";
3178 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
3181 # check for old HOTPLUG __dev<foo> section markings
3182 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3183 WARN("HOTPLUG_SECTION",
3184 "Using $1 is unnecessary\n" . $herecurr);
3187 # Check for potential 'bare' types
3188 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3190 #print "LINE<$line>\n";
3191 if ($linenr >= $suppress_statement &&
3192 $realcnt && $sline =~ /.\s*\S/) {
3193 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3194 ctx_statement_block($linenr, $realcnt, 0);
3195 $stat =~ s/\n./\n /g;
3196 $cond =~ s/\n./\n /g;
3198 #print "linenr<$linenr> <$stat>\n";
3199 # If this statement has no statement boundaries within
3200 # it there is no point in retrying a statement scan
3201 # until we hit end of it.
3202 my $frag = $stat; $frag =~ s/;+\s*$//;
3203 if ($frag !~ /(?:{|;)/) {
3204 #print "skip<$line_nr_next>\n";
3205 $suppress_statement = $line_nr_next;
3208 # Find the real next line.
3209 $realline_next = $line_nr_next;
3210 if (defined $realline_next &&
3211 (!defined $lines[$realline_next - 1] ||
3212 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3219 # Ignore goto labels.
3220 if ($s =~ /$Ident:\*$/s) {
3222 # Ignore functions being called
3223 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
3225 } elsif ($s =~ /^.\s*else\b/s) {
3227 # declarations always start with types
3228 } 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) {
3231 possible($type, "A:" . $s);
3233 # definitions in global scope can only start with types
3234 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
3235 possible($1, "B:" . $s);
3238 # any (foo ... *) is a pointer cast, and foo is a type
3239 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
3240 possible($1, "C:" . $s);
3243 # Check for any sort of function declaration.
3244 # int foo(something bar, other baz);
3245 # void (*store_gdt)(x86_descr_ptr *);
3246 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3247 my ($name_len) = length($1);
3250 substr($ctx, 0, $name_len + 1, '');
3251 $ctx =~ s/\)[^\)]*$//;
3253 for my $arg (split(/\s*,\s*/, $ctx)) {
3254 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3256 possible($1, "D:" . $s);
3264 # Checks which may be anchored in the context.
3267 # Check for switch () and associated case and default
3268 # statements should be at the same indent.
3269 if ($line=~/\bswitch\s*\(.*\)/) {
3272 my @ctx = ctx_block_outer($linenr, $realcnt);
3274 for my $ctx (@ctx) {
3275 my ($clen, $cindent) = line_stats($ctx);
3276 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3277 $indent != $cindent) {
3278 $err .= "$sep$ctx\n";
3285 ERROR("SWITCH_CASE_INDENT_LEVEL",
3286 "switch and case should be at the same indent\n$hereline$err");
3290 # if/while/etc brace do not go on next line, unless defining a do while loop,
3291 # or if that brace on the next line is for something else
3292 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3293 my $pre_ctx = "$1$2";
3295 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
3297 if ($line =~ /^\+\t{6,}/) {
3298 WARN("DEEP_INDENTATION",
3299 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3302 my $ctx_cnt = $realcnt - $#ctx - 1;
3303 my $ctx = join("\n", @ctx);
3305 my $ctx_ln = $linenr;
3306 my $ctx_skip = $realcnt;
3308 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3309 defined $lines[$ctx_ln - 1] &&
3310 $lines[$ctx_ln - 1] =~ /^-/)) {
3311 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3312 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
3316 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3317 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3319 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
3321 "that open brace { should be on the previous line\n" .
3322 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3324 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3325 $ctx =~ /\)\s*\;\s*$/ &&
3326 defined $lines[$ctx_ln - 1])
3328 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3329 if ($nindent > $indent) {
3330 WARN("TRAILING_SEMICOLON",
3331 "trailing semicolon indicates no statements, indent implies otherwise\n" .
3332 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3337 # Check relative indent for conditionals and blocks.
3338 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3339 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3340 ctx_statement_block($linenr, $realcnt, 0)
3341 if (!defined $stat);
3342 my ($s, $c) = ($stat, $cond);
3344 substr($s, 0, length($c), '');
3346 # remove inline comments
3350 # Find out how long the conditional actually is.
3351 my @newlines = ($c =~ /\n/gs);
3352 my $cond_lines = 1 + $#newlines;
3354 # Make sure we remove the line prefixes as we have
3355 # none on the first line, and are going to readd them
3358 while ($s =~ /\n\s+\\\n/) {
3359 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3362 # We want to check the first line inside the block
3363 # starting at the end of the conditional, so remove:
3364 # 1) any blank line termination
3365 # 2) any opening brace { on end of the line
3367 my $continuation = 0;
3369 $s =~ s/^.*\bdo\b//;
3371 if ($s =~ s/^\s*\\//) {
3374 if ($s =~ s/^\s*?\n//) {
3379 # Also ignore a loop construct at the end of a
3380 # preprocessor statement.
3381 if (($prevline =~ /^.\s*#\s*define\s/ ||
3382 $prevline =~ /\\\s*$/) && $continuation == 0) {
3388 while ($cond_ptr != $cond_lines) {
3389 $cond_ptr = $cond_lines;
3391 # If we see an #else/#elif then the code
3393 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3398 # 1) blank lines, they should be at 0,
3399 # 2) preprocessor lines, and
3401 if ($continuation ||
3403 $s =~ /^\s*#\s*?/ ||
3404 $s =~ /^\s*$Ident\s*:/) {
3405 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
3406 if ($s =~ s/^.*?\n//) {
3412 my (undef, $sindent) = line_stats("+" . $s);
3413 my $stat_real = raw_line($linenr, $cond_lines);
3415 # Check if either of these lines are modified, else
3416 # this is not this patch's fault.
3417 if (!defined($stat_real) ||
3418 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3421 if (defined($stat_real) && $cond_lines > 1) {
3422 $stat_real = "[...]\n$stat_real";
3425 #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";
3427 if ($check && $s ne '' &&
3428 (($sindent % 8) != 0 ||
3429 ($sindent < $indent) ||
3430 ($sindent > $indent + 8))) {
3431 WARN("SUSPECT_CODE_INDENT",
3432 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3436 # Track the 'values' across context and added lines.
3437 my $opline = $line; $opline =~ s/^./ /;
3438 my ($curr_values, $curr_vars) =
3439 annotate_values($opline . "\n", $prev_values);
3440 $curr_values = $prev_values . $curr_values;
3442 my $outline = $opline; $outline =~ s/\t/ /g;
3443 print "$linenr > .$outline\n";
3444 print "$linenr > $curr_values\n";
3445 print "$linenr > $curr_vars\n";
3447 $prev_values = substr($curr_values, -1);
3449 #ignore lines not being added
3450 next if ($line =~ /^[^\+]/);
3452 # check for dereferences that span multiple lines
3453 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
3454 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
3455 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
3457 $line =~ /^.\s*($Lval)/;
3460 WARN("MULTILINE_DEREFERENCE",
3461 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
3464 # check for declarations of signed or unsigned without int
3465 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3468 $var = "" if (!defined $var);
3469 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
3473 $pointer = "" if (!defined $pointer);
3475 if (WARN("UNSPECIFIED_INT",
3476 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3478 my $decl = trim($sign) . " int ";
3479 my $comp_pointer = $pointer;
3480 $comp_pointer =~ s/\s//g;
3481 $decl .= $comp_pointer;
3482 $decl = rtrim($decl) if ($var eq "");
3483 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
3488 # TEST: allow direct testing of the type matcher.
3490 if ($line =~ /^.\s*$Declare\s*$/) {
3492 "TEST: is type\n" . $herecurr);
3493 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
3494 ERROR("TEST_NOT_TYPE",
3495 "TEST: is not type ($1 is)\n". $herecurr);
3499 # TEST: allow direct testing of the attribute matcher.
3501 if ($line =~ /^.\s*$Modifier\s*$/) {
3503 "TEST: is attr\n" . $herecurr);
3504 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
3505 ERROR("TEST_NOT_ATTR",
3506 "TEST: is not attr ($1 is)\n". $herecurr);
3511 # check for initialisation to aggregates open brace on the next line
3512 if ($line =~ /^.\s*{/ &&
3513 $prevline =~ /(?:^|[^=])=\s*$/) {
3514 if (ERROR("OPEN_BRACE",
3515 "that open brace { should be on the previous line\n" . $hereprev) &&
3516 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3517 fix_delete_line($fixlinenr - 1, $prevrawline);
3518 fix_delete_line($fixlinenr, $rawline);
3519 my $fixedline = $prevrawline;
3520 $fixedline =~ s/\s*=\s*$/ = {/;
3521 fix_insert_line($fixlinenr, $fixedline);
3523 $fixedline =~ s/^(.\s*){\s*/$1/;
3524 fix_insert_line($fixlinenr, $fixedline);
3529 # Checks which are anchored on the added line.
3532 # check for malformed paths in #include statements (uses RAW line)
3533 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
3535 if ($path =~ m{//}) {
3536 ERROR("MALFORMED_INCLUDE",
3537 "malformed #include filename\n" . $herecurr);
3539 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3540 ERROR("UAPI_INCLUDE",
3541 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
3545 # no C99 // comments
3546 if ($line =~ m{//}) {
3547 if (ERROR("C99_COMMENTS",
3548 "do not use C99 // comments\n" . $herecurr) &&
3550 my $line = $fixed[$fixlinenr];
3551 if ($line =~ /\/\/(.*)$/) {
3552 my $comment = trim($1);
3553 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
3557 # Remove C99 comments.
3559 $opline =~ s@//.*@@;
3561 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3562 # the whole statement.
3563 #print "APW <$lines[$realline_next - 1]>\n";
3564 if (defined $realline_next &&
3565 exists $lines[$realline_next - 1] &&
3566 !defined $suppress_export{$realline_next} &&
3567 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3568 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3569 # Handle definitions which produce identifiers with
3572 # EXPORT_SYMBOL(something_foo);
3574 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
3575 $name =~ /^${Ident}_$2/) {
3576 #print "FOO C name<$name>\n";
3577 $suppress_export{$realline_next} = 1;
3579 } elsif ($stat !~ /(?:
3581 ^.DEFINE_$Ident\(\Q$name\E\)|
3582 ^.DECLARE_$Ident\(\Q$name\E\)|
3583 ^.LIST_HEAD\(\Q$name\E\)|
3584 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3585 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
3587 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3588 $suppress_export{$realline_next} = 2;
3590 $suppress_export{$realline_next} = 1;
3593 if (!defined $suppress_export{$linenr} &&
3594 $prevline =~ /^.\s*$/ &&
3595 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3596 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3597 #print "FOO B <$lines[$linenr - 1]>\n";
3598 $suppress_export{$linenr} = 2;
3600 if (defined $suppress_export{$linenr} &&
3601 $suppress_export{$linenr} == 2) {
3602 WARN("EXPORT_SYMBOL",
3603 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
3606 # check for global initialisers.
3607 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
3608 if (ERROR("GLOBAL_INITIALISERS",
3609 "do not initialise globals to $1\n" . $herecurr) &&
3611 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
3614 # check for static initialisers.
3615 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
3616 if (ERROR("INITIALISED_STATIC",
3617 "do not initialise statics to $1\n" .
3620 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
3624 # check for misordered declarations of char/short/int/long with signed/unsigned
3625 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3627 WARN("MISORDERED_TYPE",
3628 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3631 # check for static const char * arrays.
3632 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
3633 WARN("STATIC_CONST_CHAR_ARRAY",
3634 "static const char * array should probably be static const char * const\n" .
3638 # check for static char foo[] = "bar" declarations.
3639 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
3640 WARN("STATIC_CONST_CHAR_ARRAY",
3641 "static char array declaration should probably be static const char\n" .
3645 # check for const <foo> const where <foo> is not a pointer or array type
3646 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3648 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3650 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3651 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3653 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3657 # check for non-global char *foo[] = {"bar", ...} declarations.
3658 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3659 WARN("STATIC_CONST_CHAR_ARRAY",
3660 "char * array declaration might be better as static const\n" .
3664 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3665 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3667 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3669 if (WARN("ARRAY_SIZE",
3670 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3672 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3677 # check for function declarations without arguments like "int foo()"
3678 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3679 if (ERROR("FUNCTION_WITHOUT_ARGS",
3680 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3682 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
3686 # check for new typedefs, only function parameters and sparse annotations
3688 if ($line =~ /\btypedef\s/ &&
3689 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
3690 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
3691 $line !~ /\b$typeTypedefs\b/ &&
3692 $line !~ /\b__bitwise\b/) {
3693 WARN("NEW_TYPEDEFS",
3694 "do not add new typedefs\n" . $herecurr);
3697 # * goes on variable not on type
3699 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3701 my ($ident, $from, $to) = ($1, $2, $2);
3703 # Should start with a space.
3704 $to =~ s/^(\S)/ $1/;
3705 # Should not end with a space.
3707 # '*'s should not have spaces between.
3708 while ($to =~ s/\*\s+\*/\*\*/) {
3711 ## print "1: from<$from> to<$to> ident<$ident>\n";
3713 if (ERROR("POINTER_LOCATION",
3714 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3716 my $sub_from = $ident;
3717 my $sub_to = $ident;
3718 $sub_to =~ s/\Q$from\E/$to/;
3719 $fixed[$fixlinenr] =~
3720 s@\Q$sub_from\E@$sub_to@;
3724 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3726 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
3728 # Should start with a space.
3729 $to =~ s/^(\S)/ $1/;
3730 # Should not end with a space.
3732 # '*'s should not have spaces between.
3733 while ($to =~ s/\*\s+\*/\*\*/) {
3735 # Modifiers should have spaces.
3736 $to =~ s/(\b$Modifier$)/$1 /;
3738 ## print "2: from<$from> to<$to> ident<$ident>\n";
3739 if ($from ne $to && $ident !~ /^$Modifier$/) {
3740 if (ERROR("POINTER_LOCATION",
3741 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3744 my $sub_from = $match;
3745 my $sub_to = $match;
3746 $sub_to =~ s/\Q$from\E/$to/;
3747 $fixed[$fixlinenr] =~
3748 s@\Q$sub_from\E@$sub_to@;
3753 # avoid BUG() or BUG_ON()
3754 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
3755 my $msg_type = \&WARN;
3756 $msg_type = \&CHK if ($file);
3757 &{$msg_type}("AVOID_BUG",
3758 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3761 # avoid LINUX_VERSION_CODE
3762 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
3763 WARN("LINUX_VERSION_CODE",
3764 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3767 # check for uses of printk_ratelimit
3768 if ($line =~ /\bprintk_ratelimit\s*\(/) {
3769 WARN("PRINTK_RATELIMITED",
3770 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
3773 # printk should use KERN_* levels. Note that follow on printk's on the
3774 # same line do not need a level, so we use the current block context
3775 # to try and find and validate the current printk. In summary the current
3776 # printk includes all preceding printk's which have no newline on the end.
3777 # we assume the first bad printk is the one to report.
3778 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
3780 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3781 #print "CHECK<$lines[$ln - 1]\n";
3782 # we have a preceding printk if it ends
3783 # with "\n" ignore it, else it is to blame
3784 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3785 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3792 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3793 "printk() should include KERN_ facility level\n" . $herecurr);
3797 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3799 my $level = lc($orig);
3800 $level = "warn" if ($level eq "warning");
3801 my $level2 = $level;
3802 $level2 = "dbg" if ($level eq "debug");
3803 WARN("PREFER_PR_LEVEL",
3804 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
3807 if ($line =~ /\bpr_warning\s*\(/) {
3808 if (WARN("PREFER_PR_LEVEL",
3809 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3811 $fixed[$fixlinenr] =~
3812 s/\bpr_warning\b/pr_warn/;
3816 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3818 my $level = lc($orig);
3819 $level = "warn" if ($level eq "warning");
3820 $level = "dbg" if ($level eq "debug");
3821 WARN("PREFER_DEV_LEVEL",
3822 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3825 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
3826 # number of false positives, but assembly files are not checked, so at
3827 # least the arch entry code will not trigger this warning.
3828 if ($line =~ /\bENOSYS\b/) {
3830 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3833 # function brace can't be on same line, except for #defines of do while,
3834 # or if closed on same line
3835 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
3836 !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) {
3837 if (ERROR("OPEN_BRACE",
3838 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3840 fix_delete_line($fixlinenr, $rawline);
3841 my $fixed_line = $rawline;
3842 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3845 fix_insert_line($fixlinenr, ltrim($line1));
3846 fix_insert_line($fixlinenr, "\+{");
3847 if ($line2 !~ /^\s*$/) {
3848 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3853 # open braces for enum, union and struct go on the same line.
3854 if ($line =~ /^.\s*{/ &&
3855 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
3856 if (ERROR("OPEN_BRACE",
3857 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3858 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3859 fix_delete_line($fixlinenr - 1, $prevrawline);
3860 fix_delete_line($fixlinenr, $rawline);
3861 my $fixedline = rtrim($prevrawline) . " {";
3862 fix_insert_line($fixlinenr, $fixedline);
3863 $fixedline = $rawline;
3864 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3865 if ($fixedline !~ /^\+\s*$/) {
3866 fix_insert_line($fixlinenr, $fixedline);
3871 # missing space after union, struct or enum definition
3872 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3874 "missing space after $1 definition\n" . $herecurr) &&
3876 $fixed[$fixlinenr] =~
3877 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3881 # Function pointer declarations
3882 # check spacing between type, funcptr, and args
3883 # canonical declaration is "type (*funcptr)(args...)"
3884 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
3886 my $pre_pointer_space = $2;
3887 my $post_pointer_space = $3;
3889 my $post_funcname_space = $5;
3890 my $pre_args_space = $6;
3892 # the $Declare variable will capture all spaces after the type
3893 # so check it for a missing trailing missing space but pointer return types
3894 # don't need a space so don't warn for those.
3895 my $post_declare_space = "";
3896 if ($declare =~ /(\s+)$/) {
3897 $post_declare_space = $1;
3898 $declare = rtrim($declare);
3900 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
3902 "missing space after return type\n" . $herecurr);
3903 $post_declare_space = " ";
3906 # unnecessary space "type (*funcptr)(args...)"
3907 # This test is not currently implemented because these declarations are
3909 # int foo(int bar, ...)
3910 # and this is form shouldn't/doesn't generate a checkpatch warning.
3912 # elsif ($declare =~ /\s{2,}$/) {
3914 # "Multiple spaces after return type\n" . $herecurr);
3917 # unnecessary space "type ( *funcptr)(args...)"
3918 if (defined $pre_pointer_space &&
3919 $pre_pointer_space =~ /^\s/) {
3921 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3924 # unnecessary space "type (* funcptr)(args...)"
3925 if (defined $post_pointer_space &&
3926 $post_pointer_space =~ /^\s/) {
3928 "Unnecessary space before function pointer name\n" . $herecurr);
3931 # unnecessary space "type (*funcptr )(args...)"
3932 if (defined $post_funcname_space &&
3933 $post_funcname_space =~ /^\s/) {
3935 "Unnecessary space after function pointer name\n" . $herecurr);
3938 # unnecessary space "type (*funcptr) (args...)"
3939 if (defined $pre_args_space &&
3940 $pre_args_space =~ /^\s/) {
3942 "Unnecessary space before function pointer arguments\n" . $herecurr);
3945 if (show_type("SPACING") && $fix) {
3946 $fixed[$fixlinenr] =~
3947 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3951 # check for spacing round square brackets; allowed:
3952 # 1. with a type on the left -- int [] a;
3953 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3954 # 3. inside a curly brace -- = { [0...10] = 5 }
3955 while ($line =~ /(.*?\s)\[/g) {
3956 my ($where, $prefix) = ($-[1], $1);
3957 if ($prefix !~ /$Type\s+$/ &&
3958 ($where != 0 || $prefix !~ /^.\s+$/) &&
3959 $prefix !~ /[{,]\s+$/) {
3960 if (ERROR("BRACKET_SPACE",
3961 "space prohibited before open square bracket '['\n" . $herecurr) &&
3963 $fixed[$fixlinenr] =~
3964 s/^(\+.*?)\s+\[/$1\[/;
3969 # check for spaces between functions and their parentheses.
3970 while ($line =~ /($Ident)\s+\(/g) {
3972 my $ctx_before = substr($line, 0, $-[1]);
3973 my $ctx = "$ctx_before$name";
3975 # Ignore those directives where spaces _are_ permitted.
3977 if|for|while|switch|return|case|
3978 volatile|__volatile__|
3979 __attribute__|format|__extension__|
3982 # cpp #define statements have non-optional spaces, ie
3983 # if there is a space between the name and the open
3984 # parenthesis it is simply not a parameter group.
3985 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
3987 # cpp #elif statement condition may start with a (
3988 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
3990 # If this whole things ends with a type its most
3991 # likely a typedef for a function.
3992 } elsif ($ctx =~ /$Type$/) {
3996 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3998 $fixed[$fixlinenr] =~
3999 s/\b$name\s+\(/$name\(/;
4004 # Check operator spacing.
4005 if (!($line=~/\#\s*include/)) {
4006 my $fixed_line = "";
4010 <<=|>>=|<=|>=|==|!=|
4011 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4012 =>|->|<<|>>|<|>|=|!|~|
4013 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
4016 my @elements = split(/($ops|;)/, $opline);
4018 ## print("element count: <" . $#elements . ">\n");
4019 ## foreach my $el (@elements) {
4020 ## print("el: <$el>\n");
4023 my @fix_elements = ();
4026 foreach my $el (@elements) {
4027 push(@fix_elements, substr($rawline, $off, length($el)));
4028 $off += length($el);
4033 my $blank = copy_spacing($opline);
4034 my $last_after = -1;
4036 for (my $n = 0; $n < $#elements; $n += 2) {
4038 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4040 ## print("n: <$n> good: <$good>\n");
4042 $off += length($elements[$n]);
4044 # Pick up the preceding and succeeding characters.
4045 my $ca = substr($opline, 0, $off);
4047 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4048 $cc = substr($opline, $off + length($elements[$n + 1]));
4050 my $cb = "$ca$;$cc";
4053 $a = 'V' if ($elements[$n] ne '');
4054 $a = 'W' if ($elements[$n] =~ /\s$/);
4055 $a = 'C' if ($elements[$n] =~ /$;$/);
4056 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4057 $a = 'O' if ($elements[$n] eq '');
4058 $a = 'E' if ($ca =~ /^\s*$/);
4060 my $op = $elements[$n + 1];
4063 if (defined $elements[$n + 2]) {
4064 $c = 'V' if ($elements[$n + 2] ne '');
4065 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
4066 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
4067 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4068 $c = 'O' if ($elements[$n + 2] eq '');
4069 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
4074 my $ctx = "${a}x${c}";
4076 my $at = "(ctx:$ctx)";
4078 my $ptr = substr($blank, 0, $off) . "^";
4079 my $hereptr = "$hereline$ptr\n";
4081 # Pull out the value of this operator.
4082 my $op_type = substr($curr_values, $off + 1, 1);
4084 # Get the full operator variant.
4085 my $opv = $op . substr($curr_vars, $off, 1);
4087 # Ignore operators passed as parameters.
4088 if ($op_type ne 'V' &&
4089 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
4092 # } elsif ($op =~ /^$;+$/) {
4094 # ; should have either the end of line or a space or \ after it
4095 } elsif ($op eq ';') {
4096 if ($ctx !~ /.x[WEBC]/ &&
4097 $cc !~ /^\\/ && $cc !~ /^;/) {
4098 if (ERROR("SPACING",
4099 "space required after that '$op' $at\n" . $hereptr)) {
4100 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
4106 } elsif ($op eq '//') {
4108 # : when part of a bitfield
4109 } elsif ($opv eq ':B') {
4110 # skip the bitfield test for now
4114 } elsif ($op eq '->') {
4115 if ($ctx =~ /Wx.|.xW/) {
4116 if (ERROR("SPACING",
4117 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
4118 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4119 if (defined $fix_elements[$n + 2]) {
4120 $fix_elements[$n + 2] =~ s/^\s+//;
4126 # , must not have a space before and must have a space on the right.
4127 } elsif ($op eq ',') {
4128 my $rtrim_before = 0;
4129 my $space_after = 0;
4130 if ($ctx =~ /Wx./) {
4131 if (ERROR("SPACING",
4132 "space prohibited before that '$op' $at\n" . $hereptr)) {
4137 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
4138 if (ERROR("SPACING",
4139 "space required after that '$op' $at\n" . $hereptr)) {
4145 if ($rtrim_before || $space_after) {
4146 if ($rtrim_before) {
4147 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4149 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4156 # '*' as part of a type definition -- reported already.
4157 } elsif ($opv eq '*_') {
4158 #warn "'*' is part of type\n";
4160 # unary operators should have a space before and
4161 # none after. May be left adjacent to another
4162 # unary operator, or a cast
4163 } elsif ($op eq '!' || $op eq '~' ||
4164 $opv eq '*U' || $opv eq '-U' ||
4165 $opv eq '&U' || $opv eq '&&U') {
4166 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
4167 if (ERROR("SPACING",
4168 "space required before that '$op' $at\n" . $hereptr)) {
4169 if ($n != $last_after + 2) {
4170 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4175 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
4176 # A unary '*' may be const
4178 } elsif ($ctx =~ /.xW/) {
4179 if (ERROR("SPACING",
4180 "space prohibited after that '$op' $at\n" . $hereptr)) {
4181 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
4182 if (defined $fix_elements[$n + 2]) {
4183 $fix_elements[$n + 2] =~ s/^\s+//;
4189 # unary ++ and unary -- are allowed no space on one side.
4190 } elsif ($op eq '++' or $op eq '--') {
4191 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
4192 if (ERROR("SPACING",
4193 "space required one side of that '$op' $at\n" . $hereptr)) {
4194 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
4198 if ($ctx =~ /Wx[BE]/ ||
4199 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
4200 if (ERROR("SPACING",
4201 "space prohibited before that '$op' $at\n" . $hereptr)) {
4202 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4206 if ($ctx =~ /ExW/) {
4207 if (ERROR("SPACING",
4208 "space prohibited after that '$op' $at\n" . $hereptr)) {
4209 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4210 if (defined $fix_elements[$n + 2]) {
4211 $fix_elements[$n + 2] =~ s/^\s+//;
4217 # << and >> may either have or not have spaces both sides
4218 } elsif ($op eq '<<' or $op eq '>>' or
4219 $op eq '&' or $op eq '^' or $op eq '|' or
4220 $op eq '+' or $op eq '-' or
4221 $op eq '*' or $op eq '/' or
4225 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4227 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4228 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4229 $fix_elements[$n + 2] =~ s/^\s+//;
4232 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4234 "space preferred before that '$op' $at\n" . $hereptr)) {
4235 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4239 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
4240 if (ERROR("SPACING",
4241 "need consistent spacing around '$op' $at\n" . $hereptr)) {
4242 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4243 if (defined $fix_elements[$n + 2]) {
4244 $fix_elements[$n + 2] =~ s/^\s+//;
4250 # A colon needs no spaces before when it is
4251 # terminating a case value or a label.
4252 } elsif ($opv eq ':C' || $opv eq ':L') {
4253 if ($ctx =~ /Wx./) {
4254 if (ERROR("SPACING",
4255 "space prohibited before that '$op' $at\n" . $hereptr)) {
4256 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4261 # All the others need spaces both sides.
4262 } elsif ($ctx !~ /[EWC]x[CWE]/) {
4265 # Ignore email addresses <foo@bar>
4267 $cc =~ /^\S+\@\S+>/) ||
4269 $ca =~ /<\S+\@\S+$/))
4274 # for asm volatile statements
4275 # ignore a colon with another
4276 # colon immediately before or after
4278 ($ca =~ /:$/ || $cc =~ /^:/)) {
4282 # messages are ERROR, but ?: are CHK
4284 my $msg_type = \&ERROR;
4285 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4287 if (&{$msg_type}("SPACING",
4288 "spaces required around that '$op' $at\n" . $hereptr)) {
4289 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4290 if (defined $fix_elements[$n + 2]) {
4291 $fix_elements[$n + 2] =~ s/^\s+//;
4297 $off += length($elements[$n + 1]);
4299 ## print("n: <$n> GOOD: <$good>\n");
4301 $fixed_line = $fixed_line . $good;
4304 if (($#elements % 2) == 0) {
4305 $fixed_line = $fixed_line . $fix_elements[$#elements];
4308 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4309 $fixed[$fixlinenr] = $fixed_line;
4315 # check for whitespace before a non-naked semicolon
4316 if ($line =~ /^\+.*\S\s+;\s*$/) {
4318 "space prohibited before semicolon\n" . $herecurr) &&
4320 1 while $fixed[$fixlinenr] =~
4321 s/^(\+.*\S)\s+;/$1;/;
4325 # check for multiple assignments
4326 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
4327 CHK("MULTIPLE_ASSIGNMENTS",
4328 "multiple assignments should be avoided\n" . $herecurr);
4331 ## # check for multiple declarations, allowing for a function declaration
4333 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4334 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4336 ## # Remove any bracketed sections to ensure we do not
4337 ## # falsly report the parameters of functions.
4339 ## while ($ln =~ s/\([^\(\)]*\)//g) {
4341 ## if ($ln =~ /,/) {
4342 ## WARN("MULTIPLE_DECLARATION",
4343 ## "declaring multiple variables together should be avoided\n" . $herecurr);
4347 #need space before brace following if, while, etc
4348 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
4350 if (ERROR("SPACING",
4351 "space required before the open brace '{'\n" . $herecurr) &&
4353 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
4357 ## # check for blank lines before declarations
4358 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4359 ## $prevrawline =~ /^.\s*$/) {
4361 ## "No blank lines before declarations\n" . $hereprev);
4365 # closing brace should have a space following it when it has anything
4367 if ($line =~ /}(?!(?:,|;|\)))\S/) {
4368 if (ERROR("SPACING",
4369 "space required after that close brace '}'\n" . $herecurr) &&
4371 $fixed[$fixlinenr] =~
4372 s/}((?!(?:,|;|\)))\S)/} $1/;
4376 # check spacing on square brackets
4377 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
4378 if (ERROR("SPACING",
4379 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4381 $fixed[$fixlinenr] =~
4385 if ($line =~ /\s\]/) {
4386 if (ERROR("SPACING",
4387 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4389 $fixed[$fixlinenr] =~
4394 # check spacing on parentheses
4395 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4396 $line !~ /for\s*\(\s+;/) {
4397 if (ERROR("SPACING",
4398 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4400 $fixed[$fixlinenr] =~
4404 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
4405 $line !~ /for\s*\(.*;\s+\)/ &&
4406 $line !~ /:\s+\)/) {
4407 if (ERROR("SPACING",
4408 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4410 $fixed[$fixlinenr] =~
4415 # check unnecessary parentheses around addressof/dereference single $Lvals
4416 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4418 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
4420 if (CHK("UNNECESSARY_PARENTHESES",
4421 "Unnecessary parentheses around $var\n" . $herecurr) &&
4423 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4427 # check for unnecessary parentheses around function pointer uses
4428 # ie: (foo->bar)(); should be foo->bar();
4429 # but not "if (foo->bar) (" to avoid some false positives
4430 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4432 if (CHK("UNNECESSARY_PARENTHESES",
4433 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4435 my $var2 = deparenthesize($var);
4437 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4441 #goto labels aren't indented, allow a single space however
4442 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
4443 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
4444 if (WARN("INDENTED_LABEL",
4445 "labels should not be indented\n" . $herecurr) &&
4447 $fixed[$fixlinenr] =~
4452 # return is not a function
4453 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
4455 if ($^V && $^V ge 5.10.0 &&
4456 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4458 $value = deparenthesize($value);
4459 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4460 ERROR("RETURN_PARENTHESES",
4461 "return is not a function, parentheses are not required\n" . $herecurr);
4463 } elsif ($spacing !~ /\s+/) {
4465 "space required before the open parenthesis '('\n" . $herecurr);
4469 # unnecessary return in a void function
4470 # at end-of-function, with the previous line a single leading tab, then return;
4471 # and the line before that not a goto label target like "out:"
4472 if ($sline =~ /^[ \+]}\s*$/ &&
4473 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4475 $lines[$linenr - 3] =~ /^[ +]/ &&
4476 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
4478 "void function return statements are not generally useful\n" . $hereprev);
4481 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4482 if ($^V && $^V ge 5.10.0 &&
4483 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4484 my $openparens = $1;
4485 my $count = $openparens =~ tr@\(@\(@;
4487 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4488 my $comp = $4; #Not $1 because of $LvalOrFunc
4489 $msg = " - maybe == should be = ?" if ($comp eq "==");
4490 WARN("UNNECESSARY_PARENTHESES",
4491 "Unnecessary parentheses$msg\n" . $herecurr);
4495 # comparisons with a constant or upper case identifier on the left
4496 # avoid cases like "foo + BAR < baz"
4497 # only fix matches surrounded by parentheses to avoid incorrect
4498 # conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4499 if ($^V && $^V ge 5.10.0 &&
4500 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4505 my $newcomp = $comp;
4506 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
4507 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4508 WARN("CONSTANT_COMPARISON",
4509 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4513 } elsif ($comp eq "<=") {
4515 } elsif ($comp eq ">") {
4517 } elsif ($comp eq ">=") {
4520 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4524 # Return of what appears to be an errno should normally be negative
4525 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
4527 if ($name ne 'EOF' && $name ne 'ERROR') {
4528 WARN("USE_NEGATIVE_ERRNO",
4529 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
4533 # Need a space before open parenthesis after if, while etc
4534 if ($line =~ /\b(if|while|for|switch)\(/) {
4535 if (ERROR("SPACING",
4536 "space required before the open parenthesis '('\n" . $herecurr) &&
4538 $fixed[$fixlinenr] =~
4539 s/\b(if|while|for|switch)\(/$1 \(/;
4543 # Check for illegal assignment in if conditional -- and check for trailing
4544 # statements after the conditional.
4545 if ($line =~ /do\s*(?!{)/) {
4546 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4547 ctx_statement_block($linenr, $realcnt, 0)
4548 if (!defined $stat);
4549 my ($stat_next) = ctx_statement_block($line_nr_next,
4550 $remain_next, $off_next);
4551 $stat_next =~ s/\n./\n /g;
4552 ##print "stat<$stat> stat_next<$stat_next>\n";
4554 if ($stat_next =~ /^\s*while\b/) {
4555 # If the statement carries leading newlines,
4556 # then count those as offsets.
4558 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4560 statement_rawlines($whitespace) - 1;
4562 $suppress_whiletrailers{$line_nr_next +
4566 if (!defined $suppress_whiletrailers{$linenr} &&
4567 defined($stat) && defined($cond) &&
4568 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
4569 my ($s, $c) = ($stat, $cond);
4571 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
4572 ERROR("ASSIGN_IN_IF",
4573 "do not use assignment in if condition\n" . $herecurr);
4576 # Find out what is on the end of the line after the
4578 substr($s, 0, length($c), '');
4580 $s =~ s/$;//g; # Remove any comments
4581 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4582 $c !~ /}\s*while\s*/)
4584 # Find out how long the conditional actually is.
4585 my @newlines = ($c =~ /\n/gs);
4586 my $cond_lines = 1 + $#newlines;
4589 $stat_real = raw_line($linenr, $cond_lines)
4590 . "\n" if ($cond_lines);
4591 if (defined($stat_real) && $cond_lines > 1) {
4592 $stat_real = "[...]\n$stat_real";
4595 ERROR("TRAILING_STATEMENTS",
4596 "trailing statements should be on next line\n" . $herecurr . $stat_real);
4600 # Check for bitwise tests written as boolean
4612 WARN("HEXADECIMAL_BOOLEAN_TEST",
4613 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
4616 # if and else should not have general statements after it
4617 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4619 $s =~ s/$;//g; # Remove any comments
4620 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
4621 ERROR("TRAILING_STATEMENTS",
4622 "trailing statements should be on next line\n" . $herecurr);
4625 # if should not continue a brace
4626 if ($line =~ /}\s*if\b/) {
4627 ERROR("TRAILING_STATEMENTS",
4628 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
4631 # case and default should not have general statements after them
4632 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4634 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
4638 ERROR("TRAILING_STATEMENTS",
4639 "trailing statements should be on next line\n" . $herecurr);
4642 # Check for }<nl>else {, these must be at the same
4643 # indent level to be relevant to each other.
4644 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4645 $previndent == $indent) {
4646 if (ERROR("ELSE_AFTER_BRACE",
4647 "else should follow close brace '}'\n" . $hereprev) &&
4648 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4649 fix_delete_line($fixlinenr - 1, $prevrawline);
4650 fix_delete_line($fixlinenr, $rawline);
4651 my $fixedline = $prevrawline;
4652 $fixedline =~ s/}\s*$//;
4653 if ($fixedline !~ /^\+\s*$/) {
4654 fix_insert_line($fixlinenr, $fixedline);
4656 $fixedline = $rawline;
4657 $fixedline =~ s/^(.\s*)else/$1} else/;
4658 fix_insert_line($fixlinenr, $fixedline);
4662 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4663 $previndent == $indent) {
4664 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4666 # Find out what is on the end of the line after the
4668 substr($s, 0, length($c), '');
4671 if ($s =~ /^\s*;/) {
4672 if (ERROR("WHILE_AFTER_BRACE",
4673 "while should follow close brace '}'\n" . $hereprev) &&
4674 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4675 fix_delete_line($fixlinenr - 1, $prevrawline);
4676 fix_delete_line($fixlinenr, $rawline);
4677 my $fixedline = $prevrawline;
4678 my $trailing = $rawline;
4679 $trailing =~ s/^\+//;
4680 $trailing = trim($trailing);
4681 $fixedline =~ s/}\s*$/} $trailing/;
4682 fix_insert_line($fixlinenr, $fixedline);
4687 #Specific variable tests
4688 while ($line =~ m{($Constant|$Lval)}g) {
4691 #gcc binary extension
4692 if ($var =~ /^$Binary$/) {
4693 if (WARN("GCC_BINARY_CONSTANT",
4694 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4696 my $hexval = sprintf("0x%x", oct($var));
4697 $fixed[$fixlinenr] =~
4698 s/\b$var\b/$hexval/;
4703 if ($var !~ /^$Constant$/ &&
4704 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
4705 #Ignore Page<foo> variants
4706 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
4707 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4708 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4709 #Ignore some three character SI units explicitly, like MiB and KHz
4710 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
4711 while ($var =~ m{($Ident)}g) {
4713 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
4715 seed_camelcase_includes();
4716 if (!$file && !$camelcase_file_seeded) {
4717 seed_camelcase_file($realfile);
4718 $camelcase_file_seeded = 1;
4721 if (!defined $camelcase{$word}) {
4722 $camelcase{$word} = 1;
4724 "Avoid CamelCase: <$word>\n" . $herecurr);
4730 #no spaces allowed after \ in define
4731 if ($line =~ /\#\s*define.*\\\s+$/) {
4732 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4733 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4735 $fixed[$fixlinenr] =~ s/\s+$//;
4739 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4740 # itself <asm/foo.h> (uses RAW line)
4741 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
4743 my $checkfile = "include/linux/$file";
4744 if (-f "$root/$checkfile" &&
4745 $realfile ne $checkfile &&
4746 $1 !~ /$allowed_asm_includes/)
4748 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4749 if ($asminclude > 0) {
4750 if ($realfile =~ m{^arch/}) {
4751 CHK("ARCH_INCLUDE_LINUX",
4752 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4754 WARN("INCLUDE_LINUX",
4755 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4761 # multi-statement macros should be enclosed in a do while loop, grab the
4762 # first statement and ensure its the whole macro if its not enclosed
4763 # in a known good container
4764 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4765 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
4768 my ($off, $dstat, $dcond, $rest);
4770 my $has_flow_statement = 0;
4771 my $has_arg_concat = 0;
4772 ($dstat, $dcond, $ln, $cnt, $off) =
4773 ctx_statement_block($linenr, $realcnt, 0);
4775 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4776 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4778 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
4779 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
4781 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
4782 my $define_args = $1;
4783 my $define_stmt = $dstat;
4786 if (defined $define_args && $define_args ne "") {
4787 $define_args = substr($define_args, 1, length($define_args) - 2);
4788 $define_args =~ s/\s*//g;
4789 @def_args = split(",", $define_args);
4793 $dstat =~ s/\\\n.//g;
4794 $dstat =~ s/^\s*//s;
4795 $dstat =~ s/\s*$//s;
4797 # Flatten any parentheses and braces
4798 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4799 $dstat =~ s/\{[^\{\}]*\}/1/ ||
4800 $dstat =~ s/.\[[^\[\]]*\]/1/)
4804 # Flatten any obvious string concatentation.
4805 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4806 $dstat =~ s/$Ident\s*($String)/$1/)
4810 # Make asm volatile uses seem like a generic function
4811 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
4813 my $exceptions = qr{
4826 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4829 my $herectx = $here . "\n";
4830 my $stmt_cnt = statement_rawlines($ctx);
4832 for (my $n = 0; $n < $stmt_cnt; $n++) {
4833 $herectx .= raw_line($linenr, $n) . "\n";
4837 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4838 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
4839 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4840 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
4841 $dstat !~ /$exceptions/ &&
4842 $dstat !~ /^\.$Ident\s*=/ && # .foo =
4843 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
4844 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
4845 $dstat !~ /^for\s*$Constant$/ && # for (...)
4846 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4847 $dstat !~ /^do\s*{/ && # do {...
4848 $dstat !~ /^\(\{/ && # ({...
4849 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
4852 if ($dstat =~ /;/) {
4853 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4854 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4856 ERROR("COMPLEX_MACRO",
4857 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
4862 # Make $define_stmt single line, comment-free, etc
4863 my @stmt_array = split('\n', $define_stmt);
4866 foreach my $l (@stmt_array) {
4871 } elsif ($l =~ /^[\+ ]/) {
4872 $define_stmt .= substr($l, 1);
4875 $define_stmt =~ s/$;//g;
4876 $define_stmt =~ s/\s+/ /g;
4877 $define_stmt = trim($define_stmt);
4879 # check if any macro arguments are reused (ignore '...' and 'type')
4880 foreach my $arg (@def_args) {
4881 next if ($arg =~ /\.\.\./);
4882 next if ($arg =~ /^type$/i);
4883 my $tmp = $define_stmt;
4884 $tmp =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
4885 $tmp =~ s/\#+\s*$arg\b//g;
4886 $tmp =~ s/\b$arg\s*\#\#//g;
4887 my $use_cnt = $tmp =~ s/\b$arg\b//g;
4889 CHK("MACRO_ARG_REUSE",
4890 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
4892 # check if any macro arguments may have other precedence issues
4893 if ($define_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
4894 ((defined($1) && $1 ne ',') ||
4895 (defined($2) && $2 ne ','))) {
4896 CHK("MACRO_ARG_PRECEDENCE",
4897 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
4901 # check for macros with flow control, but without ## concatenation
4902 # ## concatenation is commonly a macro that defines a function so ignore those
4903 if ($has_flow_statement && !$has_arg_concat) {
4904 my $herectx = $here . "\n";
4905 my $cnt = statement_rawlines($ctx);
4907 for (my $n = 0; $n < $cnt; $n++) {
4908 $herectx .= raw_line($linenr, $n) . "\n";
4910 WARN("MACRO_WITH_FLOW_CONTROL",
4911 "Macros with flow control statements should be avoided\n" . "$herectx");
4914 # check for line continuations outside of #defines, preprocessor #, and asm
4917 if ($prevline !~ /^..*\\$/ &&
4918 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4919 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
4920 $line =~ /^\+.*\\$/) {
4921 WARN("LINE_CONTINUATIONS",
4922 "Avoid unnecessary line continuations\n" . $herecurr);
4926 # do {} while (0) macro tests:
4927 # single-statement macros do not need to be enclosed in do while (0) loop,
4928 # macro should not end with a semicolon
4929 if ($^V && $^V ge 5.10.0 &&
4930 $realfile !~ m@/vmlinux.lds.h$@ &&
4931 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4934 my ($off, $dstat, $dcond, $rest);
4936 ($dstat, $dcond, $ln, $cnt, $off) =
4937 ctx_statement_block($linenr, $realcnt, 0);
4940 $dstat =~ s/\\\n.//g;
4943 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4948 my $cnt = statement_rawlines($ctx);
4949 my $herectx = $here . "\n";
4951 for (my $n = 0; $n < $cnt; $n++) {
4952 $herectx .= raw_line($linenr, $n) . "\n";
4955 if (($stmts =~ tr/;/;/) == 1 &&
4956 $stmts !~ /^\s*(if|while|for|switch)\b/) {
4957 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4958 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4960 if (defined $semis && $semis ne "") {
4961 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4962 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4964 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4966 my $cnt = statement_rawlines($ctx);
4967 my $herectx = $here . "\n";
4969 for (my $n = 0; $n < $cnt; $n++) {
4970 $herectx .= raw_line($linenr, $n) . "\n";
4973 WARN("TRAILING_SEMICOLON",
4974 "macros should not use a trailing semicolon\n" . "$herectx");
4978 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4979 # all assignments may have only one of the following with an assignment:
4982 # VMLINUX_SYMBOL(...)
4983 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
4984 WARN("MISSING_VMLINUX_SYMBOL",
4985 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
4988 # check for redundant bracing round if etc
4989 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4990 my ($level, $endln, @chunks) =
4991 ctx_statement_full($linenr, $realcnt, 1);
4992 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
4993 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4994 if ($#chunks > 0 && $level == 0) {
4998 my $herectx = $here . "\n";
4999 my $ln = $linenr - 1;
5000 for my $chunk (@chunks) {
5001 my ($cond, $block) = @{$chunk};
5003 # If the condition carries leading newlines, then count those as offsets.
5004 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5005 my $offset = statement_rawlines($whitespace) - 1;
5007 $allowed[$allow] = 0;
5008 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5010 # We have looked at and allowed this specific line.
5011 $suppress_ifbraces{$ln + $offset} = 1;
5013 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
5014 $ln += statement_rawlines($block) - 1;
5016 substr($block, 0, length($cond), '');
5018 $seen++ if ($block =~ /^\s*{/);
5020 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5021 if (statement_lines($cond) > 1) {
5022 #print "APW: ALLOWED: cond<$cond>\n";
5023 $allowed[$allow] = 1;
5025 if ($block =~/\b(?:if|for|while)\b/) {
5026 #print "APW: ALLOWED: block<$block>\n";
5027 $allowed[$allow] = 1;
5029 if (statement_block_size($block) > 1) {
5030 #print "APW: ALLOWED: lines block<$block>\n";
5031 $allowed[$allow] = 1;
5036 my $sum_allowed = 0;
5037 foreach (@allowed) {
5040 if ($sum_allowed == 0) {
5042 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5043 } elsif ($sum_allowed != $allow &&
5046 "braces {} should be used on all arms of this statement\n" . $herectx);
5051 if (!defined $suppress_ifbraces{$linenr - 1} &&
5052 $line =~ /\b(if|while|for|else)\b/) {
5055 # Check the pre-context.
5056 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5057 #print "APW: ALLOWED: pre<$1>\n";
5061 my ($level, $endln, @chunks) =
5062 ctx_statement_full($linenr, $realcnt, $-[0]);
5064 # Check the condition.
5065 my ($cond, $block) = @{$chunks[0]};
5066 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5067 if (defined $cond) {
5068 substr($block, 0, length($cond), '');
5070 if (statement_lines($cond) > 1) {
5071 #print "APW: ALLOWED: cond<$cond>\n";
5074 if ($block =~/\b(?:if|for|while)\b/) {
5075 #print "APW: ALLOWED: block<$block>\n";
5078 if (statement_block_size($block) > 1) {
5079 #print "APW: ALLOWED: lines block<$block>\n";
5082 # Check the post-context.
5083 if (defined $chunks[1]) {
5084 my ($cond, $block) = @{$chunks[1]};
5085 if (defined $cond) {
5086 substr($block, 0, length($cond), '');
5088 if ($block =~ /^\s*\{/) {
5089 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5093 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
5094 my $herectx = $here . "\n";
5095 my $cnt = statement_rawlines($block);
5097 for (my $n = 0; $n < $cnt; $n++) {
5098 $herectx .= raw_line($linenr, $n) . "\n";
5102 "braces {} are not necessary for single statement blocks\n" . $herectx);
5106 # check for unnecessary blank lines around braces
5107 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
5109 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5110 $fix && $prevrawline =~ /^\+/) {
5111 fix_delete_line($fixlinenr - 1, $prevrawline);
5114 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
5116 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5118 fix_delete_line($fixlinenr, $rawline);
5122 # no volatiles please
5123 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5124 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
5126 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
5129 # Check for user-visible strings broken across lines, which breaks the ability
5130 # to grep for the string. Make exceptions when the previous string ends in a
5131 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5132 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
5133 if ($line =~ /^\+\s*$String/ &&
5134 $prevline =~ /"\s*$/ &&
5135 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5136 if (WARN("SPLIT_STRING",
5137 "quoted string split across lines\n" . $hereprev) &&
5139 $prevrawline =~ /^\+.*"\s*$/ &&
5140 $last_coalesced_string_linenr != $linenr - 1) {
5141 my $extracted_string = get_quoted_string($line, $rawline);
5142 my $comma_close = "";
5143 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5147 fix_delete_line($fixlinenr - 1, $prevrawline);
5148 fix_delete_line($fixlinenr, $rawline);
5149 my $fixedline = $prevrawline;
5150 $fixedline =~ s/"\s*$//;
5151 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5152 fix_insert_line($fixlinenr - 1, $fixedline);
5153 $fixedline = $rawline;
5154 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5155 if ($fixedline !~ /\+\s*$/) {
5156 fix_insert_line($fixlinenr, $fixedline);
5158 $last_coalesced_string_linenr = $linenr;
5162 # check for missing a space in a string concatenation
5163 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5164 WARN('MISSING_SPACE',
5165 "break quoted strings at a space character\n" . $hereprev);
5168 #check for an embedded function name in a string when the function is known
5169 # as part of a diff. This does not work for -f --file checking as it
5170 #depends on patch context providing the function name
5171 if ($line =~ /^\+.*$String/ &&
5172 defined($context_function) &&
5173 get_quoted_string($line, $rawline) =~ /\b$context_function\b/) {
5174 WARN("EMBEDDED_FUNCTION_NAME",
5175 "Prefer using \"%s\", __func__ to embedded function names\n" . $herecurr);
5178 # check for spaces before a quoted newline
5179 if ($rawline =~ /^.*\".*\s\\n/) {
5180 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5181 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5183 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5188 # concatenated string without spaces between elements
5189 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
5190 CHK("CONCATENATED_STRING",
5191 "Concatenated strings should use spaces between elements\n" . $herecurr);
5194 # uncoalesced string fragments
5195 if ($line =~ /$String\s*"/) {
5196 WARN("STRING_FRAGMENTS",
5197 "Consecutive strings are generally better as a single string\n" . $herecurr);
5200 # check for %L{u,d,i} and 0x%[udi] in strings
5202 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
5203 $string = substr($rawline, $-[1], $+[1] - $-[1]);
5204 $string =~ s/%%/__/g;
5205 if ($string =~ /(?<!%)%[\*\d\.\$]*L[udi]/) {
5207 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
5210 if ($string =~ /0x%[\*\d\.\$\Llzth]*[udi]/) {
5211 ERROR("PRINTF_0xDECIMAL",
5212 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5216 # check for line continuations in quoted strings with odd counts of "
5217 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
5218 WARN("LINE_CONTINUATIONS",
5219 "Avoid line continuations in quoted strings\n" . $herecurr);
5223 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
5224 CHK("REDUNDANT_CODE",
5225 "if this code is redundant consider removing it\n" .
5229 # check for needless "if (<foo>) fn(<foo>)" uses
5230 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
5231 my $tested = quotemeta($1);
5232 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5233 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5235 if (WARN('NEEDLESS_IF',
5236 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5239 my $leading_tabs = "";
5240 my $new_leading_tabs = "";
5241 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5246 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5247 $new_leading_tabs = $1;
5248 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5255 fix_delete_line($fixlinenr - 1, $prevrawline);
5256 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5262 # check for unnecessary "Out of Memory" messages
5263 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5264 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5265 (defined $1 || defined $3) &&
5268 my $testline = $lines[$linenr - 3];
5270 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5271 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5273 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
5275 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5279 # check for logging functions with KERN_<LEVEL>
5280 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
5281 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5283 if (WARN("UNNECESSARY_KERN_LEVEL",
5284 "Possible unnecessary $level\n" . $herecurr) &&
5286 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5290 # check for mask then right shift without a parentheses
5291 if ($^V && $^V ge 5.10.0 &&
5292 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5293 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5294 WARN("MASK_THEN_SHIFT",
5295 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5298 # check for pointer comparisons to NULL
5299 if ($^V && $^V ge 5.10.0) {
5300 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5303 $equal = "" if ($4 eq "!=");
5304 if (CHK("COMPARISON_TO_NULL",
5305 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5307 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5312 # check for bad placement of section $InitAttribute (e.g.: __initdata)
5313 if ($line =~ /(\b$InitAttribute\b)/) {
5315 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5318 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5319 ERROR("MISPLACED_INIT",
5320 "$attr should be placed after $var\n" . $herecurr)) ||
5321 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5322 WARN("MISPLACED_INIT",
5323 "$attr should be placed after $var\n" . $herecurr))) &&
5325 $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;
5330 # check for $InitAttributeData (ie: __initdata) with const
5331 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5333 $attr =~ /($InitAttributePrefix)(.*)/;
5334 my $attr_prefix = $1;
5336 if (ERROR("INIT_ATTRIBUTE",
5337 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5339 $fixed[$fixlinenr] =~
5340 s/$InitAttributeData/${attr_prefix}initconst/;
5344 # check for $InitAttributeConst (ie: __initconst) without const
5345 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5347 if (ERROR("INIT_ATTRIBUTE",
5348 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5350 my $lead = $fixed[$fixlinenr] =~
5351 /(^\+\s*(?:static\s+))/;
5353 $lead = "$lead " if ($lead !~ /^\+$/);
5354 $lead = "${lead}const ";
5355 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
5359 # check for __read_mostly with const non-pointer (should just be const)
5360 if ($line =~ /\b__read_mostly\b/ &&
5361 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5362 if (ERROR("CONST_READ_MOSTLY",
5363 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5365 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5369 # don't use __constant_<foo> functions outside of include/uapi/
5370 if ($realfile !~ m@^include/uapi/@ &&
5371 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5372 my $constant_func = $1;
5373 my $func = $constant_func;
5374 $func =~ s/^__constant_//;
5375 if (WARN("CONSTANT_CONVERSION",
5376 "$constant_func should be $func\n" . $herecurr) &&
5378 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
5382 # prefer usleep_range over udelay
5383 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
5385 # ignore udelay's < 10, however
5386 if (! ($delay < 10) ) {
5388 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5390 if ($delay > 2000) {
5392 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
5396 # warn about unexpectedly long msleep's
5397 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5400 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5404 # check for comparisons of jiffies
5405 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5406 WARN("JIFFIES_COMPARISON",
5407 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5410 # check for comparisons of get_jiffies_64()
5411 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5412 WARN("JIFFIES_COMPARISON",
5413 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5416 # warn about #ifdefs in C files
5417 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5418 # print "#ifdef in C files should be avoided\n";
5419 # print "$herecurr";
5423 # warn about spacing in #ifdefs
5424 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
5425 if (ERROR("SPACING",
5426 "exactly one space required after that #$1\n" . $herecurr) &&
5428 $fixed[$fixlinenr] =~
5429 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5434 # check for spinlock_t definitions without a comment.
5435 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5436 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
5438 if (!ctx_has_comment($first_line, $linenr)) {
5439 CHK("UNCOMMENTED_DEFINITION",
5440 "$1 definition without comment\n" . $herecurr);
5443 # check for memory barriers without a comment.
5449 read_barrier_depends
5451 my $barrier_stems = qr{
5459 my $all_barriers = qr{
5461 smp_(?:$barrier_stems)|
5462 virt_(?:$barrier_stems)
5465 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
5466 if (!ctx_has_comment($first_line, $linenr)) {
5467 WARN("MEMORY_BARRIER",
5468 "memory barrier without comment\n" . $herecurr);
5472 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5474 if ($realfile !~ m@^include/asm-generic/@ &&
5475 $realfile !~ m@/barrier\.h$@ &&
5476 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5477 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5478 WARN("MEMORY_BARRIER",
5479 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5482 # check for waitqueue_active without a comment.
5483 if ($line =~ /\bwaitqueue_active\s*\(/) {
5484 if (!ctx_has_comment($first_line, $linenr)) {
5485 WARN("WAITQUEUE_ACTIVE",
5486 "waitqueue_active without comment\n" . $herecurr);
5490 # Check for expedited grace periods that interrupt non-idle non-nohz
5491 # online CPUs. These expedited can therefore degrade real-time response
5492 # if used carelessly, and should be avoided where not absolutely
5493 # needed. It is always OK to use synchronize_rcu_expedited() and
5494 # synchronize_sched_expedited() at boot time (before real-time applications
5495 # start) and in error situations where real-time response is compromised in
5496 # any case. Note that synchronize_srcu_expedited() does -not- interrupt
5497 # other CPUs, so don't warn on uses of synchronize_srcu_expedited().
5498 # Of course, nothing comes for free, and srcu_read_lock() and
5499 # srcu_read_unlock() do contain full memory barriers in payment for
5500 # synchronize_srcu_expedited() non-interruption properties.
5501 if ($line =~ /\b(synchronize_rcu_expedited|synchronize_sched_expedited)\(/) {
5502 WARN("EXPEDITED_RCU_GRACE_PERIOD",
5503 "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr);
5507 # check of hardware specific defines
5508 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5510 "architecture specific defines should be avoided\n" . $herecurr);
5513 # Check that the storage class is at the beginning of a declaration
5514 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
5515 WARN("STORAGE_CLASS",
5516 "storage class should be at the beginning of the declaration\n" . $herecurr)
5519 # check the location of the inline attribute, that it is between
5520 # storage class and type.
5521 if ($line =~ /\b$Type\s+$Inline\b/ ||
5522 $line =~ /\b$Inline\s+$Storage\b/) {
5523 ERROR("INLINE_LOCATION",
5524 "inline keyword should sit between storage class and type\n" . $herecurr);
5527 # Check for __inline__ and __inline, prefer inline
5528 if ($realfile !~ m@\binclude/uapi/@ &&
5529 $line =~ /\b(__inline__|__inline)\b/) {
5531 "plain inline is preferred over $1\n" . $herecurr) &&
5533 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
5538 # Check for __attribute__ packed, prefer __packed
5539 if ($realfile !~ m@\binclude/uapi/@ &&
5540 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
5541 WARN("PREFER_PACKED",
5542 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
5545 # Check for __attribute__ aligned, prefer __aligned
5546 if ($realfile !~ m@\binclude/uapi/@ &&
5547 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
5548 WARN("PREFER_ALIGNED",
5549 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
5552 # Check for __attribute__ format(printf, prefer __printf
5553 if ($realfile !~ m@\binclude/uapi/@ &&
5554 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
5555 if (WARN("PREFER_PRINTF",
5556 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5558 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5563 # Check for __attribute__ format(scanf, prefer __scanf
5564 if ($realfile !~ m@\binclude/uapi/@ &&
5565 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
5566 if (WARN("PREFER_SCANF",
5567 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5569 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5573 # Check for __attribute__ weak, or __weak declarations (may have link issues)
5574 if ($^V && $^V ge 5.10.0 &&
5575 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5576 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5577 $line =~ /\b__weak\b/)) {
5578 ERROR("WEAK_DECLARATION",
5579 "Using weak declarations can have unintended link defects\n" . $herecurr);
5582 # check for c99 types like uint8_t used outside of uapi/ and tools/
5583 if ($realfile !~ m@\binclude/uapi/@ &&
5584 $realfile !~ m@\btools/@ &&
5585 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5587 if ($type =~ /\b($typeC99Typedefs)\b/) {
5589 my $kernel_type = 'u';
5590 $kernel_type = 's' if ($type =~ /^_*[si]/);
5593 if (CHK("PREFER_KERNEL_TYPES",
5594 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5596 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5601 # check for cast of C90 native int or longer types constants
5602 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5605 if (WARN("TYPECAST_INT_CONSTANT",
5606 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5609 my $newconst = $const;
5610 $newconst =~ s/${Int_type}$//;
5611 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5612 if ($cast =~ /\blong\s+long\b/) {
5614 } elsif ($cast =~ /\blong\b/) {
5617 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5621 # check for sizeof(&)
5622 if ($line =~ /\bsizeof\s*\(\s*\&/) {
5623 WARN("SIZEOF_ADDRESS",
5624 "sizeof(& should be avoided\n" . $herecurr);
5627 # check for sizeof without parenthesis
5628 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
5629 if (WARN("SIZEOF_PARENTHESIS",
5630 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5632 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5636 # check for struct spinlock declarations
5637 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5638 WARN("USE_SPINLOCK_T",
5639 "struct spinlock should be spinlock_t\n" . $herecurr);
5642 # check for seq_printf uses that could be seq_puts
5643 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
5644 my $fmt = get_quoted_string($line, $rawline);
5647 if (WARN("PREFER_SEQ_PUTS",
5648 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5650 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
5655 # Check for misused memsets
5656 if ($^V && $^V ge 5.10.0 &&
5658 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
5664 if ($ms_size =~ /^(0x|)0$/i) {
5666 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
5667 } elsif ($ms_size =~ /^(0x|)1$/i) {
5669 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5673 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5674 # if ($^V && $^V ge 5.10.0 &&
5676 # $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5677 # if (WARN("PREFER_ETHER_ADDR_COPY",
5678 # "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5680 # $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5684 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5685 # if ($^V && $^V ge 5.10.0 &&
5687 # $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5688 # WARN("PREFER_ETHER_ADDR_EQUAL",
5689 # "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5692 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5693 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5694 # if ($^V && $^V ge 5.10.0 &&
5696 # $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5700 # if ($ms_val =~ /^(?:0x|)0+$/i) {
5701 # if (WARN("PREFER_ETH_ZERO_ADDR",
5702 # "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5704 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5706 # } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5707 # if (WARN("PREFER_ETH_BROADCAST_ADDR",
5708 # "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5710 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5715 # typecasts on min/max could be min_t/max_t
5716 if ($^V && $^V ge 5.10.0 &&
5718 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
5719 if (defined $2 || defined $7) {
5721 my $cast1 = deparenthesize($2);
5723 my $cast2 = deparenthesize($7);
5727 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
5728 $cast = "$cast1 or $cast2";
5729 } elsif ($cast1 ne "") {
5735 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
5739 # check usleep_range arguments
5740 if ($^V && $^V ge 5.10.0 &&
5742 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5746 WARN("USLEEP_RANGE",
5747 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5748 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5750 WARN("USLEEP_RANGE",
5751 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5755 # check for naked sscanf
5756 if ($^V && $^V ge 5.10.0 &&
5758 $line =~ /\bsscanf\b/ &&
5759 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5760 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5761 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5762 my $lc = $stat =~ tr@\n@@;
5763 $lc = $lc + $linenr;
5764 my $stat_real = raw_line($linenr, 0);
5765 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5766 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5768 WARN("NAKED_SSCANF",
5769 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5772 # check for simple sscanf that should be kstrto<foo>
5773 if ($^V && $^V ge 5.10.0 &&
5775 $line =~ /\bsscanf\b/) {
5776 my $lc = $stat =~ tr@\n@@;
5777 $lc = $lc + $linenr;
5778 my $stat_real = raw_line($linenr, 0);
5779 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5780 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5782 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5784 my $count = $format =~ tr@%@%@;
5786 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5787 WARN("SSCANF_TO_KSTRTO",
5788 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5793 # check for new externs in .h files.
5794 if ($realfile =~ /\.h$/ &&
5795 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
5796 if (CHK("AVOID_EXTERNS",
5797 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
5799 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
5803 # check for new externs in .c files.
5804 if ($realfile =~ /\.c$/ && defined $stat &&
5805 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
5807 my $function_name = $1;
5808 my $paren_space = $2;
5811 if (defined $cond) {
5812 substr($s, 0, length($cond), '');
5814 if ($s =~ /^\s*;/ &&
5815 $function_name ne 'uninitialized_var')
5817 WARN("AVOID_EXTERNS",
5818 "externs should be avoided in .c files\n" . $herecurr);
5821 if ($paren_space =~ /\n/) {
5822 WARN("FUNCTION_ARGUMENTS",
5823 "arguments for function declarations should follow identifier\n" . $herecurr);
5826 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5827 $stat =~ /^.\s*extern\s+/)
5829 WARN("AVOID_EXTERNS",
5830 "externs should be avoided in .c files\n" . $herecurr);
5833 if ($realfile =~ /\.[ch]$/ && defined $stat &&
5834 $stat =~ /^.\s*(?:extern\s+)?$Type\s*$Ident\s*\(\s*([^{]+)\s*\)\s*;/s &&
5836 my $args = trim($1);
5837 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
5839 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
5840 WARN("FUNCTION_ARGUMENTS",
5841 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
5846 # checks for new __setup's
5847 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5850 if (!grep(/$name/, @setup_docs)) {
5851 CHK("UNDOCUMENTED_SETUP",
5852 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
5856 # check for pointless casting of kmalloc return
5857 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
5858 WARN("UNNECESSARY_CASTS",
5859 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
5863 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5864 if ($^V && $^V ge 5.10.0 &&
5865 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5866 CHK("ALLOC_SIZEOF_STRUCT",
5867 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
5870 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5871 if ($^V && $^V ge 5.10.0 &&
5872 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
5876 my $newfunc = "kmalloc_array";
5877 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
5880 if ($a1 =~ /^sizeof\s*\S/) {
5884 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
5885 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
5886 if (WARN("ALLOC_WITH_MULTIPLY",
5887 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
5889 $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;
5895 # check for krealloc arg reuse
5896 if ($^V && $^V ge 5.10.0 &&
5897 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
5898 WARN("KREALLOC_ARG_REUSE",
5899 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
5902 # check for alloc argument mismatch
5903 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
5904 WARN("ALLOC_ARRAY_ARGS",
5905 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
5908 # check for multiple semicolons
5909 if ($line =~ /;\s*;\s*$/) {
5910 if (WARN("ONE_SEMICOLON",
5911 "Statements terminations use 1 semicolon\n" . $herecurr) &&
5913 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
5917 # check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
5918 if ($realfile !~ m@^include/uapi/@ &&
5919 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
5921 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
5922 if (CHK("BIT_MACRO",
5923 "Prefer using the BIT$ull macro\n" . $herecurr) &&
5925 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
5929 # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
5930 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
5932 if (WARN("PREFER_IS_ENABLED",
5933 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
5935 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
5939 # check for case / default statements not preceded by break/fallthrough/switch
5940 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
5942 my $has_statement = 0;
5944 my $prevline = $linenr;
5945 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
5947 my $rline = $rawlines[$prevline - 1];
5948 my $fline = $lines[$prevline - 1];
5949 last if ($fline =~ /^\@\@/);
5950 next if ($fline =~ /^\-/);
5951 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
5952 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
5953 next if ($fline =~ /^.[\s$;]*$/);
5956 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
5958 if (!$has_break && $has_statement) {
5959 WARN("MISSING_BREAK",
5960 "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr);
5964 # check for switch/default statements without a break;
5965 if ($^V && $^V ge 5.10.0 &&
5967 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
5969 my $herectx = $here . "\n";
5970 my $cnt = statement_rawlines($stat);
5971 for (my $n = 0; $n < $cnt; $n++) {
5972 $herectx .= raw_line($linenr, $n) . "\n";
5974 WARN("DEFAULT_NO_BREAK",
5975 "switch default: should use break\n" . $herectx);
5978 # check for gcc specific __FUNCTION__
5979 if ($line =~ /\b__FUNCTION__\b/) {
5980 if (WARN("USE_FUNC",
5981 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
5983 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
5987 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
5988 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
5990 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
5993 # check for use of yield()
5994 if ($line =~ /\byield\s*\(\s*\)/) {
5996 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
5999 # check for comparisons against true and false
6000 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6008 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6010 my $type = lc($otype);
6011 if ($type =~ /^(?:true|false)$/) {
6012 if (("$test" eq "==" && "$type" eq "true") ||
6013 ("$test" eq "!=" && "$type" eq "false")) {
6017 CHK("BOOL_COMPARISON",
6018 "Using comparison to $otype is error prone\n" . $herecurr);
6020 ## maybe suggesting a correct construct would better
6021 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6026 # check for semaphores initialized locked
6027 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
6028 WARN("CONSIDER_COMPLETION",
6029 "consider using a completion\n" . $herecurr);
6032 # recommend kstrto* over simple_strto* and strict_strto*
6033 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
6034 WARN("CONSIDER_KSTRTO",
6035 "$1 is obsolete, use k$3 instead\n" . $herecurr);
6038 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
6039 if ($line =~ /^.\s*__initcall\s*\(/) {
6040 WARN("USE_DEVICE_INITCALL",
6041 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
6044 # check for various structs that are normally const (ops, kgdb, device_tree)
6045 if ($line !~ /\bconst\b/ &&
6046 $line =~ /\bstruct\s+($const_structs)\b/) {
6047 WARN("CONST_STRUCT",
6048 "struct $1 should normally be const\n" .
6052 # use of NR_CPUS is usually wrong
6053 # ignore definitions of NR_CPUS and usage to define arrays as likely right
6054 if ($line =~ /\bNR_CPUS\b/ &&
6055 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6056 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
6057 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6058 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6059 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
6062 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
6065 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6066 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6067 ERROR("DEFINE_ARCH_HAS",
6068 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6071 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
6072 if ($^V && $^V ge 5.10.0 &&
6073 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6074 WARN("LIKELY_MISUSE",
6075 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6078 # whine mightly about in_atomic
6079 if ($line =~ /\bin_atomic\s*\(/) {
6080 if ($realfile =~ m@^drivers/@) {
6082 "do not use in_atomic in drivers\n" . $herecurr);
6083 } elsif ($realfile !~ m@^kernel/@) {
6085 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
6089 # whine about ACCESS_ONCE
6090 if ($^V && $^V ge 5.10.0 &&
6091 $line =~ /\bACCESS_ONCE\s*$balanced_parens\s*(=(?!=))?\s*($FuncArg)?/) {
6095 $par =~ s/^\(\s*(.*)\s*\)$/$1/;
6097 if (WARN("PREFER_WRITE_ONCE",
6098 "Prefer WRITE_ONCE(<FOO>, <BAR>) over ACCESS_ONCE(<FOO>) = <BAR>\n" . $herecurr) &&
6100 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/;
6103 if (WARN("PREFER_READ_ONCE",
6104 "Prefer READ_ONCE(<FOO>) over ACCESS_ONCE(<FOO>)\n" . $herecurr) &&
6106 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)/READ_ONCE($par)/;
6111 # check for mutex_trylock_recursive usage
6112 if ($line =~ /mutex_trylock_recursive/) {
6114 "recursive locking is bad, do not use this ever.\n" . $herecurr);
6117 # check for lockdep_set_novalidate_class
6118 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6119 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6120 if ($realfile !~ m@^kernel/lockdep@ &&
6121 $realfile !~ m@^include/linux/lockdep@ &&
6122 $realfile !~ m@^drivers/base/core@) {
6124 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
6128 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6129 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
6130 WARN("EXPORTED_WORLD_WRITABLE",
6131 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6134 # Mode permission misuses where it seems decimal should be octal
6135 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6136 if ($^V && $^V ge 5.10.0 &&
6138 $line =~ /$mode_perms_search/) {
6139 foreach my $entry (@mode_permission_funcs) {
6140 my $func = $entry->[0];
6141 my $arg_pos = $entry->[1];
6143 my $lc = $stat =~ tr@\n@@;
6144 $lc = $lc + $linenr;
6145 my $stat_real = raw_line($linenr, 0);
6146 for (my $count = $linenr + 1; $count <= $lc; $count++) {
6147 $stat_real = $stat_real . "\n" . raw_line($count, 0);
6153 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6155 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
6156 if ($stat =~ /$test/) {
6158 $val = $6 if ($skip_args ne "");
6159 if (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6160 ($val =~ /^$Octal$/ && length($val) ne 4)) {
6161 ERROR("NON_OCTAL_PERMISSIONS",
6162 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
6164 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
6165 ERROR("EXPORTED_WORLD_WRITABLE",
6166 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
6172 # check for uses of S_<PERMS> that could be octal for readability
6173 if ($line =~ /\b$mode_perms_string_search\b/) {
6179 while ($line =~ /\b(($mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
6180 $curpos = pos($line);
6183 last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
6185 $to |= $mode_permission_string_types{$match};
6186 $val .= '\s*\|\s*' if ($val ne "");
6190 $oval =~ s/^\s*\|\s*//;
6191 $oval =~ s/\s*\|\s*$//;
6192 my $octal = sprintf("%04o", $to);
6193 if (WARN("SYMBOLIC_PERMS",
6194 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6196 $fixed[$fixlinenr] =~ s/$val/$octal/;
6200 # validate content of MODULE_LICENSE against list from include/linux/module.h
6201 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6202 my $extracted_string = get_quoted_string($line, $rawline);
6203 my $valid_licenses = qr{
6206 GPL\ and\ additional\ rights|
6212 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6213 WARN("MODULE_LICENSE",
6214 "unknown module license " . $extracted_string . "\n" . $herecurr);
6219 # If we have no input at all, then there is nothing to report on
6220 # so just keep quiet.
6221 if ($#rawlines == -1) {
6225 # In mailback mode only produce a report in the negative, for
6226 # things that appear to be patches.
6227 if ($mailback && ($clean == 1 || !$is_patch)) {
6231 # This is not a patch, and we are are in 'no-patch' mode so
6233 if (!$chk_patch && !$is_patch) {
6237 if (!$is_patch && $file !~ /cover-letter\.patch$/) {
6238 ERROR("NOT_UNIFIED_DIFF",
6239 "Does not appear to be a unified-diff format patch\n");
6241 if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) {
6242 ERROR("MISSING_SIGN_OFF",
6243 "Missing Signed-off-by: line(s)\n");
6246 print report_dump();
6247 if ($summary && !($clean == 1 && $quiet == 1)) {
6248 print "$filename " if ($summary_file);
6249 print "total: $cnt_error errors, $cnt_warn warnings, " .
6250 (($check)? "$cnt_chk checks, " : "") .
6251 "$cnt_lines lines checked\n";
6255 # If there were any defects found and not already fixing them
6256 if (!$clean and !$fix) {
6259 NOTE: For some of the reported defects, checkpatch may be able to
6260 mechanically convert to the typical style using --fix or --fix-inplace.
6263 # If there were whitespace errors which cleanpatch can fix
6264 # then suggest that.
6265 if ($rpt_cleaners) {
6269 NOTE: Whitespace errors detected.
6270 You may wish to use scripts/cleanpatch or scripts/cleanfile
6275 if ($clean == 0 && $fix &&
6276 ("@rawlines" ne "@fixed" ||
6277 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
6278 my $newfile = $filename;
6279 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
6283 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6285 open($f, '>', $newfile)
6286 or die "$P: Can't open $newfile for write\n";
6287 foreach my $fixed_line (@fixed) {
6290 if ($linecount > 3) {
6291 $fixed_line =~ s/^\+//;
6292 print $f $fixed_line . "\n";
6295 print $f $fixed_line . "\n";
6303 Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6305 Do _NOT_ trust the results written to this file.
6306 Do _NOT_ submit these changes without inspecting them for correctness.
6308 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6309 No warranties, expressed or implied...
6317 print "$vname has no obvious style problems and is ready for submission.\n";
6319 print "$vname has style problems, please review.\n";