2 # SPDX-License-Identifier: GPL-2.0
4 # (c) 2001, Dave Jones. (the file handling bit)
5 # (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
6 # (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
7 # (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
8 # (c) 2010-2018 Joe Perches <joe@perches.com>
15 use Term::ANSIColor qw(:constants);
16 use Encode qw(decode encode);
19 my $D = dirname(abs_path($P));
23 use Getopt::Long qw(:config no_auto_abbrev);
53 my $configuration_file = ".checkpatch.conf";
54 my $max_line_length = 80;
55 my $ignore_perl_version = 0;
56 my $minimum_perl_version = 5.10.0;
57 my $min_conf_desc_length = 4;
58 my $spelling_file = "$D/spelling.txt";
60 my $codespellfile = "/usr/share/codespell/dictionary.txt";
61 my $conststructsfile = "$D/const_structs.checkpatch";
62 my $typedefsfile = "";
64 my $allow_c99_comments = 1; # Can be overridden by --ignore C99_COMMENT_TOLERANCE
70 Usage: $P [OPTION]... [FILE]...
75 --no-tree run without a kernel tree
76 --no-signoff do not check for 'Signed-off-by' line
77 --patch treat FILE as patchfile (default)
78 --emacs emacs compile window format
79 --terse one line per report
80 --showfile emit diffed file position, not input file position
81 -g, --git treat FILE as a single commit or git revision range
82 single git commit with:
86 multiple git commits with:
90 git merges are ignored
91 -f, --file treat FILE as regular source file
92 --subjective, --strict enable more subjective tests
93 --list-types list the possible message types
94 --types TYPE(,TYPE2...) show only these comma separated message types
95 --ignore TYPE(,TYPE2...) ignore various comma separated message types
96 --show-types show the specific message type in the output
97 --max-line-length=n set the maximum line length, if exceeded, warn
98 --min-conf-desc-length=n set the min description length, if shorter, warn
99 --root=PATH PATH to the kernel tree root
100 --no-summary suppress the per-file summary
101 --mailback only produce a report in case of warnings/errors
102 --summary-file include the filename in summary
103 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
104 'values', 'possible', 'type', and 'attr' (default
106 --test-only=WORD report only warnings/errors containing WORD
108 --fix EXPERIMENTAL - may create horrible results
109 If correctable single-line errors exist, create
110 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
111 with potential errors corrected to the preferred
113 --fix-inplace EXPERIMENTAL - may create horrible results
114 Is the same as --fix, but overwrites the input
115 file. It's your fault if there's no backup or git
116 --ignore-perl-version override checking of perl version. expect
118 --codespell Use the codespell dictionary for spelling/typos
119 (default:/usr/share/codespell/dictionary.txt)
120 --codespellfile Use this codespell dictionary
121 --typedefsfile Read additional types from this file
122 --color[=WHEN] Use colors 'always', 'never', or only when output
123 is a terminal ('auto'). Default is 'auto'.
124 -h, --help, --version display this help and exit
126 When FILE is - read standard input.
134 return grep { !$seen{$_}++ } @_;
144 open(my $script, '<', abs_path($P)) or
145 die "$P: Can't read '$P' $!\n";
147 my $text = <$script>;
151 # Also catch when type or level is passed through a variable
152 for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
155 @types = sort(uniq(@types));
156 print("#\tMessage type\n\n");
157 foreach my $type (@types) {
158 print(++$count . "\t" . $type . "\n");
164 my $conf = which_conf($configuration_file);
167 open(my $conffile, '<', "$conf")
168 or warn "$P: Can't find a readable $configuration_file file $!\n";
170 while (<$conffile>) {
173 $line =~ s/\s*\n?$//g;
177 next if ($line =~ m/^\s*#/);
178 next if ($line =~ m/^\s*$/);
180 my @words = split(" ", $line);
181 foreach my $word (@words) {
182 last if ($word =~ m/^#/);
183 push (@conf_args, $word);
187 unshift(@ARGV, @conf_args) if @conf_args;
190 # Perl's Getopt::Long allows options to take optional arguments after a space.
191 # Prevent --color by itself from consuming other arguments
193 if ($_ eq "--color" || $_ eq "-color") {
194 $_ = "--color=$color";
199 'q|quiet+' => \$quiet,
201 'signoff!' => \$chk_signoff,
202 'patch!' => \$chk_patch,
205 'showfile!' => \$showfile,
208 'subjective!' => \$check,
209 'strict!' => \$check,
210 'ignore=s' => \@ignore,
212 'show-types!' => \$show_types,
213 'list-types!' => \$list_types,
214 'max-line-length=i' => \$max_line_length,
215 'min-conf-desc-length=i' => \$min_conf_desc_length,
217 'summary!' => \$summary,
218 'mailback!' => \$mailback,
219 'summary-file!' => \$summary_file,
221 'fix-inplace!' => \$fix_inplace,
222 'ignore-perl-version!' => \$ignore_perl_version,
223 'debug=s' => \%debug,
224 'test-only=s' => \$tst_only,
225 'codespell!' => \$codespell,
226 'codespellfile=s' => \$codespellfile,
227 'typedefsfile=s' => \$typedefsfile,
228 'color=s' => \$color,
229 'no-color' => \$color, #keep old behaviors of -nocolor
230 'nocolor' => \$color, #keep old behaviors of -nocolor
237 list_types(0) if ($list_types);
239 $fix = 1 if ($fix_inplace);
240 $check_orig = $check;
244 my $perl_version_ok = 1;
245 if ($^V && $^V lt $minimum_perl_version) {
246 $perl_version_ok = 0;
247 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
248 exit(1) if (!$ignore_perl_version);
251 #if no filenames are given, push '-' to read patch from stdin
256 if ($color =~ /^[01]$/) {
258 } elsif ($color =~ /^always$/i) {
260 } elsif ($color =~ /^never$/i) {
262 } elsif ($color =~ /^auto$/i) {
263 $color = (-t STDOUT);
265 die "Invalid color mode: $color\n";
268 sub hash_save_array_words {
269 my ($hashRef, $arrayRef) = @_;
271 my @array = split(/,/, join(',', @$arrayRef));
272 foreach my $word (@array) {
273 $word =~ s/\s*\n?$//g;
276 $word =~ tr/[a-z]/[A-Z]/;
278 next if ($word =~ m/^\s*#/);
279 next if ($word =~ m/^\s*$/);
285 sub hash_show_words {
286 my ($hashRef, $prefix) = @_;
288 if (keys %$hashRef) {
289 print "\nNOTE: $prefix message types:";
290 foreach my $word (sort keys %$hashRef) {
297 hash_save_array_words(\%ignore_type, \@ignore);
298 hash_save_array_words(\%use_type, \@use);
301 my $dbg_possible = 0;
304 for my $key (keys %debug) {
306 eval "\${dbg_$key} = '$debug{$key}';";
310 my $rpt_cleaners = 0;
319 if (!top_of_kernel_tree($root)) {
320 die "$P: $root: --root does not point at a valid tree\n";
323 if (top_of_kernel_tree('.')) {
325 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
326 top_of_kernel_tree($1)) {
331 if (!defined $root) {
332 print "Must be run from the top-level dir. of a kernel tree\n";
337 my $emitted_corrupt = 0;
340 [A-Za-z_][A-Za-z\d_]*
341 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
343 our $Storage = qr{extern|static|asmlinkage};
357 our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
358 our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
359 our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
360 our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
361 our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
363 # Notes to $Attribute:
364 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
386 ____cacheline_aligned|
387 ____cacheline_aligned_in_smp|
388 ____cacheline_internodealigned_in_smp|
392 our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
393 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
394 our $Lval = qr{$Ident(?:$Member)*};
396 our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
397 our $Binary = qr{(?i)0b[01]+$Int_type?};
398 our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
399 our $Int = qr{[0-9]+$Int_type?};
400 our $Octal = qr{0[0-7]+$Int_type?};
401 our $String = qr{"[X\t]*"};
402 our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
403 our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
404 our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
405 our $Float = qr{$Float_hex|$Float_dec|$Float_int};
406 our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
407 our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
408 our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
409 our $Arithmetic = qr{\+|-|\*|\/|%};
413 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
416 our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
420 our $NonptrTypeMisordered;
421 our $NonptrTypeWithAttr;
425 our $DeclareMisordered;
427 our $NON_ASCII_UTF8 = qr{
428 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
429 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
430 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
431 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
432 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
433 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
434 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
438 [\x09\x0A\x0D\x20-\x7E] # ASCII
442 our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
443 our $typeOtherOSTypedefs = qr{(?x:
444 u_(?:char|short|int|long) | # bsd
445 u(?:nchar|short|int|long) # sysv
447 our $typeKernelTypedefs = qr{(?x:
448 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
451 our $typeTypedefs = qr{(?x:
453 $typeOtherOSTypedefs\b|
454 $typeKernelTypedefs\b
457 our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
459 our $logFunctions = qr{(?x:
460 printk(?:_ratelimited|_once|_deferred_once|_deferred|)|
461 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
463 WARN(?:_RATELIMIT|_ONCE|)|
466 seq_vprintf|seq_printf|seq_puts
469 our $allocFunctions = qr{(?x:
471 (?:kv|k|v)[czm]alloc(?:_node|_array)? |
474 (?:\w+)?alloc_skb(?:ip_align)? |
475 # dev_alloc_skb/netdev_alloc_skb, et al
479 our $signature_tags = qr{(?xi:
491 our @typeListMisordered = (
492 qr{char\s+(?:un)?signed},
493 qr{int\s+(?:(?:un)?signed\s+)?short\s},
494 qr{int\s+short(?:\s+(?:un)?signed)},
495 qr{short\s+int(?:\s+(?:un)?signed)},
496 qr{(?:un)?signed\s+int\s+short},
497 qr{short\s+(?:un)?signed},
498 qr{long\s+int\s+(?:un)?signed},
499 qr{int\s+long\s+(?:un)?signed},
500 qr{long\s+(?:un)?signed\s+int},
501 qr{int\s+(?:un)?signed\s+long},
502 qr{int\s+(?:un)?signed},
503 qr{int\s+long\s+long\s+(?:un)?signed},
504 qr{long\s+long\s+int\s+(?:un)?signed},
505 qr{long\s+long\s+(?:un)?signed\s+int},
506 qr{long\s+long\s+(?:un)?signed},
507 qr{long\s+(?:un)?signed},
512 qr{(?:(?:un)?signed\s+)?char},
513 qr{(?:(?:un)?signed\s+)?short\s+int},
514 qr{(?:(?:un)?signed\s+)?short},
515 qr{(?:(?:un)?signed\s+)?int},
516 qr{(?:(?:un)?signed\s+)?long\s+int},
517 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
518 qr{(?:(?:un)?signed\s+)?long\s+long},
519 qr{(?:(?:un)?signed\s+)?long},
528 qr{${Ident}_handler},
529 qr{${Ident}_handler_fn},
533 our $C90_int_types = qr{(?x:
534 long\s+long\s+int\s+(?:un)?signed|
535 long\s+long\s+(?:un)?signed\s+int|
536 long\s+long\s+(?:un)?signed|
537 (?:(?:un)?signed\s+)?long\s+long\s+int|
538 (?:(?:un)?signed\s+)?long\s+long|
539 int\s+long\s+long\s+(?:un)?signed|
540 int\s+(?:(?:un)?signed\s+)?long\s+long|
542 long\s+int\s+(?:un)?signed|
543 long\s+(?:un)?signed\s+int|
544 long\s+(?:un)?signed|
545 (?:(?:un)?signed\s+)?long\s+int|
546 (?:(?:un)?signed\s+)?long|
547 int\s+long\s+(?:un)?signed|
548 int\s+(?:(?:un)?signed\s+)?long|
551 (?:(?:un)?signed\s+)?int
554 our @typeListFile = ();
555 our @typeListWithAttr = (
557 qr{struct\s+$InitAttribute\s+$Ident},
558 qr{union\s+$InitAttribute\s+$Ident},
561 our @modifierList = (
564 our @modifierListFile = ();
566 our @mode_permission_funcs = (
568 ["module_param_(?:array|named|string)", 4],
569 ["module_param_array_named", 5],
570 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
571 ["proc_create(?:_data|)", 2],
572 ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2],
573 ["IIO_DEV_ATTR_[A-Z_]+", 1],
574 ["SENSOR_(?:DEVICE_|)ATTR_2", 2],
575 ["SENSOR_TEMPLATE(?:_2|)", 3],
579 #Create a search pattern for all these functions to speed up a loop below
580 our $mode_perms_search = "";
581 foreach my $entry (@mode_permission_funcs) {
582 $mode_perms_search .= '|' if ($mode_perms_search ne "");
583 $mode_perms_search .= $entry->[0];
585 $mode_perms_search = "(?:${mode_perms_search})";
587 our %deprecated_apis = (
588 "synchronize_rcu_bh" => "synchronize_rcu",
589 "synchronize_rcu_bh_expedited" => "synchronize_rcu_expedited",
590 "call_rcu_bh" => "call_rcu",
591 "rcu_barrier_bh" => "rcu_barrier",
592 "synchronize_sched" => "synchronize_rcu",
593 "synchronize_sched_expedited" => "synchronize_rcu_expedited",
594 "call_rcu_sched" => "call_rcu",
595 "rcu_barrier_sched" => "rcu_barrier",
596 "get_state_synchronize_sched" => "get_state_synchronize_rcu",
597 "cond_synchronize_sched" => "cond_synchronize_rcu",
600 #Create a search pattern for all these strings to speed up a loop below
601 our $deprecated_apis_search = "";
602 foreach my $entry (keys %deprecated_apis) {
603 $deprecated_apis_search .= '|' if ($deprecated_apis_search ne "");
604 $deprecated_apis_search .= $entry;
606 $deprecated_apis_search = "(?:${deprecated_apis_search})";
608 our $mode_perms_world_writable = qr{
616 our %mode_permission_string_types = (
635 #Create a search pattern for all these strings to speed up a loop below
636 our $mode_perms_string_search = "";
637 foreach my $entry (keys %mode_permission_string_types) {
638 $mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
639 $mode_perms_string_search .= $entry;
641 our $single_mode_perms_string_search = "(?:${mode_perms_string_search})";
642 our $multi_mode_perms_string_search = qr{
643 ${single_mode_perms_string_search}
644 (?:\s*\|\s*${single_mode_perms_string_search})*
650 return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/);
657 while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
658 $curpos = pos($string);
661 last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
663 $to |= $mode_permission_string_types{$match};
664 $val .= '\s*\|\s*' if ($val ne "");
668 $oval =~ s/^\s*\|\s*//;
669 $oval =~ s/\s*\|\s*$//;
670 return sprintf("%04o", $to);
673 our $allowed_asm_includes = qr{(?x:
679 # memory.h: ARM has a custom one
681 # Load common spelling mistakes and build regular expression list.
685 if (open(my $spelling, '<', $spelling_file)) {
686 while (<$spelling>) {
689 $line =~ s/\s*\n?$//g;
692 next if ($line =~ m/^\s*#/);
693 next if ($line =~ m/^\s*$/);
695 my ($suspect, $fix) = split(/\|\|/, $line);
697 $spelling_fix{$suspect} = $fix;
701 warn "No typos will be found - file '$spelling_file': $!\n";
705 if (open(my $spelling, '<', $codespellfile)) {
706 while (<$spelling>) {
709 $line =~ s/\s*\n?$//g;
712 next if ($line =~ m/^\s*#/);
713 next if ($line =~ m/^\s*$/);
714 next if ($line =~ m/, disabled/i);
718 my ($suspect, $fix) = split(/->/, $line);
720 $spelling_fix{$suspect} = $fix;
724 warn "No codespell typos will be found - file '$codespellfile': $!\n";
728 $misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
731 my ($wordsRef, $file) = @_;
733 if (open(my $words, '<', $file)) {
737 $line =~ s/\s*\n?$//g;
740 next if ($line =~ m/^\s*#/);
741 next if ($line =~ m/^\s*$/);
743 print("$file: '$line' invalid - ignored\n");
747 $$wordsRef .= '|' if ($$wordsRef ne "");
757 my $const_structs = "";
758 read_words(\$const_structs, $conststructsfile)
759 or warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
761 my $typeOtherTypedefs = "";
762 if (length($typedefsfile)) {
763 read_words(\$typeOtherTypedefs, $typedefsfile)
764 or warn "No additional types will be considered - file '$typedefsfile': $!\n";
766 $typeTypedefs .= '|' . $typeOtherTypedefs if ($typeOtherTypedefs ne "");
769 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
770 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
771 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
772 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
773 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
779 (?:$Modifier\s+|const\s+)*
781 (?:typeof|__typeof__)\s*\([^\)]*\)|
785 (?:\s+$Modifier|\s+const)*
787 $NonptrTypeMisordered = qr{
788 (?:$Modifier\s+|const\s+)*
792 (?:\s+$Modifier|\s+const)*
794 $NonptrTypeWithAttr = qr{
795 (?:$Modifier\s+|const\s+)*
797 (?:typeof|__typeof__)\s*\([^\)]*\)|
801 (?:\s+$Modifier|\s+const)*
805 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
806 (?:\s+$Inline|\s+$Modifier)*
808 $TypeMisordered = qr{
809 $NonptrTypeMisordered
810 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
811 (?:\s+$Inline|\s+$Modifier)*
813 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
814 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
818 our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
820 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
821 # requires at least perl version v5.10.0
822 # Any use must be runtime checked with $^V
824 our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
825 our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
826 our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
828 our $declaration_macros = qr{(?x:
829 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
830 (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(|
831 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(|
832 (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\(
837 return "" if (!defined($string));
839 while ($string =~ /^\s*\(.*\)\s*$/) {
840 $string =~ s@^\s*\(\s*@@;
841 $string =~ s@\s*\)\s*$@@;
844 $string =~ s@\s+@ @g;
849 sub seed_camelcase_file {
852 return if (!(-f $file));
856 open(my $include_file, '<', "$file")
857 or warn "$P: Can't read '$file' $!\n";
858 my $text = <$include_file>;
859 close($include_file);
861 my @lines = split('\n', $text);
863 foreach my $line (@lines) {
864 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
865 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
867 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
869 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
875 sub is_maintained_obsolete {
878 return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl"));
880 my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
882 return $status =~ /obsolete/i;
885 sub is_SPDX_License_valid {
888 return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$root/.git"));
890 my $root_path = abs_path($root);
891 my $status = `cd "$root_path"; echo "$license" | python scripts/spdxcheck.py -`;
892 return 0 if ($status ne "");
896 my $camelcase_seeded = 0;
897 sub seed_camelcase_includes {
898 return if ($camelcase_seeded);
901 my $camelcase_cache = "";
902 my @include_files = ();
904 $camelcase_seeded = 1;
907 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
908 chomp $git_last_include_commit;
909 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
911 my $last_mod_date = 0;
912 $files = `find $root/include -name "*.h"`;
913 @include_files = split('\n', $files);
914 foreach my $file (@include_files) {
915 my $date = POSIX::strftime("%Y%m%d%H%M",
916 localtime((stat $file)[9]));
917 $last_mod_date = $date if ($last_mod_date < $date);
919 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
922 if ($camelcase_cache ne "" && -f $camelcase_cache) {
923 open(my $camelcase_file, '<', "$camelcase_cache")
924 or warn "$P: Can't read '$camelcase_cache' $!\n";
925 while (<$camelcase_file>) {
929 close($camelcase_file);
935 $files = `git ls-files "include/*.h"`;
936 @include_files = split('\n', $files);
939 foreach my $file (@include_files) {
940 seed_camelcase_file($file);
943 if ($camelcase_cache ne "") {
944 unlink glob ".checkpatch-camelcase.*";
945 open(my $camelcase_file, '>', "$camelcase_cache")
946 or warn "$P: Can't write '$camelcase_cache' $!\n";
947 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
948 print $camelcase_file ("$_\n");
950 close($camelcase_file);
954 sub git_commit_info {
955 my ($commit, $id, $desc) = @_;
957 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
959 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
960 $output =~ s/^\s*//gm;
961 my @lines = split("\n", $output);
963 return ($id, $desc) if ($#lines < 0);
965 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
966 # Maybe one day convert this block of bash into something that returns
967 # all matching commit ids, but it's very slow...
969 # echo "checking commits $1..."
970 # git rev-list --remotes | grep -i "^$1" |
971 # while read line ; do
972 # git log --format='%H %s' -1 $line |
973 # echo "commit $(cut -c 1-12,41-)"
975 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
978 $id = substr($lines[0], 0, 12);
979 $desc = substr($lines[0], 41);
985 $chk_signoff = 0 if ($file);
990 my @fixed_inserted = ();
991 my @fixed_deleted = ();
994 # If input is git commits, extract all commits from the commit expressions.
995 # For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
996 die "$P: No git repository found\n" if ($git && !-e ".git");
1000 foreach my $commit_expr (@ARGV) {
1002 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
1003 $git_range = "-$2 $1";
1004 } elsif ($commit_expr =~ m/\.\./) {
1005 $git_range = "$commit_expr";
1007 $git_range = "-1 $commit_expr";
1009 my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
1010 foreach my $line (split(/\n/, $lines)) {
1011 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
1012 next if (!defined($1) || !defined($2));
1015 unshift(@commits, $sha1);
1016 $git_commits{$sha1} = $subject;
1019 die "$P: no git commits after extraction!\n" if (@commits == 0);
1024 $allow_c99_comments = !defined $ignore_type{"C99_COMMENT_TOLERANCE"};
1025 for my $filename (@ARGV) {
1028 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
1029 die "$P: $filename: git format-patch failed - $!\n";
1031 open($FILE, '-|', "diff -u /dev/null $filename") ||
1032 die "$P: $filename: diff failed - $!\n";
1033 } elsif ($filename eq '-') {
1034 open($FILE, '<&STDIN');
1036 open($FILE, '<', "$filename") ||
1037 die "$P: $filename: open failed - $!\n";
1039 if ($filename eq '-') {
1040 $vname = 'Your patch';
1042 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
1048 push(@rawlines, $_);
1052 if ($#ARGV > 0 && $quiet == 0) {
1053 print '-' x length($vname) . "\n";
1055 print '-' x length($vname) . "\n";
1058 if (!process($filename)) {
1064 @fixed_inserted = ();
1065 @fixed_deleted = ();
1067 @modifierListFile = ();
1073 hash_show_words(\%use_type, "Used");
1074 hash_show_words(\%ignore_type, "Ignored");
1076 if (!$perl_version_ok) {
1079 NOTE: perl $^V is not modern enough to detect all possible issues.
1080 An upgrade to at least perl $minimum_perl_version is suggested.
1086 NOTE: If any of the errors are false positives, please report
1087 them to the maintainer, see CHECKPATCH in MAINTAINERS.
1094 sub top_of_kernel_tree {
1098 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
1099 "README", "Documentation", "arch", "include", "drivers",
1100 "fs", "init", "ipc", "kernel", "lib", "scripts",
1103 foreach my $check (@tree_check) {
1104 if (! -e $root . '/' . $check) {
1112 my ($formatted_email) = @_;
1118 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
1121 $comment = $3 if defined $3;
1122 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
1124 $comment = $2 if defined $2;
1125 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
1127 $comment = $2 if defined $2;
1128 $formatted_email =~ s/\Q$address\E.*$//;
1129 $name = $formatted_email;
1130 $name = trim($name);
1131 $name =~ s/^\"|\"$//g;
1132 # If there's a name left after stripping spaces and
1133 # leading quotes, and the address doesn't have both
1134 # leading and trailing angle brackets, the address
1136 # "joe smith joe@smith.com" bad
1137 # "joe smith <joe@smith.com" bad
1138 if ($name ne "" && $address !~ /^<[^>]+>$/) {
1145 $name = trim($name);
1146 $name =~ s/^\"|\"$//g;
1147 $address = trim($address);
1148 $address =~ s/^\<|\>$//g;
1150 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1151 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1152 $name = "\"$name\"";
1155 return ($name, $address, $comment);
1159 my ($name, $address) = @_;
1161 my $formatted_email;
1163 $name = trim($name);
1164 $name =~ s/^\"|\"$//g;
1165 $address = trim($address);
1167 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1168 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1169 $name = "\"$name\"";
1172 if ("$name" eq "") {
1173 $formatted_email = "$address";
1175 $formatted_email = "$name <$address>";
1178 return $formatted_email;
1184 foreach my $path (split(/:/, $ENV{PATH})) {
1185 if (-e "$path/$bin") {
1186 return "$path/$bin";
1196 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1197 if (-e "$path/$conf") {
1198 return "$path/$conf";
1210 for my $c (split(//, $str)) {
1214 for (; ($n % 8) != 0; $n++) {
1226 (my $res = shift) =~ tr/\t/ /c;
1233 # Drop the diff line leader and expand tabs
1235 $line = expand_tabs($line);
1237 # Pick the indent from the front of the line.
1238 my ($white) = ($line =~ /^(\s*)/);
1240 return (length($line), length($white));
1243 my $sanitise_quote = '';
1245 sub sanitise_line_reset {
1246 my ($in_comment) = @_;
1249 $sanitise_quote = '*/';
1251 $sanitise_quote = '';
1264 # Always copy over the diff marker.
1265 $res = substr($line, 0, 1);
1267 for ($off = 1; $off < length($line); $off++) {
1268 $c = substr($line, $off, 1);
1270 # Comments we are whacking completely including the begin
1271 # and end, all to $;.
1272 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1273 $sanitise_quote = '*/';
1275 substr($res, $off, 2, "$;$;");
1279 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
1280 $sanitise_quote = '';
1281 substr($res, $off, 2, "$;$;");
1285 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1286 $sanitise_quote = '//';
1288 substr($res, $off, 2, $sanitise_quote);
1293 # A \ in a string means ignore the next character.
1294 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1296 substr($res, $off, 2, 'XX');
1301 if ($c eq "'" || $c eq '"') {
1302 if ($sanitise_quote eq '') {
1303 $sanitise_quote = $c;
1305 substr($res, $off, 1, $c);
1307 } elsif ($sanitise_quote eq $c) {
1308 $sanitise_quote = '';
1312 #print "c<$c> SQ<$sanitise_quote>\n";
1313 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1314 substr($res, $off, 1, $;);
1315 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1316 substr($res, $off, 1, $;);
1317 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1318 substr($res, $off, 1, 'X');
1320 substr($res, $off, 1, $c);
1324 if ($sanitise_quote eq '//') {
1325 $sanitise_quote = '';
1328 # The pathname on a #include may be surrounded by '<' and '>'.
1329 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
1330 my $clean = 'X' x length($1);
1331 $res =~ s@\<.*\>@<$clean>@;
1333 # The whole of a #error is a string.
1334 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
1335 my $clean = 'X' x length($1);
1336 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
1339 if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1341 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1347 sub get_quoted_string {
1348 my ($line, $rawline) = @_;
1350 return "" if (!defined($line) || !defined($rawline));
1351 return "" if ($line !~ m/($String)/g);
1352 return substr($rawline, $-[0], $+[0] - $-[0]);
1355 sub ctx_statement_block {
1356 my ($linenr, $remain, $off) = @_;
1357 my $line = $linenr - 1;
1360 my $coff = $off - 1;
1374 @stack = (['', 0]) if ($#stack == -1);
1376 #warn "CSB: blk<$blk> remain<$remain>\n";
1377 # If we are about to drop off the end, pull in more
1380 for (; $remain > 0; $line++) {
1381 last if (!defined $lines[$line]);
1382 next if ($lines[$line] =~ /^-/);
1385 $blk .= $lines[$line] . "\n";
1386 $len = length($blk);
1390 # Bail if there is no further context.
1391 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1395 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1401 $c = substr($blk, $off, 1);
1402 $remainder = substr($blk, $off);
1404 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1406 # Handle nested #if/#else.
1407 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1408 push(@stack, [ $type, $level ]);
1409 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1410 ($type, $level) = @{$stack[$#stack - 1]};
1411 } elsif ($remainder =~ /^#\s*endif\b/) {
1412 ($type, $level) = @{pop(@stack)};
1415 # Statement ends at the ';' or a close '}' at the
1417 if ($level == 0 && $c eq ';') {
1421 # An else is really a conditional as long as its not else if
1422 if ($level == 0 && $coff_set == 0 &&
1423 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1424 $remainder =~ /^(else)(?:\s|{)/ &&
1425 $remainder !~ /^else\s+if\b/) {
1426 $coff = $off + length($1) - 1;
1428 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1429 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1432 if (($type eq '' || $type eq '(') && $c eq '(') {
1436 if ($type eq '(' && $c eq ')') {
1438 $type = ($level != 0)? '(' : '';
1440 if ($level == 0 && $coff < $soff) {
1443 #warn "CSB: mark coff<$coff>\n";
1446 if (($type eq '' || $type eq '{') && $c eq '{') {
1450 if ($type eq '{' && $c eq '}') {
1452 $type = ($level != 0)? '{' : '';
1455 if (substr($blk, $off + 1, 1) eq ';') {
1461 # Preprocessor commands end at the newline unless escaped.
1462 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1470 # We are truly at the end, so shuffle to the next line.
1477 my $statement = substr($blk, $soff, $off - $soff + 1);
1478 my $condition = substr($blk, $soff, $coff - $soff + 1);
1480 #warn "STATEMENT<$statement>\n";
1481 #warn "CONDITION<$condition>\n";
1483 #print "coff<$coff> soff<$off> loff<$loff>\n";
1485 return ($statement, $condition,
1486 $line, $remain + 1, $off - $loff + 1, $level);
1489 sub statement_lines {
1492 # Strip the diff line prefixes and rip blank lines at start and end.
1493 $stmt =~ s/(^|\n)./$1/g;
1497 my @stmt_lines = ($stmt =~ /\n/g);
1499 return $#stmt_lines + 2;
1502 sub statement_rawlines {
1505 my @stmt_lines = ($stmt =~ /\n/g);
1507 return $#stmt_lines + 2;
1510 sub statement_block_size {
1513 $stmt =~ s/(^|\n)./$1/g;
1519 my @stmt_lines = ($stmt =~ /\n/g);
1520 my @stmt_statements = ($stmt =~ /;/g);
1522 my $stmt_lines = $#stmt_lines + 2;
1523 my $stmt_statements = $#stmt_statements + 1;
1525 if ($stmt_lines > $stmt_statements) {
1528 return $stmt_statements;
1532 sub ctx_statement_full {
1533 my ($linenr, $remain, $off) = @_;
1534 my ($statement, $condition, $level);
1538 # Grab the first conditional/block pair.
1539 ($statement, $condition, $linenr, $remain, $off, $level) =
1540 ctx_statement_block($linenr, $remain, $off);
1541 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1542 push(@chunks, [ $condition, $statement ]);
1543 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1544 return ($level, $linenr, @chunks);
1547 # Pull in the following conditional/block pairs and see if they
1548 # could continue the statement.
1550 ($statement, $condition, $linenr, $remain, $off, $level) =
1551 ctx_statement_block($linenr, $remain, $off);
1552 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1553 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1555 push(@chunks, [ $condition, $statement ]);
1558 return ($level, $linenr, @chunks);
1562 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1564 my $start = $linenr - 1;
1571 my @stack = ($level);
1572 for ($line = $start; $remain > 0; $line++) {
1573 next if ($rawlines[$line] =~ /^-/);
1576 $blk .= $rawlines[$line];
1578 # Handle nested #if/#else.
1579 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1580 push(@stack, $level);
1581 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1582 $level = $stack[$#stack - 1];
1583 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1584 $level = pop(@stack);
1587 foreach my $c (split(//, $lines[$line])) {
1588 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1594 if ($c eq $close && $level > 0) {
1596 last if ($level == 0);
1597 } elsif ($c eq $open) {
1602 if (!$outer || $level <= 1) {
1603 push(@res, $rawlines[$line]);
1606 last if ($level == 0);
1609 return ($level, @res);
1611 sub ctx_block_outer {
1612 my ($linenr, $remain) = @_;
1614 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1618 my ($linenr, $remain) = @_;
1620 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1624 my ($linenr, $remain, $off) = @_;
1626 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1629 sub ctx_block_level {
1630 my ($linenr, $remain) = @_;
1632 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1634 sub ctx_statement_level {
1635 my ($linenr, $remain, $off) = @_;
1637 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1640 sub ctx_locate_comment {
1641 my ($first_line, $end_line) = @_;
1643 # Catch a comment on the end of the line itself.
1644 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1645 return $current_comment if (defined $current_comment);
1647 # Look through the context and try and figure out if there is a
1650 $current_comment = '';
1651 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1652 my $line = $rawlines[$linenr - 1];
1654 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1657 if ($line =~ m@/\*@) {
1660 if (!$in_comment && $current_comment ne '') {
1661 $current_comment = '';
1663 $current_comment .= $line . "\n" if ($in_comment);
1664 if ($line =~ m@\*/@) {
1669 chomp($current_comment);
1670 return($current_comment);
1672 sub ctx_has_comment {
1673 my ($first_line, $end_line) = @_;
1674 my $cmt = ctx_locate_comment($first_line, $end_line);
1676 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1677 ##print "CMMT: $cmt\n";
1679 return ($cmt ne '');
1683 my ($linenr, $cnt) = @_;
1685 my $offset = $linenr - 1;
1690 $line = $rawlines[$offset++];
1691 next if (defined($line) && $line =~ /^-/);
1699 my ($linenr, $lc) = @_;
1701 my $stat_real = raw_line($linenr, 0);
1702 for (my $count = $linenr + 1; $count <= $lc; $count++) {
1703 $stat_real = $stat_real . "\n" . raw_line($count, 0);
1710 my ($linenr, $cnt, $here) = @_;
1712 my $herectx = $here . "\n";
1713 for (my $n = 0; $n < $cnt; $n++) {
1714 $herectx .= raw_line($linenr, $n) . "\n";
1725 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1728 $coded = sprintf("^%c", unpack('C', $2) + 64);
1737 my $av_preprocessor = 0;
1742 sub annotate_reset {
1743 $av_preprocessor = 0;
1745 @av_paren_type = ('E');
1746 $av_pend_colon = 'O';
1749 sub annotate_values {
1750 my ($stream, $type) = @_;
1753 my $var = '_' x length($stream);
1756 print "$stream\n" if ($dbg_values > 1);
1758 while (length($cur)) {
1759 @av_paren_type = ('E') if ($#av_paren_type < 0);
1760 print " <" . join('', @av_paren_type) .
1761 "> <$type> <$av_pending>" if ($dbg_values > 1);
1762 if ($cur =~ /^(\s+)/o) {
1763 print "WS($1)\n" if ($dbg_values > 1);
1764 if ($1 =~ /\n/ && $av_preprocessor) {
1765 $type = pop(@av_paren_type);
1766 $av_preprocessor = 0;
1769 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1770 print "CAST($1)\n" if ($dbg_values > 1);
1771 push(@av_paren_type, $type);
1774 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1775 print "DECLARE($1)\n" if ($dbg_values > 1);
1778 } elsif ($cur =~ /^($Modifier)\s*/) {
1779 print "MODIFIER($1)\n" if ($dbg_values > 1);
1782 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1783 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1784 $av_preprocessor = 1;
1785 push(@av_paren_type, $type);
1791 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1792 print "UNDEF($1)\n" if ($dbg_values > 1);
1793 $av_preprocessor = 1;
1794 push(@av_paren_type, $type);
1796 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1797 print "PRE_START($1)\n" if ($dbg_values > 1);
1798 $av_preprocessor = 1;
1800 push(@av_paren_type, $type);
1801 push(@av_paren_type, $type);
1804 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1805 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1806 $av_preprocessor = 1;
1808 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1812 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1813 print "PRE_END($1)\n" if ($dbg_values > 1);
1815 $av_preprocessor = 1;
1817 # Assume all arms of the conditional end as this
1818 # one does, and continue as if the #endif was not here.
1819 pop(@av_paren_type);
1820 push(@av_paren_type, $type);
1823 } elsif ($cur =~ /^(\\\n)/o) {
1824 print "PRECONT($1)\n" if ($dbg_values > 1);
1826 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1827 print "ATTR($1)\n" if ($dbg_values > 1);
1828 $av_pending = $type;
1831 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1832 print "SIZEOF($1)\n" if ($dbg_values > 1);
1838 } elsif ($cur =~ /^(if|while|for)\b/o) {
1839 print "COND($1)\n" if ($dbg_values > 1);
1843 } elsif ($cur =~/^(case)/o) {
1844 print "CASE($1)\n" if ($dbg_values > 1);
1845 $av_pend_colon = 'C';
1848 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1849 print "KEYWORD($1)\n" if ($dbg_values > 1);
1852 } elsif ($cur =~ /^(\()/o) {
1853 print "PAREN('$1')\n" if ($dbg_values > 1);
1854 push(@av_paren_type, $av_pending);
1858 } elsif ($cur =~ /^(\))/o) {
1859 my $new_type = pop(@av_paren_type);
1860 if ($new_type ne '_') {
1862 print "PAREN('$1') -> $type\n"
1863 if ($dbg_values > 1);
1865 print "PAREN('$1')\n" if ($dbg_values > 1);
1868 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1869 print "FUNC($1)\n" if ($dbg_values > 1);
1873 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1874 if (defined $2 && $type eq 'C' || $type eq 'T') {
1875 $av_pend_colon = 'B';
1876 } elsif ($type eq 'E') {
1877 $av_pend_colon = 'L';
1879 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1882 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1883 print "IDENT($1)\n" if ($dbg_values > 1);
1886 } elsif ($cur =~ /^($Assignment)/o) {
1887 print "ASSIGN($1)\n" if ($dbg_values > 1);
1890 } elsif ($cur =~/^(;|{|})/) {
1891 print "END($1)\n" if ($dbg_values > 1);
1893 $av_pend_colon = 'O';
1895 } elsif ($cur =~/^(,)/) {
1896 print "COMMA($1)\n" if ($dbg_values > 1);
1899 } elsif ($cur =~ /^(\?)/o) {
1900 print "QUESTION($1)\n" if ($dbg_values > 1);
1903 } elsif ($cur =~ /^(:)/o) {
1904 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1906 substr($var, length($res), 1, $av_pend_colon);
1907 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1912 $av_pend_colon = 'O';
1914 } elsif ($cur =~ /^(\[)/o) {
1915 print "CLOSE($1)\n" if ($dbg_values > 1);
1918 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1921 print "OPV($1)\n" if ($dbg_values > 1);
1928 substr($var, length($res), 1, $variant);
1931 } elsif ($cur =~ /^($Operators)/o) {
1932 print "OP($1)\n" if ($dbg_values > 1);
1933 if ($1 ne '++' && $1 ne '--') {
1937 } elsif ($cur =~ /(^.)/o) {
1938 print "C($1)\n" if ($dbg_values > 1);
1941 $cur = substr($cur, length($1));
1942 $res .= $type x length($1);
1946 return ($res, $var);
1950 my ($possible, $line) = @_;
1951 my $notPermitted = qr{(?:
1968 ^(?:typedef|struct|enum)\b
1970 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1971 if ($possible !~ $notPermitted) {
1972 # Check for modifiers.
1973 $possible =~ s/\s*$Storage\s*//g;
1974 $possible =~ s/\s*$Sparse\s*//g;
1975 if ($possible =~ /^\s*$/) {
1977 } elsif ($possible =~ /\s/) {
1978 $possible =~ s/\s*$Type\s*//g;
1979 for my $modifier (split(' ', $possible)) {
1980 if ($modifier !~ $notPermitted) {
1981 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1982 push(@modifierListFile, $modifier);
1987 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1988 push(@typeListFile, $possible);
1992 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
2001 $type =~ tr/[a-z]/[A-Z]/;
2003 return defined $use_type{$type} if (scalar keys %use_type > 0);
2005 return !defined $ignore_type{$type};
2009 my ($level, $type, $msg) = @_;
2011 if (!show_type($type) ||
2012 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
2017 if ($level eq 'ERROR') {
2019 } elsif ($level eq 'WARNING') {
2025 $output .= $prefix . $level . ':';
2027 $output .= BLUE if ($color);
2028 $output .= "$type:";
2030 $output .= RESET if ($color);
2031 $output .= ' ' . $msg . "\n";
2034 my @lines = split("\n", $output, -1);
2035 splice(@lines, 1, 1);
2036 $output = join("\n", @lines);
2038 $output = (split('\n', $output))[0] . "\n" if ($terse);
2040 push(our @report, $output);
2049 sub fixup_current_range {
2050 my ($lineRef, $offset, $length) = @_;
2052 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
2055 my $no = $o + $offset;
2056 my $nl = $l + $length;
2057 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
2061 sub fix_inserted_deleted_lines {
2062 my ($linesRef, $insertedRef, $deletedRef) = @_;
2064 my $range_last_linenr = 0;
2065 my $delta_offset = 0;
2070 my $next_insert = 0;
2071 my $next_delete = 0;
2075 my $inserted = @{$insertedRef}[$next_insert++];
2076 my $deleted = @{$deletedRef}[$next_delete++];
2078 foreach my $old_line (@{$linesRef}) {
2080 my $line = $old_line; #don't modify the array
2081 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
2083 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
2084 $range_last_linenr = $new_linenr;
2085 fixup_current_range(\$line, $delta_offset, 0);
2088 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
2089 $deleted = @{$deletedRef}[$next_delete++];
2091 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
2094 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
2095 push(@lines, ${$inserted}{'LINE'});
2096 $inserted = @{$insertedRef}[$next_insert++];
2098 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
2102 push(@lines, $line);
2112 sub fix_insert_line {
2113 my ($linenr, $line) = @_;
2119 push(@fixed_inserted, $inserted);
2122 sub fix_delete_line {
2123 my ($linenr, $line) = @_;
2130 push(@fixed_deleted, $deleted);
2134 my ($type, $msg) = @_;
2136 if (report("ERROR", $type, $msg)) {
2144 my ($type, $msg) = @_;
2146 if (report("WARNING", $type, $msg)) {
2154 my ($type, $msg) = @_;
2156 if ($check && report("CHECK", $type, $msg)) {
2164 sub check_absolute_file {
2165 my ($absolute, $herecurr) = @_;
2166 my $file = $absolute;
2168 ##print "absolute<$absolute>\n";
2170 # See if any suffix of this path is a path within the tree.
2171 while ($file =~ s@^[^/]*/@@) {
2172 if (-f "$root/$file") {
2173 ##print "file<$file>\n";
2181 # It is, so see if the prefix is acceptable.
2182 my $prefix = $absolute;
2183 substr($prefix, -length($file)) = '';
2185 ##print "prefix<$prefix>\n";
2186 if ($prefix ne ".../") {
2187 WARN("USE_RELATIVE_PATH",
2188 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
2195 $string =~ s/^\s+|\s+$//g;
2203 $string =~ s/^\s+//;
2211 $string =~ s/\s+$//;
2216 sub string_find_replace {
2217 my ($string, $find, $replace) = @_;
2219 $string =~ s/$find/$replace/g;
2227 my $source_indent = 8;
2228 my $max_spaces_before_tab = $source_indent - 1;
2229 my $spaces_to_tab = " " x $source_indent;
2231 #convert leading spaces to tabs
2232 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2233 #Remove spaces before a tab
2234 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2239 sub pos_last_openparen {
2244 my $opens = $line =~ tr/\(/\(/;
2245 my $closes = $line =~ tr/\)/\)/;
2247 my $last_openparen = 0;
2249 if (($opens == 0) || ($closes >= $opens)) {
2253 my $len = length($line);
2255 for ($pos = 0; $pos < $len; $pos++) {
2256 my $string = substr($line, $pos);
2257 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2258 $pos += length($1) - 1;
2259 } elsif (substr($line, $pos, 1) eq '(') {
2260 $last_openparen = $pos;
2261 } elsif (index($string, '(') == -1) {
2266 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
2270 my $filename = shift;
2276 my $stashrawline="";
2286 my $authorsignoff = 0;
2288 my $is_binding_patch = -1;
2289 my $in_header_lines = $file ? 0 : 1;
2290 my $in_commit_log = 0; #Scanning lines before patch
2291 my $has_commit_log = 0; #Encountered lines before patch
2292 my $commit_log_lines = 0; #Number of commit log lines
2293 my $commit_log_possible_stack_dump = 0;
2294 my $commit_log_long_line = 0;
2295 my $commit_log_has_diff = 0;
2296 my $reported_maintainer_file = 0;
2297 my $non_utf8_charset = 0;
2299 my $last_blank_line = 0;
2300 my $last_coalesced_string_linenr = -1;
2308 # Trace the real file/line as we go.
2313 my $context_function; #undef'd unless there's a known function
2315 my $comment_edge = 0;
2319 my $prev_values = 'E';
2322 my %suppress_ifbraces;
2323 my %suppress_whiletrailers;
2324 my %suppress_export;
2325 my $suppress_statement = 0;
2327 my %signatures = ();
2329 # Pre-scan the patch sanitizing the lines.
2330 # Pre-scan the patch looking for any __setup documentation.
2332 my @setup_docs = ();
2335 my $camelcase_file_seeded = 0;
2337 my $checklicenseline = 1;
2339 sanitise_line_reset();
2341 foreach my $rawline (@rawlines) {
2345 push(@fixed, $rawline) if ($fix);
2347 if ($rawline=~/^\+\+\+\s+(\S+)/) {
2349 if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) {
2354 if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2363 # Guestimate if this is a continuing comment. Run
2364 # the context looking for a comment "edge". If this
2365 # edge is a close comment then we must be in a comment
2369 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2370 next if (defined $rawlines[$ln - 1] &&
2371 $rawlines[$ln - 1] =~ /^-/);
2373 #print "RAW<$rawlines[$ln - 1]>\n";
2374 last if (!defined $rawlines[$ln - 1]);
2375 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2376 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2381 if (defined $edge && $edge eq '*/') {
2385 # Guestimate if this is a continuing comment. If this
2386 # is the start of a diff block and this line starts
2387 # ' *' then it is very likely a comment.
2388 if (!defined $edge &&
2389 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
2394 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2395 sanitise_line_reset($in_comment);
2397 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
2398 # Standardise the strings and chars within the input to
2399 # simplify matching -- only bother with positive lines.
2400 $line = sanitise_line($rawline);
2402 push(@lines, $line);
2405 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2410 #print "==>$rawline\n";
2411 #print "-->$line\n";
2413 if ($setup_docs && $line =~ /^\+/) {
2414 push(@setup_docs, $line);
2423 foreach my $line (@lines) {
2426 my $sline = $line; #copy of $line
2427 $sline =~ s/$;/ /g; #with comments as spaces
2429 my $rawline = $rawlines[$linenr - 1];
2431 # check if it's a mode change, rename or start of a patch
2432 if (!$in_commit_log &&
2433 ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ ||
2434 ($line =~ /^rename (?:from|to) \S+\s*$/ ||
2435 $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) {
2439 #extract the line range in the file after the patch is applied
2440 if (!$in_commit_log &&
2441 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2444 $first_line = $linenr + 1;
2454 %suppress_ifbraces = ();
2455 %suppress_whiletrailers = ();
2456 %suppress_export = ();
2457 $suppress_statement = 0;
2458 if ($context =~ /\b(\w+)\s*\(/) {
2459 $context_function = $1;
2461 undef $context_function;
2465 # track the line number as we move through the hunk, note that
2466 # new versions of GNU diff omit the leading space on completely
2467 # blank context lines so we need to count that too.
2468 } elsif ($line =~ /^( |\+|$)/) {
2470 $realcnt-- if ($realcnt != 0);
2472 # Measure the line length and indent.
2473 ($length, $indent) = line_stats($rawline);
2475 # Track the previous line.
2476 ($prevline, $stashline) = ($stashline, $line);
2477 ($previndent, $stashindent) = ($stashindent, $indent);
2478 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2480 #warn "line<$line>\n";
2482 } elsif ($realcnt == 1) {
2486 my $hunk_line = ($realcnt != 0);
2488 $here = "#$linenr: " if (!$file);
2489 $here = "#$realline: " if ($file);
2492 # extract the filename as it passes
2493 if ($line =~ /^diff --git.*?(\S+)$/) {
2495 $realfile =~ s@^([^/]*)/@@ if (!$file);
2498 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2500 $realfile =~ s@^([^/]*)/@@ if (!$file);
2504 if (!$file && $tree && $p1_prefix ne '' &&
2505 -e "$root/$p1_prefix") {
2506 WARN("PATCH_PREFIX",
2507 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
2510 if ($realfile =~ m@^include/asm/@) {
2511 ERROR("MODIFIED_INCLUDE_ASM",
2512 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2517 #make up the handle for any error we report on this line
2519 $prefix = "$realfile:$realline: "
2522 $prefix = "$filename:$realline: ";
2524 $prefix = "$filename:$linenr: ";
2529 if (is_maintained_obsolete($realfile)) {
2531 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2533 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
2536 $check = $check_orig;
2538 $checklicenseline = 1;
2540 if ($realfile !~ /^MAINTAINERS/) {
2541 my $last_binding_patch = $is_binding_patch;
2543 $is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@;
2545 if (($last_binding_patch != -1) &&
2546 ($last_binding_patch ^ $is_binding_patch)) {
2547 WARN("DT_SPLIT_BINDING_PATCH",
2548 "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.txt\n");
2555 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
2557 my $hereline = "$here\n$rawline\n";
2558 my $herecurr = "$here\n$rawline\n";
2559 my $hereprev = "$here\n$prevrawline\n$rawline\n";
2561 $cnt_lines++ if ($realcnt != 0);
2563 # Verify the existence of a commit log if appropriate
2564 # 2 is used because a $signature is counted in $commit_log_lines
2565 if ($in_commit_log) {
2566 if ($line !~ /^\s*$/) {
2567 $commit_log_lines++; #could be a $signature
2569 } elsif ($has_commit_log && $commit_log_lines < 2) {
2570 WARN("COMMIT_MESSAGE",
2571 "Missing commit description - Add an appropriate one\n");
2572 $commit_log_lines = 2; #warn only once
2575 # Check if the commit log has what seems like a diff which can confuse patch
2576 if ($in_commit_log && !$commit_log_has_diff &&
2577 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2578 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2579 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2580 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2581 ERROR("DIFF_IN_COMMIT_MSG",
2582 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2583 $commit_log_has_diff = 1;
2586 # Check for incorrect file permissions
2587 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2588 my $permhere = $here . "FILE: $realfile\n";
2589 if ($realfile !~ m@scripts/@ &&
2590 $realfile !~ /\.(py|pl|awk|sh)$/) {
2591 ERROR("EXECUTE_PERMISSIONS",
2592 "do not set execute permissions for source files\n" . $permhere);
2596 # Check the patch for a From:
2597 if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) {
2599 $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i);
2603 # Check the patch for a signoff:
2604 if ($line =~ /^\s*signed-off-by:/i) {
2607 if ($author ne '') {
2610 if ($l =~ /^\s*signed-off-by:\s*\Q$author\E/i) {
2616 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2617 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2618 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2619 $reported_maintainer_file = 1;
2622 # Check signature styles
2623 if (!$in_header_lines &&
2624 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
2625 my $space_before = $1;
2627 my $space_after = $3;
2629 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2631 if ($sign_off !~ /$signature_tags/) {
2632 WARN("BAD_SIGN_OFF",
2633 "Non-standard signature: $sign_off\n" . $herecurr);
2635 if (defined $space_before && $space_before ne "") {
2636 if (WARN("BAD_SIGN_OFF",
2637 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2639 $fixed[$fixlinenr] =
2640 "$ucfirst_sign_off $email";
2643 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
2644 if (WARN("BAD_SIGN_OFF",
2645 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2647 $fixed[$fixlinenr] =
2648 "$ucfirst_sign_off $email";
2652 if (!defined $space_after || $space_after ne " ") {
2653 if (WARN("BAD_SIGN_OFF",
2654 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2656 $fixed[$fixlinenr] =
2657 "$ucfirst_sign_off $email";
2661 my ($email_name, $email_address, $comment) = parse_email($email);
2662 my $suggested_email = format_email(($email_name, $email_address));
2663 if ($suggested_email eq "") {
2664 ERROR("BAD_SIGN_OFF",
2665 "Unrecognized email address: '$email'\n" . $herecurr);
2667 my $dequoted = $suggested_email;
2668 $dequoted =~ s/^"//;
2669 $dequoted =~ s/" </ </;
2670 # Don't force email to have quotes
2671 # Allow just an angle bracketed address
2672 if ("$dequoted$comment" ne $email &&
2673 "<$email_address>$comment" ne $email &&
2674 "$suggested_email$comment" ne $email) {
2675 WARN("BAD_SIGN_OFF",
2676 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
2680 # Check for duplicate signatures
2681 my $sig_nospace = $line;
2682 $sig_nospace =~ s/\s//g;
2683 $sig_nospace = lc($sig_nospace);
2684 if (defined $signatures{$sig_nospace}) {
2685 WARN("BAD_SIGN_OFF",
2686 "Duplicate signature\n" . $herecurr);
2688 $signatures{$sig_nospace} = 1;
2691 # Check Co-developed-by: immediately followed by Signed-off-by: with same name and email
2692 if ($sign_off =~ /^co-developed-by:$/i) {
2693 if ($email eq $author) {
2694 WARN("BAD_SIGN_OFF",
2695 "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline);
2697 if (!defined $lines[$linenr]) {
2698 WARN("BAD_SIGN_OFF",
2699 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline);
2700 } elsif ($rawlines[$linenr] !~ /^\s*signed-off-by:\s*(.*)/i) {
2701 WARN("BAD_SIGN_OFF",
2702 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2703 } elsif ($1 ne $email) {
2704 WARN("BAD_SIGN_OFF",
2705 "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2710 # Check email subject for common tools that don't need to be mentioned
2711 if ($in_header_lines &&
2712 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2713 WARN("EMAIL_SUBJECT",
2714 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2717 # Check for unwanted Gerrit info
2718 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2719 ERROR("GERRIT_CHANGE_ID",
2720 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2723 # Check if the commit log is in a possible stack dump
2724 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2725 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2726 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2728 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/) ||
2729 $line =~ /^(?:\s+\w+:\s+[0-9a-fA-F]+){3,3}/ ||
2730 $line =~ /^\s*\#\d+\s*\[[0-9a-fA-F]+\]\s*\w+ at [0-9a-fA-F]+/) {
2731 # stack dump address styles
2732 $commit_log_possible_stack_dump = 1;
2735 # Check for line lengths > 75 in commit log, warn once
2736 if ($in_commit_log && !$commit_log_long_line &&
2737 length($line) > 75 &&
2738 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2739 # file delta changes
2740 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2742 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2743 # A Fixes: or Link: line
2744 $commit_log_possible_stack_dump)) {
2745 WARN("COMMIT_LOG_LONG_LINE",
2746 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2747 $commit_log_long_line = 1;
2750 # Reset possible stack dump if a blank line is found
2751 if ($in_commit_log && $commit_log_possible_stack_dump &&
2753 $commit_log_possible_stack_dump = 0;
2756 # Check for git id commit length and improperly formed commit descriptions
2757 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2758 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
2759 $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
2760 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
2761 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
2762 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2763 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
2764 my $init_char = "c";
2765 my $orig_commit = "";
2772 my $id = '0123456789ab';
2773 my $orig_desc = "commit description";
2774 my $description = "";
2776 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2778 $orig_commit = lc($2);
2779 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2780 $orig_commit = lc($1);
2783 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2784 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2785 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2786 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2787 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2790 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2791 defined $rawlines[$linenr] &&
2792 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2795 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2796 defined $rawlines[$linenr] &&
2797 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2798 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2800 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2801 $orig_desc .= " " . $1;
2805 ($id, $description) = git_commit_info($orig_commit,
2809 ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
2810 ERROR("GIT_COMMIT_ID",
2811 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2815 # Check for added, moved or deleted files
2816 if (!$reported_maintainer_file && !$in_commit_log &&
2817 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2818 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2819 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2820 (defined($1) || defined($2))))) {
2822 $reported_maintainer_file = 1;
2823 WARN("FILE_PATH_CHANGES",
2824 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2827 # Check for wrappage within a valid hunk of the file
2828 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
2829 ERROR("CORRUPTED_PATCH",
2830 "patch seems to be corrupt (line wrapped?)\n" .
2831 $herecurr) if (!$emitted_corrupt++);
2834 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2835 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
2836 $rawline !~ m/^$UTF8*$/) {
2837 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2839 my $blank = copy_spacing($rawline);
2840 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2841 my $hereptr = "$hereline$ptr\n";
2844 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
2847 # Check if it's the start of a commit log
2848 # (not a header line and we haven't seen the patch filename)
2849 if ($in_header_lines && $realfile =~ /^$/ &&
2850 !($rawline =~ /^\s+(?:\S|$)/ ||
2851 $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
2852 $in_header_lines = 0;
2854 $has_commit_log = 1;
2857 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2858 # declined it, i.e defined some charset where it is missing.
2859 if ($in_header_lines &&
2860 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2862 $non_utf8_charset = 1;
2865 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
2866 $rawline =~ /$NON_ASCII_UTF8/) {
2867 WARN("UTF8_BEFORE_PATCH",
2868 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2871 # Check for absolute kernel paths in commit message
2872 if ($tree && $in_commit_log) {
2873 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2876 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2877 check_absolute_file($1, $herecurr)) {
2880 check_absolute_file($file, $herecurr);
2885 # Check for various typo / spelling mistakes
2886 if (defined($misspellings) &&
2887 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
2888 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
2890 my $typo_fix = $spelling_fix{lc($typo)};
2891 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2892 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2893 my $msg_level = \&WARN;
2894 $msg_level = \&CHK if ($file);
2895 if (&{$msg_level}("TYPO_SPELLING",
2896 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2898 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2903 # check for invalid commit id
2904 if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) {
2907 ($id, $description) = git_commit_info($2, undef, undef);
2908 if (!defined($id)) {
2909 WARN("UNKNOWN_COMMIT_ID",
2910 "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr);
2914 # ignore non-hunk lines and lines being removed
2915 next if (!$hunk_line || $line =~ /^-/);
2917 #trailing whitespace
2918 if ($line =~ /^\+.*\015/) {
2919 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2920 if (ERROR("DOS_LINE_ENDINGS",
2921 "DOS line endings\n" . $herevet) &&
2923 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
2925 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2926 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2927 if (ERROR("TRAILING_WHITESPACE",
2928 "trailing whitespace\n" . $herevet) &&
2930 $fixed[$fixlinenr] =~ s/\s+$//;
2936 # Check for FSF mailing addresses.
2937 if ($rawline =~ /\bwrite to the Free/i ||
2938 $rawline =~ /\b675\s+Mass\s+Ave/i ||
2939 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2940 $rawline =~ /\b51\s+Franklin\s+St/i) {
2941 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2942 my $msg_level = \&ERROR;
2943 $msg_level = \&CHK if ($file);
2944 &{$msg_level}("FSF_MAILING_ADDRESS",
2945 "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)
2948 # check for Kconfig help text having a real description
2949 # Only applies when adding the entry originally, after that we do not have
2950 # sufficient context to determine whether it is indeed long enough.
2951 if ($realfile =~ /Kconfig/ &&
2952 # 'choice' is usually the last thing on the line (though
2953 # Kconfig supports named choices), so use a word boundary
2954 # (\b) rather than a whitespace character (\s)
2955 $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) {
2958 my $ln = $linenr + 1;
2962 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
2963 $f = $lines[$ln - 1];
2964 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2965 $is_end = $lines[$ln - 1] =~ /^\+/;
2967 next if ($f =~ /^-/);
2968 last if (!$file && $f =~ /^\@\@/);
2970 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
2972 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) {
2973 if ($lines[$ln - 1] =~ "---help---") {
2974 WARN("CONFIG_DESCRIPTION",
2975 "prefer 'help' over '---help---' for new help texts\n" . $herecurr);
2983 next if ($f =~ /^$/);
2985 # This only checks context lines in the patch
2986 # and so hopefully shouldn't trigger false
2987 # positives, even though some of these are
2988 # common words in help texts
2989 if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice|
2990 if|endif|menu|endmenu|source)\b/x) {
2996 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2997 WARN("CONFIG_DESCRIPTION",
2998 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
3000 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
3003 # check for MAINTAINERS entries that don't have the right form
3004 if ($realfile =~ /^MAINTAINERS$/ &&
3005 $rawline =~ /^\+[A-Z]:/ &&
3006 $rawline !~ /^\+[A-Z]:\t\S/) {
3007 if (WARN("MAINTAINERS_STYLE",
3008 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
3010 $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
3014 # discourage the use of boolean for type definition attributes of Kconfig options
3015 if ($realfile =~ /Kconfig/ &&
3016 $line =~ /^\+\s*\bboolean\b/) {
3017 WARN("CONFIG_TYPE_BOOLEAN",
3018 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
3021 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
3022 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
3025 'EXTRA_AFLAGS' => 'asflags-y',
3026 'EXTRA_CFLAGS' => 'ccflags-y',
3027 'EXTRA_CPPFLAGS' => 'cppflags-y',
3028 'EXTRA_LDFLAGS' => 'ldflags-y',
3031 WARN("DEPRECATED_VARIABLE",
3032 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
3035 # check for DT compatible documentation
3036 if (defined $root &&
3037 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
3038 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
3040 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
3042 my $dt_path = $root . "/Documentation/devicetree/bindings/";
3043 my $vp_file = $dt_path . "vendor-prefixes.yaml";
3045 foreach my $compat (@compats) {
3046 my $compat2 = $compat;
3047 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
3048 my $compat3 = $compat;
3049 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
3050 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
3052 WARN("UNDOCUMENTED_DT_STRING",
3053 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
3056 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
3058 `grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`;
3060 WARN("UNDOCUMENTED_DT_STRING",
3061 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
3066 # check for using SPDX license tag at beginning of files
3067 if ($realline == $checklicenseline) {
3068 if ($rawline =~ /^[ \+]\s*\#\!\s*\//) {
3069 $checklicenseline = 2;
3070 } elsif ($rawline =~ /^\+/) {
3072 if ($realfile =~ /\.(h|s|S)$/) {
3074 } elsif ($realfile =~ /\.(c|dts|dtsi)$/) {
3076 } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc)$/) {
3078 } elsif ($realfile =~ /\.rst$/) {
3082 # check SPDX comment style for .[chsS] files
3083 if ($realfile =~ /\.[chsS]$/ &&
3084 $rawline =~ /SPDX-License-Identifier:/ &&
3085 $rawline !~ m@^\+\s*\Q$comment\E\s*@) {
3086 WARN("SPDX_LICENSE_TAG",
3087 "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr);
3090 if ($comment !~ /^$/ &&
3091 $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) {
3092 WARN("SPDX_LICENSE_TAG",
3093 "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr);
3094 } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) {
3095 my $spdx_license = $1;
3096 if (!is_SPDX_License_valid($spdx_license)) {
3097 WARN("SPDX_LICENSE_TAG",
3098 "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr);
3104 # check we are in a valid source file if not then ignore this hunk
3105 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
3107 # check for using SPDX-License-Identifier on the wrong line number
3108 if ($realline != $checklicenseline &&
3109 $rawline =~ /\bSPDX-License-Identifier:/ &&
3110 substr($line, @-, @+ - @-) eq "$;" x (@+ - @-)) {
3111 WARN("SPDX_LICENSE_TAG",
3112 "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr);
3115 # line length limit (with some exclusions)
3117 # There are a few types of lines that may extend beyond $max_line_length:
3118 # logging functions like pr_info that end in a string
3119 # lines with a single string
3120 # #defines that are a single string
3121 # lines with an RFC3986 like URL
3123 # There are 3 different line length message types:
3124 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
3125 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
3126 # LONG_LINE all other lines longer than $max_line_length
3128 # if LONG_LINE is ignored, the other 2 types are also ignored
3131 if ($line =~ /^\+/ && $length > $max_line_length) {
3132 my $msg_type = "LONG_LINE";
3134 # Check the allowed long line types first
3136 # logging functions that end in a string that starts
3137 # before $max_line_length
3138 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3139 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3142 # lines with only strings (w/ possible termination)
3143 # #defines with only strings
3144 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
3145 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
3148 # More special cases
3149 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
3150 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
3153 # URL ($rawline is used in case the URL is in a comment)
3154 } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) {
3157 # Otherwise set the alternate message types
3159 # a comment starts before $max_line_length
3160 } elsif ($line =~ /($;[\s$;]*)$/ &&
3161 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3162 $msg_type = "LONG_LINE_COMMENT"
3164 # a quoted string starts before $max_line_length
3165 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
3166 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3167 $msg_type = "LONG_LINE_STRING"
3170 if ($msg_type ne "" &&
3171 (show_type("LONG_LINE") || show_type($msg_type))) {
3173 "line over $max_line_length characters\n" . $herecurr);
3177 # check for adding lines without a newline.
3178 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
3179 WARN("MISSING_EOF_NEWLINE",
3180 "adding a line without newline at end of file\n" . $herecurr);
3183 # check we are in a valid source file C or perl if not then ignore this hunk
3184 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
3186 # at the beginning of a line any tabs must come first and anything
3187 # more than 8 must use tabs.
3188 if ($rawline =~ /^\+\s* \t\s*\S/ ||
3189 $rawline =~ /^\+\s* \s*/) {
3190 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3192 if (ERROR("CODE_INDENT",
3193 "code indent should use tabs where possible\n" . $herevet) &&
3195 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3199 # check for space before tabs.
3200 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
3201 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3202 if (WARN("SPACE_BEFORE_TAB",
3203 "please, no space before tabs\n" . $herevet) &&
3205 while ($fixed[$fixlinenr] =~
3206 s/(^\+.*) {8,8}\t/$1\t\t/) {}
3207 while ($fixed[$fixlinenr] =~
3208 s/(^\+.*) +\t/$1\t/) {}
3212 # check for assignments on the start of a line
3213 if ($sline =~ /^\+\s+($Assignment)[^=]/) {
3214 CHK("ASSIGNMENT_CONTINUATIONS",
3215 "Assignment operator '$1' should be on the previous line\n" . $hereprev);
3218 # check for && or || at the start of a line
3219 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
3220 CHK("LOGICAL_CONTINUATIONS",
3221 "Logical continuations should be on the previous line\n" . $hereprev);
3224 # check indentation starts on a tab stop
3225 if ($perl_version_ok &&
3226 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
3227 my $indent = length($1);
3230 "Statements should start on a tabstop\n" . $herecurr) &&
3232 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
3237 # check multi-line statement indentation matches previous line
3238 if ($perl_version_ok &&
3239 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
3240 $prevline =~ /^\+(\t*)(.*)$/;
3244 my $pos = pos_last_openparen($rest);
3246 $line =~ /^(\+| )([ \t]*)/;
3249 my $goodtabindent = $oldindent .
3252 my $goodspaceindent = $oldindent . " " x $pos;
3254 if ($newindent ne $goodtabindent &&
3255 $newindent ne $goodspaceindent) {
3257 if (CHK("PARENTHESIS_ALIGNMENT",
3258 "Alignment should match open parenthesis\n" . $hereprev) &&
3259 $fix && $line =~ /^\+/) {
3260 $fixed[$fixlinenr] =~
3261 s/^\+[ \t]*/\+$goodtabindent/;
3267 # check for space after cast like "(int) foo" or "(struct foo) bar"
3268 # avoid checking a few false positives:
3269 # "sizeof(<type>)" or "__alignof__(<type>)"
3270 # function pointer declarations like "(*foo)(int) = bar;"
3271 # structure definitions like "(struct foo) { 0 };"
3272 # multiline macros that define functions
3273 # known attributes or the __attribute__ keyword
3274 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
3275 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
3277 "No space is necessary after a cast\n" . $herecurr) &&
3279 $fixed[$fixlinenr] =~
3280 s/(\(\s*$Type\s*\))[ \t]+/$1/;
3284 # Block comment styles
3285 # Networking with an initial /*
3286 if ($realfile =~ m@^(drivers/net/|net/)@ &&
3287 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
3288 $rawline =~ /^\+[ \t]*\*/ &&
3290 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
3291 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3294 # Block comments use * on subsequent lines
3295 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3296 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
3297 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
3298 $rawline =~ /^\+/ && #line is new
3299 $rawline !~ /^\+[ \t]*\*/) { #no leading *
3300 WARN("BLOCK_COMMENT_STYLE",
3301 "Block comments use * on subsequent lines\n" . $hereprev);
3304 # Block comments use */ on trailing lines
3305 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
3306 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3307 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3308 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
3309 WARN("BLOCK_COMMENT_STYLE",
3310 "Block comments use a trailing */ on a separate line\n" . $herecurr);
3313 # Block comment * alignment
3314 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3315 $line =~ /^\+[ \t]*$;/ && #leading comment
3316 $rawline =~ /^\+[ \t]*\*/ && #leading *
3317 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
3318 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
3319 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3321 $prevrawline =~ m@^\+([ \t]*/?)\*@;
3323 $oldindent = expand_tabs($1);
3325 $prevrawline =~ m@^\+(.*/?)\*@;
3326 $oldindent = expand_tabs($1);
3328 $rawline =~ m@^\+([ \t]*)\*@;
3330 $newindent = expand_tabs($newindent);
3331 if (length($oldindent) ne length($newindent)) {
3332 WARN("BLOCK_COMMENT_STYLE",
3333 "Block comments should align the * on each line\n" . $hereprev);
3337 # check for missing blank lines after struct/union declarations
3338 # with exceptions for various attributes and macros
3339 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3341 !($line =~ /^\+\s*$/ ||
3342 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3343 $line =~ /^\+\s*MODULE_/i ||
3344 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3345 $line =~ /^\+[a-z_]*init/ ||
3346 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3347 $line =~ /^\+\s*DECLARE/ ||
3348 $line =~ /^\+\s*builtin_[\w_]*driver/ ||
3349 $line =~ /^\+\s*__setup/)) {
3350 if (CHK("LINE_SPACING",
3351 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3353 fix_insert_line($fixlinenr, "\+");
3357 # check for multiple consecutive blank lines
3358 if ($prevline =~ /^[\+ ]\s*$/ &&
3359 $line =~ /^\+\s*$/ &&
3360 $last_blank_line != ($linenr - 1)) {
3361 if (CHK("LINE_SPACING",
3362 "Please don't use multiple blank lines\n" . $hereprev) &&
3364 fix_delete_line($fixlinenr, $rawline);
3367 $last_blank_line = $linenr;
3370 # check for missing blank lines after declarations
3371 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3372 # actual declarations
3373 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
3374 # function pointer declarations
3375 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3376 # foo bar; where foo is some local typedef or #define
3377 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3378 # known declaration macros
3379 $prevline =~ /^\+\s+$declaration_macros/) &&
3380 # for "else if" which can look like "$Ident $Ident"
3381 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3382 # other possible extensions of declaration lines
3383 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3384 # not starting a section or a macro "\" extended line
3385 $prevline =~ /(?:\{\s*|\\)$/) &&
3386 # looks like a declaration
3387 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
3388 # function pointer declarations
3389 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3390 # foo bar; where foo is some local typedef or #define
3391 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3392 # known declaration macros
3393 $sline =~ /^\+\s+$declaration_macros/ ||
3394 # start of struct or union or enum
3395 $sline =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ ||
3396 # start or end of block or continuation of declaration
3397 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3398 # bitfield continuation
3399 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3400 # other possible extensions of declaration lines
3401 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3402 # indentation of previous and current line are the same
3403 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
3404 if (WARN("LINE_SPACING",
3405 "Missing a blank line after declarations\n" . $hereprev) &&
3407 fix_insert_line($fixlinenr, "\+");
3411 # check for spaces at the beginning of a line.
3413 # 1) within comments
3414 # 2) indented preprocessor commands
3416 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
3417 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3418 if (WARN("LEADING_SPACE",
3419 "please, no spaces at the start of a line\n" . $herevet) &&
3421 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3425 # check we are in a valid C source file if not then ignore this hunk
3426 next if ($realfile !~ /\.(h|c)$/);
3428 # check for unusual line ending [ or (
3429 if ($line =~ /^\+.*([\[\(])\s*$/) {
3430 CHK("OPEN_ENDED_LINE",
3431 "Lines should not end with a '$1'\n" . $herecurr);
3434 # check if this appears to be the start function declaration, save the name
3435 if ($sline =~ /^\+\{\s*$/ &&
3436 $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
3437 $context_function = $1;
3440 # check if this appears to be the end of function declaration
3441 if ($sline =~ /^\+\}\s*$/) {
3442 undef $context_function;
3445 # check indentation of any line with a bare else
3446 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
3447 # if the previous line is a break or return and is indented 1 tab more...
3448 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3449 my $tabs = length($1) + 1;
3450 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3451 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3452 defined $lines[$linenr] &&
3453 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
3454 WARN("UNNECESSARY_ELSE",
3455 "else is not generally useful after a break or return\n" . $hereprev);
3459 # check indentation of a line with a break;
3460 # if the previous line is a goto or return and is indented the same # of tabs
3461 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3463 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3464 WARN("UNNECESSARY_BREAK",
3465 "break is not useful after a goto or return\n" . $hereprev);
3469 # check for RCS/CVS revision markers
3470 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
3472 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
3475 # check for old HOTPLUG __dev<foo> section markings
3476 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3477 WARN("HOTPLUG_SECTION",
3478 "Using $1 is unnecessary\n" . $herecurr);
3481 # Check for potential 'bare' types
3482 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3484 #print "LINE<$line>\n";
3485 if ($linenr > $suppress_statement &&
3486 $realcnt && $sline =~ /.\s*\S/) {
3487 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3488 ctx_statement_block($linenr, $realcnt, 0);
3489 $stat =~ s/\n./\n /g;
3490 $cond =~ s/\n./\n /g;
3492 #print "linenr<$linenr> <$stat>\n";
3493 # If this statement has no statement boundaries within
3494 # it there is no point in retrying a statement scan
3495 # until we hit end of it.
3496 my $frag = $stat; $frag =~ s/;+\s*$//;
3497 if ($frag !~ /(?:{|;)/) {
3498 #print "skip<$line_nr_next>\n";
3499 $suppress_statement = $line_nr_next;
3502 # Find the real next line.
3503 $realline_next = $line_nr_next;
3504 if (defined $realline_next &&
3505 (!defined $lines[$realline_next - 1] ||
3506 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3513 # Ignore goto labels.
3514 if ($s =~ /$Ident:\*$/s) {
3516 # Ignore functions being called
3517 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
3519 } elsif ($s =~ /^.\s*else\b/s) {
3521 # declarations always start with types
3522 } 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) {
3525 possible($type, "A:" . $s);
3527 # definitions in global scope can only start with types
3528 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
3529 possible($1, "B:" . $s);
3532 # any (foo ... *) is a pointer cast, and foo is a type
3533 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
3534 possible($1, "C:" . $s);
3537 # Check for any sort of function declaration.
3538 # int foo(something bar, other baz);
3539 # void (*store_gdt)(x86_descr_ptr *);
3540 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3541 my ($name_len) = length($1);
3544 substr($ctx, 0, $name_len + 1, '');
3545 $ctx =~ s/\)[^\)]*$//;
3547 for my $arg (split(/\s*,\s*/, $ctx)) {
3548 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3550 possible($1, "D:" . $s);
3558 # Checks which may be anchored in the context.
3561 # Check for switch () and associated case and default
3562 # statements should be at the same indent.
3563 if ($line=~/\bswitch\s*\(.*\)/) {
3566 my @ctx = ctx_block_outer($linenr, $realcnt);
3568 for my $ctx (@ctx) {
3569 my ($clen, $cindent) = line_stats($ctx);
3570 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3571 $indent != $cindent) {
3572 $err .= "$sep$ctx\n";
3579 ERROR("SWITCH_CASE_INDENT_LEVEL",
3580 "switch and case should be at the same indent\n$hereline$err");
3584 # if/while/etc brace do not go on next line, unless defining a do while loop,
3585 # or if that brace on the next line is for something else
3586 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3587 my $pre_ctx = "$1$2";
3589 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
3591 if ($line =~ /^\+\t{6,}/) {
3592 WARN("DEEP_INDENTATION",
3593 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3596 my $ctx_cnt = $realcnt - $#ctx - 1;
3597 my $ctx = join("\n", @ctx);
3599 my $ctx_ln = $linenr;
3600 my $ctx_skip = $realcnt;
3602 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3603 defined $lines[$ctx_ln - 1] &&
3604 $lines[$ctx_ln - 1] =~ /^-/)) {
3605 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3606 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
3610 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3611 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3613 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
3615 "that open brace { should be on the previous line\n" .
3616 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3618 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3619 $ctx =~ /\)\s*\;\s*$/ &&
3620 defined $lines[$ctx_ln - 1])
3622 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3623 if ($nindent > $indent) {
3624 WARN("TRAILING_SEMICOLON",
3625 "trailing semicolon indicates no statements, indent implies otherwise\n" .
3626 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3631 # Check relative indent for conditionals and blocks.
3632 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3633 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3634 ctx_statement_block($linenr, $realcnt, 0)
3635 if (!defined $stat);
3636 my ($s, $c) = ($stat, $cond);
3638 substr($s, 0, length($c), '');
3640 # remove inline comments
3644 # Find out how long the conditional actually is.
3645 my @newlines = ($c =~ /\n/gs);
3646 my $cond_lines = 1 + $#newlines;
3648 # Make sure we remove the line prefixes as we have
3649 # none on the first line, and are going to readd them
3652 while ($s =~ /\n\s+\\\n/) {
3653 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3656 # We want to check the first line inside the block
3657 # starting at the end of the conditional, so remove:
3658 # 1) any blank line termination
3659 # 2) any opening brace { on end of the line
3661 my $continuation = 0;
3663 $s =~ s/^.*\bdo\b//;
3665 if ($s =~ s/^\s*\\//) {
3668 if ($s =~ s/^\s*?\n//) {
3673 # Also ignore a loop construct at the end of a
3674 # preprocessor statement.
3675 if (($prevline =~ /^.\s*#\s*define\s/ ||
3676 $prevline =~ /\\\s*$/) && $continuation == 0) {
3682 while ($cond_ptr != $cond_lines) {
3683 $cond_ptr = $cond_lines;
3685 # If we see an #else/#elif then the code
3687 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3692 # 1) blank lines, they should be at 0,
3693 # 2) preprocessor lines, and
3695 if ($continuation ||
3697 $s =~ /^\s*#\s*?/ ||
3698 $s =~ /^\s*$Ident\s*:/) {
3699 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
3700 if ($s =~ s/^.*?\n//) {
3706 my (undef, $sindent) = line_stats("+" . $s);
3707 my $stat_real = raw_line($linenr, $cond_lines);
3709 # Check if either of these lines are modified, else
3710 # this is not this patch's fault.
3711 if (!defined($stat_real) ||
3712 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3715 if (defined($stat_real) && $cond_lines > 1) {
3716 $stat_real = "[...]\n$stat_real";
3719 #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";
3721 if ($check && $s ne '' &&
3722 (($sindent % 8) != 0 ||
3723 ($sindent < $indent) ||
3724 ($sindent == $indent &&
3725 ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
3726 ($sindent > $indent + 8))) {
3727 WARN("SUSPECT_CODE_INDENT",
3728 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3732 # Track the 'values' across context and added lines.
3733 my $opline = $line; $opline =~ s/^./ /;
3734 my ($curr_values, $curr_vars) =
3735 annotate_values($opline . "\n", $prev_values);
3736 $curr_values = $prev_values . $curr_values;
3738 my $outline = $opline; $outline =~ s/\t/ /g;
3739 print "$linenr > .$outline\n";
3740 print "$linenr > $curr_values\n";
3741 print "$linenr > $curr_vars\n";
3743 $prev_values = substr($curr_values, -1);
3745 #ignore lines not being added
3746 next if ($line =~ /^[^\+]/);
3748 # check for dereferences that span multiple lines
3749 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
3750 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
3751 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
3753 $line =~ /^.\s*($Lval)/;
3756 WARN("MULTILINE_DEREFERENCE",
3757 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
3760 # check for declarations of signed or unsigned without int
3761 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3764 $var = "" if (!defined $var);
3765 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
3769 $pointer = "" if (!defined $pointer);
3771 if (WARN("UNSPECIFIED_INT",
3772 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3774 my $decl = trim($sign) . " int ";
3775 my $comp_pointer = $pointer;
3776 $comp_pointer =~ s/\s//g;
3777 $decl .= $comp_pointer;
3778 $decl = rtrim($decl) if ($var eq "");
3779 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
3784 # TEST: allow direct testing of the type matcher.
3786 if ($line =~ /^.\s*$Declare\s*$/) {
3788 "TEST: is type\n" . $herecurr);
3789 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
3790 ERROR("TEST_NOT_TYPE",
3791 "TEST: is not type ($1 is)\n". $herecurr);
3795 # TEST: allow direct testing of the attribute matcher.
3797 if ($line =~ /^.\s*$Modifier\s*$/) {
3799 "TEST: is attr\n" . $herecurr);
3800 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
3801 ERROR("TEST_NOT_ATTR",
3802 "TEST: is not attr ($1 is)\n". $herecurr);
3807 # check for initialisation to aggregates open brace on the next line
3808 if ($line =~ /^.\s*{/ &&
3809 $prevline =~ /(?:^|[^=])=\s*$/) {
3810 if (ERROR("OPEN_BRACE",
3811 "that open brace { should be on the previous line\n" . $hereprev) &&
3812 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3813 fix_delete_line($fixlinenr - 1, $prevrawline);
3814 fix_delete_line($fixlinenr, $rawline);
3815 my $fixedline = $prevrawline;
3816 $fixedline =~ s/\s*=\s*$/ = {/;
3817 fix_insert_line($fixlinenr, $fixedline);
3819 $fixedline =~ s/^(.\s*)\{\s*/$1/;
3820 fix_insert_line($fixlinenr, $fixedline);
3825 # Checks which are anchored on the added line.
3828 # check for malformed paths in #include statements (uses RAW line)
3829 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
3831 if ($path =~ m{//}) {
3832 ERROR("MALFORMED_INCLUDE",
3833 "malformed #include filename\n" . $herecurr);
3835 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3836 ERROR("UAPI_INCLUDE",
3837 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
3841 # no C99 // comments
3842 if ($line =~ m{//}) {
3843 if (ERROR("C99_COMMENTS",
3844 "do not use C99 // comments\n" . $herecurr) &&
3846 my $line = $fixed[$fixlinenr];
3847 if ($line =~ /\/\/(.*)$/) {
3848 my $comment = trim($1);
3849 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
3853 # Remove C99 comments.
3855 $opline =~ s@//.*@@;
3857 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3858 # the whole statement.
3859 #print "APW <$lines[$realline_next - 1]>\n";
3860 if (defined $realline_next &&
3861 exists $lines[$realline_next - 1] &&
3862 !defined $suppress_export{$realline_next} &&
3863 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3864 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3865 # Handle definitions which produce identifiers with
3868 # EXPORT_SYMBOL(something_foo);
3870 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
3871 $name =~ /^${Ident}_$2/) {
3872 #print "FOO C name<$name>\n";
3873 $suppress_export{$realline_next} = 1;
3875 } elsif ($stat !~ /(?:
3877 ^.DEFINE_$Ident\(\Q$name\E\)|
3878 ^.DECLARE_$Ident\(\Q$name\E\)|
3879 ^.LIST_HEAD\(\Q$name\E\)|
3880 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3881 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
3883 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3884 $suppress_export{$realline_next} = 2;
3886 $suppress_export{$realline_next} = 1;
3889 if (!defined $suppress_export{$linenr} &&
3890 $prevline =~ /^.\s*$/ &&
3891 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3892 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3893 #print "FOO B <$lines[$linenr - 1]>\n";
3894 $suppress_export{$linenr} = 2;
3896 if (defined $suppress_export{$linenr} &&
3897 $suppress_export{$linenr} == 2) {
3898 WARN("EXPORT_SYMBOL",
3899 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
3902 # check for global initialisers.
3903 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
3904 if (ERROR("GLOBAL_INITIALISERS",
3905 "do not initialise globals to $1\n" . $herecurr) &&
3907 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
3910 # check for static initialisers.
3911 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
3912 if (ERROR("INITIALISED_STATIC",
3913 "do not initialise statics to $1\n" .
3916 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
3920 # check for misordered declarations of char/short/int/long with signed/unsigned
3921 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3923 WARN("MISORDERED_TYPE",
3924 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3927 # check for unnecessary <signed> int declarations of short/long/long long
3928 while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) {
3929 my $type = trim($1);
3930 next if ($type !~ /\bint\b/);
3931 next if ($type !~ /\b(?:short|long\s+long|long)\b/);
3932 my $new_type = $type;
3933 $new_type =~ s/\b\s*int\s*\b/ /;
3934 $new_type =~ s/\b\s*(?:un)?signed\b\s*/ /;
3935 $new_type =~ s/^const\s+//;
3936 $new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/);
3937 $new_type = "const $new_type" if ($type =~ /^const\b/);
3938 $new_type =~ s/\s+/ /g;
3939 $new_type = trim($new_type);
3940 if (WARN("UNNECESSARY_INT",
3941 "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) &&
3943 $fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/;
3947 # check for static const char * arrays.
3948 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
3949 WARN("STATIC_CONST_CHAR_ARRAY",
3950 "static const char * array should probably be static const char * const\n" .
3954 # check for initialized const char arrays that should be static const
3955 if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) {
3956 if (WARN("STATIC_CONST_CHAR_ARRAY",
3957 "const array should probably be static const\n" . $herecurr) &&
3959 $fixed[$fixlinenr] =~ s/(^.\s*)const\b/${1}static const/;
3963 # check for static char foo[] = "bar" declarations.
3964 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
3965 WARN("STATIC_CONST_CHAR_ARRAY",
3966 "static char array declaration should probably be static const char\n" .
3970 # check for const <foo> const where <foo> is not a pointer or array type
3971 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3973 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3975 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3976 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3978 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3982 # check for non-global char *foo[] = {"bar", ...} declarations.
3983 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3984 WARN("STATIC_CONST_CHAR_ARRAY",
3985 "char * array declaration might be better as static const\n" .
3989 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3990 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3992 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3994 if (WARN("ARRAY_SIZE",
3995 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3997 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
4002 # check for function declarations without arguments like "int foo()"
4003 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
4004 if (ERROR("FUNCTION_WITHOUT_ARGS",
4005 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
4007 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
4011 # check for new typedefs, only function parameters and sparse annotations
4013 if ($line =~ /\btypedef\s/ &&
4014 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
4015 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
4016 $line !~ /\b$typeTypedefs\b/ &&
4017 $line !~ /\b__bitwise\b/) {
4018 WARN("NEW_TYPEDEFS",
4019 "do not add new typedefs\n" . $herecurr);
4022 # * goes on variable not on type
4024 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
4026 my ($ident, $from, $to) = ($1, $2, $2);
4028 # Should start with a space.
4029 $to =~ s/^(\S)/ $1/;
4030 # Should not end with a space.
4032 # '*'s should not have spaces between.
4033 while ($to =~ s/\*\s+\*/\*\*/) {
4036 ## print "1: from<$from> to<$to> ident<$ident>\n";
4038 if (ERROR("POINTER_LOCATION",
4039 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
4041 my $sub_from = $ident;
4042 my $sub_to = $ident;
4043 $sub_to =~ s/\Q$from\E/$to/;
4044 $fixed[$fixlinenr] =~
4045 s@\Q$sub_from\E@$sub_to@;
4049 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
4051 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
4053 # Should start with a space.
4054 $to =~ s/^(\S)/ $1/;
4055 # Should not end with a space.
4057 # '*'s should not have spaces between.
4058 while ($to =~ s/\*\s+\*/\*\*/) {
4060 # Modifiers should have spaces.
4061 $to =~ s/(\b$Modifier$)/$1 /;
4063 ## print "2: from<$from> to<$to> ident<$ident>\n";
4064 if ($from ne $to && $ident !~ /^$Modifier$/) {
4065 if (ERROR("POINTER_LOCATION",
4066 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
4069 my $sub_from = $match;
4070 my $sub_to = $match;
4071 $sub_to =~ s/\Q$from\E/$to/;
4072 $fixed[$fixlinenr] =~
4073 s@\Q$sub_from\E@$sub_to@;
4078 # avoid BUG() or BUG_ON()
4079 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
4080 my $msg_level = \&WARN;
4081 $msg_level = \&CHK if ($file);
4082 &{$msg_level}("AVOID_BUG",
4083 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
4086 # avoid LINUX_VERSION_CODE
4087 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
4088 WARN("LINUX_VERSION_CODE",
4089 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
4092 # check for uses of printk_ratelimit
4093 if ($line =~ /\bprintk_ratelimit\s*\(/) {
4094 WARN("PRINTK_RATELIMITED",
4095 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
4098 # printk should use KERN_* levels
4099 if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
4100 WARN("PRINTK_WITHOUT_KERN_LEVEL",
4101 "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
4104 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
4106 my $level = lc($orig);
4107 $level = "warn" if ($level eq "warning");
4108 my $level2 = $level;
4109 $level2 = "dbg" if ($level eq "debug");
4110 WARN("PREFER_PR_LEVEL",
4111 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
4114 if ($line =~ /\bpr_warning\s*\(/) {
4115 if (WARN("PREFER_PR_LEVEL",
4116 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
4118 $fixed[$fixlinenr] =~
4119 s/\bpr_warning\b/pr_warn/;
4123 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
4125 my $level = lc($orig);
4126 $level = "warn" if ($level eq "warning");
4127 $level = "dbg" if ($level eq "debug");
4128 WARN("PREFER_DEV_LEVEL",
4129 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
4132 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
4133 # number of false positives, but assembly files are not checked, so at
4134 # least the arch entry code will not trigger this warning.
4135 if ($line =~ /\bENOSYS\b/) {
4137 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
4140 # function brace can't be on same line, except for #defines of do while,
4141 # or if closed on same line
4142 if ($perl_version_ok &&
4143 $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ &&
4144 $sline !~ /\#\s*define\b.*do\s*\{/ &&
4146 if (ERROR("OPEN_BRACE",
4147 "open brace '{' following function definitions go on the next line\n" . $herecurr) &&
4149 fix_delete_line($fixlinenr, $rawline);
4150 my $fixed_line = $rawline;
4151 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
4154 fix_insert_line($fixlinenr, ltrim($line1));
4155 fix_insert_line($fixlinenr, "\+{");
4156 if ($line2 !~ /^\s*$/) {
4157 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
4162 # open braces for enum, union and struct go on the same line.
4163 if ($line =~ /^.\s*{/ &&
4164 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
4165 if (ERROR("OPEN_BRACE",
4166 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
4167 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4168 fix_delete_line($fixlinenr - 1, $prevrawline);
4169 fix_delete_line($fixlinenr, $rawline);
4170 my $fixedline = rtrim($prevrawline) . " {";
4171 fix_insert_line($fixlinenr, $fixedline);
4172 $fixedline = $rawline;
4173 $fixedline =~ s/^(.\s*)\{\s*/$1\t/;
4174 if ($fixedline !~ /^\+\s*$/) {
4175 fix_insert_line($fixlinenr, $fixedline);
4180 # missing space after union, struct or enum definition
4181 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
4183 "missing space after $1 definition\n" . $herecurr) &&
4185 $fixed[$fixlinenr] =~
4186 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
4190 # Function pointer declarations
4191 # check spacing between type, funcptr, and args
4192 # canonical declaration is "type (*funcptr)(args...)"
4193 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
4195 my $pre_pointer_space = $2;
4196 my $post_pointer_space = $3;
4198 my $post_funcname_space = $5;
4199 my $pre_args_space = $6;
4201 # the $Declare variable will capture all spaces after the type
4202 # so check it for a missing trailing missing space but pointer return types
4203 # don't need a space so don't warn for those.
4204 my $post_declare_space = "";
4205 if ($declare =~ /(\s+)$/) {
4206 $post_declare_space = $1;
4207 $declare = rtrim($declare);
4209 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
4211 "missing space after return type\n" . $herecurr);
4212 $post_declare_space = " ";
4215 # unnecessary space "type (*funcptr)(args...)"
4216 # This test is not currently implemented because these declarations are
4218 # int foo(int bar, ...)
4219 # and this is form shouldn't/doesn't generate a checkpatch warning.
4221 # elsif ($declare =~ /\s{2,}$/) {
4223 # "Multiple spaces after return type\n" . $herecurr);
4226 # unnecessary space "type ( *funcptr)(args...)"
4227 if (defined $pre_pointer_space &&
4228 $pre_pointer_space =~ /^\s/) {
4230 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
4233 # unnecessary space "type (* funcptr)(args...)"
4234 if (defined $post_pointer_space &&
4235 $post_pointer_space =~ /^\s/) {
4237 "Unnecessary space before function pointer name\n" . $herecurr);
4240 # unnecessary space "type (*funcptr )(args...)"
4241 if (defined $post_funcname_space &&
4242 $post_funcname_space =~ /^\s/) {
4244 "Unnecessary space after function pointer name\n" . $herecurr);
4247 # unnecessary space "type (*funcptr) (args...)"
4248 if (defined $pre_args_space &&
4249 $pre_args_space =~ /^\s/) {
4251 "Unnecessary space before function pointer arguments\n" . $herecurr);
4254 if (show_type("SPACING") && $fix) {
4255 $fixed[$fixlinenr] =~
4256 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
4260 # check for spacing round square brackets; allowed:
4261 # 1. with a type on the left -- int [] a;
4262 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4263 # 3. inside a curly brace -- = { [0...10] = 5 }
4264 while ($line =~ /(.*?\s)\[/g) {
4265 my ($where, $prefix) = ($-[1], $1);
4266 if ($prefix !~ /$Type\s+$/ &&
4267 ($where != 0 || $prefix !~ /^.\s+$/) &&
4268 $prefix !~ /[{,:]\s+$/) {
4269 if (ERROR("BRACKET_SPACE",
4270 "space prohibited before open square bracket '['\n" . $herecurr) &&
4272 $fixed[$fixlinenr] =~
4273 s/^(\+.*?)\s+\[/$1\[/;
4278 # check for spaces between functions and their parentheses.
4279 while ($line =~ /($Ident)\s+\(/g) {
4281 my $ctx_before = substr($line, 0, $-[1]);
4282 my $ctx = "$ctx_before$name";
4284 # Ignore those directives where spaces _are_ permitted.
4286 if|for|while|switch|return|case|
4287 volatile|__volatile__|
4288 __attribute__|format|__extension__|
4291 # cpp #define statements have non-optional spaces, ie
4292 # if there is a space between the name and the open
4293 # parenthesis it is simply not a parameter group.
4294 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
4296 # cpp #elif statement condition may start with a (
4297 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
4299 # If this whole things ends with a type its most
4300 # likely a typedef for a function.
4301 } elsif ($ctx =~ /$Type$/) {
4305 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
4307 $fixed[$fixlinenr] =~
4308 s/\b$name\s+\(/$name\(/;
4313 # Check operator spacing.
4314 if (!($line=~/\#\s*include/)) {
4315 my $fixed_line = "";
4319 <<=|>>=|<=|>=|==|!=|
4320 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4321 =>|->|<<|>>|<|>|=|!|~|
4322 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
4325 my @elements = split(/($ops|;)/, $opline);
4327 ## print("element count: <" . $#elements . ">\n");
4328 ## foreach my $el (@elements) {
4329 ## print("el: <$el>\n");
4332 my @fix_elements = ();
4335 foreach my $el (@elements) {
4336 push(@fix_elements, substr($rawline, $off, length($el)));
4337 $off += length($el);
4342 my $blank = copy_spacing($opline);
4343 my $last_after = -1;
4345 for (my $n = 0; $n < $#elements; $n += 2) {
4347 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4349 ## print("n: <$n> good: <$good>\n");
4351 $off += length($elements[$n]);
4353 # Pick up the preceding and succeeding characters.
4354 my $ca = substr($opline, 0, $off);
4356 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4357 $cc = substr($opline, $off + length($elements[$n + 1]));
4359 my $cb = "$ca$;$cc";
4362 $a = 'V' if ($elements[$n] ne '');
4363 $a = 'W' if ($elements[$n] =~ /\s$/);
4364 $a = 'C' if ($elements[$n] =~ /$;$/);
4365 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4366 $a = 'O' if ($elements[$n] eq '');
4367 $a = 'E' if ($ca =~ /^\s*$/);
4369 my $op = $elements[$n + 1];
4372 if (defined $elements[$n + 2]) {
4373 $c = 'V' if ($elements[$n + 2] ne '');
4374 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
4375 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
4376 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4377 $c = 'O' if ($elements[$n + 2] eq '');
4378 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
4383 my $ctx = "${a}x${c}";
4385 my $at = "(ctx:$ctx)";
4387 my $ptr = substr($blank, 0, $off) . "^";
4388 my $hereptr = "$hereline$ptr\n";
4390 # Pull out the value of this operator.
4391 my $op_type = substr($curr_values, $off + 1, 1);
4393 # Get the full operator variant.
4394 my $opv = $op . substr($curr_vars, $off, 1);
4396 # Ignore operators passed as parameters.
4397 if ($op_type ne 'V' &&
4398 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
4401 # } elsif ($op =~ /^$;+$/) {
4403 # ; should have either the end of line or a space or \ after it
4404 } elsif ($op eq ';') {
4405 if ($ctx !~ /.x[WEBC]/ &&
4406 $cc !~ /^\\/ && $cc !~ /^;/) {
4407 if (ERROR("SPACING",
4408 "space required after that '$op' $at\n" . $hereptr)) {
4409 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
4415 } elsif ($op eq '//') {
4417 # : when part of a bitfield
4418 } elsif ($opv eq ':B') {
4419 # skip the bitfield test for now
4423 } elsif ($op eq '->') {
4424 if ($ctx =~ /Wx.|.xW/) {
4425 if (ERROR("SPACING",
4426 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
4427 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4428 if (defined $fix_elements[$n + 2]) {
4429 $fix_elements[$n + 2] =~ s/^\s+//;
4435 # , must not have a space before and must have a space on the right.
4436 } elsif ($op eq ',') {
4437 my $rtrim_before = 0;
4438 my $space_after = 0;
4439 if ($ctx =~ /Wx./) {
4440 if (ERROR("SPACING",
4441 "space prohibited before that '$op' $at\n" . $hereptr)) {
4446 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
4447 if (ERROR("SPACING",
4448 "space required after that '$op' $at\n" . $hereptr)) {
4454 if ($rtrim_before || $space_after) {
4455 if ($rtrim_before) {
4456 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4458 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4465 # '*' as part of a type definition -- reported already.
4466 } elsif ($opv eq '*_') {
4467 #warn "'*' is part of type\n";
4469 # unary operators should have a space before and
4470 # none after. May be left adjacent to another
4471 # unary operator, or a cast
4472 } elsif ($op eq '!' || $op eq '~' ||
4473 $opv eq '*U' || $opv eq '-U' ||
4474 $opv eq '&U' || $opv eq '&&U') {
4475 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
4476 if (ERROR("SPACING",
4477 "space required before that '$op' $at\n" . $hereptr)) {
4478 if ($n != $last_after + 2) {
4479 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4484 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
4485 # A unary '*' may be const
4487 } elsif ($ctx =~ /.xW/) {
4488 if (ERROR("SPACING",
4489 "space prohibited after that '$op' $at\n" . $hereptr)) {
4490 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
4491 if (defined $fix_elements[$n + 2]) {
4492 $fix_elements[$n + 2] =~ s/^\s+//;
4498 # unary ++ and unary -- are allowed no space on one side.
4499 } elsif ($op eq '++' or $op eq '--') {
4500 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
4501 if (ERROR("SPACING",
4502 "space required one side of that '$op' $at\n" . $hereptr)) {
4503 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
4507 if ($ctx =~ /Wx[BE]/ ||
4508 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
4509 if (ERROR("SPACING",
4510 "space prohibited before that '$op' $at\n" . $hereptr)) {
4511 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4515 if ($ctx =~ /ExW/) {
4516 if (ERROR("SPACING",
4517 "space prohibited after that '$op' $at\n" . $hereptr)) {
4518 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4519 if (defined $fix_elements[$n + 2]) {
4520 $fix_elements[$n + 2] =~ s/^\s+//;
4526 # << and >> may either have or not have spaces both sides
4527 } elsif ($op eq '<<' or $op eq '>>' or
4528 $op eq '&' or $op eq '^' or $op eq '|' or
4529 $op eq '+' or $op eq '-' or
4530 $op eq '*' or $op eq '/' or
4534 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4536 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4537 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4538 $fix_elements[$n + 2] =~ s/^\s+//;
4541 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4543 "space preferred before that '$op' $at\n" . $hereptr)) {
4544 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4548 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
4549 if (ERROR("SPACING",
4550 "need consistent spacing around '$op' $at\n" . $hereptr)) {
4551 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4552 if (defined $fix_elements[$n + 2]) {
4553 $fix_elements[$n + 2] =~ s/^\s+//;
4559 # A colon needs no spaces before when it is
4560 # terminating a case value or a label.
4561 } elsif ($opv eq ':C' || $opv eq ':L') {
4562 if ($ctx =~ /Wx./) {
4563 if (ERROR("SPACING",
4564 "space prohibited before that '$op' $at\n" . $hereptr)) {
4565 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4570 # All the others need spaces both sides.
4571 } elsif ($ctx !~ /[EWC]x[CWE]/) {
4574 # Ignore email addresses <foo@bar>
4576 $cc =~ /^\S+\@\S+>/) ||
4578 $ca =~ /<\S+\@\S+$/))
4583 # for asm volatile statements
4584 # ignore a colon with another
4585 # colon immediately before or after
4587 ($ca =~ /:$/ || $cc =~ /^:/)) {
4591 # messages are ERROR, but ?: are CHK
4593 my $msg_level = \&ERROR;
4594 $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4596 if (&{$msg_level}("SPACING",
4597 "spaces required around that '$op' $at\n" . $hereptr)) {
4598 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4599 if (defined $fix_elements[$n + 2]) {
4600 $fix_elements[$n + 2] =~ s/^\s+//;
4606 $off += length($elements[$n + 1]);
4608 ## print("n: <$n> GOOD: <$good>\n");
4610 $fixed_line = $fixed_line . $good;
4613 if (($#elements % 2) == 0) {
4614 $fixed_line = $fixed_line . $fix_elements[$#elements];
4617 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4618 $fixed[$fixlinenr] = $fixed_line;
4624 # check for whitespace before a non-naked semicolon
4625 if ($line =~ /^\+.*\S\s+;\s*$/) {
4627 "space prohibited before semicolon\n" . $herecurr) &&
4629 1 while $fixed[$fixlinenr] =~
4630 s/^(\+.*\S)\s+;/$1;/;
4634 # check for multiple assignments
4635 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
4636 CHK("MULTIPLE_ASSIGNMENTS",
4637 "multiple assignments should be avoided\n" . $herecurr);
4640 ## # check for multiple declarations, allowing for a function declaration
4642 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4643 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4645 ## # Remove any bracketed sections to ensure we do not
4646 ## # falsly report the parameters of functions.
4648 ## while ($ln =~ s/\([^\(\)]*\)//g) {
4650 ## if ($ln =~ /,/) {
4651 ## WARN("MULTIPLE_DECLARATION",
4652 ## "declaring multiple variables together should be avoided\n" . $herecurr);
4656 #need space before brace following if, while, etc
4657 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
4658 $line =~ /\b(?:else|do)\{/) {
4659 if (ERROR("SPACING",
4660 "space required before the open brace '{'\n" . $herecurr) &&
4662 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/;
4666 ## # check for blank lines before declarations
4667 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4668 ## $prevrawline =~ /^.\s*$/) {
4670 ## "No blank lines before declarations\n" . $hereprev);
4674 # closing brace should have a space following it when it has anything
4676 if ($line =~ /}(?!(?:,|;|\)|\}))\S/) {
4677 if (ERROR("SPACING",
4678 "space required after that close brace '}'\n" . $herecurr) &&
4680 $fixed[$fixlinenr] =~
4681 s/}((?!(?:,|;|\)))\S)/} $1/;
4685 # check spacing on square brackets
4686 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
4687 if (ERROR("SPACING",
4688 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4690 $fixed[$fixlinenr] =~
4694 if ($line =~ /\s\]/) {
4695 if (ERROR("SPACING",
4696 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4698 $fixed[$fixlinenr] =~
4703 # check spacing on parentheses
4704 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4705 $line !~ /for\s*\(\s+;/) {
4706 if (ERROR("SPACING",
4707 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4709 $fixed[$fixlinenr] =~
4713 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
4714 $line !~ /for\s*\(.*;\s+\)/ &&
4715 $line !~ /:\s+\)/) {
4716 if (ERROR("SPACING",
4717 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4719 $fixed[$fixlinenr] =~
4724 # check unnecessary parentheses around addressof/dereference single $Lvals
4725 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4727 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
4729 if (CHK("UNNECESSARY_PARENTHESES",
4730 "Unnecessary parentheses around $var\n" . $herecurr) &&
4732 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4736 # check for unnecessary parentheses around function pointer uses
4737 # ie: (foo->bar)(); should be foo->bar();
4738 # but not "if (foo->bar) (" to avoid some false positives
4739 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4741 if (CHK("UNNECESSARY_PARENTHESES",
4742 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4744 my $var2 = deparenthesize($var);
4746 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4750 # check for unnecessary parentheses around comparisons in if uses
4751 # when !drivers/staging or command-line uses --strict
4752 if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) &&
4753 $perl_version_ok && defined($stat) &&
4754 $stat =~ /(^.\s*if\s*($balanced_parens))/) {
4756 my $test = substr($2, 1, -1);
4758 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4760 # avoid parentheses around potential macro args
4761 next if ($match =~ /^\s*\w+\s*$/);
4762 if (!defined($herectx)) {
4763 $herectx = $here . "\n";
4764 my $cnt = statement_rawlines($if_stat);
4765 for (my $n = 0; $n < $cnt; $n++) {
4766 my $rl = raw_line($linenr, $n);
4767 $herectx .= $rl . "\n";
4768 last if $rl =~ /^[ \+].*\{/;
4771 CHK("UNNECESSARY_PARENTHESES",
4772 "Unnecessary parentheses around '$match'\n" . $herectx);
4776 #goto labels aren't indented, allow a single space however
4777 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
4778 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
4779 if (WARN("INDENTED_LABEL",
4780 "labels should not be indented\n" . $herecurr) &&
4782 $fixed[$fixlinenr] =~
4787 # return is not a function
4788 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
4790 if ($perl_version_ok &&
4791 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4793 $value = deparenthesize($value);
4794 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4795 ERROR("RETURN_PARENTHESES",
4796 "return is not a function, parentheses are not required\n" . $herecurr);
4798 } elsif ($spacing !~ /\s+/) {
4800 "space required before the open parenthesis '('\n" . $herecurr);
4804 # unnecessary return in a void function
4805 # at end-of-function, with the previous line a single leading tab, then return;
4806 # and the line before that not a goto label target like "out:"
4807 if ($sline =~ /^[ \+]}\s*$/ &&
4808 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4810 $lines[$linenr - 3] =~ /^[ +]/ &&
4811 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
4813 "void function return statements are not generally useful\n" . $hereprev);
4816 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4817 if ($perl_version_ok &&
4818 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4819 my $openparens = $1;
4820 my $count = $openparens =~ tr@\(@\(@;
4822 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4823 my $comp = $4; #Not $1 because of $LvalOrFunc
4824 $msg = " - maybe == should be = ?" if ($comp eq "==");
4825 WARN("UNNECESSARY_PARENTHESES",
4826 "Unnecessary parentheses$msg\n" . $herecurr);
4830 # comparisons with a constant or upper case identifier on the left
4831 # avoid cases like "foo + BAR < baz"
4832 # only fix matches surrounded by parentheses to avoid incorrect
4833 # conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4834 if ($perl_version_ok &&
4835 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4840 my $newcomp = $comp;
4841 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
4842 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4843 WARN("CONSTANT_COMPARISON",
4844 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4848 } elsif ($comp eq "<=") {
4850 } elsif ($comp eq ">") {
4852 } elsif ($comp eq ">=") {
4855 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4859 # Return of what appears to be an errno should normally be negative
4860 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
4862 if ($name ne 'EOF' && $name ne 'ERROR') {
4863 WARN("USE_NEGATIVE_ERRNO",
4864 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
4868 # Need a space before open parenthesis after if, while etc
4869 if ($line =~ /\b(if|while|for|switch)\(/) {
4870 if (ERROR("SPACING",
4871 "space required before the open parenthesis '('\n" . $herecurr) &&
4873 $fixed[$fixlinenr] =~
4874 s/\b(if|while|for|switch)\(/$1 \(/;
4878 # Check for illegal assignment in if conditional -- and check for trailing
4879 # statements after the conditional.
4880 if ($line =~ /do\s*(?!{)/) {
4881 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4882 ctx_statement_block($linenr, $realcnt, 0)
4883 if (!defined $stat);
4884 my ($stat_next) = ctx_statement_block($line_nr_next,
4885 $remain_next, $off_next);
4886 $stat_next =~ s/\n./\n /g;
4887 ##print "stat<$stat> stat_next<$stat_next>\n";
4889 if ($stat_next =~ /^\s*while\b/) {
4890 # If the statement carries leading newlines,
4891 # then count those as offsets.
4893 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4895 statement_rawlines($whitespace) - 1;
4897 $suppress_whiletrailers{$line_nr_next +
4901 if (!defined $suppress_whiletrailers{$linenr} &&
4902 defined($stat) && defined($cond) &&
4903 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
4904 my ($s, $c) = ($stat, $cond);
4906 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
4907 ERROR("ASSIGN_IN_IF",
4908 "do not use assignment in if condition\n" . $herecurr);
4911 # Find out what is on the end of the line after the
4913 substr($s, 0, length($c), '');
4915 $s =~ s/$;//g; # Remove any comments
4916 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4917 $c !~ /}\s*while\s*/)
4919 # Find out how long the conditional actually is.
4920 my @newlines = ($c =~ /\n/gs);
4921 my $cond_lines = 1 + $#newlines;
4924 $stat_real = raw_line($linenr, $cond_lines)
4925 . "\n" if ($cond_lines);
4926 if (defined($stat_real) && $cond_lines > 1) {
4927 $stat_real = "[...]\n$stat_real";
4930 ERROR("TRAILING_STATEMENTS",
4931 "trailing statements should be on next line\n" . $herecurr . $stat_real);
4935 # Check for bitwise tests written as boolean
4947 WARN("HEXADECIMAL_BOOLEAN_TEST",
4948 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
4951 # if and else should not have general statements after it
4952 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4954 $s =~ s/$;//g; # Remove any comments
4955 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
4956 ERROR("TRAILING_STATEMENTS",
4957 "trailing statements should be on next line\n" . $herecurr);
4960 # if should not continue a brace
4961 if ($line =~ /}\s*if\b/) {
4962 ERROR("TRAILING_STATEMENTS",
4963 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
4966 # case and default should not have general statements after them
4967 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4969 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
4973 ERROR("TRAILING_STATEMENTS",
4974 "trailing statements should be on next line\n" . $herecurr);
4977 # Check for }<nl>else {, these must be at the same
4978 # indent level to be relevant to each other.
4979 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4980 $previndent == $indent) {
4981 if (ERROR("ELSE_AFTER_BRACE",
4982 "else should follow close brace '}'\n" . $hereprev) &&
4983 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4984 fix_delete_line($fixlinenr - 1, $prevrawline);
4985 fix_delete_line($fixlinenr, $rawline);
4986 my $fixedline = $prevrawline;
4987 $fixedline =~ s/}\s*$//;
4988 if ($fixedline !~ /^\+\s*$/) {
4989 fix_insert_line($fixlinenr, $fixedline);
4991 $fixedline = $rawline;
4992 $fixedline =~ s/^(.\s*)else/$1} else/;
4993 fix_insert_line($fixlinenr, $fixedline);
4997 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4998 $previndent == $indent) {
4999 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
5001 # Find out what is on the end of the line after the
5003 substr($s, 0, length($c), '');
5006 if ($s =~ /^\s*;/) {
5007 if (ERROR("WHILE_AFTER_BRACE",
5008 "while should follow close brace '}'\n" . $hereprev) &&
5009 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
5010 fix_delete_line($fixlinenr - 1, $prevrawline);
5011 fix_delete_line($fixlinenr, $rawline);
5012 my $fixedline = $prevrawline;
5013 my $trailing = $rawline;
5014 $trailing =~ s/^\+//;
5015 $trailing = trim($trailing);
5016 $fixedline =~ s/}\s*$/} $trailing/;
5017 fix_insert_line($fixlinenr, $fixedline);
5022 #Specific variable tests
5023 while ($line =~ m{($Constant|$Lval)}g) {
5027 if ($var !~ /^$Constant$/ &&
5028 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
5029 #Ignore Page<foo> variants
5030 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
5031 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
5032 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
5033 #Ignore some three character SI units explicitly, like MiB and KHz
5034 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
5035 while ($var =~ m{($Ident)}g) {
5037 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
5039 seed_camelcase_includes();
5040 if (!$file && !$camelcase_file_seeded) {
5041 seed_camelcase_file($realfile);
5042 $camelcase_file_seeded = 1;
5045 if (!defined $camelcase{$word}) {
5046 $camelcase{$word} = 1;
5048 "Avoid CamelCase: <$word>\n" . $herecurr);
5054 #no spaces allowed after \ in define
5055 if ($line =~ /\#\s*define.*\\\s+$/) {
5056 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
5057 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
5059 $fixed[$fixlinenr] =~ s/\s+$//;
5063 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
5064 # itself <asm/foo.h> (uses RAW line)
5065 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
5067 my $checkfile = "include/linux/$file";
5068 if (-f "$root/$checkfile" &&
5069 $realfile ne $checkfile &&
5070 $1 !~ /$allowed_asm_includes/)
5072 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
5073 if ($asminclude > 0) {
5074 if ($realfile =~ m{^arch/}) {
5075 CHK("ARCH_INCLUDE_LINUX",
5076 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5078 WARN("INCLUDE_LINUX",
5079 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5085 # multi-statement macros should be enclosed in a do while loop, grab the
5086 # first statement and ensure its the whole macro if its not enclosed
5087 # in a known good container
5088 if ($realfile !~ m@/vmlinux.lds.h$@ &&
5089 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
5092 my ($off, $dstat, $dcond, $rest);
5094 my $has_flow_statement = 0;
5095 my $has_arg_concat = 0;
5096 ($dstat, $dcond, $ln, $cnt, $off) =
5097 ctx_statement_block($linenr, $realcnt, 0);
5099 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
5100 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
5102 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
5103 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
5105 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
5106 my $define_args = $1;
5107 my $define_stmt = $dstat;
5110 if (defined $define_args && $define_args ne "") {
5111 $define_args = substr($define_args, 1, length($define_args) - 2);
5112 $define_args =~ s/\s*//g;
5113 $define_args =~ s/\\\+?//g;
5114 @def_args = split(",", $define_args);
5118 $dstat =~ s/\\\n.//g;
5119 $dstat =~ s/^\s*//s;
5120 $dstat =~ s/\s*$//s;
5122 # Flatten any parentheses and braces
5123 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
5124 $dstat =~ s/\{[^\{\}]*\}/1/ ||
5125 $dstat =~ s/.\[[^\[\]]*\]/1/)
5129 # Flatten any obvious string concatentation.
5130 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
5131 $dstat =~ s/$Ident\s*($String)/$1/)
5135 # Make asm volatile uses seem like a generic function
5136 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
5138 my $exceptions = qr{
5151 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
5154 my $stmt_cnt = statement_rawlines($ctx);
5155 my $herectx = get_stat_here($linenr, $stmt_cnt, $here);
5158 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
5159 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
5160 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
5161 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
5162 $dstat !~ /$exceptions/ &&
5163 $dstat !~ /^\.$Ident\s*=/ && # .foo =
5164 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
5165 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
5166 $dstat !~ /^for\s*$Constant$/ && # for (...)
5167 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
5168 $dstat !~ /^do\s*{/ && # do {...
5169 $dstat !~ /^\(\{/ && # ({...
5170 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
5172 if ($dstat =~ /^\s*if\b/) {
5173 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5174 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5175 } elsif ($dstat =~ /;/) {
5176 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5177 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
5179 ERROR("COMPLEX_MACRO",
5180 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
5185 # Make $define_stmt single line, comment-free, etc
5186 my @stmt_array = split('\n', $define_stmt);
5189 foreach my $l (@stmt_array) {
5194 } elsif ($l =~ /^[\+ ]/) {
5195 $define_stmt .= substr($l, 1);
5198 $define_stmt =~ s/$;//g;
5199 $define_stmt =~ s/\s+/ /g;
5200 $define_stmt = trim($define_stmt);
5202 # check if any macro arguments are reused (ignore '...' and 'type')
5203 foreach my $arg (@def_args) {
5204 next if ($arg =~ /\.\.\./);
5205 next if ($arg =~ /^type$/i);
5206 my $tmp_stmt = $define_stmt;
5207 $tmp_stmt =~ s/\b(sizeof|typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
5208 $tmp_stmt =~ s/\#+\s*$arg\b//g;
5209 $tmp_stmt =~ s/\b$arg\s*\#\#//g;
5210 my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g;
5212 CHK("MACRO_ARG_REUSE",
5213 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
5215 # check if any macro arguments may have other precedence issues
5216 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
5217 ((defined($1) && $1 ne ',') ||
5218 (defined($2) && $2 ne ','))) {
5219 CHK("MACRO_ARG_PRECEDENCE",
5220 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
5224 # check for macros with flow control, but without ## concatenation
5225 # ## concatenation is commonly a macro that defines a function so ignore those
5226 if ($has_flow_statement && !$has_arg_concat) {
5227 my $cnt = statement_rawlines($ctx);
5228 my $herectx = get_stat_here($linenr, $cnt, $here);
5230 WARN("MACRO_WITH_FLOW_CONTROL",
5231 "Macros with flow control statements should be avoided\n" . "$herectx");
5234 # check for line continuations outside of #defines, preprocessor #, and asm
5237 if ($prevline !~ /^..*\\$/ &&
5238 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
5239 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
5240 $line =~ /^\+.*\\$/) {
5241 WARN("LINE_CONTINUATIONS",
5242 "Avoid unnecessary line continuations\n" . $herecurr);
5246 # do {} while (0) macro tests:
5247 # single-statement macros do not need to be enclosed in do while (0) loop,
5248 # macro should not end with a semicolon
5249 if ($perl_version_ok &&
5250 $realfile !~ m@/vmlinux.lds.h$@ &&
5251 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
5254 my ($off, $dstat, $dcond, $rest);
5256 ($dstat, $dcond, $ln, $cnt, $off) =
5257 ctx_statement_block($linenr, $realcnt, 0);
5260 $dstat =~ s/\\\n.//g;
5263 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5268 my $cnt = statement_rawlines($ctx);
5269 my $herectx = get_stat_here($linenr, $cnt, $here);
5271 if (($stmts =~ tr/;/;/) == 1 &&
5272 $stmts !~ /^\s*(if|while|for|switch)\b/) {
5273 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
5274 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
5276 if (defined $semis && $semis ne "") {
5277 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
5278 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
5280 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
5282 my $cnt = statement_rawlines($ctx);
5283 my $herectx = get_stat_here($linenr, $cnt, $here);
5285 WARN("TRAILING_SEMICOLON",
5286 "macros should not use a trailing semicolon\n" . "$herectx");
5290 # check for redundant bracing round if etc
5291 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
5292 my ($level, $endln, @chunks) =
5293 ctx_statement_full($linenr, $realcnt, 1);
5294 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
5295 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5296 if ($#chunks > 0 && $level == 0) {
5300 my $herectx = $here . "\n";
5301 my $ln = $linenr - 1;
5302 for my $chunk (@chunks) {
5303 my ($cond, $block) = @{$chunk};
5305 # If the condition carries leading newlines, then count those as offsets.
5306 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5307 my $offset = statement_rawlines($whitespace) - 1;
5309 $allowed[$allow] = 0;
5310 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5312 # We have looked at and allowed this specific line.
5313 $suppress_ifbraces{$ln + $offset} = 1;
5315 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
5316 $ln += statement_rawlines($block) - 1;
5318 substr($block, 0, length($cond), '');
5320 $seen++ if ($block =~ /^\s*{/);
5322 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5323 if (statement_lines($cond) > 1) {
5324 #print "APW: ALLOWED: cond<$cond>\n";
5325 $allowed[$allow] = 1;
5327 if ($block =~/\b(?:if|for|while)\b/) {
5328 #print "APW: ALLOWED: block<$block>\n";
5329 $allowed[$allow] = 1;
5331 if (statement_block_size($block) > 1) {
5332 #print "APW: ALLOWED: lines block<$block>\n";
5333 $allowed[$allow] = 1;
5338 my $sum_allowed = 0;
5339 foreach (@allowed) {
5342 if ($sum_allowed == 0) {
5344 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5345 } elsif ($sum_allowed != $allow &&
5348 "braces {} should be used on all arms of this statement\n" . $herectx);
5353 if (!defined $suppress_ifbraces{$linenr - 1} &&
5354 $line =~ /\b(if|while|for|else)\b/) {
5357 # Check the pre-context.
5358 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5359 #print "APW: ALLOWED: pre<$1>\n";
5363 my ($level, $endln, @chunks) =
5364 ctx_statement_full($linenr, $realcnt, $-[0]);
5366 # Check the condition.
5367 my ($cond, $block) = @{$chunks[0]};
5368 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5369 if (defined $cond) {
5370 substr($block, 0, length($cond), '');
5372 if (statement_lines($cond) > 1) {
5373 #print "APW: ALLOWED: cond<$cond>\n";
5376 if ($block =~/\b(?:if|for|while)\b/) {
5377 #print "APW: ALLOWED: block<$block>\n";
5380 if (statement_block_size($block) > 1) {
5381 #print "APW: ALLOWED: lines block<$block>\n";
5384 # Check the post-context.
5385 if (defined $chunks[1]) {
5386 my ($cond, $block) = @{$chunks[1]};
5387 if (defined $cond) {
5388 substr($block, 0, length($cond), '');
5390 if ($block =~ /^\s*\{/) {
5391 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5395 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
5396 my $cnt = statement_rawlines($block);
5397 my $herectx = get_stat_here($linenr, $cnt, $here);
5400 "braces {} are not necessary for single statement blocks\n" . $herectx);
5404 # check for single line unbalanced braces
5405 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
5406 $sline =~ /^.\s*else\s*\{\s*$/) {
5407 CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
5410 # check for unnecessary blank lines around braces
5411 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
5413 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5414 $fix && $prevrawline =~ /^\+/) {
5415 fix_delete_line($fixlinenr - 1, $prevrawline);
5418 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
5420 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5422 fix_delete_line($fixlinenr, $rawline);
5426 # no volatiles please
5427 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5428 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
5430 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
5433 # Check for user-visible strings broken across lines, which breaks the ability
5434 # to grep for the string. Make exceptions when the previous string ends in a
5435 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5436 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
5437 if ($line =~ /^\+\s*$String/ &&
5438 $prevline =~ /"\s*$/ &&
5439 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5440 if (WARN("SPLIT_STRING",
5441 "quoted string split across lines\n" . $hereprev) &&
5443 $prevrawline =~ /^\+.*"\s*$/ &&
5444 $last_coalesced_string_linenr != $linenr - 1) {
5445 my $extracted_string = get_quoted_string($line, $rawline);
5446 my $comma_close = "";
5447 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5451 fix_delete_line($fixlinenr - 1, $prevrawline);
5452 fix_delete_line($fixlinenr, $rawline);
5453 my $fixedline = $prevrawline;
5454 $fixedline =~ s/"\s*$//;
5455 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5456 fix_insert_line($fixlinenr - 1, $fixedline);
5457 $fixedline = $rawline;
5458 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5459 if ($fixedline !~ /\+\s*$/) {
5460 fix_insert_line($fixlinenr, $fixedline);
5462 $last_coalesced_string_linenr = $linenr;
5466 # check for missing a space in a string concatenation
5467 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5468 WARN('MISSING_SPACE',
5469 "break quoted strings at a space character\n" . $hereprev);
5472 # check for an embedded function name in a string when the function is known
5473 # This does not work very well for -f --file checking as it depends on patch
5474 # context providing the function name or a single line form for in-file
5475 # function declarations
5476 if ($line =~ /^\+.*$String/ &&
5477 defined($context_function) &&
5478 get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
5479 length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
5480 WARN("EMBEDDED_FUNCTION_NAME",
5481 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
5484 # check for spaces before a quoted newline
5485 if ($rawline =~ /^.*\".*\s\\n/) {
5486 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5487 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5489 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5494 # concatenated string without spaces between elements
5495 if ($line =~ /$String[A-Za-z0-9_]/ || $line =~ /[A-Za-z0-9_]$String/) {
5496 if (CHK("CONCATENATED_STRING",
5497 "Concatenated strings should use spaces between elements\n" . $herecurr) &&
5499 while ($line =~ /($String)/g) {
5500 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5501 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/;
5502 $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/;
5507 # uncoalesced string fragments
5508 if ($line =~ /$String\s*"/) {
5509 if (WARN("STRING_FRAGMENTS",
5510 "Consecutive strings are generally better as a single string\n" . $herecurr) &&
5512 while ($line =~ /($String)(?=\s*")/g) {
5513 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5514 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e;
5519 # check for non-standard and hex prefixed decimal printf formats
5520 my $show_L = 1; #don't show the same defect twice
5522 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
5523 my $string = substr($rawline, $-[1], $+[1] - $-[1]);
5524 $string =~ s/%%/__/g;
5526 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
5528 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
5532 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
5534 "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
5537 # check for 0x<decimal>
5538 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
5539 ERROR("PRINTF_0XDECIMAL",
5540 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5544 # check for line continuations in quoted strings with odd counts of "
5545 if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
5546 WARN("LINE_CONTINUATIONS",
5547 "Avoid line continuations in quoted strings\n" . $herecurr);
5551 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
5553 "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr);
5557 if ($line =~ /^.\s*\#\s*if\s+1\b/) {
5559 "Consider removing the #if 1 and its #endif\n" . $herecurr);
5562 # check for needless "if (<foo>) fn(<foo>)" uses
5563 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
5564 my $tested = quotemeta($1);
5565 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5566 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5568 if (WARN('NEEDLESS_IF',
5569 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5572 my $leading_tabs = "";
5573 my $new_leading_tabs = "";
5574 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5579 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5580 $new_leading_tabs = $1;
5581 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5588 fix_delete_line($fixlinenr - 1, $prevrawline);
5589 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5595 # check for unnecessary "Out of Memory" messages
5596 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5597 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5598 (defined $1 || defined $3) &&
5601 my $testline = $lines[$linenr - 3];
5603 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5604 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5606 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ &&
5607 $s !~ /\b__GFP_NOWARN\b/ ) {
5609 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5613 # check for logging functions with KERN_<LEVEL>
5614 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
5615 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5617 if (WARN("UNNECESSARY_KERN_LEVEL",
5618 "Possible unnecessary $level\n" . $herecurr) &&
5620 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5624 # check for logging continuations
5625 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
5626 WARN("LOGGING_CONTINUATION",
5627 "Avoid logging continuation uses where feasible\n" . $herecurr);
5630 # check for mask then right shift without a parentheses
5631 if ($perl_version_ok &&
5632 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5633 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5634 WARN("MASK_THEN_SHIFT",
5635 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5638 # check for pointer comparisons to NULL
5639 if ($perl_version_ok) {
5640 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5643 $equal = "" if ($4 eq "!=");
5644 if (CHK("COMPARISON_TO_NULL",
5645 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5647 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5652 # check for bad placement of section $InitAttribute (e.g.: __initdata)
5653 if ($line =~ /(\b$InitAttribute\b)/) {
5655 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5658 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5659 ERROR("MISPLACED_INIT",
5660 "$attr should be placed after $var\n" . $herecurr)) ||
5661 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5662 WARN("MISPLACED_INIT",
5663 "$attr should be placed after $var\n" . $herecurr))) &&
5665 $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;
5670 # check for $InitAttributeData (ie: __initdata) with const
5671 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5673 $attr =~ /($InitAttributePrefix)(.*)/;
5674 my $attr_prefix = $1;
5676 if (ERROR("INIT_ATTRIBUTE",
5677 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5679 $fixed[$fixlinenr] =~
5680 s/$InitAttributeData/${attr_prefix}initconst/;
5684 # check for $InitAttributeConst (ie: __initconst) without const
5685 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5687 if (ERROR("INIT_ATTRIBUTE",
5688 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5690 my $lead = $fixed[$fixlinenr] =~
5691 /(^\+\s*(?:static\s+))/;
5693 $lead = "$lead " if ($lead !~ /^\+$/);
5694 $lead = "${lead}const ";
5695 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
5699 # check for __read_mostly with const non-pointer (should just be const)
5700 if ($line =~ /\b__read_mostly\b/ &&
5701 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5702 if (ERROR("CONST_READ_MOSTLY",
5703 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5705 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5709 # don't use __constant_<foo> functions outside of include/uapi/
5710 if ($realfile !~ m@^include/uapi/@ &&
5711 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5712 my $constant_func = $1;
5713 my $func = $constant_func;
5714 $func =~ s/^__constant_//;
5715 if (WARN("CONSTANT_CONVERSION",
5716 "$constant_func should be $func\n" . $herecurr) &&
5718 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
5722 # prefer usleep_range over udelay
5723 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
5725 # ignore udelay's < 10, however
5726 if (! ($delay < 10) ) {
5728 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr);
5730 if ($delay > 2000) {
5732 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
5736 # warn about unexpectedly long msleep's
5737 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5740 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr);
5744 # check for comparisons of jiffies
5745 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5746 WARN("JIFFIES_COMPARISON",
5747 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5750 # check for comparisons of get_jiffies_64()
5751 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5752 WARN("JIFFIES_COMPARISON",
5753 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5756 # warn about #ifdefs in C files
5757 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5758 # print "#ifdef in C files should be avoided\n";
5759 # print "$herecurr";
5763 # warn about spacing in #ifdefs
5764 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
5765 if (ERROR("SPACING",
5766 "exactly one space required after that #$1\n" . $herecurr) &&
5768 $fixed[$fixlinenr] =~
5769 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5774 # check for spinlock_t definitions without a comment.
5775 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5776 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
5778 if (!ctx_has_comment($first_line, $linenr)) {
5779 CHK("UNCOMMENTED_DEFINITION",
5780 "$1 definition without comment\n" . $herecurr);
5783 # check for memory barriers without a comment.
5789 read_barrier_depends
5791 my $barrier_stems = qr{
5799 my $all_barriers = qr{
5801 smp_(?:$barrier_stems)|
5802 virt_(?:$barrier_stems)
5805 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
5806 if (!ctx_has_comment($first_line, $linenr)) {
5807 WARN("MEMORY_BARRIER",
5808 "memory barrier without comment\n" . $herecurr);
5812 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5814 if ($realfile !~ m@^include/asm-generic/@ &&
5815 $realfile !~ m@/barrier\.h$@ &&
5816 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5817 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5818 WARN("MEMORY_BARRIER",
5819 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5822 # check for waitqueue_active without a comment.
5823 if ($line =~ /\bwaitqueue_active\s*\(/) {
5824 if (!ctx_has_comment($first_line, $linenr)) {
5825 WARN("WAITQUEUE_ACTIVE",
5826 "waitqueue_active without comment\n" . $herecurr);
5830 # check for smp_read_barrier_depends and read_barrier_depends
5831 if (!$file && $line =~ /\b(smp_|)read_barrier_depends\s*\(/) {
5832 WARN("READ_BARRIER_DEPENDS",
5833 "$1read_barrier_depends should only be used in READ_ONCE or DEC Alpha code\n" . $herecurr);
5836 # check of hardware specific defines
5837 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5839 "architecture specific defines should be avoided\n" . $herecurr);
5842 # check that the storage class is not after a type
5843 if ($line =~ /\b($Type)\s+($Storage)\b/) {
5844 WARN("STORAGE_CLASS",
5845 "storage class '$2' should be located before type '$1'\n" . $herecurr);
5847 # Check that the storage class is at the beginning of a declaration
5848 if ($line =~ /\b$Storage\b/ &&
5849 $line !~ /^.\s*$Storage/ &&
5850 $line =~ /^.\s*(.+?)\$Storage\s/ &&
5851 $1 !~ /[\,\)]\s*$/) {
5852 WARN("STORAGE_CLASS",
5853 "storage class should be at the beginning of the declaration\n" . $herecurr);
5856 # check the location of the inline attribute, that it is between
5857 # storage class and type.
5858 if ($line =~ /\b$Type\s+$Inline\b/ ||
5859 $line =~ /\b$Inline\s+$Storage\b/) {
5860 ERROR("INLINE_LOCATION",
5861 "inline keyword should sit between storage class and type\n" . $herecurr);
5864 # Check for __inline__ and __inline, prefer inline
5865 if ($realfile !~ m@\binclude/uapi/@ &&
5866 $line =~ /\b(__inline__|__inline)\b/) {
5868 "plain inline is preferred over $1\n" . $herecurr) &&
5870 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
5875 # Check for __attribute__ packed, prefer __packed
5876 if ($realfile !~ m@\binclude/uapi/@ &&
5877 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
5878 WARN("PREFER_PACKED",
5879 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
5882 # Check for __attribute__ aligned, prefer __aligned
5883 if ($realfile !~ m@\binclude/uapi/@ &&
5884 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
5885 WARN("PREFER_ALIGNED",
5886 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
5889 # Check for __attribute__ section, prefer __section
5890 if ($realfile !~ m@\binclude/uapi/@ &&
5891 $line =~ /\b__attribute__\s*\(\s*\(.*_*section_*\s*\(\s*("[^"]*")/) {
5892 my $old = substr($rawline, $-[1], $+[1] - $-[1]);
5893 my $new = substr($old, 1, -1);
5894 if (WARN("PREFER_SECTION",
5895 "__section($new) is preferred over __attribute__((section($old)))\n" . $herecurr) &&
5897 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*_*section_*\s*\(\s*\Q$old\E\s*\)\s*\)\s*\)/__section($new)/;
5901 # Check for __attribute__ format(printf, prefer __printf
5902 if ($realfile !~ m@\binclude/uapi/@ &&
5903 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
5904 if (WARN("PREFER_PRINTF",
5905 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5907 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5912 # Check for __attribute__ format(scanf, prefer __scanf
5913 if ($realfile !~ m@\binclude/uapi/@ &&
5914 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
5915 if (WARN("PREFER_SCANF",
5916 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5918 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5922 # Check for __attribute__ weak, or __weak declarations (may have link issues)
5923 if ($perl_version_ok &&
5924 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5925 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5926 $line =~ /\b__weak\b/)) {
5927 ERROR("WEAK_DECLARATION",
5928 "Using weak declarations can have unintended link defects\n" . $herecurr);
5931 # check for c99 types like uint8_t used outside of uapi/ and tools/
5932 if ($realfile !~ m@\binclude/uapi/@ &&
5933 $realfile !~ m@\btools/@ &&
5934 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5936 if ($type =~ /\b($typeC99Typedefs)\b/) {
5938 my $kernel_type = 'u';
5939 $kernel_type = 's' if ($type =~ /^_*[si]/);
5942 if (CHK("PREFER_KERNEL_TYPES",
5943 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5945 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5950 # check for cast of C90 native int or longer types constants
5951 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5954 if (WARN("TYPECAST_INT_CONSTANT",
5955 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5958 my $newconst = $const;
5959 $newconst =~ s/${Int_type}$//;
5960 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5961 if ($cast =~ /\blong\s+long\b/) {
5963 } elsif ($cast =~ /\blong\b/) {
5966 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5970 # check for sizeof(&)
5971 if ($line =~ /\bsizeof\s*\(\s*\&/) {
5972 WARN("SIZEOF_ADDRESS",
5973 "sizeof(& should be avoided\n" . $herecurr);
5976 # check for sizeof without parenthesis
5977 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
5978 if (WARN("SIZEOF_PARENTHESIS",
5979 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5981 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5985 # check for struct spinlock declarations
5986 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5987 WARN("USE_SPINLOCK_T",
5988 "struct spinlock should be spinlock_t\n" . $herecurr);
5991 # check for seq_printf uses that could be seq_puts
5992 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
5993 my $fmt = get_quoted_string($line, $rawline);
5996 if (WARN("PREFER_SEQ_PUTS",
5997 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5999 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
6004 # check for vsprintf extension %p<foo> misuses
6005 if ($perl_version_ok &&
6007 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
6008 $1 !~ /^_*volatile_*$/) {
6011 my $lc = $stat =~ tr@\n@@;
6012 $lc = $lc + $linenr;
6013 for (my $count = $linenr; $count <= $lc; $count++) {
6016 my $bad_specifier = "";
6017 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
6020 while ($fmt =~ /(\%[\*\d\.]*p(\w))/g) {
6023 if ($extension !~ /[SsBKRraEhMmIiUDdgVCbGNOxt]/) {
6024 $bad_specifier = $specifier;
6027 if ($extension eq "x" && !defined($stat_real)) {
6028 if (!defined($stat_real)) {
6029 $stat_real = get_stat_real($linenr, $lc);
6031 WARN("VSPRINTF_SPECIFIER_PX",
6032 "Using vsprintf specifier '\%px' potentially exposes the kernel memory layout, if you don't really need the address please consider using '\%p'.\n" . "$here\n$stat_real\n");
6035 if ($bad_specifier ne "") {
6036 my $stat_real = get_stat_real($linenr, $lc);
6037 my $ext_type = "Invalid";
6039 if ($bad_specifier =~ /p[Ff]/) {
6040 $ext_type = "Deprecated";
6041 $use = " - use %pS instead";
6042 $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/);
6045 WARN("VSPRINTF_POINTER_EXTENSION",
6046 "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n");
6051 # Check for misused memsets
6052 if ($perl_version_ok &&
6054 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
6060 if ($ms_size =~ /^(0x|)0$/i) {
6062 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
6063 } elsif ($ms_size =~ /^(0x|)1$/i) {
6065 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
6069 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
6070 # if ($perl_version_ok &&
6072 # $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6073 # if (WARN("PREFER_ETHER_ADDR_COPY",
6074 # "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
6076 # $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
6080 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
6081 # if ($perl_version_ok &&
6083 # $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6084 # WARN("PREFER_ETHER_ADDR_EQUAL",
6085 # "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
6088 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
6089 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
6090 # if ($perl_version_ok &&
6092 # $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6096 # if ($ms_val =~ /^(?:0x|)0+$/i) {
6097 # if (WARN("PREFER_ETH_ZERO_ADDR",
6098 # "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6100 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
6102 # } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
6103 # if (WARN("PREFER_ETH_BROADCAST_ADDR",
6104 # "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
6106 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
6111 # typecasts on min/max could be min_t/max_t
6112 if ($perl_version_ok &&
6114 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
6115 if (defined $2 || defined $7) {
6117 my $cast1 = deparenthesize($2);
6119 my $cast2 = deparenthesize($7);
6123 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
6124 $cast = "$cast1 or $cast2";
6125 } elsif ($cast1 ne "") {
6131 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
6135 # check usleep_range arguments
6136 if ($perl_version_ok &&
6138 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
6142 WARN("USLEEP_RANGE",
6143 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
6144 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
6146 WARN("USLEEP_RANGE",
6147 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
6151 # check for naked sscanf
6152 if ($perl_version_ok &&
6154 $line =~ /\bsscanf\b/ &&
6155 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
6156 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
6157 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
6158 my $lc = $stat =~ tr@\n@@;
6159 $lc = $lc + $linenr;
6160 my $stat_real = get_stat_real($linenr, $lc);
6161 WARN("NAKED_SSCANF",
6162 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
6165 # check for simple sscanf that should be kstrto<foo>
6166 if ($perl_version_ok &&
6168 $line =~ /\bsscanf\b/) {
6169 my $lc = $stat =~ tr@\n@@;
6170 $lc = $lc + $linenr;
6171 my $stat_real = get_stat_real($linenr, $lc);
6172 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
6174 my $count = $format =~ tr@%@%@;
6176 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
6177 WARN("SSCANF_TO_KSTRTO",
6178 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
6183 # check for new externs in .h files.
6184 if ($realfile =~ /\.h$/ &&
6185 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
6186 if (CHK("AVOID_EXTERNS",
6187 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
6189 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
6193 # check for new externs in .c files.
6194 if ($realfile =~ /\.c$/ && defined $stat &&
6195 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
6197 my $function_name = $1;
6198 my $paren_space = $2;
6201 if (defined $cond) {
6202 substr($s, 0, length($cond), '');
6204 if ($s =~ /^\s*;/ &&
6205 $function_name ne 'uninitialized_var')
6207 WARN("AVOID_EXTERNS",
6208 "externs should be avoided in .c files\n" . $herecurr);
6211 if ($paren_space =~ /\n/) {
6212 WARN("FUNCTION_ARGUMENTS",
6213 "arguments for function declarations should follow identifier\n" . $herecurr);
6216 } elsif ($realfile =~ /\.c$/ && defined $stat &&
6217 $stat =~ /^.\s*extern\s+/)
6219 WARN("AVOID_EXTERNS",
6220 "externs should be avoided in .c files\n" . $herecurr);
6223 # check for function declarations that have arguments without identifier names
6224 if (defined $stat &&
6225 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
6227 my $args = trim($1);
6228 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
6230 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
6231 WARN("FUNCTION_ARGUMENTS",
6232 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
6237 # check for function definitions
6238 if ($perl_version_ok &&
6240 $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
6241 $context_function = $1;
6243 # check for multiline function definition with misplaced open brace
6245 my $cnt = statement_rawlines($stat);
6246 my $herectx = $here . "\n";
6247 for (my $n = 0; $n < $cnt; $n++) {
6248 my $rl = raw_line($linenr, $n);
6249 $herectx .= $rl . "\n";
6250 $ok = 1 if ($rl =~ /^[ \+]\{/);
6251 $ok = 1 if ($rl =~ /\{/ && $n == 0);
6252 last if $rl =~ /^[ \+].*\{/;
6256 "open brace '{' following function definitions go on the next line\n" . $herectx);
6260 # checks for new __setup's
6261 if ($rawline =~ /\b__setup\("([^"]*)"/) {
6264 if (!grep(/$name/, @setup_docs)) {
6265 CHK("UNDOCUMENTED_SETUP",
6266 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
6270 # check for pointless casting of alloc functions
6271 if ($line =~ /\*\s*\)\s*$allocFunctions\b/) {
6272 WARN("UNNECESSARY_CASTS",
6273 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
6277 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6278 if ($perl_version_ok &&
6279 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6280 CHK("ALLOC_SIZEOF_STRUCT",
6281 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
6284 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6285 if ($perl_version_ok &&
6287 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
6291 my $newfunc = "kmalloc_array";
6292 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
6295 if ($a1 =~ /^sizeof\s*\S/) {
6299 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
6300 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
6301 my $cnt = statement_rawlines($stat);
6302 my $herectx = get_stat_here($linenr, $cnt, $here);
6304 if (WARN("ALLOC_WITH_MULTIPLY",
6305 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
6308 $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;
6313 # check for krealloc arg reuse
6314 if ($perl_version_ok &&
6315 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ &&
6317 WARN("KREALLOC_ARG_REUSE",
6318 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
6321 # check for alloc argument mismatch
6322 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
6323 WARN("ALLOC_ARRAY_ARGS",
6324 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
6327 # check for multiple semicolons
6328 if ($line =~ /;\s*;\s*$/) {
6329 if (WARN("ONE_SEMICOLON",
6330 "Statements terminations use 1 semicolon\n" . $herecurr) &&
6332 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
6336 # check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6337 if ($realfile !~ m@^include/uapi/@ &&
6338 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
6340 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
6341 if (CHK("BIT_MACRO",
6342 "Prefer using the BIT$ull macro\n" . $herecurr) &&
6344 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
6348 # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6349 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6351 if (WARN("PREFER_IS_ENABLED",
6352 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
6354 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
6358 # check for case / default statements not preceded by break/fallthrough/switch
6359 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
6361 my $has_statement = 0;
6363 my $prevline = $linenr;
6364 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
6366 my $rline = $rawlines[$prevline - 1];
6367 my $fline = $lines[$prevline - 1];
6368 last if ($fline =~ /^\@\@/);
6369 next if ($fline =~ /^\-/);
6370 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
6371 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
6372 next if ($fline =~ /^.[\s$;]*$/);
6375 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/);
6377 if (!$has_break && $has_statement) {
6378 WARN("MISSING_BREAK",
6379 "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr);
6383 # check for switch/default statements without a break;
6384 if ($perl_version_ok &&
6386 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
6387 my $cnt = statement_rawlines($stat);
6388 my $herectx = get_stat_here($linenr, $cnt, $here);
6390 WARN("DEFAULT_NO_BREAK",
6391 "switch default: should use break\n" . $herectx);
6394 # check for gcc specific __FUNCTION__
6395 if ($line =~ /\b__FUNCTION__\b/) {
6396 if (WARN("USE_FUNC",
6397 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
6399 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
6403 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
6404 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
6406 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
6409 # check for use of yield()
6410 if ($line =~ /\byield\s*\(\s*\)/) {
6412 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
6415 # check for comparisons against true and false
6416 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6424 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6426 my $type = lc($otype);
6427 if ($type =~ /^(?:true|false)$/) {
6428 if (("$test" eq "==" && "$type" eq "true") ||
6429 ("$test" eq "!=" && "$type" eq "false")) {
6433 CHK("BOOL_COMPARISON",
6434 "Using comparison to $otype is error prone\n" . $herecurr);
6436 ## maybe suggesting a correct construct would better
6437 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6442 # check for semaphores initialized locked
6443 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
6444 WARN("CONSIDER_COMPLETION",
6445 "consider using a completion\n" . $herecurr);
6448 # recommend kstrto* over simple_strto* and strict_strto*
6449 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
6450 WARN("CONSIDER_KSTRTO",
6451 "$1 is obsolete, use k$3 instead\n" . $herecurr);
6454 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
6455 if ($line =~ /^.\s*__initcall\s*\(/) {
6456 WARN("USE_DEVICE_INITCALL",
6457 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
6460 # check for spin_is_locked(), suggest lockdep instead
6461 if ($line =~ /\bspin_is_locked\(/) {
6463 "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr);
6466 # check for deprecated apis
6467 if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) {
6468 my $deprecated_api = $1;
6469 my $new_api = $deprecated_apis{$deprecated_api};
6470 WARN("DEPRECATED_API",
6471 "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr);
6474 # check for various structs that are normally const (ops, kgdb, device_tree)
6475 # and avoid what seem like struct definitions 'struct foo {'
6476 if ($line !~ /\bconst\b/ &&
6477 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
6478 WARN("CONST_STRUCT",
6479 "struct $1 should normally be const\n" . $herecurr);
6482 # use of NR_CPUS is usually wrong
6483 # ignore definitions of NR_CPUS and usage to define arrays as likely right
6484 if ($line =~ /\bNR_CPUS\b/ &&
6485 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6486 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
6487 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6488 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6489 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
6492 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
6495 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6496 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6497 ERROR("DEFINE_ARCH_HAS",
6498 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6501 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
6502 if ($perl_version_ok &&
6503 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6504 WARN("LIKELY_MISUSE",
6505 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6508 # whine mightly about in_atomic
6509 if ($line =~ /\bin_atomic\s*\(/) {
6510 if ($realfile =~ m@^drivers/@) {
6512 "do not use in_atomic in drivers\n" . $herecurr);
6513 } elsif ($realfile !~ m@^kernel/@) {
6515 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
6519 # check for mutex_trylock_recursive usage
6520 if ($line =~ /mutex_trylock_recursive/) {
6522 "recursive locking is bad, do not use this ever.\n" . $herecurr);
6525 # check for lockdep_set_novalidate_class
6526 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6527 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6528 if ($realfile !~ m@^kernel/lockdep@ &&
6529 $realfile !~ m@^include/linux/lockdep@ &&
6530 $realfile !~ m@^drivers/base/core@) {
6532 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
6536 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6537 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
6538 WARN("EXPORTED_WORLD_WRITABLE",
6539 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6542 # check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6543 # and whether or not function naming is typical and if
6544 # DEVICE_ATTR permissions uses are unusual too
6545 if ($perl_version_ok &&
6547 $stat =~ /\bDEVICE_ATTR\s*\(\s*(\w+)\s*,\s*\(?\s*(\s*(?:${multi_mode_perms_string_search}|0[0-7]{3,3})\s*)\s*\)?\s*,\s*(\w+)\s*,\s*(\w+)\s*\)/) {
6552 my $octal_perms = perms_to_octal($perms);
6553 if ($show =~ /^${var}_show$/ &&
6554 $store =~ /^${var}_store$/ &&
6555 $octal_perms eq "0644") {
6556 if (WARN("DEVICE_ATTR_RW",
6557 "Use DEVICE_ATTR_RW\n" . $herecurr) &&
6559 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6561 } elsif ($show =~ /^${var}_show$/ &&
6562 $store =~ /^NULL$/ &&
6563 $octal_perms eq "0444") {
6564 if (WARN("DEVICE_ATTR_RO",
6565 "Use DEVICE_ATTR_RO\n" . $herecurr) &&
6567 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6569 } elsif ($show =~ /^NULL$/ &&
6570 $store =~ /^${var}_store$/ &&
6571 $octal_perms eq "0200") {
6572 if (WARN("DEVICE_ATTR_WO",
6573 "Use DEVICE_ATTR_WO\n" . $herecurr) &&
6575 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6577 } elsif ($octal_perms eq "0644" ||
6578 $octal_perms eq "0444" ||
6579 $octal_perms eq "0200") {
6580 my $newshow = "$show";
6581 $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show");
6582 my $newstore = $store;
6583 $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store");
6585 if ($show ne $newshow) {
6586 $rename .= " '$show' to '$newshow'";
6588 if ($store ne $newstore) {
6589 $rename .= " '$store' to '$newstore'";
6591 WARN("DEVICE_ATTR_FUNCTIONS",
6592 "Consider renaming function(s)$rename\n" . $herecurr);
6594 WARN("DEVICE_ATTR_PERMS",
6595 "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr);
6599 # Mode permission misuses where it seems decimal should be octal
6600 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6601 # o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6602 # specific definition of not visible in sysfs.
6603 # o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6604 # use the default permissions
6605 if ($perl_version_ok &&
6607 $line =~ /$mode_perms_search/) {
6608 foreach my $entry (@mode_permission_funcs) {
6609 my $func = $entry->[0];
6610 my $arg_pos = $entry->[1];
6612 my $lc = $stat =~ tr@\n@@;
6613 $lc = $lc + $linenr;
6614 my $stat_real = get_stat_real($linenr, $lc);
6619 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6621 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
6622 if ($stat =~ /$test/) {
6624 $val = $6 if ($skip_args ne "");
6625 if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
6626 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6627 ($val =~ /^$Octal$/ && length($val) ne 4))) {
6628 ERROR("NON_OCTAL_PERMISSIONS",
6629 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
6631 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
6632 ERROR("EXPORTED_WORLD_WRITABLE",
6633 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
6639 # check for uses of S_<PERMS> that could be octal for readability
6640 while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) {
6642 my $octal = perms_to_octal($oval);
6643 if (WARN("SYMBOLIC_PERMS",
6644 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6646 $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
6650 # validate content of MODULE_LICENSE against list from include/linux/module.h
6651 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6652 my $extracted_string = get_quoted_string($line, $rawline);
6653 my $valid_licenses = qr{
6656 GPL\ and\ additional\ rights|
6662 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6663 WARN("MODULE_LICENSE",
6664 "unknown module license " . $extracted_string . "\n" . $herecurr);
6668 # check for sysctl duplicate constants
6669 if ($line =~ /\.extra[12]\s*=\s*&(zero|one|int_max)\b/) {
6670 WARN("DUPLICATED_SYSCTL_CONST",
6671 "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr);
6675 # If we have no input at all, then there is nothing to report on
6676 # so just keep quiet.
6677 if ($#rawlines == -1) {
6681 # In mailback mode only produce a report in the negative, for
6682 # things that appear to be patches.
6683 if ($mailback && ($clean == 1 || !$is_patch)) {
6687 # This is not a patch, and we are are in 'no-patch' mode so
6689 if (!$chk_patch && !$is_patch) {
6693 if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
6694 ERROR("NOT_UNIFIED_DIFF",
6695 "Does not appear to be a unified-diff format patch\n");
6697 if ($is_patch && $has_commit_log && $chk_signoff) {
6698 if ($signoff == 0) {
6699 ERROR("MISSING_SIGN_OFF",
6700 "Missing Signed-off-by: line(s)\n");
6701 } elsif (!$authorsignoff) {
6702 WARN("NO_AUTHOR_SIGN_OFF",
6703 "Missing Signed-off-by: line by nominal patch author '$author'\n");
6707 print report_dump();
6708 if ($summary && !($clean == 1 && $quiet == 1)) {
6709 print "$filename " if ($summary_file);
6710 print "total: $cnt_error errors, $cnt_warn warnings, " .
6711 (($check)? "$cnt_chk checks, " : "") .
6712 "$cnt_lines lines checked\n";
6716 # If there were any defects found and not already fixing them
6717 if (!$clean and !$fix) {
6720 NOTE: For some of the reported defects, checkpatch may be able to
6721 mechanically convert to the typical style using --fix or --fix-inplace.
6724 # If there were whitespace errors which cleanpatch can fix
6725 # then suggest that.
6726 if ($rpt_cleaners) {
6730 NOTE: Whitespace errors detected.
6731 You may wish to use scripts/cleanpatch or scripts/cleanfile
6736 if ($clean == 0 && $fix &&
6737 ("@rawlines" ne "@fixed" ||
6738 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
6739 my $newfile = $filename;
6740 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
6744 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6746 open($f, '>', $newfile)
6747 or die "$P: Can't open $newfile for write\n";
6748 foreach my $fixed_line (@fixed) {
6751 if ($linecount > 3) {
6752 $fixed_line =~ s/^\+//;
6753 print $f $fixed_line . "\n";
6756 print $f $fixed_line . "\n";
6764 Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6766 Do _NOT_ trust the results written to this file.
6767 Do _NOT_ submit these changes without inspecting them for correctness.
6769 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6770 No warranties, expressed or implied...
6778 print "$vname has no obvious style problems and is ready for submission.\n";
6780 print "$vname has style problems, please review.\n";