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);
46 my $configuration_file = ".checkpatch.conf";
47 my $max_line_length = 80;
48 my $ignore_perl_version = 0;
49 my $minimum_perl_version = 5.10.0;
50 my $min_conf_desc_length = 4;
51 my $spelling_file = "$D/spelling.txt";
53 my $codespellfile = "/usr/share/codespell/dictionary.txt";
60 Usage
: $P [OPTION
]... [FILE
]...
65 --no-tree run without a kernel tree
66 --no-signoff
do not check
for 'Signed-off-by' line
67 --patch treat FILE as patchfile
(default)
68 --emacs emacs compile window format
69 --terse one line per report
70 --showfile emit diffed file position
, not input file position
71 -f
, --file treat FILE as regular source file
72 --subjective
, --strict enable more subjective tests
73 --types TYPE
(,TYPE2
...) show only these comma separated message types
74 --ignore TYPE
(,TYPE2
...) ignore various comma separated message types
75 --max
-line
-length=n set the maximum line
length, if exceeded
, warn
76 --min
-conf
-desc
-length=n set the min description
length, if shorter
, warn
77 --show
-types show the message
"types" in the output
78 --root
=PATH PATH to the kernel tree root
79 --no-summary suppress the per
-file summary
80 --mailback only produce a report
in case of warnings
/errors
81 --summary
-file include the filename
in summary
82 --debug KEY
=[0|1] turn on
/off debugging of KEY
, where KEY is one of
83 'values', 'possible', 'type', and 'attr' (default
85 --test
-only
=WORD report only warnings
/errors containing WORD
87 --fix EXPERIMENTAL
- may create horrible results
88 If correctable single
-line errors exist
, create
89 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
90 with potential errors corrected to the preferred
92 --fix
-inplace EXPERIMENTAL
- may create horrible results
93 Is the same as
--fix
, but overwrites the input
94 file
. It
's your fault if there's
no backup
or git
95 --ignore
-perl
-version override checking of perl version
. expect
97 --codespell Use the codespell dictionary
for spelling
/typos
98 (default:/usr/share
/codespell/dictionary
.txt
)
99 --codespellfile Use this codespell dictionary
100 --color Use colors
when output is STDOUT
(default: on
)
101 -h
, --help
, --version display this help
and exit
103 When FILE is
- read standard input
.
109 my $conf = which_conf
($configuration_file);
112 open(my $conffile, '<', "$conf")
113 or warn "$P: Can't find a readable $configuration_file file $!\n";
115 while (<$conffile>) {
118 $line =~ s/\s*\n?$//g;
122 next if ($line =~ m/^\s*#/);
123 next if ($line =~ m/^\s*$/);
125 my @words = split(" ", $line);
126 foreach my $word (@words) {
127 last if ($word =~ m/^#/);
128 push (@conf_args, $word);
132 unshift(@ARGV, @conf_args) if @conf_args;
136 'q|quiet+' => \
$quiet,
138 'signoff!' => \
$chk_signoff,
139 'patch!' => \
$chk_patch,
142 'showfile!' => \
$showfile,
144 'subjective!' => \
$check,
145 'strict!' => \
$check,
146 'ignore=s' => \
@ignore,
148 'show-types!' => \
$show_types,
149 'max-line-length=i' => \
$max_line_length,
150 'min-conf-desc-length=i' => \
$min_conf_desc_length,
152 'summary!' => \
$summary,
153 'mailback!' => \
$mailback,
154 'summary-file!' => \
$summary_file,
156 'fix-inplace!' => \
$fix_inplace,
157 'ignore-perl-version!' => \
$ignore_perl_version,
158 'debug=s' => \
%debug,
159 'test-only=s' => \
$tst_only,
160 'codespell!' => \
$codespell,
161 'codespellfile=s' => \
$codespellfile,
169 $fix = 1 if ($fix_inplace);
170 $check_orig = $check;
174 if ($^V
&& $^V
lt $minimum_perl_version) {
175 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
176 if (!$ignore_perl_version) {
182 print "$P: no input files\n";
186 sub hash_save_array_words
{
187 my ($hashRef, $arrayRef) = @_;
189 my @array = split(/,/, join(',', @
$arrayRef));
190 foreach my $word (@array) {
191 $word =~ s/\s*\n?$//g;
194 $word =~ tr/[a-z]/[A-Z]/;
196 next if ($word =~ m/^\s*#/);
197 next if ($word =~ m/^\s*$/);
203 sub hash_show_words
{
204 my ($hashRef, $prefix) = @_;
206 if (keys %$hashRef) {
207 print "\nNOTE: $prefix message types:";
208 foreach my $word (sort keys %$hashRef) {
215 hash_save_array_words
(\
%ignore_type, \
@ignore);
216 hash_save_array_words
(\
%use_type, \
@use);
219 my $dbg_possible = 0;
222 for my $key (keys %debug) {
224 eval "\${dbg_$key} = '$debug{$key}';";
228 my $rpt_cleaners = 0;
237 if (!top_of_kernel_tree
($root)) {
238 die "$P: $root: --root does not point at a valid tree\n";
241 if (top_of_kernel_tree
('.')) {
243 } elsif ($0 =~ m@
(.*)/scripts/[^/]*$@
&&
244 top_of_kernel_tree
($1)) {
249 if (!defined $root) {
250 print "Must be run from the top-level dir. of a kernel tree\n";
255 my $emitted_corrupt = 0;
258 [A
-Za
-z_
][A
-Za
-z\d_
]*
259 (?
:\s
*\#\#\s
*[A
-Za
-z_
][A
-Za
-z\d_
]*)*
261 our $Storage = qr{extern|static|asmlinkage};
275 our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
276 our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
277 our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
278 our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
279 our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
281 # Notes to $Attribute:
282 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
303 ____cacheline_aligned
|
304 ____cacheline_aligned_in_smp
|
305 ____cacheline_internodealigned_in_smp
|
309 our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
310 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
311 our $Lval = qr{$Ident(?:$Member)*};
313 our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
314 our $Binary = qr{(?i)0b[01]+$Int_type?};
315 our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
316 our $Int = qr{[0-9]+$Int_type?};
317 our $Octal = qr{0[0-7]+$Int_type?};
318 our $String = qr{"[X\t]*"};
319 our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
320 our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
321 our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
322 our $Float = qr{$Float_hex|$Float_dec|$Float_int};
323 our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
324 our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
325 our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
326 our $Arithmetic = qr{\+|-|\*|\/|%};
330 &&|\
|\
||,|\
^|\
+\
+|--|&|\
||$Arithmetic
333 our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
337 our $NonptrTypeMisordered;
338 our $NonptrTypeWithAttr;
342 our $DeclareMisordered;
344 our $NON_ASCII_UTF8 = qr{
345 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
346 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
347 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
348 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
349 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
350 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
351 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
355 [\x09\x0A\x0D\x20-\x7E] # ASCII
359 our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
360 our $typeOtherOSTypedefs = qr{(?x
:
361 u_
(?
:char
|short
|int|long
) | # bsd
362 u
(?
:nchar
|short
|int|long
) # sysv
364 our $typeKernelTypedefs = qr{(?x
:
365 (?
:__
)?
(?
:u
|s
|be
|le)(?
:8|16|32|64)|
368 our $typeTypedefs = qr{(?x
:
370 $typeOtherOSTypedefs\b|
371 $typeKernelTypedefs\b
374 our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
376 our $logFunctions = qr{(?x
:
377 printk
(?
:_ratelimited
|_once
|)|
378 (?
:[a
-z0
-9]+_
){1,2}(?
:printk
|emerg
|alert
|crit
|err
|warning
|warn|notice
|info
|debug
|dbg
|vdbg
|devel
|cont
|WARN
)(?
:_ratelimited
|_once
|)|
379 WARN
(?
:_RATELIMIT
|_ONCE
|)|
382 seq_vprintf
|seq_printf
|seq_puts
385 our $signature_tags = qr{(?xi
:
396 our @typeListMisordered = (
397 qr{char\s+(?:un)?signed},
398 qr{int\s+(?:(?:un)?signed\s+)?short\s},
399 qr{int\s+short(?:\s+(?:un)?signed)},
400 qr{short\s+int(?:\s+(?:un)?signed)},
401 qr{(?:un)?signed\s+int\s+short},
402 qr{short\s+(?:un)?signed},
403 qr{long\s+int\s+(?:un)?signed},
404 qr{int\s+long\s+(?:un)?signed},
405 qr{long\s+(?:un)?signed\s+int},
406 qr{int\s+(?:un)?signed\s+long},
407 qr{int\s+(?:un)?signed},
408 qr{int\s+long\s+long\s+(?:un)?signed},
409 qr{long\s+long\s+int\s+(?:un)?signed},
410 qr{long\s+long\s+(?:un)?signed\s+int},
411 qr{long\s+long\s+(?:un)?signed},
412 qr{long\s+(?:un)?signed},
417 qr{(?:(?:un)?signed\s+)?char},
418 qr{(?:(?:un)?signed\s+)?short\s+int},
419 qr{(?:(?:un)?signed\s+)?short},
420 qr{(?:(?:un)?signed\s+)?int},
421 qr{(?:(?:un)?signed\s+)?long\s+int},
422 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
423 qr{(?:(?:un)?signed\s+)?long\s+long},
424 qr{(?:(?:un)?signed\s+)?long},
433 qr{${Ident}_handler
},
434 qr{${Ident}_handler_fn
},
438 our $C90_int_types = qr{(?x
:
439 long\s
+long\s
+int\s
+(?
:un
)?signed
|
440 long\s
+long\s
+(?
:un
)?signed\s
+int|
441 long\s
+long\s
+(?
:un
)?signed
|
442 (?
:(?
:un
)?signed\s
+)?long\s
+long\s
+int|
443 (?
:(?
:un
)?signed\s
+)?long\s
+long
|
444 int\s
+long\s
+long\s
+(?
:un
)?signed
|
445 int\s
+(?
:(?
:un
)?signed\s
+)?long\s
+long
|
447 long\s
+int\s
+(?
:un
)?signed
|
448 long\s
+(?
:un
)?signed\s
+int|
449 long\s
+(?
:un
)?signed
|
450 (?
:(?
:un
)?signed\s
+)?long\s
+int|
451 (?
:(?
:un
)?signed\s
+)?long
|
452 int\s
+long\s
+(?
:un
)?signed
|
453 int\s
+(?
:(?
:un
)?signed\s
+)?long
|
456 (?
:(?
:un
)?signed\s
+)?
int
459 our @typeListFile = ();
460 our @typeListWithAttr = (
462 qr{struct\s+$InitAttribute\s+$Ident},
463 qr{union\s+$InitAttribute\s+$Ident},
466 our @modifierList = (
469 our @modifierListFile = ();
471 our @mode_permission_funcs = (
473 ["module_param_(?:array|named|string)", 4],
474 ["module_param_array_named", 5],
475 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
476 ["proc_create(?:_data|)", 2],
477 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
480 #Create a search pattern for all these functions to speed up a loop below
481 our $mode_perms_search = "";
482 foreach my $entry (@mode_permission_funcs) {
483 $mode_perms_search .= '|' if ($mode_perms_search ne "");
484 $mode_perms_search .= $entry->[0];
487 our $mode_perms_world_writable = qr{
495 our $allowed_asm_includes = qr{(?x
:
501 # memory.h: ARM has a custom one
503 # Load common spelling mistakes and build regular expression list.
507 if (open(my $spelling, '<', $spelling_file)) {
508 while (<$spelling>) {
511 $line =~ s/\s*\n?$//g;
514 next if ($line =~ m/^\s*#/);
515 next if ($line =~ m/^\s*$/);
517 my ($suspect, $fix) = split(/\|\|/, $line);
519 $spelling_fix{$suspect} = $fix;
523 warn "No typos will be found - file '$spelling_file': $!\n";
527 if (open(my $spelling, '<', $codespellfile)) {
528 while (<$spelling>) {
531 $line =~ s/\s*\n?$//g;
534 next if ($line =~ m/^\s*#/);
535 next if ($line =~ m/^\s*$/);
536 next if ($line =~ m/, disabled/i);
540 my ($suspect, $fix) = split(/->/, $line);
542 $spelling_fix{$suspect} = $fix;
546 warn "No codespell typos will be found - file '$codespellfile': $!\n";
550 $misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
553 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
554 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
555 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
556 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
557 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
563 (?
:$Modifier\s
+|const\s
+)*
565 (?
:typeof
|__typeof__
)\s
*\
([^\
)]*\
)|
569 (?
:\s
+$Modifier|\s
+const
)*
571 $NonptrTypeMisordered = qr{
572 (?
:$Modifier\s
+|const\s
+)*
576 (?
:\s
+$Modifier|\s
+const
)*
578 $NonptrTypeWithAttr = qr{
579 (?
:$Modifier\s
+|const\s
+)*
581 (?
:typeof
|__typeof__
)\s
*\
([^\
)]*\
)|
585 (?
:\s
+$Modifier|\s
+const
)*
589 (?
:(?
:\s
|\
*|\
[\
])+\s
*const
|(?
:\s
|\
*\s
*(?
:const\s
*)?
|\
[\
])+|(?
:\s
*\
[\s
*\
])+)?
590 (?
:\s
+$Inline|\s
+$Modifier)*
592 $TypeMisordered = qr{
593 $NonptrTypeMisordered
594 (?
:(?
:\s
|\
*|\
[\
])+\s
*const
|(?
:\s
|\
*\s
*(?
:const\s
*)?
|\
[\
])+|(?
:\s
*\
[\s
*\
])+)?
595 (?
:\s
+$Inline|\s
+$Modifier)*
597 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
598 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
602 our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s
*};
604 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
605 # requires at least perl version v5.10.0
606 # Any use must be runtime checked with $^V
608 our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
609 our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s
*};
610 our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
612 our $declaration_macros = qr{(?x
:
613 (?
:$Storage\s
+)?
(?
:[A
-Z_
][A
-Z0
-9]*_
){0,2}(?
:DEFINE
|DECLARE
)(?
:_
[A
-Z0
-9]+){1,6}\s
*\
(|
614 (?
:$Storage\s
+)?LIST_HEAD\s
*\
(|
615 (?
:$Storage\s
+)?
${Type
}\s
+uninitialized_var\s
*\
(
620 return "" if (!defined($string));
622 while ($string =~ /^\s*\(.*\)\s*$/) {
623 $string =~ s@
^\s
*\
(\s
*@@
;
624 $string =~ s@\s
*\
)\s
*$@@
;
627 $string =~ s@\s
+@
@g;
632 sub seed_camelcase_file
{
635 return if (!(-f
$file));
639 open(my $include_file, '<', "$file")
640 or warn "$P: Can't read '$file' $!\n";
641 my $text = <$include_file>;
642 close($include_file);
644 my @lines = split('\n', $text);
646 foreach my $line (@lines) {
647 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
648 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
650 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
652 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
658 my $camelcase_seeded = 0;
659 sub seed_camelcase_includes
{
660 return if ($camelcase_seeded);
663 my $camelcase_cache = "";
664 my @include_files = ();
666 $camelcase_seeded = 1;
669 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
670 chomp $git_last_include_commit;
671 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
673 my $last_mod_date = 0;
674 $files = `find $root/include -name "*.h"`;
675 @include_files = split('\n', $files);
676 foreach my $file (@include_files) {
677 my $date = POSIX
::strftime
("%Y%m%d%H%M",
678 localtime((stat $file)[9]));
679 $last_mod_date = $date if ($last_mod_date < $date);
681 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
684 if ($camelcase_cache ne "" && -f
$camelcase_cache) {
685 open(my $camelcase_file, '<', "$camelcase_cache")
686 or warn "$P: Can't read '$camelcase_cache' $!\n";
687 while (<$camelcase_file>) {
691 close($camelcase_file);
697 $files = `git ls-files "include/*.h"`;
698 @include_files = split('\n', $files);
701 foreach my $file (@include_files) {
702 seed_camelcase_file
($file);
705 if ($camelcase_cache ne "") {
706 unlink glob ".checkpatch-camelcase.*";
707 open(my $camelcase_file, '>', "$camelcase_cache")
708 or warn "$P: Can't write '$camelcase_cache' $!\n";
709 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
710 print $camelcase_file ("$_\n");
712 close($camelcase_file);
716 sub git_commit_info
{
717 my ($commit, $id, $desc) = @_;
719 return ($id, $desc) if ((which
("git") eq "") || !(-e
".git"));
721 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
722 $output =~ s/^\s*//gm;
723 my @lines = split("\n", $output);
725 return ($id, $desc) if ($#lines < 0);
727 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
728 # Maybe one day convert this block of bash into something that returns
729 # all matching commit ids, but it's very slow...
731 # echo "checking commits $1..."
732 # git rev-list --remotes | grep -i "^$1" |
733 # while read line ; do
734 # git log --format='%H %s' -1 $line |
735 # echo "commit $(cut -c 1-12,41-)"
737 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
739 $id = substr($lines[0], 0, 12);
740 $desc = substr($lines[0], 41);
746 $chk_signoff = 0 if ($file);
751 my @fixed_inserted = ();
752 my @fixed_deleted = ();
756 for my $filename (@ARGV) {
759 open($FILE, '-|', "diff -u /dev/null $filename") ||
760 die "$P: $filename: diff failed - $!\n";
761 } elsif ($filename eq '-') {
762 open($FILE, '<&STDIN');
764 open($FILE, '<', "$filename") ||
765 die "$P: $filename: open failed - $!\n";
767 if ($filename eq '-') {
768 $vname = 'Your patch';
778 if ($#ARGV > 0 && $quiet == 0) {
779 print '-' x
length($vname) . "\n";
781 print '-' x
length($vname) . "\n";
784 if (!process
($filename)) {
790 @fixed_inserted = ();
793 @modifierListFile = ();
799 hash_show_words
(\
%use_type, "Used");
800 hash_show_words
(\
%ignore_type, "Ignored");
805 NOTE
: perl
$^V is
not modern enough to detect all possible issues
.
806 An upgrade to at least perl v5
.10
.0 is suggested
.
812 NOTE
: If any of the errors are false positives
, please report
813 them to the maintainer
, see CHECKPATCH
in MAINTAINERS
.
820 sub top_of_kernel_tree
{
824 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
825 "README", "Documentation", "arch", "include", "drivers",
826 "fs", "init", "ipc", "kernel", "lib", "scripts",
829 foreach my $check (@tree_check) {
830 if (! -e
$root . '/' . $check) {
838 my ($formatted_email) = @_;
844 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
847 $comment = $3 if defined $3;
848 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
850 $comment = $2 if defined $2;
851 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
853 $comment = $2 if defined $2;
854 $formatted_email =~ s/$address.*$//;
855 $name = $formatted_email;
857 $name =~ s/^\"|\"$//g;
858 # If there's a name left after stripping spaces and
859 # leading quotes, and the address doesn't have both
860 # leading and trailing angle brackets, the address
862 # "joe smith joe@smith.com" bad
863 # "joe smith <joe@smith.com" bad
864 if ($name ne "" && $address !~ /^<[^>]+>$/) {
872 $name =~ s/^\"|\"$//g;
873 $address = trim
($address);
874 $address =~ s/^\<|\>$//g;
876 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
877 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
881 return ($name, $address, $comment);
885 my ($name, $address) = @_;
890 $name =~ s/^\"|\"$//g;
891 $address = trim
($address);
893 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
894 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
899 $formatted_email = "$address";
901 $formatted_email = "$name <$address>";
904 return $formatted_email;
910 foreach my $path (split(/:/, $ENV{PATH
})) {
911 if (-e
"$path/$bin") {
922 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
923 if (-e
"$path/$conf") {
924 return "$path/$conf";
936 for my $c (split(//, $str)) {
940 for (; ($n % 8) != 0; $n++) {
952 (my $res = shift) =~ tr/\t/ /c;
959 # Drop the diff line leader and expand tabs
961 $line = expand_tabs
($line);
963 # Pick the indent from the front of the line.
964 my ($white) = ($line =~ /^(\s*)/);
966 return (length($line), length($white));
969 my $sanitise_quote = '';
971 sub sanitise_line_reset
{
972 my ($in_comment) = @_;
975 $sanitise_quote = '*/';
977 $sanitise_quote = '';
990 # Always copy over the diff marker.
991 $res = substr($line, 0, 1);
993 for ($off = 1; $off < length($line); $off++) {
994 $c = substr($line, $off, 1);
996 # Comments we are wacking completly including the begin
997 # and end, all to $;.
998 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
999 $sanitise_quote = '*/';
1001 substr($res, $off, 2, "$;$;");
1005 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
1006 $sanitise_quote = '';
1007 substr($res, $off, 2, "$;$;");
1011 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1012 $sanitise_quote = '//';
1014 substr($res, $off, 2, $sanitise_quote);
1019 # A \ in a string means ignore the next character.
1020 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1022 substr($res, $off, 2, 'XX');
1027 if ($c eq "'" || $c eq '"') {
1028 if ($sanitise_quote eq '') {
1029 $sanitise_quote = $c;
1031 substr($res, $off, 1, $c);
1033 } elsif ($sanitise_quote eq $c) {
1034 $sanitise_quote = '';
1038 #print "c<$c> SQ<$sanitise_quote>\n";
1039 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1040 substr($res, $off, 1, $;);
1041 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1042 substr($res, $off, 1, $;);
1043 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1044 substr($res, $off, 1, 'X');
1046 substr($res, $off, 1, $c);
1050 if ($sanitise_quote eq '//') {
1051 $sanitise_quote = '';
1054 # The pathname on a #include may be surrounded by '<' and '>'.
1055 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
1056 my $clean = 'X' x
length($1);
1057 $res =~ s@\
<.*\
>@
<$clean>@
;
1059 # The whole of a #error is a string.
1060 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
1061 my $clean = 'X' x
length($1);
1062 $res =~ s@
(\#\s
*(?
:error
|warning
)\s
+).*@
$1$clean@
;
1068 sub get_quoted_string
{
1069 my ($line, $rawline) = @_;
1071 return "" if ($line !~ m/($String)/g);
1072 return substr($rawline, $-[0], $+[0] - $-[0]);
1075 sub ctx_statement_block
{
1076 my ($linenr, $remain, $off) = @_;
1077 my $line = $linenr - 1;
1080 my $coff = $off - 1;
1094 @stack = (['', 0]) if ($#stack == -1);
1096 #warn "CSB: blk<$blk> remain<$remain>\n";
1097 # If we are about to drop off the end, pull in more
1100 for (; $remain > 0; $line++) {
1101 last if (!defined $lines[$line]);
1102 next if ($lines[$line] =~ /^-/);
1105 $blk .= $lines[$line] . "\n";
1106 $len = length($blk);
1110 # Bail if there is no further context.
1111 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1115 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1121 $c = substr($blk, $off, 1);
1122 $remainder = substr($blk, $off);
1124 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1126 # Handle nested #if/#else.
1127 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1128 push(@stack, [ $type, $level ]);
1129 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1130 ($type, $level) = @
{$stack[$#stack - 1]};
1131 } elsif ($remainder =~ /^#\s*endif\b/) {
1132 ($type, $level) = @
{pop(@stack)};
1135 # Statement ends at the ';' or a close '}' at the
1137 if ($level == 0 && $c eq ';') {
1141 # An else is really a conditional as long as its not else if
1142 if ($level == 0 && $coff_set == 0 &&
1143 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1144 $remainder =~ /^(else)(?:\s|{)/ &&
1145 $remainder !~ /^else\s+if\b/) {
1146 $coff = $off + length($1) - 1;
1148 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1149 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1152 if (($type eq '' || $type eq '(') && $c eq '(') {
1156 if ($type eq '(' && $c eq ')') {
1158 $type = ($level != 0)?
'(' : '';
1160 if ($level == 0 && $coff < $soff) {
1163 #warn "CSB: mark coff<$coff>\n";
1166 if (($type eq '' || $type eq '{') && $c eq '{') {
1170 if ($type eq '{' && $c eq '}') {
1172 $type = ($level != 0)?
'{' : '';
1175 if (substr($blk, $off + 1, 1) eq ';') {
1181 # Preprocessor commands end at the newline unless escaped.
1182 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1190 # We are truly at the end, so shuffle to the next line.
1197 my $statement = substr($blk, $soff, $off - $soff + 1);
1198 my $condition = substr($blk, $soff, $coff - $soff + 1);
1200 #warn "STATEMENT<$statement>\n";
1201 #warn "CONDITION<$condition>\n";
1203 #print "coff<$coff> soff<$off> loff<$loff>\n";
1205 return ($statement, $condition,
1206 $line, $remain + 1, $off - $loff + 1, $level);
1209 sub statement_lines
{
1212 # Strip the diff line prefixes and rip blank lines at start and end.
1213 $stmt =~ s/(^|\n)./$1/g;
1217 my @stmt_lines = ($stmt =~ /\n/g);
1219 return $#stmt_lines + 2;
1222 sub statement_rawlines
{
1225 my @stmt_lines = ($stmt =~ /\n/g);
1227 return $#stmt_lines + 2;
1230 sub statement_block_size
{
1233 $stmt =~ s/(^|\n)./$1/g;
1239 my @stmt_lines = ($stmt =~ /\n/g);
1240 my @stmt_statements = ($stmt =~ /;/g);
1242 my $stmt_lines = $#stmt_lines + 2;
1243 my $stmt_statements = $#stmt_statements + 1;
1245 if ($stmt_lines > $stmt_statements) {
1248 return $stmt_statements;
1252 sub ctx_statement_full
{
1253 my ($linenr, $remain, $off) = @_;
1254 my ($statement, $condition, $level);
1258 # Grab the first conditional/block pair.
1259 ($statement, $condition, $linenr, $remain, $off, $level) =
1260 ctx_statement_block
($linenr, $remain, $off);
1261 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1262 push(@chunks, [ $condition, $statement ]);
1263 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1264 return ($level, $linenr, @chunks);
1267 # Pull in the following conditional/block pairs and see if they
1268 # could continue the statement.
1270 ($statement, $condition, $linenr, $remain, $off, $level) =
1271 ctx_statement_block
($linenr, $remain, $off);
1272 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1273 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1275 push(@chunks, [ $condition, $statement ]);
1278 return ($level, $linenr, @chunks);
1282 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1284 my $start = $linenr - 1;
1291 my @stack = ($level);
1292 for ($line = $start; $remain > 0; $line++) {
1293 next if ($rawlines[$line] =~ /^-/);
1296 $blk .= $rawlines[$line];
1298 # Handle nested #if/#else.
1299 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1300 push(@stack, $level);
1301 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1302 $level = $stack[$#stack - 1];
1303 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1304 $level = pop(@stack);
1307 foreach my $c (split(//, $lines[$line])) {
1308 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1314 if ($c eq $close && $level > 0) {
1316 last if ($level == 0);
1317 } elsif ($c eq $open) {
1322 if (!$outer || $level <= 1) {
1323 push(@res, $rawlines[$line]);
1326 last if ($level == 0);
1329 return ($level, @res);
1331 sub ctx_block_outer
{
1332 my ($linenr, $remain) = @_;
1334 my ($level, @r) = ctx_block_get
($linenr, $remain, 1, '{', '}', 0);
1338 my ($linenr, $remain) = @_;
1340 my ($level, @r) = ctx_block_get
($linenr, $remain, 0, '{', '}', 0);
1344 my ($linenr, $remain, $off) = @_;
1346 my ($level, @r) = ctx_block_get
($linenr, $remain, 0, '(', ')', $off);
1349 sub ctx_block_level
{
1350 my ($linenr, $remain) = @_;
1352 return ctx_block_get
($linenr, $remain, 0, '{', '}', 0);
1354 sub ctx_statement_level
{
1355 my ($linenr, $remain, $off) = @_;
1357 return ctx_block_get
($linenr, $remain, 0, '(', ')', $off);
1360 sub ctx_locate_comment
{
1361 my ($first_line, $end_line) = @_;
1363 # Catch a comment on the end of the line itself.
1364 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@
.*(/\*.*\*/)\s
*(?
:\\\s
*)?
$@
);
1365 return $current_comment if (defined $current_comment);
1367 # Look through the context and try and figure out if there is a
1370 $current_comment = '';
1371 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1372 my $line = $rawlines[$linenr - 1];
1374 if ($linenr == $first_line and $line =~ m@
^.\s
*\
*@
) {
1377 if ($line =~ m@
/\
*@
) {
1380 if (!$in_comment && $current_comment ne '') {
1381 $current_comment = '';
1383 $current_comment .= $line . "\n" if ($in_comment);
1384 if ($line =~ m@\
*/@
) {
1389 chomp($current_comment);
1390 return($current_comment);
1392 sub ctx_has_comment
{
1393 my ($first_line, $end_line) = @_;
1394 my $cmt = ctx_locate_comment
($first_line, $end_line);
1396 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1397 ##print "CMMT: $cmt\n";
1399 return ($cmt ne '');
1403 my ($linenr, $cnt) = @_;
1405 my $offset = $linenr - 1;
1410 $line = $rawlines[$offset++];
1411 next if (defined($line) && $line =~ /^-/);
1423 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1426 $coded = sprintf("^%c", unpack('C', $2) + 64);
1435 my $av_preprocessor = 0;
1440 sub annotate_reset
{
1441 $av_preprocessor = 0;
1443 @av_paren_type = ('E');
1444 $av_pend_colon = 'O';
1447 sub annotate_values
{
1448 my ($stream, $type) = @_;
1451 my $var = '_' x
length($stream);
1454 print "$stream\n" if ($dbg_values > 1);
1456 while (length($cur)) {
1457 @av_paren_type = ('E') if ($#av_paren_type < 0);
1458 print " <" . join('', @av_paren_type) .
1459 "> <$type> <$av_pending>" if ($dbg_values > 1);
1460 if ($cur =~ /^(\s+)/o) {
1461 print "WS($1)\n" if ($dbg_values > 1);
1462 if ($1 =~ /\n/ && $av_preprocessor) {
1463 $type = pop(@av_paren_type);
1464 $av_preprocessor = 0;
1467 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1468 print "CAST($1)\n" if ($dbg_values > 1);
1469 push(@av_paren_type, $type);
1472 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1473 print "DECLARE($1)\n" if ($dbg_values > 1);
1476 } elsif ($cur =~ /^($Modifier)\s*/) {
1477 print "MODIFIER($1)\n" if ($dbg_values > 1);
1480 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1481 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1482 $av_preprocessor = 1;
1483 push(@av_paren_type, $type);
1489 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1490 print "UNDEF($1)\n" if ($dbg_values > 1);
1491 $av_preprocessor = 1;
1492 push(@av_paren_type, $type);
1494 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1495 print "PRE_START($1)\n" if ($dbg_values > 1);
1496 $av_preprocessor = 1;
1498 push(@av_paren_type, $type);
1499 push(@av_paren_type, $type);
1502 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1503 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1504 $av_preprocessor = 1;
1506 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1510 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1511 print "PRE_END($1)\n" if ($dbg_values > 1);
1513 $av_preprocessor = 1;
1515 # Assume all arms of the conditional end as this
1516 # one does, and continue as if the #endif was not here.
1517 pop(@av_paren_type);
1518 push(@av_paren_type, $type);
1521 } elsif ($cur =~ /^(\\\n)/o) {
1522 print "PRECONT($1)\n" if ($dbg_values > 1);
1524 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1525 print "ATTR($1)\n" if ($dbg_values > 1);
1526 $av_pending = $type;
1529 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1530 print "SIZEOF($1)\n" if ($dbg_values > 1);
1536 } elsif ($cur =~ /^(if|while|for)\b/o) {
1537 print "COND($1)\n" if ($dbg_values > 1);
1541 } elsif ($cur =~/^(case)/o) {
1542 print "CASE($1)\n" if ($dbg_values > 1);
1543 $av_pend_colon = 'C';
1546 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1547 print "KEYWORD($1)\n" if ($dbg_values > 1);
1550 } elsif ($cur =~ /^(\()/o) {
1551 print "PAREN('$1')\n" if ($dbg_values > 1);
1552 push(@av_paren_type, $av_pending);
1556 } elsif ($cur =~ /^(\))/o) {
1557 my $new_type = pop(@av_paren_type);
1558 if ($new_type ne '_') {
1560 print "PAREN('$1') -> $type\n"
1561 if ($dbg_values > 1);
1563 print "PAREN('$1')\n" if ($dbg_values > 1);
1566 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1567 print "FUNC($1)\n" if ($dbg_values > 1);
1571 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1572 if (defined $2 && $type eq 'C' || $type eq 'T') {
1573 $av_pend_colon = 'B';
1574 } elsif ($type eq 'E') {
1575 $av_pend_colon = 'L';
1577 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1580 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1581 print "IDENT($1)\n" if ($dbg_values > 1);
1584 } elsif ($cur =~ /^($Assignment)/o) {
1585 print "ASSIGN($1)\n" if ($dbg_values > 1);
1588 } elsif ($cur =~/^(;|{|})/) {
1589 print "END($1)\n" if ($dbg_values > 1);
1591 $av_pend_colon = 'O';
1593 } elsif ($cur =~/^(,)/) {
1594 print "COMMA($1)\n" if ($dbg_values > 1);
1597 } elsif ($cur =~ /^(\?)/o) {
1598 print "QUESTION($1)\n" if ($dbg_values > 1);
1601 } elsif ($cur =~ /^(:)/o) {
1602 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1604 substr($var, length($res), 1, $av_pend_colon);
1605 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1610 $av_pend_colon = 'O';
1612 } elsif ($cur =~ /^(\[)/o) {
1613 print "CLOSE($1)\n" if ($dbg_values > 1);
1616 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1619 print "OPV($1)\n" if ($dbg_values > 1);
1626 substr($var, length($res), 1, $variant);
1629 } elsif ($cur =~ /^($Operators)/o) {
1630 print "OP($1)\n" if ($dbg_values > 1);
1631 if ($1 ne '++' && $1 ne '--') {
1635 } elsif ($cur =~ /(^.)/o) {
1636 print "C($1)\n" if ($dbg_values > 1);
1639 $cur = substr($cur, length($1));
1640 $res .= $type x
length($1);
1644 return ($res, $var);
1648 my ($possible, $line) = @_;
1649 my $notPermitted = qr{(?
:
1666 ^(?
:typedef
|struct
|enum
)\b
1668 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1669 if ($possible !~ $notPermitted) {
1670 # Check for modifiers.
1671 $possible =~ s/\s*$Storage\s*//g;
1672 $possible =~ s/\s*$Sparse\s*//g;
1673 if ($possible =~ /^\s*$/) {
1675 } elsif ($possible =~ /\s/) {
1676 $possible =~ s/\s*$Type\s*//g;
1677 for my $modifier (split(' ', $possible)) {
1678 if ($modifier !~ $notPermitted) {
1679 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1680 push(@modifierListFile, $modifier);
1685 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1686 push(@typeListFile, $possible);
1690 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1699 return defined $use_type{$type} if (scalar keys %use_type > 0);
1701 return !defined $ignore_type{$type};
1705 my ($level, $type, $msg) = @_;
1707 if (!show_type
($type) ||
1708 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
1712 if (-t STDOUT
&& $color) {
1713 if ($level eq 'ERROR') {
1715 } elsif ($level eq 'WARNING') {
1721 $output .= $prefix . $level . ':';
1723 $output .= BLUE
if (-t STDOUT
&& $color);
1724 $output .= "$type:";
1726 $output .= RESET
if (-t STDOUT
&& $color);
1727 $output .= ' ' . $msg . "\n";
1730 my @lines = split("\n", $output, -1);
1731 splice(@lines, 1, 1);
1732 $output = join("\n", @lines);
1734 $output = (split('\n', $output))[0] . "\n" if ($terse);
1736 push(our @report, $output);
1745 sub fixup_current_range
{
1746 my ($lineRef, $offset, $length) = @_;
1748 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1751 my $no = $o + $offset;
1752 my $nl = $l + $length;
1753 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1757 sub fix_inserted_deleted_lines
{
1758 my ($linesRef, $insertedRef, $deletedRef) = @_;
1760 my $range_last_linenr = 0;
1761 my $delta_offset = 0;
1766 my $next_insert = 0;
1767 my $next_delete = 0;
1771 my $inserted = @
{$insertedRef}[$next_insert++];
1772 my $deleted = @
{$deletedRef}[$next_delete++];
1774 foreach my $old_line (@
{$linesRef}) {
1776 my $line = $old_line; #don't modify the array
1777 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
1779 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1780 $range_last_linenr = $new_linenr;
1781 fixup_current_range
(\
$line, $delta_offset, 0);
1784 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1785 $deleted = @
{$deletedRef}[$next_delete++];
1787 fixup_current_range
(\
$lines[$range_last_linenr], $delta_offset--, -1);
1790 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1791 push(@lines, ${$inserted}{'LINE'});
1792 $inserted = @
{$insertedRef}[$next_insert++];
1794 fixup_current_range
(\
$lines[$range_last_linenr], $delta_offset++, 1);
1798 push(@lines, $line);
1808 sub fix_insert_line
{
1809 my ($linenr, $line) = @_;
1815 push(@fixed_inserted, $inserted);
1818 sub fix_delete_line
{
1819 my ($linenr, $line) = @_;
1826 push(@fixed_deleted, $deleted);
1830 my ($type, $msg) = @_;
1832 if (report
("ERROR", $type, $msg)) {
1840 my ($type, $msg) = @_;
1842 if (report
("WARNING", $type, $msg)) {
1850 my ($type, $msg) = @_;
1852 if ($check && report
("CHECK", $type, $msg)) {
1860 sub check_absolute_file
{
1861 my ($absolute, $herecurr) = @_;
1862 my $file = $absolute;
1864 ##print "absolute<$absolute>\n";
1866 # See if any suffix of this path is a path within the tree.
1867 while ($file =~ s@
^[^/]*/@@
) {
1868 if (-f
"$root/$file") {
1869 ##print "file<$file>\n";
1877 # It is, so see if the prefix is acceptable.
1878 my $prefix = $absolute;
1879 substr($prefix, -length($file)) = '';
1881 ##print "prefix<$prefix>\n";
1882 if ($prefix ne ".../") {
1883 WARN
("USE_RELATIVE_PATH",
1884 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1891 $string =~ s/^\s+|\s+$//g;
1899 $string =~ s/^\s+//;
1907 $string =~ s/\s+$//;
1912 sub string_find_replace
{
1913 my ($string, $find, $replace) = @_;
1915 $string =~ s/$find/$replace/g;
1923 my $source_indent = 8;
1924 my $max_spaces_before_tab = $source_indent - 1;
1925 my $spaces_to_tab = " " x
$source_indent;
1927 #convert leading spaces to tabs
1928 1 while $leading =~ s@
^([\t]*)$spaces_to_tab@
$1\t@g;
1929 #Remove spaces before a tab
1930 1 while $leading =~ s@
^([\t]*)( {1,$max_spaces_before_tab})\t@
$1\t@g;
1935 sub pos_last_openparen
{
1940 my $opens = $line =~ tr/\(/\(/;
1941 my $closes = $line =~ tr/\)/\)/;
1943 my $last_openparen = 0;
1945 if (($opens == 0) || ($closes >= $opens)) {
1949 my $len = length($line);
1951 for ($pos = 0; $pos < $len; $pos++) {
1952 my $string = substr($line, $pos);
1953 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1954 $pos += length($1) - 1;
1955 } elsif (substr($line, $pos, 1) eq '(') {
1956 $last_openparen = $pos;
1957 } elsif (index($string, '(') == -1) {
1962 return length(expand_tabs
(substr($line, 0, $last_openparen))) + 1;
1966 my $filename = shift;
1972 my $stashrawline="";
1982 my $in_header_lines = $file ?
0 : 1;
1983 my $in_commit_log = 0; #Scanning lines before patch
1984 my $commit_log_possible_stack_dump = 0;
1985 my $commit_log_long_line = 0;
1986 my $commit_log_has_diff = 0;
1987 my $reported_maintainer_file = 0;
1988 my $non_utf8_charset = 0;
1990 my $last_blank_line = 0;
1991 my $last_coalesced_string_linenr = -1;
1999 # Trace the real file/line as we go.
2005 my $comment_edge = 0;
2009 my $prev_values = 'E';
2012 my %suppress_ifbraces;
2013 my %suppress_whiletrailers;
2014 my %suppress_export;
2015 my $suppress_statement = 0;
2017 my %signatures = ();
2019 # Pre-scan the patch sanitizing the lines.
2020 # Pre-scan the patch looking for any __setup documentation.
2022 my @setup_docs = ();
2025 my $camelcase_file_seeded = 0;
2027 sanitise_line_reset
();
2029 foreach my $rawline (@rawlines) {
2033 push(@fixed, $rawline) if ($fix);
2035 if ($rawline=~/^\+\+\+\s+(\S+)/) {
2037 if ($1 =~ m
@Documentation/kernel
-parameters
.txt
$@
) {
2042 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2051 # Guestimate if this is a continuing comment. Run
2052 # the context looking for a comment "edge". If this
2053 # edge is a close comment then we must be in a comment
2057 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2058 next if (defined $rawlines[$ln - 1] &&
2059 $rawlines[$ln - 1] =~ /^-/);
2061 #print "RAW<$rawlines[$ln - 1]>\n";
2062 last if (!defined $rawlines[$ln - 1]);
2063 if ($rawlines[$ln - 1] =~ m@
(/\*|\*/)@
&&
2064 $rawlines[$ln - 1] !~ m@
"[^"]*(?
:/\*|\*/)[^"]*"@
) {
2069 if (defined $edge && $edge eq '*/') {
2073 # Guestimate if this is a continuing comment. If this
2074 # is the start of a diff block and this line starts
2075 # ' *' then it is very likely a comment.
2076 if (!defined $edge &&
2077 $rawlines[$linenr] =~ m@
^.\s
*(?
:\
*\
*+| \
*)(?
:\s
|$)@
)
2082 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2083 sanitise_line_reset
($in_comment);
2085 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
2086 # Standardise the strings and chars within the input to
2087 # simplify matching -- only bother with positive lines.
2088 $line = sanitise_line
($rawline);
2090 push(@lines, $line);
2093 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2098 #print "==>$rawline\n";
2099 #print "-->$line\n";
2101 if ($setup_docs && $line =~ /^\+/) {
2102 push(@setup_docs, $line);
2111 foreach my $line (@lines) {
2114 my $sline = $line; #copy of $line
2115 $sline =~ s/$;/ /g; #with comments as spaces
2117 my $rawline = $rawlines[$linenr - 1];
2119 #extract the line range in the file after the patch is applied
2120 if (!$in_commit_log &&
2121 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2123 $first_line = $linenr + 1;
2133 %suppress_ifbraces = ();
2134 %suppress_whiletrailers = ();
2135 %suppress_export = ();
2136 $suppress_statement = 0;
2139 # track the line number as we move through the hunk, note that
2140 # new versions of GNU diff omit the leading space on completely
2141 # blank context lines so we need to count that too.
2142 } elsif ($line =~ /^( |\+|$)/) {
2144 $realcnt-- if ($realcnt != 0);
2146 # Measure the line length and indent.
2147 ($length, $indent) = line_stats
($rawline);
2149 # Track the previous line.
2150 ($prevline, $stashline) = ($stashline, $line);
2151 ($previndent, $stashindent) = ($stashindent, $indent);
2152 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2154 #warn "line<$line>\n";
2156 } elsif ($realcnt == 1) {
2160 my $hunk_line = ($realcnt != 0);
2162 $here = "#$linenr: " if (!$file);
2163 $here = "#$realline: " if ($file);
2166 # extract the filename as it passes
2167 if ($line =~ /^diff --git.*?(\S+)$/) {
2169 $realfile =~ s@
^([^/]*)/@@
if (!$file);
2172 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2174 $realfile =~ s@
^([^/]*)/@@
if (!$file);
2178 if (!$file && $tree && $p1_prefix ne '' &&
2179 -e
"$root/$p1_prefix") {
2180 WARN
("PATCH_PREFIX",
2181 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
2184 if ($realfile =~ m@
^include
/asm/@
) {
2185 ERROR
("MODIFIED_INCLUDE_ASM",
2186 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2191 #make up the handle for any error we report on this line
2193 $prefix = "$realfile:$realline: "
2196 $prefix = "$filename:$realline: ";
2198 $prefix = "$filename:$linenr: ";
2203 if ($realfile =~ m@
^(?
:drivers
/net
/|net
/|drivers
/staging/)@
) {
2206 $check = $check_orig;
2211 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
2213 my $hereline = "$here\n$rawline\n";
2214 my $herecurr = "$here\n$rawline\n";
2215 my $hereprev = "$here\n$prevrawline\n$rawline\n";
2217 $cnt_lines++ if ($realcnt != 0);
2219 # Check if the commit log has what seems like a diff which can confuse patch
2220 if ($in_commit_log && !$commit_log_has_diff &&
2221 (($line =~ m@
^\s
+diff
\b.*a
/[\w/]+@
&&
2222 $line =~ m@
^\s
+diff
\b.*a
/([\w/]+)\s
+b
/$1\b@
) ||
2223 $line =~ m@
^\s
*(?
:\
-\
-\
-\s
+a
/|\+\+\+\s+b/)@
||
2224 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2225 ERROR
("DIFF_IN_COMMIT_MSG",
2226 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2227 $commit_log_has_diff = 1;
2230 # Check for incorrect file permissions
2231 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2232 my $permhere = $here . "FILE: $realfile\n";
2233 if ($realfile !~ m
@scripts/@
&&
2234 $realfile !~ /\.(py|pl|awk|sh)$/) {
2235 ERROR
("EXECUTE_PERMISSIONS",
2236 "do not set execute permissions for source files\n" . $permhere);
2240 # Check the patch for a signoff:
2241 if ($line =~ /^\s*signed-off-by:/i) {
2246 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2247 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2248 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2249 $reported_maintainer_file = 1;
2252 # Check signature styles
2253 if (!$in_header_lines &&
2254 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
2255 my $space_before = $1;
2257 my $space_after = $3;
2259 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2261 if ($sign_off !~ /$signature_tags/) {
2262 WARN
("BAD_SIGN_OFF",
2263 "Non-standard signature: $sign_off\n" . $herecurr);
2265 if (defined $space_before && $space_before ne "") {
2266 if (WARN
("BAD_SIGN_OFF",
2267 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2269 $fixed[$fixlinenr] =
2270 "$ucfirst_sign_off $email";
2273 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
2274 if (WARN
("BAD_SIGN_OFF",
2275 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2277 $fixed[$fixlinenr] =
2278 "$ucfirst_sign_off $email";
2282 if (!defined $space_after || $space_after ne " ") {
2283 if (WARN
("BAD_SIGN_OFF",
2284 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2286 $fixed[$fixlinenr] =
2287 "$ucfirst_sign_off $email";
2291 my ($email_name, $email_address, $comment) = parse_email
($email);
2292 my $suggested_email = format_email
(($email_name, $email_address));
2293 if ($suggested_email eq "") {
2294 ERROR
("BAD_SIGN_OFF",
2295 "Unrecognized email address: '$email'\n" . $herecurr);
2297 my $dequoted = $suggested_email;
2298 $dequoted =~ s/^"//;
2299 $dequoted =~ s/" </ </;
2300 # Don't force email to have quotes
2301 # Allow just an angle bracketed address
2302 if ("$dequoted$comment" ne $email &&
2303 "<$email_address>$comment" ne $email &&
2304 "$suggested_email$comment" ne $email) {
2305 WARN
("BAD_SIGN_OFF",
2306 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
2310 # Check for duplicate signatures
2311 my $sig_nospace = $line;
2312 $sig_nospace =~ s/\s//g;
2313 $sig_nospace = lc($sig_nospace);
2314 if (defined $signatures{$sig_nospace}) {
2315 WARN
("BAD_SIGN_OFF",
2316 "Duplicate signature\n" . $herecurr);
2318 $signatures{$sig_nospace} = 1;
2322 # Check email subject for common tools that don't need to be mentioned
2323 if ($in_header_lines &&
2324 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2325 WARN
("EMAIL_SUBJECT",
2326 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2329 # Check for old stable address
2330 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2331 ERROR
("STABLE_ADDRESS",
2332 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2335 # Check for unwanted Gerrit info
2336 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2337 ERROR
("GERRIT_CHANGE_ID",
2338 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2341 # Check if the commit log is in a possible stack dump
2342 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2343 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2344 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2346 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2347 # stack dump address
2348 $commit_log_possible_stack_dump = 1;
2351 # Check for line lengths > 75 in commit log, warn once
2352 if ($in_commit_log && !$commit_log_long_line &&
2353 length($line) > 75 &&
2354 !($line =~ /^\s*[a-zA-Z0-9_\/\
.]+\s
+\
|\s
+\d
+/ ||
2355 # file delta changes
2356 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\
.\
-]+:/ ||
2358 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2359 # A Fixes: or Link: line
2360 $commit_log_possible_stack_dump)) {
2361 WARN
("COMMIT_LOG_LONG_LINE",
2362 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2363 $commit_log_long_line = 1;
2366 # Reset possible stack dump if a blank line is found
2367 if ($in_commit_log && $commit_log_possible_stack_dump &&
2369 $commit_log_possible_stack_dump = 0;
2372 # Check for git id commit length and improperly formed commit descriptions
2373 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2374 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
2375 ($line =~ /\b[0-9a-f]{12,40}\b/i &&
2376 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2377 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
2378 my $init_char = "c";
2379 my $orig_commit = "";
2386 my $id = '0123456789ab';
2387 my $orig_desc = "commit description";
2388 my $description = "";
2390 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2392 $orig_commit = lc($2);
2393 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2394 $orig_commit = lc($1);
2397 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2398 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2399 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2400 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2401 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2404 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2405 defined $rawlines[$linenr] &&
2406 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2409 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2410 defined $rawlines[$linenr] &&
2411 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2412 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2414 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2415 $orig_desc .= " " . $1;
2419 ($id, $description) = git_commit_info
($orig_commit,
2422 if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) {
2423 ERROR
("GIT_COMMIT_ID",
2424 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2428 # Check for added, moved or deleted files
2429 if (!$reported_maintainer_file && !$in_commit_log &&
2430 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2431 $line =~ /^rename (?:from|to) [\w\/\
.\
-]+\s
*$/ ||
2432 ($line =~ /\{\s*([\w\/\
.\
-]*)\s
*\
=\
>\s
*([\w\
/\.\-]*)\s*\}/ &&
2433 (defined($1) || defined($2))))) {
2434 $reported_maintainer_file = 1;
2435 WARN
("FILE_PATH_CHANGES",
2436 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2439 # Check for wrappage within a valid hunk of the file
2440 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
2441 ERROR
("CORRUPTED_PATCH",
2442 "patch seems to be corrupt (line wrapped?)\n" .
2443 $herecurr) if (!$emitted_corrupt++);
2446 # Check for absolute kernel paths.
2448 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2451 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2452 check_absolute_file
($1, $herecurr)) {
2455 check_absolute_file
($file, $herecurr);
2460 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2461 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
2462 $rawline !~ m/^$UTF8*$/) {
2463 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2465 my $blank = copy_spacing
($rawline);
2466 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2467 my $hereptr = "$hereline$ptr\n";
2470 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
2473 # Check if it's the start of a commit log
2474 # (not a header line and we haven't seen the patch filename)
2475 if ($in_header_lines && $realfile =~ /^$/ &&
2476 !($rawline =~ /^\s+\S/ ||
2477 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
2478 $in_header_lines = 0;
2482 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2483 # declined it, i.e defined some charset where it is missing.
2484 if ($in_header_lines &&
2485 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2487 $non_utf8_charset = 1;
2490 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
2491 $rawline =~ /$NON_ASCII_UTF8/) {
2492 WARN
("UTF8_BEFORE_PATCH",
2493 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2496 # Check for various typo / spelling mistakes
2497 if (defined($misspellings) &&
2498 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
2499 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
2501 my $typo_fix = $spelling_fix{lc($typo)};
2502 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2503 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2504 my $msg_type = \
&WARN
;
2505 $msg_type = \
&CHK
if ($file);
2506 if (&{$msg_type}("TYPO_SPELLING",
2507 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2509 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2514 # ignore non-hunk lines and lines being removed
2515 next if (!$hunk_line || $line =~ /^-/);
2517 #trailing whitespace
2518 if ($line =~ /^\+.*\015/) {
2519 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
2520 if (ERROR
("DOS_LINE_ENDINGS",
2521 "DOS line endings\n" . $herevet) &&
2523 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
2525 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2526 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
2527 if (ERROR
("TRAILING_WHITESPACE",
2528 "trailing whitespace\n" . $herevet) &&
2530 $fixed[$fixlinenr] =~ s/\s+$//;
2536 # Check for FSF mailing addresses.
2537 if ($rawline =~ /\bwrite to the Free/i ||
2538 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2539 $rawline =~ /\b51\s+Franklin\s+St/i) {
2540 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
2541 my $msg_type = \
&ERROR
;
2542 $msg_type = \
&CHK
if ($file);
2543 &{$msg_type}("FSF_MAILING_ADDRESS",
2544 "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)
2547 # check for Kconfig help text having a real description
2548 # Only applies when adding the entry originally, after that we do not have
2549 # sufficient context to determine whether it is indeed long enough.
2550 if ($realfile =~ /Kconfig/ &&
2551 $line =~ /^\+\s*config\s+/) {
2554 my $ln = $linenr + 1;
2558 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
2559 $f = $lines[$ln - 1];
2560 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2561 $is_end = $lines[$ln - 1] =~ /^\+/;
2563 next if ($f =~ /^-/);
2564 last if (!$file && $f =~ /^\@\@/);
2566 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
2568 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
2575 next if ($f =~ /^$/);
2576 if ($f =~ /^\s*config\s/) {
2582 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2583 WARN
("CONFIG_DESCRIPTION",
2584 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2586 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2589 # discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2590 if ($realfile =~ /Kconfig/ &&
2591 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2592 WARN
("CONFIG_EXPERIMENTAL",
2593 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2596 # discourage the use of boolean for type definition attributes of Kconfig options
2597 if ($realfile =~ /Kconfig/ &&
2598 $line =~ /^\+\s*\bboolean\b/) {
2599 WARN
("CONFIG_TYPE_BOOLEAN",
2600 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2603 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2604 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2607 'EXTRA_AFLAGS' => 'asflags-y',
2608 'EXTRA_CFLAGS' => 'ccflags-y',
2609 'EXTRA_CPPFLAGS' => 'cppflags-y',
2610 'EXTRA_LDFLAGS' => 'ldflags-y',
2613 WARN
("DEPRECATED_VARIABLE",
2614 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2617 # check for DT compatible documentation
2618 if (defined $root &&
2619 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2620 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2622 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2624 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2625 my $vp_file = $dt_path . "vendor-prefixes.txt";
2627 foreach my $compat (@compats) {
2628 my $compat2 = $compat;
2629 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2630 my $compat3 = $compat;
2631 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2632 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
2634 WARN
("UNDOCUMENTED_DT_STRING",
2635 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2638 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2640 `grep -Eq "^$vendor\\b" $vp_file`;
2642 WARN
("UNDOCUMENTED_DT_STRING",
2643 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2648 # check we are in a valid source file if not then ignore this hunk
2649 next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/);
2651 # line length limit (with some exclusions)
2653 # There are a few types of lines that may extend beyond $max_line_length:
2654 # logging functions like pr_info that end in a string
2655 # lines with a single string
2656 # #defines that are a single string
2658 # There are 3 different line length message types:
2659 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength
2660 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2661 # LONG_LINE all other lines longer than $max_line_length
2663 # if LONG_LINE is ignored, the other 2 types are also ignored
2666 if ($line =~ /^\+/ && $length > $max_line_length) {
2667 my $msg_type = "LONG_LINE";
2669 # Check the allowed long line types first
2671 # logging functions that end in a string that starts
2672 # before $max_line_length
2673 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2674 length(expand_tabs
(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2677 # lines with only strings (w/ possible termination)
2678 # #defines with only strings
2679 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2680 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2683 # Otherwise set the alternate message types
2685 # a comment starts before $max_line_length
2686 } elsif ($line =~ /($;[\s$;]*)$/ &&
2687 length(expand_tabs
(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2688 $msg_type = "LONG_LINE_COMMENT"
2690 # a quoted string starts before $max_line_length
2691 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
2692 length(expand_tabs
(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2693 $msg_type = "LONG_LINE_STRING"
2696 if ($msg_type ne "" &&
2697 (show_type
("LONG_LINE") || show_type
($msg_type))) {
2699 "line over $max_line_length characters\n" . $herecurr);
2703 # check for adding lines without a newline.
2704 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2705 WARN
("MISSING_EOF_NEWLINE",
2706 "adding a line without newline at end of file\n" . $herecurr);
2709 # Blackfin: use hi/lo macros
2710 if ($realfile =~ m
@arch/blackfin/.*\
.S
$@
) {
2711 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2712 my $herevet = "$here\n" . cat_vet
($line) . "\n";
2714 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
2716 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2717 my $herevet = "$here\n" . cat_vet
($line) . "\n";
2719 "use the HI() macro, not (... >> 16)\n" . $herevet);
2723 # check we are in a valid source file C or perl if not then ignore this hunk
2724 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
2726 # at the beginning of a line any tabs must come first and anything
2727 # more than 8 must use tabs.
2728 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2729 $rawline =~ /^\+\s* \s*/) {
2730 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
2732 if (ERROR
("CODE_INDENT",
2733 "code indent should use tabs where possible\n" . $herevet) &&
2735 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2739 # check for space before tabs.
2740 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2741 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
2742 if (WARN
("SPACE_BEFORE_TAB",
2743 "please, no space before tabs\n" . $herevet) &&
2745 while ($fixed[$fixlinenr] =~
2746 s/(^\+.*) {8,8}\t/$1\t\t/) {}
2747 while ($fixed[$fixlinenr] =~
2748 s/(^\+.*) +\t/$1\t/) {}
2752 # check for && or || at the start of a line
2753 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2754 CHK
("LOGICAL_CONTINUATIONS",
2755 "Logical continuations should be on the previous line\n" . $hereprev);
2758 # check multi-line statement indentation matches previous line
2759 if ($^V
&& $^V
ge 5.10.0 &&
2760 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2761 $prevline =~ /^\+(\t*)(.*)$/;
2765 my $pos = pos_last_openparen
($rest);
2767 $line =~ /^(\+| )([ \t]*)/;
2770 my $goodtabindent = $oldindent .
2773 my $goodspaceindent = $oldindent . " " x
$pos;
2775 if ($newindent ne $goodtabindent &&
2776 $newindent ne $goodspaceindent) {
2778 if (CHK
("PARENTHESIS_ALIGNMENT",
2779 "Alignment should match open parenthesis\n" . $hereprev) &&
2780 $fix && $line =~ /^\+/) {
2781 $fixed[$fixlinenr] =~
2782 s/^\+[ \t]*/\+$goodtabindent/;
2788 # check for space after cast like "(int) foo" or "(struct foo) bar"
2789 # avoid checking a few false positives:
2790 # "sizeof(<type>)" or "__alignof__(<type>)"
2791 # function pointer declarations like "(*foo)(int) = bar;"
2792 # structure definitions like "(struct foo) { 0 };"
2793 # multiline macros that define functions
2794 # known attributes or the __attribute__ keyword
2795 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
2796 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
2798 "No space is necessary after a cast\n" . $herecurr) &&
2800 $fixed[$fixlinenr] =~
2801 s/(\(\s*$Type\s*\))[ \t]+/$1/;
2805 # Block comment styles
2806 # Networking with an initial /*
2807 if ($realfile =~ m@
^(drivers
/net
/|net
/)@
&&
2808 $prevrawline =~ /^\+[ \t]*\/\
*[ \t]*$/ &&
2809 $rawline =~ /^\+[ \t]*\*/ &&
2811 WARN
("NETWORKING_BLOCK_COMMENT_STYLE",
2812 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2815 # Block comments use * on subsequent lines
2816 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
2817 $prevrawline =~ /^\+.*?\/\
*/ && #starting /*
2818 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
2819 $rawline =~ /^\+/ && #line is new
2820 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2821 WARN
("BLOCK_COMMENT_STYLE",
2822 "Block comments use * on subsequent lines\n" . $hereprev);
2825 # Block comments use */ on trailing lines
2826 if ($rawline !~ m@
^\
+[ \t]*\
*/[ \t]*$@ && #trailing */
2827 $rawline !~ m@
^\
+.*/\*.*\*/[ \t]*$@
&& #inline /*...*/
2828 $rawline !~ m@
^\
+.*\
*{2,}/[ \t]*$@ && #trailing **/
2829 $rawline =~ m@
^\
+[ \t]*.+\
*\
/[ \t]*$@) { #non blank */
2830 WARN
("BLOCK_COMMENT_STYLE",
2831 "Block comments use a trailing */ on a separate line\n" . $herecurr);
2834 # check for missing blank lines after struct/union declarations
2835 # with exceptions for various attributes and macros
2836 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2838 !($line =~ /^\+\s*$/ ||
2839 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2840 $line =~ /^\+\s*MODULE_/i ||
2841 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2842 $line =~ /^\+[a-z_]*init/ ||
2843 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2844 $line =~ /^\+\s*DECLARE/ ||
2845 $line =~ /^\+\s*__setup/)) {
2846 if (CHK
("LINE_SPACING",
2847 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
2849 fix_insert_line
($fixlinenr, "\+");
2853 # check for multiple consecutive blank lines
2854 if ($prevline =~ /^[\+ ]\s*$/ &&
2855 $line =~ /^\+\s*$/ &&
2856 $last_blank_line != ($linenr - 1)) {
2857 if (CHK
("LINE_SPACING",
2858 "Please don't use multiple blank lines\n" . $hereprev) &&
2860 fix_delete_line
($fixlinenr, $rawline);
2863 $last_blank_line = $linenr;
2866 # check for missing blank lines after declarations
2867 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2868 # actual declarations
2869 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2870 # function pointer declarations
2871 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2872 # foo bar; where foo is some local typedef or #define
2873 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2874 # known declaration macros
2875 $prevline =~ /^\+\s+$declaration_macros/) &&
2876 # for "else if" which can look like "$Ident $Ident"
2877 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2878 # other possible extensions of declaration lines
2879 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2880 # not starting a section or a macro "\" extended line
2881 $prevline =~ /(?:\{\s*|\\)$/) &&
2882 # looks like a declaration
2883 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2884 # function pointer declarations
2885 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2886 # foo bar; where foo is some local typedef or #define
2887 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2888 # known declaration macros
2889 $sline =~ /^\+\s+$declaration_macros/ ||
2890 # start of struct or union or enum
2891 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
2892 # start or end of block or continuation of declaration
2893 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
2894 # bitfield continuation
2895 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
2896 # other possible extensions of declaration lines
2897 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
2898 # indentation of previous and current line are the same
2899 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
2900 if (WARN
("LINE_SPACING",
2901 "Missing a blank line after declarations\n" . $hereprev) &&
2903 fix_insert_line
($fixlinenr, "\+");
2907 # check for spaces at the beginning of a line.
2909 # 1) within comments
2910 # 2) indented preprocessor commands
2912 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
2913 my $herevet = "$here\n" . cat_vet
($rawline) . "\n";
2914 if (WARN
("LEADING_SPACE",
2915 "please, no spaces at the start of a line\n" . $herevet) &&
2917 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2921 # check we are in a valid C source file if not then ignore this hunk
2922 next if ($realfile !~ /\.(h|c)$/);
2924 # check indentation of any line with a bare else
2925 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
2926 # if the previous line is a break or return and is indented 1 tab more...
2927 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
2928 my $tabs = length($1) + 1;
2929 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
2930 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
2931 defined $lines[$linenr] &&
2932 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
2933 WARN
("UNNECESSARY_ELSE",
2934 "else is not generally useful after a break or return\n" . $hereprev);
2938 # check indentation of a line with a break;
2939 # if the previous line is a goto or return and is indented the same # of tabs
2940 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
2942 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
2943 WARN
("UNNECESSARY_BREAK",
2944 "break is not useful after a goto or return\n" . $hereprev);
2948 # discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2949 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2950 WARN
("CONFIG_EXPERIMENTAL",
2951 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2954 # check for RCS/CVS revision markers
2955 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
2957 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
2960 # Blackfin: don't use __builtin_bfin_[cs]sync
2961 if ($line =~ /__builtin_bfin_csync/) {
2962 my $herevet = "$here\n" . cat_vet
($line) . "\n";
2964 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
2966 if ($line =~ /__builtin_bfin_ssync/) {
2967 my $herevet = "$here\n" . cat_vet
($line) . "\n";
2969 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
2972 # check for old HOTPLUG __dev<foo> section markings
2973 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2974 WARN
("HOTPLUG_SECTION",
2975 "Using $1 is unnecessary\n" . $herecurr);
2978 # Check for potential 'bare' types
2979 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2981 #print "LINE<$line>\n";
2982 if ($linenr >= $suppress_statement &&
2983 $realcnt && $sline =~ /.\s*\S/) {
2984 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2985 ctx_statement_block
($linenr, $realcnt, 0);
2986 $stat =~ s/\n./\n /g;
2987 $cond =~ s/\n./\n /g;
2989 #print "linenr<$linenr> <$stat>\n";
2990 # If this statement has no statement boundaries within
2991 # it there is no point in retrying a statement scan
2992 # until we hit end of it.
2993 my $frag = $stat; $frag =~ s/;+\s*$//;
2994 if ($frag !~ /(?:{|;)/) {
2995 #print "skip<$line_nr_next>\n";
2996 $suppress_statement = $line_nr_next;
2999 # Find the real next line.
3000 $realline_next = $line_nr_next;
3001 if (defined $realline_next &&
3002 (!defined $lines[$realline_next - 1] ||
3003 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3010 # Ignore goto labels.
3011 if ($s =~ /$Ident:\*$/s) {
3013 # Ignore functions being called
3014 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
3016 } elsif ($s =~ /^.\s*else\b/s) {
3018 # declarations always start with types
3019 } 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) {
3022 possible
($type, "A:" . $s);
3024 # definitions in global scope can only start with types
3025 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
3026 possible
($1, "B:" . $s);
3029 # any (foo ... *) is a pointer cast, and foo is a type
3030 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
3031 possible
($1, "C:" . $s);
3034 # Check for any sort of function declaration.
3035 # int foo(something bar, other baz);
3036 # void (*store_gdt)(x86_descr_ptr *);
3037 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3038 my ($name_len) = length($1);
3041 substr($ctx, 0, $name_len + 1, '');
3042 $ctx =~ s/\)[^\)]*$//;
3044 for my $arg (split(/\s*,\s*/, $ctx)) {
3045 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3047 possible
($1, "D:" . $s);
3055 # Checks which may be anchored in the context.
3058 # Check for switch () and associated case and default
3059 # statements should be at the same indent.
3060 if ($line=~/\bswitch\s*\(.*\)/) {
3063 my @ctx = ctx_block_outer
($linenr, $realcnt);
3065 for my $ctx (@ctx) {
3066 my ($clen, $cindent) = line_stats
($ctx);
3067 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3068 $indent != $cindent) {
3069 $err .= "$sep$ctx\n";
3076 ERROR
("SWITCH_CASE_INDENT_LEVEL",
3077 "switch and case should be at the same indent\n$hereline$err");
3081 # if/while/etc brace do not go on next line, unless defining a do while loop,
3082 # or if that brace on the next line is for something else
3083 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3084 my $pre_ctx = "$1$2";
3086 my ($level, @ctx) = ctx_statement_level
($linenr, $realcnt, 0);
3088 if ($line =~ /^\+\t{6,}/) {
3089 WARN
("DEEP_INDENTATION",
3090 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3093 my $ctx_cnt = $realcnt - $#ctx - 1;
3094 my $ctx = join("\n", @ctx);
3096 my $ctx_ln = $linenr;
3097 my $ctx_skip = $realcnt;
3099 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3100 defined $lines[$ctx_ln - 1] &&
3101 $lines[$ctx_ln - 1] =~ /^-/)) {
3102 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3103 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
3107 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3108 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3110 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
3112 "that open brace { should be on the previous line\n" .
3113 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3115 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3116 $ctx =~ /\)\s*\;\s*$/ &&
3117 defined $lines[$ctx_ln - 1])
3119 my ($nlength, $nindent) = line_stats
($lines[$ctx_ln - 1]);
3120 if ($nindent > $indent) {
3121 WARN
("TRAILING_SEMICOLON",
3122 "trailing semicolon indicates no statements, indent implies otherwise\n" .
3123 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3128 # Check relative indent for conditionals and blocks.
3129 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3130 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3131 ctx_statement_block
($linenr, $realcnt, 0)
3132 if (!defined $stat);
3133 my ($s, $c) = ($stat, $cond);
3135 substr($s, 0, length($c), '');
3137 # remove inline comments
3141 # Find out how long the conditional actually is.
3142 my @newlines = ($c =~ /\n/gs);
3143 my $cond_lines = 1 + $#newlines;
3145 # Make sure we remove the line prefixes as we have
3146 # none on the first line, and are going to readd them
3149 while ($s =~ /\n\s+\\\n/) {
3150 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3153 # We want to check the first line inside the block
3154 # starting at the end of the conditional, so remove:
3155 # 1) any blank line termination
3156 # 2) any opening brace { on end of the line
3158 my $continuation = 0;
3160 $s =~ s/^.*\bdo\b//;
3162 if ($s =~ s/^\s*\\//) {
3165 if ($s =~ s/^\s*?\n//) {
3170 # Also ignore a loop construct at the end of a
3171 # preprocessor statement.
3172 if (($prevline =~ /^.\s*#\s*define\s/ ||
3173 $prevline =~ /\\\s*$/) && $continuation == 0) {
3179 while ($cond_ptr != $cond_lines) {
3180 $cond_ptr = $cond_lines;
3182 # If we see an #else/#elif then the code
3184 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3189 # 1) blank lines, they should be at 0,
3190 # 2) preprocessor lines, and
3192 if ($continuation ||
3194 $s =~ /^\s*#\s*?/ ||
3195 $s =~ /^\s*$Ident\s*:/) {
3196 $continuation = ($s =~ /^.*?\\\n/) ?
1 : 0;
3197 if ($s =~ s/^.*?\n//) {
3203 my (undef, $sindent) = line_stats
("+" . $s);
3204 my $stat_real = raw_line
($linenr, $cond_lines);
3206 # Check if either of these lines are modified, else
3207 # this is not this patch's fault.
3208 if (!defined($stat_real) ||
3209 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3212 if (defined($stat_real) && $cond_lines > 1) {
3213 $stat_real = "[...]\n$stat_real";
3216 #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";
3218 if ($check && $s ne '' &&
3219 (($sindent % 8) != 0 ||
3220 ($sindent < $indent) ||
3221 ($sindent > $indent + 8))) {
3222 WARN
("SUSPECT_CODE_INDENT",
3223 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3227 # Track the 'values' across context and added lines.
3228 my $opline = $line; $opline =~ s/^./ /;
3229 my ($curr_values, $curr_vars) =
3230 annotate_values
($opline . "\n", $prev_values);
3231 $curr_values = $prev_values . $curr_values;
3233 my $outline = $opline; $outline =~ s/\t/ /g;
3234 print "$linenr > .$outline\n";
3235 print "$linenr > $curr_values\n";
3236 print "$linenr > $curr_vars\n";
3238 $prev_values = substr($curr_values, -1);
3240 #ignore lines not being added
3241 next if ($line =~ /^[^\+]/);
3243 # check for declarations of signed or unsigned without int
3244 while ($line =~ m{($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3247 $var = "" if (!defined $var);
3248 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
3252 $pointer = "" if (!defined $pointer);
3254 if (WARN
("UNSPECIFIED_INT",
3255 "Prefer '" . trim
($sign) . " int" . rtrim
($pointer) . "' to bare use of '$sign" . rtrim
($pointer) . "'\n" . $herecurr) &&
3257 my $decl = trim
($sign) . " int ";
3258 my $comp_pointer = $pointer;
3259 $comp_pointer =~ s/\s//g;
3260 $decl .= $comp_pointer;
3261 $decl = rtrim
($decl) if ($var eq "");
3262 $fixed[$fixlinenr] =~ s@
\b$sign\s
*\Q
$pointer\E\s
*$var\b@
$decl$var@
;
3267 # TEST: allow direct testing of the type matcher.
3269 if ($line =~ /^.\s*$Declare\s*$/) {
3271 "TEST: is type\n" . $herecurr);
3272 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
3273 ERROR
("TEST_NOT_TYPE",
3274 "TEST: is not type ($1 is)\n". $herecurr);
3278 # TEST: allow direct testing of the attribute matcher.
3280 if ($line =~ /^.\s*$Modifier\s*$/) {
3282 "TEST: is attr\n" . $herecurr);
3283 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
3284 ERROR
("TEST_NOT_ATTR",
3285 "TEST: is not attr ($1 is)\n". $herecurr);
3290 # check for initialisation to aggregates open brace on the next line
3291 if ($line =~ /^.\s*{/ &&
3292 $prevline =~ /(?:^|[^=])=\s*$/) {
3293 if (ERROR
("OPEN_BRACE",
3294 "that open brace { should be on the previous line\n" . $hereprev) &&
3295 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3296 fix_delete_line
($fixlinenr - 1, $prevrawline);
3297 fix_delete_line
($fixlinenr, $rawline);
3298 my $fixedline = $prevrawline;
3299 $fixedline =~ s/\s*=\s*$/ = {/;
3300 fix_insert_line
($fixlinenr, $fixedline);
3302 $fixedline =~ s/^(.\s*){\s*/$1/;
3303 fix_insert_line
($fixlinenr, $fixedline);
3308 # Checks which are anchored on the added line.
3311 # check for malformed paths in #include statements (uses RAW line)
3312 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
3314 if ($path =~ m{//}) {
3315 ERROR
("MALFORMED_INCLUDE",
3316 "malformed #include filename\n" . $herecurr);
3318 if ($path =~ "^uapi/" && $realfile =~ m@
\binclude
/uapi
/@
) {
3319 ERROR
("UAPI_INCLUDE",
3320 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
3324 # no C99 // comments
3325 if ($line =~ m{//}) {
3326 if (ERROR
("C99_COMMENTS",
3327 "do not use C99 // comments\n" . $herecurr) &&
3329 my $line = $fixed[$fixlinenr];
3330 if ($line =~ /\/\
/(.*)$/) {
3331 my $comment = trim
($1);
3332 $fixed[$fixlinenr] =~ s@\
/\/(.*)$@
/\* $comment \*/@
;
3336 # Remove C99 comments.
3338 $opline =~ s@
//.*@@
;
3340 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3341 # the whole statement.
3342 #print "APW <$lines[$realline_next - 1]>\n";
3343 if (defined $realline_next &&
3344 exists $lines[$realline_next - 1] &&
3345 !defined $suppress_export{$realline_next} &&
3346 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3347 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3348 # Handle definitions which produce identifiers with
3351 # EXPORT_SYMBOL(something_foo);
3353 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
3354 $name =~ /^${Ident}_$2/) {
3355 #print "FOO C name<$name>\n";
3356 $suppress_export{$realline_next} = 1;
3358 } elsif ($stat !~ /(?
:
3360 ^.DEFINE_
$Ident\
(\Q
$name\E\
)|
3361 ^.DECLARE_
$Ident\
(\Q
$name\E\
)|
3362 ^.LIST_HEAD\
(\Q
$name\E\
)|
3363 ^.(?
:$Storage\s
+)?
$Type\s
*\
(\s
*\
*\s
*\Q
$name\E\s
*\
)\s
*\
(|
3364 \b\Q
$name\E
(?
:\s
+$Attribute)*\s
*(?
:;|=|\
[|\
()
3366 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3367 $suppress_export{$realline_next} = 2;
3369 $suppress_export{$realline_next} = 1;
3372 if (!defined $suppress_export{$linenr} &&
3373 $prevline =~ /^.\s*$/ &&
3374 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3375 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3376 #print "FOO B <$lines[$linenr - 1]>\n";
3377 $suppress_export{$linenr} = 2;
3379 if (defined $suppress_export{$linenr} &&
3380 $suppress_export{$linenr} == 2) {
3381 WARN
("EXPORT_SYMBOL",
3382 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
3385 # check for global initialisers.
3386 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
3387 if (ERROR
("GLOBAL_INITIALISERS",
3388 "do not initialise globals to $1\n" . $herecurr) &&
3390 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
3393 # check for static initialisers.
3394 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
3395 if (ERROR
("INITIALISED_STATIC",
3396 "do not initialise statics to $1\n" .
3399 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
3403 # check for misordered declarations of char/short/int/long with signed/unsigned
3404 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3406 WARN
("MISORDERED_TYPE",
3407 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3410 # check for static const char * arrays.
3411 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
3412 WARN
("STATIC_CONST_CHAR_ARRAY",
3413 "static const char * array should probably be static const char * const\n" .
3417 # check for static char foo[] = "bar" declarations.
3418 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
3419 WARN
("STATIC_CONST_CHAR_ARRAY",
3420 "static char array declaration should probably be static const char\n" .
3424 # check for const <foo> const where <foo> is not a pointer or array type
3425 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3427 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3429 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3430 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3432 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3436 # check for non-global char *foo[] = {"bar", ...} declarations.
3437 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3438 WARN
("STATIC_CONST_CHAR_ARRAY",
3439 "char * array declaration might be better as static const\n" .
3443 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3444 if ($line =~ m@
\bsizeof\s
*\
(\s
*($Lval)\s
*\
)@
) {
3446 if ($line =~ m@
\b(sizeof\s
*\
(\s
*\Q
$array\E\s
*\
)\s
*/\s
*sizeof\s
*\
(\s
*\Q
$array\E\s
*\
[\s
*0\s
*\
]\s
*\
))@
) {
3448 if (WARN
("ARRAY_SIZE",
3449 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3451 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3456 # check for function declarations without arguments like "int foo()"
3457 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3458 if (ERROR
("FUNCTION_WITHOUT_ARGS",
3459 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3461 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
3465 # check for uses of DEFINE_PCI_DEVICE_TABLE
3466 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
3467 if (WARN
("DEFINE_PCI_DEVICE_TABLE",
3468 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
3470 $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
3474 # check for new typedefs, only function parameters and sparse annotations
3476 if ($line =~ /\btypedef\s/ &&
3477 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
3478 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
3479 $line !~ /\b$typeTypedefs\b/ &&
3480 $line !~ /\b__bitwise(?:__|)\b/) {
3481 WARN
("NEW_TYPEDEFS",
3482 "do not add new typedefs\n" . $herecurr);
3485 # * goes on variable not on type
3487 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3489 my ($ident, $from, $to) = ($1, $2, $2);
3491 # Should start with a space.
3492 $to =~ s/^(\S)/ $1/;
3493 # Should not end with a space.
3495 # '*'s should not have spaces between.
3496 while ($to =~ s/\*\s+\*/\*\*/) {
3499 ## print "1: from<$from> to<$to> ident<$ident>\n";
3501 if (ERROR
("POINTER_LOCATION",
3502 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3504 my $sub_from = $ident;
3505 my $sub_to = $ident;
3506 $sub_to =~ s/\Q$from\E/$to/;
3507 $fixed[$fixlinenr] =~
3508 s@\Q
$sub_from\E@
$sub_to@
;
3512 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3514 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
3516 # Should start with a space.
3517 $to =~ s/^(\S)/ $1/;
3518 # Should not end with a space.
3520 # '*'s should not have spaces between.
3521 while ($to =~ s/\*\s+\*/\*\*/) {
3523 # Modifiers should have spaces.
3524 $to =~ s/(\b$Modifier$)/$1 /;
3526 ## print "2: from<$from> to<$to> ident<$ident>\n";
3527 if ($from ne $to && $ident !~ /^$Modifier$/) {
3528 if (ERROR
("POINTER_LOCATION",
3529 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3532 my $sub_from = $match;
3533 my $sub_to = $match;
3534 $sub_to =~ s/\Q$from\E/$to/;
3535 $fixed[$fixlinenr] =~
3536 s@\Q
$sub_from\E@
$sub_to@
;
3541 # avoid BUG() or BUG_ON()
3542 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
3543 my $msg_type = \
&WARN
;
3544 $msg_type = \
&CHK
if ($file);
3545 &{$msg_type}("AVOID_BUG",
3546 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3549 # avoid LINUX_VERSION_CODE
3550 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
3551 WARN
("LINUX_VERSION_CODE",
3552 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3555 # check for uses of printk_ratelimit
3556 if ($line =~ /\bprintk_ratelimit\s*\(/) {
3557 WARN
("PRINTK_RATELIMITED",
3558 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
3561 # printk should use KERN_* levels. Note that follow on printk's on the
3562 # same line do not need a level, so we use the current block context
3563 # to try and find and validate the current printk. In summary the current
3564 # printk includes all preceding printk's which have no newline on the end.
3565 # we assume the first bad printk is the one to report.
3566 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
3568 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3569 #print "CHECK<$lines[$ln - 1]\n";
3570 # we have a preceding printk if it ends
3571 # with "\n" ignore it, else it is to blame
3572 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3573 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3580 WARN
("PRINTK_WITHOUT_KERN_LEVEL",
3581 "printk() should include KERN_ facility level\n" . $herecurr);
3585 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3587 my $level = lc($orig);
3588 $level = "warn" if ($level eq "warning");
3589 my $level2 = $level;
3590 $level2 = "dbg" if ($level eq "debug");
3591 WARN
("PREFER_PR_LEVEL",
3592 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
3595 if ($line =~ /\bpr_warning\s*\(/) {
3596 if (WARN
("PREFER_PR_LEVEL",
3597 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3599 $fixed[$fixlinenr] =~
3600 s/\bpr_warning\b/pr_warn/;
3604 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3606 my $level = lc($orig);
3607 $level = "warn" if ($level eq "warning");
3608 $level = "dbg" if ($level eq "debug");
3609 WARN
("PREFER_DEV_LEVEL",
3610 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3613 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
3614 # number of false positives, but assembly files are not checked, so at
3615 # least the arch entry code will not trigger this warning.
3616 if ($line =~ /\bENOSYS\b/) {
3618 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3621 # function brace can't be on same line, except for #defines of do while,
3622 # or if closed on same line
3623 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
3624 !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) {
3625 if (ERROR
("OPEN_BRACE",
3626 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3628 fix_delete_line
($fixlinenr, $rawline);
3629 my $fixed_line = $rawline;
3630 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3633 fix_insert_line
($fixlinenr, ltrim
($line1));
3634 fix_insert_line
($fixlinenr, "\+{");
3635 if ($line2 !~ /^\s*$/) {
3636 fix_insert_line
($fixlinenr, "\+\t" . trim
($line2));
3641 # open braces for enum, union and struct go on the same line.
3642 if ($line =~ /^.\s*{/ &&
3643 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
3644 if (ERROR
("OPEN_BRACE",
3645 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3646 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3647 fix_delete_line
($fixlinenr - 1, $prevrawline);
3648 fix_delete_line
($fixlinenr, $rawline);
3649 my $fixedline = rtrim
($prevrawline) . " {";
3650 fix_insert_line
($fixlinenr, $fixedline);
3651 $fixedline = $rawline;
3652 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3653 if ($fixedline !~ /^\+\s*$/) {
3654 fix_insert_line
($fixlinenr, $fixedline);
3659 # missing space after union, struct or enum definition
3660 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3662 "missing space after $1 definition\n" . $herecurr) &&
3664 $fixed[$fixlinenr] =~
3665 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3669 # Function pointer declarations
3670 # check spacing between type, funcptr, and args
3671 # canonical declaration is "type (*funcptr)(args...)"
3672 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
3674 my $pre_pointer_space = $2;
3675 my $post_pointer_space = $3;
3677 my $post_funcname_space = $5;
3678 my $pre_args_space = $6;
3680 # the $Declare variable will capture all spaces after the type
3681 # so check it for a missing trailing missing space but pointer return types
3682 # don't need a space so don't warn for those.
3683 my $post_declare_space = "";
3684 if ($declare =~ /(\s+)$/) {
3685 $post_declare_space = $1;
3686 $declare = rtrim
($declare);
3688 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
3690 "missing space after return type\n" . $herecurr);
3691 $post_declare_space = " ";
3694 # unnecessary space "type (*funcptr)(args...)"
3695 # This test is not currently implemented because these declarations are
3697 # int foo(int bar, ...)
3698 # and this is form shouldn't/doesn't generate a checkpatch warning.
3700 # elsif ($declare =~ /\s{2,}$/) {
3702 # "Multiple spaces after return type\n" . $herecurr);
3705 # unnecessary space "type ( *funcptr)(args...)"
3706 if (defined $pre_pointer_space &&
3707 $pre_pointer_space =~ /^\s/) {
3709 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3712 # unnecessary space "type (* funcptr)(args...)"
3713 if (defined $post_pointer_space &&
3714 $post_pointer_space =~ /^\s/) {
3716 "Unnecessary space before function pointer name\n" . $herecurr);
3719 # unnecessary space "type (*funcptr )(args...)"
3720 if (defined $post_funcname_space &&
3721 $post_funcname_space =~ /^\s/) {
3723 "Unnecessary space after function pointer name\n" . $herecurr);
3726 # unnecessary space "type (*funcptr) (args...)"
3727 if (defined $pre_args_space &&
3728 $pre_args_space =~ /^\s/) {
3730 "Unnecessary space before function pointer arguments\n" . $herecurr);
3733 if (show_type
("SPACING") && $fix) {
3734 $fixed[$fixlinenr] =~
3735 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3739 # check for spacing round square brackets; allowed:
3740 # 1. with a type on the left -- int [] a;
3741 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3742 # 3. inside a curly brace -- = { [0...10] = 5 }
3743 while ($line =~ /(.*?\s)\[/g) {
3744 my ($where, $prefix) = ($-[1], $1);
3745 if ($prefix !~ /$Type\s+$/ &&
3746 ($where != 0 || $prefix !~ /^.\s+$/) &&
3747 $prefix !~ /[{,]\s+$/) {
3748 if (ERROR
("BRACKET_SPACE",
3749 "space prohibited before open square bracket '['\n" . $herecurr) &&
3751 $fixed[$fixlinenr] =~
3752 s/^(\+.*?)\s+\[/$1\[/;
3757 # check for spaces between functions and their parentheses.
3758 while ($line =~ /($Ident)\s+\(/g) {
3760 my $ctx_before = substr($line, 0, $-[1]);
3761 my $ctx = "$ctx_before$name";
3763 # Ignore those directives where spaces _are_ permitted.
3765 if|for|while|switch
|return|case
|
3766 volatile
|__volatile__
|
3767 __attribute__
|format
|__extension__
|
3770 # cpp #define statements have non-optional spaces, ie
3771 # if there is a space between the name and the open
3772 # parenthesis it is simply not a parameter group.
3773 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
3775 # cpp #elif statement condition may start with a (
3776 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
3778 # If this whole things ends with a type its most
3779 # likely a typedef for a function.
3780 } elsif ($ctx =~ /$Type$/) {
3784 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3786 $fixed[$fixlinenr] =~
3787 s/\b$name\s+\(/$name\(/;
3792 # Check operator spacing.
3793 if (!($line=~/\#\s*include/)) {
3794 my $fixed_line = "";
3798 <<=|>>=|<=|>=|==|!=|
3799 \
+=|-=|\
*=|\
/=|%=|\
^=|\
|=|&=|
3800 =>|->|<<|>>|<|>|=|!|~|
3801 &&|\
|\
||,|\
^|\
+\
+|--|&|\
||\
+|-|\
*|\
/|%|
3804 my @elements = split(/($ops|;)/, $opline);
3806 ## print("element count: <" . $#elements . ">\n");
3807 ## foreach my $el (@elements) {
3808 ## print("el: <$el>\n");
3811 my @fix_elements = ();
3814 foreach my $el (@elements) {
3815 push(@fix_elements, substr($rawline, $off, length($el)));
3816 $off += length($el);
3821 my $blank = copy_spacing
($opline);
3822 my $last_after = -1;
3824 for (my $n = 0; $n < $#elements; $n += 2) {
3826 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3828 ## print("n: <$n> good: <$good>\n");
3830 $off += length($elements[$n]);
3832 # Pick up the preceding and succeeding characters.
3833 my $ca = substr($opline, 0, $off);
3835 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3836 $cc = substr($opline, $off + length($elements[$n + 1]));
3838 my $cb = "$ca$;$cc";
3841 $a = 'V' if ($elements[$n] ne '');
3842 $a = 'W' if ($elements[$n] =~ /\s$/);
3843 $a = 'C' if ($elements[$n] =~ /$;$/);
3844 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3845 $a = 'O' if ($elements[$n] eq '');
3846 $a = 'E' if ($ca =~ /^\s*$/);
3848 my $op = $elements[$n + 1];
3851 if (defined $elements[$n + 2]) {
3852 $c = 'V' if ($elements[$n + 2] ne '');
3853 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
3854 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
3855 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3856 $c = 'O' if ($elements[$n + 2] eq '');
3857 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
3862 my $ctx = "${a}x${c}";
3864 my $at = "(ctx:$ctx)";
3866 my $ptr = substr($blank, 0, $off) . "^";
3867 my $hereptr = "$hereline$ptr\n";
3869 # Pull out the value of this operator.
3870 my $op_type = substr($curr_values, $off + 1, 1);
3872 # Get the full operator variant.
3873 my $opv = $op . substr($curr_vars, $off, 1);
3875 # Ignore operators passed as parameters.
3876 if ($op_type ne 'V' &&
3877 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
3880 # } elsif ($op =~ /^$;+$/) {
3882 # ; should have either the end of line or a space or \ after it
3883 } elsif ($op eq ';') {
3884 if ($ctx !~ /.x[WEBC]/ &&
3885 $cc !~ /^\\/ && $cc !~ /^;/) {
3886 if (ERROR
("SPACING",
3887 "space required after that '$op' $at\n" . $hereptr)) {
3888 $good = $fix_elements[$n] . trim
($fix_elements[$n + 1]) . " ";
3894 } elsif ($op eq '//') {
3896 # : when part of a bitfield
3897 } elsif ($opv eq ':B') {
3898 # skip the bitfield test for now
3902 } elsif ($op eq '->') {
3903 if ($ctx =~ /Wx.|.xW/) {
3904 if (ERROR
("SPACING",
3905 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
3906 $good = rtrim
($fix_elements[$n]) . trim
($fix_elements[$n + 1]);
3907 if (defined $fix_elements[$n + 2]) {
3908 $fix_elements[$n + 2] =~ s/^\s+//;
3914 # , must not have a space before and must have a space on the right.
3915 } elsif ($op eq ',') {
3916 my $rtrim_before = 0;
3917 my $space_after = 0;
3918 if ($ctx =~ /Wx./) {
3919 if (ERROR
("SPACING",
3920 "space prohibited before that '$op' $at\n" . $hereptr)) {
3925 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
3926 if (ERROR
("SPACING",
3927 "space required after that '$op' $at\n" . $hereptr)) {
3933 if ($rtrim_before || $space_after) {
3934 if ($rtrim_before) {
3935 $good = rtrim
($fix_elements[$n]) . trim
($fix_elements[$n + 1]);
3937 $good = $fix_elements[$n] . trim
($fix_elements[$n + 1]);
3944 # '*' as part of a type definition -- reported already.
3945 } elsif ($opv eq '*_') {
3946 #warn "'*' is part of type\n";
3948 # unary operators should have a space before and
3949 # none after. May be left adjacent to another
3950 # unary operator, or a cast
3951 } elsif ($op eq '!' || $op eq '~' ||
3952 $opv eq '*U' || $opv eq '-U' ||
3953 $opv eq '&U' || $opv eq '&&U') {
3954 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
3955 if (ERROR
("SPACING",
3956 "space required before that '$op' $at\n" . $hereptr)) {
3957 if ($n != $last_after + 2) {
3958 $good = $fix_elements[$n] . " " . ltrim
($fix_elements[$n + 1]);
3963 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
3964 # A unary '*' may be const
3966 } elsif ($ctx =~ /.xW/) {
3967 if (ERROR
("SPACING",
3968 "space prohibited after that '$op' $at\n" . $hereptr)) {
3969 $good = $fix_elements[$n] . rtrim
($fix_elements[$n + 1]);
3970 if (defined $fix_elements[$n + 2]) {
3971 $fix_elements[$n + 2] =~ s/^\s+//;
3977 # unary ++ and unary -- are allowed no space on one side.
3978 } elsif ($op eq '++' or $op eq '--') {
3979 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
3980 if (ERROR
("SPACING",
3981 "space required one side of that '$op' $at\n" . $hereptr)) {
3982 $good = $fix_elements[$n] . trim
($fix_elements[$n + 1]) . " ";
3986 if ($ctx =~ /Wx[BE]/ ||
3987 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
3988 if (ERROR
("SPACING",
3989 "space prohibited before that '$op' $at\n" . $hereptr)) {
3990 $good = rtrim
($fix_elements[$n]) . trim
($fix_elements[$n + 1]);
3994 if ($ctx =~ /ExW/) {
3995 if (ERROR
("SPACING",
3996 "space prohibited after that '$op' $at\n" . $hereptr)) {
3997 $good = $fix_elements[$n] . trim
($fix_elements[$n + 1]);
3998 if (defined $fix_elements[$n + 2]) {
3999 $fix_elements[$n + 2] =~ s/^\s+//;
4005 # << and >> may either have or not have spaces both sides
4006 } elsif ($op eq '<<' or $op eq '>>' or
4007 $op eq '&' or $op eq '^' or $op eq '|' or
4008 $op eq '+' or $op eq '-' or
4009 $op eq '*' or $op eq '/' or
4013 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4015 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4016 $good = rtrim
($fix_elements[$n]) . " " . trim
($fix_elements[$n + 1]) . " ";
4017 $fix_elements[$n + 2] =~ s/^\s+//;
4020 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4022 "space preferred before that '$op' $at\n" . $hereptr)) {
4023 $good = rtrim
($fix_elements[$n]) . " " . trim
($fix_elements[$n + 1]);
4027 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
4028 if (ERROR
("SPACING",
4029 "need consistent spacing around '$op' $at\n" . $hereptr)) {
4030 $good = rtrim
($fix_elements[$n]) . " " . trim
($fix_elements[$n + 1]) . " ";
4031 if (defined $fix_elements[$n + 2]) {
4032 $fix_elements[$n + 2] =~ s/^\s+//;
4038 # A colon needs no spaces before when it is
4039 # terminating a case value or a label.
4040 } elsif ($opv eq ':C' || $opv eq ':L') {
4041 if ($ctx =~ /Wx./) {
4042 if (ERROR
("SPACING",
4043 "space prohibited before that '$op' $at\n" . $hereptr)) {
4044 $good = rtrim
($fix_elements[$n]) . trim
($fix_elements[$n + 1]);
4049 # All the others need spaces both sides.
4050 } elsif ($ctx !~ /[EWC]x[CWE]/) {
4053 # Ignore email addresses <foo@bar>
4055 $cc =~ /^\S+\@\S+>/) ||
4057 $ca =~ /<\S+\@\S+$/))
4062 # for asm volatile statements
4063 # ignore a colon with another
4064 # colon immediately before or after
4066 ($ca =~ /:$/ || $cc =~ /^:/)) {
4070 # messages are ERROR, but ?: are CHK
4072 my $msg_type = \
&ERROR
;
4073 $msg_type = \
&CHK
if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4075 if (&{$msg_type}("SPACING",
4076 "spaces required around that '$op' $at\n" . $hereptr)) {
4077 $good = rtrim
($fix_elements[$n]) . " " . trim
($fix_elements[$n + 1]) . " ";
4078 if (defined $fix_elements[$n + 2]) {
4079 $fix_elements[$n + 2] =~ s/^\s+//;
4085 $off += length($elements[$n + 1]);
4087 ## print("n: <$n> GOOD: <$good>\n");
4089 $fixed_line = $fixed_line . $good;
4092 if (($#elements % 2) == 0) {
4093 $fixed_line = $fixed_line . $fix_elements[$#elements];
4096 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4097 $fixed[$fixlinenr] = $fixed_line;
4103 # check for whitespace before a non-naked semicolon
4104 if ($line =~ /^\+.*\S\s+;\s*$/) {
4106 "space prohibited before semicolon\n" . $herecurr) &&
4108 1 while $fixed[$fixlinenr] =~
4109 s/^(\+.*\S)\s+;/$1;/;
4113 # check for multiple assignments
4114 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
4115 CHK
("MULTIPLE_ASSIGNMENTS",
4116 "multiple assignments should be avoided\n" . $herecurr);
4119 ## # check for multiple declarations, allowing for a function declaration
4121 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4122 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4124 ## # Remove any bracketed sections to ensure we do not
4125 ## # falsly report the parameters of functions.
4127 ## while ($ln =~ s/\([^\(\)]*\)//g) {
4129 ## if ($ln =~ /,/) {
4130 ## WARN("MULTIPLE_DECLARATION",
4131 ## "declaring multiple variables together should be avoided\n" . $herecurr);
4135 #need space before brace following if, while, etc
4136 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
4138 if (ERROR
("SPACING",
4139 "space required before the open brace '{'\n" . $herecurr) &&
4141 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
4145 ## # check for blank lines before declarations
4146 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4147 ## $prevrawline =~ /^.\s*$/) {
4149 ## "No blank lines before declarations\n" . $hereprev);
4153 # closing brace should have a space following it when it has anything
4155 if ($line =~ /}(?!(?:,|;|\)))\S/) {
4156 if (ERROR
("SPACING",
4157 "space required after that close brace '}'\n" . $herecurr) &&
4159 $fixed[$fixlinenr] =~
4160 s/}((?!(?:,|;|\)))\S)/} $1/;
4164 # check spacing on square brackets
4165 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
4166 if (ERROR
("SPACING",
4167 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4169 $fixed[$fixlinenr] =~
4173 if ($line =~ /\s\]/) {
4174 if (ERROR
("SPACING",
4175 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4177 $fixed[$fixlinenr] =~
4182 # check spacing on parentheses
4183 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4184 $line !~ /for\s*\(\s+;/) {
4185 if (ERROR
("SPACING",
4186 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4188 $fixed[$fixlinenr] =~
4192 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
4193 $line !~ /for\s*\(.*;\s+\)/ &&
4194 $line !~ /:\s+\)/) {
4195 if (ERROR
("SPACING",
4196 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4198 $fixed[$fixlinenr] =~
4203 # check unnecessary parentheses around addressof/dereference single $Lvals
4204 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4206 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
4208 if (CHK
("UNNECESSARY_PARENTHESES",
4209 "Unnecessary parentheses around $var\n" . $herecurr) &&
4211 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4215 # check for unnecessary parentheses around function pointer uses
4216 # ie: (foo->bar)(); should be foo->bar();
4217 # but not "if (foo->bar) (" to avoid some false positives
4218 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4220 if (CHK
("UNNECESSARY_PARENTHESES",
4221 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4223 my $var2 = deparenthesize
($var);
4225 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4229 #goto labels aren't indented, allow a single space however
4230 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
4231 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
4232 if (WARN
("INDENTED_LABEL",
4233 "labels should not be indented\n" . $herecurr) &&
4235 $fixed[$fixlinenr] =~
4240 # return is not a function
4241 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
4243 if ($^V
&& $^V
ge 5.10.0 &&
4244 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4246 $value = deparenthesize
($value);
4247 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4248 ERROR
("RETURN_PARENTHESES",
4249 "return is not a function, parentheses are not required\n" . $herecurr);
4251 } elsif ($spacing !~ /\s+/) {
4253 "space required before the open parenthesis '('\n" . $herecurr);
4257 # unnecessary return in a void function
4258 # at end-of-function, with the previous line a single leading tab, then return;
4259 # and the line before that not a goto label target like "out:"
4260 if ($sline =~ /^[ \+]}\s*$/ &&
4261 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4263 $lines[$linenr - 3] =~ /^[ +]/ &&
4264 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
4266 "void function return statements are not generally useful\n" . $hereprev);
4269 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4270 if ($^V
&& $^V
ge 5.10.0 &&
4271 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4272 my $openparens = $1;
4273 my $count = $openparens =~ tr@\
(@\
(@
;
4275 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4276 my $comp = $4; #Not $1 because of $LvalOrFunc
4277 $msg = " - maybe == should be = ?" if ($comp eq "==");
4278 WARN
("UNNECESSARY_PARENTHESES",
4279 "Unnecessary parentheses$msg\n" . $herecurr);
4283 # comparisons with a constant or upper case identifier on the left
4284 # avoid cases like "foo + BAR < baz"
4285 # only fix matches surrounded by parentheses to avoid incorrect
4286 # conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4287 if ($^V
&& $^V
ge 5.10.0 &&
4288 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4293 my $newcomp = $comp;
4294 if ($lead !~ /$Operators\s*$/ &&
4295 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4296 WARN
("CONSTANT_COMPARISON",
4297 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4301 } elsif ($comp eq "<=") {
4303 } elsif ($comp eq ">") {
4305 } elsif ($comp eq ">=") {
4308 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4312 # Return of what appears to be an errno should normally be negative
4313 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
4315 if ($name ne 'EOF' && $name ne 'ERROR') {
4316 WARN
("USE_NEGATIVE_ERRNO",
4317 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
4321 # Need a space before open parenthesis after if, while etc
4322 if ($line =~ /\b(if|while|for|switch)\(/) {
4323 if (ERROR
("SPACING",
4324 "space required before the open parenthesis '('\n" . $herecurr) &&
4326 $fixed[$fixlinenr] =~
4327 s/\b(if|while|for|switch)\(/$1 \(/;
4331 # Check for illegal assignment in if conditional -- and check for trailing
4332 # statements after the conditional.
4333 if ($line =~ /do\s*(?!{)/) {
4334 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4335 ctx_statement_block
($linenr, $realcnt, 0)
4336 if (!defined $stat);
4337 my ($stat_next) = ctx_statement_block
($line_nr_next,
4338 $remain_next, $off_next);
4339 $stat_next =~ s/\n./\n /g;
4340 ##print "stat<$stat> stat_next<$stat_next>\n";
4342 if ($stat_next =~ /^\s*while\b/) {
4343 # If the statement carries leading newlines,
4344 # then count those as offsets.
4346 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4348 statement_rawlines
($whitespace) - 1;
4350 $suppress_whiletrailers{$line_nr_next +
4354 if (!defined $suppress_whiletrailers{$linenr} &&
4355 defined($stat) && defined($cond) &&
4356 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
4357 my ($s, $c) = ($stat, $cond);
4359 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
4360 ERROR
("ASSIGN_IN_IF",
4361 "do not use assignment in if condition\n" . $herecurr);
4364 # Find out what is on the end of the line after the
4366 substr($s, 0, length($c), '');
4368 $s =~ s/$;//g; # Remove any comments
4369 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4370 $c !~ /}\s*while\s*/)
4372 # Find out how long the conditional actually is.
4373 my @newlines = ($c =~ /\n/gs);
4374 my $cond_lines = 1 + $#newlines;
4377 $stat_real = raw_line
($linenr, $cond_lines)
4378 . "\n" if ($cond_lines);
4379 if (defined($stat_real) && $cond_lines > 1) {
4380 $stat_real = "[...]\n$stat_real";
4383 ERROR
("TRAILING_STATEMENTS",
4384 "trailing statements should be on next line\n" . $herecurr . $stat_real);
4388 # Check for bitwise tests written as boolean
4400 WARN
("HEXADECIMAL_BOOLEAN_TEST",
4401 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
4404 # if and else should not have general statements after it
4405 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4407 $s =~ s/$;//g; # Remove any comments
4408 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
4409 ERROR
("TRAILING_STATEMENTS",
4410 "trailing statements should be on next line\n" . $herecurr);
4413 # if should not continue a brace
4414 if ($line =~ /}\s*if\b/) {
4415 ERROR
("TRAILING_STATEMENTS",
4416 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
4419 # case and default should not have general statements after them
4420 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4422 (?
:\s
*$;*)(?
:\s
*{)?
(?
:\s
*$;*)(?
:\s
*\\)?\s
*$|
4426 ERROR
("TRAILING_STATEMENTS",
4427 "trailing statements should be on next line\n" . $herecurr);
4430 # Check for }<nl>else {, these must be at the same
4431 # indent level to be relevant to each other.
4432 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4433 $previndent == $indent) {
4434 if (ERROR
("ELSE_AFTER_BRACE",
4435 "else should follow close brace '}'\n" . $hereprev) &&
4436 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4437 fix_delete_line
($fixlinenr - 1, $prevrawline);
4438 fix_delete_line
($fixlinenr, $rawline);
4439 my $fixedline = $prevrawline;
4440 $fixedline =~ s/}\s*$//;
4441 if ($fixedline !~ /^\+\s*$/) {
4442 fix_insert_line
($fixlinenr, $fixedline);
4444 $fixedline = $rawline;
4445 $fixedline =~ s/^(.\s*)else/$1} else/;
4446 fix_insert_line
($fixlinenr, $fixedline);
4450 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4451 $previndent == $indent) {
4452 my ($s, $c) = ctx_statement_block
($linenr, $realcnt, 0);
4454 # Find out what is on the end of the line after the
4456 substr($s, 0, length($c), '');
4459 if ($s =~ /^\s*;/) {
4460 if (ERROR
("WHILE_AFTER_BRACE",
4461 "while should follow close brace '}'\n" . $hereprev) &&
4462 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4463 fix_delete_line
($fixlinenr - 1, $prevrawline);
4464 fix_delete_line
($fixlinenr, $rawline);
4465 my $fixedline = $prevrawline;
4466 my $trailing = $rawline;
4467 $trailing =~ s/^\+//;
4468 $trailing = trim
($trailing);
4469 $fixedline =~ s/}\s*$/} $trailing/;
4470 fix_insert_line
($fixlinenr, $fixedline);
4475 #Specific variable tests
4476 while ($line =~ m{($Constant|$Lval)}g) {
4479 #gcc binary extension
4480 if ($var =~ /^$Binary$/) {
4481 if (WARN
("GCC_BINARY_CONSTANT",
4482 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4484 my $hexval = sprintf("0x%x", oct($var));
4485 $fixed[$fixlinenr] =~
4486 s/\b$var\b/$hexval/;
4491 if ($var !~ /^$Constant$/ &&
4492 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
4493 #Ignore Page<foo> variants
4494 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
4495 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4496 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4497 #Ignore some three character SI units explicitly, like MiB and KHz
4498 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
4499 while ($var =~ m{($Ident)}g) {
4501 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
4503 seed_camelcase_includes
();
4504 if (!$file && !$camelcase_file_seeded) {
4505 seed_camelcase_file
($realfile);
4506 $camelcase_file_seeded = 1;
4509 if (!defined $camelcase{$word}) {
4510 $camelcase{$word} = 1;
4512 "Avoid CamelCase: <$word>\n" . $herecurr);
4518 #no spaces allowed after \ in define
4519 if ($line =~ /\#\s*define.*\\\s+$/) {
4520 if (WARN
("WHITESPACE_AFTER_LINE_CONTINUATION",
4521 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4523 $fixed[$fixlinenr] =~ s/\s+$//;
4527 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4528 # itself <asm/foo.h> (uses RAW line)
4529 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
4531 my $checkfile = "include/linux/$file";
4532 if (-f
"$root/$checkfile" &&
4533 $realfile ne $checkfile &&
4534 $1 !~ /$allowed_asm_includes/)
4536 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4537 if ($asminclude > 0) {
4538 if ($realfile =~ m{^arch/}) {
4539 CHK
("ARCH_INCLUDE_LINUX",
4540 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4542 WARN
("INCLUDE_LINUX",
4543 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4549 # multi-statement macros should be enclosed in a do while loop, grab the
4550 # first statement and ensure its the whole macro if its not enclosed
4551 # in a known good container
4552 if ($realfile !~ m@
/vmlinux
.lds
.h
$@
&&
4553 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
4556 my ($off, $dstat, $dcond, $rest);
4558 my $has_flow_statement = 0;
4559 my $has_arg_concat = 0;
4560 ($dstat, $dcond, $ln, $cnt, $off) =
4561 ctx_statement_block
($linenr, $realcnt, 0);
4563 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4564 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4566 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
4567 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
4569 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
4571 $dstat =~ s/\\\n.//g;
4572 $dstat =~ s/^\s*//s;
4573 $dstat =~ s/\s*$//s;
4575 # Flatten any parentheses and braces
4576 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4577 $dstat =~ s/\{[^\{\}]*\}/1/ ||
4578 $dstat =~ s/.\[[^\[\]]*\]/1/)
4582 # Flatten any obvious string concatentation.
4583 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4584 $dstat =~ s/$Ident\s*($String)/$1/)
4588 # Make asm volatile uses seem like a generic function
4589 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
4591 my $exceptions = qr{
4604 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4606 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4607 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
4608 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4609 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
4610 $dstat !~ /$exceptions/ &&
4611 $dstat !~ /^\.$Ident\s*=/ && # .foo =
4612 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
4613 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
4614 $dstat !~ /^for\s*$Constant$/ && # for (...)
4615 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4616 $dstat !~ /^do\s*{/ && # do {...
4617 $dstat !~ /^\(\{/ && # ({...
4618 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
4621 my $herectx = $here . "\n";
4622 my $cnt = statement_rawlines
($ctx);
4624 for (my $n = 0; $n < $cnt; $n++) {
4625 $herectx .= raw_line
($linenr, $n) . "\n";
4628 if ($dstat =~ /;/) {
4629 ERROR
("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4630 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4632 ERROR
("COMPLEX_MACRO",
4633 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
4637 # check for macros with flow control, but without ## concatenation
4638 # ## concatenation is commonly a macro that defines a function so ignore those
4639 if ($has_flow_statement && !$has_arg_concat) {
4640 my $herectx = $here . "\n";
4641 my $cnt = statement_rawlines
($ctx);
4643 for (my $n = 0; $n < $cnt; $n++) {
4644 $herectx .= raw_line
($linenr, $n) . "\n";
4646 WARN
("MACRO_WITH_FLOW_CONTROL",
4647 "Macros with flow control statements should be avoided\n" . "$herectx");
4650 # check for line continuations outside of #defines, preprocessor #, and asm
4653 if ($prevline !~ /^..*\\$/ &&
4654 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4655 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
4656 $line =~ /^\+.*\\$/) {
4657 WARN
("LINE_CONTINUATIONS",
4658 "Avoid unnecessary line continuations\n" . $herecurr);
4662 # do {} while (0) macro tests:
4663 # single-statement macros do not need to be enclosed in do while (0) loop,
4664 # macro should not end with a semicolon
4665 if ($^V
&& $^V
ge 5.10.0 &&
4666 $realfile !~ m@
/vmlinux
.lds
.h
$@
&&
4667 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4670 my ($off, $dstat, $dcond, $rest);
4672 ($dstat, $dcond, $ln, $cnt, $off) =
4673 ctx_statement_block
($linenr, $realcnt, 0);
4676 $dstat =~ s/\\\n.//g;
4679 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4684 my $cnt = statement_rawlines
($ctx);
4685 my $herectx = $here . "\n";
4687 for (my $n = 0; $n < $cnt; $n++) {
4688 $herectx .= raw_line
($linenr, $n) . "\n";
4691 if (($stmts =~ tr/;/;/) == 1 &&
4692 $stmts !~ /^\s*(if|while|for|switch)\b/) {
4693 WARN
("SINGLE_STATEMENT_DO_WHILE_MACRO",
4694 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4696 if (defined $semis && $semis ne "") {
4697 WARN
("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4698 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4700 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4702 my $cnt = statement_rawlines
($ctx);
4703 my $herectx = $here . "\n";
4705 for (my $n = 0; $n < $cnt; $n++) {
4706 $herectx .= raw_line
($linenr, $n) . "\n";
4709 WARN
("TRAILING_SEMICOLON",
4710 "macros should not use a trailing semicolon\n" . "$herectx");
4714 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4715 # all assignments may have only one of the following with an assignment:
4718 # VMLINUX_SYMBOL(...)
4719 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
4720 WARN
("MISSING_VMLINUX_SYMBOL",
4721 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
4724 # check for redundant bracing round if etc
4725 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4726 my ($level, $endln, @chunks) =
4727 ctx_statement_full
($linenr, $realcnt, 1);
4728 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
4729 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4730 if ($#chunks > 0 && $level == 0) {
4734 my $herectx = $here . "\n";
4735 my $ln = $linenr - 1;
4736 for my $chunk (@chunks) {
4737 my ($cond, $block) = @
{$chunk};
4739 # If the condition carries leading newlines, then count those as offsets.
4740 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4741 my $offset = statement_rawlines
($whitespace) - 1;
4743 $allowed[$allow] = 0;
4744 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4746 # We have looked at and allowed this specific line.
4747 $suppress_ifbraces{$ln + $offset} = 1;
4749 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
4750 $ln += statement_rawlines
($block) - 1;
4752 substr($block, 0, length($cond), '');
4754 $seen++ if ($block =~ /^\s*{/);
4756 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
4757 if (statement_lines
($cond) > 1) {
4758 #print "APW: ALLOWED: cond<$cond>\n";
4759 $allowed[$allow] = 1;
4761 if ($block =~/\b(?:if|for|while)\b/) {
4762 #print "APW: ALLOWED: block<$block>\n";
4763 $allowed[$allow] = 1;
4765 if (statement_block_size
($block) > 1) {
4766 #print "APW: ALLOWED: lines block<$block>\n";
4767 $allowed[$allow] = 1;
4772 my $sum_allowed = 0;
4773 foreach (@allowed) {
4776 if ($sum_allowed == 0) {
4778 "braces {} are not necessary for any arm of this statement\n" . $herectx);
4779 } elsif ($sum_allowed != $allow &&
4782 "braces {} should be used on all arms of this statement\n" . $herectx);
4787 if (!defined $suppress_ifbraces{$linenr - 1} &&
4788 $line =~ /\b(if|while|for|else)\b/) {
4791 # Check the pre-context.
4792 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
4793 #print "APW: ALLOWED: pre<$1>\n";
4797 my ($level, $endln, @chunks) =
4798 ctx_statement_full
($linenr, $realcnt, $-[0]);
4800 # Check the condition.
4801 my ($cond, $block) = @
{$chunks[0]};
4802 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
4803 if (defined $cond) {
4804 substr($block, 0, length($cond), '');
4806 if (statement_lines
($cond) > 1) {
4807 #print "APW: ALLOWED: cond<$cond>\n";
4810 if ($block =~/\b(?:if|for|while)\b/) {
4811 #print "APW: ALLOWED: block<$block>\n";
4814 if (statement_block_size
($block) > 1) {
4815 #print "APW: ALLOWED: lines block<$block>\n";
4818 # Check the post-context.
4819 if (defined $chunks[1]) {
4820 my ($cond, $block) = @
{$chunks[1]};
4821 if (defined $cond) {
4822 substr($block, 0, length($cond), '');
4824 if ($block =~ /^\s*\{/) {
4825 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4829 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
4830 my $herectx = $here . "\n";
4831 my $cnt = statement_rawlines
($block);
4833 for (my $n = 0; $n < $cnt; $n++) {
4834 $herectx .= raw_line
($linenr, $n) . "\n";
4838 "braces {} are not necessary for single statement blocks\n" . $herectx);
4842 # check for unnecessary blank lines around braces
4843 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
4845 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
4846 $fix && $prevrawline =~ /^\+/) {
4847 fix_delete_line
($fixlinenr - 1, $prevrawline);
4850 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
4852 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
4854 fix_delete_line
($fixlinenr, $rawline);
4858 # no volatiles please
4859 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
4860 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
4862 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
4865 # Check for user-visible strings broken across lines, which breaks the ability
4866 # to grep for the string. Make exceptions when the previous string ends in a
4867 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
4868 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
4869 if ($line =~ /^\+\s*$String/ &&
4870 $prevline =~ /"\s*$/ &&
4871 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
4872 if (WARN
("SPLIT_STRING",
4873 "quoted string split across lines\n" . $hereprev) &&
4875 $prevrawline =~ /^\+.*"\s*$/ &&
4876 $last_coalesced_string_linenr != $linenr - 1) {
4877 my $extracted_string = get_quoted_string
($line, $rawline);
4878 my $comma_close = "";
4879 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
4883 fix_delete_line
($fixlinenr - 1, $prevrawline);
4884 fix_delete_line
($fixlinenr, $rawline);
4885 my $fixedline = $prevrawline;
4886 $fixedline =~ s/"\s*$//;
4887 $fixedline .= substr($extracted_string, 1) . trim
($comma_close);
4888 fix_insert_line
($fixlinenr - 1, $fixedline);
4889 $fixedline = $rawline;
4890 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
4891 if ($fixedline !~ /\+\s*$/) {
4892 fix_insert_line
($fixlinenr, $fixedline);
4894 $last_coalesced_string_linenr = $linenr;
4898 # check for missing a space in a string concatenation
4899 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
4900 WARN
('MISSING_SPACE',
4901 "break quoted strings at a space character\n" . $hereprev);
4904 # check for spaces before a quoted newline
4905 if ($rawline =~ /^.*\".*\s\\n/) {
4906 if (WARN
("QUOTED_WHITESPACE_BEFORE_NEWLINE",
4907 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
4909 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
4914 # concatenated string without spaces between elements
4915 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
4916 CHK
("CONCATENATED_STRING",
4917 "Concatenated strings should use spaces between elements\n" . $herecurr);
4920 # uncoalesced string fragments
4921 if ($line =~ /$String\s*"/) {
4922 WARN
("STRING_FRAGMENTS",
4923 "Consecutive strings are generally better as a single string\n" . $herecurr);
4926 # check for %L{u,d,i} and 0x%[udi] in strings
4928 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4929 $string = substr($rawline, $-[1], $+[1] - $-[1]);
4930 $string =~ s/%%/__/g;
4931 if ($string =~ /(?<!%)%[\*\d\.\$]*L[udi]/) {
4933 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
4936 if ($string =~ /0x%[\*\d\.\$\Llzth]*[udi]/) {
4937 ERROR
("PRINTF_0xDECIMAL",
4938 "Prefixing 0x with decimal output is defective\n" . $herecurr);
4942 # check for line continuations in quoted strings with odd counts of "
4943 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
4944 WARN
("LINE_CONTINUATIONS",
4945 "Avoid line continuations in quoted strings\n" . $herecurr);
4949 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
4950 CHK
("REDUNDANT_CODE",
4951 "if this code is redundant consider removing it\n" .
4955 # check for needless "if (<foo>) fn(<foo>)" uses
4956 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
4957 my $tested = quotemeta($1);
4958 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
4959 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
4961 if (WARN
('NEEDLESS_IF',
4962 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
4965 my $leading_tabs = "";
4966 my $new_leading_tabs = "";
4967 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
4972 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
4973 $new_leading_tabs = $1;
4974 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
4981 fix_delete_line
($fixlinenr - 1, $prevrawline);
4982 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
4988 # check for unnecessary "Out of Memory" messages
4989 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
4990 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
4991 (defined $1 || defined $3) &&
4994 my $testline = $lines[$linenr - 3];
4996 my ($s, $c) = ctx_statement_block
($linenr - 3, $realcnt, 0);
4997 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
4999 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
5001 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5005 # check for logging functions with KERN_<LEVEL>
5006 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
5007 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5009 if (WARN
("UNNECESSARY_KERN_LEVEL",
5010 "Possible unnecessary $level\n" . $herecurr) &&
5012 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5016 # check for mask then right shift without a parentheses
5017 if ($^V
&& $^V
ge 5.10.0 &&
5018 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5019 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5020 WARN
("MASK_THEN_SHIFT",
5021 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5024 # check for pointer comparisons to NULL
5025 if ($^V
&& $^V
ge 5.10.0) {
5026 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5029 $equal = "" if ($4 eq "!=");
5030 if (CHK
("COMPARISON_TO_NULL",
5031 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5033 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5038 # check for bad placement of section $InitAttribute (e.g.: __initdata)
5039 if ($line =~ /(\b$InitAttribute\b)/) {
5041 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5044 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5045 ERROR
("MISPLACED_INIT",
5046 "$attr should be placed after $var\n" . $herecurr)) ||
5047 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5048 WARN
("MISPLACED_INIT",
5049 "$attr should be placed after $var\n" . $herecurr))) &&
5051 $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;
5056 # check for $InitAttributeData (ie: __initdata) with const
5057 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5059 $attr =~ /($InitAttributePrefix)(.*)/;
5060 my $attr_prefix = $1;
5062 if (ERROR
("INIT_ATTRIBUTE",
5063 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5065 $fixed[$fixlinenr] =~
5066 s/$InitAttributeData/${attr_prefix}initconst/;
5070 # check for $InitAttributeConst (ie: __initconst) without const
5071 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5073 if (ERROR
("INIT_ATTRIBUTE",
5074 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5076 my $lead = $fixed[$fixlinenr] =~
5077 /(^\+\s*(?:static\s+))/;
5079 $lead = "$lead " if ($lead !~ /^\+$/);
5080 $lead = "${lead}const ";
5081 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
5085 # check for __read_mostly with const non-pointer (should just be const)
5086 if ($line =~ /\b__read_mostly\b/ &&
5087 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5088 if (ERROR
("CONST_READ_MOSTLY",
5089 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5091 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5095 # don't use __constant_<foo> functions outside of include/uapi/
5096 if ($realfile !~ m@
^include
/uapi/@
&&
5097 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5098 my $constant_func = $1;
5099 my $func = $constant_func;
5100 $func =~ s/^__constant_//;
5101 if (WARN
("CONSTANT_CONVERSION",
5102 "$constant_func should be $func\n" . $herecurr) &&
5104 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
5108 # prefer usleep_range over udelay
5109 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
5111 # ignore udelay's < 10, however
5112 if (! ($delay < 10) ) {
5114 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5116 if ($delay > 2000) {
5118 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
5122 # warn about unexpectedly long msleep's
5123 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5126 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5130 # check for comparisons of jiffies
5131 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5132 WARN
("JIFFIES_COMPARISON",
5133 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5136 # check for comparisons of get_jiffies_64()
5137 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5138 WARN
("JIFFIES_COMPARISON",
5139 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5142 # warn about #ifdefs in C files
5143 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5144 # print "#ifdef in C files should be avoided\n";
5145 # print "$herecurr";
5149 # warn about spacing in #ifdefs
5150 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
5151 if (ERROR
("SPACING",
5152 "exactly one space required after that #$1\n" . $herecurr) &&
5154 $fixed[$fixlinenr] =~
5155 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5160 # check for spinlock_t definitions without a comment.
5161 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5162 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
5164 if (!ctx_has_comment
($first_line, $linenr)) {
5165 CHK
("UNCOMMENTED_DEFINITION",
5166 "$1 definition without comment\n" . $herecurr);
5169 # check for memory barriers without a comment.
5175 read_barrier_depends
5177 my $barrier_stems = qr{
5185 my $all_barriers = qr{
5187 smp_
(?
:$barrier_stems)|
5188 virt_
(?
:$barrier_stems)
5191 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
5192 if (!ctx_has_comment
($first_line, $linenr)) {
5193 WARN
("MEMORY_BARRIER",
5194 "memory barrier without comment\n" . $herecurr);
5198 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5200 if ($realfile !~ m@
^include
/asm-generic/@
&&
5201 $realfile !~ m@
/barrier\
.h
$@
&&
5202 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5203 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5204 WARN
("MEMORY_BARRIER",
5205 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5208 # check for waitqueue_active without a comment.
5209 if ($line =~ /\bwaitqueue_active\s*\(/) {
5210 if (!ctx_has_comment
($first_line, $linenr)) {
5211 WARN
("WAITQUEUE_ACTIVE",
5212 "waitqueue_active without comment\n" . $herecurr);
5216 # Check for expedited grace periods that interrupt non-idle non-nohz
5217 # online CPUs. These expedited can therefore degrade real-time response
5218 # if used carelessly, and should be avoided where not absolutely
5219 # needed. It is always OK to use synchronize_rcu_expedited() and
5220 # synchronize_sched_expedited() at boot time (before real-time applications
5221 # start) and in error situations where real-time response is compromised in
5222 # any case. Note that synchronize_srcu_expedited() does -not- interrupt
5223 # other CPUs, so don't warn on uses of synchronize_srcu_expedited().
5224 # Of course, nothing comes for free, and srcu_read_lock() and
5225 # srcu_read_unlock() do contain full memory barriers in payment for
5226 # synchronize_srcu_expedited() non-interruption properties.
5227 if ($line =~ /\b(synchronize_rcu_expedited|synchronize_sched_expedited)\(/) {
5228 WARN
("EXPEDITED_RCU_GRACE_PERIOD",
5229 "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr);
5233 # check of hardware specific defines
5234 if ($line =~ m@
^.\s
*\#\s
*if.*\b(__i386__
|__powerpc64__
|__sun__
|__s390x__
)\b@
&& $realfile !~ m
@include/asm
-@
) {
5236 "architecture specific defines should be avoided\n" . $herecurr);
5239 # Check that the storage class is at the beginning of a declaration
5240 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
5241 WARN
("STORAGE_CLASS",
5242 "storage class should be at the beginning of the declaration\n" . $herecurr)
5245 # check the location of the inline attribute, that it is between
5246 # storage class and type.
5247 if ($line =~ /\b$Type\s+$Inline\b/ ||
5248 $line =~ /\b$Inline\s+$Storage\b/) {
5249 ERROR
("INLINE_LOCATION",
5250 "inline keyword should sit between storage class and type\n" . $herecurr);
5253 # Check for __inline__ and __inline, prefer inline
5254 if ($realfile !~ m@
\binclude
/uapi/@
&&
5255 $line =~ /\b(__inline__|__inline)\b/) {
5257 "plain inline is preferred over $1\n" . $herecurr) &&
5259 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
5264 # Check for __attribute__ packed, prefer __packed
5265 if ($realfile !~ m@
\binclude
/uapi/@
&&
5266 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
5267 WARN
("PREFER_PACKED",
5268 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
5271 # Check for __attribute__ aligned, prefer __aligned
5272 if ($realfile !~ m@
\binclude
/uapi/@
&&
5273 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
5274 WARN
("PREFER_ALIGNED",
5275 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
5278 # Check for __attribute__ format(printf, prefer __printf
5279 if ($realfile !~ m@
\binclude
/uapi/@
&&
5280 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
5281 if (WARN
("PREFER_PRINTF",
5282 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5284 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5289 # Check for __attribute__ format(scanf, prefer __scanf
5290 if ($realfile !~ m@
\binclude
/uapi/@
&&
5291 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
5292 if (WARN
("PREFER_SCANF",
5293 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5295 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5299 # Check for __attribute__ weak, or __weak declarations (may have link issues)
5300 if ($^V
&& $^V
ge 5.10.0 &&
5301 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5302 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5303 $line =~ /\b__weak\b/)) {
5304 ERROR
("WEAK_DECLARATION",
5305 "Using weak declarations can have unintended link defects\n" . $herecurr);
5308 # check for c99 types like uint8_t used outside of uapi/
5309 if ($realfile !~ m@
\binclude
/uapi/@
&&
5310 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5312 if ($type =~ /\b($typeC99Typedefs)\b/) {
5314 my $kernel_type = 'u';
5315 $kernel_type = 's' if ($type =~ /^_*[si]/);
5318 if (CHK
("PREFER_KERNEL_TYPES",
5319 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5321 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5326 # check for cast of C90 native int or longer types constants
5327 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5330 if (WARN
("TYPECAST_INT_CONSTANT",
5331 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5334 my $newconst = $const;
5335 $newconst =~ s/${Int_type}$//;
5336 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5337 if ($cast =~ /\blong\s+long\b/) {
5339 } elsif ($cast =~ /\blong\b/) {
5342 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5346 # check for sizeof(&)
5347 if ($line =~ /\bsizeof\s*\(\s*\&/) {
5348 WARN
("SIZEOF_ADDRESS",
5349 "sizeof(& should be avoided\n" . $herecurr);
5352 # check for sizeof without parenthesis
5353 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
5354 if (WARN
("SIZEOF_PARENTHESIS",
5355 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5357 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5361 # check for struct spinlock declarations
5362 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5363 WARN
("USE_SPINLOCK_T",
5364 "struct spinlock should be spinlock_t\n" . $herecurr);
5367 # check for seq_printf uses that could be seq_puts
5368 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
5369 my $fmt = get_quoted_string
($line, $rawline);
5372 if (WARN
("PREFER_SEQ_PUTS",
5373 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5375 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
5380 # Check for misused memsets
5381 if ($^V
&& $^V
ge 5.10.0 &&
5383 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
5389 if ($ms_size =~ /^(0x|)0$/i) {
5391 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
5392 } elsif ($ms_size =~ /^(0x|)1$/i) {
5394 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5398 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5399 if ($^V
&& $^V
ge 5.10.0 &&
5401 $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5402 if (WARN
("PREFER_ETHER_ADDR_COPY",
5403 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5405 $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5409 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5410 if ($^V
&& $^V
ge 5.10.0 &&
5412 $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5413 WARN
("PREFER_ETHER_ADDR_EQUAL",
5414 "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5417 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5418 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5419 if ($^V
&& $^V
ge 5.10.0 &&
5421 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5425 if ($ms_val =~ /^(?:0x|)0+$/i) {
5426 if (WARN
("PREFER_ETH_ZERO_ADDR",
5427 "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5429 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5431 } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5432 if (WARN
("PREFER_ETH_BROADCAST_ADDR",
5433 "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5435 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5440 # typecasts on min/max could be min_t/max_t
5441 if ($^V
&& $^V
ge 5.10.0 &&
5443 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
5444 if (defined $2 || defined $7) {
5446 my $cast1 = deparenthesize
($2);
5448 my $cast2 = deparenthesize
($7);
5452 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
5453 $cast = "$cast1 or $cast2";
5454 } elsif ($cast1 ne "") {
5460 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
5464 # check usleep_range arguments
5465 if ($^V
&& $^V
ge 5.10.0 &&
5467 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5471 WARN
("USLEEP_RANGE",
5472 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5473 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5475 WARN
("USLEEP_RANGE",
5476 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5480 # check for naked sscanf
5481 if ($^V
&& $^V
ge 5.10.0 &&
5483 $line =~ /\bsscanf\b/ &&
5484 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5485 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5486 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5487 my $lc = $stat =~ tr@
\n@@
;
5488 $lc = $lc + $linenr;
5489 my $stat_real = raw_line
($linenr, 0);
5490 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5491 $stat_real = $stat_real . "\n" . raw_line
($count, 0);
5493 WARN
("NAKED_SSCANF",
5494 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5497 # check for simple sscanf that should be kstrto<foo>
5498 if ($^V
&& $^V
ge 5.10.0 &&
5500 $line =~ /\bsscanf\b/) {
5501 my $lc = $stat =~ tr@
\n@@
;
5502 $lc = $lc + $linenr;
5503 my $stat_real = raw_line
($linenr, 0);
5504 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5505 $stat_real = $stat_real . "\n" . raw_line
($count, 0);
5507 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5509 my $count = $format =~ tr@
%@
%@
;
5511 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5512 WARN
("SSCANF_TO_KSTRTO",
5513 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5518 # check for new externs in .h files.
5519 if ($realfile =~ /\.h$/ &&
5520 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
5521 if (CHK
("AVOID_EXTERNS",
5522 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
5524 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
5528 # check for new externs in .c files.
5529 if ($realfile =~ /\.c$/ && defined $stat &&
5530 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
5532 my $function_name = $1;
5533 my $paren_space = $2;
5536 if (defined $cond) {
5537 substr($s, 0, length($cond), '');
5539 if ($s =~ /^\s*;/ &&
5540 $function_name ne 'uninitialized_var')
5542 WARN
("AVOID_EXTERNS",
5543 "externs should be avoided in .c files\n" . $herecurr);
5546 if ($paren_space =~ /\n/) {
5547 WARN
("FUNCTION_ARGUMENTS",
5548 "arguments for function declarations should follow identifier\n" . $herecurr);
5551 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5552 $stat =~ /^.\s*extern\s+/)
5554 WARN
("AVOID_EXTERNS",
5555 "externs should be avoided in .c files\n" . $herecurr);
5558 # checks for new __setup's
5559 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5562 if (!grep(/$name/, @setup_docs)) {
5563 CHK
("UNDOCUMENTED_SETUP",
5564 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
5568 # check for pointless casting of kmalloc return
5569 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
5570 WARN
("UNNECESSARY_CASTS",
5571 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
5575 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5576 if ($^V
&& $^V
ge 5.10.0 &&
5577 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5578 CHK
("ALLOC_SIZEOF_STRUCT",
5579 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
5582 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5583 if ($^V
&& $^V
ge 5.10.0 &&
5584 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
5588 my $newfunc = "kmalloc_array";
5589 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
5592 if ($a1 =~ /^sizeof\s*\S/) {
5596 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
5597 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
5598 if (WARN
("ALLOC_WITH_MULTIPLY",
5599 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
5601 $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;
5607 # check for krealloc arg reuse
5608 if ($^V
&& $^V
ge 5.10.0 &&
5609 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
5610 WARN
("KREALLOC_ARG_REUSE",
5611 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
5614 # check for alloc argument mismatch
5615 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
5616 WARN
("ALLOC_ARRAY_ARGS",
5617 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
5620 # check for multiple semicolons
5621 if ($line =~ /;\s*;\s*$/) {
5622 if (WARN
("ONE_SEMICOLON",
5623 "Statements terminations use 1 semicolon\n" . $herecurr) &&
5625 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
5629 # check for #defines like: 1 << <digit> that could be BIT(digit)
5630 if ($line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
5632 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
5633 if (CHK
("BIT_MACRO",
5634 "Prefer using the BIT$ull macro\n" . $herecurr) &&
5636 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
5640 # check for case / default statements not preceded by break/fallthrough/switch
5641 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
5643 my $has_statement = 0;
5645 my $prevline = $linenr;
5646 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
5648 my $rline = $rawlines[$prevline - 1];
5649 my $fline = $lines[$prevline - 1];
5650 last if ($fline =~ /^\@\@/);
5651 next if ($fline =~ /^\-/);
5652 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
5653 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
5654 next if ($fline =~ /^.[\s$;]*$/);
5657 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
5659 if (!$has_break && $has_statement) {
5660 WARN
("MISSING_BREAK",
5661 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
5665 # check for switch/default statements without a break;
5666 if ($^V
&& $^V
ge 5.10.0 &&
5668 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
5670 my $herectx = $here . "\n";
5671 my $cnt = statement_rawlines
($stat);
5672 for (my $n = 0; $n < $cnt; $n++) {
5673 $herectx .= raw_line
($linenr, $n) . "\n";
5675 WARN
("DEFAULT_NO_BREAK",
5676 "switch default: should use break\n" . $herectx);
5679 # check for gcc specific __FUNCTION__
5680 if ($line =~ /\b__FUNCTION__\b/) {
5681 if (WARN
("USE_FUNC",
5682 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
5684 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
5688 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
5689 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
5691 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
5694 # check for use of yield()
5695 if ($line =~ /\byield\s*\(\s*\)/) {
5697 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
5700 # check for comparisons against true and false
5701 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
5709 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
5711 my $type = lc($otype);
5712 if ($type =~ /^(?:true|false)$/) {
5713 if (("$test" eq "==" && "$type" eq "true") ||
5714 ("$test" eq "!=" && "$type" eq "false")) {
5718 CHK
("BOOL_COMPARISON",
5719 "Using comparison to $otype is error prone\n" . $herecurr);
5721 ## maybe suggesting a correct construct would better
5722 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5727 # check for semaphores initialized locked
5728 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
5729 WARN
("CONSIDER_COMPLETION",
5730 "consider using a completion\n" . $herecurr);
5733 # recommend kstrto* over simple_strto* and strict_strto*
5734 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
5735 WARN
("CONSIDER_KSTRTO",
5736 "$1 is obsolete, use k$3 instead\n" . $herecurr);
5739 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
5740 if ($line =~ /^.\s*__initcall\s*\(/) {
5741 WARN
("USE_DEVICE_INITCALL",
5742 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
5745 # check for various structs that are normally const (ops, kgdb, device_tree)
5746 my $const_structs = qr{
5748 address_space_operations
|
5750 block_device_operations
|
5755 file_lock_operations
|
5765 lock_manager_operations
|
5772 pipe_buf_operations
|
5773 platform_hibernation_ops
|
5774 platform_suspend_ops
|
5779 soc_pcmcia_socket_ops
|
5786 if ($line !~ /\bconst\b/ &&
5787 $line =~ /\bstruct\s+($const_structs)\b/) {
5788 WARN
("CONST_STRUCT",
5789 "struct $1 should normally be const\n" .
5793 # use of NR_CPUS is usually wrong
5794 # ignore definitions of NR_CPUS and usage to define arrays as likely right
5795 if ($line =~ /\bNR_CPUS\b/ &&
5796 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
5797 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
5798 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
5799 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
5800 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
5803 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
5806 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
5807 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
5808 ERROR
("DEFINE_ARCH_HAS",
5809 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
5812 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
5813 if ($^V
&& $^V
ge 5.10.0 &&
5814 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
5815 WARN
("LIKELY_MISUSE",
5816 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
5819 # whine mightly about in_atomic
5820 if ($line =~ /\bin_atomic\s*\(/) {
5821 if ($realfile =~ m@
^drivers
/@
) {
5823 "do not use in_atomic in drivers\n" . $herecurr);
5824 } elsif ($realfile !~ m@
^kernel
/@
) {
5826 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
5830 # check for lockdep_set_novalidate_class
5831 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
5832 $line =~ /__lockdep_no_validate__\s*\)/ ) {
5833 if ($realfile !~ m@
^kernel
/lockdep@
&&
5834 $realfile !~ m@
^include
/linux/lockdep@
&&
5835 $realfile !~ m@
^drivers
/base/core@
) {
5837 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
5841 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
5842 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
5843 WARN
("EXPORTED_WORLD_WRITABLE",
5844 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5847 # Mode permission misuses where it seems decimal should be octal
5848 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5849 if ($^V
&& $^V
ge 5.10.0 &&
5850 $line =~ /$mode_perms_search/) {
5851 foreach my $entry (@mode_permission_funcs) {
5852 my $func = $entry->[0];
5853 my $arg_pos = $entry->[1];
5858 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
5860 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
5861 if ($line =~ /$test/) {
5863 $val = $6 if ($skip_args ne "");
5865 if ($val !~ /^0$/ &&
5866 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
5867 length($val) ne 4)) {
5868 ERROR
("NON_OCTAL_PERMISSIONS",
5869 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
5870 } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) {
5871 ERROR
("EXPORTED_WORLD_WRITABLE",
5872 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5878 # validate content of MODULE_LICENSE against list from include/linux/module.h
5879 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
5880 my $extracted_string = get_quoted_string
($line, $rawline);
5881 my $valid_licenses = qr{
5884 GPL\
and\ additional\ rights
|
5890 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
5891 WARN
("MODULE_LICENSE",
5892 "unknown module license " . $extracted_string . "\n" . $herecurr);
5897 # If we have no input at all, then there is nothing to report on
5898 # so just keep quiet.
5899 if ($#rawlines == -1) {
5903 # In mailback mode only produce a report in the negative, for
5904 # things that appear to be patches.
5905 if ($mailback && ($clean == 1 || !$is_patch)) {
5909 # This is not a patch, and we are are in 'no-patch' mode so
5911 if (!$chk_patch && !$is_patch) {
5915 if (!$is_patch && $file !~ /cover-letter\.patch$/) {
5916 ERROR
("NOT_UNIFIED_DIFF",
5917 "Does not appear to be a unified-diff format patch\n");
5919 if ($is_patch && $filename ne '-' && $chk_signoff && $signoff == 0) {
5920 ERROR
("MISSING_SIGN_OFF",
5921 "Missing Signed-off-by: line(s)\n");
5924 print report_dump
();
5925 if ($summary && !($clean == 1 && $quiet == 1)) {
5926 print "$filename " if ($summary_file);
5927 print "total: $cnt_error errors, $cnt_warn warnings, " .
5928 (($check)?
"$cnt_chk checks, " : "") .
5929 "$cnt_lines lines checked\n";
5933 # If there were whitespace errors which cleanpatch can fix
5934 # then suggest that.
5935 if ($rpt_cleaners) {
5939 NOTE
: Whitespace errors detected
.
5940 You may wish to
use scripts
/cleanpatch or scripts/cleanfile
5945 if ($clean == 0 && $fix &&
5946 ("@rawlines" ne "@fixed" ||
5947 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
5948 my $newfile = $filename;
5949 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
5953 @fixed = fix_inserted_deleted_lines
(\
@fixed, \
@fixed_inserted, \
@fixed_deleted);
5955 open($f, '>', $newfile)
5956 or die "$P: Can't open $newfile for write\n";
5957 foreach my $fixed_line (@fixed) {
5960 if ($linecount > 3) {
5961 $fixed_line =~ s/^\+//;
5962 print $f $fixed_line . "\n";
5965 print $f $fixed_line . "\n";
5973 Wrote EXPERIMENTAL
--fix correction
(s
) to
'$newfile'
5975 Do _NOT_ trust the results written to this file
.
5976 Do _NOT_ submit these changes without inspecting them
for correctness
.
5978 This EXPERIMENTAL file is simply a convenience to help rewrite patches
.
5979 No warranties
, expressed
or implied
...
5987 print "$vname has no obvious style problems and is ready for submission.\n";
5989 print "$vname has style problems, please review.\n";