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);
49 my $configuration_file = ".checkpatch.conf";
50 my $max_line_length = 80;
51 my $ignore_perl_version = 0;
52 my $minimum_perl_version = 5.10.0;
53 my $min_conf_desc_length = 4;
54 my $spelling_file = "$D/spelling.txt";
56 my $codespellfile = "/usr/share/codespell/dictionary.txt";
58 my $allow_c99_comments = 1;
64 Usage: $P [OPTION]... [FILE]...
69 --no-tree run without a kernel tree
70 --no-signoff do not check for 'Signed-off-by' line
71 --patch treat FILE as patchfile (default)
72 --emacs emacs compile window format
73 --terse one line per report
74 --showfile emit diffed file position, not input file position
75 -g, --git treat FILE as a single commit or git revision range
76 single git commit with:
80 multiple git commits with:
84 git merges are ignored
85 -f, --file treat FILE as regular source file
86 --subjective, --strict enable more subjective tests
87 --list-types list the possible message types
88 --types TYPE(,TYPE2...) show only these comma separated message types
89 --ignore TYPE(,TYPE2...) ignore various comma separated message types
90 --show-types show the specific message type in the output
91 --max-line-length=n set the maximum line length, if exceeded, warn
92 --min-conf-desc-length=n set the min description length, if shorter, warn
93 --root=PATH PATH to the kernel tree root
94 --no-summary suppress the per-file summary
95 --mailback only produce a report in case of warnings/errors
96 --summary-file include the filename in summary
97 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
98 'values', 'possible', 'type', and 'attr' (default
100 --test-only=WORD report only warnings/errors containing WORD
102 --fix EXPERIMENTAL - may create horrible results
103 If correctable single-line errors exist, create
104 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
105 with potential errors corrected to the preferred
107 --fix-inplace EXPERIMENTAL - may create horrible results
108 Is the same as --fix, but overwrites the input
109 file. It's your fault if there's no backup or git
110 --ignore-perl-version override checking of perl version. expect
112 --codespell Use the codespell dictionary for spelling/typos
113 (default:/usr/share/codespell/dictionary.txt)
114 --codespellfile Use this codespell dictionary
115 --color Use colors when output is STDOUT (default: on)
116 -h, --help, --version display this help and exit
118 When FILE is - read standard input.
126 return grep { !$seen{$_}++ } @_;
136 open(my $script, '<', abs_path($P)) or
137 die "$P: Can't read '$P' $!\n";
139 my $text = <$script>;
143 for ($text =~ /\b(?:(?:CHK|WARN|ERROR)\s*\(\s*"([^"]+)")/g) {
146 @types = sort(uniq(@types));
147 print("#\tMessage type\n\n");
148 foreach my $type (@types) {
149 print(++$count . "\t" . $type . "\n");
155 my $conf = which_conf($configuration_file);
158 open(my $conffile, '<', "$conf")
159 or warn "$P: Can't find a readable $configuration_file file $!\n";
161 while (<$conffile>) {
164 $line =~ s/\s*\n?$//g;
168 next if ($line =~ m/^\s*#/);
169 next if ($line =~ m/^\s*$/);
171 my @words = split(" ", $line);
172 foreach my $word (@words) {
173 last if ($word =~ m/^#/);
174 push (@conf_args, $word);
178 unshift(@ARGV, @conf_args) if @conf_args;
182 'q|quiet+' => \$quiet,
184 'signoff!' => \$chk_signoff,
185 'patch!' => \$chk_patch,
188 'showfile!' => \$showfile,
191 'subjective!' => \$check,
192 'strict!' => \$check,
193 'ignore=s' => \@ignore,
195 'show-types!' => \$show_types,
196 'list-types!' => \$list_types,
197 'max-line-length=i' => \$max_line_length,
198 'min-conf-desc-length=i' => \$min_conf_desc_length,
200 'summary!' => \$summary,
201 'mailback!' => \$mailback,
202 'summary-file!' => \$summary_file,
204 'fix-inplace!' => \$fix_inplace,
205 'ignore-perl-version!' => \$ignore_perl_version,
206 'debug=s' => \%debug,
207 'test-only=s' => \$tst_only,
208 'codespell!' => \$codespell,
209 'codespellfile=s' => \$codespellfile,
217 list_types(0) if ($list_types);
219 $fix = 1 if ($fix_inplace);
220 $check_orig = $check;
224 if ($^V && $^V lt $minimum_perl_version) {
225 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
226 if (!$ignore_perl_version) {
232 print "$P: no input files\n";
236 sub hash_save_array_words {
237 my ($hashRef, $arrayRef) = @_;
239 my @array = split(/,/, join(',', @$arrayRef));
240 foreach my $word (@array) {
241 $word =~ s/\s*\n?$//g;
244 $word =~ tr/[a-z]/[A-Z]/;
246 next if ($word =~ m/^\s*#/);
247 next if ($word =~ m/^\s*$/);
253 sub hash_show_words {
254 my ($hashRef, $prefix) = @_;
256 if (keys %$hashRef) {
257 print "\nNOTE: $prefix message types:";
258 foreach my $word (sort keys %$hashRef) {
265 hash_save_array_words(\%ignore_type, \@ignore);
266 hash_save_array_words(\%use_type, \@use);
269 my $dbg_possible = 0;
272 for my $key (keys %debug) {
274 eval "\${dbg_$key} = '$debug{$key}';";
278 my $rpt_cleaners = 0;
287 if (!top_of_kernel_tree($root)) {
288 die "$P: $root: --root does not point at a valid tree\n";
291 if (top_of_kernel_tree('.')) {
293 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
294 top_of_kernel_tree($1)) {
299 if (!defined $root) {
300 print "Must be run from the top-level dir. of a kernel tree\n";
305 my $emitted_corrupt = 0;
308 [A-Za-z_][A-Za-z\d_]*
309 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
311 our $Storage = qr{extern|static|asmlinkage};
324 our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
325 our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
326 our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
327 our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
328 our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
330 # Notes to $Attribute:
331 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
352 ____cacheline_aligned|
353 ____cacheline_aligned_in_smp|
354 ____cacheline_internodealigned_in_smp|
358 our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
359 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
360 our $Lval = qr{$Ident(?:$Member)*};
362 our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
363 our $Binary = qr{(?i)0b[01]+$Int_type?};
364 our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
365 our $Int = qr{[0-9]+$Int_type?};
366 our $Octal = qr{0[0-7]+$Int_type?};
367 our $String = qr{"[X\t]*"};
368 our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
369 our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
370 our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
371 our $Float = qr{$Float_hex|$Float_dec|$Float_int};
372 our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
373 our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
374 our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
375 our $Arithmetic = qr{\+|-|\*|\/|%};
379 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
382 our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
386 our $NonptrTypeMisordered;
387 our $NonptrTypeWithAttr;
391 our $DeclareMisordered;
393 our $NON_ASCII_UTF8 = qr{
394 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
395 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
396 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
397 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
398 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
399 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
400 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
404 [\x09\x0A\x0D\x20-\x7E] # ASCII
408 our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
409 our $typeOtherOSTypedefs = qr{(?x:
410 u_(?:char|short|int|long) | # bsd
411 u(?:nchar|short|int|long) # sysv
413 our $typeKernelTypedefs = qr{(?x:
414 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
417 our $typeTypedefs = qr{(?x:
419 $typeOtherOSTypedefs\b|
420 $typeKernelTypedefs\b
423 our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
425 our $logFunctions = qr{(?x:
426 printk(?:_ratelimited|_once|)|
427 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
428 WARN(?:_RATELIMIT|_ONCE|)|
431 seq_vprintf|seq_printf|seq_puts
434 our $signature_tags = qr{(?xi:
445 our @typeListMisordered = (
446 qr{char\s+(?:un)?signed},
447 qr{int\s+(?:(?:un)?signed\s+)?short\s},
448 qr{int\s+short(?:\s+(?:un)?signed)},
449 qr{short\s+int(?:\s+(?:un)?signed)},
450 qr{(?:un)?signed\s+int\s+short},
451 qr{short\s+(?:un)?signed},
452 qr{long\s+int\s+(?:un)?signed},
453 qr{int\s+long\s+(?:un)?signed},
454 qr{long\s+(?:un)?signed\s+int},
455 qr{int\s+(?:un)?signed\s+long},
456 qr{int\s+(?:un)?signed},
457 qr{int\s+long\s+long\s+(?:un)?signed},
458 qr{long\s+long\s+int\s+(?:un)?signed},
459 qr{long\s+long\s+(?:un)?signed\s+int},
460 qr{long\s+long\s+(?:un)?signed},
461 qr{long\s+(?:un)?signed},
466 qr{(?:(?:un)?signed\s+)?char},
467 qr{(?:(?:un)?signed\s+)?short\s+int},
468 qr{(?:(?:un)?signed\s+)?short},
469 qr{(?:(?:un)?signed\s+)?int},
470 qr{(?:(?:un)?signed\s+)?long\s+int},
471 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
472 qr{(?:(?:un)?signed\s+)?long\s+long},
473 qr{(?:(?:un)?signed\s+)?long},
482 qr{${Ident}_handler},
483 qr{${Ident}_handler_fn},
487 our $C90_int_types = qr{(?x:
488 long\s+long\s+int\s+(?:un)?signed|
489 long\s+long\s+(?:un)?signed\s+int|
490 long\s+long\s+(?:un)?signed|
491 (?:(?:un)?signed\s+)?long\s+long\s+int|
492 (?:(?:un)?signed\s+)?long\s+long|
493 int\s+long\s+long\s+(?:un)?signed|
494 int\s+(?:(?:un)?signed\s+)?long\s+long|
496 long\s+int\s+(?:un)?signed|
497 long\s+(?:un)?signed\s+int|
498 long\s+(?:un)?signed|
499 (?:(?:un)?signed\s+)?long\s+int|
500 (?:(?:un)?signed\s+)?long|
501 int\s+long\s+(?:un)?signed|
502 int\s+(?:(?:un)?signed\s+)?long|
505 (?:(?:un)?signed\s+)?int
508 our @typeListFile = ();
509 our @typeListWithAttr = (
511 qr{struct\s+$InitAttribute\s+$Ident},
512 qr{union\s+$InitAttribute\s+$Ident},
515 our @modifierList = (
518 our @modifierListFile = ();
520 our @mode_permission_funcs = (
522 ["module_param_(?:array|named|string)", 4],
523 ["module_param_array_named", 5],
524 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
525 ["proc_create(?:_data|)", 2],
526 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
529 #Create a search pattern for all these functions to speed up a loop below
530 our $mode_perms_search = "";
531 foreach my $entry (@mode_permission_funcs) {
532 $mode_perms_search .= '|' if ($mode_perms_search ne "");
533 $mode_perms_search .= $entry->[0];
536 our $mode_perms_world_writable = qr{
544 our $allowed_asm_includes = qr{(?x:
550 # memory.h: ARM has a custom one
552 # Load common spelling mistakes and build regular expression list.
556 if (open(my $spelling, '<', $spelling_file)) {
557 while (<$spelling>) {
560 $line =~ s/\s*\n?$//g;
563 next if ($line =~ m/^\s*#/);
564 next if ($line =~ m/^\s*$/);
566 my ($suspect, $fix) = split(/\|\|/, $line);
568 $spelling_fix{$suspect} = $fix;
572 warn "No typos will be found - file '$spelling_file': $!\n";
576 if (open(my $spelling, '<', $codespellfile)) {
577 while (<$spelling>) {
580 $line =~ s/\s*\n?$//g;
583 next if ($line =~ m/^\s*#/);
584 next if ($line =~ m/^\s*$/);
585 next if ($line =~ m/, disabled/i);
589 my ($suspect, $fix) = split(/->/, $line);
591 $spelling_fix{$suspect} = $fix;
595 warn "No codespell typos will be found - file '$codespellfile': $!\n";
599 $misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
602 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
603 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
604 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
605 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
606 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
612 (?:$Modifier\s+|const\s+)*
614 (?:typeof|__typeof__)\s*\([^\)]*\)|
618 (?:\s+$Modifier|\s+const)*
620 $NonptrTypeMisordered = qr{
621 (?:$Modifier\s+|const\s+)*
625 (?:\s+$Modifier|\s+const)*
627 $NonptrTypeWithAttr = qr{
628 (?:$Modifier\s+|const\s+)*
630 (?:typeof|__typeof__)\s*\([^\)]*\)|
634 (?:\s+$Modifier|\s+const)*
638 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
639 (?:\s+$Inline|\s+$Modifier)*
641 $TypeMisordered = qr{
642 $NonptrTypeMisordered
643 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
644 (?:\s+$Inline|\s+$Modifier)*
646 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
647 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
651 our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
653 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
654 # requires at least perl version v5.10.0
655 # Any use must be runtime checked with $^V
657 our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
658 our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
659 our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
661 our $declaration_macros = qr{(?x:
662 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
663 (?:$Storage\s+)?LIST_HEAD\s*\(|
664 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
669 return "" if (!defined($string));
671 while ($string =~ /^\s*\(.*\)\s*$/) {
672 $string =~ s@^\s*\(\s*@@;
673 $string =~ s@\s*\)\s*$@@;
676 $string =~ s@\s+@ @g;
681 sub seed_camelcase_file {
684 return if (!(-f $file));
688 open(my $include_file, '<', "$file")
689 or warn "$P: Can't read '$file' $!\n";
690 my $text = <$include_file>;
691 close($include_file);
693 my @lines = split('\n', $text);
695 foreach my $line (@lines) {
696 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
697 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
699 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
701 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
707 my $camelcase_seeded = 0;
708 sub seed_camelcase_includes {
709 return if ($camelcase_seeded);
712 my $camelcase_cache = "";
713 my @include_files = ();
715 $camelcase_seeded = 1;
718 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
719 chomp $git_last_include_commit;
720 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
722 my $last_mod_date = 0;
723 $files = `find $root/include -name "*.h"`;
724 @include_files = split('\n', $files);
725 foreach my $file (@include_files) {
726 my $date = POSIX::strftime("%Y%m%d%H%M",
727 localtime((stat $file)[9]));
728 $last_mod_date = $date if ($last_mod_date < $date);
730 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
733 if ($camelcase_cache ne "" && -f $camelcase_cache) {
734 open(my $camelcase_file, '<', "$camelcase_cache")
735 or warn "$P: Can't read '$camelcase_cache' $!\n";
736 while (<$camelcase_file>) {
740 close($camelcase_file);
746 $files = `git ls-files "include/*.h"`;
747 @include_files = split('\n', $files);
750 foreach my $file (@include_files) {
751 seed_camelcase_file($file);
754 if ($camelcase_cache ne "") {
755 unlink glob ".checkpatch-camelcase.*";
756 open(my $camelcase_file, '>', "$camelcase_cache")
757 or warn "$P: Can't write '$camelcase_cache' $!\n";
758 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
759 print $camelcase_file ("$_\n");
761 close($camelcase_file);
765 sub git_commit_info {
766 my ($commit, $id, $desc) = @_;
768 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
770 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
771 $output =~ s/^\s*//gm;
772 my @lines = split("\n", $output);
774 return ($id, $desc) if ($#lines < 0);
776 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
777 # Maybe one day convert this block of bash into something that returns
778 # all matching commit ids, but it's very slow...
780 # echo "checking commits $1..."
781 # git rev-list --remotes | grep -i "^$1" |
782 # while read line ; do
783 # git log --format='%H %s' -1 $line |
784 # echo "commit $(cut -c 1-12,41-)"
786 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
788 $id = substr($lines[0], 0, 12);
789 $desc = substr($lines[0], 41);
795 $chk_signoff = 0 if ($file);
800 my @fixed_inserted = ();
801 my @fixed_deleted = ();
804 # If input is git commits, extract all commits from the commit expressions.
805 # For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
806 die "$P: No git repository found\n" if ($git && !-e ".git");
810 foreach my $commit_expr (@ARGV) {
812 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
813 $git_range = "-$2 $1";
814 } elsif ($commit_expr =~ m/\.\./) {
815 $git_range = "$commit_expr";
817 $git_range = "-1 $commit_expr";
819 my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
820 foreach my $line (split(/\n/, $lines)) {
821 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
822 next if (!defined($1) || !defined($2));
825 unshift(@commits, $sha1);
826 $git_commits{$sha1} = $subject;
829 die "$P: no git commits after extraction!\n" if (@commits == 0);
834 for my $filename (@ARGV) {
837 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
838 die "$P: $filename: git format-patch failed - $!\n";
840 open($FILE, '-|', "diff -u /dev/null $filename") ||
841 die "$P: $filename: diff failed - $!\n";
842 } elsif ($filename eq '-') {
843 open($FILE, '<&STDIN');
845 open($FILE, '<', "$filename") ||
846 die "$P: $filename: open failed - $!\n";
848 if ($filename eq '-') {
849 $vname = 'Your patch';
851 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
861 if ($#ARGV > 0 && $quiet == 0) {
862 print '-' x length($vname) . "\n";
864 print '-' x length($vname) . "\n";
867 if (!process($filename)) {
873 @fixed_inserted = ();
876 @modifierListFile = ();
882 hash_show_words(\%use_type, "Used");
883 hash_show_words(\%ignore_type, "Ignored");
888 NOTE: perl $^V is not modern enough to detect all possible issues.
889 An upgrade to at least perl v5.10.0 is suggested.
895 NOTE: If any of the errors are false positives, please report
896 them to the maintainer, see CHECKPATCH in MAINTAINERS.
903 sub top_of_kernel_tree {
907 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
908 "README", "Documentation", "arch", "include", "drivers",
909 "fs", "init", "ipc", "kernel", "lib", "scripts",
912 foreach my $check (@tree_check) {
913 if (! -e $root . '/' . $check) {
921 my ($formatted_email) = @_;
927 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
930 $comment = $3 if defined $3;
931 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
933 $comment = $2 if defined $2;
934 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
936 $comment = $2 if defined $2;
937 $formatted_email =~ s/$address.*$//;
938 $name = $formatted_email;
940 $name =~ s/^\"|\"$//g;
941 # If there's a name left after stripping spaces and
942 # leading quotes, and the address doesn't have both
943 # leading and trailing angle brackets, the address
945 # "joe smith joe@smith.com" bad
946 # "joe smith <joe@smith.com" bad
947 if ($name ne "" && $address !~ /^<[^>]+>$/) {
955 $name =~ s/^\"|\"$//g;
956 $address = trim($address);
957 $address =~ s/^\<|\>$//g;
959 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
960 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
964 return ($name, $address, $comment);
968 my ($name, $address) = @_;
973 $name =~ s/^\"|\"$//g;
974 $address = trim($address);
976 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
977 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
982 $formatted_email = "$address";
984 $formatted_email = "$name <$address>";
987 return $formatted_email;
993 foreach my $path (split(/:/, $ENV{PATH})) {
994 if (-e "$path/$bin") {
1005 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1006 if (-e "$path/$conf") {
1007 return "$path/$conf";
1019 for my $c (split(//, $str)) {
1023 for (; ($n % 8) != 0; $n++) {
1035 (my $res = shift) =~ tr/\t/ /c;
1042 # Drop the diff line leader and expand tabs
1044 $line = expand_tabs($line);
1046 # Pick the indent from the front of the line.
1047 my ($white) = ($line =~ /^(\s*)/);
1049 return (length($line), length($white));
1052 my $sanitise_quote = '';
1054 sub sanitise_line_reset {
1055 my ($in_comment) = @_;
1058 $sanitise_quote = '*/';
1060 $sanitise_quote = '';
1073 # Always copy over the diff marker.
1074 $res = substr($line, 0, 1);
1076 for ($off = 1; $off < length($line); $off++) {
1077 $c = substr($line, $off, 1);
1079 # Comments we are wacking completly including the begin
1080 # and end, all to $;.
1081 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1082 $sanitise_quote = '*/';
1084 substr($res, $off, 2, "$;$;");
1088 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
1089 $sanitise_quote = '';
1090 substr($res, $off, 2, "$;$;");
1094 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1095 $sanitise_quote = '//';
1097 substr($res, $off, 2, $sanitise_quote);
1102 # A \ in a string means ignore the next character.
1103 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1105 substr($res, $off, 2, 'XX');
1110 if ($c eq "'" || $c eq '"') {
1111 if ($sanitise_quote eq '') {
1112 $sanitise_quote = $c;
1114 substr($res, $off, 1, $c);
1116 } elsif ($sanitise_quote eq $c) {
1117 $sanitise_quote = '';
1121 #print "c<$c> SQ<$sanitise_quote>\n";
1122 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1123 substr($res, $off, 1, $;);
1124 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1125 substr($res, $off, 1, $;);
1126 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1127 substr($res, $off, 1, 'X');
1129 substr($res, $off, 1, $c);
1133 if ($sanitise_quote eq '//') {
1134 $sanitise_quote = '';
1137 # The pathname on a #include may be surrounded by '<' and '>'.
1138 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
1139 my $clean = 'X' x length($1);
1140 $res =~ s@\<.*\>@<$clean>@;
1142 # The whole of a #error is a string.
1143 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
1144 my $clean = 'X' x length($1);
1145 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
1148 if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1150 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1156 sub get_quoted_string {
1157 my ($line, $rawline) = @_;
1159 return "" if ($line !~ m/($String)/g);
1160 return substr($rawline, $-[0], $+[0] - $-[0]);
1163 sub ctx_statement_block {
1164 my ($linenr, $remain, $off) = @_;
1165 my $line = $linenr - 1;
1168 my $coff = $off - 1;
1182 @stack = (['', 0]) if ($#stack == -1);
1184 #warn "CSB: blk<$blk> remain<$remain>\n";
1185 # If we are about to drop off the end, pull in more
1188 for (; $remain > 0; $line++) {
1189 last if (!defined $lines[$line]);
1190 next if ($lines[$line] =~ /^-/);
1193 $blk .= $lines[$line] . "\n";
1194 $len = length($blk);
1198 # Bail if there is no further context.
1199 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1203 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1209 $c = substr($blk, $off, 1);
1210 $remainder = substr($blk, $off);
1212 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1214 # Handle nested #if/#else.
1215 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1216 push(@stack, [ $type, $level ]);
1217 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1218 ($type, $level) = @{$stack[$#stack - 1]};
1219 } elsif ($remainder =~ /^#\s*endif\b/) {
1220 ($type, $level) = @{pop(@stack)};
1223 # Statement ends at the ';' or a close '}' at the
1225 if ($level == 0 && $c eq ';') {
1229 # An else is really a conditional as long as its not else if
1230 if ($level == 0 && $coff_set == 0 &&
1231 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1232 $remainder =~ /^(else)(?:\s|{)/ &&
1233 $remainder !~ /^else\s+if\b/) {
1234 $coff = $off + length($1) - 1;
1236 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1237 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1240 if (($type eq '' || $type eq '(') && $c eq '(') {
1244 if ($type eq '(' && $c eq ')') {
1246 $type = ($level != 0)? '(' : '';
1248 if ($level == 0 && $coff < $soff) {
1251 #warn "CSB: mark coff<$coff>\n";
1254 if (($type eq '' || $type eq '{') && $c eq '{') {
1258 if ($type eq '{' && $c eq '}') {
1260 $type = ($level != 0)? '{' : '';
1263 if (substr($blk, $off + 1, 1) eq ';') {
1269 # Preprocessor commands end at the newline unless escaped.
1270 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1278 # We are truly at the end, so shuffle to the next line.
1285 my $statement = substr($blk, $soff, $off - $soff + 1);
1286 my $condition = substr($blk, $soff, $coff - $soff + 1);
1288 #warn "STATEMENT<$statement>\n";
1289 #warn "CONDITION<$condition>\n";
1291 #print "coff<$coff> soff<$off> loff<$loff>\n";
1293 return ($statement, $condition,
1294 $line, $remain + 1, $off - $loff + 1, $level);
1297 sub statement_lines {
1300 # Strip the diff line prefixes and rip blank lines at start and end.
1301 $stmt =~ s/(^|\n)./$1/g;
1305 my @stmt_lines = ($stmt =~ /\n/g);
1307 return $#stmt_lines + 2;
1310 sub statement_rawlines {
1313 my @stmt_lines = ($stmt =~ /\n/g);
1315 return $#stmt_lines + 2;
1318 sub statement_block_size {
1321 $stmt =~ s/(^|\n)./$1/g;
1327 my @stmt_lines = ($stmt =~ /\n/g);
1328 my @stmt_statements = ($stmt =~ /;/g);
1330 my $stmt_lines = $#stmt_lines + 2;
1331 my $stmt_statements = $#stmt_statements + 1;
1333 if ($stmt_lines > $stmt_statements) {
1336 return $stmt_statements;
1340 sub ctx_statement_full {
1341 my ($linenr, $remain, $off) = @_;
1342 my ($statement, $condition, $level);
1346 # Grab the first conditional/block pair.
1347 ($statement, $condition, $linenr, $remain, $off, $level) =
1348 ctx_statement_block($linenr, $remain, $off);
1349 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1350 push(@chunks, [ $condition, $statement ]);
1351 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1352 return ($level, $linenr, @chunks);
1355 # Pull in the following conditional/block pairs and see if they
1356 # could continue the statement.
1358 ($statement, $condition, $linenr, $remain, $off, $level) =
1359 ctx_statement_block($linenr, $remain, $off);
1360 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1361 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1363 push(@chunks, [ $condition, $statement ]);
1366 return ($level, $linenr, @chunks);
1370 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1372 my $start = $linenr - 1;
1379 my @stack = ($level);
1380 for ($line = $start; $remain > 0; $line++) {
1381 next if ($rawlines[$line] =~ /^-/);
1384 $blk .= $rawlines[$line];
1386 # Handle nested #if/#else.
1387 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1388 push(@stack, $level);
1389 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1390 $level = $stack[$#stack - 1];
1391 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1392 $level = pop(@stack);
1395 foreach my $c (split(//, $lines[$line])) {
1396 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1402 if ($c eq $close && $level > 0) {
1404 last if ($level == 0);
1405 } elsif ($c eq $open) {
1410 if (!$outer || $level <= 1) {
1411 push(@res, $rawlines[$line]);
1414 last if ($level == 0);
1417 return ($level, @res);
1419 sub ctx_block_outer {
1420 my ($linenr, $remain) = @_;
1422 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1426 my ($linenr, $remain) = @_;
1428 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1432 my ($linenr, $remain, $off) = @_;
1434 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1437 sub ctx_block_level {
1438 my ($linenr, $remain) = @_;
1440 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1442 sub ctx_statement_level {
1443 my ($linenr, $remain, $off) = @_;
1445 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1448 sub ctx_locate_comment {
1449 my ($first_line, $end_line) = @_;
1451 # Catch a comment on the end of the line itself.
1452 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1453 return $current_comment if (defined $current_comment);
1455 # Look through the context and try and figure out if there is a
1458 $current_comment = '';
1459 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1460 my $line = $rawlines[$linenr - 1];
1462 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1465 if ($line =~ m@/\*@) {
1468 if (!$in_comment && $current_comment ne '') {
1469 $current_comment = '';
1471 $current_comment .= $line . "\n" if ($in_comment);
1472 if ($line =~ m@\*/@) {
1477 chomp($current_comment);
1478 return($current_comment);
1480 sub ctx_has_comment {
1481 my ($first_line, $end_line) = @_;
1482 my $cmt = ctx_locate_comment($first_line, $end_line);
1484 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1485 ##print "CMMT: $cmt\n";
1487 return ($cmt ne '');
1491 my ($linenr, $cnt) = @_;
1493 my $offset = $linenr - 1;
1498 $line = $rawlines[$offset++];
1499 next if (defined($line) && $line =~ /^-/);
1511 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1514 $coded = sprintf("^%c", unpack('C', $2) + 64);
1523 my $av_preprocessor = 0;
1528 sub annotate_reset {
1529 $av_preprocessor = 0;
1531 @av_paren_type = ('E');
1532 $av_pend_colon = 'O';
1535 sub annotate_values {
1536 my ($stream, $type) = @_;
1539 my $var = '_' x length($stream);
1542 print "$stream\n" if ($dbg_values > 1);
1544 while (length($cur)) {
1545 @av_paren_type = ('E') if ($#av_paren_type < 0);
1546 print " <" . join('', @av_paren_type) .
1547 "> <$type> <$av_pending>" if ($dbg_values > 1);
1548 if ($cur =~ /^(\s+)/o) {
1549 print "WS($1)\n" if ($dbg_values > 1);
1550 if ($1 =~ /\n/ && $av_preprocessor) {
1551 $type = pop(@av_paren_type);
1552 $av_preprocessor = 0;
1555 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1556 print "CAST($1)\n" if ($dbg_values > 1);
1557 push(@av_paren_type, $type);
1560 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1561 print "DECLARE($1)\n" if ($dbg_values > 1);
1564 } elsif ($cur =~ /^($Modifier)\s*/) {
1565 print "MODIFIER($1)\n" if ($dbg_values > 1);
1568 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1569 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1570 $av_preprocessor = 1;
1571 push(@av_paren_type, $type);
1577 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1578 print "UNDEF($1)\n" if ($dbg_values > 1);
1579 $av_preprocessor = 1;
1580 push(@av_paren_type, $type);
1582 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1583 print "PRE_START($1)\n" if ($dbg_values > 1);
1584 $av_preprocessor = 1;
1586 push(@av_paren_type, $type);
1587 push(@av_paren_type, $type);
1590 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1591 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1592 $av_preprocessor = 1;
1594 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1598 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1599 print "PRE_END($1)\n" if ($dbg_values > 1);
1601 $av_preprocessor = 1;
1603 # Assume all arms of the conditional end as this
1604 # one does, and continue as if the #endif was not here.
1605 pop(@av_paren_type);
1606 push(@av_paren_type, $type);
1609 } elsif ($cur =~ /^(\\\n)/o) {
1610 print "PRECONT($1)\n" if ($dbg_values > 1);
1612 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1613 print "ATTR($1)\n" if ($dbg_values > 1);
1614 $av_pending = $type;
1617 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1618 print "SIZEOF($1)\n" if ($dbg_values > 1);
1624 } elsif ($cur =~ /^(if|while|for)\b/o) {
1625 print "COND($1)\n" if ($dbg_values > 1);
1629 } elsif ($cur =~/^(case)/o) {
1630 print "CASE($1)\n" if ($dbg_values > 1);
1631 $av_pend_colon = 'C';
1634 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1635 print "KEYWORD($1)\n" if ($dbg_values > 1);
1638 } elsif ($cur =~ /^(\()/o) {
1639 print "PAREN('$1')\n" if ($dbg_values > 1);
1640 push(@av_paren_type, $av_pending);
1644 } elsif ($cur =~ /^(\))/o) {
1645 my $new_type = pop(@av_paren_type);
1646 if ($new_type ne '_') {
1648 print "PAREN('$1') -> $type\n"
1649 if ($dbg_values > 1);
1651 print "PAREN('$1')\n" if ($dbg_values > 1);
1654 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1655 print "FUNC($1)\n" if ($dbg_values > 1);
1659 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1660 if (defined $2 && $type eq 'C' || $type eq 'T') {
1661 $av_pend_colon = 'B';
1662 } elsif ($type eq 'E') {
1663 $av_pend_colon = 'L';
1665 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1668 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1669 print "IDENT($1)\n" if ($dbg_values > 1);
1672 } elsif ($cur =~ /^($Assignment)/o) {
1673 print "ASSIGN($1)\n" if ($dbg_values > 1);
1676 } elsif ($cur =~/^(;|{|})/) {
1677 print "END($1)\n" if ($dbg_values > 1);
1679 $av_pend_colon = 'O';
1681 } elsif ($cur =~/^(,)/) {
1682 print "COMMA($1)\n" if ($dbg_values > 1);
1685 } elsif ($cur =~ /^(\?)/o) {
1686 print "QUESTION($1)\n" if ($dbg_values > 1);
1689 } elsif ($cur =~ /^(:)/o) {
1690 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1692 substr($var, length($res), 1, $av_pend_colon);
1693 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1698 $av_pend_colon = 'O';
1700 } elsif ($cur =~ /^(\[)/o) {
1701 print "CLOSE($1)\n" if ($dbg_values > 1);
1704 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1707 print "OPV($1)\n" if ($dbg_values > 1);
1714 substr($var, length($res), 1, $variant);
1717 } elsif ($cur =~ /^($Operators)/o) {
1718 print "OP($1)\n" if ($dbg_values > 1);
1719 if ($1 ne '++' && $1 ne '--') {
1723 } elsif ($cur =~ /(^.)/o) {
1724 print "C($1)\n" if ($dbg_values > 1);
1727 $cur = substr($cur, length($1));
1728 $res .= $type x length($1);
1732 return ($res, $var);
1736 my ($possible, $line) = @_;
1737 my $notPermitted = qr{(?:
1754 ^(?:typedef|struct|enum)\b
1756 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1757 if ($possible !~ $notPermitted) {
1758 # Check for modifiers.
1759 $possible =~ s/\s*$Storage\s*//g;
1760 $possible =~ s/\s*$Sparse\s*//g;
1761 if ($possible =~ /^\s*$/) {
1763 } elsif ($possible =~ /\s/) {
1764 $possible =~ s/\s*$Type\s*//g;
1765 for my $modifier (split(' ', $possible)) {
1766 if ($modifier !~ $notPermitted) {
1767 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1768 push(@modifierListFile, $modifier);
1773 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1774 push(@typeListFile, $possible);
1778 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1787 return defined $use_type{$type} if (scalar keys %use_type > 0);
1789 return !defined $ignore_type{$type};
1793 my ($level, $type, $msg) = @_;
1795 if (!show_type($type) ||
1796 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
1800 if (-t STDOUT && $color) {
1801 if ($level eq 'ERROR') {
1803 } elsif ($level eq 'WARNING') {
1809 $output .= $prefix . $level . ':';
1811 $output .= BLUE if (-t STDOUT && $color);
1812 $output .= "$type:";
1814 $output .= RESET if (-t STDOUT && $color);
1815 $output .= ' ' . $msg . "\n";
1818 my @lines = split("\n", $output, -1);
1819 splice(@lines, 1, 1);
1820 $output = join("\n", @lines);
1822 $output = (split('\n', $output))[0] . "\n" if ($terse);
1824 push(our @report, $output);
1833 sub fixup_current_range {
1834 my ($lineRef, $offset, $length) = @_;
1836 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1839 my $no = $o + $offset;
1840 my $nl = $l + $length;
1841 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1845 sub fix_inserted_deleted_lines {
1846 my ($linesRef, $insertedRef, $deletedRef) = @_;
1848 my $range_last_linenr = 0;
1849 my $delta_offset = 0;
1854 my $next_insert = 0;
1855 my $next_delete = 0;
1859 my $inserted = @{$insertedRef}[$next_insert++];
1860 my $deleted = @{$deletedRef}[$next_delete++];
1862 foreach my $old_line (@{$linesRef}) {
1864 my $line = $old_line; #don't modify the array
1865 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
1867 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1868 $range_last_linenr = $new_linenr;
1869 fixup_current_range(\$line, $delta_offset, 0);
1872 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1873 $deleted = @{$deletedRef}[$next_delete++];
1875 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1878 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1879 push(@lines, ${$inserted}{'LINE'});
1880 $inserted = @{$insertedRef}[$next_insert++];
1882 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1886 push(@lines, $line);
1896 sub fix_insert_line {
1897 my ($linenr, $line) = @_;
1903 push(@fixed_inserted, $inserted);
1906 sub fix_delete_line {
1907 my ($linenr, $line) = @_;
1914 push(@fixed_deleted, $deleted);
1918 my ($type, $msg) = @_;
1920 if (report("ERROR", $type, $msg)) {
1928 my ($type, $msg) = @_;
1930 if (report("WARNING", $type, $msg)) {
1938 my ($type, $msg) = @_;
1940 if ($check && report("CHECK", $type, $msg)) {
1948 sub check_absolute_file {
1949 my ($absolute, $herecurr) = @_;
1950 my $file = $absolute;
1952 ##print "absolute<$absolute>\n";
1954 # See if any suffix of this path is a path within the tree.
1955 while ($file =~ s@^[^/]*/@@) {
1956 if (-f "$root/$file") {
1957 ##print "file<$file>\n";
1965 # It is, so see if the prefix is acceptable.
1966 my $prefix = $absolute;
1967 substr($prefix, -length($file)) = '';
1969 ##print "prefix<$prefix>\n";
1970 if ($prefix ne ".../") {
1971 WARN("USE_RELATIVE_PATH",
1972 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1979 $string =~ s/^\s+|\s+$//g;
1987 $string =~ s/^\s+//;
1995 $string =~ s/\s+$//;
2000 sub string_find_replace {
2001 my ($string, $find, $replace) = @_;
2003 $string =~ s/$find/$replace/g;
2011 my $source_indent = 8;
2012 my $max_spaces_before_tab = $source_indent - 1;
2013 my $spaces_to_tab = " " x $source_indent;
2015 #convert leading spaces to tabs
2016 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2017 #Remove spaces before a tab
2018 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2023 sub pos_last_openparen {
2028 my $opens = $line =~ tr/\(/\(/;
2029 my $closes = $line =~ tr/\)/\)/;
2031 my $last_openparen = 0;
2033 if (($opens == 0) || ($closes >= $opens)) {
2037 my $len = length($line);
2039 for ($pos = 0; $pos < $len; $pos++) {
2040 my $string = substr($line, $pos);
2041 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2042 $pos += length($1) - 1;
2043 } elsif (substr($line, $pos, 1) eq '(') {
2044 $last_openparen = $pos;
2045 } elsif (index($string, '(') == -1) {
2050 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
2054 my $filename = shift;
2060 my $stashrawline="";
2070 my $in_header_lines = $file ? 0 : 1;
2071 my $in_commit_log = 0; #Scanning lines before patch
2072 my $commit_log_possible_stack_dump = 0;
2073 my $commit_log_long_line = 0;
2074 my $commit_log_has_diff = 0;
2075 my $reported_maintainer_file = 0;
2076 my $non_utf8_charset = 0;
2078 my $last_blank_line = 0;
2079 my $last_coalesced_string_linenr = -1;
2087 # Trace the real file/line as we go.
2093 my $comment_edge = 0;
2097 my $prev_values = 'E';
2100 my %suppress_ifbraces;
2101 my %suppress_whiletrailers;
2102 my %suppress_export;
2103 my $suppress_statement = 0;
2105 my %signatures = ();
2107 # Pre-scan the patch sanitizing the lines.
2108 # Pre-scan the patch looking for any __setup documentation.
2110 my @setup_docs = ();
2113 my $camelcase_file_seeded = 0;
2115 sanitise_line_reset();
2117 foreach my $rawline (@rawlines) {
2121 push(@fixed, $rawline) if ($fix);
2123 if ($rawline=~/^\+\+\+\s+(\S+)/) {
2125 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
2130 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2139 # Guestimate if this is a continuing comment. Run
2140 # the context looking for a comment "edge". If this
2141 # edge is a close comment then we must be in a comment
2145 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2146 next if (defined $rawlines[$ln - 1] &&
2147 $rawlines[$ln - 1] =~ /^-/);
2149 #print "RAW<$rawlines[$ln - 1]>\n";
2150 last if (!defined $rawlines[$ln - 1]);
2151 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2152 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2157 if (defined $edge && $edge eq '*/') {
2161 # Guestimate if this is a continuing comment. If this
2162 # is the start of a diff block and this line starts
2163 # ' *' then it is very likely a comment.
2164 if (!defined $edge &&
2165 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
2170 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2171 sanitise_line_reset($in_comment);
2173 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
2174 # Standardise the strings and chars within the input to
2175 # simplify matching -- only bother with positive lines.
2176 $line = sanitise_line($rawline);
2178 push(@lines, $line);
2181 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2186 #print "==>$rawline\n";
2187 #print "-->$line\n";
2189 if ($setup_docs && $line =~ /^\+/) {
2190 push(@setup_docs, $line);
2199 foreach my $line (@lines) {
2202 my $sline = $line; #copy of $line
2203 $sline =~ s/$;/ /g; #with comments as spaces
2205 my $rawline = $rawlines[$linenr - 1];
2207 #extract the line range in the file after the patch is applied
2208 if (!$in_commit_log &&
2209 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2211 $first_line = $linenr + 1;
2221 %suppress_ifbraces = ();
2222 %suppress_whiletrailers = ();
2223 %suppress_export = ();
2224 $suppress_statement = 0;
2227 # track the line number as we move through the hunk, note that
2228 # new versions of GNU diff omit the leading space on completely
2229 # blank context lines so we need to count that too.
2230 } elsif ($line =~ /^( |\+|$)/) {
2232 $realcnt-- if ($realcnt != 0);
2234 # Measure the line length and indent.
2235 ($length, $indent) = line_stats($rawline);
2237 # Track the previous line.
2238 ($prevline, $stashline) = ($stashline, $line);
2239 ($previndent, $stashindent) = ($stashindent, $indent);
2240 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2242 #warn "line<$line>\n";
2244 } elsif ($realcnt == 1) {
2248 my $hunk_line = ($realcnt != 0);
2250 $here = "#$linenr: " if (!$file);
2251 $here = "#$realline: " if ($file);
2254 # extract the filename as it passes
2255 if ($line =~ /^diff --git.*?(\S+)$/) {
2257 $realfile =~ s@^([^/]*)/@@ if (!$file);
2260 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2262 $realfile =~ s@^([^/]*)/@@ if (!$file);
2266 if (!$file && $tree && $p1_prefix ne '' &&
2267 -e "$root/$p1_prefix") {
2268 WARN("PATCH_PREFIX",
2269 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
2272 if ($realfile =~ m@^include/asm/@) {
2273 ERROR("MODIFIED_INCLUDE_ASM",
2274 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2279 #make up the handle for any error we report on this line
2281 $prefix = "$realfile:$realline: "
2284 $prefix = "$filename:$realline: ";
2286 $prefix = "$filename:$linenr: ";
2291 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
2294 $check = $check_orig;
2299 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
2301 my $hereline = "$here\n$rawline\n";
2302 my $herecurr = "$here\n$rawline\n";
2303 my $hereprev = "$here\n$prevrawline\n$rawline\n";
2305 $cnt_lines++ if ($realcnt != 0);
2307 # Check if the commit log has what seems like a diff which can confuse patch
2308 if ($in_commit_log && !$commit_log_has_diff &&
2309 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2310 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2311 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2312 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2313 ERROR("DIFF_IN_COMMIT_MSG",
2314 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2315 $commit_log_has_diff = 1;
2318 # Check for incorrect file permissions
2319 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2320 my $permhere = $here . "FILE: $realfile\n";
2321 if ($realfile !~ m@scripts/@ &&
2322 $realfile !~ /\.(py|pl|awk|sh)$/) {
2323 ERROR("EXECUTE_PERMISSIONS",
2324 "do not set execute permissions for source files\n" . $permhere);
2328 # Check the patch for a signoff:
2329 if ($line =~ /^\s*signed-off-by:/i) {
2334 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2335 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2336 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2337 $reported_maintainer_file = 1;
2340 # Check signature styles
2341 if (!$in_header_lines &&
2342 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
2343 my $space_before = $1;
2345 my $space_after = $3;
2347 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2349 if ($sign_off !~ /$signature_tags/) {
2350 WARN("BAD_SIGN_OFF",
2351 "Non-standard signature: $sign_off\n" . $herecurr);
2353 if (defined $space_before && $space_before ne "") {
2354 if (WARN("BAD_SIGN_OFF",
2355 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2357 $fixed[$fixlinenr] =
2358 "$ucfirst_sign_off $email";
2361 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
2362 if (WARN("BAD_SIGN_OFF",
2363 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2365 $fixed[$fixlinenr] =
2366 "$ucfirst_sign_off $email";
2370 if (!defined $space_after || $space_after ne " ") {
2371 if (WARN("BAD_SIGN_OFF",
2372 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2374 $fixed[$fixlinenr] =
2375 "$ucfirst_sign_off $email";
2379 my ($email_name, $email_address, $comment) = parse_email($email);
2380 my $suggested_email = format_email(($email_name, $email_address));
2381 if ($suggested_email eq "") {
2382 ERROR("BAD_SIGN_OFF",
2383 "Unrecognized email address: '$email'\n" . $herecurr);
2385 my $dequoted = $suggested_email;
2386 $dequoted =~ s/^"//;
2387 $dequoted =~ s/" </ </;
2388 # Don't force email to have quotes
2389 # Allow just an angle bracketed address
2390 if ("$dequoted$comment" ne $email &&
2391 "<$email_address>$comment" ne $email &&
2392 "$suggested_email$comment" ne $email) {
2393 WARN("BAD_SIGN_OFF",
2394 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
2398 # Check for duplicate signatures
2399 my $sig_nospace = $line;
2400 $sig_nospace =~ s/\s//g;
2401 $sig_nospace = lc($sig_nospace);
2402 if (defined $signatures{$sig_nospace}) {
2403 WARN("BAD_SIGN_OFF",
2404 "Duplicate signature\n" . $herecurr);
2406 $signatures{$sig_nospace} = 1;
2410 # Check email subject for common tools that don't need to be mentioned
2411 if ($in_header_lines &&
2412 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2413 WARN("EMAIL_SUBJECT",
2414 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2417 # Check for old stable address
2418 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2419 ERROR("STABLE_ADDRESS",
2420 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2423 # Check for unwanted Gerrit info
2424 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2425 ERROR("GERRIT_CHANGE_ID",
2426 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2429 # Check if the commit log is in a possible stack dump
2430 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2431 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2432 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2434 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2435 # stack dump address
2436 $commit_log_possible_stack_dump = 1;
2439 # Check for line lengths > 75 in commit log, warn once
2440 if ($in_commit_log && !$commit_log_long_line &&
2441 length($line) > 75 &&
2442 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2443 # file delta changes
2444 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2446 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2447 # A Fixes: or Link: line
2448 $commit_log_possible_stack_dump)) {
2449 WARN("COMMIT_LOG_LONG_LINE",
2450 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2451 $commit_log_long_line = 1;
2454 # Reset possible stack dump if a blank line is found
2455 if ($in_commit_log && $commit_log_possible_stack_dump &&
2457 $commit_log_possible_stack_dump = 0;
2460 # Check for git id commit length and improperly formed commit descriptions
2461 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2462 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
2463 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
2464 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
2465 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2466 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
2467 my $init_char = "c";
2468 my $orig_commit = "";
2475 my $id = '0123456789ab';
2476 my $orig_desc = "commit description";
2477 my $description = "";
2479 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2481 $orig_commit = lc($2);
2482 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2483 $orig_commit = lc($1);
2486 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2487 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2488 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2489 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2490 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2493 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2494 defined $rawlines[$linenr] &&
2495 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2498 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2499 defined $rawlines[$linenr] &&
2500 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2501 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2503 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2504 $orig_desc .= " " . $1;
2508 ($id, $description) = git_commit_info($orig_commit,
2511 if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) {
2512 ERROR("GIT_COMMIT_ID",
2513 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2517 # Check for added, moved or deleted files
2518 if (!$reported_maintainer_file && !$in_commit_log &&
2519 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2520 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2521 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2522 (defined($1) || defined($2))))) {
2523 $reported_maintainer_file = 1;
2524 WARN("FILE_PATH_CHANGES",
2525 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2528 # Check for wrappage within a valid hunk of the file
2529 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
2530 ERROR("CORRUPTED_PATCH",
2531 "patch seems to be corrupt (line wrapped?)\n" .
2532 $herecurr) if (!$emitted_corrupt++);
2535 # Check for absolute kernel paths.
2537 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2540 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2541 check_absolute_file($1, $herecurr)) {
2544 check_absolute_file($file, $herecurr);
2549 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2550 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
2551 $rawline !~ m/^$UTF8*$/) {
2552 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2554 my $blank = copy_spacing($rawline);
2555 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2556 my $hereptr = "$hereline$ptr\n";
2559 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
2562 # Check if it's the start of a commit log
2563 # (not a header line and we haven't seen the patch filename)
2564 if ($in_header_lines && $realfile =~ /^$/ &&
2565 !($rawline =~ /^\s+\S/ ||
2566 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
2567 $in_header_lines = 0;
2571 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2572 # declined it, i.e defined some charset where it is missing.
2573 if ($in_header_lines &&
2574 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2576 $non_utf8_charset = 1;
2579 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
2580 $rawline =~ /$NON_ASCII_UTF8/) {
2581 WARN("UTF8_BEFORE_PATCH",
2582 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2585 # Check for various typo / spelling mistakes
2586 if (defined($misspellings) &&
2587 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
2588 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
2590 my $typo_fix = $spelling_fix{lc($typo)};
2591 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2592 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2593 my $msg_type = \&WARN;
2594 $msg_type = \&CHK if ($file);
2595 if (&{$msg_type}("TYPO_SPELLING",
2596 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2598 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2603 # ignore non-hunk lines and lines being removed
2604 next if (!$hunk_line || $line =~ /^-/);
2606 #trailing whitespace
2607 if ($line =~ /^\+.*\015/) {
2608 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2609 if (ERROR("DOS_LINE_ENDINGS",
2610 "DOS line endings\n" . $herevet) &&
2612 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
2614 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2615 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2616 if (ERROR("TRAILING_WHITESPACE",
2617 "trailing whitespace\n" . $herevet) &&
2619 $fixed[$fixlinenr] =~ s/\s+$//;
2625 # Check for FSF mailing addresses.
2626 if ($rawline =~ /\bwrite to the Free/i ||
2627 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2628 $rawline =~ /\b51\s+Franklin\s+St/i) {
2629 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2630 my $msg_type = \&ERROR;
2631 $msg_type = \&CHK if ($file);
2632 &{$msg_type}("FSF_MAILING_ADDRESS",
2633 "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)
2636 # check for Kconfig help text having a real description
2637 # Only applies when adding the entry originally, after that we do not have
2638 # sufficient context to determine whether it is indeed long enough.
2639 if ($realfile =~ /Kconfig/ &&
2640 $line =~ /^\+\s*config\s+/) {
2643 my $ln = $linenr + 1;
2647 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
2648 $f = $lines[$ln - 1];
2649 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2650 $is_end = $lines[$ln - 1] =~ /^\+/;
2652 next if ($f =~ /^-/);
2653 last if (!$file && $f =~ /^\@\@/);
2655 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
2657 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
2664 next if ($f =~ /^$/);
2665 if ($f =~ /^\s*config\s/) {
2671 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2672 WARN("CONFIG_DESCRIPTION",
2673 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2675 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2678 # discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2679 if ($realfile =~ /Kconfig/ &&
2680 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2681 WARN("CONFIG_EXPERIMENTAL",
2682 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2685 # discourage the use of boolean for type definition attributes of Kconfig options
2686 if ($realfile =~ /Kconfig/ &&
2687 $line =~ /^\+\s*\bboolean\b/) {
2688 WARN("CONFIG_TYPE_BOOLEAN",
2689 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2692 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2693 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2696 'EXTRA_AFLAGS' => 'asflags-y',
2697 'EXTRA_CFLAGS' => 'ccflags-y',
2698 'EXTRA_CPPFLAGS' => 'cppflags-y',
2699 'EXTRA_LDFLAGS' => 'ldflags-y',
2702 WARN("DEPRECATED_VARIABLE",
2703 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2706 # check for DT compatible documentation
2707 if (defined $root &&
2708 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2709 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2711 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2713 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2714 my $vp_file = $dt_path . "vendor-prefixes.txt";
2716 foreach my $compat (@compats) {
2717 my $compat2 = $compat;
2718 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2719 my $compat3 = $compat;
2720 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2721 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
2723 WARN("UNDOCUMENTED_DT_STRING",
2724 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2727 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2729 `grep -Eq "^$vendor\\b" $vp_file`;
2731 WARN("UNDOCUMENTED_DT_STRING",
2732 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2737 # check we are in a valid source file if not then ignore this hunk
2738 next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/);
2740 # line length limit (with some exclusions)
2742 # There are a few types of lines that may extend beyond $max_line_length:
2743 # logging functions like pr_info that end in a string
2744 # lines with a single string
2745 # #defines that are a single string
2747 # There are 3 different line length message types:
2748 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength
2749 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2750 # LONG_LINE all other lines longer than $max_line_length
2752 # if LONG_LINE is ignored, the other 2 types are also ignored
2755 if ($line =~ /^\+/ && $length > $max_line_length) {
2756 my $msg_type = "LONG_LINE";
2758 # Check the allowed long line types first
2760 # logging functions that end in a string that starts
2761 # before $max_line_length
2762 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2763 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2766 # lines with only strings (w/ possible termination)
2767 # #defines with only strings
2768 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2769 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2772 # EFI_GUID is another special case
2773 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/) {
2776 # Otherwise set the alternate message types
2778 # a comment starts before $max_line_length
2779 } elsif ($line =~ /($;[\s$;]*)$/ &&
2780 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2781 $msg_type = "LONG_LINE_COMMENT"
2783 # a quoted string starts before $max_line_length
2784 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
2785 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2786 $msg_type = "LONG_LINE_STRING"
2789 if ($msg_type ne "" &&
2790 (show_type("LONG_LINE") || show_type($msg_type))) {
2792 "line over $max_line_length characters\n" . $herecurr);
2796 # check for adding lines without a newline.
2797 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2798 WARN("MISSING_EOF_NEWLINE",
2799 "adding a line without newline at end of file\n" . $herecurr);
2802 # Blackfin: use hi/lo macros
2803 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2804 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2805 my $herevet = "$here\n" . cat_vet($line) . "\n";
2807 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
2809 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2810 my $herevet = "$here\n" . cat_vet($line) . "\n";
2812 "use the HI() macro, not (... >> 16)\n" . $herevet);
2816 # check we are in a valid source file C or perl if not then ignore this hunk
2817 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
2819 # at the beginning of a line any tabs must come first and anything
2820 # more than 8 must use tabs.
2821 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2822 $rawline =~ /^\+\s* \s*/) {
2823 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2825 if (ERROR("CODE_INDENT",
2826 "code indent should use tabs where possible\n" . $herevet) &&
2828 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2832 # check for space before tabs.
2833 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2834 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2835 if (WARN("SPACE_BEFORE_TAB",
2836 "please, no space before tabs\n" . $herevet) &&
2838 while ($fixed[$fixlinenr] =~
2839 s/(^\+.*) {8,8}\t/$1\t\t/) {}
2840 while ($fixed[$fixlinenr] =~
2841 s/(^\+.*) +\t/$1\t/) {}
2845 # check for && or || at the start of a line
2846 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2847 CHK("LOGICAL_CONTINUATIONS",
2848 "Logical continuations should be on the previous line\n" . $hereprev);
2851 # check indentation starts on a tab stop
2852 if ($^V && $^V ge 5.10.0 &&
2853 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$))/) {
2854 my $indent = length($1);
2857 "Statements should start on a tabstop\n" . $herecurr) &&
2859 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
2864 # check multi-line statement indentation matches previous line
2865 if ($^V && $^V ge 5.10.0 &&
2866 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2867 $prevline =~ /^\+(\t*)(.*)$/;
2871 my $pos = pos_last_openparen($rest);
2873 $line =~ /^(\+| )([ \t]*)/;
2876 my $goodtabindent = $oldindent .
2879 my $goodspaceindent = $oldindent . " " x $pos;
2881 if ($newindent ne $goodtabindent &&
2882 $newindent ne $goodspaceindent) {
2884 if (CHK("PARENTHESIS_ALIGNMENT",
2885 "Alignment should match open parenthesis\n" . $hereprev) &&
2886 $fix && $line =~ /^\+/) {
2887 $fixed[$fixlinenr] =~
2888 s/^\+[ \t]*/\+$goodtabindent/;
2894 # check for space after cast like "(int) foo" or "(struct foo) bar"
2895 # avoid checking a few false positives:
2896 # "sizeof(<type>)" or "__alignof__(<type>)"
2897 # function pointer declarations like "(*foo)(int) = bar;"
2898 # structure definitions like "(struct foo) { 0 };"
2899 # multiline macros that define functions
2900 # known attributes or the __attribute__ keyword
2901 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
2902 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
2904 "No space is necessary after a cast\n" . $herecurr) &&
2906 $fixed[$fixlinenr] =~
2907 s/(\(\s*$Type\s*\))[ \t]+/$1/;
2911 # Block comment styles
2912 # Networking with an initial /*
2913 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2914 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
2915 $rawline =~ /^\+[ \t]*\*/ &&
2917 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2918 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2921 # Block comments use * on subsequent lines
2922 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
2923 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
2924 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
2925 $rawline =~ /^\+/ && #line is new
2926 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2927 WARN("BLOCK_COMMENT_STYLE",
2928 "Block comments use * on subsequent lines\n" . $hereprev);
2931 # Block comments use */ on trailing lines
2932 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2933 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2934 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2935 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
2936 WARN("BLOCK_COMMENT_STYLE",
2937 "Block comments use a trailing */ on a separate line\n" . $herecurr);
2940 # check for missing blank lines after struct/union declarations
2941 # with exceptions for various attributes and macros
2942 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2944 !($line =~ /^\+\s*$/ ||
2945 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2946 $line =~ /^\+\s*MODULE_/i ||
2947 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2948 $line =~ /^\+[a-z_]*init/ ||
2949 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2950 $line =~ /^\+\s*DECLARE/ ||
2951 $line =~ /^\+\s*__setup/)) {
2952 if (CHK("LINE_SPACING",
2953 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
2955 fix_insert_line($fixlinenr, "\+");
2959 # check for multiple consecutive blank lines
2960 if ($prevline =~ /^[\+ ]\s*$/ &&
2961 $line =~ /^\+\s*$/ &&
2962 $last_blank_line != ($linenr - 1)) {
2963 if (CHK("LINE_SPACING",
2964 "Please don't use multiple blank lines\n" . $hereprev) &&
2966 fix_delete_line($fixlinenr, $rawline);
2969 $last_blank_line = $linenr;
2972 # check for missing blank lines after declarations
2973 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2974 # actual declarations
2975 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2976 # function pointer declarations
2977 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2978 # foo bar; where foo is some local typedef or #define
2979 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2980 # known declaration macros
2981 $prevline =~ /^\+\s+$declaration_macros/) &&
2982 # for "else if" which can look like "$Ident $Ident"
2983 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2984 # other possible extensions of declaration lines
2985 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2986 # not starting a section or a macro "\" extended line
2987 $prevline =~ /(?:\{\s*|\\)$/) &&
2988 # looks like a declaration
2989 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2990 # function pointer declarations
2991 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2992 # foo bar; where foo is some local typedef or #define
2993 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2994 # known declaration macros
2995 $sline =~ /^\+\s+$declaration_macros/ ||
2996 # start of struct or union or enum
2997 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
2998 # start or end of block or continuation of declaration
2999 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3000 # bitfield continuation
3001 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3002 # other possible extensions of declaration lines
3003 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3004 # indentation of previous and current line are the same
3005 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
3006 if (WARN("LINE_SPACING",
3007 "Missing a blank line after declarations\n" . $hereprev) &&
3009 fix_insert_line($fixlinenr, "\+");
3013 # check for spaces at the beginning of a line.
3015 # 1) within comments
3016 # 2) indented preprocessor commands
3018 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
3019 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3020 if (WARN("LEADING_SPACE",
3021 "please, no spaces at the start of a line\n" . $herevet) &&
3023 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3027 # check we are in a valid C source file if not then ignore this hunk
3028 next if ($realfile !~ /\.(h|c)$/);
3030 # check indentation of any line with a bare else
3031 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
3032 # if the previous line is a break or return and is indented 1 tab more...
3033 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3034 my $tabs = length($1) + 1;
3035 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3036 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3037 defined $lines[$linenr] &&
3038 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
3039 WARN("UNNECESSARY_ELSE",
3040 "else is not generally useful after a break or return\n" . $hereprev);
3044 # check indentation of a line with a break;
3045 # if the previous line is a goto or return and is indented the same # of tabs
3046 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3048 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3049 WARN("UNNECESSARY_BREAK",
3050 "break is not useful after a goto or return\n" . $hereprev);
3054 # discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
3055 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
3056 WARN("CONFIG_EXPERIMENTAL",
3057 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
3060 # check for RCS/CVS revision markers
3061 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
3063 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
3066 # Blackfin: don't use __builtin_bfin_[cs]sync
3067 if ($line =~ /__builtin_bfin_csync/) {
3068 my $herevet = "$here\n" . cat_vet($line) . "\n";
3070 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
3072 if ($line =~ /__builtin_bfin_ssync/) {
3073 my $herevet = "$here\n" . cat_vet($line) . "\n";
3075 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
3078 # check for old HOTPLUG __dev<foo> section markings
3079 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3080 WARN("HOTPLUG_SECTION",
3081 "Using $1 is unnecessary\n" . $herecurr);
3084 # Check for potential 'bare' types
3085 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3087 #print "LINE<$line>\n";
3088 if ($linenr >= $suppress_statement &&
3089 $realcnt && $sline =~ /.\s*\S/) {
3090 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3091 ctx_statement_block($linenr, $realcnt, 0);
3092 $stat =~ s/\n./\n /g;
3093 $cond =~ s/\n./\n /g;
3095 #print "linenr<$linenr> <$stat>\n";
3096 # If this statement has no statement boundaries within
3097 # it there is no point in retrying a statement scan
3098 # until we hit end of it.
3099 my $frag = $stat; $frag =~ s/;+\s*$//;
3100 if ($frag !~ /(?:{|;)/) {
3101 #print "skip<$line_nr_next>\n";
3102 $suppress_statement = $line_nr_next;
3105 # Find the real next line.
3106 $realline_next = $line_nr_next;
3107 if (defined $realline_next &&
3108 (!defined $lines[$realline_next - 1] ||
3109 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3116 # Ignore goto labels.
3117 if ($s =~ /$Ident:\*$/s) {
3119 # Ignore functions being called
3120 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
3122 } elsif ($s =~ /^.\s*else\b/s) {
3124 # declarations always start with types
3125 } 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) {
3128 possible($type, "A:" . $s);
3130 # definitions in global scope can only start with types
3131 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
3132 possible($1, "B:" . $s);
3135 # any (foo ... *) is a pointer cast, and foo is a type
3136 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
3137 possible($1, "C:" . $s);
3140 # Check for any sort of function declaration.
3141 # int foo(something bar, other baz);
3142 # void (*store_gdt)(x86_descr_ptr *);
3143 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3144 my ($name_len) = length($1);
3147 substr($ctx, 0, $name_len + 1, '');
3148 $ctx =~ s/\)[^\)]*$//;
3150 for my $arg (split(/\s*,\s*/, $ctx)) {
3151 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3153 possible($1, "D:" . $s);
3161 # Checks which may be anchored in the context.
3164 # Check for switch () and associated case and default
3165 # statements should be at the same indent.
3166 if ($line=~/\bswitch\s*\(.*\)/) {
3169 my @ctx = ctx_block_outer($linenr, $realcnt);
3171 for my $ctx (@ctx) {
3172 my ($clen, $cindent) = line_stats($ctx);
3173 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3174 $indent != $cindent) {
3175 $err .= "$sep$ctx\n";
3182 ERROR("SWITCH_CASE_INDENT_LEVEL",
3183 "switch and case should be at the same indent\n$hereline$err");
3187 # if/while/etc brace do not go on next line, unless defining a do while loop,
3188 # or if that brace on the next line is for something else
3189 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3190 my $pre_ctx = "$1$2";
3192 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
3194 if ($line =~ /^\+\t{6,}/) {
3195 WARN("DEEP_INDENTATION",
3196 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3199 my $ctx_cnt = $realcnt - $#ctx - 1;
3200 my $ctx = join("\n", @ctx);
3202 my $ctx_ln = $linenr;
3203 my $ctx_skip = $realcnt;
3205 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3206 defined $lines[$ctx_ln - 1] &&
3207 $lines[$ctx_ln - 1] =~ /^-/)) {
3208 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3209 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
3213 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3214 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3216 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
3218 "that open brace { should be on the previous line\n" .
3219 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3221 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3222 $ctx =~ /\)\s*\;\s*$/ &&
3223 defined $lines[$ctx_ln - 1])
3225 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3226 if ($nindent > $indent) {
3227 WARN("TRAILING_SEMICOLON",
3228 "trailing semicolon indicates no statements, indent implies otherwise\n" .
3229 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3234 # Check relative indent for conditionals and blocks.
3235 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3236 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3237 ctx_statement_block($linenr, $realcnt, 0)
3238 if (!defined $stat);
3239 my ($s, $c) = ($stat, $cond);
3241 substr($s, 0, length($c), '');
3243 # remove inline comments
3247 # Find out how long the conditional actually is.
3248 my @newlines = ($c =~ /\n/gs);
3249 my $cond_lines = 1 + $#newlines;
3251 # Make sure we remove the line prefixes as we have
3252 # none on the first line, and are going to readd them
3255 while ($s =~ /\n\s+\\\n/) {
3256 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3259 # We want to check the first line inside the block
3260 # starting at the end of the conditional, so remove:
3261 # 1) any blank line termination
3262 # 2) any opening brace { on end of the line
3264 my $continuation = 0;
3266 $s =~ s/^.*\bdo\b//;
3268 if ($s =~ s/^\s*\\//) {
3271 if ($s =~ s/^\s*?\n//) {
3276 # Also ignore a loop construct at the end of a
3277 # preprocessor statement.
3278 if (($prevline =~ /^.\s*#\s*define\s/ ||
3279 $prevline =~ /\\\s*$/) && $continuation == 0) {
3285 while ($cond_ptr != $cond_lines) {
3286 $cond_ptr = $cond_lines;
3288 # If we see an #else/#elif then the code
3290 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3295 # 1) blank lines, they should be at 0,
3296 # 2) preprocessor lines, and
3298 if ($continuation ||
3300 $s =~ /^\s*#\s*?/ ||
3301 $s =~ /^\s*$Ident\s*:/) {
3302 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
3303 if ($s =~ s/^.*?\n//) {
3309 my (undef, $sindent) = line_stats("+" . $s);
3310 my $stat_real = raw_line($linenr, $cond_lines);
3312 # Check if either of these lines are modified, else
3313 # this is not this patch's fault.
3314 if (!defined($stat_real) ||
3315 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3318 if (defined($stat_real) && $cond_lines > 1) {
3319 $stat_real = "[...]\n$stat_real";
3322 #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";
3324 if ($check && $s ne '' &&
3325 (($sindent % 8) != 0 ||
3326 ($sindent < $indent) ||
3327 ($sindent > $indent + 8))) {
3328 WARN("SUSPECT_CODE_INDENT",
3329 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3333 # Track the 'values' across context and added lines.
3334 my $opline = $line; $opline =~ s/^./ /;
3335 my ($curr_values, $curr_vars) =
3336 annotate_values($opline . "\n", $prev_values);
3337 $curr_values = $prev_values . $curr_values;
3339 my $outline = $opline; $outline =~ s/\t/ /g;
3340 print "$linenr > .$outline\n";
3341 print "$linenr > $curr_values\n";
3342 print "$linenr > $curr_vars\n";
3344 $prev_values = substr($curr_values, -1);
3346 #ignore lines not being added
3347 next if ($line =~ /^[^\+]/);
3349 # check for declarations of signed or unsigned without int
3350 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3353 $var = "" if (!defined $var);
3354 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
3358 $pointer = "" if (!defined $pointer);
3360 if (WARN("UNSPECIFIED_INT",
3361 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3363 my $decl = trim($sign) . " int ";
3364 my $comp_pointer = $pointer;
3365 $comp_pointer =~ s/\s//g;
3366 $decl .= $comp_pointer;
3367 $decl = rtrim($decl) if ($var eq "");
3368 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
3373 # TEST: allow direct testing of the type matcher.
3375 if ($line =~ /^.\s*$Declare\s*$/) {
3377 "TEST: is type\n" . $herecurr);
3378 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
3379 ERROR("TEST_NOT_TYPE",
3380 "TEST: is not type ($1 is)\n". $herecurr);
3384 # TEST: allow direct testing of the attribute matcher.
3386 if ($line =~ /^.\s*$Modifier\s*$/) {
3388 "TEST: is attr\n" . $herecurr);
3389 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
3390 ERROR("TEST_NOT_ATTR",
3391 "TEST: is not attr ($1 is)\n". $herecurr);
3396 # check for initialisation to aggregates open brace on the next line
3397 if ($line =~ /^.\s*{/ &&
3398 $prevline =~ /(?:^|[^=])=\s*$/) {
3399 if (ERROR("OPEN_BRACE",
3400 "that open brace { should be on the previous line\n" . $hereprev) &&
3401 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3402 fix_delete_line($fixlinenr - 1, $prevrawline);
3403 fix_delete_line($fixlinenr, $rawline);
3404 my $fixedline = $prevrawline;
3405 $fixedline =~ s/\s*=\s*$/ = {/;
3406 fix_insert_line($fixlinenr, $fixedline);
3408 $fixedline =~ s/^(.\s*){\s*/$1/;
3409 fix_insert_line($fixlinenr, $fixedline);
3414 # Checks which are anchored on the added line.
3417 # check for malformed paths in #include statements (uses RAW line)
3418 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
3420 if ($path =~ m{//}) {
3421 ERROR("MALFORMED_INCLUDE",
3422 "malformed #include filename\n" . $herecurr);
3424 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3425 ERROR("UAPI_INCLUDE",
3426 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
3430 # no C99 // comments
3431 if ($line =~ m{//}) {
3432 if (ERROR("C99_COMMENTS",
3433 "do not use C99 // comments\n" . $herecurr) &&
3435 my $line = $fixed[$fixlinenr];
3436 if ($line =~ /\/\/(.*)$/) {
3437 my $comment = trim($1);
3438 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
3442 # Remove C99 comments.
3444 $opline =~ s@//.*@@;
3446 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3447 # the whole statement.
3448 #print "APW <$lines[$realline_next - 1]>\n";
3449 if (defined $realline_next &&
3450 exists $lines[$realline_next - 1] &&
3451 !defined $suppress_export{$realline_next} &&
3452 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3453 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3454 # Handle definitions which produce identifiers with
3457 # EXPORT_SYMBOL(something_foo);
3459 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
3460 $name =~ /^${Ident}_$2/) {
3461 #print "FOO C name<$name>\n";
3462 $suppress_export{$realline_next} = 1;
3464 } elsif ($stat !~ /(?:
3466 ^.DEFINE_$Ident\(\Q$name\E\)|
3467 ^.DECLARE_$Ident\(\Q$name\E\)|
3468 ^.LIST_HEAD\(\Q$name\E\)|
3469 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3470 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
3472 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3473 $suppress_export{$realline_next} = 2;
3475 $suppress_export{$realline_next} = 1;
3478 if (!defined $suppress_export{$linenr} &&
3479 $prevline =~ /^.\s*$/ &&
3480 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3481 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3482 #print "FOO B <$lines[$linenr - 1]>\n";
3483 $suppress_export{$linenr} = 2;
3485 if (defined $suppress_export{$linenr} &&
3486 $suppress_export{$linenr} == 2) {
3487 WARN("EXPORT_SYMBOL",
3488 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
3491 # check for global initialisers.
3492 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
3493 if (ERROR("GLOBAL_INITIALISERS",
3494 "do not initialise globals to $1\n" . $herecurr) &&
3496 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
3499 # check for static initialisers.
3500 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
3501 if (ERROR("INITIALISED_STATIC",
3502 "do not initialise statics to $1\n" .
3505 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
3509 # check for misordered declarations of char/short/int/long with signed/unsigned
3510 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3512 WARN("MISORDERED_TYPE",
3513 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3516 # check for static const char * arrays.
3517 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
3518 WARN("STATIC_CONST_CHAR_ARRAY",
3519 "static const char * array should probably be static const char * const\n" .
3523 # check for static char foo[] = "bar" declarations.
3524 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
3525 WARN("STATIC_CONST_CHAR_ARRAY",
3526 "static char array declaration should probably be static const char\n" .
3530 # check for const <foo> const where <foo> is not a pointer or array type
3531 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3533 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3535 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3536 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3538 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3542 # check for non-global char *foo[] = {"bar", ...} declarations.
3543 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3544 WARN("STATIC_CONST_CHAR_ARRAY",
3545 "char * array declaration might be better as static const\n" .
3549 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3550 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3552 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3554 if (WARN("ARRAY_SIZE",
3555 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3557 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3562 # check for function declarations without arguments like "int foo()"
3563 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3564 if (ERROR("FUNCTION_WITHOUT_ARGS",
3565 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3567 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
3571 # check for uses of DEFINE_PCI_DEVICE_TABLE
3572 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
3573 if (WARN("DEFINE_PCI_DEVICE_TABLE",
3574 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
3576 $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
3580 # check for new typedefs, only function parameters and sparse annotations
3582 if ($line =~ /\btypedef\s/ &&
3583 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
3584 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
3585 $line !~ /\b$typeTypedefs\b/ &&
3586 $line !~ /\b__bitwise(?:__|)\b/) {
3587 WARN("NEW_TYPEDEFS",
3588 "do not add new typedefs\n" . $herecurr);
3591 # * goes on variable not on type
3593 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3595 my ($ident, $from, $to) = ($1, $2, $2);
3597 # Should start with a space.
3598 $to =~ s/^(\S)/ $1/;
3599 # Should not end with a space.
3601 # '*'s should not have spaces between.
3602 while ($to =~ s/\*\s+\*/\*\*/) {
3605 ## print "1: from<$from> to<$to> ident<$ident>\n";
3607 if (ERROR("POINTER_LOCATION",
3608 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3610 my $sub_from = $ident;
3611 my $sub_to = $ident;
3612 $sub_to =~ s/\Q$from\E/$to/;
3613 $fixed[$fixlinenr] =~
3614 s@\Q$sub_from\E@$sub_to@;
3618 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3620 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
3622 # Should start with a space.
3623 $to =~ s/^(\S)/ $1/;
3624 # Should not end with a space.
3626 # '*'s should not have spaces between.
3627 while ($to =~ s/\*\s+\*/\*\*/) {
3629 # Modifiers should have spaces.
3630 $to =~ s/(\b$Modifier$)/$1 /;
3632 ## print "2: from<$from> to<$to> ident<$ident>\n";
3633 if ($from ne $to && $ident !~ /^$Modifier$/) {
3634 if (ERROR("POINTER_LOCATION",
3635 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3638 my $sub_from = $match;
3639 my $sub_to = $match;
3640 $sub_to =~ s/\Q$from\E/$to/;
3641 $fixed[$fixlinenr] =~
3642 s@\Q$sub_from\E@$sub_to@;
3647 # avoid BUG() or BUG_ON()
3648 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
3649 my $msg_type = \&WARN;
3650 $msg_type = \&CHK if ($file);
3651 &{$msg_type}("AVOID_BUG",
3652 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3655 # avoid LINUX_VERSION_CODE
3656 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
3657 WARN("LINUX_VERSION_CODE",
3658 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3661 # check for uses of printk_ratelimit
3662 if ($line =~ /\bprintk_ratelimit\s*\(/) {
3663 WARN("PRINTK_RATELIMITED",
3664 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
3667 # printk should use KERN_* levels. Note that follow on printk's on the
3668 # same line do not need a level, so we use the current block context
3669 # to try and find and validate the current printk. In summary the current
3670 # printk includes all preceding printk's which have no newline on the end.
3671 # we assume the first bad printk is the one to report.
3672 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
3674 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3675 #print "CHECK<$lines[$ln - 1]\n";
3676 # we have a preceding printk if it ends
3677 # with "\n" ignore it, else it is to blame
3678 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3679 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3686 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3687 "printk() should include KERN_ facility level\n" . $herecurr);
3691 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3693 my $level = lc($orig);
3694 $level = "warn" if ($level eq "warning");
3695 my $level2 = $level;
3696 $level2 = "dbg" if ($level eq "debug");
3697 WARN("PREFER_PR_LEVEL",
3698 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
3701 if ($line =~ /\bpr_warning\s*\(/) {
3702 if (WARN("PREFER_PR_LEVEL",
3703 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3705 $fixed[$fixlinenr] =~
3706 s/\bpr_warning\b/pr_warn/;
3710 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3712 my $level = lc($orig);
3713 $level = "warn" if ($level eq "warning");
3714 $level = "dbg" if ($level eq "debug");
3715 WARN("PREFER_DEV_LEVEL",
3716 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3719 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
3720 # number of false positives, but assembly files are not checked, so at
3721 # least the arch entry code will not trigger this warning.
3722 if ($line =~ /\bENOSYS\b/) {
3724 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3727 # function brace can't be on same line, except for #defines of do while,
3728 # or if closed on same line
3729 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
3730 !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) {
3731 if (ERROR("OPEN_BRACE",
3732 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3734 fix_delete_line($fixlinenr, $rawline);
3735 my $fixed_line = $rawline;
3736 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3739 fix_insert_line($fixlinenr, ltrim($line1));
3740 fix_insert_line($fixlinenr, "\+{");
3741 if ($line2 !~ /^\s*$/) {
3742 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3747 # open braces for enum, union and struct go on the same line.
3748 if ($line =~ /^.\s*{/ &&
3749 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
3750 if (ERROR("OPEN_BRACE",
3751 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3752 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3753 fix_delete_line($fixlinenr - 1, $prevrawline);
3754 fix_delete_line($fixlinenr, $rawline);
3755 my $fixedline = rtrim($prevrawline) . " {";
3756 fix_insert_line($fixlinenr, $fixedline);
3757 $fixedline = $rawline;
3758 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3759 if ($fixedline !~ /^\+\s*$/) {
3760 fix_insert_line($fixlinenr, $fixedline);
3765 # missing space after union, struct or enum definition
3766 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3768 "missing space after $1 definition\n" . $herecurr) &&
3770 $fixed[$fixlinenr] =~
3771 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3775 # Function pointer declarations
3776 # check spacing between type, funcptr, and args
3777 # canonical declaration is "type (*funcptr)(args...)"
3778 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
3780 my $pre_pointer_space = $2;
3781 my $post_pointer_space = $3;
3783 my $post_funcname_space = $5;
3784 my $pre_args_space = $6;
3786 # the $Declare variable will capture all spaces after the type
3787 # so check it for a missing trailing missing space but pointer return types
3788 # don't need a space so don't warn for those.
3789 my $post_declare_space = "";
3790 if ($declare =~ /(\s+)$/) {
3791 $post_declare_space = $1;
3792 $declare = rtrim($declare);
3794 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
3796 "missing space after return type\n" . $herecurr);
3797 $post_declare_space = " ";
3800 # unnecessary space "type (*funcptr)(args...)"
3801 # This test is not currently implemented because these declarations are
3803 # int foo(int bar, ...)
3804 # and this is form shouldn't/doesn't generate a checkpatch warning.
3806 # elsif ($declare =~ /\s{2,}$/) {
3808 # "Multiple spaces after return type\n" . $herecurr);
3811 # unnecessary space "type ( *funcptr)(args...)"
3812 if (defined $pre_pointer_space &&
3813 $pre_pointer_space =~ /^\s/) {
3815 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3818 # unnecessary space "type (* funcptr)(args...)"
3819 if (defined $post_pointer_space &&
3820 $post_pointer_space =~ /^\s/) {
3822 "Unnecessary space before function pointer name\n" . $herecurr);
3825 # unnecessary space "type (*funcptr )(args...)"
3826 if (defined $post_funcname_space &&
3827 $post_funcname_space =~ /^\s/) {
3829 "Unnecessary space after function pointer name\n" . $herecurr);
3832 # unnecessary space "type (*funcptr) (args...)"
3833 if (defined $pre_args_space &&
3834 $pre_args_space =~ /^\s/) {
3836 "Unnecessary space before function pointer arguments\n" . $herecurr);
3839 if (show_type("SPACING") && $fix) {
3840 $fixed[$fixlinenr] =~
3841 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3845 # check for spacing round square brackets; allowed:
3846 # 1. with a type on the left -- int [] a;
3847 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3848 # 3. inside a curly brace -- = { [0...10] = 5 }
3849 while ($line =~ /(.*?\s)\[/g) {
3850 my ($where, $prefix) = ($-[1], $1);
3851 if ($prefix !~ /$Type\s+$/ &&
3852 ($where != 0 || $prefix !~ /^.\s+$/) &&
3853 $prefix !~ /[{,]\s+$/) {
3854 if (ERROR("BRACKET_SPACE",
3855 "space prohibited before open square bracket '['\n" . $herecurr) &&
3857 $fixed[$fixlinenr] =~
3858 s/^(\+.*?)\s+\[/$1\[/;
3863 # check for spaces between functions and their parentheses.
3864 while ($line =~ /($Ident)\s+\(/g) {
3866 my $ctx_before = substr($line, 0, $-[1]);
3867 my $ctx = "$ctx_before$name";
3869 # Ignore those directives where spaces _are_ permitted.
3871 if|for|while|switch|return|case|
3872 volatile|__volatile__|
3873 __attribute__|format|__extension__|
3876 # cpp #define statements have non-optional spaces, ie
3877 # if there is a space between the name and the open
3878 # parenthesis it is simply not a parameter group.
3879 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
3881 # cpp #elif statement condition may start with a (
3882 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
3884 # If this whole things ends with a type its most
3885 # likely a typedef for a function.
3886 } elsif ($ctx =~ /$Type$/) {
3890 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3892 $fixed[$fixlinenr] =~
3893 s/\b$name\s+\(/$name\(/;
3898 # Check operator spacing.
3899 if (!($line=~/\#\s*include/)) {
3900 my $fixed_line = "";
3904 <<=|>>=|<=|>=|==|!=|
3905 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3906 =>|->|<<|>>|<|>|=|!|~|
3907 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
3910 my @elements = split(/($ops|;)/, $opline);
3912 ## print("element count: <" . $#elements . ">\n");
3913 ## foreach my $el (@elements) {
3914 ## print("el: <$el>\n");
3917 my @fix_elements = ();
3920 foreach my $el (@elements) {
3921 push(@fix_elements, substr($rawline, $off, length($el)));
3922 $off += length($el);
3927 my $blank = copy_spacing($opline);
3928 my $last_after = -1;
3930 for (my $n = 0; $n < $#elements; $n += 2) {
3932 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3934 ## print("n: <$n> good: <$good>\n");
3936 $off += length($elements[$n]);
3938 # Pick up the preceding and succeeding characters.
3939 my $ca = substr($opline, 0, $off);
3941 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3942 $cc = substr($opline, $off + length($elements[$n + 1]));
3944 my $cb = "$ca$;$cc";
3947 $a = 'V' if ($elements[$n] ne '');
3948 $a = 'W' if ($elements[$n] =~ /\s$/);
3949 $a = 'C' if ($elements[$n] =~ /$;$/);
3950 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3951 $a = 'O' if ($elements[$n] eq '');
3952 $a = 'E' if ($ca =~ /^\s*$/);
3954 my $op = $elements[$n + 1];
3957 if (defined $elements[$n + 2]) {
3958 $c = 'V' if ($elements[$n + 2] ne '');
3959 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
3960 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
3961 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3962 $c = 'O' if ($elements[$n + 2] eq '');
3963 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
3968 my $ctx = "${a}x${c}";
3970 my $at = "(ctx:$ctx)";
3972 my $ptr = substr($blank, 0, $off) . "^";
3973 my $hereptr = "$hereline$ptr\n";
3975 # Pull out the value of this operator.
3976 my $op_type = substr($curr_values, $off + 1, 1);
3978 # Get the full operator variant.
3979 my $opv = $op . substr($curr_vars, $off, 1);
3981 # Ignore operators passed as parameters.
3982 if ($op_type ne 'V' &&
3983 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
3986 # } elsif ($op =~ /^$;+$/) {
3988 # ; should have either the end of line or a space or \ after it
3989 } elsif ($op eq ';') {
3990 if ($ctx !~ /.x[WEBC]/ &&
3991 $cc !~ /^\\/ && $cc !~ /^;/) {
3992 if (ERROR("SPACING",
3993 "space required after that '$op' $at\n" . $hereptr)) {
3994 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
4000 } elsif ($op eq '//') {
4002 # : when part of a bitfield
4003 } elsif ($opv eq ':B') {
4004 # skip the bitfield test for now
4008 } elsif ($op eq '->') {
4009 if ($ctx =~ /Wx.|.xW/) {
4010 if (ERROR("SPACING",
4011 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
4012 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4013 if (defined $fix_elements[$n + 2]) {
4014 $fix_elements[$n + 2] =~ s/^\s+//;
4020 # , must not have a space before and must have a space on the right.
4021 } elsif ($op eq ',') {
4022 my $rtrim_before = 0;
4023 my $space_after = 0;
4024 if ($ctx =~ /Wx./) {
4025 if (ERROR("SPACING",
4026 "space prohibited before that '$op' $at\n" . $hereptr)) {
4031 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
4032 if (ERROR("SPACING",
4033 "space required after that '$op' $at\n" . $hereptr)) {
4039 if ($rtrim_before || $space_after) {
4040 if ($rtrim_before) {
4041 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4043 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4050 # '*' as part of a type definition -- reported already.
4051 } elsif ($opv eq '*_') {
4052 #warn "'*' is part of type\n";
4054 # unary operators should have a space before and
4055 # none after. May be left adjacent to another
4056 # unary operator, or a cast
4057 } elsif ($op eq '!' || $op eq '~' ||
4058 $opv eq '*U' || $opv eq '-U' ||
4059 $opv eq '&U' || $opv eq '&&U') {
4060 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
4061 if (ERROR("SPACING",
4062 "space required before that '$op' $at\n" . $hereptr)) {
4063 if ($n != $last_after + 2) {
4064 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4069 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
4070 # A unary '*' may be const
4072 } elsif ($ctx =~ /.xW/) {
4073 if (ERROR("SPACING",
4074 "space prohibited after that '$op' $at\n" . $hereptr)) {
4075 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
4076 if (defined $fix_elements[$n + 2]) {
4077 $fix_elements[$n + 2] =~ s/^\s+//;
4083 # unary ++ and unary -- are allowed no space on one side.
4084 } elsif ($op eq '++' or $op eq '--') {
4085 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
4086 if (ERROR("SPACING",
4087 "space required one side of that '$op' $at\n" . $hereptr)) {
4088 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
4092 if ($ctx =~ /Wx[BE]/ ||
4093 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
4094 if (ERROR("SPACING",
4095 "space prohibited before that '$op' $at\n" . $hereptr)) {
4096 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4100 if ($ctx =~ /ExW/) {
4101 if (ERROR("SPACING",
4102 "space prohibited after that '$op' $at\n" . $hereptr)) {
4103 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4104 if (defined $fix_elements[$n + 2]) {
4105 $fix_elements[$n + 2] =~ s/^\s+//;
4111 # << and >> may either have or not have spaces both sides
4112 } elsif ($op eq '<<' or $op eq '>>' or
4113 $op eq '&' or $op eq '^' or $op eq '|' or
4114 $op eq '+' or $op eq '-' or
4115 $op eq '*' or $op eq '/' or
4119 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4121 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4122 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4123 $fix_elements[$n + 2] =~ s/^\s+//;
4126 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4128 "space preferred before that '$op' $at\n" . $hereptr)) {
4129 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4133 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
4134 if (ERROR("SPACING",
4135 "need consistent spacing around '$op' $at\n" . $hereptr)) {
4136 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4137 if (defined $fix_elements[$n + 2]) {
4138 $fix_elements[$n + 2] =~ s/^\s+//;
4144 # A colon needs no spaces before when it is
4145 # terminating a case value or a label.
4146 } elsif ($opv eq ':C' || $opv eq ':L') {
4147 if ($ctx =~ /Wx./) {
4148 if (ERROR("SPACING",
4149 "space prohibited before that '$op' $at\n" . $hereptr)) {
4150 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4155 # All the others need spaces both sides.
4156 } elsif ($ctx !~ /[EWC]x[CWE]/) {
4159 # Ignore email addresses <foo@bar>
4161 $cc =~ /^\S+\@\S+>/) ||
4163 $ca =~ /<\S+\@\S+$/))
4168 # for asm volatile statements
4169 # ignore a colon with another
4170 # colon immediately before or after
4172 ($ca =~ /:$/ || $cc =~ /^:/)) {
4176 # messages are ERROR, but ?: are CHK
4178 my $msg_type = \&ERROR;
4179 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4181 if (&{$msg_type}("SPACING",
4182 "spaces required around that '$op' $at\n" . $hereptr)) {
4183 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4184 if (defined $fix_elements[$n + 2]) {
4185 $fix_elements[$n + 2] =~ s/^\s+//;
4191 $off += length($elements[$n + 1]);
4193 ## print("n: <$n> GOOD: <$good>\n");
4195 $fixed_line = $fixed_line . $good;
4198 if (($#elements % 2) == 0) {
4199 $fixed_line = $fixed_line . $fix_elements[$#elements];
4202 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4203 $fixed[$fixlinenr] = $fixed_line;
4209 # check for whitespace before a non-naked semicolon
4210 if ($line =~ /^\+.*\S\s+;\s*$/) {
4212 "space prohibited before semicolon\n" . $herecurr) &&
4214 1 while $fixed[$fixlinenr] =~
4215 s/^(\+.*\S)\s+;/$1;/;
4219 # check for multiple assignments
4220 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
4221 CHK("MULTIPLE_ASSIGNMENTS",
4222 "multiple assignments should be avoided\n" . $herecurr);
4225 ## # check for multiple declarations, allowing for a function declaration
4227 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4228 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4230 ## # Remove any bracketed sections to ensure we do not
4231 ## # falsly report the parameters of functions.
4233 ## while ($ln =~ s/\([^\(\)]*\)//g) {
4235 ## if ($ln =~ /,/) {
4236 ## WARN("MULTIPLE_DECLARATION",
4237 ## "declaring multiple variables together should be avoided\n" . $herecurr);
4241 #need space before brace following if, while, etc
4242 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
4244 if (ERROR("SPACING",
4245 "space required before the open brace '{'\n" . $herecurr) &&
4247 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
4251 ## # check for blank lines before declarations
4252 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4253 ## $prevrawline =~ /^.\s*$/) {
4255 ## "No blank lines before declarations\n" . $hereprev);
4259 # closing brace should have a space following it when it has anything
4261 if ($line =~ /}(?!(?:,|;|\)))\S/) {
4262 if (ERROR("SPACING",
4263 "space required after that close brace '}'\n" . $herecurr) &&
4265 $fixed[$fixlinenr] =~
4266 s/}((?!(?:,|;|\)))\S)/} $1/;
4270 # check spacing on square brackets
4271 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
4272 if (ERROR("SPACING",
4273 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4275 $fixed[$fixlinenr] =~
4279 if ($line =~ /\s\]/) {
4280 if (ERROR("SPACING",
4281 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4283 $fixed[$fixlinenr] =~
4288 # check spacing on parentheses
4289 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4290 $line !~ /for\s*\(\s+;/) {
4291 if (ERROR("SPACING",
4292 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4294 $fixed[$fixlinenr] =~
4298 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
4299 $line !~ /for\s*\(.*;\s+\)/ &&
4300 $line !~ /:\s+\)/) {
4301 if (ERROR("SPACING",
4302 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4304 $fixed[$fixlinenr] =~
4309 # check unnecessary parentheses around addressof/dereference single $Lvals
4310 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4312 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
4314 if (CHK("UNNECESSARY_PARENTHESES",
4315 "Unnecessary parentheses around $var\n" . $herecurr) &&
4317 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4321 # check for unnecessary parentheses around function pointer uses
4322 # ie: (foo->bar)(); should be foo->bar();
4323 # but not "if (foo->bar) (" to avoid some false positives
4324 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4326 if (CHK("UNNECESSARY_PARENTHESES",
4327 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4329 my $var2 = deparenthesize($var);
4331 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4335 #goto labels aren't indented, allow a single space however
4336 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
4337 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
4338 if (WARN("INDENTED_LABEL",
4339 "labels should not be indented\n" . $herecurr) &&
4341 $fixed[$fixlinenr] =~
4346 # return is not a function
4347 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
4349 if ($^V && $^V ge 5.10.0 &&
4350 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4352 $value = deparenthesize($value);
4353 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4354 ERROR("RETURN_PARENTHESES",
4355 "return is not a function, parentheses are not required\n" . $herecurr);
4357 } elsif ($spacing !~ /\s+/) {
4359 "space required before the open parenthesis '('\n" . $herecurr);
4363 # unnecessary return in a void function
4364 # at end-of-function, with the previous line a single leading tab, then return;
4365 # and the line before that not a goto label target like "out:"
4366 if ($sline =~ /^[ \+]}\s*$/ &&
4367 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4369 $lines[$linenr - 3] =~ /^[ +]/ &&
4370 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
4372 "void function return statements are not generally useful\n" . $hereprev);
4375 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4376 if ($^V && $^V ge 5.10.0 &&
4377 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4378 my $openparens = $1;
4379 my $count = $openparens =~ tr@\(@\(@;
4381 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4382 my $comp = $4; #Not $1 because of $LvalOrFunc
4383 $msg = " - maybe == should be = ?" if ($comp eq "==");
4384 WARN("UNNECESSARY_PARENTHESES",
4385 "Unnecessary parentheses$msg\n" . $herecurr);
4389 # comparisons with a constant or upper case identifier on the left
4390 # avoid cases like "foo + BAR < baz"
4391 # only fix matches surrounded by parentheses to avoid incorrect
4392 # conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4393 if ($^V && $^V ge 5.10.0 &&
4394 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4399 my $newcomp = $comp;
4400 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
4401 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4402 WARN("CONSTANT_COMPARISON",
4403 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4407 } elsif ($comp eq "<=") {
4409 } elsif ($comp eq ">") {
4411 } elsif ($comp eq ">=") {
4414 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4418 # Return of what appears to be an errno should normally be negative
4419 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
4421 if ($name ne 'EOF' && $name ne 'ERROR') {
4422 WARN("USE_NEGATIVE_ERRNO",
4423 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
4427 # Need a space before open parenthesis after if, while etc
4428 if ($line =~ /\b(if|while|for|switch)\(/) {
4429 if (ERROR("SPACING",
4430 "space required before the open parenthesis '('\n" . $herecurr) &&
4432 $fixed[$fixlinenr] =~
4433 s/\b(if|while|for|switch)\(/$1 \(/;
4437 # Check for illegal assignment in if conditional -- and check for trailing
4438 # statements after the conditional.
4439 if ($line =~ /do\s*(?!{)/) {
4440 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4441 ctx_statement_block($linenr, $realcnt, 0)
4442 if (!defined $stat);
4443 my ($stat_next) = ctx_statement_block($line_nr_next,
4444 $remain_next, $off_next);
4445 $stat_next =~ s/\n./\n /g;
4446 ##print "stat<$stat> stat_next<$stat_next>\n";
4448 if ($stat_next =~ /^\s*while\b/) {
4449 # If the statement carries leading newlines,
4450 # then count those as offsets.
4452 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4454 statement_rawlines($whitespace) - 1;
4456 $suppress_whiletrailers{$line_nr_next +
4460 if (!defined $suppress_whiletrailers{$linenr} &&
4461 defined($stat) && defined($cond) &&
4462 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
4463 my ($s, $c) = ($stat, $cond);
4465 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
4466 ERROR("ASSIGN_IN_IF",
4467 "do not use assignment in if condition\n" . $herecurr);
4470 # Find out what is on the end of the line after the
4472 substr($s, 0, length($c), '');
4474 $s =~ s/$;//g; # Remove any comments
4475 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4476 $c !~ /}\s*while\s*/)
4478 # Find out how long the conditional actually is.
4479 my @newlines = ($c =~ /\n/gs);
4480 my $cond_lines = 1 + $#newlines;
4483 $stat_real = raw_line($linenr, $cond_lines)
4484 . "\n" if ($cond_lines);
4485 if (defined($stat_real) && $cond_lines > 1) {
4486 $stat_real = "[...]\n$stat_real";
4489 ERROR("TRAILING_STATEMENTS",
4490 "trailing statements should be on next line\n" . $herecurr . $stat_real);
4494 # Check for bitwise tests written as boolean
4506 WARN("HEXADECIMAL_BOOLEAN_TEST",
4507 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
4510 # if and else should not have general statements after it
4511 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4513 $s =~ s/$;//g; # Remove any comments
4514 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
4515 ERROR("TRAILING_STATEMENTS",
4516 "trailing statements should be on next line\n" . $herecurr);
4519 # if should not continue a brace
4520 if ($line =~ /}\s*if\b/) {
4521 ERROR("TRAILING_STATEMENTS",
4522 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
4525 # case and default should not have general statements after them
4526 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4528 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
4532 ERROR("TRAILING_STATEMENTS",
4533 "trailing statements should be on next line\n" . $herecurr);
4536 # Check for }<nl>else {, these must be at the same
4537 # indent level to be relevant to each other.
4538 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4539 $previndent == $indent) {
4540 if (ERROR("ELSE_AFTER_BRACE",
4541 "else should follow close brace '}'\n" . $hereprev) &&
4542 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4543 fix_delete_line($fixlinenr - 1, $prevrawline);
4544 fix_delete_line($fixlinenr, $rawline);
4545 my $fixedline = $prevrawline;
4546 $fixedline =~ s/}\s*$//;
4547 if ($fixedline !~ /^\+\s*$/) {
4548 fix_insert_line($fixlinenr, $fixedline);
4550 $fixedline = $rawline;
4551 $fixedline =~ s/^(.\s*)else/$1} else/;
4552 fix_insert_line($fixlinenr, $fixedline);
4556 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4557 $previndent == $indent) {
4558 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4560 # Find out what is on the end of the line after the
4562 substr($s, 0, length($c), '');
4565 if ($s =~ /^\s*;/) {
4566 if (ERROR("WHILE_AFTER_BRACE",
4567 "while should follow close brace '}'\n" . $hereprev) &&
4568 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4569 fix_delete_line($fixlinenr - 1, $prevrawline);
4570 fix_delete_line($fixlinenr, $rawline);
4571 my $fixedline = $prevrawline;
4572 my $trailing = $rawline;
4573 $trailing =~ s/^\+//;
4574 $trailing = trim($trailing);
4575 $fixedline =~ s/}\s*$/} $trailing/;
4576 fix_insert_line($fixlinenr, $fixedline);
4581 #Specific variable tests
4582 while ($line =~ m{($Constant|$Lval)}g) {
4585 #gcc binary extension
4586 if ($var =~ /^$Binary$/) {
4587 if (WARN("GCC_BINARY_CONSTANT",
4588 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4590 my $hexval = sprintf("0x%x", oct($var));
4591 $fixed[$fixlinenr] =~
4592 s/\b$var\b/$hexval/;
4597 if ($var !~ /^$Constant$/ &&
4598 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
4599 #Ignore Page<foo> variants
4600 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
4601 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4602 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4603 #Ignore some three character SI units explicitly, like MiB and KHz
4604 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
4605 while ($var =~ m{($Ident)}g) {
4607 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
4609 seed_camelcase_includes();
4610 if (!$file && !$camelcase_file_seeded) {
4611 seed_camelcase_file($realfile);
4612 $camelcase_file_seeded = 1;
4615 if (!defined $camelcase{$word}) {
4616 $camelcase{$word} = 1;
4618 "Avoid CamelCase: <$word>\n" . $herecurr);
4624 #no spaces allowed after \ in define
4625 if ($line =~ /\#\s*define.*\\\s+$/) {
4626 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4627 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4629 $fixed[$fixlinenr] =~ s/\s+$//;
4633 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4634 # itself <asm/foo.h> (uses RAW line)
4635 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
4637 my $checkfile = "include/linux/$file";
4638 if (-f "$root/$checkfile" &&
4639 $realfile ne $checkfile &&
4640 $1 !~ /$allowed_asm_includes/)
4642 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4643 if ($asminclude > 0) {
4644 if ($realfile =~ m{^arch/}) {
4645 CHK("ARCH_INCLUDE_LINUX",
4646 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4648 WARN("INCLUDE_LINUX",
4649 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4655 # multi-statement macros should be enclosed in a do while loop, grab the
4656 # first statement and ensure its the whole macro if its not enclosed
4657 # in a known good container
4658 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4659 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
4662 my ($off, $dstat, $dcond, $rest);
4664 my $has_flow_statement = 0;
4665 my $has_arg_concat = 0;
4666 ($dstat, $dcond, $ln, $cnt, $off) =
4667 ctx_statement_block($linenr, $realcnt, 0);
4669 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4670 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4672 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
4673 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
4675 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
4677 $dstat =~ s/\\\n.//g;
4678 $dstat =~ s/^\s*//s;
4679 $dstat =~ s/\s*$//s;
4681 # Flatten any parentheses and braces
4682 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4683 $dstat =~ s/\{[^\{\}]*\}/1/ ||
4684 $dstat =~ s/.\[[^\[\]]*\]/1/)
4688 # Flatten any obvious string concatentation.
4689 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4690 $dstat =~ s/$Ident\s*($String)/$1/)
4694 # Make asm volatile uses seem like a generic function
4695 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
4697 my $exceptions = qr{
4710 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4712 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4713 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
4714 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4715 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
4716 $dstat !~ /$exceptions/ &&
4717 $dstat !~ /^\.$Ident\s*=/ && # .foo =
4718 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
4719 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
4720 $dstat !~ /^for\s*$Constant$/ && # for (...)
4721 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4722 $dstat !~ /^do\s*{/ && # do {...
4723 $dstat !~ /^\(\{/ && # ({...
4724 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
4727 my $herectx = $here . "\n";
4728 my $cnt = statement_rawlines($ctx);
4730 for (my $n = 0; $n < $cnt; $n++) {
4731 $herectx .= raw_line($linenr, $n) . "\n";
4734 if ($dstat =~ /;/) {
4735 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4736 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4738 ERROR("COMPLEX_MACRO",
4739 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
4743 # check for macros with flow control, but without ## concatenation
4744 # ## concatenation is commonly a macro that defines a function so ignore those
4745 if ($has_flow_statement && !$has_arg_concat) {
4746 my $herectx = $here . "\n";
4747 my $cnt = statement_rawlines($ctx);
4749 for (my $n = 0; $n < $cnt; $n++) {
4750 $herectx .= raw_line($linenr, $n) . "\n";
4752 WARN("MACRO_WITH_FLOW_CONTROL",
4753 "Macros with flow control statements should be avoided\n" . "$herectx");
4756 # check for line continuations outside of #defines, preprocessor #, and asm
4759 if ($prevline !~ /^..*\\$/ &&
4760 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4761 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
4762 $line =~ /^\+.*\\$/) {
4763 WARN("LINE_CONTINUATIONS",
4764 "Avoid unnecessary line continuations\n" . $herecurr);
4768 # do {} while (0) macro tests:
4769 # single-statement macros do not need to be enclosed in do while (0) loop,
4770 # macro should not end with a semicolon
4771 if ($^V && $^V ge 5.10.0 &&
4772 $realfile !~ m@/vmlinux.lds.h$@ &&
4773 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4776 my ($off, $dstat, $dcond, $rest);
4778 ($dstat, $dcond, $ln, $cnt, $off) =
4779 ctx_statement_block($linenr, $realcnt, 0);
4782 $dstat =~ s/\\\n.//g;
4785 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4790 my $cnt = statement_rawlines($ctx);
4791 my $herectx = $here . "\n";
4793 for (my $n = 0; $n < $cnt; $n++) {
4794 $herectx .= raw_line($linenr, $n) . "\n";
4797 if (($stmts =~ tr/;/;/) == 1 &&
4798 $stmts !~ /^\s*(if|while|for|switch)\b/) {
4799 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4800 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4802 if (defined $semis && $semis ne "") {
4803 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4804 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4806 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4808 my $cnt = statement_rawlines($ctx);
4809 my $herectx = $here . "\n";
4811 for (my $n = 0; $n < $cnt; $n++) {
4812 $herectx .= raw_line($linenr, $n) . "\n";
4815 WARN("TRAILING_SEMICOLON",
4816 "macros should not use a trailing semicolon\n" . "$herectx");
4820 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4821 # all assignments may have only one of the following with an assignment:
4824 # VMLINUX_SYMBOL(...)
4825 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
4826 WARN("MISSING_VMLINUX_SYMBOL",
4827 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
4830 # check for redundant bracing round if etc
4831 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4832 my ($level, $endln, @chunks) =
4833 ctx_statement_full($linenr, $realcnt, 1);
4834 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
4835 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4836 if ($#chunks > 0 && $level == 0) {
4840 my $herectx = $here . "\n";
4841 my $ln = $linenr - 1;
4842 for my $chunk (@chunks) {
4843 my ($cond, $block) = @{$chunk};
4845 # If the condition carries leading newlines, then count those as offsets.
4846 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4847 my $offset = statement_rawlines($whitespace) - 1;
4849 $allowed[$allow] = 0;
4850 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4852 # We have looked at and allowed this specific line.
4853 $suppress_ifbraces{$ln + $offset} = 1;
4855 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
4856 $ln += statement_rawlines($block) - 1;
4858 substr($block, 0, length($cond), '');
4860 $seen++ if ($block =~ /^\s*{/);
4862 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
4863 if (statement_lines($cond) > 1) {
4864 #print "APW: ALLOWED: cond<$cond>\n";
4865 $allowed[$allow] = 1;
4867 if ($block =~/\b(?:if|for|while)\b/) {
4868 #print "APW: ALLOWED: block<$block>\n";
4869 $allowed[$allow] = 1;
4871 if (statement_block_size($block) > 1) {
4872 #print "APW: ALLOWED: lines block<$block>\n";
4873 $allowed[$allow] = 1;
4878 my $sum_allowed = 0;
4879 foreach (@allowed) {
4882 if ($sum_allowed == 0) {
4884 "braces {} are not necessary for any arm of this statement\n" . $herectx);
4885 } elsif ($sum_allowed != $allow &&
4888 "braces {} should be used on all arms of this statement\n" . $herectx);
4893 if (!defined $suppress_ifbraces{$linenr - 1} &&
4894 $line =~ /\b(if|while|for|else)\b/) {
4897 # Check the pre-context.
4898 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
4899 #print "APW: ALLOWED: pre<$1>\n";
4903 my ($level, $endln, @chunks) =
4904 ctx_statement_full($linenr, $realcnt, $-[0]);
4906 # Check the condition.
4907 my ($cond, $block) = @{$chunks[0]};
4908 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
4909 if (defined $cond) {
4910 substr($block, 0, length($cond), '');
4912 if (statement_lines($cond) > 1) {
4913 #print "APW: ALLOWED: cond<$cond>\n";
4916 if ($block =~/\b(?:if|for|while)\b/) {
4917 #print "APW: ALLOWED: block<$block>\n";
4920 if (statement_block_size($block) > 1) {
4921 #print "APW: ALLOWED: lines block<$block>\n";
4924 # Check the post-context.
4925 if (defined $chunks[1]) {
4926 my ($cond, $block) = @{$chunks[1]};
4927 if (defined $cond) {
4928 substr($block, 0, length($cond), '');
4930 if ($block =~ /^\s*\{/) {
4931 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4935 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
4936 my $herectx = $here . "\n";
4937 my $cnt = statement_rawlines($block);
4939 for (my $n = 0; $n < $cnt; $n++) {
4940 $herectx .= raw_line($linenr, $n) . "\n";
4944 "braces {} are not necessary for single statement blocks\n" . $herectx);
4948 # check for unnecessary blank lines around braces
4949 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
4951 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
4952 $fix && $prevrawline =~ /^\+/) {
4953 fix_delete_line($fixlinenr - 1, $prevrawline);
4956 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
4958 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
4960 fix_delete_line($fixlinenr, $rawline);
4964 # no volatiles please
4965 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
4966 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
4968 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
4971 # Check for user-visible strings broken across lines, which breaks the ability
4972 # to grep for the string. Make exceptions when the previous string ends in a
4973 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
4974 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
4975 if ($line =~ /^\+\s*$String/ &&
4976 $prevline =~ /"\s*$/ &&
4977 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
4978 if (WARN("SPLIT_STRING",
4979 "quoted string split across lines\n" . $hereprev) &&
4981 $prevrawline =~ /^\+.*"\s*$/ &&
4982 $last_coalesced_string_linenr != $linenr - 1) {
4983 my $extracted_string = get_quoted_string($line, $rawline);
4984 my $comma_close = "";
4985 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
4989 fix_delete_line($fixlinenr - 1, $prevrawline);
4990 fix_delete_line($fixlinenr, $rawline);
4991 my $fixedline = $prevrawline;
4992 $fixedline =~ s/"\s*$//;
4993 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
4994 fix_insert_line($fixlinenr - 1, $fixedline);
4995 $fixedline = $rawline;
4996 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
4997 if ($fixedline !~ /\+\s*$/) {
4998 fix_insert_line($fixlinenr, $fixedline);
5000 $last_coalesced_string_linenr = $linenr;
5004 # check for missing a space in a string concatenation
5005 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5006 WARN('MISSING_SPACE',
5007 "break quoted strings at a space character\n" . $hereprev);
5010 # check for spaces before a quoted newline
5011 if ($rawline =~ /^.*\".*\s\\n/) {
5012 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5013 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5015 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5020 # concatenated string without spaces between elements
5021 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
5022 CHK("CONCATENATED_STRING",
5023 "Concatenated strings should use spaces between elements\n" . $herecurr);
5026 # uncoalesced string fragments
5027 if ($line =~ /$String\s*"/) {
5028 WARN("STRING_FRAGMENTS",
5029 "Consecutive strings are generally better as a single string\n" . $herecurr);
5032 # check for %L{u,d,i} and 0x%[udi] in strings
5034 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
5035 $string = substr($rawline, $-[1], $+[1] - $-[1]);
5036 $string =~ s/%%/__/g;
5037 if ($string =~ /(?<!%)%[\*\d\.\$]*L[udi]/) {
5039 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
5042 if ($string =~ /0x%[\*\d\.\$\Llzth]*[udi]/) {
5043 ERROR("PRINTF_0xDECIMAL",
5044 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5048 # check for line continuations in quoted strings with odd counts of "
5049 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
5050 WARN("LINE_CONTINUATIONS",
5051 "Avoid line continuations in quoted strings\n" . $herecurr);
5055 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
5056 CHK("REDUNDANT_CODE",
5057 "if this code is redundant consider removing it\n" .
5061 # check for needless "if (<foo>) fn(<foo>)" uses
5062 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
5063 my $tested = quotemeta($1);
5064 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5065 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5067 if (WARN('NEEDLESS_IF',
5068 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5071 my $leading_tabs = "";
5072 my $new_leading_tabs = "";
5073 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5078 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5079 $new_leading_tabs = $1;
5080 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5087 fix_delete_line($fixlinenr - 1, $prevrawline);
5088 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5094 # check for unnecessary "Out of Memory" messages
5095 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5096 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5097 (defined $1 || defined $3) &&
5100 my $testline = $lines[$linenr - 3];
5102 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5103 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5105 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
5107 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5111 # check for logging functions with KERN_<LEVEL>
5112 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
5113 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5115 if (WARN("UNNECESSARY_KERN_LEVEL",
5116 "Possible unnecessary $level\n" . $herecurr) &&
5118 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5122 # check for mask then right shift without a parentheses
5123 if ($^V && $^V ge 5.10.0 &&
5124 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5125 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5126 WARN("MASK_THEN_SHIFT",
5127 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5130 # check for pointer comparisons to NULL
5131 if ($^V && $^V ge 5.10.0) {
5132 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5135 $equal = "" if ($4 eq "!=");
5136 if (CHK("COMPARISON_TO_NULL",
5137 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5139 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5144 # check for bad placement of section $InitAttribute (e.g.: __initdata)
5145 if ($line =~ /(\b$InitAttribute\b)/) {
5147 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5150 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5151 ERROR("MISPLACED_INIT",
5152 "$attr should be placed after $var\n" . $herecurr)) ||
5153 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5154 WARN("MISPLACED_INIT",
5155 "$attr should be placed after $var\n" . $herecurr))) &&
5157 $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;
5162 # check for $InitAttributeData (ie: __initdata) with const
5163 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5165 $attr =~ /($InitAttributePrefix)(.*)/;
5166 my $attr_prefix = $1;
5168 if (ERROR("INIT_ATTRIBUTE",
5169 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5171 $fixed[$fixlinenr] =~
5172 s/$InitAttributeData/${attr_prefix}initconst/;
5176 # check for $InitAttributeConst (ie: __initconst) without const
5177 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5179 if (ERROR("INIT_ATTRIBUTE",
5180 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5182 my $lead = $fixed[$fixlinenr] =~
5183 /(^\+\s*(?:static\s+))/;
5185 $lead = "$lead " if ($lead !~ /^\+$/);
5186 $lead = "${lead}const ";
5187 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
5191 # check for __read_mostly with const non-pointer (should just be const)
5192 if ($line =~ /\b__read_mostly\b/ &&
5193 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5194 if (ERROR("CONST_READ_MOSTLY",
5195 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5197 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5201 # don't use __constant_<foo> functions outside of include/uapi/
5202 if ($realfile !~ m@^include/uapi/@ &&
5203 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5204 my $constant_func = $1;
5205 my $func = $constant_func;
5206 $func =~ s/^__constant_//;
5207 if (WARN("CONSTANT_CONVERSION",
5208 "$constant_func should be $func\n" . $herecurr) &&
5210 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
5214 # prefer usleep_range over udelay
5215 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
5217 # ignore udelay's < 10, however
5218 if (! ($delay < 10) ) {
5220 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5222 if ($delay > 2000) {
5224 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
5228 # warn about unexpectedly long msleep's
5229 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5232 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5236 # check for comparisons of jiffies
5237 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5238 WARN("JIFFIES_COMPARISON",
5239 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5242 # check for comparisons of get_jiffies_64()
5243 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5244 WARN("JIFFIES_COMPARISON",
5245 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5248 # warn about #ifdefs in C files
5249 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5250 # print "#ifdef in C files should be avoided\n";
5251 # print "$herecurr";
5255 # warn about spacing in #ifdefs
5256 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
5257 if (ERROR("SPACING",
5258 "exactly one space required after that #$1\n" . $herecurr) &&
5260 $fixed[$fixlinenr] =~
5261 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5266 # check for spinlock_t definitions without a comment.
5267 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5268 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
5270 if (!ctx_has_comment($first_line, $linenr)) {
5271 CHK("UNCOMMENTED_DEFINITION",
5272 "$1 definition without comment\n" . $herecurr);
5275 # check for memory barriers without a comment.
5281 read_barrier_depends
5283 my $barrier_stems = qr{
5291 my $all_barriers = qr{
5293 smp_(?:$barrier_stems)|
5294 virt_(?:$barrier_stems)
5297 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
5298 if (!ctx_has_comment($first_line, $linenr)) {
5299 WARN("MEMORY_BARRIER",
5300 "memory barrier without comment\n" . $herecurr);
5304 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5306 if ($realfile !~ m@^include/asm-generic/@ &&
5307 $realfile !~ m@/barrier\.h$@ &&
5308 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5309 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5310 WARN("MEMORY_BARRIER",
5311 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5314 # check for waitqueue_active without a comment.
5315 if ($line =~ /\bwaitqueue_active\s*\(/) {
5316 if (!ctx_has_comment($first_line, $linenr)) {
5317 WARN("WAITQUEUE_ACTIVE",
5318 "waitqueue_active without comment\n" . $herecurr);
5322 # Check for expedited grace periods that interrupt non-idle non-nohz
5323 # online CPUs. These expedited can therefore degrade real-time response
5324 # if used carelessly, and should be avoided where not absolutely
5325 # needed. It is always OK to use synchronize_rcu_expedited() and
5326 # synchronize_sched_expedited() at boot time (before real-time applications
5327 # start) and in error situations where real-time response is compromised in
5328 # any case. Note that synchronize_srcu_expedited() does -not- interrupt
5329 # other CPUs, so don't warn on uses of synchronize_srcu_expedited().
5330 # Of course, nothing comes for free, and srcu_read_lock() and
5331 # srcu_read_unlock() do contain full memory barriers in payment for
5332 # synchronize_srcu_expedited() non-interruption properties.
5333 if ($line =~ /\b(synchronize_rcu_expedited|synchronize_sched_expedited)\(/) {
5334 WARN("EXPEDITED_RCU_GRACE_PERIOD",
5335 "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr);
5339 # check of hardware specific defines
5340 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5342 "architecture specific defines should be avoided\n" . $herecurr);
5345 # Check that the storage class is at the beginning of a declaration
5346 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
5347 WARN("STORAGE_CLASS",
5348 "storage class should be at the beginning of the declaration\n" . $herecurr)
5351 # check the location of the inline attribute, that it is between
5352 # storage class and type.
5353 if ($line =~ /\b$Type\s+$Inline\b/ ||
5354 $line =~ /\b$Inline\s+$Storage\b/) {
5355 ERROR("INLINE_LOCATION",
5356 "inline keyword should sit between storage class and type\n" . $herecurr);
5359 # Check for __inline__ and __inline, prefer inline
5360 if ($realfile !~ m@\binclude/uapi/@ &&
5361 $line =~ /\b(__inline__|__inline)\b/) {
5363 "plain inline is preferred over $1\n" . $herecurr) &&
5365 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
5370 # Check for __attribute__ packed, prefer __packed
5371 if ($realfile !~ m@\binclude/uapi/@ &&
5372 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
5373 WARN("PREFER_PACKED",
5374 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
5377 # Check for __attribute__ aligned, prefer __aligned
5378 if ($realfile !~ m@\binclude/uapi/@ &&
5379 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
5380 WARN("PREFER_ALIGNED",
5381 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
5384 # Check for __attribute__ format(printf, prefer __printf
5385 if ($realfile !~ m@\binclude/uapi/@ &&
5386 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
5387 if (WARN("PREFER_PRINTF",
5388 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5390 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5395 # Check for __attribute__ format(scanf, prefer __scanf
5396 if ($realfile !~ m@\binclude/uapi/@ &&
5397 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
5398 if (WARN("PREFER_SCANF",
5399 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5401 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5405 # Check for __attribute__ weak, or __weak declarations (may have link issues)
5406 if ($^V && $^V ge 5.10.0 &&
5407 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5408 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5409 $line =~ /\b__weak\b/)) {
5410 ERROR("WEAK_DECLARATION",
5411 "Using weak declarations can have unintended link defects\n" . $herecurr);
5414 # check for c99 types like uint8_t used outside of uapi/
5415 if ($realfile !~ m@\binclude/uapi/@ &&
5416 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5418 if ($type =~ /\b($typeC99Typedefs)\b/) {
5420 my $kernel_type = 'u';
5421 $kernel_type = 's' if ($type =~ /^_*[si]/);
5424 if (CHK("PREFER_KERNEL_TYPES",
5425 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5427 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5432 # check for cast of C90 native int or longer types constants
5433 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5436 if (WARN("TYPECAST_INT_CONSTANT",
5437 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5440 my $newconst = $const;
5441 $newconst =~ s/${Int_type}$//;
5442 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5443 if ($cast =~ /\blong\s+long\b/) {
5445 } elsif ($cast =~ /\blong\b/) {
5448 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5452 # check for sizeof(&)
5453 if ($line =~ /\bsizeof\s*\(\s*\&/) {
5454 WARN("SIZEOF_ADDRESS",
5455 "sizeof(& should be avoided\n" . $herecurr);
5458 # check for sizeof without parenthesis
5459 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
5460 if (WARN("SIZEOF_PARENTHESIS",
5461 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5463 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5467 # check for struct spinlock declarations
5468 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5469 WARN("USE_SPINLOCK_T",
5470 "struct spinlock should be spinlock_t\n" . $herecurr);
5473 # check for seq_printf uses that could be seq_puts
5474 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
5475 my $fmt = get_quoted_string($line, $rawline);
5478 if (WARN("PREFER_SEQ_PUTS",
5479 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5481 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
5486 # Check for misused memsets
5487 if ($^V && $^V ge 5.10.0 &&
5489 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
5495 if ($ms_size =~ /^(0x|)0$/i) {
5497 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
5498 } elsif ($ms_size =~ /^(0x|)1$/i) {
5500 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5504 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5505 if ($^V && $^V ge 5.10.0 &&
5507 $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5508 if (WARN("PREFER_ETHER_ADDR_COPY",
5509 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5511 $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5515 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5516 if ($^V && $^V ge 5.10.0 &&
5518 $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5519 WARN("PREFER_ETHER_ADDR_EQUAL",
5520 "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5523 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5524 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5525 if ($^V && $^V ge 5.10.0 &&
5527 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5531 if ($ms_val =~ /^(?:0x|)0+$/i) {
5532 if (WARN("PREFER_ETH_ZERO_ADDR",
5533 "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5535 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5537 } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5538 if (WARN("PREFER_ETH_BROADCAST_ADDR",
5539 "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5541 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5546 # typecasts on min/max could be min_t/max_t
5547 if ($^V && $^V ge 5.10.0 &&
5549 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
5550 if (defined $2 || defined $7) {
5552 my $cast1 = deparenthesize($2);
5554 my $cast2 = deparenthesize($7);
5558 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
5559 $cast = "$cast1 or $cast2";
5560 } elsif ($cast1 ne "") {
5566 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
5570 # check usleep_range arguments
5571 if ($^V && $^V ge 5.10.0 &&
5573 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5577 WARN("USLEEP_RANGE",
5578 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5579 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5581 WARN("USLEEP_RANGE",
5582 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5586 # check for naked sscanf
5587 if ($^V && $^V ge 5.10.0 &&
5589 $line =~ /\bsscanf\b/ &&
5590 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5591 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5592 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5593 my $lc = $stat =~ tr@\n@@;
5594 $lc = $lc + $linenr;
5595 my $stat_real = raw_line($linenr, 0);
5596 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5597 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5599 WARN("NAKED_SSCANF",
5600 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5603 # check for simple sscanf that should be kstrto<foo>
5604 if ($^V && $^V ge 5.10.0 &&
5606 $line =~ /\bsscanf\b/) {
5607 my $lc = $stat =~ tr@\n@@;
5608 $lc = $lc + $linenr;
5609 my $stat_real = raw_line($linenr, 0);
5610 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5611 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5613 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5615 my $count = $format =~ tr@%@%@;
5617 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5618 WARN("SSCANF_TO_KSTRTO",
5619 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5624 # check for new externs in .h files.
5625 if ($realfile =~ /\.h$/ &&
5626 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
5627 if (CHK("AVOID_EXTERNS",
5628 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
5630 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
5634 # check for new externs in .c files.
5635 if ($realfile =~ /\.c$/ && defined $stat &&
5636 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
5638 my $function_name = $1;
5639 my $paren_space = $2;
5642 if (defined $cond) {
5643 substr($s, 0, length($cond), '');
5645 if ($s =~ /^\s*;/ &&
5646 $function_name ne 'uninitialized_var')
5648 WARN("AVOID_EXTERNS",
5649 "externs should be avoided in .c files\n" . $herecurr);
5652 if ($paren_space =~ /\n/) {
5653 WARN("FUNCTION_ARGUMENTS",
5654 "arguments for function declarations should follow identifier\n" . $herecurr);
5657 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5658 $stat =~ /^.\s*extern\s+/)
5660 WARN("AVOID_EXTERNS",
5661 "externs should be avoided in .c files\n" . $herecurr);
5664 # checks for new __setup's
5665 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5668 if (!grep(/$name/, @setup_docs)) {
5669 CHK("UNDOCUMENTED_SETUP",
5670 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
5674 # check for pointless casting of kmalloc return
5675 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
5676 WARN("UNNECESSARY_CASTS",
5677 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
5681 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5682 if ($^V && $^V ge 5.10.0 &&
5683 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5684 CHK("ALLOC_SIZEOF_STRUCT",
5685 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
5688 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5689 if ($^V && $^V ge 5.10.0 &&
5690 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
5694 my $newfunc = "kmalloc_array";
5695 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
5698 if ($a1 =~ /^sizeof\s*\S/) {
5702 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
5703 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
5704 if (WARN("ALLOC_WITH_MULTIPLY",
5705 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
5707 $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;
5713 # check for krealloc arg reuse
5714 if ($^V && $^V ge 5.10.0 &&
5715 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
5716 WARN("KREALLOC_ARG_REUSE",
5717 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
5720 # check for alloc argument mismatch
5721 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
5722 WARN("ALLOC_ARRAY_ARGS",
5723 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
5726 # check for multiple semicolons
5727 if ($line =~ /;\s*;\s*$/) {
5728 if (WARN("ONE_SEMICOLON",
5729 "Statements terminations use 1 semicolon\n" . $herecurr) &&
5731 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
5735 # check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
5736 if ($realfile !~ m@^include/uapi/@ &&
5737 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
5739 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
5740 if (CHK("BIT_MACRO",
5741 "Prefer using the BIT$ull macro\n" . $herecurr) &&
5743 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
5747 # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
5748 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
5750 if (WARN("PREFER_IS_ENABLED",
5751 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
5753 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
5757 # check for case / default statements not preceded by break/fallthrough/switch
5758 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
5760 my $has_statement = 0;
5762 my $prevline = $linenr;
5763 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
5765 my $rline = $rawlines[$prevline - 1];
5766 my $fline = $lines[$prevline - 1];
5767 last if ($fline =~ /^\@\@/);
5768 next if ($fline =~ /^\-/);
5769 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
5770 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
5771 next if ($fline =~ /^.[\s$;]*$/);
5774 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
5776 if (!$has_break && $has_statement) {
5777 WARN("MISSING_BREAK",
5778 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
5782 # check for switch/default statements without a break;
5783 if ($^V && $^V ge 5.10.0 &&
5785 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
5787 my $herectx = $here . "\n";
5788 my $cnt = statement_rawlines($stat);
5789 for (my $n = 0; $n < $cnt; $n++) {
5790 $herectx .= raw_line($linenr, $n) . "\n";
5792 WARN("DEFAULT_NO_BREAK",
5793 "switch default: should use break\n" . $herectx);
5796 # check for gcc specific __FUNCTION__
5797 if ($line =~ /\b__FUNCTION__\b/) {
5798 if (WARN("USE_FUNC",
5799 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
5801 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
5805 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
5806 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
5808 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
5811 # check for use of yield()
5812 if ($line =~ /\byield\s*\(\s*\)/) {
5814 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
5817 # check for comparisons against true and false
5818 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
5826 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
5828 my $type = lc($otype);
5829 if ($type =~ /^(?:true|false)$/) {
5830 if (("$test" eq "==" && "$type" eq "true") ||
5831 ("$test" eq "!=" && "$type" eq "false")) {
5835 CHK("BOOL_COMPARISON",
5836 "Using comparison to $otype is error prone\n" . $herecurr);
5838 ## maybe suggesting a correct construct would better
5839 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5844 # check for semaphores initialized locked
5845 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
5846 WARN("CONSIDER_COMPLETION",
5847 "consider using a completion\n" . $herecurr);
5850 # recommend kstrto* over simple_strto* and strict_strto*
5851 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
5852 WARN("CONSIDER_KSTRTO",
5853 "$1 is obsolete, use k$3 instead\n" . $herecurr);
5856 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
5857 if ($line =~ /^.\s*__initcall\s*\(/) {
5858 WARN("USE_DEVICE_INITCALL",
5859 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
5862 # check for various structs that are normally const (ops, kgdb, device_tree)
5863 my $const_structs = qr{
5865 address_space_operations|
5867 block_device_operations|
5872 file_lock_operations|
5882 lock_manager_operations|
5889 pipe_buf_operations|
5890 platform_hibernation_ops|
5891 platform_suspend_ops|
5896 soc_pcmcia_socket_ops|
5903 if ($line !~ /\bconst\b/ &&
5904 $line =~ /\bstruct\s+($const_structs)\b/) {
5905 WARN("CONST_STRUCT",
5906 "struct $1 should normally be const\n" .
5910 # use of NR_CPUS is usually wrong
5911 # ignore definitions of NR_CPUS and usage to define arrays as likely right
5912 if ($line =~ /\bNR_CPUS\b/ &&
5913 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
5914 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
5915 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
5916 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
5917 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
5920 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
5923 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
5924 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
5925 ERROR("DEFINE_ARCH_HAS",
5926 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
5929 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
5930 if ($^V && $^V ge 5.10.0 &&
5931 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
5932 WARN("LIKELY_MISUSE",
5933 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
5936 # whine mightly about in_atomic
5937 if ($line =~ /\bin_atomic\s*\(/) {
5938 if ($realfile =~ m@^drivers/@) {
5940 "do not use in_atomic in drivers\n" . $herecurr);
5941 } elsif ($realfile !~ m@^kernel/@) {
5943 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
5947 # whine about ACCESS_ONCE
5948 if ($^V && $^V ge 5.10.0 &&
5949 $line =~ /\bACCESS_ONCE\s*$balanced_parens\s*(=(?!=))?\s*($FuncArg)?/) {
5953 $par =~ s/^\(\s*(.*)\s*\)$/$1/;
5955 if (WARN("PREFER_WRITE_ONCE",
5956 "Prefer WRITE_ONCE(<FOO>, <BAR>) over ACCESS_ONCE(<FOO>) = <BAR>\n" . $herecurr) &&
5958 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/;
5961 if (WARN("PREFER_READ_ONCE",
5962 "Prefer READ_ONCE(<FOO>) over ACCESS_ONCE(<FOO>)\n" . $herecurr) &&
5964 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)/READ_ONCE($par)/;
5969 # check for lockdep_set_novalidate_class
5970 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
5971 $line =~ /__lockdep_no_validate__\s*\)/ ) {
5972 if ($realfile !~ m@^kernel/lockdep@ &&
5973 $realfile !~ m@^include/linux/lockdep@ &&
5974 $realfile !~ m@^drivers/base/core@) {
5976 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
5980 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
5981 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
5982 WARN("EXPORTED_WORLD_WRITABLE",
5983 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5986 # Mode permission misuses where it seems decimal should be octal
5987 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5988 if ($^V && $^V ge 5.10.0 &&
5989 $line =~ /$mode_perms_search/) {
5990 foreach my $entry (@mode_permission_funcs) {
5991 my $func = $entry->[0];
5992 my $arg_pos = $entry->[1];
5997 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
5999 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
6000 if ($line =~ /$test/) {
6002 $val = $6 if ($skip_args ne "");
6004 if ($val !~ /^0$/ &&
6005 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6006 length($val) ne 4)) {
6007 ERROR("NON_OCTAL_PERMISSIONS",
6008 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
6009 } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) {
6010 ERROR("EXPORTED_WORLD_WRITABLE",
6011 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6017 # validate content of MODULE_LICENSE against list from include/linux/module.h
6018 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6019 my $extracted_string = get_quoted_string($line, $rawline);
6020 my $valid_licenses = qr{
6023 GPL\ and\ additional\ rights|
6029 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6030 WARN("MODULE_LICENSE",
6031 "unknown module license " . $extracted_string . "\n" . $herecurr);
6036 # If we have no input at all, then there is nothing to report on
6037 # so just keep quiet.
6038 if ($#rawlines == -1) {
6042 # In mailback mode only produce a report in the negative, for
6043 # things that appear to be patches.
6044 if ($mailback && ($clean == 1 || !$is_patch)) {
6048 # This is not a patch, and we are are in 'no-patch' mode so
6050 if (!$chk_patch && !$is_patch) {
6054 if (!$is_patch && $file !~ /cover-letter\.patch$/) {
6055 ERROR("NOT_UNIFIED_DIFF",
6056 "Does not appear to be a unified-diff format patch\n");
6058 if ($is_patch && $filename ne '-' && $chk_signoff && $signoff == 0) {
6059 ERROR("MISSING_SIGN_OFF",
6060 "Missing Signed-off-by: line(s)\n");
6063 print report_dump();
6064 if ($summary && !($clean == 1 && $quiet == 1)) {
6065 print "$filename " if ($summary_file);
6066 print "total: $cnt_error errors, $cnt_warn warnings, " .
6067 (($check)? "$cnt_chk checks, " : "") .
6068 "$cnt_lines lines checked\n";
6072 # If there were any defects found and not already fixing them
6073 if (!$clean and !$fix) {
6076 NOTE: For some of the reported defects, checkpatch may be able to
6077 mechanically convert to the typical style using --fix or --fix-inplace.
6080 # If there were whitespace errors which cleanpatch can fix
6081 # then suggest that.
6082 if ($rpt_cleaners) {
6086 NOTE: Whitespace errors detected.
6087 You may wish to use scripts/cleanpatch or scripts/cleanfile
6092 if ($clean == 0 && $fix &&
6093 ("@rawlines" ne "@fixed" ||
6094 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
6095 my $newfile = $filename;
6096 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
6100 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6102 open($f, '>', $newfile)
6103 or die "$P: Can't open $newfile for write\n";
6104 foreach my $fixed_line (@fixed) {
6107 if ($linecount > 3) {
6108 $fixed_line =~ s/^\+//;
6109 print $f $fixed_line . "\n";
6112 print $f $fixed_line . "\n";
6120 Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6122 Do _NOT_ trust the results written to this file.
6123 Do _NOT_ submit these changes without inspecting them for correctness.
6125 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6126 No warranties, expressed or implied...
6134 print "$vname has no obvious style problems and is ready for submission.\n";
6136 print "$vname has style problems, please review.\n";