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 = 100;
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 = "";
65 my $allow_c99_comments = 1; # Can be overridden by --ignore C99_COMMENT_TOLERANCE
66 # git output parsing needs US English output, so first set backtick child process LANGUAGE
67 my $git_command ='export LANGUAGE=en_US.UTF-8; git';
74 Usage
: $P [OPTION
]... [FILE
]...
79 --no-tree run without a kernel tree
80 --no-signoff
do not check
for 'Signed-off-by' line
81 --patch treat FILE as patchfile
(default)
82 --emacs emacs compile window format
83 --terse one line per report
84 --showfile emit diffed file position
, not input file position
85 -g
, --git treat FILE as a single commit
or git revision range
86 single git commit with
:
90 multiple git commits with
:
94 git merges are ignored
95 -f
, --file treat FILE as regular source file
96 --subjective
, --strict enable more subjective tests
97 --list
-types list the possible message types
98 --types TYPE
(,TYPE2
...) show only these comma separated message types
99 --ignore TYPE
(,TYPE2
...) ignore various comma separated message types
100 --show
-types show the specific message type
in the output
101 --max
-line
-length=n set the maximum line
length, (default $max_line_length)
102 if exceeded
, warn on patches
103 requires
--strict
for use with
--file
104 --min
-conf
-desc
-length=n set the min description
length, if shorter
, warn
105 --tab
-size
=n set the number of spaces
for tab
(default $tabsize)
106 --root
=PATH PATH to the kernel tree root
107 --no-summary suppress the per
-file summary
108 --mailback only produce a report
in case of warnings
/errors
109 --summary
-file include the filename
in summary
110 --debug KEY
=[0|1] turn on
/off debugging of KEY
, where KEY is one of
111 'values', 'possible', 'type', and 'attr' (default
113 --test
-only
=WORD report only warnings
/errors containing WORD
115 --fix EXPERIMENTAL
- may create horrible results
116 If correctable single
-line errors exist
, create
117 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
118 with potential errors corrected to the preferred
120 --fix
-inplace EXPERIMENTAL
- may create horrible results
121 Is the same as
--fix
, but overwrites the input
122 file
. It
's your fault if there's
no backup
or git
123 --ignore
-perl
-version override checking of perl version
. expect
125 --codespell Use the codespell dictionary
for spelling
/typos
126 (default:/usr/share
/codespell/dictionary
.txt
)
127 --codespellfile Use this codespell dictionary
128 --typedefsfile Read additional types from this file
129 --color
[=WHEN
] Use colors
'always', 'never', or only
when output
130 is a terminal
('auto'). Default is
'auto'.
131 --u
-boot Run additional checks
for U
-Boot
132 -h
, --help
, --version display this help
and exit
134 When FILE is
- read standard input
.
142 return grep { !$seen{$_}++ } @_;
152 open(my $script, '<', abs_path
($P)) or
153 die "$P: Can't read '$P' $!\n";
155 my $text = <$script>;
159 # Also catch when type or level is passed through a variable
160 for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
163 @types = sort(uniq
(@types));
164 print("#\tMessage type\n\n");
165 foreach my $type (@types) {
166 print(++$count . "\t" . $type . "\n");
172 my $conf = which_conf
($configuration_file);
175 open(my $conffile, '<', "$conf")
176 or warn "$P: Can't find a readable $configuration_file file $!\n";
178 while (<$conffile>) {
181 $line =~ s/\s*\n?$//g;
185 next if ($line =~ m/^\s*#/);
186 next if ($line =~ m/^\s*$/);
188 my @words = split(" ", $line);
189 foreach my $word (@words) {
190 last if ($word =~ m/^#/);
191 push (@conf_args, $word);
195 unshift(@ARGV, @conf_args) if @conf_args;
198 # Perl's Getopt::Long allows options to take optional arguments after a space.
199 # Prevent --color by itself from consuming other arguments
201 if ($_ eq "--color" || $_ eq "-color") {
202 $_ = "--color=$color";
207 'q|quiet+' => \
$quiet,
209 'signoff!' => \
$chk_signoff,
210 'patch!' => \
$chk_patch,
213 'showfile!' => \
$showfile,
216 'subjective!' => \
$check,
217 'strict!' => \
$check,
218 'ignore=s' => \
@ignore,
220 'show-types!' => \
$show_types,
221 'list-types!' => \
$list_types,
222 'max-line-length=i' => \
$max_line_length,
223 'min-conf-desc-length=i' => \
$min_conf_desc_length,
224 'tab-size=i' => \
$tabsize,
226 'summary!' => \
$summary,
227 'mailback!' => \
$mailback,
228 'summary-file!' => \
$summary_file,
230 'fix-inplace!' => \
$fix_inplace,
231 'ignore-perl-version!' => \
$ignore_perl_version,
232 'debug=s' => \
%debug,
233 'test-only=s' => \
$tst_only,
234 'codespell!' => \
$codespell,
235 'codespellfile=s' => \
$codespellfile,
236 'typedefsfile=s' => \
$typedefsfile,
237 'u-boot' => \
$u_boot,
238 'color=s' => \
$color,
239 'no-color' => \
$color, #keep old behaviors of -nocolor
240 'nocolor' => \
$color, #keep old behaviors of -nocolor
247 list_types
(0) if ($list_types);
249 $fix = 1 if ($fix_inplace);
250 $check_orig = $check;
254 my $perl_version_ok = 1;
255 if ($^V
&& $^V
lt $minimum_perl_version) {
256 $perl_version_ok = 0;
257 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
258 exit(1) if (!$ignore_perl_version);
261 #if no filenames are given, push '-' to read patch from stdin
266 if ($color =~ /^[01]$/) {
268 } elsif ($color =~ /^always$/i) {
270 } elsif ($color =~ /^never$/i) {
272 } elsif ($color =~ /^auto$/i) {
273 $color = (-t STDOUT
);
275 die "Invalid color mode: $color\n";
278 # skip TAB size 1 to avoid additional checks on $tabsize - 1
279 die "Invalid TAB size: $tabsize\n" if ($tabsize < 2);
281 sub hash_save_array_words
{
282 my ($hashRef, $arrayRef) = @_;
284 my @array = split(/,/, join(',', @
$arrayRef));
285 foreach my $word (@array) {
286 $word =~ s/\s*\n?$//g;
289 $word =~ tr/[a-z]/[A-Z]/;
291 next if ($word =~ m/^\s*#/);
292 next if ($word =~ m/^\s*$/);
298 sub hash_show_words
{
299 my ($hashRef, $prefix) = @_;
301 if (keys %$hashRef) {
302 print "\nNOTE: $prefix message types:";
303 foreach my $word (sort keys %$hashRef) {
310 hash_save_array_words
(\
%ignore_type, \
@ignore);
311 hash_save_array_words
(\
%use_type, \
@use);
314 my $dbg_possible = 0;
317 for my $key (keys %debug) {
319 eval "\${dbg_$key} = '$debug{$key}';";
323 my $rpt_cleaners = 0;
332 if (!top_of_kernel_tree
($root)) {
333 die "$P: $root: --root does not point at a valid tree\n";
336 if (top_of_kernel_tree
('.')) {
338 } elsif ($0 =~ m@
(.*)/scripts/[^/]*$@
&&
339 top_of_kernel_tree
($1)) {
344 if (!defined $root) {
345 print "Must be run from the top-level dir. of a kernel tree\n";
350 my $emitted_corrupt = 0;
353 [A
-Za
-z_
][A
-Za
-z\d_
]*
354 (?
:\s
*\#\#\s
*[A
-Za
-z_
][A
-Za
-z\d_
]*)*
356 our $Storage = qr{extern|static|asmlinkage};
370 our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
371 our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
372 our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
373 our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
374 our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
376 # Notes to $Attribute:
377 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
399 ____cacheline_aligned
|
400 ____cacheline_aligned_in_smp
|
401 ____cacheline_internodealigned_in_smp
|
405 our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
406 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
407 our $Lval = qr{$Ident(?:$Member)*};
409 our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
410 our $Binary = qr{(?i)0b[01]+$Int_type?};
411 our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
412 our $Int = qr{[0-9]+$Int_type?};
413 our $Octal = qr{0[0-7]+$Int_type?};
414 our $String = qr{"[X\t]*"};
415 our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
416 our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
417 our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
418 our $Float = qr{$Float_hex|$Float_dec|$Float_int};
419 our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
420 our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
421 our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
422 our $Arithmetic = qr{\+|-|\*|\/|%};
426 &&|\
|\
||,|\
^|\
+\
+|--|&|\
||$Arithmetic
429 our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
433 our $NonptrTypeMisordered;
434 our $NonptrTypeWithAttr;
438 our $DeclareMisordered;
440 our $NON_ASCII_UTF8 = qr{
441 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
442 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
443 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
444 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
445 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
446 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
447 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
451 [\x09\x0A\x0D\x20-\x7E] # ASCII
455 our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
456 our $typeOtherOSTypedefs = qr{(?x
:
457 u_
(?
:char
|short
|int|long
) | # bsd
458 u
(?
:nchar
|short
|int|long
) # sysv
460 our $typeKernelTypedefs = qr{(?x
:
461 (?
:__
)?
(?
:u
|s
|be
|le)(?
:8|16|32|64)|
464 our $typeTypedefs = qr{(?x
:
466 $typeOtherOSTypedefs\b|
467 $typeKernelTypedefs\b
470 our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
472 our $logFunctions = qr{(?x
:
473 printk
(?
:_ratelimited
|_once
|_deferred_once
|_deferred
|)|
474 (?
:[a
-z0
-9]+_
){1,2}(?
:printk
|emerg
|alert
|crit
|err
|warning
|warn|notice
|info
|debug
|dbg
|vdbg
|devel
|cont
|WARN
)(?
:_ratelimited
|_once
|)|
476 WARN
(?
:_RATELIMIT
|_ONCE
|)|
481 seq_vprintf
|seq_printf
|seq_puts
484 our $allocFunctions = qr{(?x
:
486 (?
:kv
|k
|v
)[czm
]alloc
(?
:_node
|_array
)?
|
489 (?
:\w
+)?alloc_skb
(?
:_ip_align
)?
|
490 # dev_alloc_skb/netdev_alloc_skb, et al
494 our $signature_tags = qr{(?xi
:
506 our @typeListMisordered = (
507 qr{char\s+(?:un)?signed},
508 qr{int\s+(?:(?:un)?signed\s+)?short\s},
509 qr{int\s+short(?:\s+(?:un)?signed)},
510 qr{short\s+int(?:\s+(?:un)?signed)},
511 qr{(?:un)?signed\s+int\s+short},
512 qr{short\s+(?:un)?signed},
513 qr{long\s+int\s+(?:un)?signed},
514 qr{int\s+long\s+(?:un)?signed},
515 qr{long\s+(?:un)?signed\s+int},
516 qr{int\s+(?:un)?signed\s+long},
517 qr{int\s+(?:un)?signed},
518 qr{int\s+long\s+long\s+(?:un)?signed},
519 qr{long\s+long\s+int\s+(?:un)?signed},
520 qr{long\s+long\s+(?:un)?signed\s+int},
521 qr{long\s+long\s+(?:un)?signed},
522 qr{long\s+(?:un)?signed},
527 qr{(?:(?:un)?signed\s+)?char},
528 qr{(?:(?:un)?signed\s+)?short\s+int},
529 qr{(?:(?:un)?signed\s+)?short},
530 qr{(?:(?:un)?signed\s+)?int},
531 qr{(?:(?:un)?signed\s+)?long\s+int},
532 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
533 qr{(?:(?:un)?signed\s+)?long\s+long},
534 qr{(?:(?:un)?signed\s+)?long},
543 qr{${Ident}_handler
},
544 qr{${Ident}_handler_fn
},
548 our $C90_int_types = qr{(?x
:
549 long\s
+long\s
+int\s
+(?
:un
)?signed
|
550 long\s
+long\s
+(?
:un
)?signed\s
+int|
551 long\s
+long\s
+(?
:un
)?signed
|
552 (?
:(?
:un
)?signed\s
+)?long\s
+long\s
+int|
553 (?
:(?
:un
)?signed\s
+)?long\s
+long
|
554 int\s
+long\s
+long\s
+(?
:un
)?signed
|
555 int\s
+(?
:(?
:un
)?signed\s
+)?long\s
+long
|
557 long\s
+int\s
+(?
:un
)?signed
|
558 long\s
+(?
:un
)?signed\s
+int|
559 long\s
+(?
:un
)?signed
|
560 (?
:(?
:un
)?signed\s
+)?long\s
+int|
561 (?
:(?
:un
)?signed\s
+)?long
|
562 int\s
+long\s
+(?
:un
)?signed
|
563 int\s
+(?
:(?
:un
)?signed\s
+)?long
|
566 (?
:(?
:un
)?signed\s
+)?
int
569 our @typeListFile = ();
570 our @typeListWithAttr = (
572 qr{struct\s+$InitAttribute\s+$Ident},
573 qr{union\s+$InitAttribute\s+$Ident},
576 our @modifierList = (
579 our @modifierListFile = ();
581 our @mode_permission_funcs = (
583 ["module_param_(?:array|named|string)", 4],
584 ["module_param_array_named", 5],
585 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
586 ["proc_create(?:_data|)", 2],
587 ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2],
588 ["IIO_DEV_ATTR_[A-Z_]+", 1],
589 ["SENSOR_(?:DEVICE_|)ATTR_2", 2],
590 ["SENSOR_TEMPLATE(?:_2|)", 3],
594 #Create a search pattern for all these functions to speed up a loop below
595 our $mode_perms_search = "";
596 foreach my $entry (@mode_permission_funcs) {
597 $mode_perms_search .= '|' if ($mode_perms_search ne "");
598 $mode_perms_search .= $entry->[0];
600 $mode_perms_search = "(?:${mode_perms_search})";
602 our %deprecated_apis = (
603 "synchronize_rcu_bh" => "synchronize_rcu",
604 "synchronize_rcu_bh_expedited" => "synchronize_rcu_expedited",
605 "call_rcu_bh" => "call_rcu",
606 "rcu_barrier_bh" => "rcu_barrier",
607 "synchronize_sched" => "synchronize_rcu",
608 "synchronize_sched_expedited" => "synchronize_rcu_expedited",
609 "call_rcu_sched" => "call_rcu",
610 "rcu_barrier_sched" => "rcu_barrier",
611 "get_state_synchronize_sched" => "get_state_synchronize_rcu",
612 "cond_synchronize_sched" => "cond_synchronize_rcu",
615 #Create a search pattern for all these strings to speed up a loop below
616 our $deprecated_apis_search = "";
617 foreach my $entry (keys %deprecated_apis) {
618 $deprecated_apis_search .= '|' if ($deprecated_apis_search ne "");
619 $deprecated_apis_search .= $entry;
621 $deprecated_apis_search = "(?:${deprecated_apis_search})";
623 our $mode_perms_world_writable = qr{
631 our %mode_permission_string_types = (
650 #Create a search pattern for all these strings to speed up a loop below
651 our $mode_perms_string_search = "";
652 foreach my $entry (keys %mode_permission_string_types) {
653 $mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
654 $mode_perms_string_search .= $entry;
656 our $single_mode_perms_string_search = "(?:${mode_perms_string_search})";
657 our $multi_mode_perms_string_search = qr{
658 ${single_mode_perms_string_search
}
659 (?
:\s
*\
|\s
*${single_mode_perms_string_search
})*
665 return trim
($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/);
672 while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
673 $curpos = pos($string);
676 last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
678 $to |= $mode_permission_string_types{$match};
679 $val .= '\s*\|\s*' if ($val ne "");
683 $oval =~ s/^\s*\|\s*//;
684 $oval =~ s/\s*\|\s*$//;
685 return sprintf("%04o", $to);
688 our $allowed_asm_includes = qr{(?x
:
694 # memory.h: ARM has a custom one
696 # Load common spelling mistakes and build regular expression list.
700 if (open(my $spelling, '<', $spelling_file)) {
701 while (<$spelling>) {
704 $line =~ s/\s*\n?$//g;
707 next if ($line =~ m/^\s*#/);
708 next if ($line =~ m/^\s*$/);
710 my ($suspect, $fix) = split(/\|\|/, $line);
712 $spelling_fix{$suspect} = $fix;
716 warn "No typos will be found - file '$spelling_file': $!\n";
720 if (open(my $spelling, '<', $codespellfile)) {
721 while (<$spelling>) {
724 $line =~ s/\s*\n?$//g;
727 next if ($line =~ m/^\s*#/);
728 next if ($line =~ m/^\s*$/);
729 next if ($line =~ m/, disabled/i);
733 my ($suspect, $fix) = split(/->/, $line);
735 $spelling_fix{$suspect} = $fix;
739 warn "No codespell typos will be found - file '$codespellfile': $!\n";
743 $misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
746 my ($wordsRef, $file) = @_;
748 if (open(my $words, '<', $file)) {
752 $line =~ s/\s*\n?$//g;
755 next if ($line =~ m/^\s*#/);
756 next if ($line =~ m/^\s*$/);
758 print("$file: '$line' invalid - ignored\n");
762 $$wordsRef .= '|' if ($$wordsRef ne "");
772 my $const_structs = "";
773 read_words
(\
$const_structs, $conststructsfile)
774 or warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
776 my $typeOtherTypedefs = "";
777 if (length($typedefsfile)) {
778 read_words
(\
$typeOtherTypedefs, $typedefsfile)
779 or warn "No additional types will be considered - file '$typedefsfile': $!\n";
781 $typeTypedefs .= '|' . $typeOtherTypedefs if ($typeOtherTypedefs ne "");
784 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
785 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
786 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
787 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
788 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
794 (?
:$Modifier\s
+|const\s
+)*
796 (?
:typeof
|__typeof__
)\s
*\
([^\
)]*\
)|
800 (?
:\s
+$Modifier|\s
+const
)*
802 $NonptrTypeMisordered = qr{
803 (?
:$Modifier\s
+|const\s
+)*
807 (?
:\s
+$Modifier|\s
+const
)*
809 $NonptrTypeWithAttr = qr{
810 (?
:$Modifier\s
+|const\s
+)*
812 (?
:typeof
|__typeof__
)\s
*\
([^\
)]*\
)|
816 (?
:\s
+$Modifier|\s
+const
)*
820 (?
:(?
:\s
|\
*|\
[\
])+\s
*const
|(?
:\s
|\
*\s
*(?
:const\s
*)?
|\
[\
])+|(?
:\s
*\
[\s
*\
])+){0,4}
821 (?
:\s
+$Inline|\s
+$Modifier)*
823 $TypeMisordered = qr{
824 $NonptrTypeMisordered
825 (?
:(?
:\s
|\
*|\
[\
])+\s
*const
|(?
:\s
|\
*\s
*(?
:const\s
*)?
|\
[\
])+|(?
:\s
*\
[\s
*\
])+){0,4}
826 (?
:\s
+$Inline|\s
+$Modifier)*
828 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
829 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
833 our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s
*};
835 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
836 # requires at least perl version v5.10.0
837 # Any use must be runtime checked with $^V
839 our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
840 our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s
*};
841 our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
843 our $declaration_macros = qr{(?x
:
844 (?
:$Storage\s
+)?
(?
:[A
-Z_
][A
-Z0
-9]*_
){0,2}(?
:DEFINE
|DECLARE
)(?
:_
[A
-Z0
-9]+){1,6}\s
*\
(|
845 (?
:$Storage\s
+)?
[HLP
]?LIST_HEAD\s
*\
(|
846 (?
:$Storage\s
+)?
${Type
}\s
+uninitialized_var\s
*\
(|
847 (?
:SKCIPHER_REQUEST
|SHASH_DESC
|AHASH_REQUEST
)_ON_STACK\s
*\
(
852 return "" if (!defined($string));
854 while ($string =~ /^\s*\(.*\)\s*$/) {
855 $string =~ s@
^\s
*\
(\s
*@@
;
856 $string =~ s@\s
*\
)\s
*$@@
;
859 $string =~ s@\s
+@
@g;
864 sub seed_camelcase_file
{
867 return if (!(-f
$file));
871 open(my $include_file, '<', "$file")
872 or warn "$P: Can't read '$file' $!\n";
873 my $text = <$include_file>;
874 close($include_file);
876 my @lines = split('\n', $text);
878 foreach my $line (@lines) {
879 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
880 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
882 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
884 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
890 our %maintained_status = ();
892 sub is_maintained_obsolete
{
895 return 0 if (!$tree || !(-e
"$root/scripts/get_maintainer.pl"));
897 if (!exists($maintained_status{$filename})) {
898 $maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
901 return $maintained_status{$filename} =~ /obsolete/i;
904 sub is_SPDX_License_valid
{
907 return 1 if (!$tree || which
("python") eq "" || !(-e
"$root/scripts/spdxcheck.py") || !(-e
"$root/.git"));
909 my $root_path = abs_path
($root);
910 my $status = `cd "$root_path"; echo "$license" | python scripts/spdxcheck.py -`;
911 return 0 if ($status ne "");
915 my $camelcase_seeded = 0;
916 sub seed_camelcase_includes
{
917 return if ($camelcase_seeded);
920 my $camelcase_cache = "";
921 my @include_files = ();
923 $camelcase_seeded = 1;
926 my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`;
927 chomp $git_last_include_commit;
928 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
930 my $last_mod_date = 0;
931 $files = `find $root/include -name "*.h"`;
932 @include_files = split('\n', $files);
933 foreach my $file (@include_files) {
934 my $date = POSIX
::strftime
("%Y%m%d%H%M",
935 localtime((stat $file)[9]));
936 $last_mod_date = $date if ($last_mod_date < $date);
938 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
941 if ($camelcase_cache ne "" && -f
$camelcase_cache) {
942 open(my $camelcase_file, '<', "$camelcase_cache")
943 or warn "$P: Can't read '$camelcase_cache' $!\n";
944 while (<$camelcase_file>) {
948 close($camelcase_file);
954 $files = `${git_command} ls-files "include/*.h"`;
955 @include_files = split('\n', $files);
958 foreach my $file (@include_files) {
959 seed_camelcase_file
($file);
962 if ($camelcase_cache ne "") {
963 unlink glob ".checkpatch-camelcase.*";
964 open(my $camelcase_file, '>', "$camelcase_cache")
965 or warn "$P: Can't write '$camelcase_cache' $!\n";
966 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
967 print $camelcase_file ("$_\n");
969 close($camelcase_file);
973 sub git_commit_info
{
974 my ($commit, $id, $desc) = @_;
976 return ($id, $desc) if ((which
("git") eq "") || !(-e
".git"));
978 my $output = `${git_command} log --no-color --format='%H %s' -1 $commit 2>&1`;
979 $output =~ s/^\s*//gm;
980 my @lines = split("\n", $output);
982 return ($id, $desc) if ($#lines < 0);
984 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous/) {
985 # Maybe one day convert this block of bash into something that returns
986 # all matching commit ids, but it's very slow...
988 # echo "checking commits $1..."
989 # git rev-list --remotes | grep -i "^$1" |
990 # while read line ; do
991 # git log --format='%H %s' -1 $line |
992 # echo "commit $(cut -c 1-12,41-)"
994 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
997 $id = substr($lines[0], 0, 12);
998 $desc = substr($lines[0], 41);
1001 return ($id, $desc);
1004 $chk_signoff = 0 if ($file);
1009 my @fixed_inserted = ();
1010 my @fixed_deleted = ();
1013 # If input is git commits, extract all commits from the commit expressions.
1014 # For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
1015 die "$P: No git repository found\n" if ($git && !-e
".git");
1019 foreach my $commit_expr (@ARGV) {
1021 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
1022 $git_range = "-$2 $1";
1023 } elsif ($commit_expr =~ m/\.\./) {
1024 $git_range = "$commit_expr";
1026 $git_range = "-1 $commit_expr";
1028 my $lines = `${git_command} log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
1029 foreach my $line (split(/\n/, $lines)) {
1030 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
1031 next if (!defined($1) || !defined($2));
1034 unshift(@commits, $sha1);
1035 $git_commits{$sha1} = $subject;
1038 die "$P: no git commits after extraction!\n" if (@commits == 0);
1043 $allow_c99_comments = !defined $ignore_type{"C99_COMMENT_TOLERANCE"};
1044 for my $filename (@ARGV) {
1047 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
1048 die "$P: $filename: git format-patch failed - $!\n";
1050 open($FILE, '-|', "diff -u /dev/null $filename") ||
1051 die "$P: $filename: diff failed - $!\n";
1052 } elsif ($filename eq '-') {
1053 open($FILE, '<&STDIN');
1055 open($FILE, '<', "$filename") ||
1056 die "$P: $filename: open failed - $!\n";
1058 if ($filename eq '-') {
1059 $vname = 'Your patch';
1061 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
1067 push(@rawlines, $_);
1071 if ($#ARGV > 0 && $quiet == 0) {
1072 print '-' x
length($vname) . "\n";
1074 print '-' x
length($vname) . "\n";
1077 if (!process
($filename)) {
1083 @fixed_inserted = ();
1084 @fixed_deleted = ();
1086 @modifierListFile = ();
1092 hash_show_words
(\
%use_type, "Used");
1093 hash_show_words
(\
%ignore_type, "Ignored");
1095 if (!$perl_version_ok) {
1098 NOTE
: perl
$^V is
not modern enough to detect all possible issues
.
1099 An upgrade to at least perl
$minimum_perl_version is suggested
.
1105 NOTE
: If any of the errors are false positives
, please report
1106 them to the maintainer
, see CHECKPATCH
in MAINTAINERS
.
1113 sub top_of_kernel_tree
{
1117 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
1118 "README", "Documentation", "arch", "include", "drivers",
1119 "fs", "init", "ipc", "kernel", "lib", "scripts",
1122 foreach my $check (@tree_check) {
1123 if (! -e
$root . '/' . $check) {
1131 my ($formatted_email) = @_;
1134 my $name_comment = "";
1138 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
1141 $comment = $3 if defined $3;
1142 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
1144 $comment = $2 if defined $2;
1145 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
1147 $comment = $2 if defined $2;
1148 $formatted_email =~ s/\Q$address\E.*$//;
1149 $name = $formatted_email;
1150 $name = trim
($name);
1151 $name =~ s/^\"|\"$//g;
1152 # If there's a name left after stripping spaces and
1153 # leading quotes, and the address doesn't have both
1154 # leading and trailing angle brackets, the address
1156 # "joe smith joe@smith.com" bad
1157 # "joe smith <joe@smith.com" bad
1158 if ($name ne "" && $address !~ /^<[^>]+>$/) {
1165 $name = trim
($name);
1166 $name =~ s/^\"|\"$//g;
1167 $name =~ s/(\s*\([^\)]+\))\s*//;
1169 $name_comment = trim
($1);
1171 $address = trim
($address);
1172 $address =~ s/^\<|\>$//g;
1174 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1175 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1176 $name = "\"$name\"";
1179 return ($name, $name_comment, $address, $comment);
1183 my ($name, $address) = @_;
1185 my $formatted_email;
1187 $name = trim
($name);
1188 $name =~ s/^\"|\"$//g;
1189 $address = trim
($address);
1191 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1192 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1193 $name = "\"$name\"";
1196 if ("$name" eq "") {
1197 $formatted_email = "$address";
1199 $formatted_email = "$name <$address>";
1202 return $formatted_email;
1205 sub reformat_email
{
1208 my ($email_name, $name_comment, $email_address, $comment) = parse_email
($email);
1209 return format_email
($email_name, $email_address);
1212 sub same_email_addresses
{
1213 my ($email1, $email2) = @_;
1215 my ($email1_name, $name1_comment, $email1_address, $comment1) = parse_email
($email1);
1216 my ($email2_name, $name2_comment, $email2_address, $comment2) = parse_email
($email2);
1218 return $email1_name eq $email2_name &&
1219 $email1_address eq $email2_address;
1225 foreach my $path (split(/:/, $ENV{PATH
})) {
1226 if (-e
"$path/$bin") {
1227 return "$path/$bin";
1237 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1238 if (-e
"$path/$conf") {
1239 return "$path/$conf";
1251 for my $c (split(//, $str)) {
1255 for (; ($n % $tabsize) != 0; $n++) {
1267 (my $res = shift) =~ tr/\t/ /c;
1274 # Drop the diff line leader and expand tabs
1276 $line = expand_tabs
($line);
1278 # Pick the indent from the front of the line.
1279 my ($white) = ($line =~ /^(\s*)/);
1281 return (length($line), length($white));
1284 my $sanitise_quote = '';
1286 sub sanitise_line_reset
{
1287 my ($in_comment) = @_;
1290 $sanitise_quote = '*/';
1292 $sanitise_quote = '';
1305 # Always copy over the diff marker.
1306 $res = substr($line, 0, 1);
1308 for ($off = 1; $off < length($line); $off++) {
1309 $c = substr($line, $off, 1);
1311 # Comments we are whacking completely including the begin
1312 # and end, all to $;.
1313 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1314 $sanitise_quote = '*/';
1316 substr($res, $off, 2, "$;$;");
1320 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
1321 $sanitise_quote = '';
1322 substr($res, $off, 2, "$;$;");
1326 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1327 $sanitise_quote = '//';
1329 substr($res, $off, 2, $sanitise_quote);
1334 # A \ in a string means ignore the next character.
1335 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1337 substr($res, $off, 2, 'XX');
1342 if ($c eq "'" || $c eq '"') {
1343 if ($sanitise_quote eq '') {
1344 $sanitise_quote = $c;
1346 substr($res, $off, 1, $c);
1348 } elsif ($sanitise_quote eq $c) {
1349 $sanitise_quote = '';
1353 #print "c<$c> SQ<$sanitise_quote>\n";
1354 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1355 substr($res, $off, 1, $;);
1356 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1357 substr($res, $off, 1, $;);
1358 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1359 substr($res, $off, 1, 'X');
1361 substr($res, $off, 1, $c);
1365 if ($sanitise_quote eq '//') {
1366 $sanitise_quote = '';
1369 # The pathname on a #include may be surrounded by '<' and '>'.
1370 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
1371 my $clean = 'X' x
length($1);
1372 $res =~ s@\
<.*\
>@
<$clean>@
;
1374 # The whole of a #error is a string.
1375 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
1376 my $clean = 'X' x
length($1);
1377 $res =~ s@
(\#\s
*(?
:error
|warning
)\s
+).*@
$1$clean@
;
1380 if ($allow_c99_comments && $res =~ m@
(//.*$)@
) {
1382 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1388 sub get_quoted_string
{
1389 my ($line, $rawline) = @_;
1391 return "" if (!defined($line) || !defined($rawline));
1392 return "" if ($line !~ m/($String)/g);
1393 return substr($rawline, $-[0], $+[0] - $-[0]);
1396 sub ctx_statement_block
{
1397 my ($linenr, $remain, $off) = @_;
1398 my $line = $linenr - 1;
1401 my $coff = $off - 1;
1415 @stack = (['', 0]) if ($#stack == -1);
1417 #warn "CSB: blk<$blk> remain<$remain>\n";
1418 # If we are about to drop off the end, pull in more
1421 for (; $remain > 0; $line++) {
1422 last if (!defined $lines[$line]);
1423 next if ($lines[$line] =~ /^-/);
1426 $blk .= $lines[$line] . "\n";
1427 $len = length($blk);
1431 # Bail if there is no further context.
1432 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1436 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1442 $c = substr($blk, $off, 1);
1443 $remainder = substr($blk, $off);
1445 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1447 # Handle nested #if/#else.
1448 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1449 push(@stack, [ $type, $level ]);
1450 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1451 ($type, $level) = @
{$stack[$#stack - 1]};
1452 } elsif ($remainder =~ /^#\s*endif\b/) {
1453 ($type, $level) = @
{pop(@stack)};
1456 # Statement ends at the ';' or a close '}' at the
1458 if ($level == 0 && $c eq ';') {
1462 # An else is really a conditional as long as its not else if
1463 if ($level == 0 && $coff_set == 0 &&
1464 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1465 $remainder =~ /^(else)(?:\s|{)/ &&
1466 $remainder !~ /^else\s+if\b/) {
1467 $coff = $off + length($1) - 1;
1469 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1470 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1473 if (($type eq '' || $type eq '(') && $c eq '(') {
1477 if ($type eq '(' && $c eq ')') {
1479 $type = ($level != 0)?
'(' : '';
1481 if ($level == 0 && $coff < $soff) {
1484 #warn "CSB: mark coff<$coff>\n";
1487 if (($type eq '' || $type eq '{') && $c eq '{') {
1491 if ($type eq '{' && $c eq '}') {
1493 $type = ($level != 0)?
'{' : '';
1496 if (substr($blk, $off + 1, 1) eq ';') {
1502 # Preprocessor commands end at the newline unless escaped.
1503 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1511 # We are truly at the end, so shuffle to the next line.
1518 my $statement = substr($blk, $soff, $off - $soff + 1);
1519 my $condition = substr($blk, $soff, $coff - $soff + 1);
1521 #warn "STATEMENT<$statement>\n";
1522 #warn "CONDITION<$condition>\n";
1524 #print "coff<$coff> soff<$off> loff<$loff>\n";
1526 return ($statement, $condition,
1527 $line, $remain + 1, $off - $loff + 1, $level);
1530 sub statement_lines
{
1533 # Strip the diff line prefixes and rip blank lines at start and end.
1534 $stmt =~ s/(^|\n)./$1/g;
1538 my @stmt_lines = ($stmt =~ /\n/g);
1540 return $#stmt_lines + 2;
1543 sub statement_rawlines
{
1546 my @stmt_lines = ($stmt =~ /\n/g);
1548 return $#stmt_lines + 2;
1551 sub statement_block_size
{
1554 $stmt =~ s/(^|\n)./$1/g;
1560 my @stmt_lines = ($stmt =~ /\n/g);
1561 my @stmt_statements = ($stmt =~ /;/g);
1563 my $stmt_lines = $#stmt_lines + 2;
1564 my $stmt_statements = $#stmt_statements + 1;
1566 if ($stmt_lines > $stmt_statements) {
1569 return $stmt_statements;
1573 sub ctx_statement_full
{
1574 my ($linenr, $remain, $off) = @_;
1575 my ($statement, $condition, $level);
1579 # Grab the first conditional/block pair.
1580 ($statement, $condition, $linenr, $remain, $off, $level) =
1581 ctx_statement_block
($linenr, $remain, $off);
1582 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1583 push(@chunks, [ $condition, $statement ]);
1584 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1585 return ($level, $linenr, @chunks);
1588 # Pull in the following conditional/block pairs and see if they
1589 # could continue the statement.
1591 ($statement, $condition, $linenr, $remain, $off, $level) =
1592 ctx_statement_block
($linenr, $remain, $off);
1593 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1594 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1596 push(@chunks, [ $condition, $statement ]);
1599 return ($level, $linenr, @chunks);
1603 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1605 my $start = $linenr - 1;
1612 my @stack = ($level);
1613 for ($line = $start; $remain > 0; $line++) {
1614 next if ($rawlines[$line] =~ /^-/);
1617 $blk .= $rawlines[$line];
1619 # Handle nested #if/#else.
1620 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1621 push(@stack, $level);
1622 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1623 $level = $stack[$#stack - 1];
1624 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1625 $level = pop(@stack);
1628 foreach my $c (split(//, $lines[$line])) {
1629 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1635 if ($c eq $close && $level > 0) {
1637 last if ($level == 0);
1638 } elsif ($c eq $open) {
1643 if (!$outer || $level <= 1) {
1644 push(@res, $rawlines[$line]);
1647 last if ($level == 0);
1650 return ($level, @res);
1652 sub ctx_block_outer
{
1653 my ($linenr, $remain) = @_;
1655 my ($level, @r) = ctx_block_get
($linenr, $remain, 1, '{', '}', 0);
1659 my ($linenr, $remain) = @_;
1661 my ($level, @r) = ctx_block_get
($linenr, $remain, 0, '{', '}', 0);
1665 my ($linenr, $remain, $off) = @_;
1667 my ($level, @r) = ctx_block_get
($linenr, $remain, 0, '(', ')', $off);
1670 sub ctx_block_level
{
1671 my ($linenr, $remain) = @_;
1673 return ctx_block_get
($linenr, $remain, 0, '{', '}', 0);
1675 sub ctx_statement_level
{
1676 my ($linenr, $remain, $off) = @_;
1678 return ctx_block_get
($linenr, $remain, 0, '(', ')', $off);
1681 sub ctx_locate_comment
{
1682 my ($first_line, $end_line) = @_;
1684 # Catch a comment on the end of the line itself.
1685 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@
.*(/\*.*\*/)\s
*(?
:\\\s
*)?
$@
);
1686 return $current_comment if (defined $current_comment);
1688 # Look through the context and try and figure out if there is a
1691 $current_comment = '';
1692 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1693 my $line = $rawlines[$linenr - 1];
1695 if ($linenr == $first_line and $line =~ m@
^.\s
*\
*@
) {
1698 if ($line =~ m@
/\
*@
) {
1701 if (!$in_comment && $current_comment ne '') {
1702 $current_comment = '';
1704 $current_comment .= $line . "\n" if ($in_comment);
1705 if ($line =~ m@\
*/@
) {
1710 chomp($current_comment);
1711 return($current_comment);
1713 sub ctx_has_comment
{
1714 my ($first_line, $end_line) = @_;
1715 my $cmt = ctx_locate_comment
($first_line, $end_line);
1717 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1718 ##print "CMMT: $cmt\n";
1720 return ($cmt ne '');
1724 my ($linenr, $cnt) = @_;
1726 my $offset = $linenr - 1;
1731 $line = $rawlines[$offset++];
1732 next if (defined($line) && $line =~ /^-/);
1740 my ($linenr, $lc) = @_;
1742 my $stat_real = raw_line
($linenr, 0);
1743 for (my $count = $linenr + 1; $count <= $lc; $count++) {
1744 $stat_real = $stat_real . "\n" . raw_line
($count, 0);
1751 my ($linenr, $cnt, $here) = @_;
1753 my $herectx = $here . "\n";
1754 for (my $n = 0; $n < $cnt; $n++) {
1755 $herectx .= raw_line
($linenr, $n) . "\n";
1766 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1769 $coded = sprintf("^%c", unpack('C', $2) + 64);
1778 my $av_preprocessor = 0;
1783 sub annotate_reset
{
1784 $av_preprocessor = 0;
1786 @av_paren_type = ('E');
1787 $av_pend_colon = 'O';
1790 sub annotate_values
{
1791 my ($stream, $type) = @_;
1794 my $var = '_' x
length($stream);
1797 print "$stream\n" if ($dbg_values > 1);
1799 while (length($cur)) {
1800 @av_paren_type = ('E') if ($#av_paren_type < 0);
1801 print " <" . join('', @av_paren_type) .
1802 "> <$type> <$av_pending>" if ($dbg_values > 1);
1803 if ($cur =~ /^(\s+)/o) {
1804 print "WS($1)\n" if ($dbg_values > 1);
1805 if ($1 =~ /\n/ && $av_preprocessor) {
1806 $type = pop(@av_paren_type);
1807 $av_preprocessor = 0;
1810 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1811 print "CAST($1)\n" if ($dbg_values > 1);
1812 push(@av_paren_type, $type);
1815 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1816 print "DECLARE($1)\n" if ($dbg_values > 1);
1819 } elsif ($cur =~ /^($Modifier)\s*/) {
1820 print "MODIFIER($1)\n" if ($dbg_values > 1);
1823 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1824 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1825 $av_preprocessor = 1;
1826 push(@av_paren_type, $type);
1832 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1833 print "UNDEF($1)\n" if ($dbg_values > 1);
1834 $av_preprocessor = 1;
1835 push(@av_paren_type, $type);
1837 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1838 print "PRE_START($1)\n" if ($dbg_values > 1);
1839 $av_preprocessor = 1;
1841 push(@av_paren_type, $type);
1842 push(@av_paren_type, $type);
1845 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1846 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1847 $av_preprocessor = 1;
1849 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1853 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1854 print "PRE_END($1)\n" if ($dbg_values > 1);
1856 $av_preprocessor = 1;
1858 # Assume all arms of the conditional end as this
1859 # one does, and continue as if the #endif was not here.
1860 pop(@av_paren_type);
1861 push(@av_paren_type, $type);
1864 } elsif ($cur =~ /^(\\\n)/o) {
1865 print "PRECONT($1)\n" if ($dbg_values > 1);
1867 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1868 print "ATTR($1)\n" if ($dbg_values > 1);
1869 $av_pending = $type;
1872 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1873 print "SIZEOF($1)\n" if ($dbg_values > 1);
1879 } elsif ($cur =~ /^(if|while|for)\b/o) {
1880 print "COND($1)\n" if ($dbg_values > 1);
1884 } elsif ($cur =~/^(case)/o) {
1885 print "CASE($1)\n" if ($dbg_values > 1);
1886 $av_pend_colon = 'C';
1889 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1890 print "KEYWORD($1)\n" if ($dbg_values > 1);
1893 } elsif ($cur =~ /^(\()/o) {
1894 print "PAREN('$1')\n" if ($dbg_values > 1);
1895 push(@av_paren_type, $av_pending);
1899 } elsif ($cur =~ /^(\))/o) {
1900 my $new_type = pop(@av_paren_type);
1901 if ($new_type ne '_') {
1903 print "PAREN('$1') -> $type\n"
1904 if ($dbg_values > 1);
1906 print "PAREN('$1')\n" if ($dbg_values > 1);
1909 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1910 print "FUNC($1)\n" if ($dbg_values > 1);
1914 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1915 if (defined $2 && $type eq 'C' || $type eq 'T') {
1916 $av_pend_colon = 'B';
1917 } elsif ($type eq 'E') {
1918 $av_pend_colon = 'L';
1920 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1923 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1924 print "IDENT($1)\n" if ($dbg_values > 1);
1927 } elsif ($cur =~ /^($Assignment)/o) {
1928 print "ASSIGN($1)\n" if ($dbg_values > 1);
1931 } elsif ($cur =~/^(;|{|})/) {
1932 print "END($1)\n" if ($dbg_values > 1);
1934 $av_pend_colon = 'O';
1936 } elsif ($cur =~/^(,)/) {
1937 print "COMMA($1)\n" if ($dbg_values > 1);
1940 } elsif ($cur =~ /^(\?)/o) {
1941 print "QUESTION($1)\n" if ($dbg_values > 1);
1944 } elsif ($cur =~ /^(:)/o) {
1945 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1947 substr($var, length($res), 1, $av_pend_colon);
1948 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1953 $av_pend_colon = 'O';
1955 } elsif ($cur =~ /^(\[)/o) {
1956 print "CLOSE($1)\n" if ($dbg_values > 1);
1959 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1962 print "OPV($1)\n" if ($dbg_values > 1);
1969 substr($var, length($res), 1, $variant);
1972 } elsif ($cur =~ /^($Operators)/o) {
1973 print "OP($1)\n" if ($dbg_values > 1);
1974 if ($1 ne '++' && $1 ne '--') {
1978 } elsif ($cur =~ /(^.)/o) {
1979 print "C($1)\n" if ($dbg_values > 1);
1982 $cur = substr($cur, length($1));
1983 $res .= $type x
length($1);
1987 return ($res, $var);
1991 my ($possible, $line) = @_;
1992 my $notPermitted = qr{(?
:
2009 ^(?
:typedef
|struct
|enum
)\b
2011 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
2012 if ($possible !~ $notPermitted) {
2013 # Check for modifiers.
2014 $possible =~ s/\s*$Storage\s*//g;
2015 $possible =~ s/\s*$Sparse\s*//g;
2016 if ($possible =~ /^\s*$/) {
2018 } elsif ($possible =~ /\s/) {
2019 $possible =~ s/\s*$Type\s*//g;
2020 for my $modifier (split(' ', $possible)) {
2021 if ($modifier !~ $notPermitted) {
2022 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
2023 push(@modifierListFile, $modifier);
2028 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
2029 push(@typeListFile, $possible);
2033 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
2042 $type =~ tr/[a-z]/[A-Z]/;
2044 return defined $use_type{$type} if (scalar keys %use_type > 0);
2046 return !defined $ignore_type{$type};
2050 my ($level, $type, $msg) = @_;
2052 if (!show_type
($type) ||
2053 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
2058 if ($level eq 'ERROR') {
2060 } elsif ($level eq 'WARNING') {
2066 $output .= $prefix . $level . ':';
2068 $output .= BLUE
if ($color);
2069 $output .= "$type:";
2071 $output .= RESET
if ($color);
2072 $output .= ' ' . $msg . "\n";
2075 my @lines = split("\n", $output, -1);
2076 splice(@lines, 1, 1);
2077 $output = join("\n", @lines);
2079 $output = (split('\n', $output))[0] . "\n" if ($terse);
2081 push(our @report, $output);
2090 sub fixup_current_range
{
2091 my ($lineRef, $offset, $length) = @_;
2093 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
2096 my $no = $o + $offset;
2097 my $nl = $l + $length;
2098 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
2102 sub fix_inserted_deleted_lines
{
2103 my ($linesRef, $insertedRef, $deletedRef) = @_;
2105 my $range_last_linenr = 0;
2106 my $delta_offset = 0;
2111 my $next_insert = 0;
2112 my $next_delete = 0;
2116 my $inserted = @
{$insertedRef}[$next_insert++];
2117 my $deleted = @
{$deletedRef}[$next_delete++];
2119 foreach my $old_line (@
{$linesRef}) {
2121 my $line = $old_line; #don't modify the array
2122 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
2124 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
2125 $range_last_linenr = $new_linenr;
2126 fixup_current_range
(\
$line, $delta_offset, 0);
2129 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
2130 $deleted = @
{$deletedRef}[$next_delete++];
2132 fixup_current_range
(\
$lines[$range_last_linenr], $delta_offset--, -1);
2135 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
2136 push(@lines, ${$inserted}{'LINE'});
2137 $inserted = @
{$insertedRef}[$next_insert++];
2139 fixup_current_range
(\
$lines[$range_last_linenr], $delta_offset++, 1);
2143 push(@lines, $line);
2153 sub fix_insert_line
{
2154 my ($linenr, $line) = @_;
2160 push(@fixed_inserted, $inserted);
2163 sub fix_delete_line
{
2164 my ($linenr, $line) = @_;
2171 push(@fixed_deleted, $deleted);
2175 my ($type, $msg) = @_;
2177 if (report
("ERROR", $type, $msg)) {
2185 my ($type, $msg) = @_;
2187 if (report
("WARNING", $type, $msg)) {
2195 my ($type, $msg) = @_;
2197 if ($check && report
("CHECK", $type, $msg)) {
2205 sub check_absolute_file
{
2206 my ($absolute, $herecurr) = @_;
2207 my $file = $absolute;
2209 ##print "absolute<$absolute>\n";
2211 # See if any suffix of this path is a path within the tree.
2212 while ($file =~ s@
^[^/]*/@@
) {
2213 if (-f
"$root/$file") {
2214 ##print "file<$file>\n";
2222 # It is, so see if the prefix is acceptable.
2223 my $prefix = $absolute;
2224 substr($prefix, -length($file)) = '';
2226 ##print "prefix<$prefix>\n";
2227 if ($prefix ne ".../") {
2228 WARN
("USE_RELATIVE_PATH",
2229 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
2236 $string =~ s/^\s+|\s+$//g;
2244 $string =~ s/^\s+//;
2252 $string =~ s/\s+$//;
2257 sub string_find_replace
{
2258 my ($string, $find, $replace) = @_;
2260 $string =~ s/$find/$replace/g;
2268 my $source_indent = $tabsize;
2269 my $max_spaces_before_tab = $source_indent - 1;
2270 my $spaces_to_tab = " " x
$source_indent;
2272 #convert leading spaces to tabs
2273 1 while $leading =~ s@
^([\t]*)$spaces_to_tab@
$1\t@g;
2274 #Remove spaces before a tab
2275 1 while $leading =~ s@
^([\t]*)( {1,$max_spaces_before_tab})\t@
$1\t@g;
2280 sub pos_last_openparen
{
2285 my $opens = $line =~ tr/\(/\(/;
2286 my $closes = $line =~ tr/\)/\)/;
2288 my $last_openparen = 0;
2290 if (($opens == 0) || ($closes >= $opens)) {
2294 my $len = length($line);
2296 for ($pos = 0; $pos < $len; $pos++) {
2297 my $string = substr($line, $pos);
2298 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2299 $pos += length($1) - 1;
2300 } elsif (substr($line, $pos, 1) eq '(') {
2301 $last_openparen = $pos;
2302 } elsif (index($string, '(') == -1) {
2307 return length(expand_tabs
(substr($line, 0, $last_openparen))) + 1;
2310 sub get_raw_comment
{
2311 my ($line, $rawline) = @_;
2314 for my $i (0 .. (length($line) - 1)) {
2315 if (substr($line, $i, 1) eq "$;") {
2316 $comment .= substr($rawline, $i, 1);
2324 # line: Patch line to check
2325 # auto: Auto variable name, e.g. "per_child_auto"
2326 # suffix: Suffix to expect on member, e.g. "_priv"
2327 # warning: Warning name, e.g. "PRIV_AUTO"
2328 sub u_boot_struct_name
{
2329 my ($line, $auto, $suffix, $warning) = @_;
2331 # Use _priv as a suffix for the device-private data struct
2332 if ($line =~ /^\+\s*\.${auto}\s*=\s*sizeof\(struct\((\w+)\).*/) {
2333 my $struct_name = $1;
2334 if ($struct_name !~ /^\w+${suffix}/) {
2335 WARN
($warning, "struct \'$struct_name\' should have a ${suffix} suffix");
2340 # Checks specific to U-Boot
2342 my ($realfile, $line, $rawline, $herecurr) = @_;
2344 # ask for a test if a new uclass ID is added
2345 if ($realfile =~ /uclass-id.h/ && $line =~ /^\+/) {
2347 "Possible new uclass - make sure to add a sandbox driver, plus a test in test/dm/<name>.c\n" . $herecurr);
2350 # try to get people to use the livetree API
2351 if ($line =~ /^\+.*fdtdec_/) {
2353 "Use the livetree API (dev_read_...)\n" . $herecurr);
2356 # add tests for new commands
2357 if ($line =~ /^\+.*do_($Ident)\(struct cmd_tbl.*/) {
2359 "Possible new command - make sure you add a test\n" . $herecurr);
2362 # use if instead of #if
2363 if ($realfile =~ /\.c$/ && $line =~ /^\+#if.*CONFIG.*/) {
2365 "Use 'if (IS_ENABLED(CONFIG...))' instead of '#if or #ifdef' where possible\n" . $herecurr);
2368 # prefer strl(cpy|cat) over strn(cpy|cat)
2369 if ($line =~ /\bstrn(cpy|cat)\s*\(/) {
2371 "strl$1 is preferred over strn$1 because it always produces a nul-terminated string\n" . $herecurr);
2374 # use defconfig to manage CONFIG_CMD options
2375 if ($line =~ /\+\s*#\s*(define|undef)\s+(CONFIG_CMD\w*)\b/) {
2376 ERROR
("DEFINE_CONFIG_CMD",
2377 "All commands are managed by Kconfig\n" . $herecurr);
2380 # Don't put common.h and dm.h in header files
2381 if ($realfile =~ /\.h$/ && $rawline =~ /^\+#include\s*<(common|dm)\.h>*/) {
2382 ERROR
("BARRED_INCLUDE_IN_HDR",
2383 "Avoid including common.h and dm.h in header files\n" . $herecurr);
2386 # Do not disable fdt / initrd relocation
2387 if ($rawline =~ /.*(fdt|initrd)_high=0xffffffff/) {
2388 ERROR
("DISABLE_FDT_OR_INITRD_RELOC",
2389 "fdt or initrd relocation disabled at boot time\n" . $herecurr);
2392 # make sure 'skip_board_fixup' is not
2393 if ($rawline =~ /.*skip_board_fixup.*/) {
2394 ERROR
("SKIP_BOARD_FIXUP",
2395 "Avoid setting skip_board_fixup env variable\n" . $herecurr);
2398 # Do not use CONFIG_ prefix in CONFIG_IS_ENABLED() calls
2399 if ($line =~ /^\+.*CONFIG_IS_ENABLED\(CONFIG_\w*\).*/) {
2400 ERROR
("CONFIG_IS_ENABLED_CONFIG",
2401 "CONFIG_IS_ENABLED() takes values without the CONFIG_ prefix\n" . $herecurr);
2404 # Use _priv as a suffix for the device-private data struct
2405 if ($line =~ /^\+\s*\.priv_auto\s*=\s*sizeof\(struct\((\w+)\).*/) {
2406 my $struct_name = $1;
2407 if ($struct_name !~ /^\w+_priv/) {
2408 WARN
("PRIV_AUTO", "struct \'$struct_name\' should have a _priv suffix");
2412 # Check struct names for the 'auto' members of struct driver
2413 u_boot_struct_name
($line, "priv_auto", "_priv", "PRIV_AUTO");
2414 u_boot_struct_name
($line, "plat_auto", "_plat", "PLAT_AUTO");
2415 u_boot_struct_name
($line, "per_child_auto", "_priv", "CHILD_PRIV_AUTO");
2416 u_boot_struct_name
($line, "per_child_plat_auto", "_plat",
2419 # Now the ones for struct uclass, skipping those in common with above
2420 u_boot_struct_name
($line, "per_device_auto", "_priv",
2421 "DEVICE_PRIV_AUTO");
2422 u_boot_struct_name
($line, "per_device_plat_auto", "_plat",
2423 "DEVICE_PLAT_AUTO");
2427 my $filename = shift;
2433 my $stashrawline="";
2443 my $authorsignoff = 0;
2445 my $is_binding_patch = -1;
2446 my $in_header_lines = $file ?
0 : 1;
2447 my $in_commit_log = 0; #Scanning lines before patch
2448 my $has_patch_separator = 0; #Found a --- line
2449 my $has_commit_log = 0; #Encountered lines before patch
2450 my $commit_log_lines = 0; #Number of commit log lines
2451 my $commit_log_possible_stack_dump = 0;
2452 my $commit_log_long_line = 0;
2453 my $commit_log_has_diff = 0;
2454 my $reported_maintainer_file = 0;
2455 my $non_utf8_charset = 0;
2457 my $last_blank_line = 0;
2458 my $last_coalesced_string_linenr = -1;
2466 # Trace the real file/line as we go.
2471 my $context_function; #undef'd unless there's a known function
2473 my $comment_edge = 0;
2477 my $prev_values = 'E';
2480 my %suppress_ifbraces;
2481 my %suppress_whiletrailers;
2482 my %suppress_export;
2483 my $suppress_statement = 0;
2485 my %signatures = ();
2487 # Pre-scan the patch sanitizing the lines.
2488 # Pre-scan the patch looking for any __setup documentation.
2490 my @setup_docs = ();
2493 my $camelcase_file_seeded = 0;
2495 my $checklicenseline = 1;
2497 sanitise_line_reset
();
2499 foreach my $rawline (@rawlines) {
2503 push(@fixed, $rawline) if ($fix);
2505 if ($rawline=~/^\+\+\+\s+(\S+)/) {
2507 if ($1 =~ m
@Documentation/admin-guide/kernel
-parameters
.rst
$@
) {
2512 if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2521 # Guestimate if this is a continuing comment. Run
2522 # the context looking for a comment "edge". If this
2523 # edge is a close comment then we must be in a comment
2527 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2528 next if (defined $rawlines[$ln - 1] &&
2529 $rawlines[$ln - 1] =~ /^-/);
2531 #print "RAW<$rawlines[$ln - 1]>\n";
2532 last if (!defined $rawlines[$ln - 1]);
2533 if ($rawlines[$ln - 1] =~ m@
(/\*|\*/)@
&&
2534 $rawlines[$ln - 1] !~ m@
"[^"]*(?
:/\*|\*/)[^"]*"@
) {
2539 if (defined $edge && $edge eq '*/') {
2543 # Guestimate if this is a continuing comment. If this
2544 # is the start of a diff block and this line starts
2545 # ' *' then it is very likely a comment.
2546 if (!defined $edge &&
2547 $rawlines[$linenr] =~ m@
^.\s
*(?
:\
*\
*+| \
*)(?
:\s
|$)@
)
2552 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2553 sanitise_line_reset
($in_comment);
2555 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
2556 # Standardise the strings and chars within the input to
2557 # simplify matching -- only bother with positive lines.
2558 $line = sanitise_line
($rawline);
2560 push(@lines, $line);
2563 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2568 #print "==>$rawline\n";
2569 #print "-->$line\n";
2571 if ($setup_docs && $line =~ /^\+/) {
2572 push(@setup_docs, $line);
2581 foreach my $line (@lines) {
2584 my $sline = $line; #copy of $line
2585 $sline =~ s/$;/ /g; #with comments as spaces
2587 my $rawline = $rawlines[$linenr - 1];
2588 my $raw_comment = get_raw_comment
($line, $rawline);
2590 # check if it's a mode change, rename or start of a patch
2591 if (!$in_commit_log &&
2592 ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ ||
2593 ($line =~ /^rename (?:from|to) \S+\s*$/ ||
2594 $line =~ /^diff --git a\/[\w\
/\.\_\-]+ b\/\S
+\s
*$/))) {
2598 #extract the line range in the file after the patch is applied
2599 if (!$in_commit_log &&
2600 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2603 $first_line = $linenr + 1;
2613 %suppress_ifbraces = ();
2614 %suppress_whiletrailers = ();
2615 %suppress_export = ();
2616 $suppress_statement = 0;
2617 if ($context =~ /\b(\w+)\s*\(/) {
2618 $context_function = $1;
2620 undef $context_function;
2624 # track the line number as we move through the hunk, note that
2625 # new versions of GNU diff omit the leading space on completely
2626 # blank context lines so we need to count that too.
2627 } elsif ($line =~ /^( |\+|$)/) {
2629 $realcnt-- if ($realcnt != 0);
2631 # Measure the line length and indent.
2632 ($length, $indent) = line_stats
($rawline);
2634 # Track the previous line.
2635 ($prevline, $stashline) = ($stashline, $line);
2636 ($previndent, $stashindent) = ($stashindent, $indent);
2637 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2639 #warn "line<$line>\n";
2641 } elsif ($realcnt == 1) {
2645 my $hunk_line = ($realcnt != 0);
2647 $here = "#$linenr: " if (!$file);
2648 $here = "#$realline: " if ($file);
2651 # extract the filename as it passes
2652 if ($line =~ /^diff --git.*?(\S+)$/) {
2654 $realfile =~ s@
^([^/]*)/@@
if (!$file);
2657 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2659 $realfile =~ s@
^([^/]*)/@@
if (!$file);
2663 if (!$file && $tree && $p1_prefix ne '' &&
2664 -e
"$root/$p1_prefix") {
2665 WARN
("PATCH_PREFIX",
2666 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
2669 if ($realfile =~ m@
^include
/asm/@
) {
2670 ERROR
("MODIFIED_INCLUDE_ASM",
2671 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2676 #make up the handle for any error we report on this line
2678 $prefix = "$realfile:$realline: "
2681 $prefix = "$filename:$realline: ";
2683 $prefix = "$filename:$linenr: ";
2688 if (is_maintained_obsolete
($realfile)) {
2690 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2692 if ($realfile =~ m@
^(?
:drivers
/net
/|net
/|drivers
/staging/)@
) {
2695 $check = $check_orig;
2697 $checklicenseline = 1;
2699 if ($realfile !~ /^MAINTAINERS/) {
2700 my $last_binding_patch = $is_binding_patch;
2702 $is_binding_patch = () = $realfile =~ m@
^(?
:Documentation
/devicetree/|include
/dt-bindings/)@
;
2704 if (($last_binding_patch != -1) &&
2705 ($last_binding_patch ^ $is_binding_patch)) {
2706 WARN
("DT_SPLIT_BINDING_PATCH",
2707 "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.txt\n");
2714 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
2716 my $hereline = "$here\n$rawline\n";
2717 my $herecurr = "$here\n$rawline\n";
2718 my $hereprev = "$here\n$prevrawline\n$rawline\n";
2720 $cnt_lines++ if ($realcnt != 0);
2722 # Verify the existence of a commit log if appropriate
2723 # 2 is used because a $signature is counted in $commit_log_lines
2724 if ($in_commit_log) {
2725 if ($line !~ /^\s*$/) {
2726 $commit_log_lines++; #could be a $signature
2728 } elsif ($has_commit_log && $commit_log_lines < 2) {
2729 WARN
("COMMIT_MESSAGE",
2730 "Missing commit description - Add an appropriate one\n");
2731 $commit_log_lines = 2; #warn only once
2734 # Check if the commit log has what seems like a diff which can confuse patch
2735 if ($in_commit_log && !$commit_log_has_diff &&
2736 (($line =~ m@
^\s
+diff
\b.*a
/[\w/]+@
&&
2737 $line =~ m@
^\s
+diff
\b.*a
/([\w/]+)\s
+b
/$1\b@
) ||
2738 $line =~ m@
^\s
*(?
:\
-\
-\
-\s
+a
/|\+\+\+\s+b/)@
||
2739 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2740 ERROR
("DIFF_IN_COMMIT_MSG",
2741 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2742 $commit_log_has_diff = 1;
2745 # Check for incorrect file permissions
2746 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2747 my $permhere = $here . "FILE: $realfile\n";
2748 if ($realfile !~ m
@scripts/@
&&
2749 $realfile !~ /\.(py|pl|awk|sh)$/) {
2750 ERROR
("EXECUTE_PERMISSIONS",
2751 "do not set execute permissions for source files\n" . $permhere);
2755 # Check the patch for a From:
2756 if (decode
("MIME-Header", $line) =~ /^From:\s*(.*)/) {
2758 $author = encode
("utf8", $author) if ($line =~ /=\?utf-8\?/i);
2760 $author = reformat_email
($author);
2763 # Check the patch for a signoff:
2764 if ($line =~ /^\s*signed-off-by:\s*(.*)/i) {
2767 if ($author ne '') {
2768 if (same_email_addresses
($1, $author)) {
2774 # Check for patch separator
2775 if ($line =~ /^---$/) {
2776 $has_patch_separator = 1;
2780 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2781 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2782 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2783 $reported_maintainer_file = 1;
2786 # Check signature styles
2787 if (!$in_header_lines &&
2788 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
2789 my $space_before = $1;
2791 my $space_after = $3;
2793 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2795 if ($sign_off !~ /$signature_tags/) {
2796 WARN
("BAD_SIGN_OFF",
2797 "Non-standard signature: $sign_off\n" . $herecurr);
2799 if (defined $space_before && $space_before ne "") {
2800 if (WARN
("BAD_SIGN_OFF",
2801 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2803 $fixed[$fixlinenr] =
2804 "$ucfirst_sign_off $email";
2807 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
2808 if (WARN
("BAD_SIGN_OFF",
2809 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2811 $fixed[$fixlinenr] =
2812 "$ucfirst_sign_off $email";
2816 if (!defined $space_after || $space_after ne " ") {
2817 if (WARN
("BAD_SIGN_OFF",
2818 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2820 $fixed[$fixlinenr] =
2821 "$ucfirst_sign_off $email";
2825 my ($email_name, $name_comment, $email_address, $comment) = parse_email
($email);
2826 my $suggested_email = format_email
(($email_name, $email_address));
2827 if ($suggested_email eq "") {
2828 ERROR
("BAD_SIGN_OFF",
2829 "Unrecognized email address: '$email'\n" . $herecurr);
2831 my $dequoted = $suggested_email;
2832 $dequoted =~ s/^"//;
2833 $dequoted =~ s/" </ </;
2834 # Don't force email to have quotes
2835 # Allow just an angle bracketed address
2836 if (!same_email_addresses
($email, $suggested_email)) {
2837 WARN
("BAD_SIGN_OFF",
2838 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
2842 # Check for duplicate signatures
2843 my $sig_nospace = $line;
2844 $sig_nospace =~ s/\s//g;
2845 $sig_nospace = lc($sig_nospace);
2846 if (defined $signatures{$sig_nospace}) {
2847 WARN
("BAD_SIGN_OFF",
2848 "Duplicate signature\n" . $herecurr);
2850 $signatures{$sig_nospace} = 1;
2853 # Check Co-developed-by: immediately followed by Signed-off-by: with same name and email
2854 if ($sign_off =~ /^co-developed-by:$/i) {
2855 if ($email eq $author) {
2856 WARN
("BAD_SIGN_OFF",
2857 "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline);
2859 if (!defined $lines[$linenr]) {
2860 WARN
("BAD_SIGN_OFF",
2861 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline);
2862 } elsif ($rawlines[$linenr] !~ /^\s*signed-off-by:\s*(.*)/i) {
2863 WARN
("BAD_SIGN_OFF",
2864 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2865 } elsif ($1 ne $email) {
2866 WARN
("BAD_SIGN_OFF",
2867 "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2872 # Check email subject for common tools that don't need to be mentioned
2873 if ($in_header_lines &&
2874 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2875 WARN
("EMAIL_SUBJECT",
2876 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2879 # Check for Gerrit Change-Ids not in any patch context
2880 if ($realfile eq '' && !$has_patch_separator && $line =~ /^\s*change-id:/i) {
2881 ERROR
("GERRIT_CHANGE_ID",
2882 "Remove Gerrit Change-Id's before submitting upstream\n" . $herecurr);
2885 # Check if the commit log is in a possible stack dump
2886 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2887 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2888 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2890 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/) ||
2891 $line =~ /^(?:\s+\w+:\s+[0-9a-fA-F]+){3,3}/ ||
2892 $line =~ /^\s*\#\d+\s*\[[0-9a-fA-F]+\]\s*\w+ at [0-9a-fA-F]+/) {
2893 # stack dump address styles
2894 $commit_log_possible_stack_dump = 1;
2897 # Check for line lengths > 75 in commit log, warn once
2898 if ($in_commit_log && !$commit_log_long_line &&
2899 length($line) > 75 &&
2900 !($line =~ /^\s*[a-zA-Z0-9_\/\
.]+\s
+\
|\s
+\d
+/ ||
2901 # file delta changes
2902 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\
.\
-]+:/ ||
2904 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2905 # A Fixes: or Link: line
2906 $commit_log_possible_stack_dump)) {
2907 WARN
("COMMIT_LOG_LONG_LINE",
2908 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2909 $commit_log_long_line = 1;
2912 # Reset possible stack dump if a blank line is found
2913 if ($in_commit_log && $commit_log_possible_stack_dump &&
2915 $commit_log_possible_stack_dump = 0;
2918 # Check for git id commit length and improperly formed commit descriptions
2919 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2920 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink|base-commit):/i &&
2921 $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
2922 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
2923 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
2924 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2925 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
2926 my $init_char = "c";
2927 my $orig_commit = "";
2934 my $id = '0123456789ab';
2935 my $orig_desc = "commit description";
2936 my $description = "";
2938 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2940 $orig_commit = lc($2);
2941 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2942 $orig_commit = lc($1);
2945 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2946 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2947 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2948 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2949 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2952 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2953 defined $rawlines[$linenr] &&
2954 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2957 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2958 defined $rawlines[$linenr] &&
2959 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2960 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2962 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2963 $orig_desc .= " " . $1;
2967 ($id, $description) = git_commit_info
($orig_commit,
2971 ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
2972 ERROR
("GIT_COMMIT_ID",
2973 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2977 # Check for added, moved or deleted files
2978 if (!$reported_maintainer_file && !$in_commit_log &&
2979 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2980 $line =~ /^rename (?:from|to) [\w\/\
.\
-]+\s
*$/ ||
2981 ($line =~ /\{\s*([\w\/\
.\
-]*)\s
*\
=\
>\s
*([\w\
/\.\-]*)\s*\}/ &&
2982 (defined($1) || defined($2))))) {
2984 $reported_maintainer_file = 1;
2985 WARN
("FILE_PATH_CHANGES",
2986 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2989 # Check for adding new DT bindings not in schema format
2990 if (!$in_commit_log &&
2991 ($line =~ /^new file mode\s*\d+\s*$/) &&
2992 ($realfile =~ m@
^Documentation
/devicetree/bindings
/.*\
.txt
$@
)) {
2993 WARN
("DT_SCHEMA_BINDING_PATCH",
2994 "DT bindings should be in DT schema format. See: Documentation/devicetree/writing-schema.rst\n");
2997 # Check for wrappage within a valid hunk of the file
2998 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
2999 ERROR
("CORRUPTED_PATCH",
3000 "patch seems to be corrupt (line wrapped?)\n" .
3001 $herecurr) if (!$emitted_corrupt++);
3004 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
3005 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
3006 $rawline !~ m/^$UTF8*$/) {
3007 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
3009 my $blank = copy_spacing
($rawline);
3010 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
3011 my $hereptr = "$hereline$ptr\n";
3014 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
3017 # Check if it's the start of a commit log
3018 # (not a header line and we haven't seen the patch filename)
3019 if ($in_header_lines && $realfile =~ /^$/ &&
3020 !($rawline =~ /^\s+(?:\S|$)/ ||
3021 $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
3022 $in_header_lines = 0;
3024 $has_commit_log = 1;
3027 # Check if there is UTF-8 in a commit log when a mail header has explicitly
3028 # declined it, i.e defined some charset where it is missing.
3029 if ($in_header_lines &&
3030 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
3032 $non_utf8_charset = 1;
3035 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
3036 $rawline =~ /$NON_ASCII_UTF8/) {
3037 WARN
("UTF8_BEFORE_PATCH",
3038 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
3041 # Check for absolute kernel paths in commit message
3042 if ($tree && $in_commit_log) {
3043 while ($line =~ m{(?:^|\s)(/\S*)}g) {
3046 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
3047 check_absolute_file
($1, $herecurr)) {
3050 check_absolute_file
($file, $herecurr);
3055 # Check for various typo / spelling mistakes
3056 if (defined($misspellings) &&
3057 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
3058 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
3060 my $typo_fix = $spelling_fix{lc($typo)};
3061 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
3062 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
3063 my $msg_level = \
&WARN
;
3064 $msg_level = \
&CHK
if ($file);
3065 if (&{$msg_level}("TYPO_SPELLING",
3066 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
3068 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
3073 # check for invalid commit id
3074 if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) {
3077 ($id, $description) = git_commit_info
($2, undef, undef);
3078 if (!defined($id)) {
3079 WARN
("UNKNOWN_COMMIT_ID",
3080 "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr);
3084 # ignore non-hunk lines and lines being removed
3085 next if (!$hunk_line || $line =~ /^-/);
3087 #trailing whitespace
3088 if ($line =~ /^\+.*\015/) {
3089 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
3090 if (ERROR
("DOS_LINE_ENDINGS",
3091 "DOS line endings\n" . $herevet) &&
3093 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
3095 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
3096 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
3097 if (ERROR
("TRAILING_WHITESPACE",
3098 "trailing whitespace\n" . $herevet) &&
3100 $fixed[$fixlinenr] =~ s/\s+$//;
3106 # Check for FSF mailing addresses.
3107 if ($rawline =~ /\bwrite to the Free/i ||
3108 $rawline =~ /\b675\s+Mass\s+Ave/i ||
3109 $rawline =~ /\b59\s+Temple\s+Pl/i ||
3110 $rawline =~ /\b51\s+Franklin\s+St/i) {
3111 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
3112 my $msg_level = \
&ERROR
;
3113 $msg_level = \
&CHK
if ($file);
3114 &{$msg_level}("FSF_MAILING_ADDRESS",
3115 "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)
3118 # check for Kconfig help text having a real description
3119 # Only applies when adding the entry originally, after that we do not have
3120 # sufficient context to determine whether it is indeed long enough.
3121 if ($realfile =~ /Kconfig/ &&
3122 # 'choice' is usually the last thing on the line (though
3123 # Kconfig supports named choices), so use a word boundary
3124 # (\b) rather than a whitespace character (\s)
3125 $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) {
3128 my $ln = $linenr + 1;
3132 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
3133 $f = $lines[$ln - 1];
3134 $cnt-- if ($lines[$ln - 1] !~ /^-/);
3135 $is_end = $lines[$ln - 1] =~ /^\+/;
3137 next if ($f =~ /^-/);
3138 last if (!$file && $f =~ /^\@\@/);
3140 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
3142 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) {
3143 if ($lines[$ln - 1] =~ "---help---") {
3144 WARN
("CONFIG_DESCRIPTION",
3145 "prefer 'help' over '---help---' for new help texts\n" . $herecurr);
3153 next if ($f =~ /^$/);
3155 # This only checks context lines in the patch
3156 # and so hopefully shouldn't trigger false
3157 # positives, even though some of these are
3158 # common words in help texts
3159 if ($f =~ /^\s
*(?
:config
|menuconfig
|choice
|endchoice
|
3160 if|endif
|menu
|endmenu
|source
)\b/x
) {
3166 if ($is_start && $is_end && $length < $min_conf_desc_length) {
3167 WARN
("CONFIG_DESCRIPTION",
3168 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
3170 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
3173 # check for MAINTAINERS entries that don't have the right form
3174 if ($realfile =~ /^MAINTAINERS$/ &&
3175 $rawline =~ /^\+[A-Z]:/ &&
3176 $rawline !~ /^\+[A-Z]:\t\S/) {
3177 if (WARN
("MAINTAINERS_STYLE",
3178 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
3180 $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
3184 # discourage the use of boolean for type definition attributes of Kconfig options
3185 if ($realfile =~ /Kconfig/ &&
3186 $line =~ /^\+\s*\bboolean\b/) {
3187 WARN
("CONFIG_TYPE_BOOLEAN",
3188 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
3191 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
3192 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
3195 'EXTRA_AFLAGS' => 'asflags-y',
3196 'EXTRA_CFLAGS' => 'ccflags-y',
3197 'EXTRA_CPPFLAGS' => 'cppflags-y',
3198 'EXTRA_LDFLAGS' => 'ldflags-y',
3201 WARN
("DEPRECATED_VARIABLE",
3202 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
3205 # check for DT compatible documentation
3206 if (defined $root &&
3207 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
3208 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
3210 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
3212 my $dt_path = $root . "/Documentation/devicetree/bindings/";
3213 my $vp_file = $dt_path . "vendor-prefixes.yaml";
3215 foreach my $compat (@compats) {
3216 my $compat2 = $compat;
3217 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
3218 my $compat3 = $compat;
3219 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
3220 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
3222 WARN
("UNDOCUMENTED_DT_STRING",
3223 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
3226 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
3228 `grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`;
3230 WARN
("UNDOCUMENTED_DT_STRING",
3231 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
3236 # check for using SPDX license tag at beginning of files
3237 if ($realline == $checklicenseline) {
3238 if ($rawline =~ /^[ \+]\s*\#\!\s*\//) {
3239 $checklicenseline = 2;
3240 } elsif ($rawline =~ /^\+/) {
3242 if ($realfile =~ /\.(h|s|S)$/) {
3244 } elsif ($realfile =~ /\.(c|dts|dtsi)$/) {
3246 } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc|yaml)$/) {
3248 } elsif ($realfile =~ /\.rst$/) {
3252 # check SPDX comment style for .[chsS] files
3253 if ($realfile =~ /\.[chsS]$/ &&
3254 $rawline =~ /SPDX-License-Identifier:/ &&
3255 $rawline !~ m@
^\
+\s
*\Q
$comment\E\s
*@
) {
3256 WARN
("SPDX_LICENSE_TAG",
3257 "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr);
3260 if ($comment !~ /^$/ &&
3261 $rawline !~ m@
^\
+\Q
$comment\E SPDX
-License
-Identifier
: @
) {
3262 WARN
("SPDX_LICENSE_TAG",
3263 "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr);
3264 } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) {
3265 my $spdx_license = $1;
3266 if (!is_SPDX_License_valid
($spdx_license)) {
3267 WARN
("SPDX_LICENSE_TAG",
3268 "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr);
3270 if ($realfile =~ m@
^Documentation
/devicetree/bindings
/@
&&
3271 not $spdx_license =~ /GPL-2\.0.*BSD-2-Clause/) {
3272 my $msg_level = \
&WARN
;
3273 $msg_level = \
&CHK
if ($file);
3274 if (&{$msg_level}("SPDX_LICENSE_TAG",
3276 "DT binding documents should be licensed (GPL-2.0-only OR BSD-2-Clause)\n" . $herecurr) &&
3278 $fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/;
3285 # check we are in a valid source file if not then ignore this hunk
3286 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
3288 # check for using SPDX-License-Identifier on the wrong line number
3289 if ($realline != $checklicenseline &&
3290 $rawline =~ /\bSPDX-License-Identifier:/ &&
3291 substr($line, @
-, @
+ - @
-) eq "$;" x
(@
+ - @
-)) {
3292 WARN
("SPDX_LICENSE_TAG",
3293 "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr);
3296 # line length limit (with some exclusions)
3298 # There are a few types of lines that may extend beyond $max_line_length:
3299 # logging functions like pr_info that end in a string
3300 # lines with a single string
3301 # #defines that are a single string
3302 # lines with an RFC3986 like URL
3304 # There are 3 different line length message types:
3305 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
3306 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
3307 # LONG_LINE all other lines longer than $max_line_length
3309 # if LONG_LINE is ignored, the other 2 types are also ignored
3312 if ($line =~ /^\+/ && $length > $max_line_length) {
3313 my $msg_type = "LONG_LINE";
3315 # Check the allowed long line types first
3317 # logging functions that end in a string that starts
3318 # before $max_line_length
3319 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3320 length(expand_tabs
(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3323 # lines with only strings (w/ possible termination)
3324 # #defines with only strings
3325 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
3326 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
3329 # More special cases
3330 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
3331 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
3334 # URL ($rawline is used in case the URL is in a comment)
3335 } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\
/\S+/i) {
3338 # Otherwise set the alternate message types
3340 # a comment starts before $max_line_length
3341 } elsif ($line =~ /($;[\s$;]*)$/ &&
3342 length(expand_tabs
(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3343 $msg_type = "LONG_LINE_COMMENT"
3345 # a quoted string starts before $max_line_length
3346 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
3347 length(expand_tabs
(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3348 $msg_type = "LONG_LINE_STRING"
3351 if ($msg_type ne "" &&
3352 (show_type
("LONG_LINE") || show_type
($msg_type))) {
3353 my $msg_level = \
&WARN
;
3354 $msg_level = \
&CHK
if ($file);
3355 &{$msg_level}($msg_type,
3356 "line length of $length exceeds $max_line_length columns\n" . $herecurr);
3360 # check for adding lines without a newline.
3361 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
3362 WARN
("MISSING_EOF_NEWLINE",
3363 "adding a line without newline at end of file\n" . $herecurr);
3367 u_boot_line
($realfile, $line, $rawline, $herecurr);
3370 # check we are in a valid source file C or perl if not then ignore this hunk
3371 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
3373 # at the beginning of a line any tabs must come first and anything
3374 # more than $tabsize must use tabs.
3375 if ($rawline =~ /^\+\s* \t\s*\S/ ||
3376 $rawline =~ /^\+\s* \s*/) {
3377 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
3379 if (ERROR
("CODE_INDENT",
3380 "code indent should use tabs where possible\n" . $herevet) &&
3382 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3386 # check for space before tabs.
3387 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
3388 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
3389 if (WARN
("SPACE_BEFORE_TAB",
3390 "please, no space before tabs\n" . $herevet) &&
3392 while ($fixed[$fixlinenr] =~
3393 s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {}
3394 while ($fixed[$fixlinenr] =~
3395 s/(^\+.*) +\t/$1\t/) {}
3399 # check for assignments on the start of a line
3400 if ($sline =~ /^\+\s+($Assignment)[^=]/) {
3401 CHK
("ASSIGNMENT_CONTINUATIONS",
3402 "Assignment operator '$1' should be on the previous line\n" . $hereprev);
3405 # check for && or || at the start of a line
3406 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
3407 CHK
("LOGICAL_CONTINUATIONS",
3408 "Logical continuations should be on the previous line\n" . $hereprev);
3411 # check indentation starts on a tab stop
3412 if ($perl_version_ok &&
3413 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
3414 my $indent = length($1);
3415 if ($indent % $tabsize) {
3417 "Statements should start on a tabstop\n" . $herecurr) &&
3419 $fixed[$fixlinenr] =~ s@
(^\
+\t+) +@
$1 . "\t" x
($indent/$tabsize)@e;
3424 # check multi-line statement indentation matches previous line
3425 if ($perl_version_ok &&
3426 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
3427 $prevline =~ /^\+(\t*)(.*)$/;
3431 my $pos = pos_last_openparen
($rest);
3433 $line =~ /^(\+| )([ \t]*)/;
3436 my $goodtabindent = $oldindent .
3437 "\t" x
($pos / $tabsize) .
3438 " " x
($pos % $tabsize);
3439 my $goodspaceindent = $oldindent . " " x
$pos;
3441 if ($newindent ne $goodtabindent &&
3442 $newindent ne $goodspaceindent) {
3444 if (CHK
("PARENTHESIS_ALIGNMENT",
3445 "Alignment should match open parenthesis\n" . $hereprev) &&
3446 $fix && $line =~ /^\+/) {
3447 $fixed[$fixlinenr] =~
3448 s/^\+[ \t]*/\+$goodtabindent/;
3454 # check for space after cast like "(int) foo" or "(struct foo) bar"
3455 # avoid checking a few false positives:
3456 # "sizeof(<type>)" or "__alignof__(<type>)"
3457 # function pointer declarations like "(*foo)(int) = bar;"
3458 # structure definitions like "(struct foo) { 0 };"
3459 # multiline macros that define functions
3460 # known attributes or the __attribute__ keyword
3461 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
3462 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
3464 "No space is necessary after a cast\n" . $herecurr) &&
3466 $fixed[$fixlinenr] =~
3467 s/(\(\s*$Type\s*\))[ \t]+/$1/;
3471 # Block comment styles
3472 # Networking with an initial /*
3473 if ($realfile =~ m@
^(drivers
/net
/|net
/)@
&&
3474 $prevrawline =~ /^\+[ \t]*\/\
*[ \t]*$/ &&
3475 $rawline =~ /^\+[ \t]*\*/ &&
3477 WARN
("NETWORKING_BLOCK_COMMENT_STYLE",
3478 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3481 # Block comments use * on subsequent lines
3482 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3483 $prevrawline =~ /^\+.*?\/\
*/ && #starting /*
3484 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
3485 $rawline =~ /^\+/ && #line is new
3486 $rawline !~ /^\+[ \t]*\*/) { #no leading *
3487 WARN
("BLOCK_COMMENT_STYLE",
3488 "Block comments use * on subsequent lines\n" . $hereprev);
3491 # Block comments use */ on trailing lines
3492 if ($rawline !~ m@
^\
+[ \t]*\
*/[ \t]*$@ && #trailing */
3493 $rawline !~ m@
^\
+.*/\*.*\*/[ \t]*$@
&& #inline /*...*/
3494 $rawline !~ m@
^\
+.*\
*{2,}/[ \t]*$@ && #trailing **/
3495 $rawline =~ m@
^\
+[ \t]*.+\
*\
/[ \t]*$@) { #non blank */
3496 WARN
("BLOCK_COMMENT_STYLE",
3497 "Block comments use a trailing */ on a separate line\n" . $herecurr);
3500 # Block comment * alignment
3501 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3502 $line =~ /^\+[ \t]*$;/ && #leading comment
3503 $rawline =~ /^\+[ \t]*\*/ && #leading *
3504 (($prevrawline =~ /^\+.*?\/\
*/ && #leading /*
3505 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
3506 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3508 $prevrawline =~ m@
^\
+([ \t]*/?
)\
*@
;
3510 $oldindent = expand_tabs
($1);
3512 $prevrawline =~ m@
^\
+(.*/?
)\
*@
;
3513 $oldindent = expand_tabs
($1);
3515 $rawline =~ m@
^\
+([ \t]*)\
*@
;
3517 $newindent = expand_tabs
($newindent);
3518 if (length($oldindent) ne length($newindent)) {
3519 WARN
("BLOCK_COMMENT_STYLE",
3520 "Block comments should align the * on each line\n" . $hereprev);
3524 # check for missing blank lines after struct/union declarations
3525 # with exceptions for various attributes and macros
3526 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3528 !($line =~ /^\+\s*$/ ||
3529 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3530 $line =~ /^\+\s*MODULE_/i ||
3531 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3532 $line =~ /^\+[a-z_]*init/ ||
3533 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3534 $line =~ /^\+\s*DECLARE/ ||
3535 $line =~ /^\+\s*builtin_[\w_]*driver/ ||
3536 $line =~ /^\+\s*__setup/)) {
3537 if (CHK
("LINE_SPACING",
3538 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3540 fix_insert_line
($fixlinenr, "\+");
3544 # check for multiple consecutive blank lines
3545 if ($prevline =~ /^[\+ ]\s*$/ &&
3546 $line =~ /^\+\s*$/ &&
3547 $last_blank_line != ($linenr - 1)) {
3548 if (CHK
("LINE_SPACING",
3549 "Please don't use multiple blank lines\n" . $hereprev) &&
3551 fix_delete_line
($fixlinenr, $rawline);
3554 $last_blank_line = $linenr;
3557 # check for missing blank lines after declarations
3558 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3559 # actual declarations
3560 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
3561 # function pointer declarations
3562 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3563 # foo bar; where foo is some local typedef or #define
3564 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3565 # known declaration macros
3566 $prevline =~ /^\+\s+$declaration_macros/) &&
3567 # for "else if" which can look like "$Ident $Ident"
3568 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3569 # other possible extensions of declaration lines
3570 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3571 # not starting a section or a macro "\" extended line
3572 $prevline =~ /(?:\{\s*|\\)$/) &&
3573 # looks like a declaration
3574 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
3575 # function pointer declarations
3576 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3577 # foo bar; where foo is some local typedef or #define
3578 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3579 # known declaration macros
3580 $sline =~ /^\+\s+$declaration_macros/ ||
3581 # start of struct or union or enum
3582 $sline =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ ||
3583 # start or end of block or continuation of declaration
3584 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3585 # bitfield continuation
3586 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3587 # other possible extensions of declaration lines
3588 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3589 # indentation of previous and current line are the same
3590 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
3591 if (WARN
("LINE_SPACING",
3592 "Missing a blank line after declarations\n" . $hereprev) &&
3594 fix_insert_line
($fixlinenr, "\+");
3598 # check for spaces at the beginning of a line.
3600 # 1) within comments
3601 # 2) indented preprocessor commands
3603 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
3604 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
3605 if (WARN
("LEADING_SPACE",
3606 "please, no spaces at the start of a line\n" . $herevet) &&
3608 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3612 # check we are in a valid C source file if not then ignore this hunk
3613 next if ($realfile !~ /\.(h|c)$/);
3615 # check for unusual line ending [ or (
3616 if ($line =~ /^\+.*([\[\(])\s*$/) {
3617 CHK
("OPEN_ENDED_LINE",
3618 "Lines should not end with a '$1'\n" . $herecurr);
3621 # check if this appears to be the start function declaration, save the name
3622 if ($sline =~ /^\+\{\s*$/ &&
3623 $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
3624 $context_function = $1;
3627 # check if this appears to be the end of function declaration
3628 if ($sline =~ /^\+\}\s*$/) {
3629 undef $context_function;
3632 # check indentation of any line with a bare else
3633 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
3634 # if the previous line is a break or return and is indented 1 tab more...
3635 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3636 my $tabs = length($1) + 1;
3637 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3638 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3639 defined $lines[$linenr] &&
3640 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
3641 WARN
("UNNECESSARY_ELSE",
3642 "else is not generally useful after a break or return\n" . $hereprev);
3646 # check indentation of a line with a break;
3647 # if the previous line is a goto or return and is indented the same # of tabs
3648 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3650 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3651 WARN
("UNNECESSARY_BREAK",
3652 "break is not useful after a goto or return\n" . $hereprev);
3656 # check for RCS/CVS revision markers
3657 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
3659 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
3662 # check for old HOTPLUG __dev<foo> section markings
3663 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3664 WARN
("HOTPLUG_SECTION",
3665 "Using $1 is unnecessary\n" . $herecurr);
3668 # Check for potential 'bare' types
3669 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3671 #print "LINE<$line>\n";
3672 if ($linenr > $suppress_statement &&
3673 $realcnt && $sline =~ /.\s*\S/) {
3674 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3675 ctx_statement_block
($linenr, $realcnt, 0);
3676 $stat =~ s/\n./\n /g;
3677 $cond =~ s/\n./\n /g;
3679 #print "linenr<$linenr> <$stat>\n";
3680 # If this statement has no statement boundaries within
3681 # it there is no point in retrying a statement scan
3682 # until we hit end of it.
3683 my $frag = $stat; $frag =~ s/;+\s*$//;
3684 if ($frag !~ /(?:{|;)/) {
3685 #print "skip<$line_nr_next>\n";
3686 $suppress_statement = $line_nr_next;
3689 # Find the real next line.
3690 $realline_next = $line_nr_next;
3691 if (defined $realline_next &&
3692 (!defined $lines[$realline_next - 1] ||
3693 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3700 # Ignore goto labels.
3701 if ($s =~ /$Ident:\*$/s) {
3703 # Ignore functions being called
3704 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
3706 } elsif ($s =~ /^.\s*else\b/s) {
3708 # declarations always start with types
3709 } 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) {
3712 possible
($type, "A:" . $s);
3714 # definitions in global scope can only start with types
3715 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
3716 possible
($1, "B:" . $s);
3719 # any (foo ... *) is a pointer cast, and foo is a type
3720 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
3721 possible
($1, "C:" . $s);
3724 # Check for any sort of function declaration.
3725 # int foo(something bar, other baz);
3726 # void (*store_gdt)(x86_descr_ptr *);
3727 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3728 my ($name_len) = length($1);
3731 substr($ctx, 0, $name_len + 1, '');
3732 $ctx =~ s/\)[^\)]*$//;
3734 for my $arg (split(/\s*,\s*/, $ctx)) {
3735 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3737 possible
($1, "D:" . $s);
3745 # Checks which may be anchored in the context.
3748 # Check for switch () and associated case and default
3749 # statements should be at the same indent.
3750 if ($line=~/\bswitch\s*\(.*\)/) {
3753 my @ctx = ctx_block_outer
($linenr, $realcnt);
3755 for my $ctx (@ctx) {
3756 my ($clen, $cindent) = line_stats
($ctx);
3757 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3758 $indent != $cindent) {
3759 $err .= "$sep$ctx\n";
3766 ERROR
("SWITCH_CASE_INDENT_LEVEL",
3767 "switch and case should be at the same indent\n$hereline$err");
3771 # if/while/etc brace do not go on next line, unless defining a do while loop,
3772 # or if that brace on the next line is for something else
3773 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3774 my $pre_ctx = "$1$2";
3776 my ($level, @ctx) = ctx_statement_level
($linenr, $realcnt, 0);
3778 if ($line =~ /^\+\t{6,}/) {
3779 WARN
("DEEP_INDENTATION",
3780 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3783 my $ctx_cnt = $realcnt - $#ctx - 1;
3784 my $ctx = join("\n", @ctx);
3786 my $ctx_ln = $linenr;
3787 my $ctx_skip = $realcnt;
3789 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3790 defined $lines[$ctx_ln - 1] &&
3791 $lines[$ctx_ln - 1] =~ /^-/)) {
3792 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3793 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
3797 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3798 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3800 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
3802 "that open brace { should be on the previous line\n" .
3803 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3805 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3806 $ctx =~ /\)\s*\;\s*$/ &&
3807 defined $lines[$ctx_ln - 1])
3809 my ($nlength, $nindent) = line_stats
($lines[$ctx_ln - 1]);
3810 if ($nindent > $indent) {
3811 WARN
("TRAILING_SEMICOLON",
3812 "trailing semicolon indicates no statements, indent implies otherwise\n" .
3813 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3818 # Check relative indent for conditionals and blocks.
3819 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3820 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3821 ctx_statement_block
($linenr, $realcnt, 0)
3822 if (!defined $stat);
3823 my ($s, $c) = ($stat, $cond);
3825 substr($s, 0, length($c), '');
3827 # remove inline comments
3831 # Find out how long the conditional actually is.
3832 my @newlines = ($c =~ /\n/gs);
3833 my $cond_lines = 1 + $#newlines;
3835 # Make sure we remove the line prefixes as we have
3836 # none on the first line, and are going to readd them
3839 while ($s =~ /\n\s+\\\n/) {
3840 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3843 # We want to check the first line inside the block
3844 # starting at the end of the conditional, so remove:
3845 # 1) any blank line termination
3846 # 2) any opening brace { on end of the line
3848 my $continuation = 0;
3850 $s =~ s/^.*\bdo\b//;
3852 if ($s =~ s/^\s*\\//) {
3855 if ($s =~ s/^\s*?\n//) {
3860 # Also ignore a loop construct at the end of a
3861 # preprocessor statement.
3862 if (($prevline =~ /^.\s*#\s*define\s/ ||
3863 $prevline =~ /\\\s*$/) && $continuation == 0) {
3869 while ($cond_ptr != $cond_lines) {
3870 $cond_ptr = $cond_lines;
3872 # If we see an #else/#elif then the code
3874 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3879 # 1) blank lines, they should be at 0,
3880 # 2) preprocessor lines, and
3882 if ($continuation ||
3884 $s =~ /^\s*#\s*?/ ||
3885 $s =~ /^\s*$Ident\s*:/) {
3886 $continuation = ($s =~ /^.*?\\\n/) ?
1 : 0;
3887 if ($s =~ s/^.*?\n//) {
3893 my (undef, $sindent) = line_stats
("+" . $s);
3894 my $stat_real = raw_line
($linenr, $cond_lines);
3896 # Check if either of these lines are modified, else
3897 # this is not this patch's fault.
3898 if (!defined($stat_real) ||
3899 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3902 if (defined($stat_real) && $cond_lines > 1) {
3903 $stat_real = "[...]\n$stat_real";
3906 #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";
3908 if ($check && $s ne '' &&
3909 (($sindent % $tabsize) != 0 ||
3910 ($sindent < $indent) ||
3911 ($sindent == $indent &&
3912 ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
3913 ($sindent > $indent + $tabsize))) {
3914 WARN
("SUSPECT_CODE_INDENT",
3915 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3919 # Track the 'values' across context and added lines.
3920 my $opline = $line; $opline =~ s/^./ /;
3921 my ($curr_values, $curr_vars) =
3922 annotate_values
($opline . "\n", $prev_values);
3923 $curr_values = $prev_values . $curr_values;
3925 my $outline = $opline; $outline =~ s/\t/ /g;
3926 print "$linenr > .$outline\n";
3927 print "$linenr > $curr_values\n";
3928 print "$linenr > $curr_vars\n";
3930 $prev_values = substr($curr_values, -1);
3932 #ignore lines not being added
3933 next if ($line =~ /^[^\+]/);
3935 # check for dereferences that span multiple lines
3936 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
3937 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
3938 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
3940 $line =~ /^.\s*($Lval)/;
3943 WARN
("MULTILINE_DEREFERENCE",
3944 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
3947 # check for declarations of signed or unsigned without int
3948 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3951 $var = "" if (!defined $var);
3952 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
3956 $pointer = "" if (!defined $pointer);
3958 if (WARN
("UNSPECIFIED_INT",
3959 "Prefer '" . trim
($sign) . " int" . rtrim
($pointer) . "' to bare use of '$sign" . rtrim
($pointer) . "'\n" . $herecurr) &&
3961 my $decl = trim
($sign) . " int ";
3962 my $comp_pointer = $pointer;
3963 $comp_pointer =~ s/\s//g;
3964 $decl .= $comp_pointer;
3965 $decl = rtrim
($decl) if ($var eq "");
3966 $fixed[$fixlinenr] =~ s@
\b$sign\s
*\Q
$pointer\E\s
*$var\b@
$decl$var@
;
3971 # TEST: allow direct testing of the type matcher.
3973 if ($line =~ /^.\s*$Declare\s*$/) {
3975 "TEST: is type\n" . $herecurr);
3976 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
3977 ERROR
("TEST_NOT_TYPE",
3978 "TEST: is not type ($1 is)\n". $herecurr);
3982 # TEST: allow direct testing of the attribute matcher.
3984 if ($line =~ /^.\s*$Modifier\s*$/) {
3986 "TEST: is attr\n" . $herecurr);
3987 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
3988 ERROR
("TEST_NOT_ATTR",
3989 "TEST: is not attr ($1 is)\n". $herecurr);
3994 # check for initialisation to aggregates open brace on the next line
3995 if ($line =~ /^.\s*{/ &&
3996 $prevline =~ /(?:^|[^=])=\s*$/) {
3997 if (ERROR
("OPEN_BRACE",
3998 "that open brace { should be on the previous line\n" . $hereprev) &&
3999 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4000 fix_delete_line
($fixlinenr - 1, $prevrawline);
4001 fix_delete_line
($fixlinenr, $rawline);
4002 my $fixedline = $prevrawline;
4003 $fixedline =~ s/\s*=\s*$/ = {/;
4004 fix_insert_line
($fixlinenr, $fixedline);
4006 $fixedline =~ s/^(.\s*)\{\s*/$1/;
4007 fix_insert_line
($fixlinenr, $fixedline);
4012 # Checks which are anchored on the added line.
4015 # check for malformed paths in #include statements (uses RAW line)
4016 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
4018 if ($path =~ m{//}) {
4019 ERROR
("MALFORMED_INCLUDE",
4020 "malformed #include filename\n" . $herecurr);
4022 if ($path =~ "^uapi/" && $realfile =~ m@
\binclude
/uapi
/@
) {
4023 ERROR
("UAPI_INCLUDE",
4024 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
4028 # no C99 // comments
4029 if ($line =~ m{//}) {
4030 if (ERROR
("C99_COMMENTS",
4031 "do not use C99 // comments\n" . $herecurr) &&
4033 my $line = $fixed[$fixlinenr];
4034 if ($line =~ /\/\
/(.*)$/) {
4035 my $comment = trim
($1);
4036 $fixed[$fixlinenr] =~ s@\
/\/(.*)$@
/\* $comment \*/@
;
4040 # Remove C99 comments.
4042 $opline =~ s@
//.*@@
;
4044 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
4045 # the whole statement.
4046 #print "APW <$lines[$realline_next - 1]>\n";
4047 if (defined $realline_next &&
4048 exists $lines[$realline_next - 1] &&
4049 !defined $suppress_export{$realline_next} &&
4050 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
4051 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
4052 # Handle definitions which produce identifiers with
4055 # EXPORT_SYMBOL(something_foo);
4057 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
4058 $name =~ /^${Ident}_$2/) {
4059 #print "FOO C name<$name>\n";
4060 $suppress_export{$realline_next} = 1;
4062 } elsif ($stat !~ /(?
:
4064 ^.DEFINE_
$Ident\
(\Q
$name\E\
)|
4065 ^.DECLARE_
$Ident\
(\Q
$name\E\
)|
4066 ^.LIST_HEAD\
(\Q
$name\E\
)|
4067 ^.(?
:$Storage\s
+)?
$Type\s
*\
(\s
*\
*\s
*\Q
$name\E\s
*\
)\s
*\
(|
4068 \b\Q
$name\E
(?
:\s
+$Attribute)*\s
*(?
:;|=|\
[|\
()
4070 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
4071 $suppress_export{$realline_next} = 2;
4073 $suppress_export{$realline_next} = 1;
4076 if (!defined $suppress_export{$linenr} &&
4077 $prevline =~ /^.\s*$/ &&
4078 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
4079 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
4080 #print "FOO B <$lines[$linenr - 1]>\n";
4081 $suppress_export{$linenr} = 2;
4083 if (defined $suppress_export{$linenr} &&
4084 $suppress_export{$linenr} == 2) {
4085 WARN
("EXPORT_SYMBOL",
4086 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
4089 # check for global initialisers.
4090 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
4091 if (ERROR
("GLOBAL_INITIALISERS",
4092 "do not initialise globals to $1\n" . $herecurr) &&
4094 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
4097 # check for static initialisers.
4098 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
4099 if (ERROR
("INITIALISED_STATIC",
4100 "do not initialise statics to $1\n" .
4103 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
4107 # check for misordered declarations of char/short/int/long with signed/unsigned
4108 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
4110 WARN
("MISORDERED_TYPE",
4111 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
4114 # check for unnecessary <signed> int declarations of short/long/long long
4115 while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) {
4116 my $type = trim
($1);
4117 next if ($type !~ /\bint\b/);
4118 next if ($type !~ /\b(?:short|long\s+long|long)\b/);
4119 my $new_type = $type;
4120 $new_type =~ s/\b\s*int\s*\b/ /;
4121 $new_type =~ s/\b\s*(?:un)?signed\b\s*/ /;
4122 $new_type =~ s/^const\s+//;
4123 $new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/);
4124 $new_type = "const $new_type" if ($type =~ /^const\b/);
4125 $new_type =~ s/\s+/ /g;
4126 $new_type = trim
($new_type);
4127 if (WARN
("UNNECESSARY_INT",
4128 "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) &&
4130 $fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/;
4134 # check for static const char * arrays.
4135 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
4136 WARN
("STATIC_CONST_CHAR_ARRAY",
4137 "static const char * array should probably be static const char * const\n" .
4141 # check for initialized const char arrays that should be static const
4142 if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) {
4143 if (WARN
("STATIC_CONST_CHAR_ARRAY",
4144 "const array should probably be static const\n" . $herecurr) &&
4146 $fixed[$fixlinenr] =~ s/(^.\s*)const\b/${1}static const/;
4150 # check for static char foo[] = "bar" declarations.
4151 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
4152 WARN
("STATIC_CONST_CHAR_ARRAY",
4153 "static char array declaration should probably be static const char\n" .
4157 # check for const <foo> const where <foo> is not a pointer or array type
4158 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
4160 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
4162 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
4163 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
4165 "'const $found const' should probably be 'const $found'\n" . $herecurr);
4169 # check for non-global char *foo[] = {"bar", ...} declarations.
4170 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
4171 WARN
("STATIC_CONST_CHAR_ARRAY",
4172 "char * array declaration might be better as static const\n" .
4176 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
4177 if ($line =~ m@
\bsizeof\s
*\
(\s
*($Lval)\s
*\
)@
) {
4179 if ($line =~ m@
\b(sizeof\s
*\
(\s
*\Q
$array\E\s
*\
)\s
*/\s
*sizeof\s
*\
(\s
*\Q
$array\E\s
*\
[\s
*0\s
*\
]\s
*\
))@
) {
4181 if (WARN
("ARRAY_SIZE",
4182 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
4184 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
4189 # check for function declarations without arguments like "int foo()"
4190 if ($line =~ /(\b$Type\s*$Ident)\s*\(\s*\)/) {
4191 if (ERROR
("FUNCTION_WITHOUT_ARGS",
4192 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
4194 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
4198 # check for new typedefs, only function parameters and sparse annotations
4200 if ($line =~ /\btypedef\s/ &&
4201 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
4202 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
4203 $line !~ /\b$typeTypedefs\b/ &&
4204 $line !~ /\b__bitwise\b/) {
4205 WARN
("NEW_TYPEDEFS",
4206 "do not add new typedefs\n" . $herecurr);
4209 # * goes on variable not on type
4211 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
4213 my ($ident, $from, $to) = ($1, $2, $2);
4215 # Should start with a space.
4216 $to =~ s/^(\S)/ $1/;
4217 # Should not end with a space.
4219 # '*'s should not have spaces between.
4220 while ($to =~ s/\*\s+\*/\*\*/) {
4223 ## print "1: from<$from> to<$to> ident<$ident>\n";
4225 if (ERROR
("POINTER_LOCATION",
4226 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
4228 my $sub_from = $ident;
4229 my $sub_to = $ident;
4230 $sub_to =~ s/\Q$from\E/$to/;
4231 $fixed[$fixlinenr] =~
4232 s@\Q
$sub_from\E@
$sub_to@
;
4236 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
4238 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
4240 # Should start with a space.
4241 $to =~ s/^(\S)/ $1/;
4242 # Should not end with a space.
4244 # '*'s should not have spaces between.
4245 while ($to =~ s/\*\s+\*/\*\*/) {
4247 # Modifiers should have spaces.
4248 $to =~ s/(\b$Modifier$)/$1 /;
4250 ## print "2: from<$from> to<$to> ident<$ident>\n";
4251 if ($from ne $to && $ident !~ /^$Modifier$/) {
4252 if (ERROR
("POINTER_LOCATION",
4253 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
4256 my $sub_from = $match;
4257 my $sub_to = $match;
4258 $sub_to =~ s/\Q$from\E/$to/;
4259 $fixed[$fixlinenr] =~
4260 s@\Q
$sub_from\E@
$sub_to@
;
4265 # avoid BUG() or BUG_ON()
4266 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
4267 my $msg_level = \
&WARN
;
4268 $msg_level = \
&CHK
if ($file);
4269 &{$msg_level}("AVOID_BUG",
4270 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
4273 # avoid LINUX_VERSION_CODE
4274 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
4275 WARN
("LINUX_VERSION_CODE",
4276 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
4279 # check for uses of printk_ratelimit
4280 if ($line =~ /\bprintk_ratelimit\s*\(/) {
4281 WARN
("PRINTK_RATELIMITED",
4282 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
4285 # printk should use KERN_* levels
4286 if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
4287 WARN
("PRINTK_WITHOUT_KERN_LEVEL",
4288 "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
4291 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
4293 my $level = lc($orig);
4294 $level = "warn" if ($level eq "warning");
4295 my $level2 = $level;
4296 $level2 = "dbg" if ($level eq "debug");
4297 WARN
("PREFER_PR_LEVEL",
4298 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
4301 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
4303 my $level = lc($orig);
4304 $level = "warn" if ($level eq "warning");
4305 $level = "dbg" if ($level eq "debug");
4306 WARN
("PREFER_DEV_LEVEL",
4307 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
4310 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
4311 # number of false positives, but assembly files are not checked, so at
4312 # least the arch entry code will not trigger this warning.
4313 if ($line =~ /\bENOSYS\b/) {
4315 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
4318 # function brace can't be on same line, except for #defines of do while,
4319 # or if closed on same line
4320 if ($perl_version_ok &&
4321 $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ &&
4322 $sline !~ /\#\s*define\b.*do\s*\{/ &&
4324 if (ERROR
("OPEN_BRACE",
4325 "open brace '{' following function definitions go on the next line\n" . $herecurr) &&
4327 fix_delete_line
($fixlinenr, $rawline);
4328 my $fixed_line = $rawline;
4329 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
4332 fix_insert_line
($fixlinenr, ltrim
($line1));
4333 fix_insert_line
($fixlinenr, "\+{");
4334 if ($line2 !~ /^\s*$/) {
4335 fix_insert_line
($fixlinenr, "\+\t" . trim
($line2));
4340 # open braces for enum, union and struct go on the same line.
4341 if ($line =~ /^.\s*{/ &&
4342 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
4343 if (ERROR
("OPEN_BRACE",
4344 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
4345 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4346 fix_delete_line
($fixlinenr - 1, $prevrawline);
4347 fix_delete_line
($fixlinenr, $rawline);
4348 my $fixedline = rtrim
($prevrawline) . " {";
4349 fix_insert_line
($fixlinenr, $fixedline);
4350 $fixedline = $rawline;
4351 $fixedline =~ s/^(.\s*)\{\s*/$1\t/;
4352 if ($fixedline !~ /^\+\s*$/) {
4353 fix_insert_line
($fixlinenr, $fixedline);
4358 # missing space after union, struct or enum definition
4359 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
4361 "missing space after $1 definition\n" . $herecurr) &&
4363 $fixed[$fixlinenr] =~
4364 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
4368 # Function pointer declarations
4369 # check spacing between type, funcptr, and args
4370 # canonical declaration is "type (*funcptr)(args...)"
4371 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
4373 my $pre_pointer_space = $2;
4374 my $post_pointer_space = $3;
4376 my $post_funcname_space = $5;
4377 my $pre_args_space = $6;
4379 # the $Declare variable will capture all spaces after the type
4380 # so check it for a missing trailing missing space but pointer return types
4381 # don't need a space so don't warn for those.
4382 my $post_declare_space = "";
4383 if ($declare =~ /(\s+)$/) {
4384 $post_declare_space = $1;
4385 $declare = rtrim
($declare);
4387 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
4389 "missing space after return type\n" . $herecurr);
4390 $post_declare_space = " ";
4393 # unnecessary space "type (*funcptr)(args...)"
4394 # This test is not currently implemented because these declarations are
4396 # int foo(int bar, ...)
4397 # and this is form shouldn't/doesn't generate a checkpatch warning.
4399 # elsif ($declare =~ /\s{2,}$/) {
4401 # "Multiple spaces after return type\n" . $herecurr);
4404 # unnecessary space "type ( *funcptr)(args...)"
4405 if (defined $pre_pointer_space &&
4406 $pre_pointer_space =~ /^\s/) {
4408 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
4411 # unnecessary space "type (* funcptr)(args...)"
4412 if (defined $post_pointer_space &&
4413 $post_pointer_space =~ /^\s/) {
4415 "Unnecessary space before function pointer name\n" . $herecurr);
4418 # unnecessary space "type (*funcptr )(args...)"
4419 if (defined $post_funcname_space &&
4420 $post_funcname_space =~ /^\s/) {
4422 "Unnecessary space after function pointer name\n" . $herecurr);
4425 # unnecessary space "type (*funcptr) (args...)"
4426 if (defined $pre_args_space &&
4427 $pre_args_space =~ /^\s/) {
4429 "Unnecessary space before function pointer arguments\n" . $herecurr);
4432 if (show_type
("SPACING") && $fix) {
4433 $fixed[$fixlinenr] =~
4434 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
4438 # check for spacing round square brackets; allowed:
4439 # 1. with a type on the left -- int [] a;
4440 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4441 # 3. inside a curly brace -- = { [0...10] = 5 }
4442 while ($line =~ /(.*?\s)\[/g) {
4443 my ($where, $prefix) = ($-[1], $1);
4444 if ($prefix !~ /$Type\s+$/ &&
4445 ($where != 0 || $prefix !~ /^.\s+$/) &&
4446 $prefix !~ /[{,:]\s+$/) {
4447 if (ERROR
("BRACKET_SPACE",
4448 "space prohibited before open square bracket '['\n" . $herecurr) &&
4450 $fixed[$fixlinenr] =~
4451 s/^(\+.*?)\s+\[/$1\[/;
4456 # check for spaces between functions and their parentheses.
4457 while ($line =~ /($Ident)\s+\(/g) {
4459 my $ctx_before = substr($line, 0, $-[1]);
4460 my $ctx = "$ctx_before$name";
4462 # Ignore those directives where spaces _are_ permitted.
4464 if|for|while|switch
|return|case
|
4465 volatile
|__volatile__
|
4466 __attribute__
|format
|__extension__
|
4469 # cpp #define statements have non-optional spaces, ie
4470 # if there is a space between the name and the open
4471 # parenthesis it is simply not a parameter group.
4472 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
4474 # cpp #elif statement condition may start with a (
4475 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
4477 # If this whole things ends with a type its most
4478 # likely a typedef for a function.
4479 } elsif ($ctx =~ /$Type$/) {
4483 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
4485 $fixed[$fixlinenr] =~
4486 s/\b$name\s+\(/$name\(/;
4491 # Check operator spacing.
4492 if (!($line=~/\#\s*include/)) {
4493 my $fixed_line = "";
4497 <<=|>>=|<=|>=|==|!=|
4498 \
+=|-=|\
*=|\
/=|%=|\
^=|\
|=|&=|
4499 =>|->|<<|>>|<|>|=|!|~|
4500 &&|\
|\
||,|\
^|\
+\
+|--|&|\
||\
+|-|\
*|\
/|%|
4503 my @elements = split(/($ops|;)/, $opline);
4505 ## print("element count: <" . $#elements . ">\n");
4506 ## foreach my $el (@elements) {
4507 ## print("el: <$el>\n");
4510 my @fix_elements = ();
4513 foreach my $el (@elements) {
4514 push(@fix_elements, substr($rawline, $off, length($el)));
4515 $off += length($el);
4520 my $blank = copy_spacing
($opline);
4521 my $last_after = -1;
4523 for (my $n = 0; $n < $#elements; $n += 2) {
4525 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4527 ## print("n: <$n> good: <$good>\n");
4529 $off += length($elements[$n]);
4531 # Pick up the preceding and succeeding characters.
4532 my $ca = substr($opline, 0, $off);
4534 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4535 $cc = substr($opline, $off + length($elements[$n + 1]));
4537 my $cb = "$ca$;$cc";
4540 $a = 'V' if ($elements[$n] ne '');
4541 $a = 'W' if ($elements[$n] =~ /\s$/);
4542 $a = 'C' if ($elements[$n] =~ /$;$/);
4543 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4544 $a = 'O' if ($elements[$n] eq '');
4545 $a = 'E' if ($ca =~ /^\s*$/);
4547 my $op = $elements[$n + 1];
4550 if (defined $elements[$n + 2]) {
4551 $c = 'V' if ($elements[$n + 2] ne '');
4552 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
4553 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
4554 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4555 $c = 'O' if ($elements[$n + 2] eq '');
4556 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
4561 my $ctx = "${a}x${c}";
4563 my $at = "(ctx:$ctx)";
4565 my $ptr = substr($blank, 0, $off) . "^";
4566 my $hereptr = "$hereline$ptr\n";
4568 # Pull out the value of this operator.
4569 my $op_type = substr($curr_values, $off + 1, 1);
4571 # Get the full operator variant.
4572 my $opv = $op . substr($curr_vars, $off, 1);
4574 # Ignore operators passed as parameters.
4575 if ($op_type ne 'V' &&
4576 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
4579 # } elsif ($op =~ /^$;+$/) {
4581 # ; should have either the end of line or a space or \ after it
4582 } elsif ($op eq ';') {
4583 if ($ctx !~ /.x[WEBC]/ &&
4584 $cc !~ /^\\/ && $cc !~ /^;/) {
4585 if (ERROR
("SPACING",
4586 "space required after that '$op' $at\n" . $hereptr)) {
4587 $good = $fix_elements[$n] . trim
($fix_elements[$n + 1]) . " ";
4593 } elsif ($op eq '//') {
4595 # : when part of a bitfield
4596 } elsif ($opv eq ':B') {
4597 # skip the bitfield test for now
4601 } elsif ($op eq '->') {
4602 if ($ctx =~ /Wx.|.xW/) {
4603 if (ERROR
("SPACING",
4604 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
4605 $good = rtrim
($fix_elements[$n]) . trim
($fix_elements[$n + 1]);
4606 if (defined $fix_elements[$n + 2]) {
4607 $fix_elements[$n + 2] =~ s/^\s+//;
4613 # , must not have a space before and must have a space on the right.
4614 } elsif ($op eq ',') {
4615 my $rtrim_before = 0;
4616 my $space_after = 0;
4617 if ($ctx =~ /Wx./) {
4618 if (ERROR
("SPACING",
4619 "space prohibited before that '$op' $at\n" . $hereptr)) {
4624 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
4625 if (ERROR
("SPACING",
4626 "space required after that '$op' $at\n" . $hereptr)) {
4632 if ($rtrim_before || $space_after) {
4633 if ($rtrim_before) {
4634 $good = rtrim
($fix_elements[$n]) . trim
($fix_elements[$n + 1]);
4636 $good = $fix_elements[$n] . trim
($fix_elements[$n + 1]);
4643 # '*' as part of a type definition -- reported already.
4644 } elsif ($opv eq '*_') {
4645 #warn "'*' is part of type\n";
4647 # unary operators should have a space before and
4648 # none after. May be left adjacent to another
4649 # unary operator, or a cast
4650 } elsif ($op eq '!' || $op eq '~' ||
4651 $opv eq '*U' || $opv eq '-U' ||
4652 $opv eq '&U' || $opv eq '&&U') {
4653 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
4654 if (ERROR
("SPACING",
4655 "space required before that '$op' $at\n" . $hereptr)) {
4656 if ($n != $last_after + 2) {
4657 $good = $fix_elements[$n] . " " . ltrim
($fix_elements[$n + 1]);
4662 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
4663 # A unary '*' may be const
4665 } elsif ($ctx =~ /.xW/) {
4666 if (ERROR
("SPACING",
4667 "space prohibited after that '$op' $at\n" . $hereptr)) {
4668 $good = $fix_elements[$n] . rtrim
($fix_elements[$n + 1]);
4669 if (defined $fix_elements[$n + 2]) {
4670 $fix_elements[$n + 2] =~ s/^\s+//;
4676 # unary ++ and unary -- are allowed no space on one side.
4677 } elsif ($op eq '++' or $op eq '--') {
4678 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
4679 if (ERROR
("SPACING",
4680 "space required one side of that '$op' $at\n" . $hereptr)) {
4681 $good = $fix_elements[$n] . trim
($fix_elements[$n + 1]) . " ";
4685 if ($ctx =~ /Wx[BE]/ ||
4686 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
4687 if (ERROR
("SPACING",
4688 "space prohibited before that '$op' $at\n" . $hereptr)) {
4689 $good = rtrim
($fix_elements[$n]) . trim
($fix_elements[$n + 1]);
4693 if ($ctx =~ /ExW/) {
4694 if (ERROR
("SPACING",
4695 "space prohibited after that '$op' $at\n" . $hereptr)) {
4696 $good = $fix_elements[$n] . trim
($fix_elements[$n + 1]);
4697 if (defined $fix_elements[$n + 2]) {
4698 $fix_elements[$n + 2] =~ s/^\s+//;
4704 # << and >> may either have or not have spaces both sides
4705 } elsif ($op eq '<<' or $op eq '>>' or
4706 $op eq '&' or $op eq '^' or $op eq '|' or
4707 $op eq '+' or $op eq '-' or
4708 $op eq '*' or $op eq '/' or
4712 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4714 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4715 $good = rtrim
($fix_elements[$n]) . " " . trim
($fix_elements[$n + 1]) . " ";
4716 $fix_elements[$n + 2] =~ s/^\s+//;
4719 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4721 "space preferred before that '$op' $at\n" . $hereptr)) {
4722 $good = rtrim
($fix_elements[$n]) . " " . trim
($fix_elements[$n + 1]);
4726 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
4727 if (ERROR
("SPACING",
4728 "need consistent spacing around '$op' $at\n" . $hereptr)) {
4729 $good = rtrim
($fix_elements[$n]) . " " . trim
($fix_elements[$n + 1]) . " ";
4730 if (defined $fix_elements[$n + 2]) {
4731 $fix_elements[$n + 2] =~ s/^\s+//;
4737 # A colon needs no spaces before when it is
4738 # terminating a case value or a label.
4739 } elsif ($opv eq ':C' || $opv eq ':L') {
4740 if ($ctx =~ /Wx./) {
4741 if (ERROR
("SPACING",
4742 "space prohibited before that '$op' $at\n" . $hereptr)) {
4743 $good = rtrim
($fix_elements[$n]) . trim
($fix_elements[$n + 1]);
4748 # All the others need spaces both sides.
4749 } elsif ($ctx !~ /[EWC]x[CWE]/) {
4752 # Ignore email addresses <foo@bar>
4754 $cc =~ /^\S+\@\S+>/) ||
4756 $ca =~ /<\S+\@\S+$/))
4761 # for asm volatile statements
4762 # ignore a colon with another
4763 # colon immediately before or after
4765 ($ca =~ /:$/ || $cc =~ /^:/)) {
4769 # messages are ERROR, but ?: are CHK
4771 my $msg_level = \
&ERROR
;
4772 $msg_level = \
&CHK
if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4774 if (&{$msg_level}("SPACING",
4775 "spaces required around that '$op' $at\n" . $hereptr)) {
4776 $good = rtrim
($fix_elements[$n]) . " " . trim
($fix_elements[$n + 1]) . " ";
4777 if (defined $fix_elements[$n + 2]) {
4778 $fix_elements[$n + 2] =~ s/^\s+//;
4784 $off += length($elements[$n + 1]);
4786 ## print("n: <$n> GOOD: <$good>\n");
4788 $fixed_line = $fixed_line . $good;
4791 if (($#elements % 2) == 0) {
4792 $fixed_line = $fixed_line . $fix_elements[$#elements];
4795 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4796 $fixed[$fixlinenr] = $fixed_line;
4802 # check for whitespace before a non-naked semicolon
4803 if ($line =~ /^\+.*\S\s+;\s*$/) {
4805 "space prohibited before semicolon\n" . $herecurr) &&
4807 1 while $fixed[$fixlinenr] =~
4808 s/^(\+.*\S)\s+;/$1;/;
4812 # check for multiple assignments
4813 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
4814 CHK
("MULTIPLE_ASSIGNMENTS",
4815 "multiple assignments should be avoided\n" . $herecurr);
4818 ## # check for multiple declarations, allowing for a function declaration
4820 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4821 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4823 ## # Remove any bracketed sections to ensure we do not
4824 ## # falsly report the parameters of functions.
4826 ## while ($ln =~ s/\([^\(\)]*\)//g) {
4828 ## if ($ln =~ /,/) {
4829 ## WARN("MULTIPLE_DECLARATION",
4830 ## "declaring multiple variables together should be avoided\n" . $herecurr);
4834 #need space before brace following if, while, etc
4835 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
4836 $line =~ /\b(?:else|do)\{/) {
4837 if (ERROR
("SPACING",
4838 "space required before the open brace '{'\n" . $herecurr) &&
4840 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/;
4844 ## # check for blank lines before declarations
4845 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4846 ## $prevrawline =~ /^.\s*$/) {
4848 ## "No blank lines before declarations\n" . $hereprev);
4852 # closing brace should have a space following it when it has anything
4854 if ($line =~ /}(?!(?:,|;|\)|\}))\S/) {
4855 if (ERROR
("SPACING",
4856 "space required after that close brace '}'\n" . $herecurr) &&
4858 $fixed[$fixlinenr] =~
4859 s/}((?!(?:,|;|\)))\S)/} $1/;
4863 # check spacing on square brackets
4864 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
4865 if (ERROR
("SPACING",
4866 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4868 $fixed[$fixlinenr] =~
4872 if ($line =~ /\s\]/) {
4873 if (ERROR
("SPACING",
4874 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4876 $fixed[$fixlinenr] =~
4881 # check spacing on parentheses
4882 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4883 $line !~ /for\s*\(\s+;/) {
4884 if (ERROR
("SPACING",
4885 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4887 $fixed[$fixlinenr] =~
4891 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
4892 $line !~ /for\s*\(.*;\s+\)/ &&
4893 $line !~ /:\s+\)/) {
4894 if (ERROR
("SPACING",
4895 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4897 $fixed[$fixlinenr] =~
4902 # check unnecessary parentheses around addressof/dereference single $Lvals
4903 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4905 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
4907 if (CHK
("UNNECESSARY_PARENTHESES",
4908 "Unnecessary parentheses around $var\n" . $herecurr) &&
4910 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4914 # check for unnecessary parentheses around function pointer uses
4915 # ie: (foo->bar)(); should be foo->bar();
4916 # but not "if (foo->bar) (" to avoid some false positives
4917 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4919 if (CHK
("UNNECESSARY_PARENTHESES",
4920 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4922 my $var2 = deparenthesize
($var);
4924 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4928 # check for unnecessary parentheses around comparisons in if uses
4929 # when !drivers/staging or command-line uses --strict
4930 if (($realfile !~ m@
^(?
:drivers
/staging/)@
|| $check_orig) &&
4931 $perl_version_ok && defined($stat) &&
4932 $stat =~ /(^.\s*if\s*($balanced_parens))/) {
4934 my $test = substr($2, 1, -1);
4936 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4938 # avoid parentheses around potential macro args
4939 next if ($match =~ /^\s*\w+\s*$/);
4940 if (!defined($herectx)) {
4941 $herectx = $here . "\n";
4942 my $cnt = statement_rawlines
($if_stat);
4943 for (my $n = 0; $n < $cnt; $n++) {
4944 my $rl = raw_line
($linenr, $n);
4945 $herectx .= $rl . "\n";
4946 last if $rl =~ /^[ \+].*\{/;
4949 CHK
("UNNECESSARY_PARENTHESES",
4950 "Unnecessary parentheses around '$match'\n" . $herectx);
4954 #goto labels aren't indented, allow a single space however
4955 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
4956 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
4957 if (WARN
("INDENTED_LABEL",
4958 "labels should not be indented\n" . $herecurr) &&
4960 $fixed[$fixlinenr] =~
4965 # return is not a function
4966 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
4968 if ($perl_version_ok &&
4969 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4971 $value = deparenthesize
($value);
4972 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4973 ERROR
("RETURN_PARENTHESES",
4974 "return is not a function, parentheses are not required\n" . $herecurr);
4976 } elsif ($spacing !~ /\s+/) {
4978 "space required before the open parenthesis '('\n" . $herecurr);
4982 # unnecessary return in a void function
4983 # at end-of-function, with the previous line a single leading tab, then return;
4984 # and the line before that not a goto label target like "out:"
4985 if ($sline =~ /^[ \+]}\s*$/ &&
4986 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4988 $lines[$linenr - 3] =~ /^[ +]/ &&
4989 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
4991 "void function return statements are not generally useful\n" . $hereprev);
4994 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4995 if ($perl_version_ok &&
4996 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4997 my $openparens = $1;
4998 my $count = $openparens =~ tr@\
(@\
(@
;
5000 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
5001 my $comp = $4; #Not $1 because of $LvalOrFunc
5002 $msg = " - maybe == should be = ?" if ($comp eq "==");
5003 WARN
("UNNECESSARY_PARENTHESES",
5004 "Unnecessary parentheses$msg\n" . $herecurr);
5008 # comparisons with a constant or upper case identifier on the left
5009 # avoid cases like "foo + BAR < baz"
5010 # only fix matches surrounded by parentheses to avoid incorrect
5011 # conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
5012 if ($perl_version_ok &&
5013 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
5018 my $newcomp = $comp;
5019 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
5020 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
5021 WARN
("CONSTANT_COMPARISON",
5022 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
5026 } elsif ($comp eq "<=") {
5028 } elsif ($comp eq ">") {
5030 } elsif ($comp eq ">=") {
5033 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
5037 # Return of what appears to be an errno should normally be negative
5038 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
5040 if ($name ne 'EOF' && $name ne 'ERROR') {
5041 WARN
("USE_NEGATIVE_ERRNO",
5042 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
5046 # Need a space before open parenthesis after if, while etc
5047 if ($line =~ /\b(if|while|for|switch)\(/) {
5048 if (ERROR
("SPACING",
5049 "space required before the open parenthesis '('\n" . $herecurr) &&
5051 $fixed[$fixlinenr] =~
5052 s/\b(if|while|for|switch)\(/$1 \(/;
5056 # Check for illegal assignment in if conditional -- and check for trailing
5057 # statements after the conditional.
5058 if ($line =~ /do\s*(?!{)/) {
5059 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
5060 ctx_statement_block
($linenr, $realcnt, 0)
5061 if (!defined $stat);
5062 my ($stat_next) = ctx_statement_block
($line_nr_next,
5063 $remain_next, $off_next);
5064 $stat_next =~ s/\n./\n /g;
5065 ##print "stat<$stat> stat_next<$stat_next>\n";
5067 if ($stat_next =~ /^\s*while\b/) {
5068 # If the statement carries leading newlines,
5069 # then count those as offsets.
5071 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
5073 statement_rawlines
($whitespace) - 1;
5075 $suppress_whiletrailers{$line_nr_next +
5079 if (!defined $suppress_whiletrailers{$linenr} &&
5080 defined($stat) && defined($cond) &&
5081 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
5082 my ($s, $c) = ($stat, $cond);
5084 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
5085 ERROR
("ASSIGN_IN_IF",
5086 "do not use assignment in if condition\n" . $herecurr);
5089 # Find out what is on the end of the line after the
5091 substr($s, 0, length($c), '');
5093 $s =~ s/$;//g; # Remove any comments
5094 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
5095 $c !~ /}\s*while\s*/)
5097 # Find out how long the conditional actually is.
5098 my @newlines = ($c =~ /\n/gs);
5099 my $cond_lines = 1 + $#newlines;
5102 $stat_real = raw_line
($linenr, $cond_lines)
5103 . "\n" if ($cond_lines);
5104 if (defined($stat_real) && $cond_lines > 1) {
5105 $stat_real = "[...]\n$stat_real";
5108 ERROR
("TRAILING_STATEMENTS",
5109 "trailing statements should be on next line\n" . $herecurr . $stat_real);
5113 # Check for bitwise tests written as boolean
5125 WARN
("HEXADECIMAL_BOOLEAN_TEST",
5126 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
5129 # if and else should not have general statements after it
5130 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
5132 $s =~ s/$;//g; # Remove any comments
5133 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
5134 ERROR
("TRAILING_STATEMENTS",
5135 "trailing statements should be on next line\n" . $herecurr);
5138 # if should not continue a brace
5139 if ($line =~ /}\s*if\b/) {
5140 ERROR
("TRAILING_STATEMENTS",
5141 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
5144 # case and default should not have general statements after them
5145 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
5147 (?
:\s
*$;*)(?
:\s
*{)?
(?
:\s
*$;*)(?
:\s
*\\)?\s
*$|
5151 ERROR
("TRAILING_STATEMENTS",
5152 "trailing statements should be on next line\n" . $herecurr);
5155 # Check for }<nl>else {, these must be at the same
5156 # indent level to be relevant to each other.
5157 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
5158 $previndent == $indent) {
5159 if (ERROR
("ELSE_AFTER_BRACE",
5160 "else should follow close brace '}'\n" . $hereprev) &&
5161 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
5162 fix_delete_line
($fixlinenr - 1, $prevrawline);
5163 fix_delete_line
($fixlinenr, $rawline);
5164 my $fixedline = $prevrawline;
5165 $fixedline =~ s/}\s*$//;
5166 if ($fixedline !~ /^\+\s*$/) {
5167 fix_insert_line
($fixlinenr, $fixedline);
5169 $fixedline = $rawline;
5170 $fixedline =~ s/^(.\s*)else/$1} else/;
5171 fix_insert_line
($fixlinenr, $fixedline);
5175 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
5176 $previndent == $indent) {
5177 my ($s, $c) = ctx_statement_block
($linenr, $realcnt, 0);
5179 # Find out what is on the end of the line after the
5181 substr($s, 0, length($c), '');
5184 if ($s =~ /^\s*;/) {
5185 if (ERROR
("WHILE_AFTER_BRACE",
5186 "while should follow close brace '}'\n" . $hereprev) &&
5187 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
5188 fix_delete_line
($fixlinenr - 1, $prevrawline);
5189 fix_delete_line
($fixlinenr, $rawline);
5190 my $fixedline = $prevrawline;
5191 my $trailing = $rawline;
5192 $trailing =~ s/^\+//;
5193 $trailing = trim
($trailing);
5194 $fixedline =~ s/}\s*$/} $trailing/;
5195 fix_insert_line
($fixlinenr, $fixedline);
5200 #Specific variable tests
5201 while ($line =~ m{($Constant|$Lval)}g) {
5205 if ($var !~ /^$Constant$/ &&
5206 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
5207 #Ignore Page<foo> variants
5208 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
5209 #Ignore SI style variants like nS, mV and dB
5210 #(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE)
5211 $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ &&
5212 #Ignore some three character SI units explicitly, like MiB and KHz
5213 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
5214 while ($var =~ m{($Ident)}g) {
5216 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
5218 seed_camelcase_includes
();
5219 if (!$file && !$camelcase_file_seeded) {
5220 seed_camelcase_file
($realfile);
5221 $camelcase_file_seeded = 1;
5224 if (!defined $camelcase{$word}) {
5225 $camelcase{$word} = 1;
5227 "Avoid CamelCase: <$word>\n" . $herecurr);
5233 #no spaces allowed after \ in define
5234 if ($line =~ /\#\s*define.*\\\s+$/) {
5235 if (WARN
("WHITESPACE_AFTER_LINE_CONTINUATION",
5236 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
5238 $fixed[$fixlinenr] =~ s/\s+$//;
5242 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
5243 # itself <asm/foo.h> (uses RAW line)
5244 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
5246 my $checkfile = "include/linux/$file";
5247 if (-f
"$root/$checkfile" &&
5248 $realfile ne $checkfile &&
5249 $1 !~ /$allowed_asm_includes/)
5251 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
5252 if ($asminclude > 0) {
5253 if ($realfile =~ m{^arch/}) {
5254 CHK
("ARCH_INCLUDE_LINUX",
5255 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5257 WARN
("INCLUDE_LINUX",
5258 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5264 # multi-statement macros should be enclosed in a do while loop, grab the
5265 # first statement and ensure its the whole macro if its not enclosed
5266 # in a known good container
5267 if ($realfile !~ m@
/vmlinux
.lds
.h
$@
&&
5268 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
5271 my ($off, $dstat, $dcond, $rest);
5273 my $has_flow_statement = 0;
5274 my $has_arg_concat = 0;
5275 ($dstat, $dcond, $ln, $cnt, $off) =
5276 ctx_statement_block
($linenr, $realcnt, 0);
5278 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
5279 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
5281 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
5282 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
5284 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
5285 my $define_args = $1;
5286 my $define_stmt = $dstat;
5289 if (defined $define_args && $define_args ne "") {
5290 $define_args = substr($define_args, 1, length($define_args) - 2);
5291 $define_args =~ s/\s*//g;
5292 $define_args =~ s/\\\+?//g;
5293 @def_args = split(",", $define_args);
5297 $dstat =~ s/\\\n.//g;
5298 $dstat =~ s/^\s*//s;
5299 $dstat =~ s/\s*$//s;
5301 # Flatten any parentheses and braces
5302 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
5303 $dstat =~ s/\{[^\{\}]*\}/1/ ||
5304 $dstat =~ s/.\[[^\[\]]*\]/1/)
5308 # Flatten any obvious string concatenation.
5309 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
5310 $dstat =~ s/$Ident\s*($String)/$1/)
5314 # Make asm volatile uses seem like a generic function
5315 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
5317 my $exceptions = qr{
5330 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
5333 my $stmt_cnt = statement_rawlines
($ctx);
5334 my $herectx = get_stat_here
($linenr, $stmt_cnt, $here);
5337 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
5338 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
5339 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
5340 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
5341 $dstat !~ /$exceptions/ &&
5342 $dstat !~ /^\.$Ident\s*=/ && # .foo =
5343 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
5344 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
5345 $dstat !~ /^for\s*$Constant$/ && # for (...)
5346 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
5347 $dstat !~ /^do\s*{/ && # do {...
5348 $dstat !~ /^\(\{/ && # ({...
5349 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
5351 if ($dstat =~ /^\s*if\b/) {
5352 ERROR
("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5353 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5354 } elsif ($dstat =~ /;/) {
5355 ERROR
("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5356 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
5358 ERROR
("COMPLEX_MACRO",
5359 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
5364 # Make $define_stmt single line, comment-free, etc
5365 my @stmt_array = split('\n', $define_stmt);
5368 foreach my $l (@stmt_array) {
5373 } elsif ($l =~ /^[\+ ]/) {
5374 $define_stmt .= substr($l, 1);
5377 $define_stmt =~ s/$;//g;
5378 $define_stmt =~ s/\s+/ /g;
5379 $define_stmt = trim
($define_stmt);
5381 # check if any macro arguments are reused (ignore '...' and 'type')
5382 foreach my $arg (@def_args) {
5383 next if ($arg =~ /\.\.\./);
5384 next if ($arg =~ /^type$/i);
5385 my $tmp_stmt = $define_stmt;
5386 $tmp_stmt =~ s/\b(sizeof|typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
5387 $tmp_stmt =~ s/\#+\s*$arg\b//g;
5388 $tmp_stmt =~ s/\b$arg\s*\#\#//g;
5389 my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g;
5391 CHK
("MACRO_ARG_REUSE",
5392 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
5394 # check if any macro arguments may have other precedence issues
5395 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
5396 ((defined($1) && $1 ne ',') ||
5397 (defined($2) && $2 ne ','))) {
5398 CHK
("MACRO_ARG_PRECEDENCE",
5399 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
5403 # check for macros with flow control, but without ## concatenation
5404 # ## concatenation is commonly a macro that defines a function so ignore those
5405 if ($has_flow_statement && !$has_arg_concat) {
5406 my $cnt = statement_rawlines
($ctx);
5407 my $herectx = get_stat_here
($linenr, $cnt, $here);
5409 WARN
("MACRO_WITH_FLOW_CONTROL",
5410 "Macros with flow control statements should be avoided\n" . "$herectx");
5413 # check for line continuations outside of #defines, preprocessor #, and asm
5416 if ($prevline !~ /^..*\\$/ &&
5417 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
5418 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
5419 $line =~ /^\+.*\\$/) {
5420 WARN
("LINE_CONTINUATIONS",
5421 "Avoid unnecessary line continuations\n" . $herecurr);
5425 # do {} while (0) macro tests:
5426 # single-statement macros do not need to be enclosed in do while (0) loop,
5427 # macro should not end with a semicolon
5428 if ($perl_version_ok &&
5429 $realfile !~ m@
/vmlinux
.lds
.h
$@
&&
5430 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
5433 my ($off, $dstat, $dcond, $rest);
5435 ($dstat, $dcond, $ln, $cnt, $off) =
5436 ctx_statement_block
($linenr, $realcnt, 0);
5439 $dstat =~ s/\\\n.//g;
5442 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5447 my $cnt = statement_rawlines
($ctx);
5448 my $herectx = get_stat_here
($linenr, $cnt, $here);
5450 if (($stmts =~ tr/;/;/) == 1 &&
5451 $stmts !~ /^\s*(if|while|for|switch)\b/) {
5452 WARN
("SINGLE_STATEMENT_DO_WHILE_MACRO",
5453 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
5455 if (defined $semis && $semis ne "") {
5456 WARN
("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
5457 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
5459 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
5461 my $cnt = statement_rawlines
($ctx);
5462 my $herectx = get_stat_here
($linenr, $cnt, $here);
5464 WARN
("TRAILING_SEMICOLON",
5465 "macros should not use a trailing semicolon\n" . "$herectx");
5469 # check for redundant bracing round if etc
5470 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
5471 my ($level, $endln, @chunks) =
5472 ctx_statement_full
($linenr, $realcnt, 1);
5473 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
5474 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5475 if ($#chunks > 0 && $level == 0) {
5479 my $herectx = $here . "\n";
5480 my $ln = $linenr - 1;
5481 for my $chunk (@chunks) {
5482 my ($cond, $block) = @
{$chunk};
5484 # If the condition carries leading newlines, then count those as offsets.
5485 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5486 my $offset = statement_rawlines
($whitespace) - 1;
5488 $allowed[$allow] = 0;
5489 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5491 # We have looked at and allowed this specific line.
5492 $suppress_ifbraces{$ln + $offset} = 1;
5494 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
5495 $ln += statement_rawlines
($block) - 1;
5497 substr($block, 0, length($cond), '');
5499 $seen++ if ($block =~ /^\s*{/);
5501 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5502 if (statement_lines
($cond) > 1) {
5503 #print "APW: ALLOWED: cond<$cond>\n";
5504 $allowed[$allow] = 1;
5506 if ($block =~/\b(?:if|for|while)\b/) {
5507 #print "APW: ALLOWED: block<$block>\n";
5508 $allowed[$allow] = 1;
5510 if (statement_block_size
($block) > 1) {
5511 #print "APW: ALLOWED: lines block<$block>\n";
5512 $allowed[$allow] = 1;
5517 my $sum_allowed = 0;
5518 foreach (@allowed) {
5521 if ($sum_allowed == 0) {
5523 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5524 } elsif ($sum_allowed != $allow &&
5527 "braces {} should be used on all arms of this statement\n" . $herectx);
5532 if (!defined $suppress_ifbraces{$linenr - 1} &&
5533 $line =~ /\b(if|while|for|else)\b/) {
5536 # Check the pre-context.
5537 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5538 #print "APW: ALLOWED: pre<$1>\n";
5542 my ($level, $endln, @chunks) =
5543 ctx_statement_full
($linenr, $realcnt, $-[0]);
5545 # Check the condition.
5546 my ($cond, $block) = @
{$chunks[0]};
5547 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5548 if (defined $cond) {
5549 substr($block, 0, length($cond), '');
5551 if (statement_lines
($cond) > 1) {
5552 #print "APW: ALLOWED: cond<$cond>\n";
5555 if ($block =~/\b(?:if|for|while)\b/) {
5556 #print "APW: ALLOWED: block<$block>\n";
5559 if (statement_block_size
($block) > 1) {
5560 #print "APW: ALLOWED: lines block<$block>\n";
5563 # Check the post-context.
5564 if (defined $chunks[1]) {
5565 my ($cond, $block) = @
{$chunks[1]};
5566 if (defined $cond) {
5567 substr($block, 0, length($cond), '');
5569 if ($block =~ /^\s*\{/) {
5570 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5574 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
5575 my $cnt = statement_rawlines
($block);
5576 my $herectx = get_stat_here
($linenr, $cnt, $here);
5579 "braces {} are not necessary for single statement blocks\n" . $herectx);
5583 # check for single line unbalanced braces
5584 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
5585 $sline =~ /^.\s*else\s*\{\s*$/) {
5586 CHK
("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
5589 # check for unnecessary blank lines around braces
5590 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
5592 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5593 $fix && $prevrawline =~ /^\+/) {
5594 fix_delete_line
($fixlinenr - 1, $prevrawline);
5597 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
5599 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5601 fix_delete_line
($fixlinenr, $rawline);
5605 # no volatiles please
5606 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5607 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
5609 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
5612 # Check for user-visible strings broken across lines, which breaks the ability
5613 # to grep for the string. Make exceptions when the previous string ends in a
5614 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5615 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
5616 if ($line =~ /^\+\s*$String/ &&
5617 $prevline =~ /"\s*$/ &&
5618 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5619 if (WARN
("SPLIT_STRING",
5620 "quoted string split across lines\n" . $hereprev) &&
5622 $prevrawline =~ /^\+.*"\s*$/ &&
5623 $last_coalesced_string_linenr != $linenr - 1) {
5624 my $extracted_string = get_quoted_string
($line, $rawline);
5625 my $comma_close = "";
5626 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5630 fix_delete_line
($fixlinenr - 1, $prevrawline);
5631 fix_delete_line
($fixlinenr, $rawline);
5632 my $fixedline = $prevrawline;
5633 $fixedline =~ s/"\s*$//;
5634 $fixedline .= substr($extracted_string, 1) . trim
($comma_close);
5635 fix_insert_line
($fixlinenr - 1, $fixedline);
5636 $fixedline = $rawline;
5637 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5638 if ($fixedline !~ /\+\s*$/) {
5639 fix_insert_line
($fixlinenr, $fixedline);
5641 $last_coalesced_string_linenr = $linenr;
5645 # check for missing a space in a string concatenation
5646 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5647 WARN
('MISSING_SPACE',
5648 "break quoted strings at a space character\n" . $hereprev);
5651 # check for an embedded function name in a string when the function is known
5652 # This does not work very well for -f --file checking as it depends on patch
5653 # context providing the function name or a single line form for in-file
5654 # function declarations
5655 if ($line =~ /^\+.*$String/ &&
5656 defined($context_function) &&
5657 get_quoted_string
($line, $rawline) =~ /\b$context_function\b/ &&
5658 length(get_quoted_string
($line, $rawline)) != (length($context_function) + 2)) {
5659 WARN
("EMBEDDED_FUNCTION_NAME",
5660 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
5663 # check for spaces before a quoted newline
5664 if ($rawline =~ /^.*\".*\s\\n/) {
5665 if (WARN
("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5666 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5668 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5673 # concatenated string without spaces between elements
5674 if ($line =~ /$String[A-Za-z0-9_]/ || $line =~ /[A-Za-z0-9_]$String/) {
5675 if (CHK
("CONCATENATED_STRING",
5676 "Concatenated strings should use spaces between elements\n" . $herecurr) &&
5678 while ($line =~ /($String)/g) {
5679 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5680 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/;
5681 $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/;
5686 # uncoalesced string fragments
5687 if ($line =~ /$String\s*"/) {
5688 if (WARN
("STRING_FRAGMENTS",
5689 "Consecutive strings are generally better as a single string\n" . $herecurr) &&
5691 while ($line =~ /($String)(?=\s*")/g) {
5692 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5693 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e;
5698 # check for non-standard and hex prefixed decimal printf formats
5699 my $show_L = 1; #don't show the same defect twice
5701 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
5702 my $string = substr($rawline, $-[1], $+[1] - $-[1]);
5703 $string =~ s/%%/__/g;
5705 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
5707 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
5711 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
5713 "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
5716 # check for 0x<decimal>
5717 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
5718 ERROR
("PRINTF_0XDECIMAL",
5719 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5723 # check for line continuations in quoted strings with odd counts of "
5724 if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
5725 WARN
("LINE_CONTINUATIONS",
5726 "Avoid line continuations in quoted strings\n" . $herecurr);
5730 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
5732 "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr);
5736 if ($line =~ /^.\s*\#\s*if\s+1\b/) {
5738 "Consider removing the #if 1 and its #endif\n" . $herecurr);
5741 # check for needless "if (<foo>) fn(<foo>)" uses
5742 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
5743 my $tested = quotemeta($1);
5744 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5745 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5747 if (WARN
('NEEDLESS_IF',
5748 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5751 my $leading_tabs = "";
5752 my $new_leading_tabs = "";
5753 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5758 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5759 $new_leading_tabs = $1;
5760 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5767 fix_delete_line
($fixlinenr - 1, $prevrawline);
5768 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5774 # check for unnecessary "Out of Memory" messages
5775 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5776 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5777 (defined $1 || defined $3) &&
5780 my $testline = $lines[$linenr - 3];
5782 my ($s, $c) = ctx_statement_block
($linenr - 3, $realcnt, 0);
5783 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5785 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ &&
5786 $s !~ /\b__GFP_NOWARN\b/ ) {
5788 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5792 # check for logging functions with KERN_<LEVEL>
5793 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
5794 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5796 if (WARN
("UNNECESSARY_KERN_LEVEL",
5797 "Possible unnecessary $level\n" . $herecurr) &&
5799 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5803 # check for logging continuations
5804 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
5805 WARN
("LOGGING_CONTINUATION",
5806 "Avoid logging continuation uses where feasible\n" . $herecurr);
5809 # check for mask then right shift without a parentheses
5810 if ($perl_version_ok &&
5811 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5812 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5813 WARN
("MASK_THEN_SHIFT",
5814 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5817 # check for pointer comparisons to NULL
5818 if ($perl_version_ok) {
5819 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5822 $equal = "" if ($4 eq "!=");
5823 if (CHK
("COMPARISON_TO_NULL",
5824 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5826 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5831 # check for bad placement of section $InitAttribute (e.g.: __initdata)
5832 if ($line =~ /(\b$InitAttribute\b)/) {
5834 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5837 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5838 ERROR
("MISPLACED_INIT",
5839 "$attr should be placed after $var\n" . $herecurr)) ||
5840 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5841 WARN
("MISPLACED_INIT",
5842 "$attr should be placed after $var\n" . $herecurr))) &&
5844 $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;
5849 # check for $InitAttributeData (ie: __initdata) with const
5850 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5852 $attr =~ /($InitAttributePrefix)(.*)/;
5853 my $attr_prefix = $1;
5855 if (ERROR
("INIT_ATTRIBUTE",
5856 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5858 $fixed[$fixlinenr] =~
5859 s/$InitAttributeData/${attr_prefix}initconst/;
5863 # check for $InitAttributeConst (ie: __initconst) without const
5864 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5866 if (ERROR
("INIT_ATTRIBUTE",
5867 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5869 my $lead = $fixed[$fixlinenr] =~
5870 /(^\+\s*(?:static\s+))/;
5872 $lead = "$lead " if ($lead !~ /^\+$/);
5873 $lead = "${lead}const ";
5874 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
5878 # check for __read_mostly with const non-pointer (should just be const)
5879 if ($line =~ /\b__read_mostly\b/ &&
5880 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5881 if (ERROR
("CONST_READ_MOSTLY",
5882 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5884 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5888 # don't use __constant_<foo> functions outside of include/uapi/
5889 if ($realfile !~ m@
^include
/uapi/@
&&
5890 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5891 my $constant_func = $1;
5892 my $func = $constant_func;
5893 $func =~ s/^__constant_//;
5894 if (WARN
("CONSTANT_CONVERSION",
5895 "$constant_func should be $func\n" . $herecurr) &&
5897 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
5901 # prefer usleep_range over udelay
5902 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
5904 # ignore udelay's < 10, however
5905 if (! ($delay < 10) ) {
5907 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr);
5909 if ($delay > 2000) {
5911 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
5915 # warn about unexpectedly long msleep's
5916 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5919 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr);
5923 # check for comparisons of jiffies
5924 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5925 WARN
("JIFFIES_COMPARISON",
5926 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5929 # check for comparisons of get_jiffies_64()
5930 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5931 WARN
("JIFFIES_COMPARISON",
5932 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5935 # warn about #ifdefs in C files
5936 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5937 # print "#ifdef in C files should be avoided\n";
5938 # print "$herecurr";
5942 # warn about spacing in #ifdefs
5943 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
5944 if (ERROR
("SPACING",
5945 "exactly one space required after that #$1\n" . $herecurr) &&
5947 $fixed[$fixlinenr] =~
5948 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5953 # check for spinlock_t definitions without a comment.
5954 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5955 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
5957 if (!ctx_has_comment
($first_line, $linenr)) {
5958 CHK
("UNCOMMENTED_DEFINITION",
5959 "$1 definition without comment\n" . $herecurr);
5962 # check for memory barriers without a comment.
5968 read_barrier_depends
5970 my $barrier_stems = qr{
5978 my $all_barriers = qr{
5980 smp_
(?
:$barrier_stems)|
5981 virt_
(?
:$barrier_stems)
5984 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
5985 if (!ctx_has_comment
($first_line, $linenr)) {
5986 WARN
("MEMORY_BARRIER",
5987 "memory barrier without comment\n" . $herecurr);
5991 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5993 if ($realfile !~ m@
^include
/asm-generic/@
&&
5994 $realfile !~ m@
/barrier\
.h
$@
&&
5995 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5996 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5997 WARN
("MEMORY_BARRIER",
5998 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
6001 # check for waitqueue_active without a comment.
6002 if ($line =~ /\bwaitqueue_active\s*\(/) {
6003 if (!ctx_has_comment
($first_line, $linenr)) {
6004 WARN
("WAITQUEUE_ACTIVE",
6005 "waitqueue_active without comment\n" . $herecurr);
6009 # check for smp_read_barrier_depends and read_barrier_depends
6010 if (!$file && $line =~ /\b(smp_|)read_barrier_depends\s*\(/) {
6011 WARN
("READ_BARRIER_DEPENDS",
6012 "$1read_barrier_depends should only be used in READ_ONCE or DEC Alpha code\n" . $herecurr);
6015 # check of hardware specific defines
6016 if ($line =~ m@
^.\s
*\#\s
*if.*\b(__i386__
|__powerpc64__
|__sun__
|__s390x__
)\b@
&& $realfile !~ m
@include/asm
-@
) {
6018 "architecture specific defines should be avoided\n" . $herecurr);
6021 # check that the storage class is not after a type
6022 if ($line =~ /\b($Type)\s+($Storage)\b/) {
6023 WARN
("STORAGE_CLASS",
6024 "storage class '$2' should be located before type '$1'\n" . $herecurr);
6026 # Check that the storage class is at the beginning of a declaration
6027 if ($line =~ /\b$Storage\b/ &&
6028 $line !~ /^.\s*$Storage/ &&
6029 $line =~ /^.\s*(.+?)\$Storage\s/ &&
6030 $1 !~ /[\,\)]\s*$/) {
6031 WARN
("STORAGE_CLASS",
6032 "storage class should be at the beginning of the declaration\n" . $herecurr);
6035 # check the location of the inline attribute, that it is between
6036 # storage class and type.
6037 if ($line =~ /\b$Type\s+$Inline\b/ ||
6038 $line =~ /\b$Inline\s+$Storage\b/) {
6039 ERROR
("INLINE_LOCATION",
6040 "inline keyword should sit between storage class and type\n" . $herecurr);
6043 # Check for __inline__ and __inline, prefer inline
6044 if ($realfile !~ m@
\binclude
/uapi/@
&&
6045 $line =~ /\b(__inline__|__inline)\b/) {
6047 "plain inline is preferred over $1\n" . $herecurr) &&
6049 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
6054 # Check for __attribute__ packed, prefer __packed
6055 if ($realfile !~ m@
\binclude
/uapi/@
&&
6056 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
6057 WARN
("PREFER_PACKED",
6058 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
6061 # Check for __attribute__ aligned, prefer __aligned
6062 if ($realfile !~ m@
\binclude
/uapi/@
&&
6063 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
6064 WARN
("PREFER_ALIGNED",
6065 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
6068 # Check for __attribute__ section, prefer __section
6069 if ($realfile !~ m@
\binclude
/uapi/@
&&
6070 $line =~ /\b__attribute__\s*\(\s*\(.*_*section_*\s*\(\s*("[^"]*")/) {
6071 my $old = substr($rawline, $-[1], $+[1] - $-[1]);
6072 my $new = substr($old, 1, -1);
6073 if (WARN
("PREFER_SECTION",
6074 "__section($new) is preferred over __attribute__((section($old)))\n" . $herecurr) &&
6076 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*_*section_*\s*\(\s*\Q$old\E\s*\)\s*\)\s*\)/__section($new)/;
6080 # Check for __attribute__ format(printf, prefer __printf
6081 if ($realfile !~ m@
\binclude
/uapi/@
&&
6082 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
6083 if (WARN
("PREFER_PRINTF",
6084 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
6086 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
6091 # Check for __attribute__ format(scanf, prefer __scanf
6092 if ($realfile !~ m@
\binclude
/uapi/@
&&
6093 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
6094 if (WARN
("PREFER_SCANF",
6095 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
6097 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
6101 # Check for __attribute__ weak, or __weak declarations (may have link issues)
6102 if ($perl_version_ok &&
6103 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
6104 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
6105 $line =~ /\b__weak\b/)) {
6106 ERROR
("WEAK_DECLARATION",
6107 "Using weak declarations can have unintended link defects\n" . $herecurr);
6110 # check for c99 types like uint8_t used outside of uapi/ and tools/
6111 if ($realfile !~ m@
\binclude
/uapi/@
&&
6112 $realfile !~ m@
\btools
/@
&&
6113 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
6115 if ($type =~ /\b($typeC99Typedefs)\b/) {
6117 my $kernel_type = 'u';
6118 $kernel_type = 's' if ($type =~ /^_*[si]/);
6121 if (CHK
("PREFER_KERNEL_TYPES",
6122 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
6124 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
6129 # check for cast of C90 native int or longer types constants
6130 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
6133 if (WARN
("TYPECAST_INT_CONSTANT",
6134 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
6137 my $newconst = $const;
6138 $newconst =~ s/${Int_type}$//;
6139 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
6140 if ($cast =~ /\blong\s+long\b/) {
6142 } elsif ($cast =~ /\blong\b/) {
6145 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
6149 # check for sizeof(&)
6150 if ($line =~ /\bsizeof\s*\(\s*\&/) {
6151 WARN
("SIZEOF_ADDRESS",
6152 "sizeof(& should be avoided\n" . $herecurr);
6155 # check for sizeof without parenthesis
6156 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
6157 if (WARN
("SIZEOF_PARENTHESIS",
6158 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
6160 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
6164 # check for struct spinlock declarations
6165 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
6166 WARN
("USE_SPINLOCK_T",
6167 "struct spinlock should be spinlock_t\n" . $herecurr);
6170 # check for seq_printf uses that could be seq_puts
6171 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
6172 my $fmt = get_quoted_string
($line, $rawline);
6175 if (WARN
("PREFER_SEQ_PUTS",
6176 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
6178 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
6183 # check for vsprintf extension %p<foo> misuses
6184 if ($perl_version_ok &&
6186 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
6187 $1 !~ /^_*volatile_*$/) {
6190 my $lc = $stat =~ tr@
\n@@
;
6191 $lc = $lc + $linenr;
6192 for (my $count = $linenr; $count <= $lc; $count++) {
6196 my $bad_specifier = "";
6197 my $fmt = get_quoted_string
($lines[$count - 1], raw_line
($count, 0));
6200 while ($fmt =~ /(\%[\*\d\.]*p(\w)(\w*))/g) {
6204 if ($extension !~ /[SsBKRraEehMmIiUDdgVCbGNOxtf]/ ||
6205 ($extension eq "f" &&
6206 defined $qualifier && $qualifier !~ /^w/)) {
6207 $bad_specifier = $specifier;
6210 if ($extension eq "x" && !defined($stat_real)) {
6211 if (!defined($stat_real)) {
6212 $stat_real = get_stat_real
($linenr, $lc);
6214 WARN
("VSPRINTF_SPECIFIER_PX",
6215 "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");
6218 if ($bad_specifier ne "") {
6219 my $stat_real = get_stat_real
($linenr, $lc);
6220 my $ext_type = "Invalid";
6222 if ($bad_specifier =~ /p[Ff]/) {
6223 $use = " - use %pS instead";
6224 $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/);
6227 WARN
("VSPRINTF_POINTER_EXTENSION",
6228 "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n");
6233 # Check for misused memsets
6234 if ($perl_version_ok &&
6236 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
6242 if ($ms_size =~ /^(0x|)0$/i) {
6244 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
6245 } elsif ($ms_size =~ /^(0x|)1$/i) {
6247 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
6251 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
6252 # if ($perl_version_ok &&
6254 # $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6255 # if (WARN("PREFER_ETHER_ADDR_COPY",
6256 # "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
6258 # $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
6262 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
6263 # if ($perl_version_ok &&
6265 # $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6266 # WARN("PREFER_ETHER_ADDR_EQUAL",
6267 # "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
6270 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
6271 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
6272 # if ($perl_version_ok &&
6274 # $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6278 # if ($ms_val =~ /^(?:0x|)0+$/i) {
6279 # if (WARN("PREFER_ETH_ZERO_ADDR",
6280 # "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6282 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
6284 # } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
6285 # if (WARN("PREFER_ETH_BROADCAST_ADDR",
6286 # "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
6288 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
6293 # typecasts on min/max could be min_t/max_t
6294 if ($perl_version_ok &&
6296 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
6297 if (defined $2 || defined $7) {
6299 my $cast1 = deparenthesize
($2);
6301 my $cast2 = deparenthesize
($7);
6305 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
6306 $cast = "$cast1 or $cast2";
6307 } elsif ($cast1 ne "") {
6313 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
6317 # check usleep_range arguments
6318 if ($perl_version_ok &&
6320 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
6324 WARN
("USLEEP_RANGE",
6325 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
6326 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
6328 WARN
("USLEEP_RANGE",
6329 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
6333 # check for naked sscanf
6334 if ($perl_version_ok &&
6336 $line =~ /\bsscanf\b/ &&
6337 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
6338 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
6339 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
6340 my $lc = $stat =~ tr@
\n@@
;
6341 $lc = $lc + $linenr;
6342 my $stat_real = get_stat_real
($linenr, $lc);
6343 WARN
("NAKED_SSCANF",
6344 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
6347 # check for simple sscanf that should be kstrto<foo>
6348 if ($perl_version_ok &&
6350 $line =~ /\bsscanf\b/) {
6351 my $lc = $stat =~ tr@
\n@@
;
6352 $lc = $lc + $linenr;
6353 my $stat_real = get_stat_real
($linenr, $lc);
6354 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
6356 my $count = $format =~ tr@
%@
%@
;
6358 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
6359 WARN
("SSCANF_TO_KSTRTO",
6360 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
6365 # check for new externs in .h files.
6366 if ($realfile =~ /\.h$/ &&
6367 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
6368 if (CHK
("AVOID_EXTERNS",
6369 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
6371 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
6375 # check for new externs in .c files.
6376 if ($realfile =~ /\.c$/ && defined $stat &&
6377 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
6379 my $function_name = $1;
6380 my $paren_space = $2;
6383 if (defined $cond) {
6384 substr($s, 0, length($cond), '');
6386 if ($s =~ /^\s*;/ &&
6387 $function_name ne 'uninitialized_var')
6389 WARN
("AVOID_EXTERNS",
6390 "externs should be avoided in .c files\n" . $herecurr);
6393 if ($paren_space =~ /\n/) {
6394 WARN
("FUNCTION_ARGUMENTS",
6395 "arguments for function declarations should follow identifier\n" . $herecurr);
6398 } elsif ($realfile =~ /\.c$/ && defined $stat &&
6399 $stat =~ /^.\s*extern\s+/)
6401 WARN
("AVOID_EXTERNS",
6402 "externs should be avoided in .c files\n" . $herecurr);
6405 # check for function declarations that have arguments without identifier names
6406 # while avoiding uninitialized_var(x)
6407 if (defined $stat &&
6408 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:($Ident)|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
6410 (defined($1) && $1 ne "uninitialized_var")) &&
6412 my $args = trim
($2);
6413 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
6415 if ($arg =~ /^$Type$/ &&
6416 $arg !~ /enum\s+$Ident$/) {
6417 WARN
("FUNCTION_ARGUMENTS",
6418 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
6423 # check for function definitions
6424 if ($perl_version_ok &&
6426 $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
6427 $context_function = $1;
6429 # check for multiline function definition with misplaced open brace
6431 my $cnt = statement_rawlines
($stat);
6432 my $herectx = $here . "\n";
6433 for (my $n = 0; $n < $cnt; $n++) {
6434 my $rl = raw_line
($linenr, $n);
6435 $herectx .= $rl . "\n";
6436 $ok = 1 if ($rl =~ /^[ \+]\{/);
6437 $ok = 1 if ($rl =~ /\{/ && $n == 0);
6438 last if $rl =~ /^[ \+].*\{/;
6442 "open brace '{' following function definitions go on the next line\n" . $herectx);
6446 # checks for new __setup's
6447 if ($rawline =~ /\b__setup\("([^"]*)"/) {
6450 if (!grep(/$name/, @setup_docs)) {
6451 CHK
("UNDOCUMENTED_SETUP",
6452 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
6456 # check for pointless casting of alloc functions
6457 if ($line =~ /\*\s*\)\s*$allocFunctions\b/) {
6458 WARN
("UNNECESSARY_CASTS",
6459 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
6463 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6464 if ($perl_version_ok &&
6465 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6466 CHK
("ALLOC_SIZEOF_STRUCT",
6467 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
6470 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6471 if ($perl_version_ok &&
6473 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
6477 my $newfunc = "kmalloc_array";
6478 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
6481 if ($a1 =~ /^sizeof\s*\S/) {
6485 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
6486 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
6487 my $cnt = statement_rawlines
($stat);
6488 my $herectx = get_stat_here
($linenr, $cnt, $here);
6490 if (WARN
("ALLOC_WITH_MULTIPLY",
6491 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
6494 $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;
6499 # check for krealloc arg reuse
6500 if ($perl_version_ok &&
6501 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ &&
6503 WARN
("KREALLOC_ARG_REUSE",
6504 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
6507 # check for alloc argument mismatch
6508 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
6509 WARN
("ALLOC_ARRAY_ARGS",
6510 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
6513 # check for multiple semicolons
6514 if ($line =~ /;\s*;\s*$/) {
6515 if (WARN
("ONE_SEMICOLON",
6516 "Statements terminations use 1 semicolon\n" . $herecurr) &&
6518 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
6522 # check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6523 if ($realfile !~ m@
^include
/uapi/@
&&
6524 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
6526 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
6527 if (CHK
("BIT_MACRO",
6528 "Prefer using the BIT$ull macro\n" . $herecurr) &&
6530 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
6534 # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6535 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6537 if (WARN
("PREFER_IS_ENABLED",
6538 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
6540 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
6544 # check for case / default statements not preceded by break/fallthrough/switch
6545 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
6547 my $has_statement = 0;
6549 my $prevline = $linenr;
6550 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
6552 my $rline = $rawlines[$prevline - 1];
6553 my $fline = $lines[$prevline - 1];
6554 last if ($fline =~ /^\@\@/);
6555 next if ($fline =~ /^\-/);
6556 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
6557 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
6558 next if ($fline =~ /^.[\s$;]*$/);
6561 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/);
6563 if (!$has_break && $has_statement) {
6564 WARN
("MISSING_BREAK",
6565 "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr);
6569 # check for /* fallthrough */ like comment, prefer fallthrough;
6570 my @fallthroughs = (
6573 'lint -fallthrough[ \t]*',
6574 'intentional(?:ly)?[ \t]*fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)',
6575 '(?:else,?\s*)?FALL(?:S | |-)?THR(?:OUGH|U|EW)[ \t.!]*(?:-[^\n\r]*)?',
6576 'Fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?',
6577 'fall(?:s | |-)?thr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?',
6579 if ($raw_comment ne '') {
6580 foreach my $ft (@fallthroughs) {
6581 if ($raw_comment =~ /$ft/) {
6582 my $msg_level = \
&WARN
;
6583 $msg_level = \
&CHK
if ($file);
6584 &{$msg_level}("PREFER_FALLTHROUGH",
6585 "Prefer 'fallthrough;' over fallthrough comment\n" . $herecurr);
6591 # check for switch/default statements without a break;
6592 if ($perl_version_ok &&
6594 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
6595 my $cnt = statement_rawlines
($stat);
6596 my $herectx = get_stat_here
($linenr, $cnt, $here);
6598 WARN
("DEFAULT_NO_BREAK",
6599 "switch default: should use break\n" . $herectx);
6602 # check for gcc specific __FUNCTION__
6603 if ($line =~ /\b__FUNCTION__\b/) {
6604 if (WARN
("USE_FUNC",
6605 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
6607 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
6611 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
6612 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
6614 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
6617 # check for use of yield()
6618 if ($line =~ /\byield\s*\(\s*\)/) {
6620 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
6623 # check for comparisons against true and false
6624 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6632 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6634 my $type = lc($otype);
6635 if ($type =~ /^(?:true|false)$/) {
6636 if (("$test" eq "==" && "$type" eq "true") ||
6637 ("$test" eq "!=" && "$type" eq "false")) {
6641 CHK
("BOOL_COMPARISON",
6642 "Using comparison to $otype is error prone\n" . $herecurr);
6644 ## maybe suggesting a correct construct would better
6645 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6650 # check for semaphores initialized locked
6651 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
6652 WARN
("CONSIDER_COMPLETION",
6653 "consider using a completion\n" . $herecurr);
6656 # recommend kstrto* over simple_strto* and strict_strto*
6657 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
6658 WARN
("CONSIDER_KSTRTO",
6659 "$1 is obsolete, use k$3 instead\n" . $herecurr);
6662 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
6663 if ($line =~ /^.\s*__initcall\s*\(/) {
6664 WARN
("USE_DEVICE_INITCALL",
6665 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
6668 # check for spin_is_locked(), suggest lockdep instead
6669 if ($line =~ /\bspin_is_locked\(/) {
6671 "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr);
6674 # check for deprecated apis
6675 if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) {
6676 my $deprecated_api = $1;
6677 my $new_api = $deprecated_apis{$deprecated_api};
6678 WARN
("DEPRECATED_API",
6679 "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr);
6682 # check for various structs that are normally const (ops, kgdb, device_tree)
6683 # and avoid what seem like struct definitions 'struct foo {'
6684 if ($line !~ /\bconst\b/ &&
6685 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
6686 WARN
("CONST_STRUCT",
6687 "struct $1 should normally be const\n" . $herecurr);
6690 # use of NR_CPUS is usually wrong
6691 # ignore definitions of NR_CPUS and usage to define arrays as likely right
6692 if ($line =~ /\bNR_CPUS\b/ &&
6693 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6694 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
6695 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6696 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6697 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
6700 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
6703 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6704 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6705 ERROR
("DEFINE_ARCH_HAS",
6706 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6709 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
6710 if ($perl_version_ok &&
6711 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6712 WARN
("LIKELY_MISUSE",
6713 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6716 # nested likely/unlikely calls
6717 if ($line =~ /\b(?:(?:un)?likely)\s*\(\s*!?\s*(IS_ERR(?:_OR_NULL|_VALUE)?|WARN)/) {
6718 WARN
("LIKELY_MISUSE",
6719 "nested (un)?likely() calls, $1 already uses unlikely() internally\n" . $herecurr);
6722 # whine mightly about in_atomic
6723 if ($line =~ /\bin_atomic\s*\(/) {
6724 if ($realfile =~ m@
^drivers
/@
) {
6726 "do not use in_atomic in drivers\n" . $herecurr);
6727 } elsif ($realfile !~ m@
^kernel
/@
) {
6729 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
6733 # check for mutex_trylock_recursive usage
6734 if ($line =~ /mutex_trylock_recursive/) {
6736 "recursive locking is bad, do not use this ever.\n" . $herecurr);
6739 # check for lockdep_set_novalidate_class
6740 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6741 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6742 if ($realfile !~ m@
^kernel
/lockdep@
&&
6743 $realfile !~ m@
^include
/linux/lockdep@
&&
6744 $realfile !~ m@
^drivers
/base/core@
) {
6746 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
6750 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6751 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
6752 WARN
("EXPORTED_WORLD_WRITABLE",
6753 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6756 # check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6757 # and whether or not function naming is typical and if
6758 # DEVICE_ATTR permissions uses are unusual too
6759 if ($perl_version_ok &&
6761 $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*\)/) {
6766 my $octal_perms = perms_to_octal
($perms);
6767 if ($show =~ /^${var}_show$/ &&
6768 $store =~ /^${var}_store$/ &&
6769 $octal_perms eq "0644") {
6770 if (WARN
("DEVICE_ATTR_RW",
6771 "Use DEVICE_ATTR_RW\n" . $herecurr) &&
6773 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6775 } elsif ($show =~ /^${var}_show$/ &&
6776 $store =~ /^NULL$/ &&
6777 $octal_perms eq "0444") {
6778 if (WARN
("DEVICE_ATTR_RO",
6779 "Use DEVICE_ATTR_RO\n" . $herecurr) &&
6781 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6783 } elsif ($show =~ /^NULL$/ &&
6784 $store =~ /^${var}_store$/ &&
6785 $octal_perms eq "0200") {
6786 if (WARN
("DEVICE_ATTR_WO",
6787 "Use DEVICE_ATTR_WO\n" . $herecurr) &&
6789 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6791 } elsif ($octal_perms eq "0644" ||
6792 $octal_perms eq "0444" ||
6793 $octal_perms eq "0200") {
6794 my $newshow = "$show";
6795 $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show");
6796 my $newstore = $store;
6797 $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store");
6799 if ($show ne $newshow) {
6800 $rename .= " '$show' to '$newshow'";
6802 if ($store ne $newstore) {
6803 $rename .= " '$store' to '$newstore'";
6805 WARN
("DEVICE_ATTR_FUNCTIONS",
6806 "Consider renaming function(s)$rename\n" . $herecurr);
6808 WARN
("DEVICE_ATTR_PERMS",
6809 "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr);
6813 # Mode permission misuses where it seems decimal should be octal
6814 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6815 # o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6816 # specific definition of not visible in sysfs.
6817 # o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6818 # use the default permissions
6819 if ($perl_version_ok &&
6821 $line =~ /$mode_perms_search/) {
6822 foreach my $entry (@mode_permission_funcs) {
6823 my $func = $entry->[0];
6824 my $arg_pos = $entry->[1];
6826 my $lc = $stat =~ tr@
\n@@
;
6827 $lc = $lc + $linenr;
6828 my $stat_real = get_stat_real
($linenr, $lc);
6833 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6835 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
6836 if ($stat =~ /$test/) {
6838 $val = $6 if ($skip_args ne "");
6839 if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
6840 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6841 ($val =~ /^$Octal$/ && length($val) ne 4))) {
6842 ERROR
("NON_OCTAL_PERMISSIONS",
6843 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
6845 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
6846 ERROR
("EXPORTED_WORLD_WRITABLE",
6847 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
6853 # check for uses of S_<PERMS> that could be octal for readability
6854 while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) {
6856 my $octal = perms_to_octal
($oval);
6857 if (WARN
("SYMBOLIC_PERMS",
6858 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6860 $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
6864 # validate content of MODULE_LICENSE against list from include/linux/module.h
6865 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6866 my $extracted_string = get_quoted_string
($line, $rawline);
6867 my $valid_licenses = qr{
6870 GPL\
and\ additional\ rights
|
6876 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6877 WARN
("MODULE_LICENSE",
6878 "unknown module license " . $extracted_string . "\n" . $herecurr);
6882 # check for sysctl duplicate constants
6883 if ($line =~ /\.extra[12]\s*=\s*&(zero|one|int_max)\b/) {
6884 WARN
("DUPLICATED_SYSCTL_CONST",
6885 "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr);
6889 # If we have no input at all, then there is nothing to report on
6890 # so just keep quiet.
6891 if ($#rawlines == -1) {
6895 # In mailback mode only produce a report in the negative, for
6896 # things that appear to be patches.
6897 if ($mailback && ($clean == 1 || !$is_patch)) {
6901 # This is not a patch, and we are are in 'no-patch' mode so
6903 if (!$chk_patch && !$is_patch) {
6907 if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
6908 ERROR
("NOT_UNIFIED_DIFF",
6909 "Does not appear to be a unified-diff format patch\n");
6911 if ($is_patch && $has_commit_log && $chk_signoff) {
6912 if ($signoff == 0) {
6913 ERROR
("MISSING_SIGN_OFF",
6914 "Missing Signed-off-by: line(s)\n");
6915 } elsif (!$authorsignoff) {
6916 WARN
("NO_AUTHOR_SIGN_OFF",
6917 "Missing Signed-off-by: line by nominal patch author '$author'\n");
6921 print report_dump
();
6922 if ($summary && !($clean == 1 && $quiet == 1)) {
6923 print "$filename " if ($summary_file);
6924 print "total: $cnt_error errors, $cnt_warn warnings, " .
6925 (($check)?
"$cnt_chk checks, " : "") .
6926 "$cnt_lines lines checked\n";
6930 # If there were any defects found and not already fixing them
6931 if (!$clean and !$fix) {
6934 NOTE
: For some of the reported defects
, checkpatch may be able to
6935 mechanically convert to the typical style using
--fix
or --fix
-inplace
.
6938 # If there were whitespace errors which cleanpatch can fix
6939 # then suggest that.
6940 if ($rpt_cleaners) {
6944 NOTE
: Whitespace errors detected
.
6945 You may wish to
use scripts
/cleanpatch or scripts/cleanfile
6950 if ($clean == 0 && $fix &&
6951 ("@rawlines" ne "@fixed" ||
6952 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
6953 my $newfile = $filename;
6954 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
6958 @fixed = fix_inserted_deleted_lines
(\
@fixed, \
@fixed_inserted, \
@fixed_deleted);
6960 open($f, '>', $newfile)
6961 or die "$P: Can't open $newfile for write\n";
6962 foreach my $fixed_line (@fixed) {
6965 if ($linecount > 3) {
6966 $fixed_line =~ s/^\+//;
6967 print $f $fixed_line . "\n";
6970 print $f $fixed_line . "\n";
6978 Wrote EXPERIMENTAL
--fix correction
(s
) to
'$newfile'
6980 Do _NOT_ trust the results written to this file
.
6981 Do _NOT_ submit these changes without inspecting them
for correctness
.
6983 This EXPERIMENTAL file is simply a convenience to help rewrite patches
.
6984 No warranties
, expressed
or implied
...
6992 print "$vname has no obvious style problems and is ready for submission.\n";
6994 print "$vname has style problems, please review.\n";