2 # SPDX-License-Identifier: GPL-2.0
4 # (c) 2001, Dave Jones. (the file handling bit)
5 # (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
6 # (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
7 # (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
8 # (c) 2010-2018 Joe Perches <joe@perches.com>
15 use Term
::ANSIColor
qw(:constants);
16 use Encode
qw(decode encode);
19 my $D = dirname
(abs_path
($P));
23 use Getopt
::Long
qw(:config no_auto_abbrev);
53 my $configuration_file = ".checkpatch.conf";
54 my $max_line_length = 80;
55 my $ignore_perl_version = 0;
56 my $minimum_perl_version = 5.10.0;
57 my $min_conf_desc_length = 4;
58 my $spelling_file = "$D/spelling.txt";
60 my $codespellfile = "/usr/share/codespell/dictionary.txt";
61 my $conststructsfile = "$D/const_structs.checkpatch";
62 my $typedefsfile = "";
64 my $allow_c99_comments = 1;
70 Usage
: $P [OPTION
]... [FILE
]...
75 --no-tree run without a kernel tree
76 --no-signoff
do not check
for 'Signed-off-by' line
77 --patch treat FILE as patchfile
(default)
78 --emacs emacs compile window format
79 --terse one line per report
80 --showfile emit diffed file position
, not input file position
81 -g
, --git treat FILE as a single commit
or git revision range
82 single git commit with
:
86 multiple git commits with
:
90 git merges are ignored
91 -f
, --file treat FILE as regular source file
92 --subjective
, --strict enable more subjective tests
93 --list-types list the possible message types
94 --types TYPE
(,TYPE2
...) show only these comma separated message types
95 --ignore TYPE
(,TYPE2
...) ignore various comma separated message types
96 --show-types show the specific message type
in the output
97 --max-line-length
=n set the maximum line
length, if exceeded
, warn
98 --min-conf-desc-length
=n set the min description
length, if shorter
, warn
99 --root
=PATH PATH to the kernel tree root
100 --no-summary suppress the per-file summary
101 --mailback only produce a report
in case of warnings
/errors
102 --summary-file include the filename
in summary
103 --debug KEY
=[0|1] turn on
/off debugging of KEY
, where KEY
is one of
104 'values', 'possible', 'type', and 'attr' (default
106 --test-only
=WORD report only warnings
/errors containing WORD
108 --fix EXPERIMENTAL
- may create horrible results
109 If correctable single-line errors exist
, create
110 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
111 with potential errors corrected to the preferred
113 --fix-inplace EXPERIMENTAL
- may create horrible results
114 Is the same as
--fix
, but overwrites the input
115 file
. It
's your fault if there's
no backup
or git
116 --ignore-perl-version override checking of perl version
. expect
118 --codespell Use the codespell dictionary
for spelling
/typos
119 (default:/usr/share
/codespell/dictionary
.txt
)
120 --codespellfile Use this codespell dictionary
121 --typedefsfile Read additional types from this file
122 --color
[=WHEN
] Use colors
'always', 'never', or only
when output
123 is a terminal
('auto'). Default
is 'auto'.
124 -h
, --help
, --version display this help
and exit
126 When FILE
is - read standard input
.
134 return grep { !$seen{$_}++ } @_;
144 open(my $script, '<', abs_path
($P)) or
145 die "$P: Can't read '$P' $!\n";
147 my $text = <$script>;
151 # Also catch when type or level is passed through a variable
152 for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
155 @types = sort(uniq
(@types));
156 print("#\tMessage type\n\n");
157 foreach my $type (@types) {
158 print(++$count . "\t" . $type . "\n");
164 my $conf = which_conf
($configuration_file);
167 open(my $conffile, '<', "$conf")
168 or warn "$P: Can't find a readable $configuration_file file $!\n";
170 while (<$conffile>) {
173 $line =~ s/\s*\n?$//g;
177 next if ($line =~ m/^\s*#/);
178 next if ($line =~ m/^\s*$/);
180 my @words = split(" ", $line);
181 foreach my $word (@words) {
182 last if ($word =~ m/^#/);
183 push (@conf_args, $word);
187 unshift(@ARGV, @conf_args) if @conf_args;
190 # Perl's Getopt::Long allows options to take optional arguments after a space.
191 # Prevent --color by itself from consuming other arguments
193 if ($_ eq "--color" || $_ eq "-color") {
194 $_ = "--color=$color";
199 'q|quiet+' => \
$quiet,
201 'signoff!' => \
$chk_signoff,
202 'patch!' => \
$chk_patch,
205 'showfile!' => \
$showfile,
208 'subjective!' => \
$check,
209 'strict!' => \
$check,
210 'ignore=s' => \
@ignore,
212 'show-types!' => \
$show_types,
213 'list-types!' => \
$list_types,
214 'max-line-length=i' => \
$max_line_length,
215 'min-conf-desc-length=i' => \
$min_conf_desc_length,
217 'summary!' => \
$summary,
218 'mailback!' => \
$mailback,
219 'summary-file!' => \
$summary_file,
221 'fix-inplace!' => \
$fix_inplace,
222 'ignore-perl-version!' => \
$ignore_perl_version,
223 'debug=s' => \
%debug,
224 'test-only=s' => \
$tst_only,
225 'codespell!' => \
$codespell,
226 'codespellfile=s' => \
$codespellfile,
227 'typedefsfile=s' => \
$typedefsfile,
228 'color=s' => \
$color,
229 'no-color' => \
$color, #keep old behaviors of -nocolor
230 'nocolor' => \
$color, #keep old behaviors of -nocolor
237 list_types
(0) if ($list_types);
239 $fix = 1 if ($fix_inplace);
240 $check_orig = $check;
244 my $perl_version_ok = 1;
245 if ($^V && $^V lt $minimum_perl_version) {
246 $perl_version_ok = 0;
247 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
248 exit(1) if (!$ignore_perl_version);
251 #if no filenames are given, push '-' to read patch from stdin
256 if ($color =~ /^[01]$/) {
258 } elsif ($color =~ /^always$/i) {
260 } elsif ($color =~ /^never$/i) {
262 } elsif ($color =~ /^auto$/i) {
263 $color = (-t STDOUT
);
265 die "Invalid color mode: $color\n";
268 sub hash_save_array_words
{
269 my ($hashRef, $arrayRef) = @_;
271 my @array = split(/,/, join(',', @$arrayRef));
272 foreach my $word (@array) {
273 $word =~ s/\s*\n?$//g;
276 $word =~ tr/[a-z]/[A-Z]/;
278 next if ($word =~ m/^\s*#/);
279 next if ($word =~ m/^\s*$/);
285 sub hash_show_words
{
286 my ($hashRef, $prefix) = @_;
288 if (keys %$hashRef) {
289 print "\nNOTE: $prefix message types:";
290 foreach my $word (sort keys %$hashRef) {
297 hash_save_array_words
(\
%ignore_type, \
@ignore);
298 hash_save_array_words
(\
%use_type, \
@use);
301 my $dbg_possible = 0;
304 for my $key (keys %debug) {
306 eval "\${dbg_$key} = '$debug{$key}';";
310 my $rpt_cleaners = 0;
319 if (!top_of_kernel_tree
($root)) {
320 die "$P: $root: --root does not point at a valid tree\n";
323 if (top_of_kernel_tree
('.')) {
325 } elsif ($0 =~ m
@(.*)/scripts/[^/]*$@ &&
326 top_of_kernel_tree
($1)) {
331 if (!defined $root) {
332 print "Must be run from the top-level dir. of a kernel tree\n";
337 my $emitted_corrupt = 0;
340 [A-Za-z_
][A-Za-z\d_
]*
341 (?
:\s
*\#\#\s
*[A-Za-z_
][A-Za-z\d_
]*)*
343 our $Storage = qr{extern|static|asmlinkage};
357 our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
358 our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
359 our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
360 our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
361 our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
363 # Notes to $Attribute:
364 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
385 ____cacheline_aligned
|
386 ____cacheline_aligned_in_smp
|
387 ____cacheline_internodealigned_in_smp
|
391 our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
392 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
393 our $Lval = qr{$Ident(?:$Member)*};
395 our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
396 our $Binary = qr{(?i)0b[01]+$Int_type?};
397 our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
398 our $Int = qr{[0-9]+$Int_type?};
399 our $Octal = qr{0[0-7]+$Int_type?};
400 our $String = qr{"[X\t]*"};
401 our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
402 our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
403 our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
404 our $Float = qr{$Float_hex|$Float_dec|$Float_int};
405 our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
406 our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
407 our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
408 our $Arithmetic = qr{\+|-|\*|\/|%};
412 &&|\
|\
||,|\
^|\
+\
+|--|&|\
||$Arithmetic
415 our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
419 our $NonptrTypeMisordered;
420 our $NonptrTypeWithAttr;
424 our $DeclareMisordered;
426 our $NON_ASCII_UTF8 = qr{
427 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
428 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
429 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
430 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
431 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
432 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
433 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
437 [\x09\x0A\x0D\x20-\x7E] # ASCII
441 our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
442 our $typeOtherOSTypedefs = qr{(?x
:
443 u_
(?
:char
|short
|int|long
) | # bsd
444 u
(?
:nchar
|short
|int|long
) # sysv
446 our $typeKernelTypedefs = qr{(?x
:
447 (?
:__
)?
(?
:u
|s
|be
|le)(?
:8|16|32|64)|
450 our $typeTypedefs = qr{(?x
:
452 $typeOtherOSTypedefs\b|
453 $typeKernelTypedefs\b
456 our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
458 our $logFunctions = qr{(?x
:
459 printk
(?
:_ratelimited
|_once
|_deferred_once
|_deferred
|)|
460 (?
:[a-z0-9
]+_
){1,2}(?
:printk
|emerg
|alert
|crit
|err
|warning
|warn|notice
|info
|debug
|dbg
|vdbg
|devel
|cont
|WARN
)(?
:_ratelimited
|_once
|)|
462 WARN
(?
:_RATELIMIT
|_ONCE
|)|
465 seq_vprintf
|seq_printf
|seq_puts
468 our $signature_tags = qr{(?xi
:
479 our @typeListMisordered = (
480 qr{char\s+(?:un)?signed},
481 qr{int\s+(?:(?:un)?signed\s+)?short\s},
482 qr{int\s+short(?:\s+(?:un)?signed)},
483 qr{short\s+int(?:\s+(?:un)?signed)},
484 qr{(?:un)?signed\s+int\s+short},
485 qr{short\s+(?:un)?signed},
486 qr{long\s+int\s+(?:un)?signed},
487 qr{int\s+long\s+(?:un)?signed},
488 qr{long\s+(?:un)?signed\s+int},
489 qr{int\s+(?:un)?signed\s+long},
490 qr{int\s+(?:un)?signed},
491 qr{int\s+long\s+long\s+(?:un)?signed},
492 qr{long\s+long\s+int\s+(?:un)?signed},
493 qr{long\s+long\s+(?:un)?signed\s+int},
494 qr{long\s+long\s+(?:un)?signed},
495 qr{long\s+(?:un)?signed},
500 qr{(?:(?:un)?signed\s+)?char},
501 qr{(?:(?:un)?signed\s+)?short\s+int},
502 qr{(?:(?:un)?signed\s+)?short},
503 qr{(?:(?:un)?signed\s+)?int},
504 qr{(?:(?:un)?signed\s+)?long\s+int},
505 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
506 qr{(?:(?:un)?signed\s+)?long\s+long},
507 qr{(?:(?:un)?signed\s+)?long},
516 qr{${Ident}_handler
},
517 qr{${Ident}_handler_fn
},
521 our $C90_int_types = qr{(?x
:
522 long\s
+long\s
+int\s
+(?
:un
)?signed
|
523 long\s
+long\s
+(?
:un
)?signed\s
+int|
524 long\s
+long\s
+(?
:un
)?signed
|
525 (?
:(?
:un
)?signed\s
+)?long\s
+long\s
+int|
526 (?
:(?
:un
)?signed\s
+)?long\s
+long
|
527 int\s
+long\s
+long\s
+(?
:un
)?signed
|
528 int\s
+(?
:(?
:un
)?signed\s
+)?long\s
+long
|
530 long\s
+int\s
+(?
:un
)?signed
|
531 long\s
+(?
:un
)?signed\s
+int|
532 long\s
+(?
:un
)?signed
|
533 (?
:(?
:un
)?signed\s
+)?long\s
+int|
534 (?
:(?
:un
)?signed\s
+)?long
|
535 int\s
+long\s
+(?
:un
)?signed
|
536 int\s
+(?
:(?
:un
)?signed\s
+)?long
|
539 (?
:(?
:un
)?signed\s
+)?
int
542 our @typeListFile = ();
543 our @typeListWithAttr = (
545 qr{struct\s+$InitAttribute\s+$Ident},
546 qr{union\s+$InitAttribute\s+$Ident},
549 our @modifierList = (
552 our @modifierListFile = ();
554 our @mode_permission_funcs = (
556 ["module_param_(?:array|named|string)", 4],
557 ["module_param_array_named", 5],
558 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
559 ["proc_create(?:_data|)", 2],
560 ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2],
561 ["IIO_DEV_ATTR_[A-Z_]+", 1],
562 ["SENSOR_(?:DEVICE_|)ATTR_2", 2],
563 ["SENSOR_TEMPLATE(?:_2|)", 3],
567 #Create a search pattern for all these functions to speed up a loop below
568 our $mode_perms_search = "";
569 foreach my $entry (@mode_permission_funcs) {
570 $mode_perms_search .= '|' if ($mode_perms_search ne "");
571 $mode_perms_search .= $entry->[0];
573 $mode_perms_search = "(?:${mode_perms_search})";
575 our $mode_perms_world_writable = qr{
583 our %mode_permission_string_types = (
602 #Create a search pattern for all these strings to speed up a loop below
603 our $mode_perms_string_search = "";
604 foreach my $entry (keys %mode_permission_string_types) {
605 $mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
606 $mode_perms_string_search .= $entry;
608 our $single_mode_perms_string_search = "(?:${mode_perms_string_search})";
609 our $multi_mode_perms_string_search = qr{
610 ${single_mode_perms_string_search
}
611 (?
:\s
*\
|\s
*${single_mode_perms_string_search
})*
617 return trim
($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/);
624 while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
625 $curpos = pos($string);
628 last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
630 $to |= $mode_permission_string_types{$match};
631 $val .= '\s*\|\s*' if ($val ne "");
635 $oval =~ s/^\s*\|\s*//;
636 $oval =~ s/\s*\|\s*$//;
637 return sprintf("%04o", $to);
640 our $allowed_asm_includes = qr{(?x
:
646 # memory.h: ARM has a custom one
648 # Load common spelling mistakes and build regular expression list.
652 if (open(my $spelling, '<', $spelling_file)) {
653 while (<$spelling>) {
656 $line =~ s/\s*\n?$//g;
659 next if ($line =~ m/^\s*#/);
660 next if ($line =~ m/^\s*$/);
662 my ($suspect, $fix) = split(/\|\|/, $line);
664 $spelling_fix{$suspect} = $fix;
668 warn "No typos will be found - file '$spelling_file': $!\n";
672 if (open(my $spelling, '<', $codespellfile)) {
673 while (<$spelling>) {
676 $line =~ s/\s*\n?$//g;
679 next if ($line =~ m/^\s*#/);
680 next if ($line =~ m/^\s*$/);
681 next if ($line =~ m/, disabled/i);
685 my ($suspect, $fix) = split(/->/, $line);
687 $spelling_fix{$suspect} = $fix;
691 warn "No codespell typos will be found - file '$codespellfile': $!\n";
695 $misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
698 my ($wordsRef, $file) = @_;
700 if (open(my $words, '<', $file)) {
704 $line =~ s/\s*\n?$//g;
707 next if ($line =~ m/^\s*#/);
708 next if ($line =~ m/^\s*$/);
710 print("$file: '$line' invalid - ignored\n");
714 $$wordsRef .= '|' if ($$wordsRef ne "");
724 my $const_structs = "";
725 read_words
(\
$const_structs, $conststructsfile)
726 or warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
728 my $typeOtherTypedefs = "";
729 if (length($typedefsfile)) {
730 read_words
(\
$typeOtherTypedefs, $typedefsfile)
731 or warn "No additional types will be considered - file '$typedefsfile': $!\n";
733 $typeTypedefs .= '|' . $typeOtherTypedefs if ($typeOtherTypedefs ne "");
736 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
737 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
738 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
739 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
740 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
746 (?
:$Modifier\s+|const\s
+)*
748 (?
:typeof
|__typeof__
)\s
*\
([^\
)]*\
)|
752 (?
:\s
+$Modifier|\s
+const
)*
754 $NonptrTypeMisordered = qr{
755 (?
:$Modifier\s+|const\s
+)*
759 (?
:\s
+$Modifier|\s
+const
)*
761 $NonptrTypeWithAttr = qr{
762 (?
:$Modifier\s+|const\s
+)*
764 (?
:typeof
|__typeof__
)\s
*\
([^\
)]*\
)|
768 (?
:\s
+$Modifier|\s
+const
)*
772 (?
:(?
:\s
|\
*|\
[\
])+\s
*const
|(?
:\s
|\
*\s
*(?
:const\s
*)?
|\
[\
])+|(?
:\s
*\
[\s
*\
])+)?
773 (?
:\s
+$Inline|\s
+$Modifier)*
775 $TypeMisordered = qr{
776 $NonptrTypeMisordered
777 (?
:(?
:\s
|\
*|\
[\
])+\s
*const
|(?
:\s
|\
*\s
*(?
:const\s
*)?
|\
[\
])+|(?
:\s
*\
[\s
*\
])+)?
778 (?
:\s
+$Inline|\s
+$Modifier)*
780 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
781 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
785 our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s
*};
787 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
788 # requires at least perl version v5.10.0
789 # Any use must be runtime checked with $^V
791 our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
792 our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s
*};
793 our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
795 our $declaration_macros = qr{(?x
:
796 (?
:$Storage\s+)?
(?
:[A-Z_
][A-Z0-9
]*_
){0,2}(?
:DEFINE
|DECLARE
)(?
:_
[A-Z0-9
]+){1,6}\s
*\
(|
797 (?
:$Storage\s+)?
[HLP
]?LIST_HEAD\s
*\
(|
798 (?
:$Storage\s+)?
${Type
}\s
+uninitialized_var\s
*\
(|
799 (?
:SKCIPHER_REQUEST
|SHASH_DESC
|AHASH_REQUEST
)_ON_STACK\s
*\
(
804 return "" if (!defined($string));
806 while ($string =~ /^\s*\(.*\)\s*$/) {
807 $string =~ s
@^\s*\(\s
*@@;
808 $string =~ s
@\s*\)\s
*$@@;
811 $string =~ s
@\s+@ @g;
816 sub seed_camelcase_file
{
819 return if (!(-f
$file));
823 open(my $include_file, '<', "$file")
824 or warn "$P: Can't read '$file' $!\n";
825 my $text = <$include_file>;
826 close($include_file);
828 my @lines = split('\n', $text);
830 foreach my $line (@lines) {
831 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
832 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
834 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
836 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
842 sub is_maintained_obsolete
{
845 return 0 if (!$tree || !(-e
"$root/scripts/get_maintainer.pl"));
847 my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
849 return $status =~ /obsolete/i;
852 sub is_SPDX_License_valid
{
855 return 1 if (!$tree || which
("python") eq "" || !(-e
"$root/scripts/spdxcheck.py") || !(-e
"$root/.git"));
857 my $root_path = abs_path
($root);
858 my $status = `cd "$root_path"; echo "$license" | python scripts/spdxcheck.py -`;
859 return 0 if ($status ne "");
863 my $camelcase_seeded = 0;
864 sub seed_camelcase_includes
{
865 return if ($camelcase_seeded);
868 my $camelcase_cache = "";
869 my @include_files = ();
871 $camelcase_seeded = 1;
874 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
875 chomp $git_last_include_commit;
876 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
878 my $last_mod_date = 0;
879 $files = `find $root/include -name "*.h"`;
880 @include_files = split('\n', $files);
881 foreach my $file (@include_files) {
882 my $date = POSIX
::strftime
("%Y%m%d%H%M",
883 localtime((stat $file)[9]));
884 $last_mod_date = $date if ($last_mod_date < $date);
886 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
889 if ($camelcase_cache ne "" && -f
$camelcase_cache) {
890 open(my $camelcase_file, '<', "$camelcase_cache")
891 or warn "$P: Can't read '$camelcase_cache' $!\n";
892 while (<$camelcase_file>) {
896 close($camelcase_file);
902 $files = `git ls-files "include/*.h"`;
903 @include_files = split('\n', $files);
906 foreach my $file (@include_files) {
907 seed_camelcase_file
($file);
910 if ($camelcase_cache ne "") {
911 unlink glob ".checkpatch-camelcase.*";
912 open(my $camelcase_file, '>', "$camelcase_cache")
913 or warn "$P: Can't write '$camelcase_cache' $!\n";
914 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
915 print $camelcase_file ("$_\n");
917 close($camelcase_file);
921 sub git_commit_info
{
922 my ($commit, $id, $desc) = @_;
924 return ($id, $desc) if ((which
("git") eq "") || !(-e
".git"));
926 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
927 $output =~ s/^\s*//gm;
928 my @lines = split("\n", $output);
930 return ($id, $desc) if ($#lines < 0);
932 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
933 # Maybe one day convert this block of bash into something that returns
934 # all matching commit ids, but it's very slow...
936 # echo "checking commits $1..."
937 # git rev-list --remotes | grep -i "^$1" |
938 # while read line ; do
939 # git log --format='%H %s' -1 $line |
940 # echo "commit $(cut -c 1-12,41-)"
942 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
945 $id = substr($lines[0], 0, 12);
946 $desc = substr($lines[0], 41);
952 $chk_signoff = 0 if ($file);
957 my @fixed_inserted = ();
958 my @fixed_deleted = ();
961 # If input is git commits, extract all commits from the commit expressions.
962 # For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
963 die "$P: No git repository found\n" if ($git && !-e
".git");
967 foreach my $commit_expr (@ARGV) {
969 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
970 $git_range = "-$2 $1";
971 } elsif ($commit_expr =~ m/\.\./) {
972 $git_range = "$commit_expr";
974 $git_range = "-1 $commit_expr";
976 my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
977 foreach my $line (split(/\n/, $lines)) {
978 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
979 next if (!defined($1) || !defined($2));
982 unshift(@commits, $sha1);
983 $git_commits{$sha1} = $subject;
986 die "$P: no git commits after extraction!\n" if (@commits == 0);
991 for my $filename (@ARGV) {
994 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
995 die "$P: $filename: git format-patch failed - $!\n";
997 open($FILE, '-|', "diff -u /dev/null $filename") ||
998 die "$P: $filename: diff failed - $!\n";
999 } elsif ($filename eq '-') {
1000 open($FILE, '<&STDIN');
1002 open($FILE, '<', "$filename") ||
1003 die "$P: $filename: open failed - $!\n";
1005 if ($filename eq '-') {
1006 $vname = 'Your patch';
1008 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
1014 push(@rawlines, $_);
1018 if ($#ARGV > 0 && $quiet == 0) {
1019 print '-' x length($vname) . "\n";
1021 print '-' x length($vname) . "\n";
1024 if (!process($filename)) {
1030 @fixed_inserted = ();
1031 @fixed_deleted = ();
1033 @modifierListFile = ();
1039 hash_show_words(\%use_type, "Used");
1040 hash_show_words(\%ignore_type, "Ignored");
1042 if (!$perl_version_ok) {
1045 NOTE: perl $^V is not modern enough to detect all possible issues.
1046 An upgrade to at least perl $minimum_perl_version is suggested.
1052 NOTE: If any of the errors are false positives, please report
1053 them to the maintainer, see CHECKPATCH in MAINTAINERS.
1060 sub top_of_kernel_tree {
1064 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
1065 "README", "Documentation", "arch", "include", "drivers",
1066 "fs", "init", "ipc", "kernel", "lib", "scripts",
1069 foreach my $check (@tree_check) {
1070 if (! -e $root . '/' . $check) {
1078 my ($formatted_email) = @_;
1084 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
1087 $comment = $3 if defined $3;
1088 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
1090 $comment = $2 if defined $2;
1091 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
1093 $comment = $2 if defined $2;
1094 $formatted_email =~ s/\Q$address\E.*$//;
1095 $name = $formatted_email;
1096 $name = trim($name);
1097 $name =~ s/^\"|\"$//g;
1098 # If there's a name left after stripping spaces and
1099 # leading quotes, and the address doesn't have both
1100 # leading and trailing angle brackets, the address
1102 # "joe smith joe@smith.com" bad
1103 # "joe smith <joe@smith.com" bad
1104 if ($name ne "" && $address !~ /^<[^>]+>$/) {
1111 $name = trim($name);
1112 $name =~ s/^\"|\"$//g;
1113 $address = trim($address);
1114 $address =~ s/^\<|\>$//g;
1116 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1117 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1118 $name = "\"$name\"";
1121 return ($name, $address, $comment);
1125 my ($name, $address) = @_;
1127 my $formatted_email;
1129 $name = trim($name);
1130 $name =~ s/^\"|\"$//g;
1131 $address = trim($address);
1133 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1134 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1135 $name = "\"$name\"";
1138 if ("$name" eq "") {
1139 $formatted_email = "$address";
1141 $formatted_email = "$name <$address>";
1144 return $formatted_email;
1150 foreach my $path (split(/:/, $ENV{PATH})) {
1151 if (-e "$path/$bin") {
1152 return "$path/$bin";
1162 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1163 if (-e "$path/$conf") {
1164 return "$path/$conf";
1176 for my $c (split(//, $str)) {
1180 for (; ($n % 8) != 0; $n++) {
1192 (my $res = shift) =~ tr/\t/ /c;
1199 # Drop the diff line leader and expand tabs
1201 $line = expand_tabs($line);
1203 # Pick the indent from the front of the line.
1204 my ($white) = ($line =~ /^(\s*)/);
1206 return (length($line), length($white));
1209 my $sanitise_quote = '';
1211 sub sanitise_line_reset {
1212 my ($in_comment) = @_;
1215 $sanitise_quote = '*/';
1217 $sanitise_quote = '';
1230 # Always copy over the diff marker.
1231 $res = substr($line, 0, 1);
1233 for ($off = 1; $off < length($line); $off++) {
1234 $c = substr($line, $off, 1);
1236 # Comments we are whacking completely including the begin
1237 # and end, all to $;.
1238 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1239 $sanitise_quote = '*/';
1241 substr($res, $off, 2, "$;$;");
1245 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
1246 $sanitise_quote = '';
1247 substr($res, $off, 2, "$;$;");
1251 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1252 $sanitise_quote = '//';
1254 substr($res, $off, 2, $sanitise_quote);
1259 # A \ in a string means ignore the next character.
1260 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1262 substr($res, $off, 2, 'XX');
1267 if ($c eq "'" || $c eq '"') {
1268 if ($sanitise_quote eq '') {
1269 $sanitise_quote = $c;
1271 substr($res, $off, 1, $c);
1273 } elsif ($sanitise_quote eq $c) {
1274 $sanitise_quote = '';
1278 #print "c<$c> SQ<$sanitise_quote>\n";
1279 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1280 substr($res, $off, 1, $;);
1281 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1282 substr($res, $off, 1, $;);
1283 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1284 substr($res, $off, 1, 'X');
1286 substr($res, $off, 1, $c);
1290 if ($sanitise_quote eq '//') {
1291 $sanitise_quote = '';
1294 # The pathname on a #include may be surrounded by '<' and '>'.
1295 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
1296 my $clean = 'X' x length($1);
1297 $res =~ s@\<.*\>@<$clean>@;
1299 # The whole of a #error is a string.
1300 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
1301 my $clean = 'X' x length($1);
1302 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
1305 if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1307 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1313 sub get_quoted_string {
1314 my ($line, $rawline) = @_;
1316 return "" if (!defined($line) || !defined($rawline));
1317 return "" if ($line !~ m/($String)/g);
1318 return substr($rawline, $-[0], $+[0] - $-[0]);
1321 sub ctx_statement_block {
1322 my ($linenr, $remain, $off) = @_;
1323 my $line = $linenr - 1;
1326 my $coff = $off - 1;
1340 @stack = (['', 0]) if ($#stack == -1);
1342 #warn "CSB: blk<$blk> remain<$remain>\n";
1343 # If we are about to drop off the end, pull in more
1346 for (; $remain > 0; $line++) {
1347 last if (!defined $lines[$line]);
1348 next if ($lines[$line] =~ /^-/);
1351 $blk .= $lines[$line] . "\n";
1352 $len = length($blk);
1356 # Bail if there is no further context.
1357 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1361 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1367 $c = substr($blk, $off, 1);
1368 $remainder = substr($blk, $off);
1370 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1372 # Handle nested #if/#else.
1373 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1374 push(@stack, [ $type, $level ]);
1375 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1376 ($type, $level) = @{$stack[$#stack - 1]};
1377 } elsif ($remainder =~ /^#\s*endif\b/) {
1378 ($type, $level) = @{pop(@stack)};
1381 # Statement ends at the ';' or a close '}' at the
1383 if ($level == 0 && $c eq ';') {
1387 # An else is really a conditional as long as its not else if
1388 if ($level == 0 && $coff_set == 0 &&
1389 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1390 $remainder =~ /^(else)(?:\s|{)/ &&
1391 $remainder !~ /^else\s+if\b/) {
1392 $coff = $off + length($1) - 1;
1394 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1395 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1398 if (($type eq '' || $type eq '(') && $c eq '(') {
1402 if ($type eq '(' && $c eq ')') {
1404 $type = ($level != 0)? '(' : '';
1406 if ($level == 0 && $coff < $soff) {
1409 #warn "CSB: mark coff<$coff>\n";
1412 if (($type eq '' || $type eq '{') && $c eq '{') {
1416 if ($type eq '{' && $c eq '}') {
1418 $type = ($level != 0)? '{' : '';
1421 if (substr($blk, $off + 1, 1) eq ';') {
1427 # Preprocessor commands end at the newline unless escaped.
1428 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1436 # We are truly at the end, so shuffle to the next line.
1443 my $statement = substr($blk, $soff, $off - $soff + 1);
1444 my $condition = substr($blk, $soff, $coff - $soff + 1);
1446 #warn "STATEMENT<$statement>\n";
1447 #warn "CONDITION<$condition>\n";
1449 #print "coff<$coff> soff<$off> loff<$loff>\n";
1451 return ($statement, $condition,
1452 $line, $remain + 1, $off - $loff + 1, $level);
1455 sub statement_lines {
1458 # Strip the diff line prefixes and rip blank lines at start and end.
1459 $stmt =~ s/(^|\n)./$1/g;
1463 my @stmt_lines = ($stmt =~ /\n/g);
1465 return $#stmt_lines + 2;
1468 sub statement_rawlines {
1471 my @stmt_lines = ($stmt =~ /\n/g);
1473 return $#stmt_lines + 2;
1476 sub statement_block_size {
1479 $stmt =~ s/(^|\n)./$1/g;
1485 my @stmt_lines = ($stmt =~ /\n/g);
1486 my @stmt_statements = ($stmt =~ /;/g);
1488 my $stmt_lines = $#stmt_lines + 2;
1489 my $stmt_statements = $#stmt_statements + 1;
1491 if ($stmt_lines > $stmt_statements) {
1494 return $stmt_statements;
1498 sub ctx_statement_full {
1499 my ($linenr, $remain, $off) = @_;
1500 my ($statement, $condition, $level);
1504 # Grab the first conditional/block pair.
1505 ($statement, $condition, $linenr, $remain, $off, $level) =
1506 ctx_statement_block($linenr, $remain, $off);
1507 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1508 push(@chunks, [ $condition, $statement ]);
1509 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1510 return ($level, $linenr, @chunks);
1513 # Pull in the following conditional/block pairs and see if they
1514 # could continue the statement.
1516 ($statement, $condition, $linenr, $remain, $off, $level) =
1517 ctx_statement_block($linenr, $remain, $off);
1518 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1519 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1521 push(@chunks, [ $condition, $statement ]);
1524 return ($level, $linenr, @chunks);
1528 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1530 my $start = $linenr - 1;
1537 my @stack = ($level);
1538 for ($line = $start; $remain > 0; $line++) {
1539 next if ($rawlines[$line] =~ /^-/);
1542 $blk .= $rawlines[$line];
1544 # Handle nested #if/#else.
1545 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1546 push(@stack, $level);
1547 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1548 $level = $stack[$#stack - 1];
1549 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1550 $level = pop(@stack);
1553 foreach my $c (split(//, $lines[$line])) {
1554 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1560 if ($c eq $close && $level > 0) {
1562 last if ($level == 0);
1563 } elsif ($c eq $open) {
1568 if (!$outer || $level <= 1) {
1569 push(@res, $rawlines[$line]);
1572 last if ($level == 0);
1575 return ($level, @res);
1577 sub ctx_block_outer {
1578 my ($linenr, $remain) = @_;
1580 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1584 my ($linenr, $remain) = @_;
1586 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1590 my ($linenr, $remain, $off) = @_;
1592 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1595 sub ctx_block_level {
1596 my ($linenr, $remain) = @_;
1598 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1600 sub ctx_statement_level {
1601 my ($linenr, $remain, $off) = @_;
1603 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1606 sub ctx_locate_comment {
1607 my ($first_line, $end_line) = @_;
1609 # Catch a comment on the end of the line itself.
1610 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1611 return $current_comment if (defined $current_comment);
1613 # Look through the context and try and figure out if there is a
1616 $current_comment = '';
1617 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1618 my $line = $rawlines[$linenr - 1];
1620 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1623 if ($line =~ m@/\*@) {
1626 if (!$in_comment && $current_comment ne '') {
1627 $current_comment = '';
1629 $current_comment .= $line . "\n" if ($in_comment);
1630 if ($line =~ m@\*/@) {
1635 chomp($current_comment);
1636 return($current_comment);
1638 sub ctx_has_comment {
1639 my ($first_line, $end_line) = @_;
1640 my $cmt = ctx_locate_comment($first_line, $end_line);
1642 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1643 ##print "CMMT: $cmt\n";
1645 return ($cmt ne '');
1649 my ($linenr, $cnt) = @_;
1651 my $offset = $linenr - 1;
1656 $line = $rawlines[$offset++];
1657 next if (defined($line) && $line =~ /^-/);
1665 my ($linenr, $lc) = @_;
1667 my $stat_real = raw_line($linenr, 0);
1668 for (my $count = $linenr + 1; $count <= $lc; $count++) {
1669 $stat_real = $stat_real . "\n" . raw_line($count, 0);
1676 my ($linenr, $cnt, $here) = @_;
1678 my $herectx = $here . "\n";
1679 for (my $n = 0; $n < $cnt; $n++) {
1680 $herectx .= raw_line($linenr, $n) . "\n";
1691 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1694 $coded = sprintf("^%c", unpack('C', $2) + 64);
1703 my $av_preprocessor = 0;
1708 sub annotate_reset {
1709 $av_preprocessor = 0;
1711 @av_paren_type = ('E');
1712 $av_pend_colon = 'O';
1715 sub annotate_values {
1716 my ($stream, $type) = @_;
1719 my $var = '_' x length($stream);
1722 print "$stream\n" if ($dbg_values > 1);
1724 while (length($cur)) {
1725 @av_paren_type = ('E') if ($#av_paren_type < 0);
1726 print " <" . join('', @av_paren_type) .
1727 "> <$type> <$av_pending>" if ($dbg_values > 1);
1728 if ($cur =~ /^(\s+)/o) {
1729 print "WS($1)\n" if ($dbg_values > 1);
1730 if ($1 =~ /\n/ && $av_preprocessor) {
1731 $type = pop(@av_paren_type);
1732 $av_preprocessor = 0;
1735 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1736 print "CAST($1)\n" if ($dbg_values > 1);
1737 push(@av_paren_type, $type);
1740 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1741 print "DECLARE($1)\n" if ($dbg_values > 1);
1744 } elsif ($cur =~ /^($Modifier)\s*/) {
1745 print "MODIFIER($1)\n" if ($dbg_values > 1);
1748 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1749 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1750 $av_preprocessor = 1;
1751 push(@av_paren_type, $type);
1757 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1758 print "UNDEF($1)\n" if ($dbg_values > 1);
1759 $av_preprocessor = 1;
1760 push(@av_paren_type, $type);
1762 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1763 print "PRE_START($1)\n" if ($dbg_values > 1);
1764 $av_preprocessor = 1;
1766 push(@av_paren_type, $type);
1767 push(@av_paren_type, $type);
1770 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1771 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1772 $av_preprocessor = 1;
1774 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1778 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1779 print "PRE_END($1)\n" if ($dbg_values > 1);
1781 $av_preprocessor = 1;
1783 # Assume all arms of the conditional end as this
1784 # one does, and continue as if the #endif was not here.
1785 pop(@av_paren_type);
1786 push(@av_paren_type, $type);
1789 } elsif ($cur =~ /^(\\\n)/o) {
1790 print "PRECONT($1)\n" if ($dbg_values > 1);
1792 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1793 print "ATTR($1)\n" if ($dbg_values > 1);
1794 $av_pending = $type;
1797 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1798 print "SIZEOF($1)\n" if ($dbg_values > 1);
1804 } elsif ($cur =~ /^(if|while|for)\b/o) {
1805 print "COND($1)\n" if ($dbg_values > 1);
1809 } elsif ($cur =~/^(case)/o) {
1810 print "CASE($1)\n" if ($dbg_values > 1);
1811 $av_pend_colon = 'C';
1814 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1815 print "KEYWORD($1)\n" if ($dbg_values > 1);
1818 } elsif ($cur =~ /^(\()/o) {
1819 print "PAREN('$1')\n" if ($dbg_values > 1);
1820 push(@av_paren_type, $av_pending);
1824 } elsif ($cur =~ /^(\))/o) {
1825 my $new_type = pop(@av_paren_type);
1826 if ($new_type ne '_') {
1828 print "PAREN('$1') -> $type\n"
1829 if ($dbg_values > 1);
1831 print "PAREN('$1')\n" if ($dbg_values > 1);
1834 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1835 print "FUNC($1)\n" if ($dbg_values > 1);
1839 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1840 if (defined $2 && $type eq 'C' || $type eq 'T') {
1841 $av_pend_colon = 'B';
1842 } elsif ($type eq 'E') {
1843 $av_pend_colon = 'L';
1845 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1848 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1849 print "IDENT($1)\n" if ($dbg_values > 1);
1852 } elsif ($cur =~ /^($Assignment)/o) {
1853 print "ASSIGN($1)\n" if ($dbg_values > 1);
1856 } elsif ($cur =~/^(;|{|})/) {
1857 print "END($1)\n" if ($dbg_values > 1);
1859 $av_pend_colon = 'O';
1861 } elsif ($cur =~/^(,)/) {
1862 print "COMMA($1)\n" if ($dbg_values > 1);
1865 } elsif ($cur =~ /^(\?)/o) {
1866 print "QUESTION($1)\n" if ($dbg_values > 1);
1869 } elsif ($cur =~ /^(:)/o) {
1870 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1872 substr($var, length($res), 1, $av_pend_colon);
1873 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1878 $av_pend_colon = 'O';
1880 } elsif ($cur =~ /^(\[)/o) {
1881 print "CLOSE($1)\n" if ($dbg_values > 1);
1884 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1887 print "OPV($1)\n" if ($dbg_values > 1);
1894 substr($var, length($res), 1, $variant);
1897 } elsif ($cur =~ /^($Operators)/o) {
1898 print "OP($1)\n" if ($dbg_values > 1);
1899 if ($1 ne '++' && $1 ne '--') {
1903 } elsif ($cur =~ /(^.)/o) {
1904 print "C($1)\n" if ($dbg_values > 1);
1907 $cur = substr($cur, length($1));
1908 $res .= $type x length($1);
1912 return ($res, $var);
1916 my ($possible, $line) = @_;
1917 my $notPermitted = qr{(?:
1934 ^(?:typedef|struct|enum)\b
1936 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1937 if ($possible !~ $notPermitted) {
1938 # Check for modifiers.
1939 $possible =~ s/\s*$Storage\s*//g;
1940 $possible =~ s/\s*$Sparse\s*//g;
1941 if ($possible =~ /^\s*$/) {
1943 } elsif ($possible =~ /\s/) {
1944 $possible =~ s/\s*$Type\s*//g;
1945 for my $modifier (split(' ', $possible)) {
1946 if ($modifier !~ $notPermitted) {
1947 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1948 push(@modifierListFile, $modifier);
1953 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1954 push(@typeListFile, $possible);
1958 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1967 $type =~ tr/[a-z]/[A-Z]/;
1969 return defined $use_type{$type} if (scalar keys %use_type > 0);
1971 return !defined $ignore_type{$type};
1975 my ($level, $type, $msg) = @_;
1977 if (!show_type($type) ||
1978 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
1983 if ($level eq 'ERROR') {
1985 } elsif ($level eq 'WARNING') {
1991 $output .= $prefix . $level . ':';
1993 $output .= BLUE if ($color);
1994 $output .= "$type:";
1996 $output .= RESET if ($color);
1997 $output .= ' ' . $msg . "\n";
2000 my @lines = split("\n", $output, -1);
2001 splice(@lines, 1, 1);
2002 $output = join("\n", @lines);
2004 $output = (split('\n', $output))[0] . "\n" if ($terse);
2006 push(our @report, $output);
2015 sub fixup_current_range {
2016 my ($lineRef, $offset, $length) = @_;
2018 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
2021 my $no = $o + $offset;
2022 my $nl = $l + $length;
2023 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
2027 sub fix_inserted_deleted_lines {
2028 my ($linesRef, $insertedRef, $deletedRef) = @_;
2030 my $range_last_linenr = 0;
2031 my $delta_offset = 0;
2036 my $next_insert = 0;
2037 my $next_delete = 0;
2041 my $inserted = @{$insertedRef}[$next_insert++];
2042 my $deleted = @{$deletedRef}[$next_delete++];
2044 foreach my $old_line (@{$linesRef}) {
2046 my $line = $old_line; #don't modify the array
2047 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
2049 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
2050 $range_last_linenr = $new_linenr;
2051 fixup_current_range(\$line, $delta_offset, 0);
2054 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
2055 $deleted = @{$deletedRef}[$next_delete++];
2057 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
2060 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
2061 push(@lines, ${$inserted}{'LINE'});
2062 $inserted = @{$insertedRef}[$next_insert++];
2064 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
2068 push(@lines, $line);
2078 sub fix_insert_line {
2079 my ($linenr, $line) = @_;
2085 push(@fixed_inserted, $inserted);
2088 sub fix_delete_line {
2089 my ($linenr, $line) = @_;
2096 push(@fixed_deleted, $deleted);
2100 my ($type, $msg) = @_;
2102 if (report("ERROR", $type, $msg)) {
2110 my ($type, $msg) = @_;
2112 if (report("WARNING", $type, $msg)) {
2120 my ($type, $msg) = @_;
2122 if ($check && report("CHECK", $type, $msg)) {
2130 sub check_absolute_file {
2131 my ($absolute, $herecurr) = @_;
2132 my $file = $absolute;
2134 ##print "absolute<$absolute>\n";
2136 # See if any suffix of this path is a path within the tree.
2137 while ($file =~ s@^[^/]*/@@) {
2138 if (-f "$root/$file") {
2139 ##print "file<$file>\n";
2147 # It is, so see if the prefix is acceptable.
2148 my $prefix = $absolute;
2149 substr($prefix, -length($file)) = '';
2151 ##print "prefix<$prefix>\n";
2152 if ($prefix ne ".../") {
2153 WARN("USE_RELATIVE_PATH",
2154 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
2161 $string =~ s/^\s+|\s+$//g;
2169 $string =~ s/^\s+//;
2177 $string =~ s/\s+$//;
2182 sub string_find_replace {
2183 my ($string, $find, $replace) = @_;
2185 $string =~ s/$find/$replace/g;
2193 my $source_indent = 8;
2194 my $max_spaces_before_tab = $source_indent - 1;
2195 my $spaces_to_tab = " " x $source_indent;
2197 #convert leading spaces to tabs
2198 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2199 #Remove spaces before a tab
2200 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2205 sub pos_last_openparen {
2210 my $opens = $line =~ tr/\(/\(/;
2211 my $closes = $line =~ tr/\)/\)/;
2213 my $last_openparen = 0;
2215 if (($opens == 0) || ($closes >= $opens)) {
2219 my $len = length($line);
2221 for ($pos = 0; $pos < $len; $pos++) {
2222 my $string = substr($line, $pos);
2223 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2224 $pos += length($1) - 1;
2225 } elsif (substr($line, $pos, 1) eq '(') {
2226 $last_openparen = $pos;
2227 } elsif (index($string, '(') == -1) {
2232 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
2236 my $filename = shift;
2242 my $stashrawline="";
2252 my $authorsignoff = 0;
2254 my $in_header_lines = $file ? 0 : 1;
2255 my $in_commit_log = 0; #Scanning lines before patch
2256 my $has_commit_log = 0; #Encountered lines before patch
2257 my $commit_log_lines = 0; #Number of commit log lines
2258 my $commit_log_possible_stack_dump = 0;
2259 my $commit_log_long_line = 0;
2260 my $commit_log_has_diff = 0;
2261 my $reported_maintainer_file = 0;
2262 my $non_utf8_charset = 0;
2264 my $last_blank_line = 0;
2265 my $last_coalesced_string_linenr = -1;
2273 # Trace the real file/line as we go.
2278 my $context_function; #undef'd unless there's a known function
2280 my $comment_edge = 0;
2284 my $prev_values = 'E';
2287 my %suppress_ifbraces;
2288 my %suppress_whiletrailers;
2289 my %suppress_export;
2290 my $suppress_statement = 0;
2292 my %signatures = ();
2294 # Pre-scan the patch sanitizing the lines.
2295 # Pre-scan the patch looking for any __setup documentation.
2297 my @setup_docs = ();
2300 my $camelcase_file_seeded = 0;
2302 my $checklicenseline = 1;
2304 sanitise_line_reset();
2306 foreach my $rawline (@rawlines) {
2310 push(@fixed, $rawline) if ($fix);
2312 if ($rawline=~/^\+\+\+\s+(\S+)/) {
2314 if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) {
2319 if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2328 # Guestimate if this is a continuing comment. Run
2329 # the context looking for a comment "edge". If this
2330 # edge is a close comment then we must be in a comment
2334 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2335 next if (defined $rawlines[$ln - 1] &&
2336 $rawlines[$ln - 1] =~ /^-/);
2338 #print "RAW<$rawlines[$ln - 1]>\n";
2339 last if (!defined $rawlines[$ln - 1]);
2340 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2341 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2346 if (defined $edge && $edge eq '*/') {
2350 # Guestimate if this is a continuing comment. If this
2351 # is the start of a diff block and this line starts
2352 # ' *' then it is very likely a comment.
2353 if (!defined $edge &&
2354 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
2359 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2360 sanitise_line_reset($in_comment);
2362 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
2363 # Standardise the strings and chars within the input to
2364 # simplify matching -- only bother with positive lines.
2365 $line = sanitise_line($rawline);
2367 push(@lines, $line);
2370 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2375 #print "==>$rawline\n";
2376 #print "-->$line\n";
2378 if ($setup_docs && $line =~ /^\+/) {
2379 push(@setup_docs, $line);
2388 foreach my $line (@lines) {
2391 my $sline = $line; #copy of $line
2392 $sline =~ s/$;/ /g; #with comments as spaces
2394 my $rawline = $rawlines[$linenr - 1];
2396 # check if it's a mode change, rename or start of a patch
2397 if (!$in_commit_log &&
2398 ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ ||
2399 ($line =~ /^rename (?:from|to) \S+\s*$/ ||
2400 $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) {
2404 #extract the line range in the file after the patch is applied
2405 if (!$in_commit_log &&
2406 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2409 $first_line = $linenr + 1;
2419 %suppress_ifbraces = ();
2420 %suppress_whiletrailers = ();
2421 %suppress_export = ();
2422 $suppress_statement = 0;
2423 if ($context =~ /\b(\w+)\s*\(/) {
2424 $context_function = $1;
2426 undef $context_function;
2430 # track the line number as we move through the hunk, note that
2431 # new versions of GNU diff omit the leading space on completely
2432 # blank context lines so we need to count that too.
2433 } elsif ($line =~ /^( |\+|$)/) {
2435 $realcnt-- if ($realcnt != 0);
2437 # Measure the line length and indent.
2438 ($length, $indent) = line_stats($rawline);
2440 # Track the previous line.
2441 ($prevline, $stashline) = ($stashline, $line);
2442 ($previndent, $stashindent) = ($stashindent, $indent);
2443 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2445 #warn "line<$line>\n";
2447 } elsif ($realcnt == 1) {
2451 my $hunk_line = ($realcnt != 0);
2453 $here = "#$linenr: " if (!$file);
2454 $here = "#$realline: " if ($file);
2457 # extract the filename as it passes
2458 if ($line =~ /^diff --git.*?(\S+)$/) {
2460 $realfile =~ s@^([^/]*)/@@ if (!$file);
2463 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2465 $realfile =~ s@^([^/]*)/@@ if (!$file);
2469 if (!$file && $tree && $p1_prefix ne '' &&
2470 -e "$root/$p1_prefix") {
2471 WARN("PATCH_PREFIX",
2472 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
2475 if ($realfile =~ m@^include/asm/@) {
2476 ERROR("MODIFIED_INCLUDE_ASM",
2477 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2482 #make up the handle for any error we report on this line
2484 $prefix = "$realfile:$realline: "
2487 $prefix = "$filename:$realline: ";
2489 $prefix = "$filename:$linenr: ";
2494 if (is_maintained_obsolete($realfile)) {
2496 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2498 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
2501 $check = $check_orig;
2503 $checklicenseline = 1;
2507 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
2509 my $hereline = "$here\n$rawline\n";
2510 my $herecurr = "$here\n$rawline\n";
2511 my $hereprev = "$here\n$prevrawline\n$rawline\n";
2513 $cnt_lines++ if ($realcnt != 0);
2515 # Verify the existence of a commit log if appropriate
2516 # 2 is used because a $signature is counted in $commit_log_lines
2517 if ($in_commit_log) {
2518 if ($line !~ /^\s*$/) {
2519 $commit_log_lines++; #could be a $signature
2521 } elsif ($has_commit_log && $commit_log_lines < 2) {
2522 WARN("COMMIT_MESSAGE",
2523 "Missing commit description - Add an appropriate one\n");
2524 $commit_log_lines = 2; #warn only once
2527 # Check if the commit log has what seems like a diff which can confuse patch
2528 if ($in_commit_log && !$commit_log_has_diff &&
2529 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2530 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2531 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2532 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2533 ERROR("DIFF_IN_COMMIT_MSG",
2534 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2535 $commit_log_has_diff = 1;
2538 # Check for incorrect file permissions
2539 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2540 my $permhere = $here . "FILE: $realfile\n";
2541 if ($realfile !~ m@scripts/@ &&
2542 $realfile !~ /\.(py|pl|awk|sh)$/) {
2543 ERROR("EXECUTE_PERMISSIONS",
2544 "do not set execute permissions for source files\n" . $permhere);
2548 # Check the patch for a From:
2549 if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) {
2551 $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i);
2555 # Check the patch for a signoff:
2556 if ($line =~ /^\s*signed-off-by:/i) {
2559 if ($author ne '') {
2562 if ($l =~ /^\s*signed-off-by:\s*\Q$author\E/i) {
2568 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2569 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2570 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2571 $reported_maintainer_file = 1;
2574 # Check signature styles
2575 if (!$in_header_lines &&
2576 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
2577 my $space_before = $1;
2579 my $space_after = $3;
2581 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2583 if ($sign_off !~ /$signature_tags/) {
2584 WARN("BAD_SIGN_OFF",
2585 "Non-standard signature: $sign_off\n" . $herecurr);
2587 if (defined $space_before && $space_before ne "") {
2588 if (WARN("BAD_SIGN_OFF",
2589 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2591 $fixed[$fixlinenr] =
2592 "$ucfirst_sign_off $email";
2595 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
2596 if (WARN("BAD_SIGN_OFF",
2597 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2599 $fixed[$fixlinenr] =
2600 "$ucfirst_sign_off $email";
2604 if (!defined $space_after || $space_after ne " ") {
2605 if (WARN("BAD_SIGN_OFF",
2606 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2608 $fixed[$fixlinenr] =
2609 "$ucfirst_sign_off $email";
2613 my ($email_name, $email_address, $comment) = parse_email($email);
2614 my $suggested_email = format_email(($email_name, $email_address));
2615 if ($suggested_email eq "") {
2616 ERROR("BAD_SIGN_OFF",
2617 "Unrecognized email address: '$email'\n" . $herecurr);
2619 my $dequoted = $suggested_email;
2620 $dequoted =~ s/^"//;
2621 $dequoted =~ s/" </ </;
2622 # Don't force email to have quotes
2623 # Allow just an angle bracketed address
2624 if ("$dequoted$comment" ne $email &&
2625 "<$email_address>$comment" ne $email &&
2626 "$suggested_email$comment" ne $email) {
2627 WARN("BAD_SIGN_OFF",
2628 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
2632 # Check for duplicate signatures
2633 my $sig_nospace = $line;
2634 $sig_nospace =~ s/\s//g;
2635 $sig_nospace = lc($sig_nospace);
2636 if (defined $signatures{$sig_nospace}) {
2637 WARN("BAD_SIGN_OFF",
2638 "Duplicate signature\n" . $herecurr);
2640 $signatures{$sig_nospace} = 1;
2644 # Check email subject for common tools that don't need to be mentioned
2645 if ($in_header_lines &&
2646 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2647 WARN("EMAIL_SUBJECT",
2648 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2651 # Check for unwanted Gerrit info
2652 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2653 ERROR("GERRIT_CHANGE_ID",
2654 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2657 # Check if the commit log is in a possible stack dump
2658 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2659 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2660 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2662 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2663 # stack dump address
2664 $commit_log_possible_stack_dump = 1;
2667 # Check for line lengths > 75 in commit log, warn once
2668 if ($in_commit_log && !$commit_log_long_line &&
2669 length($line) > 75 &&
2670 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2671 # file delta changes
2672 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2674 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2675 # A Fixes: or Link: line
2676 $commit_log_possible_stack_dump)) {
2677 WARN("COMMIT_LOG_LONG_LINE",
2678 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2679 $commit_log_long_line = 1;
2682 # Reset possible stack dump if a blank line is found
2683 if ($in_commit_log && $commit_log_possible_stack_dump &&
2685 $commit_log_possible_stack_dump = 0;
2688 # Check for git id commit length and improperly formed commit descriptions
2689 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2690 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
2691 $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
2692 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
2693 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
2694 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2695 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
2696 my $init_char = "c";
2697 my $orig_commit = "";
2704 my $id = '0123456789ab';
2705 my $orig_desc = "commit description";
2706 my $description = "";
2708 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2710 $orig_commit = lc($2);
2711 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2712 $orig_commit = lc($1);
2715 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2716 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2717 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2718 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2719 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2722 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2723 defined $rawlines[$linenr] &&
2724 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2727 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2728 defined $rawlines[$linenr] &&
2729 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2730 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2732 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2733 $orig_desc .= " " . $1;
2737 ($id, $description) = git_commit_info($orig_commit,
2741 ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
2742 ERROR("GIT_COMMIT_ID",
2743 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2747 # Check for added, moved or deleted files
2748 if (!$reported_maintainer_file && !$in_commit_log &&
2749 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2750 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2751 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2752 (defined($1) || defined($2))))) {
2754 $reported_maintainer_file = 1;
2755 WARN("FILE_PATH_CHANGES",
2756 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2759 # Check for wrappage within a valid hunk of the file
2760 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
2761 ERROR("CORRUPTED_PATCH",
2762 "patch seems to be corrupt (line wrapped?)\n" .
2763 $herecurr) if (!$emitted_corrupt++);
2766 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2767 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
2768 $rawline !~ m/^$UTF8*$/) {
2769 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2771 my $blank = copy_spacing($rawline);
2772 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2773 my $hereptr = "$hereline$ptr\n";
2776 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
2779 # Check if it's the start of a commit log
2780 # (not a header line and we haven't seen the patch filename)
2781 if ($in_header_lines && $realfile =~ /^$/ &&
2782 !($rawline =~ /^\s+(?:\S|$)/ ||
2783 $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
2784 $in_header_lines = 0;
2786 $has_commit_log = 1;
2789 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2790 # declined it, i.e defined some charset where it is missing.
2791 if ($in_header_lines &&
2792 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2794 $non_utf8_charset = 1;
2797 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
2798 $rawline =~ /$NON_ASCII_UTF8/) {
2799 WARN("UTF8_BEFORE_PATCH",
2800 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2803 # Check for absolute kernel paths in commit message
2804 if ($tree && $in_commit_log) {
2805 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2808 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2809 check_absolute_file($1, $herecurr)) {
2812 check_absolute_file($file, $herecurr);
2817 # Check for various typo / spelling mistakes
2818 if (defined($misspellings) &&
2819 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
2820 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
2822 my $typo_fix = $spelling_fix{lc($typo)};
2823 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2824 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2825 my $msg_level = \&WARN;
2826 $msg_level = \&CHK if ($file);
2827 if (&{$msg_level}("TYPO_SPELLING",
2828 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2830 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2835 # ignore non-hunk lines and lines being removed
2836 next if (!$hunk_line || $line =~ /^-/);
2838 #trailing whitespace
2839 if ($line =~ /^\+.*\015/) {
2840 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2841 if (ERROR("DOS_LINE_ENDINGS",
2842 "DOS line endings\n" . $herevet) &&
2844 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
2846 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2847 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2848 if (ERROR("TRAILING_WHITESPACE",
2849 "trailing whitespace\n" . $herevet) &&
2851 $fixed[$fixlinenr] =~ s/\s+$//;
2857 # Check for FSF mailing addresses.
2858 if ($rawline =~ /\bwrite to the Free/i ||
2859 $rawline =~ /\b675\s+Mass\s+Ave/i ||
2860 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2861 $rawline =~ /\b51\s+Franklin\s+St/i) {
2862 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2863 my $msg_level = \&ERROR;
2864 $msg_level = \&CHK if ($file);
2865 &{$msg_level}("FSF_MAILING_ADDRESS",
2866 "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)
2869 # check for Kconfig help text having a real description
2870 # Only applies when adding the entry originally, after that we do not have
2871 # sufficient context to determine whether it is indeed long enough.
2872 if ($realfile =~ /Kconfig/ &&
2873 # 'choice' is usually the last thing on the line (though
2874 # Kconfig supports named choices), so use a word boundary
2875 # (\b) rather than a whitespace character (\s)
2876 $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) {
2879 my $ln = $linenr + 1;
2883 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
2884 $f = $lines[$ln - 1];
2885 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2886 $is_end = $lines[$ln - 1] =~ /^\+/;
2888 next if ($f =~ /^-/);
2889 last if (!$file && $f =~ /^\@\@/);
2891 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
2893 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) {
2894 if ($lines[$ln - 1] =~ "---help---") {
2895 WARN("CONFIG_DESCRIPTION",
2896 "prefer 'help' over '---help---' for new help texts\n" . $herecurr);
2904 next if ($f =~ /^$/);
2906 # This only checks context lines in the patch
2907 # and so hopefully shouldn't trigger false
2908 # positives, even though some of these are
2909 # common words in help texts
2910 if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice|
2911 if|endif|menu|endmenu|source)\b/x) {
2917 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2918 WARN("CONFIG_DESCRIPTION",
2919 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2921 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2924 # check for MAINTAINERS entries that don't have the right form
2925 if ($realfile =~ /^MAINTAINERS$/ &&
2926 $rawline =~ /^\+[A-Z]:/ &&
2927 $rawline !~ /^\+[A-Z]:\t\S/) {
2928 if (WARN("MAINTAINERS_STYLE",
2929 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
2931 $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
2935 # discourage the use of boolean for type definition attributes of Kconfig options
2936 if ($realfile =~ /Kconfig/ &&
2937 $line =~ /^\+\s*\bboolean\b/) {
2938 WARN("CONFIG_TYPE_BOOLEAN",
2939 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2942 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2943 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2946 'EXTRA_AFLAGS' => 'asflags-y',
2947 'EXTRA_CFLAGS' => 'ccflags-y',
2948 'EXTRA_CPPFLAGS' => 'cppflags-y',
2949 'EXTRA_LDFLAGS' => 'ldflags-y',
2952 WARN("DEPRECATED_VARIABLE",
2953 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead
.\n" . $herecurr) if ($replacement->{$flag});
2956 # check for DT compatible documentation
2957 if (defined $root &&
2958 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2959 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2961 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2963 my $dt_path = $root . "/Documentation/devicetree
/bindings/";
2964 my $vp_file = $dt_path . "vendor-prefixes
.txt
";
2966 foreach my $compat (@compats) {
2967 my $compat2 = $compat;
2968 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2969 my $compat3 = $compat;
2970 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2971 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
2973 WARN("UNDOCUMENTED_DT_STRING
",
2974 "DT compatible string
\"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2977 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2979 `grep -Eq "^$vendor\\b" $vp_file`;
2981 WARN("UNDOCUMENTED_DT_STRING",
2982 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2987 # check for using SPDX license tag at beginning of files
2988 if ($realline == $checklicenseline) {
2989 if ($rawline =~ /^[ \+]\s*\#\!\s*\//) {
2990 $checklicenseline = 2;
2991 } elsif ($rawline =~ /^\+/) {
2993 if ($realfile =~ /\.(h|s|S)$/) {
2995 } elsif ($realfile =~ /\.(c|dts|dtsi)$/) {
2997 } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc)$/) {
2999 } elsif ($realfile =~ /\.rst$/) {
3003 if ($comment !~ /^$/ &&
3004 $rawline !~ /^\+\Q$comment\E SPDX-License-Identifier: /) {
3005 WARN("SPDX_LICENSE_TAG",
3006 "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr);
3007 } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) {
3008 my $spdx_license = $1;
3009 if (!is_SPDX_License_valid($spdx_license)) {
3010 WARN("SPDX_LICENSE_TAG",
3011 "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr);
3017 # check we are in a valid source file if not then ignore this hunk
3018 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
3020 # line length limit (with some exclusions)
3022 # There are a few types of lines that may extend beyond $max_line_length:
3023 # logging functions like pr_info that end in a string
3024 # lines with a single string
3025 # #defines that are a single string
3026 # lines with an RFC3986 like URL
3028 # There are 3 different line length message types:
3029 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
3030 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
3031 # LONG_LINE all other lines longer than $max_line_length
3033 # if LONG_LINE is ignored, the other 2 types are also ignored
3036 if ($line =~ /^\+/ && $length > $max_line_length) {
3037 my $msg_type = "LONG_LINE";
3039 # Check the allowed long line types first
3041 # logging functions that end in a string that starts
3042 # before $max_line_length
3043 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3044 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3047 # lines with only strings (w/ possible termination)
3048 # #defines with only strings
3049 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
3050 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
3053 # More special cases
3054 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
3055 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
3058 # URL ($rawline is used in case the URL is in a comment)
3059 } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) {
3062 # Otherwise set the alternate message types
3064 # a comment starts before $max_line_length
3065 } elsif ($line =~ /($;[\s$;]*)$/ &&
3066 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3067 $msg_type = "LONG_LINE_COMMENT"
3069 # a quoted string starts before $max_line_length
3070 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
3071 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3072 $msg_type = "LONG_LINE_STRING"
3075 if ($msg_type ne "" &&
3076 (show_type("LONG_LINE") || show_type($msg_type))) {
3078 "line over $max_line_length characters\n" . $herecurr);
3082 # check for adding lines without a newline.
3083 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
3084 WARN("MISSING_EOF_NEWLINE",
3085 "adding a line without newline at end of file\n" . $herecurr);
3088 # check we are in a valid source file C or perl if not then ignore this hunk
3089 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
3091 # at the beginning of a line any tabs must come first and anything
3092 # more than 8 must use tabs.
3093 if ($rawline =~ /^\+\s* \t\s*\S/ ||
3094 $rawline =~ /^\+\s* \s*/) {
3095 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3097 if (ERROR("CODE_INDENT",
3098 "code indent should use tabs where possible\n" . $herevet) &&
3100 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3104 # check for space before tabs.
3105 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
3106 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3107 if (WARN("SPACE_BEFORE_TAB",
3108 "please, no space before tabs\n" . $herevet) &&
3110 while ($fixed[$fixlinenr] =~
3111 s/(^\+.*) {8,8}\t/$1\t\t/) {}
3112 while ($fixed[$fixlinenr] =~
3113 s/(^\+.*) +\t/$1\t/) {}
3117 # check for assignments on the start of a line
3118 if ($sline =~ /^\+\s+($Assignment)[^=]/) {
3119 CHK("ASSIGNMENT_CONTINUATIONS",
3120 "Assignment operator '$1' should be on the previous line\n" . $hereprev);
3123 # check for && or || at the start of a line
3124 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
3125 CHK("LOGICAL_CONTINUATIONS",
3126 "Logical continuations should be on the previous line\n" . $hereprev);
3129 # check indentation starts on a tab stop
3130 if ($perl_version_ok &&
3131 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
3132 my $indent = length($1);
3135 "Statements should start on a tabstop\n" . $herecurr) &&
3137 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
3142 # check multi-line statement indentation matches previous line
3143 if ($perl_version_ok &&
3144 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
3145 $prevline =~ /^\+(\t*)(.*)$/;
3149 my $pos = pos_last_openparen($rest);
3151 $line =~ /^(\+| )([ \t]*)/;
3154 my $goodtabindent = $oldindent .
3157 my $goodspaceindent = $oldindent . " " x $pos;
3159 if ($newindent ne $goodtabindent &&
3160 $newindent ne $goodspaceindent) {
3162 if (CHK("PARENTHESIS_ALIGNMENT",
3163 "Alignment should match open parenthesis\n" . $hereprev) &&
3164 $fix && $line =~ /^\+/) {
3165 $fixed[$fixlinenr] =~
3166 s/^\+[ \t]*/\+$goodtabindent/;
3172 # check for space after cast like "(int) foo" or "(struct foo) bar"
3173 # avoid checking a few false positives:
3174 # "sizeof(<type>)" or "__alignof__(<type>)"
3175 # function pointer declarations like "(*foo)(int) = bar;"
3176 # structure definitions like "(struct foo) { 0 };"
3177 # multiline macros that define functions
3178 # known attributes or the __attribute__ keyword
3179 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
3180 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
3182 "No space is necessary after a cast\n" . $herecurr) &&
3184 $fixed[$fixlinenr] =~
3185 s/(\(\s*$Type\s*\))[ \t]+/$1/;
3189 # Block comment styles
3190 # Networking with an initial /*
3191 if ($realfile =~ m@^(drivers/net/|net/)@ &&
3192 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
3193 $rawline =~ /^\+[ \t]*\*/ &&
3195 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
3196 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3199 # Block comments use * on subsequent lines
3200 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3201 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
3202 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
3203 $rawline =~ /^\+/ && #line is new
3204 $rawline !~ /^\+[ \t]*\*/) { #no leading *
3205 WARN("BLOCK_COMMENT_STYLE",
3206 "Block comments use * on subsequent lines\n" . $hereprev);
3209 # Block comments use */ on trailing lines
3210 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
3211 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3212 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3213 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
3214 WARN("BLOCK_COMMENT_STYLE",
3215 "Block comments use a trailing */ on a separate line\n" . $herecurr);
3218 # Block comment * alignment
3219 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3220 $line =~ /^\+[ \t]*$;/ && #leading comment
3221 $rawline =~ /^\+[ \t]*\*/ && #leading *
3222 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
3223 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
3224 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3226 $prevrawline =~ m@^\+([ \t]*/?)\*@;
3228 $oldindent = expand_tabs($1);
3230 $prevrawline =~ m@^\+(.*/?)\*@;
3231 $oldindent = expand_tabs($1);
3233 $rawline =~ m@^\+([ \t]*)\*@;
3235 $newindent = expand_tabs($newindent);
3236 if (length($oldindent) ne length($newindent)) {
3237 WARN("BLOCK_COMMENT_STYLE",
3238 "Block comments should align the * on each line\n" . $hereprev);
3242 # check for missing blank lines after struct/union declarations
3243 # with exceptions for various attributes and macros
3244 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3246 !($line =~ /^\+\s*$/ ||
3247 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3248 $line =~ /^\+\s*MODULE_/i ||
3249 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3250 $line =~ /^\+[a-z_]*init/ ||
3251 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3252 $line =~ /^\+\s*DECLARE/ ||
3253 $line =~ /^\+\s*builtin_[\w_]*driver/ ||
3254 $line =~ /^\+\s*__setup/)) {
3255 if (CHK("LINE_SPACING",
3256 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3258 fix_insert_line($fixlinenr, "\+");
3262 # check for multiple consecutive blank lines
3263 if ($prevline =~ /^[\+ ]\s*$/ &&
3264 $line =~ /^\+\s*$/ &&
3265 $last_blank_line != ($linenr - 1)) {
3266 if (CHK("LINE_SPACING",
3267 "Please don't use multiple blank lines\n" . $hereprev) &&
3269 fix_delete_line($fixlinenr, $rawline);
3272 $last_blank_line = $linenr;
3275 # check for missing blank lines after declarations
3276 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3277 # actual declarations
3278 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
3279 # function pointer declarations
3280 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3281 # foo bar; where foo is some local typedef or #define
3282 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3283 # known declaration macros
3284 $prevline =~ /^\+\s+$declaration_macros/) &&
3285 # for "else if" which can look like "$Ident $Ident"
3286 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3287 # other possible extensions of declaration lines
3288 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3289 # not starting a section or a macro "\" extended line
3290 $prevline =~ /(?:\{\s*|\\)$/) &&
3291 # looks like a declaration
3292 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
3293 # function pointer declarations
3294 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3295 # foo bar; where foo is some local typedef or #define
3296 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3297 # known declaration macros
3298 $sline =~ /^\+\s+$declaration_macros/ ||
3299 # start of struct or union or enum
3300 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
3301 # start or end of block or continuation of declaration
3302 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3303 # bitfield continuation
3304 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3305 # other possible extensions of declaration lines
3306 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3307 # indentation of previous and current line are the same
3308 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
3309 if (WARN("LINE_SPACING",
3310 "Missing a blank line after declarations\n" . $hereprev) &&
3312 fix_insert_line($fixlinenr, "\+");
3316 # check for spaces at the beginning of a line.
3318 # 1) within comments
3319 # 2) indented preprocessor commands
3321 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
3322 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3323 if (WARN("LEADING_SPACE",
3324 "please, no spaces at the start of a line\n" . $herevet) &&
3326 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3330 # check we are in a valid C source file if not then ignore this hunk
3331 next if ($realfile !~ /\.(h|c)$/);
3333 # check for unusual line ending [ or (
3334 if ($line =~ /^\+.*([\[\(])\s*$/) {
3335 CHK("OPEN_ENDED_LINE",
3336 "Lines should not end with a '$1'\n" . $herecurr);
3339 # check if this appears to be the start function declaration, save the name
3340 if ($sline =~ /^\+\{\s*$/ &&
3341 $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
3342 $context_function = $1;
3345 # check if this appears to be the end of function declaration
3346 if ($sline =~ /^\+\}\s*$/) {
3347 undef $context_function;
3350 # check indentation of any line with a bare else
3351 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
3352 # if the previous line is a break or return and is indented 1 tab more...
3353 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3354 my $tabs = length($1) + 1;
3355 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3356 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3357 defined $lines[$linenr] &&
3358 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
3359 WARN("UNNECESSARY_ELSE",
3360 "else is not generally useful after a break or return\n" . $hereprev);
3364 # check indentation of a line with a break;
3365 # if the previous line is a goto or return and is indented the same # of tabs
3366 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3368 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3369 WARN("UNNECESSARY_BREAK",
3370 "break is not useful after a goto or return\n" . $hereprev);
3374 # check for RCS/CVS revision markers
3375 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
3377 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
3380 # check for old HOTPLUG __dev<foo> section markings
3381 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3382 WARN("HOTPLUG_SECTION",
3383 "Using $1 is unnecessary\n" . $herecurr);
3386 # Check for potential 'bare' types
3387 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3389 #print "LINE<$line>\n";
3390 if ($linenr > $suppress_statement &&
3391 $realcnt && $sline =~ /.\s*\S/) {
3392 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3393 ctx_statement_block($linenr, $realcnt, 0);
3394 $stat =~ s/\n./\n /g;
3395 $cond =~ s/\n./\n /g;
3397 #print "linenr<$linenr> <$stat>\n";
3398 # If this statement has no statement boundaries within
3399 # it there is no point in retrying a statement scan
3400 # until we hit end of it.
3401 my $frag = $stat; $frag =~ s/;+\s*$//;
3402 if ($frag !~ /(?:{|;)/) {
3403 #print "skip<$line_nr_next>\n";
3404 $suppress_statement = $line_nr_next;
3407 # Find the real next line.
3408 $realline_next = $line_nr_next;
3409 if (defined $realline_next &&
3410 (!defined $lines[$realline_next - 1] ||
3411 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3418 # Ignore goto labels.
3419 if ($s =~ /$Ident:\*$/s) {
3421 # Ignore functions being called
3422 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
3424 } elsif ($s =~ /^.\s*else\b/s) {
3426 # declarations always start with types
3427 } 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) {
3430 possible($type, "A:" . $s);
3432 # definitions in global scope can only start with types
3433 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
3434 possible($1, "B:" . $s);
3437 # any (foo ... *) is a pointer cast, and foo is a type
3438 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
3439 possible($1, "C:" . $s);
3442 # Check for any sort of function declaration.
3443 # int foo(something bar, other baz);
3444 # void (*store_gdt)(x86_descr_ptr *);
3445 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3446 my ($name_len) = length($1);
3449 substr($ctx, 0, $name_len + 1, '');
3450 $ctx =~ s/\)[^\)]*$//;
3452 for my $arg (split(/\s*,\s*/, $ctx)) {
3453 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3455 possible($1, "D:" . $s);
3463 # Checks which may be anchored in the context.
3466 # Check for switch () and associated case and default
3467 # statements should be at the same indent.
3468 if ($line=~/\bswitch\s*\(.*\)/) {
3471 my @ctx = ctx_block_outer($linenr, $realcnt);
3473 for my $ctx (@ctx) {
3474 my ($clen, $cindent) = line_stats($ctx);
3475 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3476 $indent != $cindent) {
3477 $err .= "$sep$ctx\n";
3484 ERROR("SWITCH_CASE_INDENT_LEVEL",
3485 "switch and case should be at the same indent\n$hereline$err");
3489 # if/while/etc brace do not go on next line, unless defining a do while loop,
3490 # or if that brace on the next line is for something else
3491 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3492 my $pre_ctx = "$1$2";
3494 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
3496 if ($line =~ /^\+\t{6,}/) {
3497 WARN("DEEP_INDENTATION",
3498 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3501 my $ctx_cnt = $realcnt - $#ctx - 1;
3502 my $ctx = join("\n", @ctx);
3504 my $ctx_ln = $linenr;
3505 my $ctx_skip = $realcnt;
3507 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3508 defined $lines[$ctx_ln - 1] &&
3509 $lines[$ctx_ln - 1] =~ /^-/)) {
3510 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3511 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
3515 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3516 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3518 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
3520 "that open brace { should be on the previous line\n" .
3521 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3523 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3524 $ctx =~ /\)\s*\;\s*$/ &&
3525 defined $lines[$ctx_ln - 1])
3527 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3528 if ($nindent > $indent) {
3529 WARN("TRAILING_SEMICOLON",
3530 "trailing semicolon indicates no statements, indent implies otherwise\n" .
3531 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3536 # Check relative indent for conditionals and blocks.
3537 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3538 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3539 ctx_statement_block($linenr, $realcnt, 0)
3540 if (!defined $stat);
3541 my ($s, $c) = ($stat, $cond);
3543 substr($s, 0, length($c), '');
3545 # remove inline comments
3549 # Find out how long the conditional actually is.
3550 my @newlines = ($c =~ /\n/gs);
3551 my $cond_lines = 1 + $#newlines;
3553 # Make sure we remove the line prefixes as we have
3554 # none on the first line, and are going to readd them
3557 while ($s =~ /\n\s+\\\n/) {
3558 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3561 # We want to check the first line inside the block
3562 # starting at the end of the conditional, so remove:
3563 # 1) any blank line termination
3564 # 2) any opening brace { on end of the line
3566 my $continuation = 0;
3568 $s =~ s/^.*\bdo\b//;
3570 if ($s =~ s/^\s*\\//) {
3573 if ($s =~ s/^\s*?\n//) {
3578 # Also ignore a loop construct at the end of a
3579 # preprocessor statement.
3580 if (($prevline =~ /^.\s*#\s*define\s/ ||
3581 $prevline =~ /\\\s*$/) && $continuation == 0) {
3587 while ($cond_ptr != $cond_lines) {
3588 $cond_ptr = $cond_lines;
3590 # If we see an #else/#elif then the code
3592 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3597 # 1) blank lines, they should be at 0,
3598 # 2) preprocessor lines, and
3600 if ($continuation ||
3602 $s =~ /^\s*#\s*?/ ||
3603 $s =~ /^\s*$Ident\s*:/) {
3604 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
3605 if ($s =~ s/^.*?\n//) {
3611 my (undef, $sindent) = line_stats("+" . $s);
3612 my $stat_real = raw_line($linenr, $cond_lines);
3614 # Check if either of these lines are modified, else
3615 # this is not this patch's fault.
3616 if (!defined($stat_real) ||
3617 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3620 if (defined($stat_real) && $cond_lines > 1) {
3621 $stat_real = "[...]\n$stat_real";
3624 #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";
3626 if ($check && $s ne '' &&
3627 (($sindent % 8) != 0 ||
3628 ($sindent < $indent) ||
3629 ($sindent == $indent &&
3630 ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
3631 ($sindent > $indent + 8))) {
3632 WARN("SUSPECT_CODE_INDENT",
3633 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3637 # Track the 'values' across context and added lines.
3638 my $opline = $line; $opline =~ s/^./ /;
3639 my ($curr_values, $curr_vars) =
3640 annotate_values($opline . "\n", $prev_values);
3641 $curr_values = $prev_values . $curr_values;
3643 my $outline = $opline; $outline =~ s/\t/ /g;
3644 print "$linenr > .$outline\n";
3645 print "$linenr > $curr_values\n";
3646 print "$linenr > $curr_vars\n";
3648 $prev_values = substr($curr_values, -1);
3650 #ignore lines not being added
3651 next if ($line =~ /^[^\+]/);
3653 # check for dereferences that span multiple lines
3654 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
3655 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
3656 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
3658 $line =~ /^.\s*($Lval)/;
3661 WARN("MULTILINE_DEREFERENCE",
3662 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
3665 # check for declarations of signed or unsigned without int
3666 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3669 $var = "" if (!defined $var);
3670 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
3674 $pointer = "" if (!defined $pointer);
3676 if (WARN("UNSPECIFIED_INT",
3677 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3679 my $decl = trim($sign) . " int ";
3680 my $comp_pointer = $pointer;
3681 $comp_pointer =~ s/\s//g;
3682 $decl .= $comp_pointer;
3683 $decl = rtrim($decl) if ($var eq "");
3684 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
3689 # TEST: allow direct testing of the type matcher.
3691 if ($line =~ /^.\s*$Declare\s*$/) {
3693 "TEST: is type\n" . $herecurr);
3694 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
3695 ERROR("TEST_NOT_TYPE",
3696 "TEST: is not type ($1 is)\n". $herecurr);
3700 # TEST: allow direct testing of the attribute matcher.
3702 if ($line =~ /^.\s*$Modifier\s*$/) {
3704 "TEST: is attr\n" . $herecurr);
3705 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
3706 ERROR("TEST_NOT_ATTR",
3707 "TEST: is not attr ($1 is)\n". $herecurr);
3712 # check for initialisation to aggregates open brace on the next line
3713 if ($line =~ /^.\s*{/ &&
3714 $prevline =~ /(?:^|[^=])=\s*$/) {
3715 if (ERROR("OPEN_BRACE",
3716 "that open brace { should be on the previous line\n" . $hereprev) &&
3717 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3718 fix_delete_line($fixlinenr - 1, $prevrawline);
3719 fix_delete_line($fixlinenr, $rawline);
3720 my $fixedline = $prevrawline;
3721 $fixedline =~ s/\s*=\s*$/ = {/;
3722 fix_insert_line($fixlinenr, $fixedline);
3724 $fixedline =~ s/^(.\s*)\{\s*/$1/;
3725 fix_insert_line($fixlinenr, $fixedline);
3730 # Checks which are anchored on the added line.
3733 # check for malformed paths in #include statements (uses RAW line)
3734 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
3736 if ($path =~ m{//}) {
3737 ERROR("MALFORMED_INCLUDE",
3738 "malformed #include filename\n" . $herecurr);
3740 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3741 ERROR("UAPI_INCLUDE",
3742 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
3746 # no C99 // comments
3747 if ($line =~ m{//}) {
3748 if (ERROR("C99_COMMENTS",
3749 "do not use C99 // comments\n" . $herecurr) &&
3751 my $line = $fixed[$fixlinenr];
3752 if ($line =~ /\/\/(.*)$/) {
3753 my $comment = trim($1);
3754 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
3758 # Remove C99 comments.
3760 $opline =~ s@//.*@@;
3762 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3763 # the whole statement.
3764 #print "APW <$lines[$realline_next - 1]>\n";
3765 if (defined $realline_next &&
3766 exists $lines[$realline_next - 1] &&
3767 !defined $suppress_export{$realline_next} &&
3768 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3769 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3770 # Handle definitions which produce identifiers with
3773 # EXPORT_SYMBOL(something_foo);
3775 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
3776 $name =~ /^${Ident}_$2/) {
3777 #print "FOO C name<$name>\n";
3778 $suppress_export{$realline_next} = 1;
3780 } elsif ($stat !~ /(?:
3782 ^.DEFINE_$Ident\(\Q$name\E\)|
3783 ^.DECLARE_$Ident\(\Q$name\E\)|
3784 ^.LIST_HEAD\(\Q$name\E\)|
3785 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3786 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
3788 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3789 $suppress_export{$realline_next} = 2;
3791 $suppress_export{$realline_next} = 1;
3794 if (!defined $suppress_export{$linenr} &&
3795 $prevline =~ /^.\s*$/ &&
3796 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3797 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3798 #print "FOO B <$lines[$linenr - 1]>\n";
3799 $suppress_export{$linenr} = 2;
3801 if (defined $suppress_export{$linenr} &&
3802 $suppress_export{$linenr} == 2) {
3803 WARN("EXPORT_SYMBOL",
3804 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
3807 # check for global initialisers.
3808 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
3809 if (ERROR("GLOBAL_INITIALISERS",
3810 "do not initialise globals to $1\n" . $herecurr) &&
3812 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
3815 # check for static initialisers.
3816 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
3817 if (ERROR("INITIALISED_STATIC",
3818 "do not initialise statics to $1\n" .
3821 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
3825 # check for misordered declarations of char/short/int/long with signed/unsigned
3826 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3828 WARN("MISORDERED_TYPE",
3829 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3832 # check for static const char * arrays.
3833 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
3834 WARN("STATIC_CONST_CHAR_ARRAY",
3835 "static const char * array should probably be static const char * const\n" .
3839 # check for static char foo[] = "bar" declarations.
3840 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
3841 WARN("STATIC_CONST_CHAR_ARRAY",
3842 "static char array declaration should probably be static const char\n" .
3846 # check for const <foo> const where <foo> is not a pointer or array type
3847 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3849 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3851 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3852 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3854 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3858 # check for non-global char *foo[] = {"bar", ...} declarations.
3859 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3860 WARN("STATIC_CONST_CHAR_ARRAY",
3861 "char * array declaration might be better as static const\n" .
3865 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3866 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3868 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3870 if (WARN("ARRAY_SIZE",
3871 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3873 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3878 # check for function declarations without arguments like "int foo()"
3879 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3880 if (ERROR("FUNCTION_WITHOUT_ARGS",
3881 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3883 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
3887 # check for new typedefs, only function parameters and sparse annotations
3889 if ($line =~ /\btypedef\s/ &&
3890 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
3891 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
3892 $line !~ /\b$typeTypedefs\b/ &&
3893 $line !~ /\b__bitwise\b/) {
3894 WARN("NEW_TYPEDEFS",
3895 "do not add new typedefs\n" . $herecurr);
3898 # * goes on variable not on type
3900 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3902 my ($ident, $from, $to) = ($1, $2, $2);
3904 # Should start with a space.
3905 $to =~ s/^(\S)/ $1/;
3906 # Should not end with a space.
3908 # '*'s should not have spaces between.
3909 while ($to =~ s/\*\s+\*/\*\*/) {
3912 ## print "1: from<$from> to<$to> ident<$ident>\n";
3914 if (ERROR("POINTER_LOCATION",
3915 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3917 my $sub_from = $ident;
3918 my $sub_to = $ident;
3919 $sub_to =~ s/\Q$from\E/$to/;
3920 $fixed[$fixlinenr] =~
3921 s@\Q$sub_from\E@$sub_to@;
3925 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3927 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
3929 # Should start with a space.
3930 $to =~ s/^(\S)/ $1/;
3931 # Should not end with a space.
3933 # '*'s should not have spaces between.
3934 while ($to =~ s/\*\s+\*/\*\*/) {
3936 # Modifiers should have spaces.
3937 $to =~ s/(\b$Modifier$)/$1 /;
3939 ## print "2: from<$from> to<$to> ident<$ident>\n";
3940 if ($from ne $to && $ident !~ /^$Modifier$/) {
3941 if (ERROR("POINTER_LOCATION",
3942 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3945 my $sub_from = $match;
3946 my $sub_to = $match;
3947 $sub_to =~ s/\Q$from\E/$to/;
3948 $fixed[$fixlinenr] =~
3949 s@\Q$sub_from\E@$sub_to@;
3954 # avoid BUG() or BUG_ON()
3955 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
3956 my $msg_level = \&WARN;
3957 $msg_level = \&CHK if ($file);
3958 &{$msg_level}("AVOID_BUG",
3959 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3962 # avoid LINUX_VERSION_CODE
3963 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
3964 WARN("LINUX_VERSION_CODE",
3965 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3968 # check for uses of printk_ratelimit
3969 if ($line =~ /\bprintk_ratelimit\s*\(/) {
3970 WARN("PRINTK_RATELIMITED",
3971 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
3974 # printk should use KERN_* levels
3975 if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
3976 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3977 "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
3980 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3982 my $level = lc($orig);
3983 $level = "warn" if ($level eq "warning");
3984 my $level2 = $level;
3985 $level2 = "dbg" if ($level eq "debug");
3986 WARN("PREFER_PR_LEVEL",
3987 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
3990 if ($line =~ /\bpr_warning\s*\(/) {
3991 if (WARN("PREFER_PR_LEVEL",
3992 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3994 $fixed[$fixlinenr] =~
3995 s/\bpr_warning\b/pr_warn/;
3999 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
4001 my $level = lc($orig);
4002 $level = "warn" if ($level eq "warning");
4003 $level = "dbg" if ($level eq "debug");
4004 WARN("PREFER_DEV_LEVEL",
4005 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
4008 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
4009 # number of false positives, but assembly files are not checked, so at
4010 # least the arch entry code will not trigger this warning.
4011 if ($line =~ /\bENOSYS\b/) {
4013 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
4016 # function brace can't be on same line, except for #defines of do while,
4017 # or if closed on same line
4018 if ($perl_version_ok &&
4019 $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ &&
4020 $sline !~ /\#\s*define\b.*do\s*\{/ &&
4022 if (ERROR("OPEN_BRACE",
4023 "open brace '{' following function definitions go on the next line\n" . $herecurr) &&
4025 fix_delete_line($fixlinenr, $rawline);
4026 my $fixed_line = $rawline;
4027 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
4030 fix_insert_line($fixlinenr, ltrim($line1));
4031 fix_insert_line($fixlinenr, "\+{");
4032 if ($line2 !~ /^\s*$/) {
4033 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
4038 # open braces for enum, union and struct go on the same line.
4039 if ($line =~ /^.\s*{/ &&
4040 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
4041 if (ERROR("OPEN_BRACE",
4042 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
4043 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4044 fix_delete_line($fixlinenr - 1, $prevrawline);
4045 fix_delete_line($fixlinenr, $rawline);
4046 my $fixedline = rtrim($prevrawline) . " {";
4047 fix_insert_line($fixlinenr, $fixedline);
4048 $fixedline = $rawline;
4049 $fixedline =~ s/^(.\s*)\{\s*/$1\t/;
4050 if ($fixedline !~ /^\+\s*$/) {
4051 fix_insert_line($fixlinenr, $fixedline);
4056 # missing space after union, struct or enum definition
4057 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
4059 "missing space after $1 definition\n" . $herecurr) &&
4061 $fixed[$fixlinenr] =~
4062 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
4066 # Function pointer declarations
4067 # check spacing between type, funcptr, and args
4068 # canonical declaration is "type (*funcptr)(args...)"
4069 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
4071 my $pre_pointer_space = $2;
4072 my $post_pointer_space = $3;
4074 my $post_funcname_space = $5;
4075 my $pre_args_space = $6;
4077 # the $Declare variable will capture all spaces after the type
4078 # so check it for a missing trailing missing space but pointer return types
4079 # don't need a space so don't warn for those.
4080 my $post_declare_space = "";
4081 if ($declare =~ /(\s+)$/) {
4082 $post_declare_space = $1;
4083 $declare = rtrim($declare);
4085 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
4087 "missing space after return type\n" . $herecurr);
4088 $post_declare_space = " ";
4091 # unnecessary space "type (*funcptr)(args...)"
4092 # This test is not currently implemented because these declarations are
4094 # int foo(int bar, ...)
4095 # and this is form shouldn't/doesn't generate a checkpatch warning.
4097 # elsif ($declare =~ /\s{2,}$/) {
4099 # "Multiple spaces after return type\n" . $herecurr);
4102 # unnecessary space "type ( *funcptr)(args...)"
4103 if (defined $pre_pointer_space &&
4104 $pre_pointer_space =~ /^\s/) {
4106 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
4109 # unnecessary space "type (* funcptr)(args...)"
4110 if (defined $post_pointer_space &&
4111 $post_pointer_space =~ /^\s/) {
4113 "Unnecessary space before function pointer name\n" . $herecurr);
4116 # unnecessary space "type (*funcptr )(args...)"
4117 if (defined $post_funcname_space &&
4118 $post_funcname_space =~ /^\s/) {
4120 "Unnecessary space after function pointer name\n" . $herecurr);
4123 # unnecessary space "type (*funcptr) (args...)"
4124 if (defined $pre_args_space &&
4125 $pre_args_space =~ /^\s/) {
4127 "Unnecessary space before function pointer arguments\n" . $herecurr);
4130 if (show_type("SPACING") && $fix) {
4131 $fixed[$fixlinenr] =~
4132 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
4136 # check for spacing round square brackets; allowed:
4137 # 1. with a type on the left -- int [] a;
4138 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4139 # 3. inside a curly brace -- = { [0...10] = 5 }
4140 while ($line =~ /(.*?\s)\[/g) {
4141 my ($where, $prefix) = ($-[1], $1);
4142 if ($prefix !~ /$Type\s+$/ &&
4143 ($where != 0 || $prefix !~ /^.\s+$/) &&
4144 $prefix !~ /[{,:]\s+$/) {
4145 if (ERROR("BRACKET_SPACE",
4146 "space prohibited before open square bracket '['\n" . $herecurr) &&
4148 $fixed[$fixlinenr] =~
4149 s/^(\+.*?)\s+\[/$1\[/;
4154 # check for spaces between functions and their parentheses.
4155 while ($line =~ /($Ident)\s+\(/g) {
4157 my $ctx_before = substr($line, 0, $-[1]);
4158 my $ctx = "$ctx_before$name";
4160 # Ignore those directives where spaces _are_ permitted.
4162 if|for|while|switch|return|case|
4163 volatile|__volatile__|
4164 __attribute__|format|__extension__|
4167 # cpp #define statements have non-optional spaces, ie
4168 # if there is a space between the name and the open
4169 # parenthesis it is simply not a parameter group.
4170 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
4172 # cpp #elif statement condition may start with a (
4173 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
4175 # If this whole things ends with a type its most
4176 # likely a typedef for a function.
4177 } elsif ($ctx =~ /$Type$/) {
4181 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
4183 $fixed[$fixlinenr] =~
4184 s/\b$name\s+\(/$name\(/;
4189 # Check operator spacing.
4190 if (!($line=~/\#\s*include/)) {
4191 my $fixed_line = "";
4195 <<=|>>=|<=|>=|==|!=|
4196 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4197 =>|->|<<|>>|<|>|=|!|~|
4198 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
4201 my @elements = split(/($ops|;)/, $opline);
4203 ## print("element count: <" . $#elements . ">\n");
4204 ## foreach my $el (@elements) {
4205 ## print("el: <$el>\n");
4208 my @fix_elements = ();
4211 foreach my $el (@elements) {
4212 push(@fix_elements, substr($rawline, $off, length($el)));
4213 $off += length($el);
4218 my $blank = copy_spacing($opline);
4219 my $last_after = -1;
4221 for (my $n = 0; $n < $#elements; $n += 2) {
4223 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4225 ## print("n: <$n> good: <$good>\n");
4227 $off += length($elements[$n]);
4229 # Pick up the preceding and succeeding characters.
4230 my $ca = substr($opline, 0, $off);
4232 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4233 $cc = substr($opline, $off + length($elements[$n + 1]));
4235 my $cb = "$ca$;$cc";
4238 $a = 'V' if ($elements[$n] ne '');
4239 $a = 'W' if ($elements[$n] =~ /\s$/);
4240 $a = 'C' if ($elements[$n] =~ /$;$/);
4241 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4242 $a = 'O' if ($elements[$n] eq '');
4243 $a = 'E' if ($ca =~ /^\s*$/);
4245 my $op = $elements[$n + 1];
4248 if (defined $elements[$n + 2]) {
4249 $c = 'V' if ($elements[$n + 2] ne '');
4250 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
4251 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
4252 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4253 $c = 'O' if ($elements[$n + 2] eq '');
4254 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
4259 my $ctx = "${a}x${c}";
4261 my $at = "(ctx:$ctx)";
4263 my $ptr = substr($blank, 0, $off) . "^";
4264 my $hereptr = "$hereline$ptr\n";
4266 # Pull out the value of this operator.
4267 my $op_type = substr($curr_values, $off + 1, 1);
4269 # Get the full operator variant.
4270 my $opv = $op . substr($curr_vars, $off, 1);
4272 # Ignore operators passed as parameters.
4273 if ($op_type ne 'V' &&
4274 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
4277 # } elsif ($op =~ /^$;+$/) {
4279 # ; should have either the end of line or a space or \ after it
4280 } elsif ($op eq ';') {
4281 if ($ctx !~ /.x[WEBC]/ &&
4282 $cc !~ /^\\/ && $cc !~ /^;/) {
4283 if (ERROR("SPACING",
4284 "space required after that '$op' $at\n" . $hereptr)) {
4285 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
4291 } elsif ($op eq '//') {
4293 # : when part of a bitfield
4294 } elsif ($opv eq ':B') {
4295 # skip the bitfield test for now
4299 } elsif ($op eq '->') {
4300 if ($ctx =~ /Wx.|.xW/) {
4301 if (ERROR("SPACING",
4302 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
4303 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4304 if (defined $fix_elements[$n + 2]) {
4305 $fix_elements[$n + 2] =~ s/^\s+//;
4311 # , must not have a space before and must have a space on the right.
4312 } elsif ($op eq ',') {
4313 my $rtrim_before = 0;
4314 my $space_after = 0;
4315 if ($ctx =~ /Wx./) {
4316 if (ERROR("SPACING",
4317 "space prohibited before that '$op' $at\n" . $hereptr)) {
4322 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
4323 if (ERROR("SPACING",
4324 "space required after that '$op' $at\n" . $hereptr)) {
4330 if ($rtrim_before || $space_after) {
4331 if ($rtrim_before) {
4332 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4334 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4341 # '*' as part of a type definition -- reported already.
4342 } elsif ($opv eq '*_') {
4343 #warn "'*' is part of type\n";
4345 # unary operators should have a space before and
4346 # none after. May be left adjacent to another
4347 # unary operator, or a cast
4348 } elsif ($op eq '!' || $op eq '~' ||
4349 $opv eq '*U' || $opv eq '-U' ||
4350 $opv eq '&U' || $opv eq '&&U') {
4351 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
4352 if (ERROR("SPACING",
4353 "space required before that '$op' $at\n" . $hereptr)) {
4354 if ($n != $last_after + 2) {
4355 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4360 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
4361 # A unary '*' may be const
4363 } elsif ($ctx =~ /.xW/) {
4364 if (ERROR("SPACING",
4365 "space prohibited after that '$op' $at\n" . $hereptr)) {
4366 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
4367 if (defined $fix_elements[$n + 2]) {
4368 $fix_elements[$n + 2] =~ s/^\s+//;
4374 # unary ++ and unary -- are allowed no space on one side.
4375 } elsif ($op eq '++' or $op eq '--') {
4376 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
4377 if (ERROR("SPACING",
4378 "space required one side of that '$op' $at\n" . $hereptr)) {
4379 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
4383 if ($ctx =~ /Wx[BE]/ ||
4384 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
4385 if (ERROR("SPACING",
4386 "space prohibited before that '$op' $at\n" . $hereptr)) {
4387 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4391 if ($ctx =~ /ExW/) {
4392 if (ERROR("SPACING",
4393 "space prohibited after that '$op' $at\n" . $hereptr)) {
4394 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4395 if (defined $fix_elements[$n + 2]) {
4396 $fix_elements[$n + 2] =~ s/^\s+//;
4402 # << and >> may either have or not have spaces both sides
4403 } elsif ($op eq '<<' or $op eq '>>' or
4404 $op eq '&' or $op eq '^' or $op eq '|' or
4405 $op eq '+' or $op eq '-' or
4406 $op eq '*' or $op eq '/' or
4410 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4412 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4413 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4414 $fix_elements[$n + 2] =~ s/^\s+//;
4417 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4419 "space preferred before that '$op' $at\n" . $hereptr)) {
4420 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4424 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
4425 if (ERROR("SPACING",
4426 "need consistent spacing around '$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 # A colon needs no spaces before when it is
4436 # terminating a case value or a label.
4437 } elsif ($opv eq ':C' || $opv eq ':L') {
4438 if ($ctx =~ /Wx./) {
4439 if (ERROR("SPACING",
4440 "space prohibited before that '$op' $at\n" . $hereptr)) {
4441 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4446 # All the others need spaces both sides.
4447 } elsif ($ctx !~ /[EWC]x[CWE]/) {
4450 # Ignore email addresses <foo@bar>
4452 $cc =~ /^\S+\@\S+>/) ||
4454 $ca =~ /<\S+\@\S+$/))
4459 # for asm volatile statements
4460 # ignore a colon with another
4461 # colon immediately before or after
4463 ($ca =~ /:$/ || $cc =~ /^:/)) {
4467 # messages are ERROR, but ?: are CHK
4469 my $msg_level = \&ERROR;
4470 $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4472 if (&{$msg_level}("SPACING",
4473 "spaces required around that '$op' $at\n" . $hereptr)) {
4474 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4475 if (defined $fix_elements[$n + 2]) {
4476 $fix_elements[$n + 2] =~ s/^\s+//;
4482 $off += length($elements[$n + 1]);
4484 ## print("n: <$n> GOOD: <$good>\n");
4486 $fixed_line = $fixed_line . $good;
4489 if (($#elements % 2) == 0) {
4490 $fixed_line = $fixed_line . $fix_elements[$#elements];
4493 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4494 $fixed[$fixlinenr] = $fixed_line;
4500 # check for whitespace before a non-naked semicolon
4501 if ($line =~ /^\+.*\S\s+;\s*$/) {
4503 "space prohibited before semicolon\n" . $herecurr) &&
4505 1 while $fixed[$fixlinenr] =~
4506 s/^(\+.*\S)\s+;/$1;/;
4510 # check for multiple assignments
4511 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
4512 CHK("MULTIPLE_ASSIGNMENTS",
4513 "multiple assignments should be avoided\n" . $herecurr);
4516 ## # check for multiple declarations, allowing for a function declaration
4518 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4519 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4521 ## # Remove any bracketed sections to ensure we do not
4522 ## # falsly report the parameters of functions.
4524 ## while ($ln =~ s/\([^\(\)]*\)//g) {
4526 ## if ($ln =~ /,/) {
4527 ## WARN("MULTIPLE_DECLARATION",
4528 ## "declaring multiple variables together should be avoided\n" . $herecurr);
4532 #need space before brace following if, while, etc
4533 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
4534 $line =~ /\b(?:else|do)\{/) {
4535 if (ERROR("SPACING",
4536 "space required before the open brace '{'\n" . $herecurr) &&
4538 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/;
4542 ## # check for blank lines before declarations
4543 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4544 ## $prevrawline =~ /^.\s*$/) {
4546 ## "No blank lines before declarations\n" . $hereprev);
4550 # closing brace should have a space following it when it has anything
4552 if ($line =~ /}(?!(?:,|;|\)))\S/) {
4553 if (ERROR("SPACING",
4554 "space required after that close brace '}'\n" . $herecurr) &&
4556 $fixed[$fixlinenr] =~
4557 s/}((?!(?:,|;|\)))\S)/} $1/;
4561 # check spacing on square brackets
4562 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
4563 if (ERROR("SPACING",
4564 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4566 $fixed[$fixlinenr] =~
4570 if ($line =~ /\s\]/) {
4571 if (ERROR("SPACING",
4572 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4574 $fixed[$fixlinenr] =~
4579 # check spacing on parentheses
4580 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4581 $line !~ /for\s*\(\s+;/) {
4582 if (ERROR("SPACING",
4583 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4585 $fixed[$fixlinenr] =~
4589 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
4590 $line !~ /for\s*\(.*;\s+\)/ &&
4591 $line !~ /:\s+\)/) {
4592 if (ERROR("SPACING",
4593 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4595 $fixed[$fixlinenr] =~
4600 # check unnecessary parentheses around addressof/dereference single $Lvals
4601 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4603 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
4605 if (CHK("UNNECESSARY_PARENTHESES",
4606 "Unnecessary parentheses around $var\n" . $herecurr) &&
4608 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4612 # check for unnecessary parentheses around function pointer uses
4613 # ie: (foo->bar)(); should be foo->bar();
4614 # but not "if (foo->bar) (" to avoid some false positives
4615 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4617 if (CHK("UNNECESSARY_PARENTHESES",
4618 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4620 my $var2 = deparenthesize($var);
4622 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4626 # check for unnecessary parentheses around comparisons in if uses
4627 # when !drivers/staging or command-line uses --strict
4628 if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) &&
4629 $perl_version_ok && defined($stat) &&
4630 $stat =~ /(^.\s*if\s*($balanced_parens))/) {
4632 my $test = substr($2, 1, -1);
4634 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4636 # avoid parentheses around potential macro args
4637 next if ($match =~ /^\s*\w+\s*$/);
4638 if (!defined($herectx)) {
4639 $herectx = $here . "\n";
4640 my $cnt = statement_rawlines($if_stat);
4641 for (my $n = 0; $n < $cnt; $n++) {
4642 my $rl = raw_line($linenr, $n);
4643 $herectx .= $rl . "\n";
4644 last if $rl =~ /^[ \+].*\{/;
4647 CHK("UNNECESSARY_PARENTHESES",
4648 "Unnecessary parentheses around '$match'\n" . $herectx);
4652 #goto labels aren't indented, allow a single space however
4653 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
4654 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
4655 if (WARN("INDENTED_LABEL",
4656 "labels should not be indented\n" . $herecurr) &&
4658 $fixed[$fixlinenr] =~
4663 # return is not a function
4664 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
4666 if ($perl_version_ok &&
4667 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4669 $value = deparenthesize($value);
4670 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4671 ERROR("RETURN_PARENTHESES",
4672 "return is not a function, parentheses are not required\n" . $herecurr);
4674 } elsif ($spacing !~ /\s+/) {
4676 "space required before the open parenthesis '('\n" . $herecurr);
4680 # unnecessary return in a void function
4681 # at end-of-function, with the previous line a single leading tab, then return;
4682 # and the line before that not a goto label target like "out:"
4683 if ($sline =~ /^[ \+]}\s*$/ &&
4684 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4686 $lines[$linenr - 3] =~ /^[ +]/ &&
4687 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
4689 "void function return statements are not generally useful\n" . $hereprev);
4692 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4693 if ($perl_version_ok &&
4694 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4695 my $openparens = $1;
4696 my $count = $openparens =~ tr@\(@\(@;
4698 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4699 my $comp = $4; #Not $1 because of $LvalOrFunc
4700 $msg = " - maybe == should be = ?" if ($comp eq "==");
4701 WARN("UNNECESSARY_PARENTHESES",
4702 "Unnecessary parentheses$msg\n" . $herecurr);
4706 # comparisons with a constant or upper case identifier on the left
4707 # avoid cases like "foo + BAR < baz"
4708 # only fix matches surrounded by parentheses to avoid incorrect
4709 # conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4710 if ($perl_version_ok &&
4711 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4716 my $newcomp = $comp;
4717 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
4718 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4719 WARN("CONSTANT_COMPARISON",
4720 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4724 } elsif ($comp eq "<=") {
4726 } elsif ($comp eq ">") {
4728 } elsif ($comp eq ">=") {
4731 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4735 # Return of what appears to be an errno should normally be negative
4736 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
4738 if ($name ne 'EOF' && $name ne 'ERROR') {
4739 WARN("USE_NEGATIVE_ERRNO",
4740 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
4744 # Need a space before open parenthesis after if, while etc
4745 if ($line =~ /\b(if|while|for|switch)\(/) {
4746 if (ERROR("SPACING",
4747 "space required before the open parenthesis '('\n" . $herecurr) &&
4749 $fixed[$fixlinenr] =~
4750 s/\b(if|while|for|switch)\(/$1 \(/;
4754 # Check for illegal assignment in if conditional -- and check for trailing
4755 # statements after the conditional.
4756 if ($line =~ /do\s*(?!{)/) {
4757 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4758 ctx_statement_block($linenr, $realcnt, 0)
4759 if (!defined $stat);
4760 my ($stat_next) = ctx_statement_block($line_nr_next,
4761 $remain_next, $off_next);
4762 $stat_next =~ s/\n./\n /g;
4763 ##print "stat<$stat> stat_next<$stat_next>\n";
4765 if ($stat_next =~ /^\s*while\b/) {
4766 # If the statement carries leading newlines,
4767 # then count those as offsets.
4769 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4771 statement_rawlines($whitespace) - 1;
4773 $suppress_whiletrailers{$line_nr_next +
4777 if (!defined $suppress_whiletrailers{$linenr} &&
4778 defined($stat) && defined($cond) &&
4779 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
4780 my ($s, $c) = ($stat, $cond);
4782 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
4783 ERROR("ASSIGN_IN_IF",
4784 "do not use assignment in if condition\n" . $herecurr);
4787 # Find out what is on the end of the line after the
4789 substr($s, 0, length($c), '');
4791 $s =~ s/$;//g; # Remove any comments
4792 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4793 $c !~ /}\s*while\s*/)
4795 # Find out how long the conditional actually is.
4796 my @newlines = ($c =~ /\n/gs);
4797 my $cond_lines = 1 + $#newlines;
4800 $stat_real = raw_line($linenr, $cond_lines)
4801 . "\n" if ($cond_lines);
4802 if (defined($stat_real) && $cond_lines > 1) {
4803 $stat_real = "[...]\n$stat_real";
4806 ERROR("TRAILING_STATEMENTS",
4807 "trailing statements should be on next line\n" . $herecurr . $stat_real);
4811 # Check for bitwise tests written as boolean
4823 WARN("HEXADECIMAL_BOOLEAN_TEST",
4824 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
4827 # if and else should not have general statements after it
4828 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4830 $s =~ s/$;//g; # Remove any comments
4831 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
4832 ERROR("TRAILING_STATEMENTS",
4833 "trailing statements should be on next line\n" . $herecurr);
4836 # if should not continue a brace
4837 if ($line =~ /}\s*if\b/) {
4838 ERROR("TRAILING_STATEMENTS",
4839 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
4842 # case and default should not have general statements after them
4843 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4845 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
4849 ERROR("TRAILING_STATEMENTS",
4850 "trailing statements should be on next line\n" . $herecurr);
4853 # Check for }<nl>else {, these must be at the same
4854 # indent level to be relevant to each other.
4855 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4856 $previndent == $indent) {
4857 if (ERROR("ELSE_AFTER_BRACE",
4858 "else should follow close brace '}'\n" . $hereprev) &&
4859 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4860 fix_delete_line($fixlinenr - 1, $prevrawline);
4861 fix_delete_line($fixlinenr, $rawline);
4862 my $fixedline = $prevrawline;
4863 $fixedline =~ s/}\s*$//;
4864 if ($fixedline !~ /^\+\s*$/) {
4865 fix_insert_line($fixlinenr, $fixedline);
4867 $fixedline = $rawline;
4868 $fixedline =~ s/^(.\s*)else/$1} else/;
4869 fix_insert_line($fixlinenr, $fixedline);
4873 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4874 $previndent == $indent) {
4875 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4877 # Find out what is on the end of the line after the
4879 substr($s, 0, length($c), '');
4882 if ($s =~ /^\s*;/) {
4883 if (ERROR("WHILE_AFTER_BRACE",
4884 "while should follow close brace '}'\n" . $hereprev) &&
4885 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4886 fix_delete_line($fixlinenr - 1, $prevrawline);
4887 fix_delete_line($fixlinenr, $rawline);
4888 my $fixedline = $prevrawline;
4889 my $trailing = $rawline;
4890 $trailing =~ s/^\+//;
4891 $trailing = trim($trailing);
4892 $fixedline =~ s/}\s*$/} $trailing/;
4893 fix_insert_line($fixlinenr, $fixedline);
4898 #Specific variable tests
4899 while ($line =~ m{($Constant|$Lval)}g) {
4902 #gcc binary extension
4903 if ($var =~ /^$Binary$/) {
4904 if (WARN("GCC_BINARY_CONSTANT",
4905 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4907 my $hexval = sprintf("0x%x", oct($var));
4908 $fixed[$fixlinenr] =~
4909 s/\b$var\b/$hexval/;
4914 if ($var !~ /^$Constant$/ &&
4915 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
4916 #Ignore Page<foo> variants
4917 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
4918 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4919 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4920 #Ignore some three character SI units explicitly, like MiB and KHz
4921 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
4922 while ($var =~ m{($Ident)}g) {
4924 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
4926 seed_camelcase_includes();
4927 if (!$file && !$camelcase_file_seeded) {
4928 seed_camelcase_file($realfile);
4929 $camelcase_file_seeded = 1;
4932 if (!defined $camelcase{$word}) {
4933 $camelcase{$word} = 1;
4935 "Avoid CamelCase: <$word>\n" . $herecurr);
4941 #no spaces allowed after \ in define
4942 if ($line =~ /\#\s*define.*\\\s+$/) {
4943 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4944 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4946 $fixed[$fixlinenr] =~ s/\s+$//;
4950 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4951 # itself <asm/foo.h> (uses RAW line)
4952 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
4954 my $checkfile = "include/linux/$file";
4955 if (-f "$root/$checkfile" &&
4956 $realfile ne $checkfile &&
4957 $1 !~ /$allowed_asm_includes/)
4959 my $asminclude = `grep -Ec
"#include\\s+<asm/$file>" $root/$checkfile`;
4960 if ($asminclude > 0) {
4961 if ($realfile =~ m{^arch/}) {
4962 CHK
("ARCH_INCLUDE_LINUX",
4963 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4965 WARN
("INCLUDE_LINUX",
4966 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4972 # multi-statement macros should be enclosed in a do while loop, grab the
4973 # first statement and ensure its the whole macro if its not enclosed
4974 # in a known good container
4975 if ($realfile !~ m
@/vmlinux.lds
.h
$@ &&
4976 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
4979 my ($off, $dstat, $dcond, $rest);
4981 my $has_flow_statement = 0;
4982 my $has_arg_concat = 0;
4983 ($dstat, $dcond, $ln, $cnt, $off) =
4984 ctx_statement_block
($linenr, $realcnt, 0);
4986 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4987 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4989 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
4990 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
4992 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
4993 my $define_args = $1;
4994 my $define_stmt = $dstat;
4997 if (defined $define_args && $define_args ne "") {
4998 $define_args = substr($define_args, 1, length($define_args) - 2);
4999 $define_args =~ s/\s*//g;
5000 $define_args =~ s/\\\+?//g;
5001 @def_args = split(",", $define_args);
5005 $dstat =~ s/\\\n.//g;
5006 $dstat =~ s/^\s*//s;
5007 $dstat =~ s/\s*$//s;
5009 # Flatten any parentheses and braces
5010 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
5011 $dstat =~ s/\{[^\{\}]*\}/1/ ||
5012 $dstat =~ s/.\[[^\[\]]*\]/1/)
5016 # Flatten any obvious string concatentation.
5017 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
5018 $dstat =~ s/$Ident\s*($String)/$1/)
5022 # Make asm volatile uses seem like a generic function
5023 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
5025 my $exceptions = qr{
5038 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
5041 my $stmt_cnt = statement_rawlines
($ctx);
5042 my $herectx = get_stat_here
($linenr, $stmt_cnt, $here);
5045 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
5046 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
5047 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
5048 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
5049 $dstat !~ /$exceptions/ &&
5050 $dstat !~ /^\.$Ident\s*=/ && # .foo =
5051 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
5052 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
5053 $dstat !~ /^for\s*$Constant$/ && # for (...)
5054 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
5055 $dstat !~ /^do\s*{/ && # do {...
5056 $dstat !~ /^\(\{/ && # ({...
5057 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
5059 if ($dstat =~ /^\s*if\b/) {
5060 ERROR
("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5061 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5062 } elsif ($dstat =~ /;/) {
5063 ERROR
("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5064 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
5066 ERROR
("COMPLEX_MACRO",
5067 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
5072 # Make $define_stmt single line, comment-free, etc
5073 my @stmt_array = split('\n', $define_stmt);
5076 foreach my $l (@stmt_array) {
5081 } elsif ($l =~ /^[\+ ]/) {
5082 $define_stmt .= substr($l, 1);
5085 $define_stmt =~ s/$;//g;
5086 $define_stmt =~ s/\s+/ /g;
5087 $define_stmt = trim
($define_stmt);
5089 # check if any macro arguments are reused (ignore '...' and 'type')
5090 foreach my $arg (@def_args) {
5091 next if ($arg =~ /\.\.\./);
5092 next if ($arg =~ /^type$/i);
5093 my $tmp_stmt = $define_stmt;
5094 $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
5095 $tmp_stmt =~ s/\#+\s*$arg\b//g;
5096 $tmp_stmt =~ s/\b$arg\s*\#\#//g;
5097 my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g;
5099 CHK
("MACRO_ARG_REUSE",
5100 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
5102 # check if any macro arguments may have other precedence issues
5103 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
5104 ((defined($1) && $1 ne ',') ||
5105 (defined($2) && $2 ne ','))) {
5106 CHK
("MACRO_ARG_PRECEDENCE",
5107 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
5111 # check for macros with flow control, but without ## concatenation
5112 # ## concatenation is commonly a macro that defines a function so ignore those
5113 if ($has_flow_statement && !$has_arg_concat) {
5114 my $cnt = statement_rawlines
($ctx);
5115 my $herectx = get_stat_here
($linenr, $cnt, $here);
5117 WARN
("MACRO_WITH_FLOW_CONTROL",
5118 "Macros with flow control statements should be avoided\n" . "$herectx");
5121 # check for line continuations outside of #defines, preprocessor #, and asm
5124 if ($prevline !~ /^..*\\$/ &&
5125 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
5126 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
5127 $line =~ /^\+.*\\$/) {
5128 WARN
("LINE_CONTINUATIONS",
5129 "Avoid unnecessary line continuations\n" . $herecurr);
5133 # do {} while (0) macro tests:
5134 # single-statement macros do not need to be enclosed in do while (0) loop,
5135 # macro should not end with a semicolon
5136 if ($perl_version_ok &&
5137 $realfile !~ m
@/vmlinux.lds
.h
$@ &&
5138 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
5141 my ($off, $dstat, $dcond, $rest);
5143 ($dstat, $dcond, $ln, $cnt, $off) =
5144 ctx_statement_block
($linenr, $realcnt, 0);
5147 $dstat =~ s/\\\n.//g;
5150 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5155 my $cnt = statement_rawlines
($ctx);
5156 my $herectx = get_stat_here
($linenr, $cnt, $here);
5158 if (($stmts =~ tr/;/;/) == 1 &&
5159 $stmts !~ /^\s*(if|while|for|switch)\b/) {
5160 WARN
("SINGLE_STATEMENT_DO_WHILE_MACRO",
5161 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
5163 if (defined $semis && $semis ne "") {
5164 WARN
("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
5165 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
5167 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
5169 my $cnt = statement_rawlines
($ctx);
5170 my $herectx = get_stat_here
($linenr, $cnt, $here);
5172 WARN
("TRAILING_SEMICOLON",
5173 "macros should not use a trailing semicolon\n" . "$herectx");
5177 # check for redundant bracing round if etc
5178 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
5179 my ($level, $endln, @chunks) =
5180 ctx_statement_full
($linenr, $realcnt, 1);
5181 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
5182 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5183 if ($#chunks > 0 && $level == 0) {
5187 my $herectx = $here . "\n";
5188 my $ln = $linenr - 1;
5189 for my $chunk (@chunks) {
5190 my ($cond, $block) = @{$chunk};
5192 # If the condition carries leading newlines, then count those as offsets.
5193 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5194 my $offset = statement_rawlines
($whitespace) - 1;
5196 $allowed[$allow] = 0;
5197 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5199 # We have looked at and allowed this specific line.
5200 $suppress_ifbraces{$ln + $offset} = 1;
5202 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
5203 $ln += statement_rawlines
($block) - 1;
5205 substr($block, 0, length($cond), '');
5207 $seen++ if ($block =~ /^\s*{/);
5209 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5210 if (statement_lines
($cond) > 1) {
5211 #print "APW: ALLOWED: cond<$cond>\n";
5212 $allowed[$allow] = 1;
5214 if ($block =~/\b(?:if|for|while)\b/) {
5215 #print "APW: ALLOWED: block<$block>\n";
5216 $allowed[$allow] = 1;
5218 if (statement_block_size
($block) > 1) {
5219 #print "APW: ALLOWED: lines block<$block>\n";
5220 $allowed[$allow] = 1;
5225 my $sum_allowed = 0;
5226 foreach (@allowed) {
5229 if ($sum_allowed == 0) {
5231 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5232 } elsif ($sum_allowed != $allow &&
5235 "braces {} should be used on all arms of this statement\n" . $herectx);
5240 if (!defined $suppress_ifbraces{$linenr - 1} &&
5241 $line =~ /\b(if|while|for|else)\b/) {
5244 # Check the pre-context.
5245 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5246 #print "APW: ALLOWED: pre<$1>\n";
5250 my ($level, $endln, @chunks) =
5251 ctx_statement_full
($linenr, $realcnt, $-[0]);
5253 # Check the condition.
5254 my ($cond, $block) = @{$chunks[0]};
5255 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5256 if (defined $cond) {
5257 substr($block, 0, length($cond), '');
5259 if (statement_lines
($cond) > 1) {
5260 #print "APW: ALLOWED: cond<$cond>\n";
5263 if ($block =~/\b(?:if|for|while)\b/) {
5264 #print "APW: ALLOWED: block<$block>\n";
5267 if (statement_block_size
($block) > 1) {
5268 #print "APW: ALLOWED: lines block<$block>\n";
5271 # Check the post-context.
5272 if (defined $chunks[1]) {
5273 my ($cond, $block) = @{$chunks[1]};
5274 if (defined $cond) {
5275 substr($block, 0, length($cond), '');
5277 if ($block =~ /^\s*\{/) {
5278 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5282 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
5283 my $cnt = statement_rawlines
($block);
5284 my $herectx = get_stat_here
($linenr, $cnt, $here);
5287 "braces {} are not necessary for single statement blocks\n" . $herectx);
5291 # check for single line unbalanced braces
5292 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
5293 $sline =~ /^.\s*else\s*\{\s*$/) {
5294 CHK
("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
5297 # check for unnecessary blank lines around braces
5298 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
5300 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5301 $fix && $prevrawline =~ /^\+/) {
5302 fix_delete_line
($fixlinenr - 1, $prevrawline);
5305 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
5307 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5309 fix_delete_line
($fixlinenr, $rawline);
5313 # no volatiles please
5314 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5315 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
5317 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
5320 # Check for user-visible strings broken across lines, which breaks the ability
5321 # to grep for the string. Make exceptions when the previous string ends in a
5322 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5323 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
5324 if ($line =~ /^\+\s*$String/ &&
5325 $prevline =~ /"\s*$/ &&
5326 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5327 if (WARN
("SPLIT_STRING",
5328 "quoted string split across lines\n" . $hereprev) &&
5330 $prevrawline =~ /^\+.*"\s*$/ &&
5331 $last_coalesced_string_linenr != $linenr - 1) {
5332 my $extracted_string = get_quoted_string
($line, $rawline);
5333 my $comma_close = "";
5334 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5338 fix_delete_line
($fixlinenr - 1, $prevrawline);
5339 fix_delete_line
($fixlinenr, $rawline);
5340 my $fixedline = $prevrawline;
5341 $fixedline =~ s/"\s*$//;
5342 $fixedline .= substr($extracted_string, 1) . trim
($comma_close);
5343 fix_insert_line
($fixlinenr - 1, $fixedline);
5344 $fixedline = $rawline;
5345 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5346 if ($fixedline !~ /\+\s*$/) {
5347 fix_insert_line
($fixlinenr, $fixedline);
5349 $last_coalesced_string_linenr = $linenr;
5353 # check for missing a space in a string concatenation
5354 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5355 WARN
('MISSING_SPACE',
5356 "break quoted strings at a space character\n" . $hereprev);
5359 # check for an embedded function name in a string when the function is known
5360 # This does not work very well for -f --file checking as it depends on patch
5361 # context providing the function name or a single line form for in-file
5362 # function declarations
5363 if ($line =~ /^\+.*$String/ &&
5364 defined($context_function) &&
5365 get_quoted_string
($line, $rawline) =~ /\b$context_function\b/ &&
5366 length(get_quoted_string
($line, $rawline)) != (length($context_function) + 2)) {
5367 WARN
("EMBEDDED_FUNCTION_NAME",
5368 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
5371 # check for spaces before a quoted newline
5372 if ($rawline =~ /^.*\".*\s\\n/) {
5373 if (WARN
("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5374 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5376 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5381 # concatenated string without spaces between elements
5382 if ($line =~ /$String[A-Za-z0-9_]/ || $line =~ /[A-Za-z0-9_]$String/) {
5383 if (CHK
("CONCATENATED_STRING",
5384 "Concatenated strings should use spaces between elements\n" . $herecurr) &&
5386 while ($line =~ /($String)/g) {
5387 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5388 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/;
5389 $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/;
5394 # uncoalesced string fragments
5395 if ($line =~ /$String\s*"/) {
5396 if (WARN
("STRING_FRAGMENTS",
5397 "Consecutive strings are generally better as a single string\n" . $herecurr) &&
5399 while ($line =~ /($String)(?=\s*")/g) {
5400 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5401 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e;
5406 # check for non-standard and hex prefixed decimal printf formats
5407 my $show_L = 1; #don't show the same defect twice
5409 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
5410 my $string = substr($rawline, $-[1], $+[1] - $-[1]);
5411 $string =~ s/%%/__/g;
5413 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
5415 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
5419 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
5421 "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
5424 # check for 0x<decimal>
5425 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
5426 ERROR
("PRINTF_0XDECIMAL",
5427 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5431 # check for line continuations in quoted strings with odd counts of "
5432 if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
5433 WARN
("LINE_CONTINUATIONS",
5434 "Avoid line continuations in quoted strings\n" . $herecurr);
5438 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
5440 "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr);
5444 if ($line =~ /^.\s*\#\s*if\s+1\b/) {
5446 "Consider removing the #if 1 and its #endif\n" . $herecurr);
5449 # check for needless "if (<foo>) fn(<foo>)" uses
5450 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
5451 my $tested = quotemeta($1);
5452 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5453 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5455 if (WARN
('NEEDLESS_IF',
5456 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5459 my $leading_tabs = "";
5460 my $new_leading_tabs = "";
5461 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5466 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5467 $new_leading_tabs = $1;
5468 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5475 fix_delete_line
($fixlinenr - 1, $prevrawline);
5476 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5482 # check for unnecessary "Out of Memory" messages
5483 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5484 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5485 (defined $1 || defined $3) &&
5488 my $testline = $lines[$linenr - 3];
5490 my ($s, $c) = ctx_statement_block
($linenr - 3, $realcnt, 0);
5491 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5493 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|kmemdup|(?:dev_)?alloc_skb)/) {
5495 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5499 # check for logging functions with KERN_<LEVEL>
5500 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
5501 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5503 if (WARN
("UNNECESSARY_KERN_LEVEL",
5504 "Possible unnecessary $level\n" . $herecurr) &&
5506 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5510 # check for logging continuations
5511 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
5512 WARN
("LOGGING_CONTINUATION",
5513 "Avoid logging continuation uses where feasible\n" . $herecurr);
5516 # check for mask then right shift without a parentheses
5517 if ($perl_version_ok &&
5518 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5519 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5520 WARN
("MASK_THEN_SHIFT",
5521 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5524 # check for pointer comparisons to NULL
5525 if ($perl_version_ok) {
5526 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5529 $equal = "" if ($4 eq "!=");
5530 if (CHK
("COMPARISON_TO_NULL",
5531 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5533 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5538 # check for bad placement of section $InitAttribute (e.g.: __initdata)
5539 if ($line =~ /(\b$InitAttribute\b)/) {
5541 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5544 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5545 ERROR
("MISPLACED_INIT",
5546 "$attr should be placed after $var\n" . $herecurr)) ||
5547 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5548 WARN
("MISPLACED_INIT",
5549 "$attr should be placed after $var\n" . $herecurr))) &&
5551 $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;
5556 # check for $InitAttributeData (ie: __initdata) with const
5557 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5559 $attr =~ /($InitAttributePrefix)(.*)/;
5560 my $attr_prefix = $1;
5562 if (ERROR
("INIT_ATTRIBUTE",
5563 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5565 $fixed[$fixlinenr] =~
5566 s/$InitAttributeData/${attr_prefix}initconst/;
5570 # check for $InitAttributeConst (ie: __initconst) without const
5571 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5573 if (ERROR
("INIT_ATTRIBUTE",
5574 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5576 my $lead = $fixed[$fixlinenr] =~
5577 /(^\+\s*(?:static\s+))/;
5579 $lead = "$lead " if ($lead !~ /^\+$/);
5580 $lead = "${lead}const ";
5581 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
5585 # check for __read_mostly with const non-pointer (should just be const)
5586 if ($line =~ /\b__read_mostly\b/ &&
5587 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5588 if (ERROR
("CONST_READ_MOSTLY",
5589 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5591 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5595 # don't use __constant_<foo> functions outside of include/uapi/
5596 if ($realfile !~ m
@^include/uapi/@ &&
5597 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5598 my $constant_func = $1;
5599 my $func = $constant_func;
5600 $func =~ s/^__constant_//;
5601 if (WARN
("CONSTANT_CONVERSION",
5602 "$constant_func should be $func\n" . $herecurr) &&
5604 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
5608 # prefer usleep_range over udelay
5609 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
5611 # ignore udelay's < 10, however
5612 if (! ($delay < 10) ) {
5614 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5616 if ($delay > 2000) {
5618 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
5622 # warn about unexpectedly long msleep's
5623 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5626 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5630 # check for comparisons of jiffies
5631 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5632 WARN
("JIFFIES_COMPARISON",
5633 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5636 # check for comparisons of get_jiffies_64()
5637 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5638 WARN
("JIFFIES_COMPARISON",
5639 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5642 # warn about #ifdefs in C files
5643 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5644 # print "#ifdef in C files should be avoided\n";
5645 # print "$herecurr";
5649 # warn about spacing in #ifdefs
5650 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
5651 if (ERROR
("SPACING",
5652 "exactly one space required after that #$1\n" . $herecurr) &&
5654 $fixed[$fixlinenr] =~
5655 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5660 # check for spinlock_t definitions without a comment.
5661 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5662 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
5664 if (!ctx_has_comment
($first_line, $linenr)) {
5665 CHK
("UNCOMMENTED_DEFINITION",
5666 "$1 definition without comment\n" . $herecurr);
5669 # check for memory barriers without a comment.
5675 read_barrier_depends
5677 my $barrier_stems = qr{
5685 my $all_barriers = qr{
5687 smp_
(?
:$barrier_stems)|
5688 virt_
(?
:$barrier_stems)
5691 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
5692 if (!ctx_has_comment
($first_line, $linenr)) {
5693 WARN
("MEMORY_BARRIER",
5694 "memory barrier without comment\n" . $herecurr);
5698 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5700 if ($realfile !~ m
@^include/asm-generic
/@ &&
5701 $realfile !~ m
@/barrier\.h
$@ &&
5702 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5703 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5704 WARN
("MEMORY_BARRIER",
5705 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5708 # check for waitqueue_active without a comment.
5709 if ($line =~ /\bwaitqueue_active\s*\(/) {
5710 if (!ctx_has_comment
($first_line, $linenr)) {
5711 WARN
("WAITQUEUE_ACTIVE",
5712 "waitqueue_active without comment\n" . $herecurr);
5716 # check for smp_read_barrier_depends and read_barrier_depends
5717 if (!$file && $line =~ /\b(smp_|)read_barrier_depends\s*\(/) {
5718 WARN
("READ_BARRIER_DEPENDS",
5719 "$1read_barrier_depends should only be used in READ_ONCE or DEC Alpha code\n" . $herecurr);
5722 # check of hardware specific defines
5723 if ($line =~ m
@^.\s
*\#\s
*if.*\b(__i386__
|__powerpc64__
|__sun__
|__s390x__
)\b@ && $realfile !~ m
@include/asm-@) {
5725 "architecture specific defines should be avoided\n" . $herecurr);
5728 # check that the storage class is not after a type
5729 if ($line =~ /\b($Type)\s+($Storage)\b/) {
5730 WARN
("STORAGE_CLASS",
5731 "storage class '$2' should be located before type '$1'\n" . $herecurr);
5733 # Check that the storage class is at the beginning of a declaration
5734 if ($line =~ /\b$Storage\b/ &&
5735 $line !~ /^.\s*$Storage/ &&
5736 $line =~ /^.\s*(.+?)\$Storage\s/ &&
5737 $1 !~ /[\,\)]\s*$/) {
5738 WARN
("STORAGE_CLASS",
5739 "storage class should be at the beginning of the declaration\n" . $herecurr);
5742 # check the location of the inline attribute, that it is between
5743 # storage class and type.
5744 if ($line =~ /\b$Type\s+$Inline\b/ ||
5745 $line =~ /\b$Inline\s+$Storage\b/) {
5746 ERROR
("INLINE_LOCATION",
5747 "inline keyword should sit between storage class and type\n" . $herecurr);
5750 # Check for __inline__ and __inline, prefer inline
5751 if ($realfile !~ m
@\binclude/uapi/@ &&
5752 $line =~ /\b(__inline__|__inline)\b/) {
5754 "plain inline is preferred over $1\n" . $herecurr) &&
5756 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
5761 # Check for __attribute__ packed, prefer __packed
5762 if ($realfile !~ m
@\binclude/uapi/@ &&
5763 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
5764 WARN
("PREFER_PACKED",
5765 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
5768 # Check for __attribute__ aligned, prefer __aligned
5769 if ($realfile !~ m
@\binclude/uapi/@ &&
5770 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
5771 WARN
("PREFER_ALIGNED",
5772 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
5775 # Check for __attribute__ format(printf, prefer __printf
5776 if ($realfile !~ m
@\binclude/uapi/@ &&
5777 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
5778 if (WARN
("PREFER_PRINTF",
5779 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5781 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5786 # Check for __attribute__ format(scanf, prefer __scanf
5787 if ($realfile !~ m
@\binclude/uapi/@ &&
5788 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
5789 if (WARN
("PREFER_SCANF",
5790 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5792 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5796 # Check for __attribute__ weak, or __weak declarations (may have link issues)
5797 if ($perl_version_ok &&
5798 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5799 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5800 $line =~ /\b__weak\b/)) {
5801 ERROR
("WEAK_DECLARATION",
5802 "Using weak declarations can have unintended link defects\n" . $herecurr);
5805 # check for c99 types like uint8_t used outside of uapi/ and tools/
5806 if ($realfile !~ m
@\binclude/uapi/@ &&
5807 $realfile !~ m
@\btools/@ &&
5808 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5810 if ($type =~ /\b($typeC99Typedefs)\b/) {
5812 my $kernel_type = 'u';
5813 $kernel_type = 's' if ($type =~ /^_*[si]/);
5816 if (CHK
("PREFER_KERNEL_TYPES",
5817 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5819 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5824 # check for cast of C90 native int or longer types constants
5825 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5828 if (WARN
("TYPECAST_INT_CONSTANT",
5829 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5832 my $newconst = $const;
5833 $newconst =~ s/${Int_type}$//;
5834 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5835 if ($cast =~ /\blong\s+long\b/) {
5837 } elsif ($cast =~ /\blong\b/) {
5840 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5844 # check for sizeof(&)
5845 if ($line =~ /\bsizeof\s*\(\s*\&/) {
5846 WARN
("SIZEOF_ADDRESS",
5847 "sizeof(& should be avoided\n" . $herecurr);
5850 # check for sizeof without parenthesis
5851 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
5852 if (WARN
("SIZEOF_PARENTHESIS",
5853 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5855 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5859 # check for struct spinlock declarations
5860 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5861 WARN
("USE_SPINLOCK_T",
5862 "struct spinlock should be spinlock_t\n" . $herecurr);
5865 # check for seq_printf uses that could be seq_puts
5866 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
5867 my $fmt = get_quoted_string
($line, $rawline);
5870 if (WARN
("PREFER_SEQ_PUTS",
5871 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5873 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
5878 # check for vsprintf extension %p<foo> misuses
5879 if ($perl_version_ok &&
5881 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
5882 $1 !~ /^_*volatile_*$/) {
5885 my $lc = $stat =~ tr
@\n@@;
5886 $lc = $lc + $linenr;
5887 for (my $count = $linenr; $count <= $lc; $count++) {
5890 my $bad_specifier = "";
5891 my $fmt = get_quoted_string
($lines[$count - 1], raw_line
($count, 0));
5894 while ($fmt =~ /(\%[\*\d\.]*p(\w))/g) {
5897 if ($extension !~ /[SsBKRraEhMmIiUDdgVCbGNOx]/) {
5898 $bad_specifier = $specifier;
5901 if ($extension eq "x" && !defined($stat_real)) {
5902 if (!defined($stat_real)) {
5903 $stat_real = get_stat_real
($linenr, $lc);
5905 WARN
("VSPRINTF_SPECIFIER_PX",
5906 "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");
5909 if ($bad_specifier ne "") {
5910 my $stat_real = get_stat_real
($linenr, $lc);
5911 my $ext_type = "Invalid";
5913 if ($bad_specifier =~ /p[Ff]/) {
5914 $ext_type = "Deprecated";
5915 $use = " - use %pS instead";
5916 $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/);
5919 WARN
("VSPRINTF_POINTER_EXTENSION",
5920 "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n");
5925 # Check for misused memsets
5926 if ($perl_version_ok &&
5928 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
5934 if ($ms_size =~ /^(0x|)0$/i) {
5936 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
5937 } elsif ($ms_size =~ /^(0x|)1$/i) {
5939 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5943 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5944 # if ($perl_version_ok &&
5946 # $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5947 # if (WARN("PREFER_ETHER_ADDR_COPY",
5948 # "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5950 # $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5954 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5955 # if ($perl_version_ok &&
5957 # $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5958 # WARN("PREFER_ETHER_ADDR_EQUAL",
5959 # "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5962 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5963 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5964 # if ($perl_version_ok &&
5966 # $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5970 # if ($ms_val =~ /^(?:0x|)0+$/i) {
5971 # if (WARN("PREFER_ETH_ZERO_ADDR",
5972 # "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5974 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5976 # } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5977 # if (WARN("PREFER_ETH_BROADCAST_ADDR",
5978 # "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5980 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5985 # typecasts on min/max could be min_t/max_t
5986 if ($perl_version_ok &&
5988 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
5989 if (defined $2 || defined $7) {
5991 my $cast1 = deparenthesize
($2);
5993 my $cast2 = deparenthesize
($7);
5997 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
5998 $cast = "$cast1 or $cast2";
5999 } elsif ($cast1 ne "") {
6005 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
6009 # check usleep_range arguments
6010 if ($perl_version_ok &&
6012 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
6016 WARN
("USLEEP_RANGE",
6017 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
6018 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
6020 WARN
("USLEEP_RANGE",
6021 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
6025 # check for naked sscanf
6026 if ($perl_version_ok &&
6028 $line =~ /\bsscanf\b/ &&
6029 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
6030 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
6031 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
6032 my $lc = $stat =~ tr
@\n@@;
6033 $lc = $lc + $linenr;
6034 my $stat_real = get_stat_real
($linenr, $lc);
6035 WARN
("NAKED_SSCANF",
6036 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
6039 # check for simple sscanf that should be kstrto<foo>
6040 if ($perl_version_ok &&
6042 $line =~ /\bsscanf\b/) {
6043 my $lc = $stat =~ tr
@\n@@;
6044 $lc = $lc + $linenr;
6045 my $stat_real = get_stat_real
($linenr, $lc);
6046 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
6048 my $count = $format =~ tr
@%@%@;
6050 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
6051 WARN
("SSCANF_TO_KSTRTO",
6052 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
6057 # check for new externs in .h files.
6058 if ($realfile =~ /\.h$/ &&
6059 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
6060 if (CHK
("AVOID_EXTERNS",
6061 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
6063 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
6067 # check for new externs in .c files.
6068 if ($realfile =~ /\.c$/ && defined $stat &&
6069 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
6071 my $function_name = $1;
6072 my $paren_space = $2;
6075 if (defined $cond) {
6076 substr($s, 0, length($cond), '');
6078 if ($s =~ /^\s*;/ &&
6079 $function_name ne 'uninitialized_var')
6081 WARN
("AVOID_EXTERNS",
6082 "externs should be avoided in .c files\n" . $herecurr);
6085 if ($paren_space =~ /\n/) {
6086 WARN
("FUNCTION_ARGUMENTS",
6087 "arguments for function declarations should follow identifier\n" . $herecurr);
6090 } elsif ($realfile =~ /\.c$/ && defined $stat &&
6091 $stat =~ /^.\s*extern\s+/)
6093 WARN
("AVOID_EXTERNS",
6094 "externs should be avoided in .c files\n" . $herecurr);
6097 # check for function declarations that have arguments without identifier names
6098 if (defined $stat &&
6099 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
6101 my $args = trim
($1);
6102 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
6104 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
6105 WARN
("FUNCTION_ARGUMENTS",
6106 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
6111 # check for function definitions
6112 if ($perl_version_ok &&
6114 $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
6115 $context_function = $1;
6117 # check for multiline function definition with misplaced open brace
6119 my $cnt = statement_rawlines
($stat);
6120 my $herectx = $here . "\n";
6121 for (my $n = 0; $n < $cnt; $n++) {
6122 my $rl = raw_line
($linenr, $n);
6123 $herectx .= $rl . "\n";
6124 $ok = 1 if ($rl =~ /^[ \+]\{/);
6125 $ok = 1 if ($rl =~ /\{/ && $n == 0);
6126 last if $rl =~ /^[ \+].*\{/;
6130 "open brace '{' following function definitions go on the next line\n" . $herectx);
6134 # checks for new __setup's
6135 if ($rawline =~ /\b__setup\("([^"]*)"/) {
6138 if (!grep(/$name/, @setup_docs)) {
6139 CHK
("UNDOCUMENTED_SETUP",
6140 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
6144 # check for pointless casting of kmalloc return
6145 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
6146 WARN
("UNNECESSARY_CASTS",
6147 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
6151 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6152 if ($perl_version_ok &&
6153 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6154 CHK
("ALLOC_SIZEOF_STRUCT",
6155 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
6158 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6159 if ($perl_version_ok &&
6161 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
6165 my $newfunc = "kmalloc_array";
6166 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
6169 if ($a1 =~ /^sizeof\s*\S/) {
6173 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
6174 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
6175 my $cnt = statement_rawlines
($stat);
6176 my $herectx = get_stat_here
($linenr, $cnt, $here);
6178 if (WARN
("ALLOC_WITH_MULTIPLY",
6179 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
6182 $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;
6187 # check for krealloc arg reuse
6188 if ($perl_version_ok &&
6189 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ &&
6191 WARN
("KREALLOC_ARG_REUSE",
6192 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
6195 # check for alloc argument mismatch
6196 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
6197 WARN
("ALLOC_ARRAY_ARGS",
6198 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
6201 # check for multiple semicolons
6202 if ($line =~ /;\s*;\s*$/) {
6203 if (WARN
("ONE_SEMICOLON",
6204 "Statements terminations use 1 semicolon\n" . $herecurr) &&
6206 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
6210 # check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6211 if ($realfile !~ m
@^include/uapi/@ &&
6212 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
6214 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
6215 if (CHK
("BIT_MACRO",
6216 "Prefer using the BIT$ull macro\n" . $herecurr) &&
6218 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
6222 # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6223 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6225 if (WARN
("PREFER_IS_ENABLED",
6226 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
6228 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
6232 # check for case / default statements not preceded by break/fallthrough/switch
6233 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
6235 my $has_statement = 0;
6237 my $prevline = $linenr;
6238 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
6240 my $rline = $rawlines[$prevline - 1];
6241 my $fline = $lines[$prevline - 1];
6242 last if ($fline =~ /^\@\@/);
6243 next if ($fline =~ /^\-/);
6244 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
6245 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
6246 next if ($fline =~ /^.[\s$;]*$/);
6249 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/);
6251 if (!$has_break && $has_statement) {
6252 WARN
("MISSING_BREAK",
6253 "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr);
6257 # check for switch/default statements without a break;
6258 if ($perl_version_ok &&
6260 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
6261 my $cnt = statement_rawlines
($stat);
6262 my $herectx = get_stat_here
($linenr, $cnt, $here);
6264 WARN
("DEFAULT_NO_BREAK",
6265 "switch default: should use break\n" . $herectx);
6268 # check for gcc specific __FUNCTION__
6269 if ($line =~ /\b__FUNCTION__\b/) {
6270 if (WARN
("USE_FUNC",
6271 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
6273 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
6277 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
6278 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
6280 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
6283 # check for use of yield()
6284 if ($line =~ /\byield\s*\(\s*\)/) {
6286 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
6289 # check for comparisons against true and false
6290 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6298 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6300 my $type = lc($otype);
6301 if ($type =~ /^(?:true|false)$/) {
6302 if (("$test" eq "==" && "$type" eq "true") ||
6303 ("$test" eq "!=" && "$type" eq "false")) {
6307 CHK
("BOOL_COMPARISON",
6308 "Using comparison to $otype is error prone\n" . $herecurr);
6310 ## maybe suggesting a correct construct would better
6311 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6316 # check for bool bitfields
6317 if ($sline =~ /^.\s+bool\s*$Ident\s*:\s*\d+\s*;/) {
6318 WARN
("BOOL_BITFIELD",
6319 "Avoid using bool as bitfield. Prefer bool bitfields as unsigned int or u<8|16|32>\n" . $herecurr);
6322 # check for bool use in .h files
6323 if ($realfile =~ /\.h$/ &&
6324 $sline =~ /^.\s+bool\s*$Ident\s*(?::\s*d+\s*)?;/) {
6326 "Avoid using bool structure members because of possible alignment issues - see: https://lkml.org/lkml/2017/11/21/384\n" . $herecurr);
6329 # check for semaphores initialized locked
6330 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
6331 WARN
("CONSIDER_COMPLETION",
6332 "consider using a completion\n" . $herecurr);
6335 # recommend kstrto* over simple_strto* and strict_strto*
6336 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
6337 WARN
("CONSIDER_KSTRTO",
6338 "$1 is obsolete, use k$3 instead\n" . $herecurr);
6341 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
6342 if ($line =~ /^.\s*__initcall\s*\(/) {
6343 WARN
("USE_DEVICE_INITCALL",
6344 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
6347 # check for various structs that are normally const (ops, kgdb, device_tree)
6348 # and avoid what seem like struct definitions 'struct foo {'
6349 if ($line !~ /\bconst\b/ &&
6350 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
6351 WARN
("CONST_STRUCT",
6352 "struct $1 should normally be const\n" . $herecurr);
6355 # use of NR_CPUS is usually wrong
6356 # ignore definitions of NR_CPUS and usage to define arrays as likely right
6357 if ($line =~ /\bNR_CPUS\b/ &&
6358 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6359 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
6360 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6361 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6362 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
6365 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
6368 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6369 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6370 ERROR
("DEFINE_ARCH_HAS",
6371 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6374 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
6375 if ($perl_version_ok &&
6376 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6377 WARN
("LIKELY_MISUSE",
6378 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6381 # whine mightly about in_atomic
6382 if ($line =~ /\bin_atomic\s*\(/) {
6383 if ($realfile =~ m
@^drivers/@) {
6385 "do not use in_atomic in drivers\n" . $herecurr);
6386 } elsif ($realfile !~ m
@^kernel/@) {
6388 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
6392 # check for mutex_trylock_recursive usage
6393 if ($line =~ /mutex_trylock_recursive/) {
6395 "recursive locking is bad, do not use this ever.\n" . $herecurr);
6398 # check for lockdep_set_novalidate_class
6399 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6400 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6401 if ($realfile !~ m
@^kernel/lockdep@ &&
6402 $realfile !~ m
@^include/linux/lockdep@ &&
6403 $realfile !~ m
@^drivers/base/core@) {
6405 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
6409 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6410 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
6411 WARN
("EXPORTED_WORLD_WRITABLE",
6412 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6415 # check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6416 # and whether or not function naming is typical and if
6417 # DEVICE_ATTR permissions uses are unusual too
6418 if ($perl_version_ok &&
6420 $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*\)/) {
6425 my $octal_perms = perms_to_octal
($perms);
6426 if ($show =~ /^${var}_show$/ &&
6427 $store =~ /^${var}_store$/ &&
6428 $octal_perms eq "0644") {
6429 if (WARN
("DEVICE_ATTR_RW",
6430 "Use DEVICE_ATTR_RW\n" . $herecurr) &&
6432 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6434 } elsif ($show =~ /^${var}_show$/ &&
6435 $store =~ /^NULL$/ &&
6436 $octal_perms eq "0444") {
6437 if (WARN
("DEVICE_ATTR_RO",
6438 "Use DEVICE_ATTR_RO\n" . $herecurr) &&
6440 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6442 } elsif ($show =~ /^NULL$/ &&
6443 $store =~ /^${var}_store$/ &&
6444 $octal_perms eq "0200") {
6445 if (WARN
("DEVICE_ATTR_WO",
6446 "Use DEVICE_ATTR_WO\n" . $herecurr) &&
6448 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6450 } elsif ($octal_perms eq "0644" ||
6451 $octal_perms eq "0444" ||
6452 $octal_perms eq "0200") {
6453 my $newshow = "$show";
6454 $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show");
6455 my $newstore = $store;
6456 $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store");
6458 if ($show ne $newshow) {
6459 $rename .= " '$show' to '$newshow'";
6461 if ($store ne $newstore) {
6462 $rename .= " '$store' to '$newstore'";
6464 WARN
("DEVICE_ATTR_FUNCTIONS",
6465 "Consider renaming function(s)$rename\n" . $herecurr);
6467 WARN
("DEVICE_ATTR_PERMS",
6468 "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr);
6472 # Mode permission misuses where it seems decimal should be octal
6473 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6474 # o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6475 # specific definition of not visible in sysfs.
6476 # o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6477 # use the default permissions
6478 if ($perl_version_ok &&
6480 $line =~ /$mode_perms_search/) {
6481 foreach my $entry (@mode_permission_funcs) {
6482 my $func = $entry->[0];
6483 my $arg_pos = $entry->[1];
6485 my $lc = $stat =~ tr
@\n@@;
6486 $lc = $lc + $linenr;
6487 my $stat_real = get_stat_real
($linenr, $lc);
6492 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6494 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
6495 if ($stat =~ /$test/) {
6497 $val = $6 if ($skip_args ne "");
6498 if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
6499 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6500 ($val =~ /^$Octal$/ && length($val) ne 4))) {
6501 ERROR
("NON_OCTAL_PERMISSIONS",
6502 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
6504 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
6505 ERROR
("EXPORTED_WORLD_WRITABLE",
6506 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
6512 # check for uses of S_<PERMS> that could be octal for readability
6513 while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) {
6515 my $octal = perms_to_octal
($oval);
6516 if (WARN
("SYMBOLIC_PERMS",
6517 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6519 $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
6523 # validate content of MODULE_LICENSE against list from include/linux/module.h
6524 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6525 my $extracted_string = get_quoted_string
($line, $rawline);
6526 my $valid_licenses = qr{
6529 GPL\
and\ additional\ rights
|
6535 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6536 WARN
("MODULE_LICENSE",
6537 "unknown module license " . $extracted_string . "\n" . $herecurr);
6542 # If we have no input at all, then there is nothing to report on
6543 # so just keep quiet.
6544 if ($#rawlines == -1) {
6548 # In mailback mode only produce a report in the negative, for
6549 # things that appear to be patches.
6550 if ($mailback && ($clean == 1 || !$is_patch)) {
6554 # This is not a patch, and we are are in 'no-patch' mode so
6556 if (!$chk_patch && !$is_patch) {
6560 if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
6561 ERROR
("NOT_UNIFIED_DIFF",
6562 "Does not appear to be a unified-diff format patch\n");
6564 if ($is_patch && $has_commit_log && $chk_signoff) {
6565 if ($signoff == 0) {
6566 ERROR
("MISSING_SIGN_OFF",
6567 "Missing Signed-off-by: line(s)\n");
6568 } elsif (!$authorsignoff) {
6569 WARN
("NO_AUTHOR_SIGN_OFF",
6570 "Missing Signed-off-by: line by nominal patch author '$author'\n");
6574 print report_dump
();
6575 if ($summary && !($clean == 1 && $quiet == 1)) {
6576 print "$filename " if ($summary_file);
6577 print "total: $cnt_error errors, $cnt_warn warnings, " .
6578 (($check)?
"$cnt_chk checks, " : "") .
6579 "$cnt_lines lines checked\n";
6583 # If there were any defects found and not already fixing them
6584 if (!$clean and !$fix) {
6587 NOTE
: For some of the reported defects
, checkpatch may be able to
6588 mechanically convert to the typical style using
--fix
or --fix-inplace
.
6591 # If there were whitespace errors which cleanpatch can fix
6592 # then suggest that.
6593 if ($rpt_cleaners) {
6597 NOTE
: Whitespace errors detected
.
6598 You may wish to
use scripts
/cleanpatch or scripts/cleanfile
6603 if ($clean == 0 && $fix &&
6604 ("@rawlines" ne "@fixed" ||
6605 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
6606 my $newfile = $filename;
6607 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
6611 @fixed = fix_inserted_deleted_lines
(\
@fixed, \
@fixed_inserted, \
@fixed_deleted);
6613 open($f, '>', $newfile)
6614 or die "$P: Can't open $newfile for write\n";
6615 foreach my $fixed_line (@fixed) {
6618 if ($linecount > 3) {
6619 $fixed_line =~ s/^\+//;
6620 print $f $fixed_line . "\n";
6623 print $f $fixed_line . "\n";
6631 Wrote EXPERIMENTAL
--fix correction
(s
) to
'$newfile'
6633 Do _NOT_ trust the results written to this file
.
6634 Do _NOT_ submit these changes without inspecting them
for correctness
.
6636 This EXPERIMENTAL file
is simply a convenience to help rewrite patches
.
6637 No warranties
, expressed
or implied
...
6645 print "$vname has no obvious style problems and is ready for submission.\n";
6647 print "$vname has style problems, please review.\n";