2 # (c) 2001, Dave Jones. (the file handling bit)
3 # (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
4 # (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
5 # (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
6 # Licensed under the terms of the GNU GPL License version 2
12 use Term
::ANSIColor
qw(:constants);
15 my $D = dirname
(abs_path
($P));
19 use Getopt
::Long
qw(:config no_auto_abbrev);
47 my $configuration_file = ".checkpatch.conf";
48 my $max_line_length = 80;
49 my $ignore_perl_version = 0;
50 my $minimum_perl_version = 5.10.0;
51 my $min_conf_desc_length = 4;
52 my $spelling_file = "$D/spelling.txt";
54 my $codespellfile = "/usr/share/codespell/dictionary.txt";
61 Usage
: $P [OPTION
]... [FILE
]...
66 --no-tree run without a kernel tree
67 --no-signoff
do not check
for 'Signed-off-by' line
68 --patch treat FILE as patchfile
(default)
69 --emacs emacs compile window format
70 --terse one line per report
71 --showfile emit diffed file position
, not input file position
72 -f
, --file treat FILE as regular source file
73 --subjective
, --strict enable more subjective tests
74 --list-types list the possible message types
75 --types TYPE
(,TYPE2
...) show only these comma separated message types
76 --ignore TYPE
(,TYPE2
...) ignore various comma separated message types
77 --show-types show the specific message type
in the output
78 --max-line-length
=n set the maximum line
length, if exceeded
, warn
79 --min-conf-desc-length
=n set the min description
length, if shorter
, warn
80 --root
=PATH PATH to the kernel tree root
81 --no-summary suppress the per-file summary
82 --mailback only produce a report
in case of warnings
/errors
83 --summary-file include the filename
in summary
84 --debug KEY
=[0|1] turn on
/off debugging of KEY
, where KEY
is one of
85 'values', 'possible', 'type', and 'attr' (default
87 --test-only
=WORD report only warnings
/errors containing WORD
89 --fix EXPERIMENTAL
- may create horrible results
90 If correctable single-line errors exist
, create
91 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
92 with potential errors corrected to the preferred
94 --fix-inplace EXPERIMENTAL
- may create horrible results
95 Is the same as
--fix
, but overwrites the input
96 file
. It
's your fault if there's
no backup
or git
97 --ignore-perl-version override checking of perl version
. expect
99 --codespell Use the codespell dictionary
for spelling
/typos
100 (default:/usr/share
/codespell/dictionary
.txt
)
101 --codespellfile Use this codespell dictionary
102 --color Use colors
when output
is STDOUT
(default: on
)
103 -h
, --help
, --version display this help
and exit
105 When FILE
is - read standard input
.
113 return grep { !$seen{$_}++ } @_;
123 open(my $script, '<', abs_path
($P)) or
124 die "$P: Can't read '$P' $!\n";
126 my $text = <$script>;
130 for ($text =~ /\b(?:(?:CHK|WARN|ERROR)\s*\(\s*"([^"]+)")/g) {
133 @types = sort(uniq
(@types));
134 print("#\tMessage type\n\n");
135 foreach my $type (@types) {
136 print(++$count . "\t" . $type . "\n");
142 my $conf = which_conf
($configuration_file);
145 open(my $conffile, '<', "$conf")
146 or warn "$P: Can't find a readable $configuration_file file $!\n";
148 while (<$conffile>) {
151 $line =~ s/\s*\n?$//g;
155 next if ($line =~ m/^\s*#/);
156 next if ($line =~ m/^\s*$/);
158 my @words = split(" ", $line);
159 foreach my $word (@words) {
160 last if ($word =~ m/^#/);
161 push (@conf_args, $word);
165 unshift(@ARGV, @conf_args) if @conf_args;
169 'q|quiet+' => \
$quiet,
171 'signoff!' => \
$chk_signoff,
172 'patch!' => \
$chk_patch,
175 'showfile!' => \
$showfile,
177 'subjective!' => \
$check,
178 'strict!' => \
$check,
179 'ignore=s' => \
@ignore,
181 'show-types!' => \
$show_types,
182 'list-types!' => \
$list_types,
183 'max-line-length=i' => \
$max_line_length,
184 'min-conf-desc-length=i' => \
$min_conf_desc_length,
186 'summary!' => \
$summary,
187 'mailback!' => \
$mailback,
188 'summary-file!' => \
$summary_file,
190 'fix-inplace!' => \
$fix_inplace,
191 'ignore-perl-version!' => \
$ignore_perl_version,
192 'debug=s' => \
%debug,
193 'test-only=s' => \
$tst_only,
194 'codespell!' => \
$codespell,
195 'codespellfile=s' => \
$codespellfile,
203 list_types
(0) if ($list_types);
205 $fix = 1 if ($fix_inplace);
206 $check_orig = $check;
210 if ($^V && $^V lt $minimum_perl_version) {
211 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
212 if (!$ignore_perl_version) {
218 print "$P: no input files\n";
222 sub hash_save_array_words
{
223 my ($hashRef, $arrayRef) = @_;
225 my @array = split(/,/, join(',', @$arrayRef));
226 foreach my $word (@array) {
227 $word =~ s/\s*\n?$//g;
230 $word =~ tr/[a-z]/[A-Z]/;
232 next if ($word =~ m/^\s*#/);
233 next if ($word =~ m/^\s*$/);
239 sub hash_show_words
{
240 my ($hashRef, $prefix) = @_;
242 if (keys %$hashRef) {
243 print "\nNOTE: $prefix message types:";
244 foreach my $word (sort keys %$hashRef) {
251 hash_save_array_words
(\
%ignore_type, \
@ignore);
252 hash_save_array_words
(\
%use_type, \
@use);
255 my $dbg_possible = 0;
258 for my $key (keys %debug) {
260 eval "\${dbg_$key} = '$debug{$key}';";
264 my $rpt_cleaners = 0;
273 if (!top_of_kernel_tree
($root)) {
274 die "$P: $root: --root does not point at a valid tree\n";
277 if (top_of_kernel_tree
('.')) {
279 } elsif ($0 =~ m
@(.*)/scripts/[^/]*$@ &&
280 top_of_kernel_tree
($1)) {
285 if (!defined $root) {
286 print "Must be run from the top-level dir. of a kernel tree\n";
291 my $emitted_corrupt = 0;
294 [A-Za-z_
][A-Za-z\d_
]*
295 (?
:\s
*\#\#\s
*[A-Za-z_
][A-Za-z\d_
]*)*
297 our $Storage = qr{extern|static|asmlinkage};
311 our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
312 our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
313 our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
314 our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
315 our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
317 # Notes to $Attribute:
318 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
339 ____cacheline_aligned
|
340 ____cacheline_aligned_in_smp
|
341 ____cacheline_internodealigned_in_smp
|
345 our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
346 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
347 our $Lval = qr{$Ident(?:$Member)*};
349 our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
350 our $Binary = qr{(?i)0b[01]+$Int_type?};
351 our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
352 our $Int = qr{[0-9]+$Int_type?};
353 our $Octal = qr{0[0-7]+$Int_type?};
354 our $String = qr{"[X\t]*"};
355 our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
356 our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
357 our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
358 our $Float = qr{$Float_hex|$Float_dec|$Float_int};
359 our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
360 our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
361 our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
362 our $Arithmetic = qr{\+|-|\*|\/|%};
366 &&|\
|\
||,|\
^|\
+\
+|--|&|\
||$Arithmetic
369 our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
373 our $NonptrTypeMisordered;
374 our $NonptrTypeWithAttr;
378 our $DeclareMisordered;
380 our $NON_ASCII_UTF8 = qr{
381 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
382 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
383 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
384 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
385 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
386 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
387 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
391 [\x09\x0A\x0D\x20-\x7E] # ASCII
395 our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
396 our $typeOtherOSTypedefs = qr{(?x
:
397 u_
(?
:char
|short
|int|long
) | # bsd
398 u
(?
:nchar
|short
|int|long
) # sysv
400 our $typeKernelTypedefs = qr{(?x
:
401 (?
:__
)?
(?
:u
|s
|be
|le)(?
:8|16|32|64)|
404 our $typeTypedefs = qr{(?x
:
406 $typeOtherOSTypedefs\b|
407 $typeKernelTypedefs\b
410 our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
412 our $logFunctions = qr{(?x
:
413 printk
(?
:_ratelimited
|_once
|)|
414 (?
:[a-z0-9
]+_
){1,2}(?
:printk
|emerg
|alert
|crit
|err
|warning
|warn|notice
|info
|debug
|dbg
|vdbg
|devel
|cont
|WARN
)(?
:_ratelimited
|_once
|)|
415 WARN
(?
:_RATELIMIT
|_ONCE
|)|
418 seq_vprintf
|seq_printf
|seq_puts
421 our $signature_tags = qr{(?xi
:
432 our @typeListMisordered = (
433 qr{char\s+(?:un)?signed},
434 qr{int\s+(?:(?:un)?signed\s+)?short\s},
435 qr{int\s+short(?:\s+(?:un)?signed)},
436 qr{short\s+int(?:\s+(?:un)?signed)},
437 qr{(?:un)?signed\s+int\s+short},
438 qr{short\s+(?:un)?signed},
439 qr{long\s+int\s+(?:un)?signed},
440 qr{int\s+long\s+(?:un)?signed},
441 qr{long\s+(?:un)?signed\s+int},
442 qr{int\s+(?:un)?signed\s+long},
443 qr{int\s+(?:un)?signed},
444 qr{int\s+long\s+long\s+(?:un)?signed},
445 qr{long\s+long\s+int\s+(?:un)?signed},
446 qr{long\s+long\s+(?:un)?signed\s+int},
447 qr{long\s+long\s+(?:un)?signed},
448 qr{long\s+(?:un)?signed},
453 qr{(?:(?:un)?signed\s+)?char},
454 qr{(?:(?:un)?signed\s+)?short\s+int},
455 qr{(?:(?:un)?signed\s+)?short},
456 qr{(?:(?:un)?signed\s+)?int},
457 qr{(?:(?:un)?signed\s+)?long\s+int},
458 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
459 qr{(?:(?:un)?signed\s+)?long\s+long},
460 qr{(?:(?:un)?signed\s+)?long},
469 qr{${Ident}_handler
},
470 qr{${Ident}_handler_fn
},
474 our $C90_int_types = qr{(?x
:
475 long\s
+long\s
+int\s
+(?
:un
)?signed
|
476 long\s
+long\s
+(?
:un
)?signed\s
+int|
477 long\s
+long\s
+(?
:un
)?signed
|
478 (?
:(?
:un
)?signed\s
+)?long\s
+long\s
+int|
479 (?
:(?
:un
)?signed\s
+)?long\s
+long
|
480 int\s
+long\s
+long\s
+(?
:un
)?signed
|
481 int\s
+(?
:(?
:un
)?signed\s
+)?long\s
+long
|
483 long\s
+int\s
+(?
:un
)?signed
|
484 long\s
+(?
:un
)?signed\s
+int|
485 long\s
+(?
:un
)?signed
|
486 (?
:(?
:un
)?signed\s
+)?long\s
+int|
487 (?
:(?
:un
)?signed\s
+)?long
|
488 int\s
+long\s
+(?
:un
)?signed
|
489 int\s
+(?
:(?
:un
)?signed\s
+)?long
|
492 (?
:(?
:un
)?signed\s
+)?
int
495 our @typeListFile = ();
496 our @typeListWithAttr = (
498 qr{struct\s+$InitAttribute\s+$Ident},
499 qr{union\s+$InitAttribute\s+$Ident},
502 our @modifierList = (
505 our @modifierListFile = ();
507 our @mode_permission_funcs = (
509 ["module_param_(?:array|named|string)", 4],
510 ["module_param_array_named", 5],
511 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
512 ["proc_create(?:_data|)", 2],
513 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
516 #Create a search pattern for all these functions to speed up a loop below
517 our $mode_perms_search = "";
518 foreach my $entry (@mode_permission_funcs) {
519 $mode_perms_search .= '|' if ($mode_perms_search ne "");
520 $mode_perms_search .= $entry->[0];
523 our $mode_perms_world_writable = qr{
531 our $allowed_asm_includes = qr{(?x
:
537 # memory.h: ARM has a custom one
539 # Load common spelling mistakes and build regular expression list.
543 if (open(my $spelling, '<', $spelling_file)) {
544 while (<$spelling>) {
547 $line =~ s/\s*\n?$//g;
550 next if ($line =~ m/^\s*#/);
551 next if ($line =~ m/^\s*$/);
553 my ($suspect, $fix) = split(/\|\|/, $line);
555 $spelling_fix{$suspect} = $fix;
559 warn "No typos will be found - file '$spelling_file': $!\n";
563 if (open(my $spelling, '<', $codespellfile)) {
564 while (<$spelling>) {
567 $line =~ s/\s*\n?$//g;
570 next if ($line =~ m/^\s*#/);
571 next if ($line =~ m/^\s*$/);
572 next if ($line =~ m/, disabled/i);
576 my ($suspect, $fix) = split(/->/, $line);
578 $spelling_fix{$suspect} = $fix;
582 warn "No codespell typos will be found - file '$codespellfile': $!\n";
586 $misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
589 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
590 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
591 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
592 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
593 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
599 (?
:$Modifier\s+|const\s
+)*
601 (?
:typeof
|__typeof__
)\s
*\
([^\
)]*\
)|
605 (?
:\s
+$Modifier|\s
+const
)*
607 $NonptrTypeMisordered = qr{
608 (?
:$Modifier\s+|const\s
+)*
612 (?
:\s
+$Modifier|\s
+const
)*
614 $NonptrTypeWithAttr = qr{
615 (?
:$Modifier\s+|const\s
+)*
617 (?
:typeof
|__typeof__
)\s
*\
([^\
)]*\
)|
621 (?
:\s
+$Modifier|\s
+const
)*
625 (?
:(?
:\s
|\
*|\
[\
])+\s
*const
|(?
:\s
|\
*\s
*(?
:const\s
*)?
|\
[\
])+|(?
:\s
*\
[\s
*\
])+)?
626 (?
:\s
+$Inline|\s
+$Modifier)*
628 $TypeMisordered = qr{
629 $NonptrTypeMisordered
630 (?
:(?
:\s
|\
*|\
[\
])+\s
*const
|(?
:\s
|\
*\s
*(?
:const\s
*)?
|\
[\
])+|(?
:\s
*\
[\s
*\
])+)?
631 (?
:\s
+$Inline|\s
+$Modifier)*
633 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
634 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
638 our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s
*};
640 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
641 # requires at least perl version v5.10.0
642 # Any use must be runtime checked with $^V
644 our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
645 our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s
*};
646 our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
648 our $declaration_macros = qr{(?x
:
649 (?
:$Storage\s+)?
(?
:[A-Z_
][A-Z0-9
]*_
){0,2}(?
:DEFINE
|DECLARE
)(?
:_
[A-Z0-9
]+){1,6}\s
*\
(|
650 (?
:$Storage\s+)?LIST_HEAD\s
*\
(|
651 (?
:$Storage\s+)?
${Type
}\s
+uninitialized_var\s
*\
(
656 return "" if (!defined($string));
658 while ($string =~ /^\s*\(.*\)\s*$/) {
659 $string =~ s
@^\s*\(\s
*@@;
660 $string =~ s
@\s*\)\s
*$@@;
663 $string =~ s
@\s+@ @g;
668 sub seed_camelcase_file
{
671 return if (!(-f
$file));
675 open(my $include_file, '<', "$file")
676 or warn "$P: Can't read '$file' $!\n";
677 my $text = <$include_file>;
678 close($include_file);
680 my @lines = split('\n', $text);
682 foreach my $line (@lines) {
683 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
684 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
686 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
688 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
694 my $camelcase_seeded = 0;
695 sub seed_camelcase_includes
{
696 return if ($camelcase_seeded);
699 my $camelcase_cache = "";
700 my @include_files = ();
702 $camelcase_seeded = 1;
705 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
706 chomp $git_last_include_commit;
707 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
709 my $last_mod_date = 0;
710 $files = `find $root/include -name "*.h"`;
711 @include_files = split('\n', $files);
712 foreach my $file (@include_files) {
713 my $date = POSIX
::strftime
("%Y%m%d%H%M",
714 localtime((stat $file)[9]));
715 $last_mod_date = $date if ($last_mod_date < $date);
717 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
720 if ($camelcase_cache ne "" && -f
$camelcase_cache) {
721 open(my $camelcase_file, '<', "$camelcase_cache")
722 or warn "$P: Can't read '$camelcase_cache' $!\n";
723 while (<$camelcase_file>) {
727 close($camelcase_file);
733 $files = `git ls-files "include/*.h"`;
734 @include_files = split('\n', $files);
737 foreach my $file (@include_files) {
738 seed_camelcase_file
($file);
741 if ($camelcase_cache ne "") {
742 unlink glob ".checkpatch-camelcase.*";
743 open(my $camelcase_file, '>', "$camelcase_cache")
744 or warn "$P: Can't write '$camelcase_cache' $!\n";
745 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
746 print $camelcase_file ("$_\n");
748 close($camelcase_file);
752 sub git_commit_info
{
753 my ($commit, $id, $desc) = @_;
755 return ($id, $desc) if ((which
("git") eq "") || !(-e
".git"));
757 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
758 $output =~ s/^\s*//gm;
759 my @lines = split("\n", $output);
761 return ($id, $desc) if ($#lines < 0);
763 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
764 # Maybe one day convert this block of bash into something that returns
765 # all matching commit ids, but it's very slow...
767 # echo "checking commits $1..."
768 # git rev-list --remotes | grep -i "^$1" |
769 # while read line ; do
770 # git log --format='%H %s' -1 $line |
771 # echo "commit $(cut -c 1-12,41-)"
773 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
775 $id = substr($lines[0], 0, 12);
776 $desc = substr($lines[0], 41);
782 $chk_signoff = 0 if ($file);
787 my @fixed_inserted = ();
788 my @fixed_deleted = ();
792 for my $filename (@ARGV) {
795 open($FILE, '-|', "diff -u /dev/null $filename") ||
796 die "$P: $filename: diff failed - $!\n";
797 } elsif ($filename eq '-') {
798 open($FILE, '<&STDIN');
800 open($FILE, '<', "$filename") ||
801 die "$P: $filename: open failed - $!\n";
803 if ($filename eq '-') {
804 $vname = 'Your patch';
814 if ($#ARGV > 0 && $quiet == 0) {
815 print '-' x
length($vname) . "\n";
817 print '-' x
length($vname) . "\n";
820 if (!process
($filename)) {
826 @fixed_inserted = ();
829 @modifierListFile = ();
835 hash_show_words
(\
%use_type, "Used");
836 hash_show_words
(\
%ignore_type, "Ignored");
841 NOTE
: perl
$^V is not modern enough to detect all possible issues
.
842 An upgrade to at least perl v5
.10
.0 is suggested
.
848 NOTE
: If any of the errors are false positives
, please report
849 them to the maintainer
, see CHECKPATCH
in MAINTAINERS
.
856 sub top_of_kernel_tree
{
860 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
861 "README", "Documentation", "arch", "include", "drivers",
862 "fs", "init", "ipc", "kernel", "lib", "scripts",
865 foreach my $check (@tree_check) {
866 if (! -e
$root . '/' . $check) {
874 my ($formatted_email) = @_;
880 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
883 $comment = $3 if defined $3;
884 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
886 $comment = $2 if defined $2;
887 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
889 $comment = $2 if defined $2;
890 $formatted_email =~ s/$address.*$//;
891 $name = $formatted_email;
893 $name =~ s/^\"|\"$//g;
894 # If there's a name left after stripping spaces and
895 # leading quotes, and the address doesn't have both
896 # leading and trailing angle brackets, the address
898 # "joe smith joe@smith.com" bad
899 # "joe smith <joe@smith.com" bad
900 if ($name ne "" && $address !~ /^<[^>]+>$/) {
908 $name =~ s/^\"|\"$//g;
909 $address = trim
($address);
910 $address =~ s/^\<|\>$//g;
912 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
913 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
917 return ($name, $address, $comment);
921 my ($name, $address) = @_;
926 $name =~ s/^\"|\"$//g;
927 $address = trim($address);
929 if ($name =~ /[^\w \-]/i) { ##has "must quote
" chars
930 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
935 $formatted_email = "$address";
937 $formatted_email = "$name <$address>";
940 return $formatted_email;
946 foreach my $path (split(/:/, $ENV{PATH
})) {
947 if (-e
"$path/$bin") {
958 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
959 if (-e
"$path/$conf") {
960 return "$path/$conf";
972 for my $c (split(//, $str)) {
976 for (; ($n % 8) != 0; $n++) {
988 (my $res = shift) =~ tr/\t/ /c;
995 # Drop the diff line leader and expand tabs
997 $line = expand_tabs
($line);
999 # Pick the indent from the front of the line.
1000 my ($white) = ($line =~ /^(\s*)/);
1002 return (length($line), length($white));
1005 my $sanitise_quote = '';
1007 sub sanitise_line_reset
{
1008 my ($in_comment) = @_;
1011 $sanitise_quote = '*/';
1013 $sanitise_quote = '';
1026 # Always copy over the diff marker.
1027 $res = substr($line, 0, 1);
1029 for ($off = 1; $off < length($line); $off++) {
1030 $c = substr($line, $off, 1);
1032 # Comments we are wacking completly including the begin
1033 # and end, all to $;.
1034 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1035 $sanitise_quote = '*/';
1037 substr($res, $off, 2, "$;$;");
1041 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
1042 $sanitise_quote = '';
1043 substr($res, $off, 2, "$;$;");
1047 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1048 $sanitise_quote = '//';
1050 substr($res, $off, 2, $sanitise_quote);
1055 # A \ in a string means ignore the next character.
1056 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1058 substr($res, $off, 2, 'XX');
1063 if ($c eq "'" || $c eq '"') {
1064 if ($sanitise_quote eq '') {
1065 $sanitise_quote = $c;
1067 substr($res, $off, 1, $c);
1069 } elsif ($sanitise_quote eq $c) {
1070 $sanitise_quote = '';
1074 #print "c<$c> SQ<$sanitise_quote>\n";
1075 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1076 substr($res, $off, 1, $;);
1077 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1078 substr($res, $off, 1, $;);
1079 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1080 substr($res, $off, 1, 'X');
1082 substr($res, $off, 1, $c);
1086 if ($sanitise_quote eq '//') {
1087 $sanitise_quote = '';
1090 # The pathname on a #include may be surrounded by '<' and '>'.
1091 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
1092 my $clean = 'X' x
length($1);
1093 $res =~ s
@\<.*\
>@<$clean>@;
1095 # The whole of a #error is a string.
1096 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
1097 my $clean = 'X' x
length($1);
1098 $res =~ s
@(\#\s
*(?
:error
|warning
)\s
+).*@$1$clean@;
1104 sub get_quoted_string
{
1105 my ($line, $rawline) = @_;
1107 return "" if ($line !~ m/($String)/g);
1108 return substr($rawline, $-[0], $+[0] - $-[0]);
1111 sub ctx_statement_block
{
1112 my ($linenr, $remain, $off) = @_;
1113 my $line = $linenr - 1;
1116 my $coff = $off - 1;
1130 @stack = (['', 0]) if ($#stack == -1);
1132 #warn "CSB: blk<$blk> remain<$remain>\n";
1133 # If we are about to drop off the end, pull in more
1136 for (; $remain > 0; $line++) {
1137 last if (!defined $lines[$line]);
1138 next if ($lines[$line] =~ /^-/);
1141 $blk .= $lines[$line] . "\n";
1142 $len = length($blk);
1146 # Bail if there is no further context.
1147 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1151 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1157 $c = substr($blk, $off, 1);
1158 $remainder = substr($blk, $off);
1160 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1162 # Handle nested #if/#else.
1163 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1164 push(@stack, [ $type, $level ]);
1165 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1166 ($type, $level) = @{$stack[$#stack - 1]};
1167 } elsif ($remainder =~ /^#\s*endif\b/) {
1168 ($type, $level) = @{pop(@stack)};
1171 # Statement ends at the ';' or a close '}' at the
1173 if ($level == 0 && $c eq ';') {
1177 # An else is really a conditional as long as its not else if
1178 if ($level == 0 && $coff_set == 0 &&
1179 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1180 $remainder =~ /^(else)(?:\s|{)/ &&
1181 $remainder !~ /^else\s+if\b/) {
1182 $coff = $off + length($1) - 1;
1184 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1185 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1188 if (($type eq '' || $type eq '(') && $c eq '(') {
1192 if ($type eq '(' && $c eq ')') {
1194 $type = ($level != 0)?
'(' : '';
1196 if ($level == 0 && $coff < $soff) {
1199 #warn "CSB: mark coff<$coff>\n";
1202 if (($type eq '' || $type eq '{') && $c eq '{') {
1206 if ($type eq '{' && $c eq '}') {
1208 $type = ($level != 0)?
'{' : '';
1211 if (substr($blk, $off + 1, 1) eq ';') {
1217 # Preprocessor commands end at the newline unless escaped.
1218 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1226 # We are truly at the end, so shuffle to the next line.
1233 my $statement = substr($blk, $soff, $off - $soff + 1);
1234 my $condition = substr($blk, $soff, $coff - $soff + 1);
1236 #warn "STATEMENT<$statement>\n";
1237 #warn "CONDITION<$condition>\n";
1239 #print "coff<$coff> soff<$off> loff<$loff>\n";
1241 return ($statement, $condition,
1242 $line, $remain + 1, $off - $loff + 1, $level);
1245 sub statement_lines
{
1248 # Strip the diff line prefixes and rip blank lines at start and end.
1249 $stmt =~ s/(^|\n)./$1/g;
1253 my @stmt_lines = ($stmt =~ /\n/g);
1255 return $#stmt_lines + 2;
1258 sub statement_rawlines
{
1261 my @stmt_lines = ($stmt =~ /\n/g);
1263 return $#stmt_lines + 2;
1266 sub statement_block_size
{
1269 $stmt =~ s/(^|\n)./$1/g;
1275 my @stmt_lines = ($stmt =~ /\n/g);
1276 my @stmt_statements = ($stmt =~ /;/g);
1278 my $stmt_lines = $#stmt_lines + 2;
1279 my $stmt_statements = $#stmt_statements + 1;
1281 if ($stmt_lines > $stmt_statements) {
1284 return $stmt_statements;
1288 sub ctx_statement_full
{
1289 my ($linenr, $remain, $off) = @_;
1290 my ($statement, $condition, $level);
1294 # Grab the first conditional/block pair.
1295 ($statement, $condition, $linenr, $remain, $off, $level) =
1296 ctx_statement_block
($linenr, $remain, $off);
1297 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1298 push(@chunks, [ $condition, $statement ]);
1299 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1300 return ($level, $linenr, @chunks);
1303 # Pull in the following conditional/block pairs and see if they
1304 # could continue the statement.
1306 ($statement, $condition, $linenr, $remain, $off, $level) =
1307 ctx_statement_block
($linenr, $remain, $off);
1308 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1309 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1311 push(@chunks, [ $condition, $statement ]);
1314 return ($level, $linenr, @chunks);
1318 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1320 my $start = $linenr - 1;
1327 my @stack = ($level);
1328 for ($line = $start; $remain > 0; $line++) {
1329 next if ($rawlines[$line] =~ /^-/);
1332 $blk .= $rawlines[$line];
1334 # Handle nested #if/#else.
1335 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1336 push(@stack, $level);
1337 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1338 $level = $stack[$#stack - 1];
1339 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1340 $level = pop(@stack);
1343 foreach my $c (split(//, $lines[$line])) {
1344 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1350 if ($c eq $close && $level > 0) {
1352 last if ($level == 0);
1353 } elsif ($c eq $open) {
1358 if (!$outer || $level <= 1) {
1359 push(@res, $rawlines[$line]);
1362 last if ($level == 0);
1365 return ($level, @res);
1367 sub ctx_block_outer
{
1368 my ($linenr, $remain) = @_;
1370 my ($level, @r) = ctx_block_get
($linenr, $remain, 1, '{', '}', 0);
1374 my ($linenr, $remain) = @_;
1376 my ($level, @r) = ctx_block_get
($linenr, $remain, 0, '{', '}', 0);
1380 my ($linenr, $remain, $off) = @_;
1382 my ($level, @r) = ctx_block_get
($linenr, $remain, 0, '(', ')', $off);
1385 sub ctx_block_level
{
1386 my ($linenr, $remain) = @_;
1388 return ctx_block_get
($linenr, $remain, 0, '{', '}', 0);
1390 sub ctx_statement_level
{
1391 my ($linenr, $remain, $off) = @_;
1393 return ctx_block_get
($linenr, $remain, 0, '(', ')', $off);
1396 sub ctx_locate_comment
{
1397 my ($first_line, $end_line) = @_;
1399 # Catch a comment on the end of the line itself.
1400 my ($current_comment) = ($rawlines[$end_line - 1] =~ m
@.*(/\*.*\*/)\s
*(?
:\\\s
*)?
$@);
1401 return $current_comment if (defined $current_comment);
1403 # Look through the context and try and figure out if there is a
1406 $current_comment = '';
1407 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1408 my $line = $rawlines[$linenr - 1];
1410 if ($linenr == $first_line and $line =~ m
@^.\s
*\
*@) {
1413 if ($line =~ m
@/\*@) {
1416 if (!$in_comment && $current_comment ne '') {
1417 $current_comment = '';
1419 $current_comment .= $line . "\n" if ($in_comment);
1420 if ($line =~ m
@\*/@) {
1425 chomp($current_comment);
1426 return($current_comment);
1428 sub ctx_has_comment
{
1429 my ($first_line, $end_line) = @_;
1430 my $cmt = ctx_locate_comment
($first_line, $end_line);
1432 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1433 ##print "CMMT: $cmt\n";
1435 return ($cmt ne '');
1439 my ($linenr, $cnt) = @_;
1441 my $offset = $linenr - 1;
1446 $line = $rawlines[$offset++];
1447 next if (defined($line) && $line =~ /^-/);
1459 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1462 $coded = sprintf("^%c", unpack('C', $2) + 64);
1471 my $av_preprocessor = 0;
1476 sub annotate_reset
{
1477 $av_preprocessor = 0;
1479 @av_paren_type = ('E');
1480 $av_pend_colon = 'O';
1483 sub annotate_values
{
1484 my ($stream, $type) = @_;
1487 my $var = '_' x
length($stream);
1490 print "$stream\n" if ($dbg_values > 1);
1492 while (length($cur)) {
1493 @av_paren_type = ('E') if ($#av_paren_type < 0);
1494 print " <" . join('', @av_paren_type) .
1495 "> <$type> <$av_pending>" if ($dbg_values > 1);
1496 if ($cur =~ /^(\s+)/o) {
1497 print "WS($1)\n" if ($dbg_values > 1);
1498 if ($1 =~ /\n/ && $av_preprocessor) {
1499 $type = pop(@av_paren_type);
1500 $av_preprocessor = 0;
1503 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1504 print "CAST($1)\n" if ($dbg_values > 1);
1505 push(@av_paren_type, $type);
1508 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1509 print "DECLARE($1)\n" if ($dbg_values > 1);
1512 } elsif ($cur =~ /^($Modifier)\s*/) {
1513 print "MODIFIER($1)\n" if ($dbg_values > 1);
1516 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1517 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1518 $av_preprocessor = 1;
1519 push(@av_paren_type, $type);
1525 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1526 print "UNDEF($1)\n" if ($dbg_values > 1);
1527 $av_preprocessor = 1;
1528 push(@av_paren_type, $type);
1530 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1531 print "PRE_START($1)\n" if ($dbg_values > 1);
1532 $av_preprocessor = 1;
1534 push(@av_paren_type, $type);
1535 push(@av_paren_type, $type);
1538 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1539 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1540 $av_preprocessor = 1;
1542 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1546 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1547 print "PRE_END($1)\n" if ($dbg_values > 1);
1549 $av_preprocessor = 1;
1551 # Assume all arms of the conditional end as this
1552 # one does, and continue as if the #endif was not here.
1553 pop(@av_paren_type);
1554 push(@av_paren_type, $type);
1557 } elsif ($cur =~ /^(\\\n)/o) {
1558 print "PRECONT($1)\n" if ($dbg_values > 1);
1560 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1561 print "ATTR($1)\n" if ($dbg_values > 1);
1562 $av_pending = $type;
1565 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1566 print "SIZEOF($1)\n" if ($dbg_values > 1);
1572 } elsif ($cur =~ /^(if|while|for)\b/o) {
1573 print "COND($1)\n" if ($dbg_values > 1);
1577 } elsif ($cur =~/^(case)/o) {
1578 print "CASE($1)\n" if ($dbg_values > 1);
1579 $av_pend_colon = 'C';
1582 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1583 print "KEYWORD($1)\n" if ($dbg_values > 1);
1586 } elsif ($cur =~ /^(\()/o) {
1587 print "PAREN('$1')\n" if ($dbg_values > 1);
1588 push(@av_paren_type, $av_pending);
1592 } elsif ($cur =~ /^(\))/o) {
1593 my $new_type = pop(@av_paren_type);
1594 if ($new_type ne '_') {
1596 print "PAREN('$1') -> $type\n"
1597 if ($dbg_values > 1);
1599 print "PAREN('$1')\n" if ($dbg_values > 1);
1602 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1603 print "FUNC($1)\n" if ($dbg_values > 1);
1607 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1608 if (defined $2 && $type eq 'C' || $type eq 'T') {
1609 $av_pend_colon = 'B';
1610 } elsif ($type eq 'E') {
1611 $av_pend_colon = 'L';
1613 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1616 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1617 print "IDENT($1)\n" if ($dbg_values > 1);
1620 } elsif ($cur =~ /^($Assignment)/o) {
1621 print "ASSIGN($1)\n" if ($dbg_values > 1);
1624 } elsif ($cur =~/^(;|{|})/) {
1625 print "END($1)\n" if ($dbg_values > 1);
1627 $av_pend_colon = 'O';
1629 } elsif ($cur =~/^(,)/) {
1630 print "COMMA($1)\n" if ($dbg_values > 1);
1633 } elsif ($cur =~ /^(\?)/o) {
1634 print "QUESTION($1)\n" if ($dbg_values > 1);
1637 } elsif ($cur =~ /^(:)/o) {
1638 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1640 substr($var, length($res), 1, $av_pend_colon);
1641 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1646 $av_pend_colon = 'O';
1648 } elsif ($cur =~ /^(\[)/o) {
1649 print "CLOSE($1)\n" if ($dbg_values > 1);
1652 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1655 print "OPV($1)\n" if ($dbg_values > 1);
1662 substr($var, length($res), 1, $variant);
1665 } elsif ($cur =~ /^($Operators)/o) {
1666 print "OP($1)\n" if ($dbg_values > 1);
1667 if ($1 ne '++' && $1 ne '--') {
1671 } elsif ($cur =~ /(^.)/o) {
1672 print "C($1)\n" if ($dbg_values > 1);
1675 $cur = substr($cur, length($1));
1676 $res .= $type x
length($1);
1680 return ($res, $var);
1684 my ($possible, $line) = @_;
1685 my $notPermitted = qr{(?
:
1702 ^(?
:typedef
|struct
|enum
)\b
1704 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1705 if ($possible !~ $notPermitted) {
1706 # Check for modifiers.
1707 $possible =~ s/\s*$Storage\s*//g;
1708 $possible =~ s/\s*$Sparse\s*//g;
1709 if ($possible =~ /^\s*$/) {
1711 } elsif ($possible =~ /\s/) {
1712 $possible =~ s/\s*$Type\s*//g;
1713 for my $modifier (split(' ', $possible)) {
1714 if ($modifier !~ $notPermitted) {
1715 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1716 push(@modifierListFile, $modifier);
1721 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1722 push(@typeListFile, $possible);
1726 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1735 return defined $use_type{$type} if (scalar keys %use_type > 0);
1737 return !defined $ignore_type{$type};
1741 my ($level, $type, $msg) = @_;
1743 if (!show_type
($type) ||
1744 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
1748 if (-t STDOUT
&& $color) {
1749 if ($level eq 'ERROR') {
1751 } elsif ($level eq 'WARNING') {
1757 $output .= $prefix . $level . ':';
1759 $output .= BLUE
if (-t STDOUT
&& $color);
1760 $output .= "$type:";
1762 $output .= RESET
if (-t STDOUT
&& $color);
1763 $output .= ' ' . $msg . "\n";
1766 my @lines = split("\n", $output, -1);
1767 splice(@lines, 1, 1);
1768 $output = join("\n", @lines);
1770 $output = (split('\n', $output))[0] . "\n" if ($terse);
1772 push(our @report, $output);
1781 sub fixup_current_range
{
1782 my ($lineRef, $offset, $length) = @_;
1784 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1787 my $no = $o + $offset;
1788 my $nl = $l + $length;
1789 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1793 sub fix_inserted_deleted_lines
{
1794 my ($linesRef, $insertedRef, $deletedRef) = @_;
1796 my $range_last_linenr = 0;
1797 my $delta_offset = 0;
1802 my $next_insert = 0;
1803 my $next_delete = 0;
1807 my $inserted = @{$insertedRef}[$next_insert++];
1808 my $deleted = @{$deletedRef}[$next_delete++];
1810 foreach my $old_line (@{$linesRef}) {
1812 my $line = $old_line; #don't modify the array
1813 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
1815 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1816 $range_last_linenr = $new_linenr;
1817 fixup_current_range
(\
$line, $delta_offset, 0);
1820 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1821 $deleted = @{$deletedRef}[$next_delete++];
1823 fixup_current_range
(\
$lines[$range_last_linenr], $delta_offset--, -1);
1826 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1827 push(@lines, ${$inserted}{'LINE'});
1828 $inserted = @{$insertedRef}[$next_insert++];
1830 fixup_current_range
(\
$lines[$range_last_linenr], $delta_offset++, 1);
1834 push(@lines, $line);
1844 sub fix_insert_line
{
1845 my ($linenr, $line) = @_;
1851 push(@fixed_inserted, $inserted);
1854 sub fix_delete_line
{
1855 my ($linenr, $line) = @_;
1862 push(@fixed_deleted, $deleted);
1866 my ($type, $msg) = @_;
1868 if (report
("ERROR", $type, $msg)) {
1876 my ($type, $msg) = @_;
1878 if (report
("WARNING", $type, $msg)) {
1886 my ($type, $msg) = @_;
1888 if ($check && report
("CHECK", $type, $msg)) {
1896 sub check_absolute_file
{
1897 my ($absolute, $herecurr) = @_;
1898 my $file = $absolute;
1900 ##print "absolute<$absolute>\n";
1902 # See if any suffix of this path is a path within the tree.
1903 while ($file =~ s
@^[^/]*/@@) {
1904 if (-f
"$root/$file") {
1905 ##print "file<$file>\n";
1913 # It is, so see if the prefix is acceptable.
1914 my $prefix = $absolute;
1915 substr($prefix, -length($file)) = '';
1917 ##print "prefix<$prefix>\n";
1918 if ($prefix ne ".../") {
1919 WARN
("USE_RELATIVE_PATH",
1920 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1927 $string =~ s/^\s+|\s+$//g;
1935 $string =~ s/^\s+//;
1943 $string =~ s/\s+$//;
1948 sub string_find_replace
{
1949 my ($string, $find, $replace) = @_;
1951 $string =~ s/$find/$replace/g;
1959 my $source_indent = 8;
1960 my $max_spaces_before_tab = $source_indent - 1;
1961 my $spaces_to_tab = " " x
$source_indent;
1963 #convert leading spaces to tabs
1964 1 while $leading =~ s
@^([\t]*)$spaces_to_tab@$1\t@g;
1965 #Remove spaces before a tab
1966 1 while $leading =~ s
@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1971 sub pos_last_openparen
{
1976 my $opens = $line =~ tr/\(/\(/;
1977 my $closes = $line =~ tr/\)/\)/;
1979 my $last_openparen = 0;
1981 if (($opens == 0) || ($closes >= $opens)) {
1985 my $len = length($line);
1987 for ($pos = 0; $pos < $len; $pos++) {
1988 my $string = substr($line, $pos);
1989 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1990 $pos += length($1) - 1;
1991 } elsif (substr($line, $pos, 1) eq '(') {
1992 $last_openparen = $pos;
1993 } elsif (index($string, '(') == -1) {
1998 return length(expand_tabs
(substr($line, 0, $last_openparen))) + 1;
2002 my $filename = shift;
2008 my $stashrawline="";
2018 my $in_header_lines = $file ?
0 : 1;
2019 my $in_commit_log = 0; #Scanning lines before patch
2020 my $commit_log_possible_stack_dump = 0;
2021 my $commit_log_long_line = 0;
2022 my $commit_log_has_diff = 0;
2023 my $reported_maintainer_file = 0;
2024 my $non_utf8_charset = 0;
2026 my $last_blank_line = 0;
2027 my $last_coalesced_string_linenr = -1;
2035 # Trace the real file/line as we go.
2041 my $comment_edge = 0;
2045 my $prev_values = 'E';
2048 my %suppress_ifbraces;
2049 my %suppress_whiletrailers;
2050 my %suppress_export;
2051 my $suppress_statement = 0;
2053 my %signatures = ();
2055 # Pre-scan the patch sanitizing the lines.
2056 # Pre-scan the patch looking for any __setup documentation.
2058 my @setup_docs = ();
2061 my $camelcase_file_seeded = 0;
2063 sanitise_line_reset
();
2065 foreach my $rawline (@rawlines) {
2069 push(@fixed, $rawline) if ($fix);
2071 if ($rawline=~/^\+\+\+\s+(\S+)/) {
2073 if ($1 =~ m
@Documentation/kernel-parameters
.txt
$@) {
2078 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2087 # Guestimate if this is a continuing comment. Run
2088 # the context looking for a comment "edge". If this
2089 # edge is a close comment then we must be in a comment
2093 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2094 next if (defined $rawlines[$ln - 1] &&
2095 $rawlines[$ln - 1] =~ /^-/);
2097 #print "RAW<$rawlines[$ln - 1]>\n";
2098 last if (!defined $rawlines[$ln - 1]);
2099 if ($rawlines[$ln - 1] =~ m
@(/\*|\*/)@ &&
2100 $rawlines[$ln - 1] !~ m
@"[^"]*(?
:/\*|\*/)[^"]*"@) {
2105 if (defined $edge && $edge eq '*/') {
2109 # Guestimate if this is a continuing comment. If this
2110 # is the start of a diff block and this line starts
2111 # ' *' then it is very likely a comment.
2112 if (!defined $edge &&
2113 $rawlines[$linenr] =~ m
@^.\s
*(?
:\
*\
*+| \
*)(?
:\s
|$)@)
2118 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2119 sanitise_line_reset
($in_comment);
2121 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
2122 # Standardise the strings and chars within the input to
2123 # simplify matching -- only bother with positive lines.
2124 $line = sanitise_line
($rawline);
2126 push(@lines, $line);
2129 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2134 #print "==>$rawline\n";
2135 #print "-->$line\n";
2137 if ($setup_docs && $line =~ /^\+/) {
2138 push(@setup_docs, $line);
2147 foreach my $line (@lines) {
2150 my $sline = $line; #copy of $line
2151 $sline =~ s/$;/ /g; #with comments as spaces
2153 my $rawline = $rawlines[$linenr - 1];
2155 #extract the line range in the file after the patch is applied
2156 if (!$in_commit_log &&
2157 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2159 $first_line = $linenr + 1;
2169 %suppress_ifbraces = ();
2170 %suppress_whiletrailers = ();
2171 %suppress_export = ();
2172 $suppress_statement = 0;
2175 # track the line number as we move through the hunk, note that
2176 # new versions of GNU diff omit the leading space on completely
2177 # blank context lines so we need to count that too.
2178 } elsif ($line =~ /^( |\+|$)/) {
2180 $realcnt-- if ($realcnt != 0);
2182 # Measure the line length and indent.
2183 ($length, $indent) = line_stats
($rawline);
2185 # Track the previous line.
2186 ($prevline, $stashline) = ($stashline, $line);
2187 ($previndent, $stashindent) = ($stashindent, $indent);
2188 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2190 #warn "line<$line>\n";
2192 } elsif ($realcnt == 1) {
2196 my $hunk_line = ($realcnt != 0);
2198 $here = "#$linenr: " if (!$file);
2199 $here = "#$realline: " if ($file);
2202 # extract the filename as it passes
2203 if ($line =~ /^diff --git.*?(\S+)$/) {
2205 $realfile =~ s
@^([^/]*)/@@ if (!$file);
2208 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2210 $realfile =~ s
@^([^/]*)/@@ if (!$file);
2214 if (!$file && $tree && $p1_prefix ne '' &&
2215 -e
"$root/$p1_prefix") {
2216 WARN
("PATCH_PREFIX",
2217 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
2220 if ($realfile =~ m
@^include/asm/@) {
2221 ERROR
("MODIFIED_INCLUDE_ASM",
2222 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2227 #make up the handle for any error we report on this line
2229 $prefix = "$realfile:$realline: "
2232 $prefix = "$filename:$realline: ";
2234 $prefix = "$filename:$linenr: ";
2239 if ($realfile =~ m
@^(?
:drivers
/net
/|net
/|drivers
/staging/)@) {
2242 $check = $check_orig;
2247 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
2249 my $hereline = "$here\n$rawline\n";
2250 my $herecurr = "$here\n$rawline\n";
2251 my $hereprev = "$here\n$prevrawline\n$rawline\n";
2253 $cnt_lines++ if ($realcnt != 0);
2255 # Check if the commit log has what seems like a diff which can confuse patch
2256 if ($in_commit_log && !$commit_log_has_diff &&
2257 (($line =~ m
@^\s+diff\b.*a
/[\w/]+@ &&
2258 $line =~ m
@^\s+diff\b.*a
/([\w/]+)\s
+b
/$1\b@) ||
2259 $line =~ m
@^\s*(?
:\
-\
-\
-\s
+a
/|\+\+\+\s+b/)@ ||
2260 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2261 ERROR
("DIFF_IN_COMMIT_MSG",
2262 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2263 $commit_log_has_diff = 1;
2266 # Check for incorrect file permissions
2267 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2268 my $permhere = $here . "FILE: $realfile\n";
2269 if ($realfile !~ m
@scripts/@ &&
2270 $realfile !~ /\.(py|pl|awk|sh)$/) {
2271 ERROR
("EXECUTE_PERMISSIONS",
2272 "do not set execute permissions for source files\n" . $permhere);
2276 # Check the patch for a signoff:
2277 if ($line =~ /^\s*signed-off-by:/i) {
2282 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2283 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2284 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2285 $reported_maintainer_file = 1;
2288 # Check signature styles
2289 if (!$in_header_lines &&
2290 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
2291 my $space_before = $1;
2293 my $space_after = $3;
2295 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2297 if ($sign_off !~ /$signature_tags/) {
2298 WARN
("BAD_SIGN_OFF",
2299 "Non-standard signature: $sign_off\n" . $herecurr);
2301 if (defined $space_before && $space_before ne "") {
2302 if (WARN
("BAD_SIGN_OFF",
2303 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2305 $fixed[$fixlinenr] =
2306 "$ucfirst_sign_off $email";
2309 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
2310 if (WARN
("BAD_SIGN_OFF",
2311 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2313 $fixed[$fixlinenr] =
2314 "$ucfirst_sign_off $email";
2318 if (!defined $space_after || $space_after ne " ") {
2319 if (WARN
("BAD_SIGN_OFF",
2320 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2322 $fixed[$fixlinenr] =
2323 "$ucfirst_sign_off $email";
2327 my ($email_name, $email_address, $comment) = parse_email
($email);
2328 my $suggested_email = format_email
(($email_name, $email_address));
2329 if ($suggested_email eq "") {
2330 ERROR
("BAD_SIGN_OFF",
2331 "Unrecognized email address: '$email'\n" . $herecurr);
2333 my $dequoted = $suggested_email;
2334 $dequoted =~ s/^"//;
2335 $dequoted =~ s/" </ </;
2336 # Don't force email to have quotes
2337 # Allow just an angle bracketed address
2338 if ("$dequoted$comment" ne $email &&
2339 "<$email_address>$comment" ne $email &&
2340 "$suggested_email$comment" ne $email) {
2341 WARN
("BAD_SIGN_OFF",
2342 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
2346 # Check for duplicate signatures
2347 my $sig_nospace = $line;
2348 $sig_nospace =~ s/\s//g;
2349 $sig_nospace = lc($sig_nospace);
2350 if (defined $signatures{$sig_nospace}) {
2351 WARN
("BAD_SIGN_OFF",
2352 "Duplicate signature\n" . $herecurr);
2354 $signatures{$sig_nospace} = 1;
2358 # Check email subject for common tools that don't need to be mentioned
2359 if ($in_header_lines &&
2360 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2361 WARN
("EMAIL_SUBJECT",
2362 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2365 # Check for old stable address
2366 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2367 ERROR
("STABLE_ADDRESS",
2368 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2371 # Check for unwanted Gerrit info
2372 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2373 ERROR
("GERRIT_CHANGE_ID",
2374 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2377 # Check if the commit log is in a possible stack dump
2378 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2379 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2380 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2382 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2383 # stack dump address
2384 $commit_log_possible_stack_dump = 1;
2387 # Check for line lengths > 75 in commit log, warn once
2388 if ($in_commit_log && !$commit_log_long_line &&
2389 length($line) > 75 &&
2390 !($line =~ /^\s*[a-zA-Z0-9_\/\
.]+\s
+\
|\s
+\d
+/ ||
2391 # file delta changes
2392 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\
.\
-]+:/ ||
2394 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2395 # A Fixes: or Link: line
2396 $commit_log_possible_stack_dump)) {
2397 WARN
("COMMIT_LOG_LONG_LINE",
2398 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2399 $commit_log_long_line = 1;
2402 # Reset possible stack dump if a blank line is found
2403 if ($in_commit_log && $commit_log_possible_stack_dump &&
2405 $commit_log_possible_stack_dump = 0;
2408 # Check for git id commit length and improperly formed commit descriptions
2409 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2410 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
2411 ($line =~ /\b[0-9a-f]{12,40}\b/i &&
2412 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2413 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
2414 my $init_char = "c";
2415 my $orig_commit = "";
2422 my $id = '0123456789ab';
2423 my $orig_desc = "commit description";
2424 my $description = "";
2426 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2428 $orig_commit = lc($2);
2429 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2430 $orig_commit = lc($1);
2433 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2434 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2435 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2436 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2437 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2440 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2441 defined $rawlines[$linenr] &&
2442 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2445 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2446 defined $rawlines[$linenr] &&
2447 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2448 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2450 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2451 $orig_desc .= " " . $1;
2455 ($id, $description) = git_commit_info
($orig_commit,
2458 if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) {
2459 ERROR
("GIT_COMMIT_ID",
2460 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2464 # Check for added, moved or deleted files
2465 if (!$reported_maintainer_file && !$in_commit_log &&
2466 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2467 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2468 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2469 (defined($1) || defined($2))))) {
2470 $reported_maintainer_file = 1;
2471 WARN("FILE_PATH_CHANGES",
2472 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2475 # Check for wrappage within a valid hunk of the file
2476 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
2477 ERROR("CORRUPTED_PATCH",
2478 "patch seems to be corrupt (line wrapped?)\n" .
2479 $herecurr) if (!$emitted_corrupt++);
2482 # Check for absolute kernel paths.
2484 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2487 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2488 check_absolute_file($1, $herecurr)) {
2491 check_absolute_file($file, $herecurr);
2496 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2497 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
2498 $rawline !~ m/^$UTF8*$/) {
2499 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2501 my $blank = copy_spacing($rawline);
2502 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2503 my $hereptr = "$hereline$ptr\n";
2506 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
2509 # Check if it's the start of a commit
log
2510 # (not a header line and we haven't seen the patch filename)
2511 if ($in_header_lines && $realfile =~ /^$/ &&
2512 !($rawline =~ /^\s+\S/ ||
2513 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
2514 $in_header_lines = 0;
2518 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2519 # declined it, i.e defined some charset where it is missing.
2520 if ($in_header_lines &&
2521 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2523 $non_utf8_charset = 1;
2526 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
2527 $rawline =~ /$NON_ASCII_UTF8/) {
2528 WARN
("UTF8_BEFORE_PATCH",
2529 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2532 # Check for various typo / spelling mistakes
2533 if (defined($misspellings) &&
2534 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
2535 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
2537 my $typo_fix = $spelling_fix{lc($typo)};
2538 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2539 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2540 my $msg_type = \
&WARN
;
2541 $msg_type = \
&CHK
if ($file);
2542 if (&{$msg_type}("TYPO_SPELLING",
2543 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2545 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2550 # ignore non-hunk lines and lines being removed
2551 next if (!$hunk_line || $line =~ /^-/);
2553 #trailing whitespace
2554 if ($line =~ /^\+.*\015/) {
2555 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
2556 if (ERROR
("DOS_LINE_ENDINGS",
2557 "DOS line endings\n" . $herevet) &&
2559 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
2561 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2562 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
2563 if (ERROR
("TRAILING_WHITESPACE",
2564 "trailing whitespace\n" . $herevet) &&
2566 $fixed[$fixlinenr] =~ s/\s+$//;
2572 # Check for FSF mailing addresses.
2573 if ($rawline =~ /\bwrite to the Free/i ||
2574 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2575 $rawline =~ /\b51\s+Franklin\s+St/i) {
2576 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
2577 my $msg_type = \
&ERROR
;
2578 $msg_type = \
&CHK
if ($file);
2579 &{$msg_type}("FSF_MAILING_ADDRESS",
2580 "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)
2583 # check for Kconfig help text having a real description
2584 # Only applies when adding the entry originally, after that we do not have
2585 # sufficient context to determine whether it is indeed long enough.
2586 if ($realfile =~ /Kconfig/ &&
2587 $line =~ /^\+\s*config\s+/) {
2590 my $ln = $linenr + 1;
2594 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
2595 $f = $lines[$ln - 1];
2596 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2597 $is_end = $lines[$ln - 1] =~ /^\+/;
2599 next if ($f =~ /^-/);
2600 last if (!$file && $f =~ /^\@\@/);
2602 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
2604 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
2611 next if ($f =~ /^$/);
2612 if ($f =~ /^\s*config\s/) {
2618 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2619 WARN
("CONFIG_DESCRIPTION",
2620 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2622 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2625 # discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2626 if ($realfile =~ /Kconfig/ &&
2627 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2628 WARN
("CONFIG_EXPERIMENTAL",
2629 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2632 # discourage the use of boolean for type definition attributes of Kconfig options
2633 if ($realfile =~ /Kconfig/ &&
2634 $line =~ /^\+\s*\bboolean\b/) {
2635 WARN
("CONFIG_TYPE_BOOLEAN",
2636 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2639 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2640 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2643 'EXTRA_AFLAGS' => 'asflags-y',
2644 'EXTRA_CFLAGS' => 'ccflags-y',
2645 'EXTRA_CPPFLAGS' => 'cppflags-y',
2646 'EXTRA_LDFLAGS' => 'ldflags-y',
2649 WARN
("DEPRECATED_VARIABLE",
2650 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2653 # check for DT compatible documentation
2654 if (defined $root &&
2655 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2656 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2658 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2660 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2661 my $vp_file = $dt_path . "vendor-prefixes.txt";
2663 foreach my $compat (@compats) {
2664 my $compat2 = $compat;
2665 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2666 my $compat3 = $compat;
2667 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2668 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
2670 WARN("UNDOCUMENTED_DT_STRING",
2671 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2674 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2676 `grep -Eq
"^$vendor\\b" $vp_file`;
2678 WARN
("UNDOCUMENTED_DT_STRING",
2679 "DT compatible string vendor \"$vendor\" appears un-documented
-- check
$vp_file\n" . $herecurr);
2684 # check we are in a valid source file if not then ignore this hunk
2685 next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/);
2687 # line length limit (with some exclusions)
2689 # There are a few types of lines that may extend beyond $max_line_length:
2690 # logging functions like pr_info that end in a string
2691 # lines with a single string
2692 # #defines that are a single string
2694 # There are 3 different line length message types:
2695 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength
2696 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2697 # LONG_LINE all other lines longer than $max_line_length
2699 # if LONG_LINE is ignored, the other 2 types are also ignored
2702 if ($line =~ /^\+/ && $length > $max_line_length) {
2703 my $msg_type = "LONG_LINE
";
2705 # Check the allowed long line types first
2707 # logging functions that end in a string that starts
2708 # before $max_line_length
2709 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?
($String\s*(?
:|,|\
)\s
*;)\s
*)$/ &&
2710 length(expand_tabs
(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2713 # lines with only strings (w/ possible termination)
2714 # #defines with only strings
2715 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2716 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2719 # Otherwise set the alternate message types
2721 # a comment starts before $max_line_length
2722 } elsif ($line =~ /($;[\s$;]*)$/ &&
2723 length(expand_tabs
(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2724 $msg_type = "LONG_LINE_COMMENT"
2726 # a quoted string starts before $max_line_length
2727 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
2728 length(expand_tabs
(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2729 $msg_type = "LONG_LINE_STRING"
2732 if ($msg_type ne "" &&
2733 (show_type
("LONG_LINE") || show_type
($msg_type))) {
2735 "line over $max_line_length characters\n" . $herecurr);
2739 # check for adding lines without a newline.
2740 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2741 WARN
("MISSING_EOF_NEWLINE",
2742 "adding a line without newline at end of file\n" . $herecurr);
2745 # Blackfin: use hi/lo macros
2746 if ($realfile =~ m
@arch/blackfin/.*\
.S
$@) {
2747 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2748 my $herevet = "$here\n" . cat_vet
($line) . "\n";
2750 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
2752 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2753 my $herevet = "$here\n" . cat_vet
($line) . "\n";
2755 "use the HI() macro, not (... >> 16)\n" . $herevet);
2759 # check we are in a valid source file C or perl if not then ignore this hunk
2760 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
2762 # at the beginning of a line any tabs must come first and anything
2763 # more than 8 must use tabs.
2764 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2765 $rawline =~ /^\+\s* \s*/) {
2766 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
2768 if (ERROR
("CODE_INDENT",
2769 "code indent should use tabs where possible\n" . $herevet) &&
2771 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2775 # check for space before tabs.
2776 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2777 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
2778 if (WARN
("SPACE_BEFORE_TAB",
2779 "please, no space before tabs\n" . $herevet) &&
2781 while ($fixed[$fixlinenr] =~
2782 s/(^\+.*) {8,8}\t/$1\t\t/) {}
2783 while ($fixed[$fixlinenr] =~
2784 s/(^\+.*) +\t/$1\t/) {}
2788 # check for && or || at the start of a line
2789 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2790 CHK
("LOGICAL_CONTINUATIONS",
2791 "Logical continuations should be on the previous line\n" . $hereprev);
2794 # check indentation starts on a tab stop
2795 if ($^V && $^V ge 5.10.0 &&
2796 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$))/) {
2797 my $indent = length($1);
2800 "Statements should start on a tabstop\n" . $herecurr) &&
2802 $fixed[$fixlinenr] =~ s
@(^\
+\t+) +@$1 . "\t" x
($indent/8)@e;
2807 # check multi-line statement indentation matches previous line
2808 if ($^V && $^V ge 5.10.0 &&
2809 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2810 $prevline =~ /^\+(\t*)(.*)$/;
2814 my $pos = pos_last_openparen
($rest);
2816 $line =~ /^(\+| )([ \t]*)/;
2819 my $goodtabindent = $oldindent .
2822 my $goodspaceindent = $oldindent . " " x
$pos;
2824 if ($newindent ne $goodtabindent &&
2825 $newindent ne $goodspaceindent) {
2827 if (CHK
("PARENTHESIS_ALIGNMENT",
2828 "Alignment should match open parenthesis\n" . $hereprev) &&
2829 $fix && $line =~ /^\+/) {
2830 $fixed[$fixlinenr] =~
2831 s/^\+[ \t]*/\+$goodtabindent/;
2837 # check for space after cast like "(int) foo" or "(struct foo) bar"
2838 # avoid checking a few false positives:
2839 # "sizeof(<type>)" or "__alignof__(<type>)"
2840 # function pointer declarations like "(*foo)(int) = bar;"
2841 # structure definitions like "(struct foo) { 0 };"
2842 # multiline macros that define functions
2843 # known attributes or the __attribute__ keyword
2844 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
2845 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
2847 "No space is necessary after a cast\n" . $herecurr) &&
2849 $fixed[$fixlinenr] =~
2850 s/(\(\s*$Type\s*\))[ \t]+/$1/;
2854 # Block comment styles
2855 # Networking with an initial /*
2856 if ($realfile =~ m
@^(drivers
/net
/|net
/)@ &&
2857 $prevrawline =~ /^\+[ \t]*\/\
*[ \t]*$/ &&
2858 $rawline =~ /^\+[ \t]*\*/ &&
2860 WARN
("NETWORKING_BLOCK_COMMENT_STYLE",
2861 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2864 # Block comments use * on subsequent lines
2865 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
2866 $prevrawline =~ /^\+.*?\/\
*/ && #starting /*
2867 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
2868 $rawline =~ /^\+/ && #line is new
2869 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2870 WARN
("BLOCK_COMMENT_STYLE",
2871 "Block comments use * on subsequent lines\n" . $hereprev);
2874 # Block comments use */ on trailing lines
2875 if ($rawline !~ m
@^\+[ \t]*\
*/[ \t]*$@ && #trailing */
2876 $rawline !~ m
@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2877 $rawline !~ m
@^\+.*\
*{2,}/[ \t]*$@ && #trailing **/
2878 $rawline =~ m
@^\+[ \t]*.+\
*\
/[ \t]*$@) { #non blank */
2879 WARN
("BLOCK_COMMENT_STYLE",
2880 "Block comments use a trailing */ on a separate line\n" . $herecurr);
2883 # check for missing blank lines after struct/union declarations
2884 # with exceptions for various attributes and macros
2885 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2887 !($line =~ /^\+\s*$/ ||
2888 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2889 $line =~ /^\+\s*MODULE_/i ||
2890 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2891 $line =~ /^\+[a-z_]*init/ ||
2892 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2893 $line =~ /^\+\s*DECLARE/ ||
2894 $line =~ /^\+\s*__setup/)) {
2895 if (CHK
("LINE_SPACING",
2896 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
2898 fix_insert_line
($fixlinenr, "\+");
2902 # check for multiple consecutive blank lines
2903 if ($prevline =~ /^[\+ ]\s*$/ &&
2904 $line =~ /^\+\s*$/ &&
2905 $last_blank_line != ($linenr - 1)) {
2906 if (CHK
("LINE_SPACING",
2907 "Please don't use multiple blank lines\n" . $hereprev) &&
2909 fix_delete_line
($fixlinenr, $rawline);
2912 $last_blank_line = $linenr;
2915 # check for missing blank lines after declarations
2916 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2917 # actual declarations
2918 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2919 # function pointer declarations
2920 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2921 # foo bar; where foo is some local typedef or #define
2922 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2923 # known declaration macros
2924 $prevline =~ /^\+\s+$declaration_macros/) &&
2925 # for "else if" which can look like "$Ident $Ident"
2926 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2927 # other possible extensions of declaration lines
2928 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2929 # not starting a section or a macro "\" extended line
2930 $prevline =~ /(?:\{\s*|\\)$/) &&
2931 # looks like a declaration
2932 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2933 # function pointer declarations
2934 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2935 # foo bar; where foo is some local typedef or #define
2936 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2937 # known declaration macros
2938 $sline =~ /^\+\s+$declaration_macros/ ||
2939 # start of struct or union or enum
2940 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
2941 # start or end of block or continuation of declaration
2942 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
2943 # bitfield continuation
2944 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
2945 # other possible extensions of declaration lines
2946 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
2947 # indentation of previous and current line are the same
2948 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
2949 if (WARN
("LINE_SPACING",
2950 "Missing a blank line after declarations\n" . $hereprev) &&
2952 fix_insert_line
($fixlinenr, "\+");
2956 # check for spaces at the beginning of a line.
2958 # 1) within comments
2959 # 2) indented preprocessor commands
2961 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
2962 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
2963 if (WARN
("LEADING_SPACE",
2964 "please, no spaces at the start of a line\n" . $herevet) &&
2966 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2970 # check we are in a valid C source file if not then ignore this hunk
2971 next if ($realfile !~ /\.(h|c)$/);
2973 # check indentation of any line with a bare else
2974 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
2975 # if the previous line is a break or return and is indented 1 tab more...
2976 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
2977 my $tabs = length($1) + 1;
2978 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
2979 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
2980 defined $lines[$linenr] &&
2981 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
2982 WARN
("UNNECESSARY_ELSE",
2983 "else is not generally useful after a break or return\n" . $hereprev);
2987 # check indentation of a line with a break;
2988 # if the previous line is a goto or return and is indented the same # of tabs
2989 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
2991 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
2992 WARN
("UNNECESSARY_BREAK",
2993 "break is not useful after a goto or return\n" . $hereprev);
2997 # discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2998 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2999 WARN
("CONFIG_EXPERIMENTAL",
3000 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
3003 # check for RCS/CVS revision markers
3004 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
3006 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
3009 # Blackfin: don't use __builtin_bfin_[cs]sync
3010 if ($line =~ /__builtin_bfin_csync/) {
3011 my $herevet = "$here\n" . cat_vet
($line) . "\n";
3013 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
3015 if ($line =~ /__builtin_bfin_ssync/) {
3016 my $herevet = "$here\n" . cat_vet
($line) . "\n";
3018 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
3021 # check for old HOTPLUG __dev<foo> section markings
3022 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3023 WARN
("HOTPLUG_SECTION",
3024 "Using $1 is unnecessary\n" . $herecurr);
3027 # Check for potential 'bare' types
3028 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3030 #print "LINE<$line>\n";
3031 if ($linenr >= $suppress_statement &&
3032 $realcnt && $sline =~ /.\s*\S/) {
3033 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3034 ctx_statement_block
($linenr, $realcnt, 0);
3035 $stat =~ s/\n./\n /g;
3036 $cond =~ s/\n./\n /g;
3038 #print "linenr<$linenr> <$stat>\n";
3039 # If this statement has no statement boundaries within
3040 # it there is no point in retrying a statement scan
3041 # until we hit end of it.
3042 my $frag = $stat; $frag =~ s/;+\s*$//;
3043 if ($frag !~ /(?:{|;)/) {
3044 #print "skip<$line_nr_next>\n";
3045 $suppress_statement = $line_nr_next;
3048 # Find the real next line.
3049 $realline_next = $line_nr_next;
3050 if (defined $realline_next &&
3051 (!defined $lines[$realline_next - 1] ||
3052 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3059 # Ignore goto labels.
3060 if ($s =~ /$Ident:\*$/s) {
3062 # Ignore functions being called
3063 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
3065 } elsif ($s =~ /^.\s*else\b/s) {
3067 # declarations always start with types
3068 } 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) {
3071 possible
($type, "A:" . $s);
3073 # definitions in global scope can only start with types
3074 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
3075 possible
($1, "B:" . $s);
3078 # any (foo ... *) is a pointer cast, and foo is a type
3079 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
3080 possible
($1, "C:" . $s);
3083 # Check for any sort of function declaration.
3084 # int foo(something bar, other baz);
3085 # void (*store_gdt)(x86_descr_ptr *);
3086 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3087 my ($name_len) = length($1);
3090 substr($ctx, 0, $name_len + 1, '');
3091 $ctx =~ s/\)[^\)]*$//;
3093 for my $arg (split(/\s*,\s*/, $ctx)) {
3094 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3096 possible
($1, "D:" . $s);
3104 # Checks which may be anchored in the context.
3107 # Check for switch () and associated case and default
3108 # statements should be at the same indent.
3109 if ($line=~/\bswitch\s*\(.*\)/) {
3112 my @ctx = ctx_block_outer
($linenr, $realcnt);
3114 for my $ctx (@ctx) {
3115 my ($clen, $cindent) = line_stats
($ctx);
3116 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3117 $indent != $cindent) {
3118 $err .= "$sep$ctx\n";
3125 ERROR
("SWITCH_CASE_INDENT_LEVEL",
3126 "switch and case should be at the same indent\n$hereline$err");
3130 # if/while/etc brace do not go on next line, unless defining a do while loop,
3131 # or if that brace on the next line is for something else
3132 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3133 my $pre_ctx = "$1$2";
3135 my ($level, @ctx) = ctx_statement_level
($linenr, $realcnt, 0);
3137 if ($line =~ /^\+\t{6,}/) {
3138 WARN
("DEEP_INDENTATION",
3139 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3142 my $ctx_cnt = $realcnt - $#ctx - 1;
3143 my $ctx = join("\n", @ctx);
3145 my $ctx_ln = $linenr;
3146 my $ctx_skip = $realcnt;
3148 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3149 defined $lines[$ctx_ln - 1] &&
3150 $lines[$ctx_ln - 1] =~ /^-/)) {
3151 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3152 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
3156 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3157 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3159 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
3161 "that open brace { should be on the previous line\n" .
3162 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3164 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3165 $ctx =~ /\)\s*\;\s*$/ &&
3166 defined $lines[$ctx_ln - 1])
3168 my ($nlength, $nindent) = line_stats
($lines[$ctx_ln - 1]);
3169 if ($nindent > $indent) {
3170 WARN
("TRAILING_SEMICOLON",
3171 "trailing semicolon indicates no statements, indent implies otherwise\n" .
3172 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3177 # Check relative indent for conditionals and blocks.
3178 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3179 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3180 ctx_statement_block
($linenr, $realcnt, 0)
3181 if (!defined $stat);
3182 my ($s, $c) = ($stat, $cond);
3184 substr($s, 0, length($c), '');
3186 # remove inline comments
3190 # Find out how long the conditional actually is.
3191 my @newlines = ($c =~ /\n/gs);
3192 my $cond_lines = 1 + $#newlines;
3194 # Make sure we remove the line prefixes as we have
3195 # none on the first line, and are going to readd them
3198 while ($s =~ /\n\s+\\\n/) {
3199 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3202 # We want to check the first line inside the block
3203 # starting at the end of the conditional, so remove:
3204 # 1) any blank line termination
3205 # 2) any opening brace { on end of the line
3207 my $continuation = 0;
3209 $s =~ s/^.*\bdo\b//;
3211 if ($s =~ s/^\s*\\//) {
3214 if ($s =~ s/^\s*?\n//) {
3219 # Also ignore a loop construct at the end of a
3220 # preprocessor statement.
3221 if (($prevline =~ /^.\s*#\s*define\s/ ||
3222 $prevline =~ /\\\s*$/) && $continuation == 0) {
3228 while ($cond_ptr != $cond_lines) {
3229 $cond_ptr = $cond_lines;
3231 # If we see an #else/#elif then the code
3233 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3238 # 1) blank lines, they should be at 0,
3239 # 2) preprocessor lines, and
3241 if ($continuation ||
3243 $s =~ /^\s*#\s*?/ ||
3244 $s =~ /^\s*$Ident\s*:/) {
3245 $continuation = ($s =~ /^.*?\\\n/) ?
1 : 0;
3246 if ($s =~ s/^.*?\n//) {
3252 my (undef, $sindent) = line_stats
("+" . $s);
3253 my $stat_real = raw_line
($linenr, $cond_lines);
3255 # Check if either of these lines are modified, else
3256 # this is not this patch's fault.
3257 if (!defined($stat_real) ||
3258 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3261 if (defined($stat_real) && $cond_lines > 1) {
3262 $stat_real = "[...]\n$stat_real";
3265 #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";
3267 if ($check && $s ne '' &&
3268 (($sindent % 8) != 0 ||
3269 ($sindent < $indent) ||
3270 ($sindent > $indent + 8))) {
3271 WARN
("SUSPECT_CODE_INDENT",
3272 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3276 # Track the 'values' across context and added lines.
3277 my $opline = $line; $opline =~ s/^./ /;
3278 my ($curr_values, $curr_vars) =
3279 annotate_values
($opline . "\n", $prev_values);
3280 $curr_values = $prev_values . $curr_values;
3282 my $outline = $opline; $outline =~ s/\t/ /g;
3283 print "$linenr > .$outline\n";
3284 print "$linenr > $curr_values\n";
3285 print "$linenr > $curr_vars\n";
3287 $prev_values = substr($curr_values, -1);
3289 #ignore lines not being added
3290 next if ($line =~ /^[^\+]/);
3292 # check for declarations of signed or unsigned without int
3293 while ($line =~ m{($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3296 $var = "" if (!defined $var);
3297 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
3301 $pointer = "" if (!defined $pointer);
3303 if (WARN
("UNSPECIFIED_INT",
3304 "Prefer '" . trim
($sign) . " int" . rtrim
($pointer) . "' to bare use of '$sign" . rtrim
($pointer) . "'\n" . $herecurr) &&
3306 my $decl = trim
($sign) . " int ";
3307 my $comp_pointer = $pointer;
3308 $comp_pointer =~ s/\s//g;
3309 $decl .= $comp_pointer;
3310 $decl = rtrim
($decl) if ($var eq "");
3311 $fixed[$fixlinenr] =~ s
@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
3316 # TEST: allow direct testing of the type matcher.
3318 if ($line =~ /^.\s*$Declare\s*$/) {
3320 "TEST: is type\n" . $herecurr);
3321 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
3322 ERROR
("TEST_NOT_TYPE",
3323 "TEST: is not type ($1 is)\n". $herecurr);
3327 # TEST: allow direct testing of the attribute matcher.
3329 if ($line =~ /^.\s*$Modifier\s*$/) {
3331 "TEST: is attr\n" . $herecurr);
3332 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
3333 ERROR
("TEST_NOT_ATTR",
3334 "TEST: is not attr ($1 is)\n". $herecurr);
3339 # check for initialisation to aggregates open brace on the next line
3340 if ($line =~ /^.\s*{/ &&
3341 $prevline =~ /(?:^|[^=])=\s*$/) {
3342 if (ERROR
("OPEN_BRACE",
3343 "that open brace { should be on the previous line\n" . $hereprev) &&
3344 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3345 fix_delete_line
($fixlinenr - 1, $prevrawline);
3346 fix_delete_line
($fixlinenr, $rawline);
3347 my $fixedline = $prevrawline;
3348 $fixedline =~ s/\s*=\s*$/ = {/;
3349 fix_insert_line
($fixlinenr, $fixedline);
3351 $fixedline =~ s/^(.\s*){\s*/$1/;
3352 fix_insert_line
($fixlinenr, $fixedline);
3357 # Checks which are anchored on the added line.
3360 # check for malformed paths in #include statements (uses RAW line)
3361 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
3363 if ($path =~ m{//}) {
3364 ERROR
("MALFORMED_INCLUDE",
3365 "malformed #include filename\n" . $herecurr);
3367 if ($path =~ "^uapi/" && $realfile =~ m
@\binclude/uapi/@) {
3368 ERROR
("UAPI_INCLUDE",
3369 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
3373 # no C99 // comments
3374 if ($line =~ m{//}) {
3375 if (ERROR
("C99_COMMENTS",
3376 "do not use C99 // comments\n" . $herecurr) &&
3378 my $line = $fixed[$fixlinenr];
3379 if ($line =~ /\/\
/(.*)$/) {
3380 my $comment = trim
($1);
3381 $fixed[$fixlinenr] =~ s
@\/\/(.*)$@/\* $comment \
*/@;
3385 # Remove C99 comments.
3387 $opline =~ s
@//.*@@;
3389 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3390 # the whole statement.
3391 #print "APW <$lines[$realline_next - 1]>\n";
3392 if (defined $realline_next &&
3393 exists $lines[$realline_next - 1] &&
3394 !defined $suppress_export{$realline_next} &&
3395 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3396 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3397 # Handle definitions which produce identifiers with
3400 # EXPORT_SYMBOL(something_foo);
3402 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
3403 $name =~ /^${Ident}_$2/) {
3404 #print "FOO C name<$name>\n";
3405 $suppress_export{$realline_next} = 1;
3407 } elsif ($stat !~ /(?
:
3409 ^.DEFINE_
$Ident\(\Q
$name\E\)|
3410 ^.DECLARE_
$Ident\(\Q
$name\E\)|
3411 ^.LIST_HEAD\
(\Q
$name\E\)|
3412 ^.(?
:$Storage\s+)?
$Type\s*\(\s
*\
*\s
*\Q
$name\E\s*\)\s
*\
(|
3413 \b\Q
$name\E(?
:\s
+$Attribute)*\s
*(?
:;|=|\
[|\
()
3415 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3416 $suppress_export{$realline_next} = 2;
3418 $suppress_export{$realline_next} = 1;
3421 if (!defined $suppress_export{$linenr} &&
3422 $prevline =~ /^.\s*$/ &&
3423 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3424 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3425 #print "FOO B <$lines[$linenr - 1]>\n";
3426 $suppress_export{$linenr} = 2;
3428 if (defined $suppress_export{$linenr} &&
3429 $suppress_export{$linenr} == 2) {
3430 WARN
("EXPORT_SYMBOL",
3431 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
3434 # check for global initialisers.
3435 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
3436 if (ERROR
("GLOBAL_INITIALISERS",
3437 "do not initialise globals to $1\n" . $herecurr) &&
3439 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
3442 # check for static initialisers.
3443 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
3444 if (ERROR
("INITIALISED_STATIC",
3445 "do not initialise statics to $1\n" .
3448 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
3452 # check for misordered declarations of char/short/int/long with signed/unsigned
3453 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3455 WARN
("MISORDERED_TYPE",
3456 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3459 # check for static const char * arrays.
3460 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
3461 WARN
("STATIC_CONST_CHAR_ARRAY",
3462 "static const char * array should probably be static const char * const\n" .
3466 # check for static char foo[] = "bar" declarations.
3467 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
3468 WARN
("STATIC_CONST_CHAR_ARRAY",
3469 "static char array declaration should probably be static const char\n" .
3473 # check for const <foo> const where <foo> is not a pointer or array type
3474 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3476 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3478 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3479 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3481 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3485 # check for non-global char *foo[] = {"bar", ...} declarations.
3486 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3487 WARN
("STATIC_CONST_CHAR_ARRAY",
3488 "char * array declaration might be better as static const\n" .
3492 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3493 if ($line =~ m
@\bsizeof\s*\(\s
*($Lval)\s
*\
)@) {
3495 if ($line =~ m
@\b(sizeof\s
*\
(\s
*\Q
$array\E\s*\)\s
*/\s
*sizeof\s
*\
(\s
*\Q
$array\E\s*\[\s
*0\s
*\
]\s
*\
))@) {
3497 if (WARN
("ARRAY_SIZE",
3498 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3500 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3505 # check for function declarations without arguments like "int foo()"
3506 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3507 if (ERROR
("FUNCTION_WITHOUT_ARGS",
3508 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3510 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
3514 # check for uses of DEFINE_PCI_DEVICE_TABLE
3515 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
3516 if (WARN
("DEFINE_PCI_DEVICE_TABLE",
3517 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
3519 $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
3523 # check for new typedefs, only function parameters and sparse annotations
3525 if ($line =~ /\btypedef\s/ &&
3526 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
3527 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
3528 $line !~ /\b$typeTypedefs\b/ &&
3529 $line !~ /\b__bitwise(?:__|)\b/) {
3530 WARN
("NEW_TYPEDEFS",
3531 "do not add new typedefs\n" . $herecurr);
3534 # * goes on variable not on type
3536 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3538 my ($ident, $from, $to) = ($1, $2, $2);
3540 # Should start with a space.
3541 $to =~ s/^(\S)/ $1/;
3542 # Should not end with a space.
3544 # '*'s should not have spaces between.
3545 while ($to =~ s/\*\s+\*/\*\*/) {
3548 ## print "1: from<$from> to<$to> ident<$ident>\n";
3550 if (ERROR
("POINTER_LOCATION",
3551 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3553 my $sub_from = $ident;
3554 my $sub_to = $ident;
3555 $sub_to =~ s/\Q$from\E/$to/;
3556 $fixed[$fixlinenr] =~
3557 s
@\Q$sub_from\E@$sub_to@;
3561 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3563 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
3565 # Should start with a space.
3566 $to =~ s/^(\S)/ $1/;
3567 # Should not end with a space.
3569 # '*'s should not have spaces between.
3570 while ($to =~ s/\*\s+\*/\*\*/) {
3572 # Modifiers should have spaces.
3573 $to =~ s/(\b$Modifier$)/$1 /;
3575 ## print "2: from<$from> to<$to> ident<$ident>\n";
3576 if ($from ne $to && $ident !~ /^$Modifier$/) {
3577 if (ERROR
("POINTER_LOCATION",
3578 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3581 my $sub_from = $match;
3582 my $sub_to = $match;
3583 $sub_to =~ s/\Q$from\E/$to/;
3584 $fixed[$fixlinenr] =~
3585 s
@\Q$sub_from\E@$sub_to@;
3590 # avoid BUG() or BUG_ON()
3591 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
3592 my $msg_type = \
&WARN
;
3593 $msg_type = \
&CHK
if ($file);
3594 &{$msg_type}("AVOID_BUG",
3595 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3598 # avoid LINUX_VERSION_CODE
3599 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
3600 WARN
("LINUX_VERSION_CODE",
3601 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3604 # check for uses of printk_ratelimit
3605 if ($line =~ /\bprintk_ratelimit\s*\(/) {
3606 WARN
("PRINTK_RATELIMITED",
3607 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
3610 # printk should use KERN_* levels. Note that follow on printk's on the
3611 # same line do not need a level, so we use the current block context
3612 # to try and find and validate the current printk. In summary the current
3613 # printk includes all preceding printk's which have no newline on the end.
3614 # we assume the first bad printk is the one to report.
3615 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
3617 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3618 #print "CHECK<$lines[$ln - 1]\n";
3619 # we have a preceding printk if it ends
3620 # with "\n" ignore it, else it is to blame
3621 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3622 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3629 WARN
("PRINTK_WITHOUT_KERN_LEVEL",
3630 "printk() should include KERN_ facility level\n" . $herecurr);
3634 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3636 my $level = lc($orig);
3637 $level = "warn" if ($level eq "warning");
3638 my $level2 = $level;
3639 $level2 = "dbg" if ($level eq "debug");
3640 WARN
("PREFER_PR_LEVEL",
3641 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
3644 if ($line =~ /\bpr_warning\s*\(/) {
3645 if (WARN
("PREFER_PR_LEVEL",
3646 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3648 $fixed[$fixlinenr] =~
3649 s/\bpr_warning\b/pr_warn/;
3653 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3655 my $level = lc($orig);
3656 $level = "warn" if ($level eq "warning");
3657 $level = "dbg" if ($level eq "debug");
3658 WARN
("PREFER_DEV_LEVEL",
3659 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3662 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
3663 # number of false positives, but assembly files are not checked, so at
3664 # least the arch entry code will not trigger this warning.
3665 if ($line =~ /\bENOSYS\b/) {
3667 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3670 # function brace can't be on same line, except for #defines of do while,
3671 # or if closed on same line
3672 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
3673 !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) {
3674 if (ERROR
("OPEN_BRACE",
3675 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3677 fix_delete_line
($fixlinenr, $rawline);
3678 my $fixed_line = $rawline;
3679 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3682 fix_insert_line
($fixlinenr, ltrim
($line1));
3683 fix_insert_line
($fixlinenr, "\+{");
3684 if ($line2 !~ /^\s*$/) {
3685 fix_insert_line
($fixlinenr, "\+\t" . trim
($line2));
3690 # open braces for enum, union and struct go on the same line.
3691 if ($line =~ /^.\s*{/ &&
3692 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
3693 if (ERROR
("OPEN_BRACE",
3694 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3695 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3696 fix_delete_line
($fixlinenr - 1, $prevrawline);
3697 fix_delete_line
($fixlinenr, $rawline);
3698 my $fixedline = rtrim
($prevrawline) . " {";
3699 fix_insert_line
($fixlinenr, $fixedline);
3700 $fixedline = $rawline;
3701 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3702 if ($fixedline !~ /^\+\s*$/) {
3703 fix_insert_line
($fixlinenr, $fixedline);
3708 # missing space after union, struct or enum definition
3709 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3711 "missing space after $1 definition\n" . $herecurr) &&
3713 $fixed[$fixlinenr] =~
3714 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3718 # Function pointer declarations
3719 # check spacing between type, funcptr, and args
3720 # canonical declaration is "type (*funcptr)(args...)"
3721 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
3723 my $pre_pointer_space = $2;
3724 my $post_pointer_space = $3;
3726 my $post_funcname_space = $5;
3727 my $pre_args_space = $6;
3729 # the $Declare variable will capture all spaces after the type
3730 # so check it for a missing trailing missing space but pointer return types
3731 # don't need a space so don't warn for those.
3732 my $post_declare_space = "";
3733 if ($declare =~ /(\s+)$/) {
3734 $post_declare_space = $1;
3735 $declare = rtrim
($declare);
3737 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
3739 "missing space after return type\n" . $herecurr);
3740 $post_declare_space = " ";
3743 # unnecessary space "type (*funcptr)(args...)"
3744 # This test is not currently implemented because these declarations are
3746 # int foo(int bar, ...)
3747 # and this is form shouldn't/doesn't generate a checkpatch warning.
3749 # elsif ($declare =~ /\s{2,}$/) {
3751 # "Multiple spaces after return type\n" . $herecurr);
3754 # unnecessary space "type ( *funcptr)(args...)"
3755 if (defined $pre_pointer_space &&
3756 $pre_pointer_space =~ /^\s/) {
3758 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3761 # unnecessary space "type (* funcptr)(args...)"
3762 if (defined $post_pointer_space &&
3763 $post_pointer_space =~ /^\s/) {
3765 "Unnecessary space before function pointer name\n" . $herecurr);
3768 # unnecessary space "type (*funcptr )(args...)"
3769 if (defined $post_funcname_space &&
3770 $post_funcname_space =~ /^\s/) {
3772 "Unnecessary space after function pointer name\n" . $herecurr);
3775 # unnecessary space "type (*funcptr) (args...)"
3776 if (defined $pre_args_space &&
3777 $pre_args_space =~ /^\s/) {
3779 "Unnecessary space before function pointer arguments\n" . $herecurr);
3782 if (show_type
("SPACING") && $fix) {
3783 $fixed[$fixlinenr] =~
3784 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3788 # check for spacing round square brackets; allowed:
3789 # 1. with a type on the left -- int [] a;
3790 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3791 # 3. inside a curly brace -- = { [0...10] = 5 }
3792 while ($line =~ /(.*?\s)\[/g) {
3793 my ($where, $prefix) = ($-[1], $1);
3794 if ($prefix !~ /$Type\s+$/ &&
3795 ($where != 0 || $prefix !~ /^.\s+$/) &&
3796 $prefix !~ /[{,]\s+$/) {
3797 if (ERROR
("BRACKET_SPACE",
3798 "space prohibited before open square bracket '['\n" . $herecurr) &&
3800 $fixed[$fixlinenr] =~
3801 s/^(\+.*?)\s+\[/$1\[/;
3806 # check for spaces between functions and their parentheses.
3807 while ($line =~ /($Ident)\s+\(/g) {
3809 my $ctx_before = substr($line, 0, $-[1]);
3810 my $ctx = "$ctx_before$name";
3812 # Ignore those directives where spaces _are_ permitted.
3814 if|for|while|switch
|return|case
|
3815 volatile
|__volatile__
|
3816 __attribute__
|format
|__extension__
|
3819 # cpp #define statements have non-optional spaces, ie
3820 # if there is a space between the name and the open
3821 # parenthesis it is simply not a parameter group.
3822 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
3824 # cpp #elif statement condition may start with a (
3825 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
3827 # If this whole things ends with a type its most
3828 # likely a typedef for a function.
3829 } elsif ($ctx =~ /$Type$/) {
3833 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3835 $fixed[$fixlinenr] =~
3836 s/\b$name\s+\(/$name\(/;
3841 # Check operator spacing.
3842 if (!($line=~/\#\s*include/)) {
3843 my $fixed_line = "";
3847 <<=|>>=|<=|>=|==|!=|
3848 \
+=|-=|\
*=|\
/=|%=|\
^=|\
|=|&=|
3849 =>|->|<<|>>|<|>|=|!|~|
3850 &&|\
|\
||,|\
^|\
+\
+|--|&|\
||\
+|-|\
*|\
/|%|
3853 my @elements = split(/($ops|;)/, $opline);
3855 ## print("element count: <" . $#elements . ">\n");
3856 ## foreach my $el (@elements) {
3857 ## print("el: <$el>\n");
3860 my @fix_elements = ();
3863 foreach my $el (@elements) {
3864 push(@fix_elements, substr($rawline, $off, length($el)));
3865 $off += length($el);
3870 my $blank = copy_spacing
($opline);
3871 my $last_after = -1;
3873 for (my $n = 0; $n < $#elements; $n += 2) {
3875 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3877 ## print("n: <$n> good: <$good>\n");
3879 $off += length($elements[$n]);
3881 # Pick up the preceding and succeeding characters.
3882 my $ca = substr($opline, 0, $off);
3884 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3885 $cc = substr($opline, $off + length($elements[$n + 1]));
3887 my $cb = "$ca$;$cc";
3890 $a = 'V' if ($elements[$n] ne '');
3891 $a = 'W' if ($elements[$n] =~ /\s$/);
3892 $a = 'C' if ($elements[$n] =~ /$;$/);
3893 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3894 $a = 'O' if ($elements[$n] eq '');
3895 $a = 'E' if ($ca =~ /^\s*$/);
3897 my $op = $elements[$n + 1];
3900 if (defined $elements[$n + 2]) {
3901 $c = 'V' if ($elements[$n + 2] ne '');
3902 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
3903 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
3904 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3905 $c = 'O' if ($elements[$n + 2] eq '');
3906 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
3911 my $ctx = "${a}x${c}";
3913 my $at = "(ctx:$ctx)";
3915 my $ptr = substr($blank, 0, $off) . "^";
3916 my $hereptr = "$hereline$ptr\n";
3918 # Pull out the value of this operator.
3919 my $op_type = substr($curr_values, $off + 1, 1);
3921 # Get the full operator variant.
3922 my $opv = $op . substr($curr_vars, $off, 1);
3924 # Ignore operators passed as parameters.
3925 if ($op_type ne 'V' &&
3926 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
3929 # } elsif ($op =~ /^$;+$/) {
3931 # ; should have either the end of line or a space or \ after it
3932 } elsif ($op eq ';') {
3933 if ($ctx !~ /.x[WEBC]/ &&
3934 $cc !~ /^\\/ && $cc !~ /^;/) {
3935 if (ERROR
("SPACING",
3936 "space required after that '$op' $at\n" . $hereptr)) {
3937 $good = $fix_elements[$n] . trim
($fix_elements[$n + 1]) . " ";
3943 } elsif ($op eq '//') {
3945 # : when part of a bitfield
3946 } elsif ($opv eq ':B') {
3947 # skip the bitfield test for now
3951 } elsif ($op eq '->') {
3952 if ($ctx =~ /Wx.|.xW/) {
3953 if (ERROR
("SPACING",
3954 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
3955 $good = rtrim
($fix_elements[$n]) . trim
($fix_elements[$n + 1]);
3956 if (defined $fix_elements[$n + 2]) {
3957 $fix_elements[$n + 2] =~ s/^\s+//;
3963 # , must not have a space before and must have a space on the right.
3964 } elsif ($op eq ',') {
3965 my $rtrim_before = 0;
3966 my $space_after = 0;
3967 if ($ctx =~ /Wx./) {
3968 if (ERROR
("SPACING",
3969 "space prohibited before that '$op' $at\n" . $hereptr)) {
3974 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
3975 if (ERROR
("SPACING",
3976 "space required after that '$op' $at\n" . $hereptr)) {
3982 if ($rtrim_before || $space_after) {
3983 if ($rtrim_before) {
3984 $good = rtrim
($fix_elements[$n]) . trim
($fix_elements[$n + 1]);
3986 $good = $fix_elements[$n] . trim
($fix_elements[$n + 1]);
3993 # '*' as part of a type definition -- reported already.
3994 } elsif ($opv eq '*_') {
3995 #warn "'*' is part of type\n";
3997 # unary operators should have a space before and
3998 # none after. May be left adjacent to another
3999 # unary operator, or a cast
4000 } elsif ($op eq '!' || $op eq '~' ||
4001 $opv eq '*U' || $opv eq '-U' ||
4002 $opv eq '&U' || $opv eq '&&U') {
4003 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
4004 if (ERROR
("SPACING",
4005 "space required before that '$op' $at\n" . $hereptr)) {
4006 if ($n != $last_after + 2) {
4007 $good = $fix_elements[$n] . " " . ltrim
($fix_elements[$n + 1]);
4012 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
4013 # A unary '*' may be const
4015 } elsif ($ctx =~ /.xW/) {
4016 if (ERROR
("SPACING",
4017 "space prohibited after that '$op' $at\n" . $hereptr)) {
4018 $good = $fix_elements[$n] . rtrim
($fix_elements[$n + 1]);
4019 if (defined $fix_elements[$n + 2]) {
4020 $fix_elements[$n + 2] =~ s/^\s+//;
4026 # unary ++ and unary -- are allowed no space on one side.
4027 } elsif ($op eq '++' or $op eq '--') {
4028 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
4029 if (ERROR
("SPACING",
4030 "space required one side of that '$op' $at\n" . $hereptr)) {
4031 $good = $fix_elements[$n] . trim
($fix_elements[$n + 1]) . " ";
4035 if ($ctx =~ /Wx[BE]/ ||
4036 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
4037 if (ERROR
("SPACING",
4038 "space prohibited before that '$op' $at\n" . $hereptr)) {
4039 $good = rtrim
($fix_elements[$n]) . trim
($fix_elements[$n + 1]);
4043 if ($ctx =~ /ExW/) {
4044 if (ERROR
("SPACING",
4045 "space prohibited after that '$op' $at\n" . $hereptr)) {
4046 $good = $fix_elements[$n] . trim
($fix_elements[$n + 1]);
4047 if (defined $fix_elements[$n + 2]) {
4048 $fix_elements[$n + 2] =~ s/^\s+//;
4054 # << and >> may either have or not have spaces both sides
4055 } elsif ($op eq '<<' or $op eq '>>' or
4056 $op eq '&' or $op eq '^' or $op eq '|' or
4057 $op eq '+' or $op eq '-' or
4058 $op eq '*' or $op eq '/' or
4062 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4064 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4065 $good = rtrim
($fix_elements[$n]) . " " . trim
($fix_elements[$n + 1]) . " ";
4066 $fix_elements[$n + 2] =~ s/^\s+//;
4069 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4071 "space preferred before that '$op' $at\n" . $hereptr)) {
4072 $good = rtrim
($fix_elements[$n]) . " " . trim
($fix_elements[$n + 1]);
4076 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
4077 if (ERROR
("SPACING",
4078 "need consistent spacing around '$op' $at\n" . $hereptr)) {
4079 $good = rtrim
($fix_elements[$n]) . " " . trim
($fix_elements[$n + 1]) . " ";
4080 if (defined $fix_elements[$n + 2]) {
4081 $fix_elements[$n + 2] =~ s/^\s+//;
4087 # A colon needs no spaces before when it is
4088 # terminating a case value or a label.
4089 } elsif ($opv eq ':C' || $opv eq ':L') {
4090 if ($ctx =~ /Wx./) {
4091 if (ERROR
("SPACING",
4092 "space prohibited before that '$op' $at\n" . $hereptr)) {
4093 $good = rtrim
($fix_elements[$n]) . trim
($fix_elements[$n + 1]);
4098 # All the others need spaces both sides.
4099 } elsif ($ctx !~ /[EWC]x[CWE]/) {
4102 # Ignore email addresses <foo@bar>
4104 $cc =~ /^\S+\@\S+>/) ||
4106 $ca =~ /<\S+\@\S+$/))
4111 # for asm volatile statements
4112 # ignore a colon with another
4113 # colon immediately before or after
4115 ($ca =~ /:$/ || $cc =~ /^:/)) {
4119 # messages are ERROR, but ?: are CHK
4121 my $msg_type = \
&ERROR
;
4122 $msg_type = \
&CHK
if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4124 if (&{$msg_type}("SPACING",
4125 "spaces required around that '$op' $at\n" . $hereptr)) {
4126 $good = rtrim
($fix_elements[$n]) . " " . trim
($fix_elements[$n + 1]) . " ";
4127 if (defined $fix_elements[$n + 2]) {
4128 $fix_elements[$n + 2] =~ s/^\s+//;
4134 $off += length($elements[$n + 1]);
4136 ## print("n: <$n> GOOD: <$good>\n");
4138 $fixed_line = $fixed_line . $good;
4141 if (($#elements % 2) == 0) {
4142 $fixed_line = $fixed_line . $fix_elements[$#elements];
4145 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4146 $fixed[$fixlinenr] = $fixed_line;
4152 # check for whitespace before a non-naked semicolon
4153 if ($line =~ /^\+.*\S\s+;\s*$/) {
4155 "space prohibited before semicolon\n" . $herecurr) &&
4157 1 while $fixed[$fixlinenr] =~
4158 s/^(\+.*\S)\s+;/$1;/;
4162 # check for multiple assignments
4163 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
4164 CHK
("MULTIPLE_ASSIGNMENTS",
4165 "multiple assignments should be avoided\n" . $herecurr);
4168 ## # check for multiple declarations, allowing for a function declaration
4170 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4171 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4173 ## # Remove any bracketed sections to ensure we do not
4174 ## # falsly report the parameters of functions.
4176 ## while ($ln =~ s/\([^\(\)]*\)//g) {
4178 ## if ($ln =~ /,/) {
4179 ## WARN("MULTIPLE_DECLARATION",
4180 ## "declaring multiple variables together should be avoided\n" . $herecurr);
4184 #need space before brace following if, while, etc
4185 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
4187 if (ERROR
("SPACING",
4188 "space required before the open brace '{'\n" . $herecurr) &&
4190 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
4194 ## # check for blank lines before declarations
4195 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4196 ## $prevrawline =~ /^.\s*$/) {
4198 ## "No blank lines before declarations\n" . $hereprev);
4202 # closing brace should have a space following it when it has anything
4204 if ($line =~ /}(?!(?:,|;|\)))\S/) {
4205 if (ERROR
("SPACING",
4206 "space required after that close brace '}'\n" . $herecurr) &&
4208 $fixed[$fixlinenr] =~
4209 s/}((?!(?:,|;|\)))\S)/} $1/;
4213 # check spacing on square brackets
4214 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
4215 if (ERROR
("SPACING",
4216 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4218 $fixed[$fixlinenr] =~
4222 if ($line =~ /\s\]/) {
4223 if (ERROR
("SPACING",
4224 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4226 $fixed[$fixlinenr] =~
4231 # check spacing on parentheses
4232 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4233 $line !~ /for\s*\(\s+;/) {
4234 if (ERROR
("SPACING",
4235 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4237 $fixed[$fixlinenr] =~
4241 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
4242 $line !~ /for\s*\(.*;\s+\)/ &&
4243 $line !~ /:\s+\)/) {
4244 if (ERROR
("SPACING",
4245 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4247 $fixed[$fixlinenr] =~
4252 # check unnecessary parentheses around addressof/dereference single $Lvals
4253 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4255 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
4257 if (CHK
("UNNECESSARY_PARENTHESES",
4258 "Unnecessary parentheses around $var\n" . $herecurr) &&
4260 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4264 # check for unnecessary parentheses around function pointer uses
4265 # ie: (foo->bar)(); should be foo->bar();
4266 # but not "if (foo->bar) (" to avoid some false positives
4267 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4269 if (CHK
("UNNECESSARY_PARENTHESES",
4270 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4272 my $var2 = deparenthesize
($var);
4274 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4278 #goto labels aren't indented, allow a single space however
4279 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
4280 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
4281 if (WARN
("INDENTED_LABEL",
4282 "labels should not be indented\n" . $herecurr) &&
4284 $fixed[$fixlinenr] =~
4289 # return is not a function
4290 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
4292 if ($^V && $^V ge 5.10.0 &&
4293 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4295 $value = deparenthesize
($value);
4296 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4297 ERROR
("RETURN_PARENTHESES",
4298 "return is not a function, parentheses are not required\n" . $herecurr);
4300 } elsif ($spacing !~ /\s+/) {
4302 "space required before the open parenthesis '('\n" . $herecurr);
4306 # unnecessary return in a void function
4307 # at end-of-function, with the previous line a single leading tab, then return;
4308 # and the line before that not a goto label target like "out:"
4309 if ($sline =~ /^[ \+]}\s*$/ &&
4310 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4312 $lines[$linenr - 3] =~ /^[ +]/ &&
4313 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
4315 "void function return statements are not generally useful\n" . $hereprev);
4318 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4319 if ($^V && $^V ge 5.10.0 &&
4320 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4321 my $openparens = $1;
4322 my $count = $openparens =~ tr
@\(@\(@;
4324 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4325 my $comp = $4; #Not $1 because of $LvalOrFunc
4326 $msg = " - maybe == should be = ?" if ($comp eq "==");
4327 WARN
("UNNECESSARY_PARENTHESES",
4328 "Unnecessary parentheses$msg\n" . $herecurr);
4332 # comparisons with a constant or upper case identifier on the left
4333 # avoid cases like "foo + BAR < baz"
4334 # only fix matches surrounded by parentheses to avoid incorrect
4335 # conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4336 if ($^V && $^V ge 5.10.0 &&
4337 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4342 my $newcomp = $comp;
4343 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
4344 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4345 WARN
("CONSTANT_COMPARISON",
4346 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4350 } elsif ($comp eq "<=") {
4352 } elsif ($comp eq ">") {
4354 } elsif ($comp eq ">=") {
4357 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4361 # Return of what appears to be an errno should normally be negative
4362 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
4364 if ($name ne 'EOF' && $name ne 'ERROR') {
4365 WARN
("USE_NEGATIVE_ERRNO",
4366 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
4370 # Need a space before open parenthesis after if, while etc
4371 if ($line =~ /\b(if|while|for|switch)\(/) {
4372 if (ERROR
("SPACING",
4373 "space required before the open parenthesis '('\n" . $herecurr) &&
4375 $fixed[$fixlinenr] =~
4376 s/\b(if|while|for|switch)\(/$1 \(/;
4380 # Check for illegal assignment in if conditional -- and check for trailing
4381 # statements after the conditional.
4382 if ($line =~ /do\s*(?!{)/) {
4383 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4384 ctx_statement_block
($linenr, $realcnt, 0)
4385 if (!defined $stat);
4386 my ($stat_next) = ctx_statement_block
($line_nr_next,
4387 $remain_next, $off_next);
4388 $stat_next =~ s/\n./\n /g;
4389 ##print "stat<$stat> stat_next<$stat_next>\n";
4391 if ($stat_next =~ /^\s*while\b/) {
4392 # If the statement carries leading newlines,
4393 # then count those as offsets.
4395 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4397 statement_rawlines
($whitespace) - 1;
4399 $suppress_whiletrailers{$line_nr_next +
4403 if (!defined $suppress_whiletrailers{$linenr} &&
4404 defined($stat) && defined($cond) &&
4405 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
4406 my ($s, $c) = ($stat, $cond);
4408 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
4409 ERROR
("ASSIGN_IN_IF",
4410 "do not use assignment in if condition\n" . $herecurr);
4413 # Find out what is on the end of the line after the
4415 substr($s, 0, length($c), '');
4417 $s =~ s/$;//g; # Remove any comments
4418 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4419 $c !~ /}\s*while\s*/)
4421 # Find out how long the conditional actually is.
4422 my @newlines = ($c =~ /\n/gs);
4423 my $cond_lines = 1 + $#newlines;
4426 $stat_real = raw_line
($linenr, $cond_lines)
4427 . "\n" if ($cond_lines);
4428 if (defined($stat_real) && $cond_lines > 1) {
4429 $stat_real = "[...]\n$stat_real";
4432 ERROR
("TRAILING_STATEMENTS",
4433 "trailing statements should be on next line\n" . $herecurr . $stat_real);
4437 # Check for bitwise tests written as boolean
4449 WARN
("HEXADECIMAL_BOOLEAN_TEST",
4450 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
4453 # if and else should not have general statements after it
4454 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4456 $s =~ s/$;//g; # Remove any comments
4457 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
4458 ERROR
("TRAILING_STATEMENTS",
4459 "trailing statements should be on next line\n" . $herecurr);
4462 # if should not continue a brace
4463 if ($line =~ /}\s*if\b/) {
4464 ERROR
("TRAILING_STATEMENTS",
4465 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
4468 # case and default should not have general statements after them
4469 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4471 (?
:\s
*$;*)(?
:\s
*{)?
(?
:\s
*$;*)(?
:\s
*\\)?\s
*$|
4475 ERROR
("TRAILING_STATEMENTS",
4476 "trailing statements should be on next line\n" . $herecurr);
4479 # Check for }<nl>else {, these must be at the same
4480 # indent level to be relevant to each other.
4481 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4482 $previndent == $indent) {
4483 if (ERROR
("ELSE_AFTER_BRACE",
4484 "else should follow close brace '}'\n" . $hereprev) &&
4485 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4486 fix_delete_line
($fixlinenr - 1, $prevrawline);
4487 fix_delete_line
($fixlinenr, $rawline);
4488 my $fixedline = $prevrawline;
4489 $fixedline =~ s/}\s*$//;
4490 if ($fixedline !~ /^\+\s*$/) {
4491 fix_insert_line
($fixlinenr, $fixedline);
4493 $fixedline = $rawline;
4494 $fixedline =~ s/^(.\s*)else/$1} else/;
4495 fix_insert_line
($fixlinenr, $fixedline);
4499 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4500 $previndent == $indent) {
4501 my ($s, $c) = ctx_statement_block
($linenr, $realcnt, 0);
4503 # Find out what is on the end of the line after the
4505 substr($s, 0, length($c), '');
4508 if ($s =~ /^\s*;/) {
4509 if (ERROR
("WHILE_AFTER_BRACE",
4510 "while should follow close brace '}'\n" . $hereprev) &&
4511 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4512 fix_delete_line
($fixlinenr - 1, $prevrawline);
4513 fix_delete_line
($fixlinenr, $rawline);
4514 my $fixedline = $prevrawline;
4515 my $trailing = $rawline;
4516 $trailing =~ s/^\+//;
4517 $trailing = trim
($trailing);
4518 $fixedline =~ s/}\s*$/} $trailing/;
4519 fix_insert_line
($fixlinenr, $fixedline);
4524 #Specific variable tests
4525 while ($line =~ m{($Constant|$Lval)}g) {
4528 #gcc binary extension
4529 if ($var =~ /^$Binary$/) {
4530 if (WARN
("GCC_BINARY_CONSTANT",
4531 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4533 my $hexval = sprintf("0x%x", oct($var));
4534 $fixed[$fixlinenr] =~
4535 s/\b$var\b/$hexval/;
4540 if ($var !~ /^$Constant$/ &&
4541 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
4542 #Ignore Page<foo> variants
4543 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
4544 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4545 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4546 #Ignore some three character SI units explicitly, like MiB and KHz
4547 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
4548 while ($var =~ m{($Ident)}g) {
4550 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
4552 seed_camelcase_includes
();
4553 if (!$file && !$camelcase_file_seeded) {
4554 seed_camelcase_file
($realfile);
4555 $camelcase_file_seeded = 1;
4558 if (!defined $camelcase{$word}) {
4559 $camelcase{$word} = 1;
4561 "Avoid CamelCase: <$word>\n" . $herecurr);
4567 #no spaces allowed after \ in define
4568 if ($line =~ /\#\s*define.*\\\s+$/) {
4569 if (WARN
("WHITESPACE_AFTER_LINE_CONTINUATION",
4570 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4572 $fixed[$fixlinenr] =~ s/\s+$//;
4576 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4577 # itself <asm/foo.h> (uses RAW line)
4578 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
4580 my $checkfile = "include/linux/$file";
4581 if (-f
"$root/$checkfile" &&
4582 $realfile ne $checkfile &&
4583 $1 !~ /$allowed_asm_includes/)
4585 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4586 if ($asminclude > 0) {
4587 if ($realfile =~ m{^arch/}) {
4588 CHK("ARCH_INCLUDE_LINUX",
4589 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4591 WARN("INCLUDE_LINUX",
4592 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4598 # multi-statement macros should be enclosed in a do while loop, grab the
4599 # first statement and ensure its the whole macro if its not enclosed
4600 # in a known good container
4601 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4602 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
4605 my ($off, $dstat, $dcond, $rest);
4607 my $has_flow_statement = 0;
4608 my $has_arg_concat = 0;
4609 ($dstat, $dcond, $ln, $cnt, $off) =
4610 ctx_statement_block($linenr, $realcnt, 0);
4612 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4613 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4615 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
4616 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
4618 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
4620 $dstat =~ s/\\\n.//g;
4621 $dstat =~ s/^\s*//s;
4622 $dstat =~ s/\s*$//s;
4624 # Flatten any parentheses and braces
4625 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4626 $dstat =~ s/\{[^\{\}]*\}/1/ ||
4627 $dstat =~ s/.\[[^\[\]]*\]/1/)
4631 # Flatten any obvious string concatentation.
4632 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4633 $dstat =~ s/$Ident\s*($String)/$1/)
4637 # Make asm volatile uses seem like a generic function
4638 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
4640 my $exceptions = qr{
4653 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4655 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4656 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
4657 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4658 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
4659 $dstat !~ /$exceptions/ &&
4660 $dstat !~ /^\.$Ident\s*=/ && # .foo =
4661 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
4662 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
4663 $dstat !~ /^for\s*$Constant$/ && # for (...)
4664 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4665 $dstat !~ /^do\s*{/ && # do {...
4666 $dstat !~ /^\(\{/ && # ({...
4667 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
4670 my $herectx = $here . "\n";
4671 my $cnt = statement_rawlines($ctx);
4673 for (my $n = 0; $n < $cnt; $n++) {
4674 $herectx .= raw_line($linenr, $n) . "\n";
4677 if ($dstat =~ /;/) {
4678 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4679 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4681 ERROR("COMPLEX_MACRO",
4682 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
4686 # check for macros with flow control, but without ## concatenation
4687 # ## concatenation is commonly a macro that defines a function so ignore those
4688 if ($has_flow_statement && !$has_arg_concat) {
4689 my $herectx = $here . "\n";
4690 my $cnt = statement_rawlines($ctx);
4692 for (my $n = 0; $n < $cnt; $n++) {
4693 $herectx .= raw_line($linenr, $n) . "\n";
4695 WARN("MACRO_WITH_FLOW_CONTROL",
4696 "Macros with flow control statements should be avoided\n" . "$herectx");
4699 # check for line continuations outside of #defines, preprocessor #, and asm
4702 if ($prevline !~ /^..*\\$/ &&
4703 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4704 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
4705 $line =~ /^\+.*\\$/) {
4706 WARN("LINE_CONTINUATIONS",
4707 "Avoid unnecessary line continuations\n" . $herecurr);
4711 # do {} while (0) macro tests:
4712 # single-statement macros do not need to be enclosed in do while (0) loop,
4713 # macro should not end with a semicolon
4714 if ($^V && $^V ge 5.10.0 &&
4715 $realfile !~ m@/vmlinux.lds.h$@ &&
4716 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4719 my ($off, $dstat, $dcond, $rest);
4721 ($dstat, $dcond, $ln, $cnt, $off) =
4722 ctx_statement_block($linenr, $realcnt, 0);
4725 $dstat =~ s/\\\n.//g;
4728 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4733 my $cnt = statement_rawlines($ctx);
4734 my $herectx = $here . "\n";
4736 for (my $n = 0; $n < $cnt; $n++) {
4737 $herectx .= raw_line($linenr, $n) . "\n";
4740 if (($stmts =~ tr/;/;/) == 1 &&
4741 $stmts !~ /^\s*(if|while|for|switch)\b/) {
4742 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4743 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4745 if (defined $semis && $semis ne "") {
4746 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4747 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4749 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4751 my $cnt = statement_rawlines($ctx);
4752 my $herectx = $here . "\n";
4754 for (my $n = 0; $n < $cnt; $n++) {
4755 $herectx .= raw_line($linenr, $n) . "\n";
4758 WARN("TRAILING_SEMICOLON",
4759 "macros should not use a trailing semicolon\n" . "$herectx");
4763 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4764 # all assignments may have only one of the following with an assignment:
4767 # VMLINUX_SYMBOL(...)
4768 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
4769 WARN("MISSING_VMLINUX_SYMBOL",
4770 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
4773 # check for redundant bracing round if etc
4774 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4775 my ($level, $endln, @chunks) =
4776 ctx_statement_full($linenr, $realcnt, 1);
4777 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
4778 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4779 if ($#chunks > 0 && $level == 0) {
4783 my $herectx = $here . "\n";
4784 my $ln = $linenr - 1;
4785 for my $chunk (@chunks) {
4786 my ($cond, $block) = @{$chunk};
4788 # If the condition carries leading newlines, then count those as offsets.
4789 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4790 my $offset = statement_rawlines($whitespace) - 1;
4792 $allowed[$allow] = 0;
4793 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4795 # We have looked at and allowed this specific line.
4796 $suppress_ifbraces{$ln + $offset} = 1;
4798 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
4799 $ln += statement_rawlines($block) - 1;
4801 substr($block, 0, length($cond), '');
4803 $seen++ if ($block =~ /^\s*{/);
4805 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
4806 if (statement_lines($cond) > 1) {
4807 #print "APW: ALLOWED: cond<$cond>\n";
4808 $allowed[$allow] = 1;
4810 if ($block =~/\b(?:if|for|while)\b/) {
4811 #print "APW: ALLOWED: block<$block>\n";
4812 $allowed[$allow] = 1;
4814 if (statement_block_size($block) > 1) {
4815 #print "APW: ALLOWED: lines block<$block>\n";
4816 $allowed[$allow] = 1;
4821 my $sum_allowed = 0;
4822 foreach (@allowed) {
4825 if ($sum_allowed == 0) {
4827 "braces {} are not necessary for any arm of this statement\n" . $herectx);
4828 } elsif ($sum_allowed != $allow &&
4831 "braces {} should be used on all arms of this statement\n" . $herectx);
4836 if (!defined $suppress_ifbraces{$linenr - 1} &&
4837 $line =~ /\b(if|while|for|else)\b/) {
4840 # Check the pre-context.
4841 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
4842 #print "APW: ALLOWED: pre<$1>\n";
4846 my ($level, $endln, @chunks) =
4847 ctx_statement_full($linenr, $realcnt, $-[0]);
4849 # Check the condition.
4850 my ($cond, $block) = @{$chunks[0]};
4851 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
4852 if (defined $cond) {
4853 substr($block, 0, length($cond), '');
4855 if (statement_lines($cond) > 1) {
4856 #print "APW: ALLOWED: cond<$cond>\n";
4859 if ($block =~/\b(?:if|for|while)\b/) {
4860 #print "APW: ALLOWED: block<$block>\n";
4863 if (statement_block_size($block) > 1) {
4864 #print "APW: ALLOWED: lines block<$block>\n";
4867 # Check the post-context.
4868 if (defined $chunks[1]) {
4869 my ($cond, $block) = @{$chunks[1]};
4870 if (defined $cond) {
4871 substr($block, 0, length($cond), '');
4873 if ($block =~ /^\s*\{/) {
4874 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4878 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
4879 my $herectx = $here . "\n";
4880 my $cnt = statement_rawlines($block);
4882 for (my $n = 0; $n < $cnt; $n++) {
4883 $herectx .= raw_line($linenr, $n) . "\n";
4887 "braces {} are not necessary for single statement blocks\n" . $herectx);
4891 # check for unnecessary blank lines around braces
4892 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
4894 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
4895 $fix && $prevrawline =~ /^\+/) {
4896 fix_delete_line($fixlinenr - 1, $prevrawline);
4899 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
4901 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
4903 fix_delete_line($fixlinenr, $rawline);
4907 # no volatiles please
4908 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
4909 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
4911 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
4914 # Check for user-visible strings broken across lines, which breaks the ability
4915 # to grep for the string. Make exceptions when the previous string ends in a
4916 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
4917 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
4918 if ($line =~ /^\+\s*$String/ &&
4919 $prevline =~ /"\s*$/ &&
4920 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
4921 if (WARN("SPLIT_STRING",
4922 "quoted string split across lines\n" . $hereprev) &&
4924 $prevrawline =~ /^\+.*"\s*$/ &&
4925 $last_coalesced_string_linenr != $linenr - 1) {
4926 my $extracted_string = get_quoted_string($line, $rawline);
4927 my $comma_close = "";
4928 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
4932 fix_delete_line($fixlinenr - 1, $prevrawline);
4933 fix_delete_line($fixlinenr, $rawline);
4934 my $fixedline = $prevrawline;
4935 $fixedline =~ s/"\s*$//;
4936 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
4937 fix_insert_line($fixlinenr - 1, $fixedline);
4938 $fixedline = $rawline;
4939 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
4940 if ($fixedline !~ /\+\s*$/) {
4941 fix_insert_line($fixlinenr, $fixedline);
4943 $last_coalesced_string_linenr = $linenr;
4947 # check for missing a space in a string concatenation
4948 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
4949 WARN('MISSING_SPACE',
4950 "break quoted strings at a space character\n" . $hereprev);
4953 # check for spaces before a quoted newline
4954 if ($rawline =~ /^.*\".*\s\\n/) {
4955 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
4956 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
4958 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
4963 # concatenated string without spaces between elements
4964 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
4965 CHK("CONCATENATED_STRING",
4966 "Concatenated strings should use spaces between elements\n" . $herecurr);
4969 # uncoalesced string fragments
4970 if ($line =~ /$String\s*"/) {
4971 WARN("STRING_FRAGMENTS",
4972 "Consecutive strings are generally better as a single string\n" . $herecurr);
4975 # check for %L{u,d,i} and 0x%[udi] in strings
4977 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4978 $string = substr($rawline, $-[1], $+[1] - $-[1]);
4979 $string =~ s/%%/__/g;
4980 if ($string =~ /(?<!%)%[\*\d\.\$]*L[udi]/) {
4982 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
4985 if ($string =~ /0x%[\*\d\.\$\Llzth]*[udi]/) {
4986 ERROR("PRINTF_0xDECIMAL",
4987 "Prefixing 0x with decimal output is defective\n" . $herecurr);
4991 # check for line continuations in quoted strings with odd counts of "
4992 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
4993 WARN("LINE_CONTINUATIONS",
4994 "Avoid line continuations in quoted strings\n" . $herecurr);
4998 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
4999 CHK("REDUNDANT_CODE",
5000 "if this code is redundant consider removing it\n" .
5004 # check for needless "if (<foo>) fn(<foo>)" uses
5005 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
5006 my $tested = quotemeta($1);
5007 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5008 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5010 if (WARN('NEEDLESS_IF',
5011 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5014 my $leading_tabs = "";
5015 my $new_leading_tabs = "";
5016 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5021 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5022 $new_leading_tabs = $1;
5023 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5030 fix_delete_line($fixlinenr - 1, $prevrawline);
5031 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5037 # check for unnecessary "Out of Memory" messages
5038 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5039 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5040 (defined $1 || defined $3) &&
5043 my $testline = $lines[$linenr - 3];
5045 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5046 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5048 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
5050 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5054 # check for logging functions with KERN_<LEVEL>
5055 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
5056 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5058 if (WARN("UNNECESSARY_KERN_LEVEL",
5059 "Possible unnecessary $level\n" . $herecurr) &&
5061 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5065 # check for mask then right shift without a parentheses
5066 if ($^V && $^V ge 5.10.0 &&
5067 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5068 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5069 WARN("MASK_THEN_SHIFT",
5070 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5073 # check for pointer comparisons to NULL
5074 if ($^V && $^V ge 5.10.0) {
5075 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5078 $equal = "" if ($4 eq "!=");
5079 if (CHK("COMPARISON_TO_NULL",
5080 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5082 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5087 # check for bad placement of section $InitAttribute (e.g.: __initdata)
5088 if ($line =~ /(\b$InitAttribute\b)/) {
5090 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5093 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5094 ERROR("MISPLACED_INIT",
5095 "$attr should be placed after $var\n" . $herecurr)) ||
5096 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5097 WARN("MISPLACED_INIT",
5098 "$attr should be placed after $var\n" . $herecurr))) &&
5100 $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;
5105 # check for $InitAttributeData (ie: __initdata) with const
5106 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5108 $attr =~ /($InitAttributePrefix)(.*)/;
5109 my $attr_prefix = $1;
5111 if (ERROR("INIT_ATTRIBUTE",
5112 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5114 $fixed[$fixlinenr] =~
5115 s/$InitAttributeData/${attr_prefix}initconst/;
5119 # check for $InitAttributeConst (ie: __initconst) without const
5120 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5122 if (ERROR("INIT_ATTRIBUTE",
5123 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5125 my $lead = $fixed[$fixlinenr] =~
5126 /(^\+\s*(?:static\s+))/;
5128 $lead = "$lead " if ($lead !~ /^\+$/);
5129 $lead = "${lead}const ";
5130 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
5134 # check for __read_mostly with const non-pointer (should just be const)
5135 if ($line =~ /\b__read_mostly\b/ &&
5136 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5137 if (ERROR("CONST_READ_MOSTLY",
5138 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5140 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5144 # don't use __constant_<foo> functions outside of include/uapi/
5145 if ($realfile !~ m@^include/uapi/@ &&
5146 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5147 my $constant_func = $1;
5148 my $func = $constant_func;
5149 $func =~ s/^__constant_//;
5150 if (WARN("CONSTANT_CONVERSION",
5151 "$constant_func should be $func\n" . $herecurr) &&
5153 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
5157 # prefer usleep_range over udelay
5158 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
5160 # ignore udelay's < 10, however
5161 if (! ($delay < 10) ) {
5163 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5165 if ($delay > 2000) {
5167 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
5171 # warn about unexpectedly long msleep's
5172 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5175 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5179 # check for comparisons of jiffies
5180 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5181 WARN("JIFFIES_COMPARISON",
5182 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5185 # check for comparisons of get_jiffies_64()
5186 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5187 WARN("JIFFIES_COMPARISON",
5188 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5191 # warn about #ifdefs in C files
5192 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5193 # print "#ifdef in C files should be avoided\n";
5194 # print "$herecurr";
5198 # warn about spacing in #ifdefs
5199 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
5200 if (ERROR("SPACING",
5201 "exactly one space required after that #$1\n" . $herecurr) &&
5203 $fixed[$fixlinenr] =~
5204 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5209 # check for spinlock_t definitions without a comment.
5210 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5211 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
5213 if (!ctx_has_comment($first_line, $linenr)) {
5214 CHK("UNCOMMENTED_DEFINITION",
5215 "$1 definition without comment\n" . $herecurr);
5218 # check for memory barriers without a comment.
5224 read_barrier_depends
5226 my $barrier_stems = qr{
5234 my $all_barriers = qr{
5236 smp_(?:$barrier_stems)|
5237 virt_(?:$barrier_stems)
5240 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
5241 if (!ctx_has_comment($first_line, $linenr)) {
5242 WARN("MEMORY_BARRIER",
5243 "memory barrier without comment\n" . $herecurr);
5247 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5249 if ($realfile !~ m@^include/asm-generic/@ &&
5250 $realfile !~ m@/barrier\.h$@ &&
5251 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5252 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5253 WARN("MEMORY_BARRIER",
5254 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5257 # check for waitqueue_active without a comment.
5258 if ($line =~ /\bwaitqueue_active\s*\(/) {
5259 if (!ctx_has_comment($first_line, $linenr)) {
5260 WARN("WAITQUEUE_ACTIVE",
5261 "waitqueue_active without comment\n" . $herecurr);
5265 # Check for expedited grace periods that interrupt non-idle non-nohz
5266 # online CPUs. These expedited can therefore degrade real-time response
5267 # if used carelessly, and should be avoided where not absolutely
5268 # needed. It is always OK to use synchronize_rcu_expedited() and
5269 # synchronize_sched_expedited() at boot time (before real-time applications
5270 # start) and in error situations where real-time response is compromised in
5271 # any case. Note that synchronize_srcu_expedited() does -not- interrupt
5272 # other CPUs, so don't warn on uses of synchronize_srcu_expedited().
5273 # Of course, nothing comes for free, and srcu_read_lock() and
5274 # srcu_read_unlock() do contain full memory barriers in payment for
5275 # synchronize_srcu_expedited() non-interruption properties.
5276 if ($line =~ /\b(synchronize_rcu_expedited|synchronize_sched_expedited)\(/) {
5277 WARN("EXPEDITED_RCU_GRACE_PERIOD",
5278 "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr);
5282 # check of hardware specific defines
5283 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5285 "architecture specific defines should be avoided\n" . $herecurr);
5288 # Check that the storage class is at the beginning of a declaration
5289 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
5290 WARN("STORAGE_CLASS",
5291 "storage class should be at the beginning of the declaration\n" . $herecurr)
5294 # check the location of the inline attribute, that it is between
5295 # storage class and type.
5296 if ($line =~ /\b$Type\s+$Inline\b/ ||
5297 $line =~ /\b$Inline\s+$Storage\b/) {
5298 ERROR("INLINE_LOCATION",
5299 "inline keyword should sit between storage class and type\n" . $herecurr);
5302 # Check for __inline__ and __inline, prefer inline
5303 if ($realfile !~ m@\binclude/uapi/@ &&
5304 $line =~ /\b(__inline__|__inline)\b/) {
5306 "plain inline is preferred over $1\n" . $herecurr) &&
5308 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
5313 # Check for __attribute__ packed, prefer __packed
5314 if ($realfile !~ m@\binclude/uapi/@ &&
5315 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
5316 WARN("PREFER_PACKED",
5317 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
5320 # Check for __attribute__ aligned, prefer __aligned
5321 if ($realfile !~ m@\binclude/uapi/@ &&
5322 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
5323 WARN("PREFER_ALIGNED",
5324 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
5327 # Check for __attribute__ format(printf, prefer __printf
5328 if ($realfile !~ m@\binclude/uapi/@ &&
5329 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
5330 if (WARN("PREFER_PRINTF",
5331 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5333 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5338 # Check for __attribute__ format(scanf, prefer __scanf
5339 if ($realfile !~ m@\binclude/uapi/@ &&
5340 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
5341 if (WARN("PREFER_SCANF",
5342 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5344 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5348 # Check for __attribute__ weak, or __weak declarations (may have link issues)
5349 if ($^V && $^V ge 5.10.0 &&
5350 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5351 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5352 $line =~ /\b__weak\b/)) {
5353 ERROR("WEAK_DECLARATION",
5354 "Using weak declarations can have unintended link defects\n" . $herecurr);
5357 # check for c99 types like uint8_t used outside of uapi/
5358 if ($realfile !~ m@\binclude/uapi/@ &&
5359 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5361 if ($type =~ /\b($typeC99Typedefs)\b/) {
5363 my $kernel_type = 'u';
5364 $kernel_type = 's' if ($type =~ /^_*[si]/);
5367 if (CHK("PREFER_KERNEL_TYPES",
5368 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5370 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5375 # check for cast of C90 native int or longer types constants
5376 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5379 if (WARN("TYPECAST_INT_CONSTANT",
5380 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5383 my $newconst = $const;
5384 $newconst =~ s/${Int_type}$//;
5385 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5386 if ($cast =~ /\blong\s+long\b/) {
5388 } elsif ($cast =~ /\blong\b/) {
5391 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5395 # check for sizeof(&)
5396 if ($line =~ /\bsizeof\s*\(\s*\&/) {
5397 WARN("SIZEOF_ADDRESS",
5398 "sizeof(& should be avoided\n" . $herecurr);
5401 # check for sizeof without parenthesis
5402 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
5403 if (WARN("SIZEOF_PARENTHESIS",
5404 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5406 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5410 # check for struct spinlock declarations
5411 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5412 WARN("USE_SPINLOCK_T",
5413 "struct spinlock should be spinlock_t\n" . $herecurr);
5416 # check for seq_printf uses that could be seq_puts
5417 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
5418 my $fmt = get_quoted_string($line, $rawline);
5421 if (WARN("PREFER_SEQ_PUTS",
5422 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5424 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
5429 # Check for misused memsets
5430 if ($^V && $^V ge 5.10.0 &&
5432 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
5438 if ($ms_size =~ /^(0x|)0$/i) {
5440 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
5441 } elsif ($ms_size =~ /^(0x|)1$/i) {
5443 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5447 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5448 if ($^V && $^V ge 5.10.0 &&
5450 $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5451 if (WARN("PREFER_ETHER_ADDR_COPY",
5452 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5454 $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5458 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5459 if ($^V && $^V ge 5.10.0 &&
5461 $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5462 WARN("PREFER_ETHER_ADDR_EQUAL",
5463 "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5466 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5467 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5468 if ($^V && $^V ge 5.10.0 &&
5470 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5474 if ($ms_val =~ /^(?:0x|)0+$/i) {
5475 if (WARN("PREFER_ETH_ZERO_ADDR",
5476 "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5478 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5480 } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5481 if (WARN("PREFER_ETH_BROADCAST_ADDR",
5482 "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5484 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5489 # typecasts on min/max could be min_t/max_t
5490 if ($^V && $^V ge 5.10.0 &&
5492 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
5493 if (defined $2 || defined $7) {
5495 my $cast1 = deparenthesize($2);
5497 my $cast2 = deparenthesize($7);
5501 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
5502 $cast = "$cast1 or $cast2";
5503 } elsif ($cast1 ne "") {
5509 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
5513 # check usleep_range arguments
5514 if ($^V && $^V ge 5.10.0 &&
5516 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5520 WARN("USLEEP_RANGE",
5521 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5522 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5524 WARN("USLEEP_RANGE",
5525 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5529 # check for naked sscanf
5530 if ($^V && $^V ge 5.10.0 &&
5532 $line =~ /\bsscanf\b/ &&
5533 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5534 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5535 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5536 my $lc = $stat =~ tr@\n@@;
5537 $lc = $lc + $linenr;
5538 my $stat_real = raw_line($linenr, 0);
5539 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5540 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5542 WARN("NAKED_SSCANF",
5543 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5546 # check for simple sscanf that should be kstrto<foo>
5547 if ($^V && $^V ge 5.10.0 &&
5549 $line =~ /\bsscanf\b/) {
5550 my $lc = $stat =~ tr@\n@@;
5551 $lc = $lc + $linenr;
5552 my $stat_real = raw_line($linenr, 0);
5553 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5554 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5556 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5558 my $count = $format =~ tr@%@%@;
5560 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5561 WARN("SSCANF_TO_KSTRTO",
5562 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5567 # check for new externs in .h files.
5568 if ($realfile =~ /\.h$/ &&
5569 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
5570 if (CHK("AVOID_EXTERNS",
5571 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
5573 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
5577 # check for new externs in .c files.
5578 if ($realfile =~ /\.c$/ && defined $stat &&
5579 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
5581 my $function_name = $1;
5582 my $paren_space = $2;
5585 if (defined $cond) {
5586 substr($s, 0, length($cond), '');
5588 if ($s =~ /^\s*;/ &&
5589 $function_name ne 'uninitialized_var')
5591 WARN("AVOID_EXTERNS",
5592 "externs should be avoided in .c files\n" . $herecurr);
5595 if ($paren_space =~ /\n/) {
5596 WARN("FUNCTION_ARGUMENTS",
5597 "arguments for function declarations should follow identifier\n" . $herecurr);
5600 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5601 $stat =~ /^.\s*extern\s+/)
5603 WARN("AVOID_EXTERNS",
5604 "externs should be avoided in .c files\n" . $herecurr);
5607 # checks for new __setup's
5608 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5611 if (!grep(/$name/, @setup_docs)) {
5612 CHK("UNDOCUMENTED_SETUP",
5613 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
5617 # check for pointless casting of kmalloc return
5618 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
5619 WARN("UNNECESSARY_CASTS",
5620 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
5624 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5625 if ($^V && $^V ge 5.10.0 &&
5626 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5627 CHK("ALLOC_SIZEOF_STRUCT",
5628 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
5631 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5632 if ($^V && $^V ge 5.10.0 &&
5633 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
5637 my $newfunc = "kmalloc_array";
5638 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
5641 if ($a1 =~ /^sizeof\s*\S/) {
5645 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
5646 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
5647 if (WARN("ALLOC_WITH_MULTIPLY",
5648 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
5650 $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;
5656 # check for krealloc arg reuse
5657 if ($^V && $^V ge 5.10.0 &&
5658 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
5659 WARN("KREALLOC_ARG_REUSE",
5660 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
5663 # check for alloc argument mismatch
5664 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
5665 WARN("ALLOC_ARRAY_ARGS",
5666 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
5669 # check for multiple semicolons
5670 if ($line =~ /;\s*;\s*$/) {
5671 if (WARN("ONE_SEMICOLON",
5672 "Statements terminations use 1 semicolon\n" . $herecurr) &&
5674 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
5678 # check for #defines like: 1 << <digit> that could be BIT(digit)
5679 if ($line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
5681 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
5682 if (CHK("BIT_MACRO",
5683 "Prefer using the BIT$ull macro\n" . $herecurr) &&
5685 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
5689 # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
5690 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
5692 if (WARN("PREFER_IS_ENABLED",
5693 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
5695 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
5699 # check for case / default statements not preceded by break/fallthrough/switch
5700 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
5702 my $has_statement = 0;
5704 my $prevline = $linenr;
5705 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
5707 my $rline = $rawlines[$prevline - 1];
5708 my $fline = $lines[$prevline - 1];
5709 last if ($fline =~ /^\@\@/);
5710 next if ($fline =~ /^\-/);
5711 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
5712 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
5713 next if ($fline =~ /^.[\s$;]*$/);
5716 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
5718 if (!$has_break && $has_statement) {
5719 WARN("MISSING_BREAK",
5720 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
5724 # check for switch/default statements without a break;
5725 if ($^V && $^V ge 5.10.0 &&
5727 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
5729 my $herectx = $here . "\n";
5730 my $cnt = statement_rawlines($stat);
5731 for (my $n = 0; $n < $cnt; $n++) {
5732 $herectx .= raw_line($linenr, $n) . "\n";
5734 WARN("DEFAULT_NO_BREAK",
5735 "switch default: should use break\n" . $herectx);
5738 # check for gcc specific __FUNCTION__
5739 if ($line =~ /\b__FUNCTION__\b/) {
5740 if (WARN("USE_FUNC",
5741 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
5743 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
5747 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
5748 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
5750 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
5753 # check for use of yield()
5754 if ($line =~ /\byield\s*\(\s*\)/) {
5756 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
5759 # check for comparisons against true and false
5760 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
5768 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
5770 my $type = lc($otype);
5771 if ($type =~ /^(?:true|false)$/) {
5772 if (("$test" eq "==" && "$type" eq "true") ||
5773 ("$test" eq "!=" && "$type" eq "false")) {
5777 CHK("BOOL_COMPARISON",
5778 "Using comparison to $otype is error prone\n" . $herecurr);
5780 ## maybe suggesting a correct construct would better
5781 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5786 # check for semaphores initialized locked
5787 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
5788 WARN("CONSIDER_COMPLETION",
5789 "consider using a completion\n" . $herecurr);
5792 # recommend kstrto* over simple_strto* and strict_strto*
5793 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
5794 WARN("CONSIDER_KSTRTO",
5795 "$1 is obsolete, use k$3 instead\n" . $herecurr);
5798 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
5799 if ($line =~ /^.\s*__initcall\s*\(/) {
5800 WARN("USE_DEVICE_INITCALL",
5801 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
5804 # check for various structs that are normally const (ops, kgdb, device_tree)
5805 my $const_structs = qr{
5807 address_space_operations|
5809 block_device_operations|
5814 file_lock_operations|
5824 lock_manager_operations|
5831 pipe_buf_operations|
5832 platform_hibernation_ops|
5833 platform_suspend_ops|
5838 soc_pcmcia_socket_ops|
5845 if ($line !~ /\bconst\b/ &&
5846 $line =~ /\bstruct\s+($const_structs)\b/) {
5847 WARN("CONST_STRUCT",
5848 "struct $1 should normally be const\n" .
5852 # use of NR_CPUS is usually wrong
5853 # ignore definitions of NR_CPUS and usage to define arrays as likely right
5854 if ($line =~ /\bNR_CPUS\b/ &&
5855 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
5856 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
5857 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
5858 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
5859 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
5862 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
5865 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
5866 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
5867 ERROR("DEFINE_ARCH_HAS",
5868 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
5871 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
5872 if ($^V && $^V ge 5.10.0 &&
5873 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
5874 WARN("LIKELY_MISUSE",
5875 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
5878 # whine mightly about in_atomic
5879 if ($line =~ /\bin_atomic\s*\(/) {
5880 if ($realfile =~ m@^drivers/@) {
5882 "do not use in_atomic in drivers\n" . $herecurr);
5883 } elsif ($realfile !~ m@^kernel/@) {
5885 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
5889 # whine about ACCESS_ONCE
5890 if ($^V && $^V ge 5.10.0 &&
5891 $line =~ /\bACCESS_ONCE\s*$balanced_parens\s*(=(?!=))?\s*($FuncArg)?/) {
5895 $par =~ s/^\(\s*(.*)\s*\)$/$1/;
5897 if (WARN("PREFER_WRITE_ONCE",
5898 "Prefer WRITE_ONCE(<FOO>, <BAR>) over ACCESS_ONCE(<FOO>) = <BAR>\n" . $herecurr) &&
5900 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/;
5903 if (WARN("PREFER_READ_ONCE",
5904 "Prefer READ_ONCE(<FOO>) over ACCESS_ONCE(<FOO>)\n" . $herecurr) &&
5906 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)/READ_ONCE($par)/;
5911 # check for lockdep_set_novalidate_class
5912 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
5913 $line =~ /__lockdep_no_validate__\s*\)/ ) {
5914 if ($realfile !~ m@^kernel/lockdep@ &&
5915 $realfile !~ m@^include/linux/lockdep@ &&
5916 $realfile !~ m@^drivers/base/core@) {
5918 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
5922 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
5923 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
5924 WARN("EXPORTED_WORLD_WRITABLE",
5925 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5928 # Mode permission misuses where it seems decimal should be octal
5929 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5930 if ($^V && $^V ge 5.10.0 &&
5931 $line =~ /$mode_perms_search/) {
5932 foreach my $entry (@mode_permission_funcs) {
5933 my $func = $entry->[0];
5934 my $arg_pos = $entry->[1];
5939 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
5941 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
5942 if ($line =~ /$test/) {
5944 $val = $6 if ($skip_args ne "");
5946 if ($val !~ /^0$/ &&
5947 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
5948 length($val) ne 4)) {
5949 ERROR("NON_OCTAL_PERMISSIONS",
5950 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
5951 } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) {
5952 ERROR("EXPORTED_WORLD_WRITABLE",
5953 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5959 # validate content of MODULE_LICENSE against list from include/linux/module.h
5960 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
5961 my $extracted_string = get_quoted_string($line, $rawline);
5962 my $valid_licenses = qr{
5965 GPL\ and\ additional\ rights|
5971 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
5972 WARN("MODULE_LICENSE",
5973 "unknown module license " . $extracted_string . "\n" . $herecurr);
5978 # If we have no input at all, then there is nothing to report on
5979 # so just keep quiet.
5980 if ($#rawlines == -1) {
5984 # In mailback mode only produce a report in the negative, for
5985 # things that appear to be patches.
5986 if ($mailback && ($clean == 1 || !$is_patch)) {
5990 # This is not a patch, and we are are in 'no-patch' mode so
5992 if (!$chk_patch && !$is_patch) {
5996 if (!$is_patch && $file !~ /cover-letter\.patch$/) {
5997 ERROR("NOT_UNIFIED_DIFF",
5998 "Does not appear to be a unified-diff format patch\n");
6000 if ($is_patch && $filename ne '-' && $chk_signoff && $signoff == 0) {
6001 ERROR("MISSING_SIGN_OFF",
6002 "Missing Signed-off-by: line(s)\n");
6005 print report_dump();
6006 if ($summary && !($clean == 1 && $quiet == 1)) {
6007 print "$filename " if ($summary_file);
6008 print "total: $cnt_error errors, $cnt_warn warnings, " .
6009 (($check)? "$cnt_chk checks, " : "") .
6010 "$cnt_lines lines checked\n";
6014 # If there were any defects found and not already fixing them
6015 if (!$clean and !$fix) {
6018 NOTE: For some of the reported defects, checkpatch may be able to
6019 mechanically convert to the typical style using --fix or --fix-inplace.
6022 # If there were whitespace errors which cleanpatch can fix
6023 # then suggest that.
6024 if ($rpt_cleaners) {
6028 NOTE: Whitespace errors detected.
6029 You may wish to use scripts/cleanpatch or scripts/cleanfile
6034 if ($clean == 0 && $fix &&
6035 ("@rawlines" ne "@fixed" ||
6036 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
6037 my $newfile = $filename;
6038 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
6042 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6044 open($f, '>', $newfile)
6045 or die "$P: Can't open $newfile for write\n";
6046 foreach my $fixed_line (@fixed) {
6049 if ($linecount > 3) {
6050 $fixed_line =~ s/^\+//;
6051 print $f $fixed_line . "\n";
6054 print $f $fixed_line . "\n";
6062 Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6064 Do _NOT_ trust the results written to this file.
6065 Do _NOT_ submit these changes without inspecting them for correctness.
6067 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6068 No warranties, expressed or implied...
6076 print "$vname has no obvious style problems and is ready for submission.\n";
6078 print "$vname has style problems, please review.\n";