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
17 use Getopt::Long qw(:config no_auto_abbrev);
43 my $configuration_file = ".checkpatch.conf";
44 my $max_line_length = 80;
45 my $ignore_perl_version = 0;
46 my $minimum_perl_version = 5.10.0;
47 my $min_conf_desc_length = 4;
48 my $spelling_file = "$D/spelling.txt";
54 Usage: $P [OPTION]... [FILE]...
59 --no-tree run without a kernel tree
60 --no-signoff do not check for 'Signed-off-by' line
61 --patch treat FILE as patchfile (default)
62 --emacs emacs compile window format
63 --terse one line per report
64 -f, --file treat FILE as regular source file
65 --subjective, --strict enable more subjective tests
66 --types TYPE(,TYPE2...) show only these comma separated message types
67 --ignore TYPE(,TYPE2...) ignore various comma separated message types
68 --max-line-length=n set the maximum line length, if exceeded, warn
69 --min-conf-desc-length=n set the min description length, if shorter, warn
70 --show-types show the message "types" in the output
71 --root=PATH PATH to the kernel tree root
72 --no-summary suppress the per-file summary
73 --mailback only produce a report in case of warnings/errors
74 --summary-file include the filename in summary
75 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
76 'values', 'possible', 'type', and 'attr' (default
78 --test-only=WORD report only warnings/errors containing WORD
80 --fix EXPERIMENTAL - may create horrible results
81 If correctable single-line errors exist, create
82 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
83 with potential errors corrected to the preferred
85 --fix-inplace EXPERIMENTAL - may create horrible results
86 Is the same as --fix, but overwrites the input
87 file. It's your fault if there's no backup or git
88 --ignore-perl-version override checking of perl version. expect
90 -h, --help, --version display this help and exit
92 When FILE is - read standard input.
98 my $conf = which_conf($configuration_file);
101 open(my $conffile, '<', "$conf")
102 or warn "$P: Can't find a readable $configuration_file file $!\n";
104 while (<$conffile>) {
107 $line =~ s/\s*\n?$//g;
111 next if ($line =~ m/^\s*#/);
112 next if ($line =~ m/^\s*$/);
114 my @words = split(" ", $line);
115 foreach my $word (@words) {
116 last if ($word =~ m/^#/);
117 push (@conf_args, $word);
121 unshift(@ARGV, @conf_args) if @conf_args;
125 'q|quiet+' => \$quiet,
127 'signoff!' => \$chk_signoff,
128 'patch!' => \$chk_patch,
132 'subjective!' => \$check,
133 'strict!' => \$check,
134 'ignore=s' => \@ignore,
136 'show-types!' => \$show_types,
137 'max-line-length=i' => \$max_line_length,
138 'min-conf-desc-length=i' => \$min_conf_desc_length,
140 'summary!' => \$summary,
141 'mailback!' => \$mailback,
142 'summary-file!' => \$summary_file,
144 'fix-inplace!' => \$fix_inplace,
145 'ignore-perl-version!' => \$ignore_perl_version,
146 'debug=s' => \%debug,
147 'test-only=s' => \$tst_only,
154 $fix = 1 if ($fix_inplace);
155 $check_orig = $check;
159 if ($^V && $^V lt $minimum_perl_version) {
160 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
161 if (!$ignore_perl_version) {
167 print "$P: no input files\n";
171 sub hash_save_array_words {
172 my ($hashRef, $arrayRef) = @_;
174 my @array = split(/,/, join(',', @$arrayRef));
175 foreach my $word (@array) {
176 $word =~ s/\s*\n?$//g;
179 $word =~ tr/[a-z]/[A-Z]/;
181 next if ($word =~ m/^\s*#/);
182 next if ($word =~ m/^\s*$/);
188 sub hash_show_words {
189 my ($hashRef, $prefix) = @_;
191 if ($quiet == 0 && keys %$hashRef) {
192 print "NOTE: $prefix message types:";
193 foreach my $word (sort keys %$hashRef) {
200 hash_save_array_words(\%ignore_type, \@ignore);
201 hash_save_array_words(\%use_type, \@use);
204 my $dbg_possible = 0;
207 for my $key (keys %debug) {
209 eval "\${dbg_$key} = '$debug{$key}';";
213 my $rpt_cleaners = 0;
222 if (!top_of_kernel_tree($root)) {
223 die "$P: $root: --root does not point at a valid tree\n";
226 if (top_of_kernel_tree('.')) {
228 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
229 top_of_kernel_tree($1)) {
234 if (!defined $root) {
235 print "Must be run from the top-level dir. of a kernel tree\n";
240 my $emitted_corrupt = 0;
243 [A-Za-z_][A-Za-z\d_]*
244 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
246 our $Storage = qr{extern|static|asmlinkage};
258 our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
259 our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
260 our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
261 our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
262 our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
264 # Notes to $Attribute:
265 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
285 ____cacheline_aligned|
286 ____cacheline_aligned_in_smp|
287 ____cacheline_internodealigned_in_smp|
291 our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
292 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
293 our $Lval = qr{$Ident(?:$Member)*};
295 our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
296 our $Binary = qr{(?i)0b[01]+$Int_type?};
297 our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
298 our $Int = qr{[0-9]+$Int_type?};
299 our $Octal = qr{0[0-7]+$Int_type?};
300 our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
301 our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
302 our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
303 our $Float = qr{$Float_hex|$Float_dec|$Float_int};
304 our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
305 our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
306 our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
307 our $Arithmetic = qr{\+|-|\*|\/|%};
311 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
314 our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
317 our $NonptrTypeMisordered;
318 our $NonptrTypeWithAttr;
322 our $DeclareMisordered;
324 our $NON_ASCII_UTF8 = qr{
325 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
326 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
327 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
328 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
329 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
330 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
331 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
335 [\x09\x0A\x0D\x20-\x7E] # ASCII
339 our $typeTypedefs = qr{(?x:
340 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
344 our $logFunctions = qr{(?x:
345 printk(?:_ratelimited|_once|)|
346 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
347 WARN(?:_RATELIMIT|_ONCE|)|
350 seq_vprintf|seq_printf|seq_puts
353 our $signature_tags = qr{(?xi:
364 our @typeListMisordered = (
365 qr{char\s+(?:un)?signed},
366 qr{int\s+(?:(?:un)?signed\s+)?short\s},
367 qr{int\s+short(?:\s+(?:un)?signed)},
368 qr{short\s+int(?:\s+(?:un)?signed)},
369 qr{(?:un)?signed\s+int\s+short},
370 qr{short\s+(?:un)?signed},
371 qr{long\s+int\s+(?:un)?signed},
372 qr{int\s+long\s+(?:un)?signed},
373 qr{long\s+(?:un)?signed\s+int},
374 qr{int\s+(?:un)?signed\s+long},
375 qr{int\s+(?:un)?signed},
376 qr{int\s+long\s+long\s+(?:un)?signed},
377 qr{long\s+long\s+int\s+(?:un)?signed},
378 qr{long\s+long\s+(?:un)?signed\s+int},
379 qr{long\s+long\s+(?:un)?signed},
380 qr{long\s+(?:un)?signed},
385 qr{(?:(?:un)?signed\s+)?char},
386 qr{(?:(?:un)?signed\s+)?short\s+int},
387 qr{(?:(?:un)?signed\s+)?short},
388 qr{(?:(?:un)?signed\s+)?int},
389 qr{(?:(?:un)?signed\s+)?long\s+int},
390 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
391 qr{(?:(?:un)?signed\s+)?long\s+long},
392 qr{(?:(?:un)?signed\s+)?long},
401 qr{${Ident}_handler},
402 qr{${Ident}_handler_fn},
405 our @typeListWithAttr = (
407 qr{struct\s+$InitAttribute\s+$Ident},
408 qr{union\s+$InitAttribute\s+$Ident},
411 our @modifierList = (
415 our @mode_permission_funcs = (
417 ["module_param_(?:array|named|string)", 4],
418 ["module_param_array_named", 5],
419 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
420 ["proc_create(?:_data|)", 2],
421 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
424 #Create a search pattern for all these functions to speed up a loop below
425 our $mode_perms_search = "";
426 foreach my $entry (@mode_permission_funcs) {
427 $mode_perms_search .= '|' if ($mode_perms_search ne "");
428 $mode_perms_search .= $entry->[0];
431 our $allowed_asm_includes = qr{(?x:
437 # memory.h: ARM has a custom one
439 # Load common spelling mistakes and build regular expression list.
443 open(my $spelling, '<', $spelling_file)
444 or die "$P: Can't open $spelling_file for reading: $!\n";
445 while (<$spelling>) {
448 $line =~ s/\s*\n?$//g;
451 next if ($line =~ m/^\s*#/);
452 next if ($line =~ m/^\s*$/);
454 my ($suspect, $fix) = split(/\|\|/, $line);
456 push(@spelling_list, $suspect);
457 $spelling_fix{$suspect} = $fix;
460 $misspellings = join("|", @spelling_list);
463 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
464 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
465 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
466 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
467 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
469 (?:$Modifier\s+|const\s+)*
471 (?:typeof|__typeof__)\s*\([^\)]*\)|
475 (?:\s+$Modifier|\s+const)*
477 $NonptrTypeMisordered = qr{
478 (?:$Modifier\s+|const\s+)*
482 (?:\s+$Modifier|\s+const)*
484 $NonptrTypeWithAttr = qr{
485 (?:$Modifier\s+|const\s+)*
487 (?:typeof|__typeof__)\s*\([^\)]*\)|
491 (?:\s+$Modifier|\s+const)*
495 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
496 (?:\s+$Inline|\s+$Modifier)*
498 $TypeMisordered = qr{
499 $NonptrTypeMisordered
500 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
501 (?:\s+$Inline|\s+$Modifier)*
503 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
504 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
508 our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
510 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
511 # requires at least perl version v5.10.0
512 # Any use must be runtime checked with $^V
514 our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
515 our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
516 our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
518 our $declaration_macros = qr{(?x:
519 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,2}\s*\(|
520 (?:$Storage\s+)?LIST_HEAD\s*\(|
521 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
526 return "" if (!defined($string));
528 while ($string =~ /^\s*\(.*\)\s*$/) {
529 $string =~ s@^\s*\(\s*@@;
530 $string =~ s@\s*\)\s*$@@;
533 $string =~ s@\s+@ @g;
538 sub seed_camelcase_file {
541 return if (!(-f $file));
545 open(my $include_file, '<', "$file")
546 or warn "$P: Can't read '$file' $!\n";
547 my $text = <$include_file>;
548 close($include_file);
550 my @lines = split('\n', $text);
552 foreach my $line (@lines) {
553 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
554 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
556 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
558 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
564 my $camelcase_seeded = 0;
565 sub seed_camelcase_includes {
566 return if ($camelcase_seeded);
569 my $camelcase_cache = "";
570 my @include_files = ();
572 $camelcase_seeded = 1;
575 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
576 chomp $git_last_include_commit;
577 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
579 my $last_mod_date = 0;
580 $files = `find $root/include -name "*.h"`;
581 @include_files = split('\n', $files);
582 foreach my $file (@include_files) {
583 my $date = POSIX::strftime("%Y%m%d%H%M",
584 localtime((stat $file)[9]));
585 $last_mod_date = $date if ($last_mod_date < $date);
587 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
590 if ($camelcase_cache ne "" && -f $camelcase_cache) {
591 open(my $camelcase_file, '<', "$camelcase_cache")
592 or warn "$P: Can't read '$camelcase_cache' $!\n";
593 while (<$camelcase_file>) {
597 close($camelcase_file);
603 $files = `git ls-files "include/*.h"`;
604 @include_files = split('\n', $files);
607 foreach my $file (@include_files) {
608 seed_camelcase_file($file);
611 if ($camelcase_cache ne "") {
612 unlink glob ".checkpatch-camelcase.*";
613 open(my $camelcase_file, '>', "$camelcase_cache")
614 or warn "$P: Can't write '$camelcase_cache' $!\n";
615 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
616 print $camelcase_file ("$_\n");
618 close($camelcase_file);
622 sub git_commit_info {
623 my ($commit, $id, $desc) = @_;
625 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
627 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
628 $output =~ s/^\s*//gm;
629 my @lines = split("\n", $output);
631 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
632 # Maybe one day convert this block of bash into something that returns
633 # all matching commit ids, but it's very slow...
635 # echo "checking commits $1..."
636 # git rev-list --remotes | grep -i "^$1" |
637 # while read line ; do
638 # git log --format='%H %s' -1 $line |
639 # echo "commit $(cut -c 1-12,41-)"
641 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
643 $id = substr($lines[0], 0, 12);
644 $desc = substr($lines[0], 41);
650 $chk_signoff = 0 if ($file);
655 my @fixed_inserted = ();
656 my @fixed_deleted = ();
660 for my $filename (@ARGV) {
663 open($FILE, '-|', "diff -u /dev/null $filename") ||
664 die "$P: $filename: diff failed - $!\n";
665 } elsif ($filename eq '-') {
666 open($FILE, '<&STDIN');
668 open($FILE, '<', "$filename") ||
669 die "$P: $filename: open failed - $!\n";
671 if ($filename eq '-') {
672 $vname = 'Your patch';
681 if (!process($filename)) {
687 @fixed_inserted = ();
694 sub top_of_kernel_tree {
698 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
699 "README", "Documentation", "arch", "include", "drivers",
700 "fs", "init", "ipc", "kernel", "lib", "scripts",
703 foreach my $check (@tree_check) {
704 if (! -e $root . '/' . $check) {
712 my ($formatted_email) = @_;
718 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
721 $comment = $3 if defined $3;
722 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
724 $comment = $2 if defined $2;
725 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
727 $comment = $2 if defined $2;
728 $formatted_email =~ s/$address.*$//;
729 $name = $formatted_email;
731 $name =~ s/^\"|\"$//g;
732 # If there's a name left after stripping spaces and
733 # leading quotes, and the address doesn't have both
734 # leading and trailing angle brackets, the address
736 # "joe smith joe@smith.com" bad
737 # "joe smith <joe@smith.com" bad
738 if ($name ne "" && $address !~ /^<[^>]+>$/) {
746 $name =~ s/^\"|\"$//g;
747 $address = trim($address);
748 $address =~ s/^\<|\>$//g;
750 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
751 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
755 return ($name, $address, $comment);
759 my ($name, $address) = @_;
764 $name =~ s/^\"|\"$//g;
765 $address = trim($address);
767 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
768 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
773 $formatted_email = "$address";
775 $formatted_email = "$name <$address>";
778 return $formatted_email;
784 foreach my $path (split(/:/, $ENV{PATH})) {
785 if (-e "$path/$bin") {
796 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
797 if (-e "$path/$conf") {
798 return "$path/$conf";
810 for my $c (split(//, $str)) {
814 for (; ($n % 8) != 0; $n++) {
826 (my $res = shift) =~ tr/\t/ /c;
833 # Drop the diff line leader and expand tabs
835 $line = expand_tabs($line);
837 # Pick the indent from the front of the line.
838 my ($white) = ($line =~ /^(\s*)/);
840 return (length($line), length($white));
843 my $sanitise_quote = '';
845 sub sanitise_line_reset {
846 my ($in_comment) = @_;
849 $sanitise_quote = '*/';
851 $sanitise_quote = '';
864 # Always copy over the diff marker.
865 $res = substr($line, 0, 1);
867 for ($off = 1; $off < length($line); $off++) {
868 $c = substr($line, $off, 1);
870 # Comments we are wacking completly including the begin
871 # and end, all to $;.
872 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
873 $sanitise_quote = '*/';
875 substr($res, $off, 2, "$;$;");
879 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
880 $sanitise_quote = '';
881 substr($res, $off, 2, "$;$;");
885 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
886 $sanitise_quote = '//';
888 substr($res, $off, 2, $sanitise_quote);
893 # A \ in a string means ignore the next character.
894 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
896 substr($res, $off, 2, 'XX');
901 if ($c eq "'" || $c eq '"') {
902 if ($sanitise_quote eq '') {
903 $sanitise_quote = $c;
905 substr($res, $off, 1, $c);
907 } elsif ($sanitise_quote eq $c) {
908 $sanitise_quote = '';
912 #print "c<$c> SQ<$sanitise_quote>\n";
913 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
914 substr($res, $off, 1, $;);
915 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
916 substr($res, $off, 1, $;);
917 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
918 substr($res, $off, 1, 'X');
920 substr($res, $off, 1, $c);
924 if ($sanitise_quote eq '//') {
925 $sanitise_quote = '';
928 # The pathname on a #include may be surrounded by '<' and '>'.
929 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
930 my $clean = 'X' x length($1);
931 $res =~ s@\<.*\>@<$clean>@;
933 # The whole of a #error is a string.
934 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
935 my $clean = 'X' x length($1);
936 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
942 sub get_quoted_string {
943 my ($line, $rawline) = @_;
945 return "" if ($line !~ m/(\"[X]+\")/g);
946 return substr($rawline, $-[0], $+[0] - $-[0]);
949 sub ctx_statement_block {
950 my ($linenr, $remain, $off) = @_;
951 my $line = $linenr - 1;
968 @stack = (['', 0]) if ($#stack == -1);
970 #warn "CSB: blk<$blk> remain<$remain>\n";
971 # If we are about to drop off the end, pull in more
974 for (; $remain > 0; $line++) {
975 last if (!defined $lines[$line]);
976 next if ($lines[$line] =~ /^-/);
979 $blk .= $lines[$line] . "\n";
984 # Bail if there is no further context.
985 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
989 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
995 $c = substr($blk, $off, 1);
996 $remainder = substr($blk, $off);
998 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1000 # Handle nested #if/#else.
1001 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1002 push(@stack, [ $type, $level ]);
1003 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1004 ($type, $level) = @{$stack[$#stack - 1]};
1005 } elsif ($remainder =~ /^#\s*endif\b/) {
1006 ($type, $level) = @{pop(@stack)};
1009 # Statement ends at the ';' or a close '}' at the
1011 if ($level == 0 && $c eq ';') {
1015 # An else is really a conditional as long as its not else if
1016 if ($level == 0 && $coff_set == 0 &&
1017 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1018 $remainder =~ /^(else)(?:\s|{)/ &&
1019 $remainder !~ /^else\s+if\b/) {
1020 $coff = $off + length($1) - 1;
1022 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1023 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1026 if (($type eq '' || $type eq '(') && $c eq '(') {
1030 if ($type eq '(' && $c eq ')') {
1032 $type = ($level != 0)? '(' : '';
1034 if ($level == 0 && $coff < $soff) {
1037 #warn "CSB: mark coff<$coff>\n";
1040 if (($type eq '' || $type eq '{') && $c eq '{') {
1044 if ($type eq '{' && $c eq '}') {
1046 $type = ($level != 0)? '{' : '';
1049 if (substr($blk, $off + 1, 1) eq ';') {
1055 # Preprocessor commands end at the newline unless escaped.
1056 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1064 # We are truly at the end, so shuffle to the next line.
1071 my $statement = substr($blk, $soff, $off - $soff + 1);
1072 my $condition = substr($blk, $soff, $coff - $soff + 1);
1074 #warn "STATEMENT<$statement>\n";
1075 #warn "CONDITION<$condition>\n";
1077 #print "coff<$coff> soff<$off> loff<$loff>\n";
1079 return ($statement, $condition,
1080 $line, $remain + 1, $off - $loff + 1, $level);
1083 sub statement_lines {
1086 # Strip the diff line prefixes and rip blank lines at start and end.
1087 $stmt =~ s/(^|\n)./$1/g;
1091 my @stmt_lines = ($stmt =~ /\n/g);
1093 return $#stmt_lines + 2;
1096 sub statement_rawlines {
1099 my @stmt_lines = ($stmt =~ /\n/g);
1101 return $#stmt_lines + 2;
1104 sub statement_block_size {
1107 $stmt =~ s/(^|\n)./$1/g;
1113 my @stmt_lines = ($stmt =~ /\n/g);
1114 my @stmt_statements = ($stmt =~ /;/g);
1116 my $stmt_lines = $#stmt_lines + 2;
1117 my $stmt_statements = $#stmt_statements + 1;
1119 if ($stmt_lines > $stmt_statements) {
1122 return $stmt_statements;
1126 sub ctx_statement_full {
1127 my ($linenr, $remain, $off) = @_;
1128 my ($statement, $condition, $level);
1132 # Grab the first conditional/block pair.
1133 ($statement, $condition, $linenr, $remain, $off, $level) =
1134 ctx_statement_block($linenr, $remain, $off);
1135 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1136 push(@chunks, [ $condition, $statement ]);
1137 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1138 return ($level, $linenr, @chunks);
1141 # Pull in the following conditional/block pairs and see if they
1142 # could continue the statement.
1144 ($statement, $condition, $linenr, $remain, $off, $level) =
1145 ctx_statement_block($linenr, $remain, $off);
1146 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1147 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1149 push(@chunks, [ $condition, $statement ]);
1152 return ($level, $linenr, @chunks);
1156 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1158 my $start = $linenr - 1;
1165 my @stack = ($level);
1166 for ($line = $start; $remain > 0; $line++) {
1167 next if ($rawlines[$line] =~ /^-/);
1170 $blk .= $rawlines[$line];
1172 # Handle nested #if/#else.
1173 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1174 push(@stack, $level);
1175 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1176 $level = $stack[$#stack - 1];
1177 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1178 $level = pop(@stack);
1181 foreach my $c (split(//, $lines[$line])) {
1182 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1188 if ($c eq $close && $level > 0) {
1190 last if ($level == 0);
1191 } elsif ($c eq $open) {
1196 if (!$outer || $level <= 1) {
1197 push(@res, $rawlines[$line]);
1200 last if ($level == 0);
1203 return ($level, @res);
1205 sub ctx_block_outer {
1206 my ($linenr, $remain) = @_;
1208 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1212 my ($linenr, $remain) = @_;
1214 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1218 my ($linenr, $remain, $off) = @_;
1220 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1223 sub ctx_block_level {
1224 my ($linenr, $remain) = @_;
1226 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1228 sub ctx_statement_level {
1229 my ($linenr, $remain, $off) = @_;
1231 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1234 sub ctx_locate_comment {
1235 my ($first_line, $end_line) = @_;
1237 # Catch a comment on the end of the line itself.
1238 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1239 return $current_comment if (defined $current_comment);
1241 # Look through the context and try and figure out if there is a
1244 $current_comment = '';
1245 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1246 my $line = $rawlines[$linenr - 1];
1248 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1251 if ($line =~ m@/\*@) {
1254 if (!$in_comment && $current_comment ne '') {
1255 $current_comment = '';
1257 $current_comment .= $line . "\n" if ($in_comment);
1258 if ($line =~ m@\*/@) {
1263 chomp($current_comment);
1264 return($current_comment);
1266 sub ctx_has_comment {
1267 my ($first_line, $end_line) = @_;
1268 my $cmt = ctx_locate_comment($first_line, $end_line);
1270 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1271 ##print "CMMT: $cmt\n";
1273 return ($cmt ne '');
1277 my ($linenr, $cnt) = @_;
1279 my $offset = $linenr - 1;
1284 $line = $rawlines[$offset++];
1285 next if (defined($line) && $line =~ /^-/);
1297 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1300 $coded = sprintf("^%c", unpack('C', $2) + 64);
1309 my $av_preprocessor = 0;
1314 sub annotate_reset {
1315 $av_preprocessor = 0;
1317 @av_paren_type = ('E');
1318 $av_pend_colon = 'O';
1321 sub annotate_values {
1322 my ($stream, $type) = @_;
1325 my $var = '_' x length($stream);
1328 print "$stream\n" if ($dbg_values > 1);
1330 while (length($cur)) {
1331 @av_paren_type = ('E') if ($#av_paren_type < 0);
1332 print " <" . join('', @av_paren_type) .
1333 "> <$type> <$av_pending>" if ($dbg_values > 1);
1334 if ($cur =~ /^(\s+)/o) {
1335 print "WS($1)\n" if ($dbg_values > 1);
1336 if ($1 =~ /\n/ && $av_preprocessor) {
1337 $type = pop(@av_paren_type);
1338 $av_preprocessor = 0;
1341 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1342 print "CAST($1)\n" if ($dbg_values > 1);
1343 push(@av_paren_type, $type);
1346 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1347 print "DECLARE($1)\n" if ($dbg_values > 1);
1350 } elsif ($cur =~ /^($Modifier)\s*/) {
1351 print "MODIFIER($1)\n" if ($dbg_values > 1);
1354 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1355 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1356 $av_preprocessor = 1;
1357 push(@av_paren_type, $type);
1363 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1364 print "UNDEF($1)\n" if ($dbg_values > 1);
1365 $av_preprocessor = 1;
1366 push(@av_paren_type, $type);
1368 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1369 print "PRE_START($1)\n" if ($dbg_values > 1);
1370 $av_preprocessor = 1;
1372 push(@av_paren_type, $type);
1373 push(@av_paren_type, $type);
1376 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1377 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1378 $av_preprocessor = 1;
1380 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1384 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1385 print "PRE_END($1)\n" if ($dbg_values > 1);
1387 $av_preprocessor = 1;
1389 # Assume all arms of the conditional end as this
1390 # one does, and continue as if the #endif was not here.
1391 pop(@av_paren_type);
1392 push(@av_paren_type, $type);
1395 } elsif ($cur =~ /^(\\\n)/o) {
1396 print "PRECONT($1)\n" if ($dbg_values > 1);
1398 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1399 print "ATTR($1)\n" if ($dbg_values > 1);
1400 $av_pending = $type;
1403 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1404 print "SIZEOF($1)\n" if ($dbg_values > 1);
1410 } elsif ($cur =~ /^(if|while|for)\b/o) {
1411 print "COND($1)\n" if ($dbg_values > 1);
1415 } elsif ($cur =~/^(case)/o) {
1416 print "CASE($1)\n" if ($dbg_values > 1);
1417 $av_pend_colon = 'C';
1420 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1421 print "KEYWORD($1)\n" if ($dbg_values > 1);
1424 } elsif ($cur =~ /^(\()/o) {
1425 print "PAREN('$1')\n" if ($dbg_values > 1);
1426 push(@av_paren_type, $av_pending);
1430 } elsif ($cur =~ /^(\))/o) {
1431 my $new_type = pop(@av_paren_type);
1432 if ($new_type ne '_') {
1434 print "PAREN('$1') -> $type\n"
1435 if ($dbg_values > 1);
1437 print "PAREN('$1')\n" if ($dbg_values > 1);
1440 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1441 print "FUNC($1)\n" if ($dbg_values > 1);
1445 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1446 if (defined $2 && $type eq 'C' || $type eq 'T') {
1447 $av_pend_colon = 'B';
1448 } elsif ($type eq 'E') {
1449 $av_pend_colon = 'L';
1451 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1454 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1455 print "IDENT($1)\n" if ($dbg_values > 1);
1458 } elsif ($cur =~ /^($Assignment)/o) {
1459 print "ASSIGN($1)\n" if ($dbg_values > 1);
1462 } elsif ($cur =~/^(;|{|})/) {
1463 print "END($1)\n" if ($dbg_values > 1);
1465 $av_pend_colon = 'O';
1467 } elsif ($cur =~/^(,)/) {
1468 print "COMMA($1)\n" if ($dbg_values > 1);
1471 } elsif ($cur =~ /^(\?)/o) {
1472 print "QUESTION($1)\n" if ($dbg_values > 1);
1475 } elsif ($cur =~ /^(:)/o) {
1476 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1478 substr($var, length($res), 1, $av_pend_colon);
1479 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1484 $av_pend_colon = 'O';
1486 } elsif ($cur =~ /^(\[)/o) {
1487 print "CLOSE($1)\n" if ($dbg_values > 1);
1490 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1493 print "OPV($1)\n" if ($dbg_values > 1);
1500 substr($var, length($res), 1, $variant);
1503 } elsif ($cur =~ /^($Operators)/o) {
1504 print "OP($1)\n" if ($dbg_values > 1);
1505 if ($1 ne '++' && $1 ne '--') {
1509 } elsif ($cur =~ /(^.)/o) {
1510 print "C($1)\n" if ($dbg_values > 1);
1513 $cur = substr($cur, length($1));
1514 $res .= $type x length($1);
1518 return ($res, $var);
1522 my ($possible, $line) = @_;
1523 my $notPermitted = qr{(?:
1540 ^(?:typedef|struct|enum)\b
1542 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1543 if ($possible !~ $notPermitted) {
1544 # Check for modifiers.
1545 $possible =~ s/\s*$Storage\s*//g;
1546 $possible =~ s/\s*$Sparse\s*//g;
1547 if ($possible =~ /^\s*$/) {
1549 } elsif ($possible =~ /\s/) {
1550 $possible =~ s/\s*$Type\s*//g;
1551 for my $modifier (split(' ', $possible)) {
1552 if ($modifier !~ $notPermitted) {
1553 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1554 push(@modifierList, $modifier);
1559 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1560 push(@typeList, $possible);
1564 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1573 return defined $use_type{$type} if (scalar keys %use_type > 0);
1575 return !defined $ignore_type{$type};
1579 my ($level, $type, $msg) = @_;
1581 if (!show_type($type) ||
1582 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
1587 $line = "$prefix$level:$type: $msg\n";
1589 $line = "$prefix$level: $msg\n";
1591 $line = (split('\n', $line))[0] . "\n" if ($terse);
1593 push(our @report, $line);
1602 sub fixup_current_range {
1603 my ($lineRef, $offset, $length) = @_;
1605 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1608 my $no = $o + $offset;
1609 my $nl = $l + $length;
1610 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1614 sub fix_inserted_deleted_lines {
1615 my ($linesRef, $insertedRef, $deletedRef) = @_;
1617 my $range_last_linenr = 0;
1618 my $delta_offset = 0;
1623 my $next_insert = 0;
1624 my $next_delete = 0;
1628 my $inserted = @{$insertedRef}[$next_insert++];
1629 my $deleted = @{$deletedRef}[$next_delete++];
1631 foreach my $old_line (@{$linesRef}) {
1633 my $line = $old_line; #don't modify the array
1634 if ($line =~ /^(?:\+\+\+\|\-\-\-)\s+\S+/) { #new filename
1636 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1637 $range_last_linenr = $new_linenr;
1638 fixup_current_range(\$line, $delta_offset, 0);
1641 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1642 $deleted = @{$deletedRef}[$next_delete++];
1644 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1647 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1648 push(@lines, ${$inserted}{'LINE'});
1649 $inserted = @{$insertedRef}[$next_insert++];
1651 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1655 push(@lines, $line);
1665 sub fix_insert_line {
1666 my ($linenr, $line) = @_;
1672 push(@fixed_inserted, $inserted);
1675 sub fix_delete_line {
1676 my ($linenr, $line) = @_;
1683 push(@fixed_deleted, $deleted);
1687 my ($type, $msg) = @_;
1689 if (report("ERROR", $type, $msg)) {
1697 my ($type, $msg) = @_;
1699 if (report("WARNING", $type, $msg)) {
1707 my ($type, $msg) = @_;
1709 if ($check && report("CHECK", $type, $msg)) {
1717 sub check_absolute_file {
1718 my ($absolute, $herecurr) = @_;
1719 my $file = $absolute;
1721 ##print "absolute<$absolute>\n";
1723 # See if any suffix of this path is a path within the tree.
1724 while ($file =~ s@^[^/]*/@@) {
1725 if (-f "$root/$file") {
1726 ##print "file<$file>\n";
1734 # It is, so see if the prefix is acceptable.
1735 my $prefix = $absolute;
1736 substr($prefix, -length($file)) = '';
1738 ##print "prefix<$prefix>\n";
1739 if ($prefix ne ".../") {
1740 WARN("USE_RELATIVE_PATH",
1741 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1748 $string =~ s/^\s+|\s+$//g;
1756 $string =~ s/^\s+//;
1764 $string =~ s/\s+$//;
1769 sub string_find_replace {
1770 my ($string, $find, $replace) = @_;
1772 $string =~ s/$find/$replace/g;
1780 my $source_indent = 8;
1781 my $max_spaces_before_tab = $source_indent - 1;
1782 my $spaces_to_tab = " " x $source_indent;
1784 #convert leading spaces to tabs
1785 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1786 #Remove spaces before a tab
1787 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1792 sub pos_last_openparen {
1797 my $opens = $line =~ tr/\(/\(/;
1798 my $closes = $line =~ tr/\)/\)/;
1800 my $last_openparen = 0;
1802 if (($opens == 0) || ($closes >= $opens)) {
1806 my $len = length($line);
1808 for ($pos = 0; $pos < $len; $pos++) {
1809 my $string = substr($line, $pos);
1810 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1811 $pos += length($1) - 1;
1812 } elsif (substr($line, $pos, 1) eq '(') {
1813 $last_openparen = $pos;
1814 } elsif (index($string, '(') == -1) {
1819 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
1823 my $filename = shift;
1829 my $stashrawline="";
1840 my $in_header_lines = $file ? 0 : 1;
1841 my $in_commit_log = 0; #Scanning lines before patch
1842 my $reported_maintainer_file = 0;
1843 my $non_utf8_charset = 0;
1845 my $last_blank_line = 0;
1853 # Trace the real file/line as we go.
1859 my $comment_edge = 0;
1863 my $prev_values = 'E';
1866 my %suppress_ifbraces;
1867 my %suppress_whiletrailers;
1868 my %suppress_export;
1869 my $suppress_statement = 0;
1871 my %signatures = ();
1873 # Pre-scan the patch sanitizing the lines.
1874 # Pre-scan the patch looking for any __setup documentation.
1876 my @setup_docs = ();
1879 my $camelcase_file_seeded = 0;
1881 sanitise_line_reset();
1883 foreach my $rawline (@rawlines) {
1887 push(@fixed, $rawline) if ($fix);
1889 if ($rawline=~/^\+\+\+\s+(\S+)/) {
1891 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1896 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1905 # Guestimate if this is a continuing comment. Run
1906 # the context looking for a comment "edge". If this
1907 # edge is a close comment then we must be in a comment
1911 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1912 next if (defined $rawlines[$ln - 1] &&
1913 $rawlines[$ln - 1] =~ /^-/);
1915 #print "RAW<$rawlines[$ln - 1]>\n";
1916 last if (!defined $rawlines[$ln - 1]);
1917 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1918 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1923 if (defined $edge && $edge eq '*/') {
1927 # Guestimate if this is a continuing comment. If this
1928 # is the start of a diff block and this line starts
1929 # ' *' then it is very likely a comment.
1930 if (!defined $edge &&
1931 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1936 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1937 sanitise_line_reset($in_comment);
1939 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1940 # Standardise the strings and chars within the input to
1941 # simplify matching -- only bother with positive lines.
1942 $line = sanitise_line($rawline);
1944 push(@lines, $line);
1947 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1952 #print "==>$rawline\n";
1953 #print "-->$line\n";
1955 if ($setup_docs && $line =~ /^\+/) {
1956 push(@setup_docs, $line);
1965 foreach my $line (@lines) {
1968 my $sline = $line; #copy of $line
1969 $sline =~ s/$;/ /g; #with comments as spaces
1971 my $rawline = $rawlines[$linenr - 1];
1973 #extract the line range in the file after the patch is applied
1974 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1976 $first_line = $linenr + 1;
1986 %suppress_ifbraces = ();
1987 %suppress_whiletrailers = ();
1988 %suppress_export = ();
1989 $suppress_statement = 0;
1992 # track the line number as we move through the hunk, note that
1993 # new versions of GNU diff omit the leading space on completely
1994 # blank context lines so we need to count that too.
1995 } elsif ($line =~ /^( |\+|$)/) {
1997 $realcnt-- if ($realcnt != 0);
1999 # Measure the line length and indent.
2000 ($length, $indent) = line_stats($rawline);
2002 # Track the previous line.
2003 ($prevline, $stashline) = ($stashline, $line);
2004 ($previndent, $stashindent) = ($stashindent, $indent);
2005 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2007 #warn "line<$line>\n";
2009 } elsif ($realcnt == 1) {
2013 my $hunk_line = ($realcnt != 0);
2015 #make up the handle for any error we report on this line
2016 $prefix = "$filename:$realline: " if ($emacs && $file);
2017 $prefix = "$filename:$linenr: " if ($emacs && !$file);
2019 $here = "#$linenr: " if (!$file);
2020 $here = "#$realline: " if ($file);
2023 # extract the filename as it passes
2024 if ($line =~ /^diff --git.*?(\S+)$/) {
2026 $realfile =~ s@^([^/]*)/@@ if (!$file);
2029 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2031 $realfile =~ s@^([^/]*)/@@ if (!$file);
2035 if (!$file && $tree && $p1_prefix ne '' &&
2036 -e "$root/$p1_prefix") {
2037 WARN("PATCH_PREFIX",
2038 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
2041 if ($realfile =~ m@^include/asm/@) {
2042 ERROR("MODIFIED_INCLUDE_ASM",
2043 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2049 if ($realfile =~ m@^(drivers/net/|net/)@) {
2052 $check = $check_orig;
2057 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
2059 my $hereline = "$here\n$rawline\n";
2060 my $herecurr = "$here\n$rawline\n";
2061 my $hereprev = "$here\n$prevrawline\n$rawline\n";
2063 $cnt_lines++ if ($realcnt != 0);
2065 # Check for incorrect file permissions
2066 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2067 my $permhere = $here . "FILE: $realfile\n";
2068 if ($realfile !~ m@scripts/@ &&
2069 $realfile !~ /\.(py|pl|awk|sh)$/) {
2070 ERROR("EXECUTE_PERMISSIONS",
2071 "do not set execute permissions for source files\n" . $permhere);
2075 # Check the patch for a signoff:
2076 if ($line =~ /^\s*signed-off-by:/i) {
2081 # Check signature styles
2082 if (!$in_header_lines &&
2083 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
2084 my $space_before = $1;
2086 my $space_after = $3;
2088 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2090 if ($sign_off !~ /$signature_tags/) {
2091 WARN("BAD_SIGN_OFF",
2092 "Non-standard signature: $sign_off\n" . $herecurr);
2094 if (defined $space_before && $space_before ne "") {
2095 if (WARN("BAD_SIGN_OFF",
2096 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2098 $fixed[$fixlinenr] =
2099 "$ucfirst_sign_off $email";
2102 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
2103 if (WARN("BAD_SIGN_OFF",
2104 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2106 $fixed[$fixlinenr] =
2107 "$ucfirst_sign_off $email";
2111 if (!defined $space_after || $space_after ne " ") {
2112 if (WARN("BAD_SIGN_OFF",
2113 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2115 $fixed[$fixlinenr] =
2116 "$ucfirst_sign_off $email";
2120 my ($email_name, $email_address, $comment) = parse_email($email);
2121 my $suggested_email = format_email(($email_name, $email_address));
2122 if ($suggested_email eq "") {
2123 ERROR("BAD_SIGN_OFF",
2124 "Unrecognized email address: '$email'\n" . $herecurr);
2126 my $dequoted = $suggested_email;
2127 $dequoted =~ s/^"//;
2128 $dequoted =~ s/" </ </;
2129 # Don't force email to have quotes
2130 # Allow just an angle bracketed address
2131 if ("$dequoted$comment" ne $email &&
2132 "<$email_address>$comment" ne $email &&
2133 "$suggested_email$comment" ne $email) {
2134 WARN("BAD_SIGN_OFF",
2135 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
2139 # Check for duplicate signatures
2140 my $sig_nospace = $line;
2141 $sig_nospace =~ s/\s//g;
2142 $sig_nospace = lc($sig_nospace);
2143 if (defined $signatures{$sig_nospace}) {
2144 WARN("BAD_SIGN_OFF",
2145 "Duplicate signature\n" . $herecurr);
2147 $signatures{$sig_nospace} = 1;
2151 # Check for old stable address
2152 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2153 ERROR("STABLE_ADDRESS",
2154 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2157 # Check for unwanted Gerrit info
2158 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2159 ERROR("GERRIT_CHANGE_ID",
2160 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2163 # Check for improperly formed commit descriptions
2164 if ($in_commit_log &&
2165 $line =~ /\bcommit\s+[0-9a-f]{5,}/i &&
2166 !($line =~ /\b[Cc]ommit [0-9a-f]{12,40} \("/ ||
2167 ($line =~ /\b[Cc]ommit [0-9a-f]{12,40}\s*$/ &&
2168 defined $rawlines[$linenr] &&
2169 $rawlines[$linenr] =~ /^\s*\("/))) {
2170 $line =~ /\b(c)ommit\s+([0-9a-f]{5,})/i;
2172 my $orig_commit = lc($2);
2173 my $id = '01234567890ab';
2174 my $desc = 'commit description';
2175 ($id, $desc) = git_commit_info($orig_commit, $id, $desc);
2176 ERROR("GIT_COMMIT_ID",
2177 "Please use 12 or more chars for the git commit ID like: '${init_char}ommit $id (\"$desc\")'\n" . $herecurr);
2180 # Check for added, moved or deleted files
2181 if (!$reported_maintainer_file && !$in_commit_log &&
2182 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2183 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2184 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2185 (defined($1) || defined($2))))) {
2186 $reported_maintainer_file = 1;
2187 WARN("FILE_PATH_CHANGES",
2188 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2191 # Check for wrappage within a valid hunk of the file
2192 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
2193 ERROR("CORRUPTED_PATCH",
2194 "patch seems to be corrupt (line wrapped?)\n" .
2195 $herecurr) if (!$emitted_corrupt++);
2198 # Check for absolute kernel paths.
2200 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2203 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2204 check_absolute_file($1, $herecurr)) {
2207 check_absolute_file($file, $herecurr);
2212 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2213 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
2214 $rawline !~ m/^$UTF8*$/) {
2215 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2217 my $blank = copy_spacing($rawline);
2218 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2219 my $hereptr = "$hereline$ptr\n";
2222 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
2225 # Check if it's the start of a commit log
2226 # (not a header line and we haven't seen the patch filename)
2227 if ($in_header_lines && $realfile =~ /^$/ &&
2228 !($rawline =~ /^\s+\S/ ||
2229 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
2230 $in_header_lines = 0;
2234 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2235 # declined it, i.e defined some charset where it is missing.
2236 if ($in_header_lines &&
2237 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2239 $non_utf8_charset = 1;
2242 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
2243 $rawline =~ /$NON_ASCII_UTF8/) {
2244 WARN("UTF8_BEFORE_PATCH",
2245 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2248 # Check for various typo / spelling mistakes
2249 if ($in_commit_log || $line =~ /^\+/) {
2250 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:$|[^a-z@])/gi) {
2252 my $typo_fix = $spelling_fix{lc($typo)};
2253 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2254 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2255 my $msg_type = \&WARN;
2256 $msg_type = \&CHK if ($file);
2257 if (&{$msg_type}("TYPO_SPELLING",
2258 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2260 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2265 # ignore non-hunk lines and lines being removed
2266 next if (!$hunk_line || $line =~ /^-/);
2268 #trailing whitespace
2269 if ($line =~ /^\+.*\015/) {
2270 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2271 if (ERROR("DOS_LINE_ENDINGS",
2272 "DOS line endings\n" . $herevet) &&
2274 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
2276 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2277 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2278 if (ERROR("TRAILING_WHITESPACE",
2279 "trailing whitespace\n" . $herevet) &&
2281 $fixed[$fixlinenr] =~ s/\s+$//;
2287 # Check for FSF mailing addresses.
2288 if ($rawline =~ /\bwrite to the Free/i ||
2289 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2290 $rawline =~ /\b51\s+Franklin\s+St/i) {
2291 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2292 my $msg_type = \&ERROR;
2293 $msg_type = \&CHK if ($file);
2294 &{$msg_type}("FSF_MAILING_ADDRESS",
2295 "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)
2298 # check for Kconfig help text having a real description
2299 # Only applies when adding the entry originally, after that we do not have
2300 # sufficient context to determine whether it is indeed long enough.
2301 if ($realfile =~ /Kconfig/ &&
2302 $line =~ /^\+\s*config\s+/) {
2305 my $ln = $linenr + 1;
2309 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
2310 $f = $lines[$ln - 1];
2311 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2312 $is_end = $lines[$ln - 1] =~ /^\+/;
2314 next if ($f =~ /^-/);
2315 last if (!$file && $f =~ /^\@\@/);
2317 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
2319 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
2326 next if ($f =~ /^$/);
2327 if ($f =~ /^\s*config\s/) {
2333 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2334 WARN("CONFIG_DESCRIPTION",
2335 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2337 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2340 # discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2341 if ($realfile =~ /Kconfig/ &&
2342 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2343 WARN("CONFIG_EXPERIMENTAL",
2344 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2347 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2348 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2351 'EXTRA_AFLAGS' => 'asflags-y',
2352 'EXTRA_CFLAGS' => 'ccflags-y',
2353 'EXTRA_CPPFLAGS' => 'cppflags-y',
2354 'EXTRA_LDFLAGS' => 'ldflags-y',
2357 WARN("DEPRECATED_VARIABLE",
2358 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2361 # check for DT compatible documentation
2362 if (defined $root &&
2363 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2364 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2366 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2368 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2369 my $vp_file = $dt_path . "vendor-prefixes.txt";
2371 foreach my $compat (@compats) {
2372 my $compat2 = $compat;
2373 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2374 my $compat3 = $compat;
2375 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2376 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
2378 WARN("UNDOCUMENTED_DT_STRING",
2379 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2382 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2384 `grep -Eq "^$vendor\\b" $vp_file`;
2386 WARN("UNDOCUMENTED_DT_STRING",
2387 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2392 # check we are in a valid source file if not then ignore this hunk
2393 next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/);
2396 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
2397 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
2398 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
2399 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
2400 $length > $max_line_length)
2403 "line over $max_line_length characters\n" . $herecurr);
2406 # Check for user-visible strings broken across lines, which breaks the ability
2407 # to grep for the string. Make exceptions when the previous string ends in a
2408 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
2409 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
2410 if ($line =~ /^\+\s*"/ &&
2411 $prevline =~ /"\s*$/ &&
2412 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
2413 WARN("SPLIT_STRING",
2414 "quoted string split across lines\n" . $hereprev);
2417 # check for missing a space in a string concatination
2418 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
2419 WARN('MISSING_SPACE',
2420 "break quoted strings at a space character\n" . $hereprev);
2423 # check for spaces before a quoted newline
2424 if ($rawline =~ /^.*\".*\s\\n/) {
2425 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
2426 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
2428 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
2433 # check for adding lines without a newline.
2434 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2435 WARN("MISSING_EOF_NEWLINE",
2436 "adding a line without newline at end of file\n" . $herecurr);
2439 # Blackfin: use hi/lo macros
2440 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2441 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2442 my $herevet = "$here\n" . cat_vet($line) . "\n";
2444 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
2446 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2447 my $herevet = "$here\n" . cat_vet($line) . "\n";
2449 "use the HI() macro, not (... >> 16)\n" . $herevet);
2453 # check we are in a valid source file C or perl if not then ignore this hunk
2454 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
2456 # at the beginning of a line any tabs must come first and anything
2457 # more than 8 must use tabs.
2458 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2459 $rawline =~ /^\+\s* \s*/) {
2460 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2462 if (ERROR("CODE_INDENT",
2463 "code indent should use tabs where possible\n" . $herevet) &&
2465 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2469 # check for space before tabs.
2470 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2471 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2472 if (WARN("SPACE_BEFORE_TAB",
2473 "please, no space before tabs\n" . $herevet) &&
2475 while ($fixed[$fixlinenr] =~
2476 s/(^\+.*) {8,8}\t/$1\t\t/) {}
2477 while ($fixed[$fixlinenr] =~
2478 s/(^\+.*) +\t/$1\t/) {}
2482 # check for && or || at the start of a line
2483 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2484 CHK("LOGICAL_CONTINUATIONS",
2485 "Logical continuations should be on the previous line\n" . $hereprev);
2488 # check multi-line statement indentation matches previous line
2489 if ($^V && $^V ge 5.10.0 &&
2490 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2491 $prevline =~ /^\+(\t*)(.*)$/;
2495 my $pos = pos_last_openparen($rest);
2497 $line =~ /^(\+| )([ \t]*)/;
2500 my $goodtabindent = $oldindent .
2503 my $goodspaceindent = $oldindent . " " x $pos;
2505 if ($newindent ne $goodtabindent &&
2506 $newindent ne $goodspaceindent) {
2508 if (CHK("PARENTHESIS_ALIGNMENT",
2509 "Alignment should match open parenthesis\n" . $hereprev) &&
2510 $fix && $line =~ /^\+/) {
2511 $fixed[$fixlinenr] =~
2512 s/^\+[ \t]*/\+$goodtabindent/;
2518 if ($line =~ /^\+.*\(\s*$Type\s*\)[ \t]+(?!$Assignment|$Arithmetic|{)/) {
2520 "No space is necessary after a cast\n" . $herecurr) &&
2522 $fixed[$fixlinenr] =~
2523 s/(\(\s*$Type\s*\))[ \t]+/$1/;
2527 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2528 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
2529 $rawline =~ /^\+[ \t]*\*/ &&
2531 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2532 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2535 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2536 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2537 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
2538 $rawline =~ /^\+/ && #line is new
2539 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2540 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2541 "networking block comments start with * on subsequent lines\n" . $hereprev);
2544 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2545 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2546 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2547 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2548 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
2549 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2550 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2553 # check for missing blank lines after struct/union declarations
2554 # with exceptions for various attributes and macros
2555 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2557 !($line =~ /^\+\s*$/ ||
2558 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2559 $line =~ /^\+\s*MODULE_/i ||
2560 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2561 $line =~ /^\+[a-z_]*init/ ||
2562 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2563 $line =~ /^\+\s*DECLARE/ ||
2564 $line =~ /^\+\s*__setup/)) {
2565 if (CHK("LINE_SPACING",
2566 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
2568 fix_insert_line($fixlinenr, "\+");
2572 # check for multiple consecutive blank lines
2573 if ($prevline =~ /^[\+ ]\s*$/ &&
2574 $line =~ /^\+\s*$/ &&
2575 $last_blank_line != ($linenr - 1)) {
2576 if (CHK("LINE_SPACING",
2577 "Please don't use multiple blank lines\n" . $hereprev) &&
2579 fix_delete_line($fixlinenr, $rawline);
2582 $last_blank_line = $linenr;
2585 # check for missing blank lines after declarations
2586 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2587 # actual declarations
2588 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2589 # function pointer declarations
2590 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2591 # foo bar; where foo is some local typedef or #define
2592 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2593 # known declaration macros
2594 $prevline =~ /^\+\s+$declaration_macros/) &&
2595 # for "else if" which can look like "$Ident $Ident"
2596 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2597 # other possible extensions of declaration lines
2598 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2599 # not starting a section or a macro "\" extended line
2600 $prevline =~ /(?:\{\s*|\\)$/) &&
2601 # looks like a declaration
2602 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2603 # function pointer declarations
2604 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2605 # foo bar; where foo is some local typedef or #define
2606 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2607 # known declaration macros
2608 $sline =~ /^\+\s+$declaration_macros/ ||
2609 # start of struct or union or enum
2610 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
2611 # start or end of block or continuation of declaration
2612 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
2613 # bitfield continuation
2614 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
2615 # other possible extensions of declaration lines
2616 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
2617 # indentation of previous and current line are the same
2618 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
2619 if (WARN("LINE_SPACING",
2620 "Missing a blank line after declarations\n" . $hereprev) &&
2622 fix_insert_line($fixlinenr, "\+");
2626 # check for spaces at the beginning of a line.
2628 # 1) within comments
2629 # 2) indented preprocessor commands
2631 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
2632 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2633 if (WARN("LEADING_SPACE",
2634 "please, no spaces at the start of a line\n" . $herevet) &&
2636 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2640 # check we are in a valid C source file if not then ignore this hunk
2641 next if ($realfile !~ /\.(h|c)$/);
2643 # check indentation of any line with a bare else
2644 # if the previous line is a break or return and is indented 1 tab more...
2645 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
2646 my $tabs = length($1) + 1;
2647 if ($prevline =~ /^\+\t{$tabs,$tabs}(?:break|return)\b/) {
2648 WARN("UNNECESSARY_ELSE",
2649 "else is not generally useful after a break or return\n" . $hereprev);
2653 # check indentation of a line with a break;
2654 # if the previous line is a goto or return and is indented the same # of tabs
2655 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
2657 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
2658 WARN("UNNECESSARY_BREAK",
2659 "break is not useful after a goto or return\n" . $hereprev);
2663 # discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2664 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2665 WARN("CONFIG_EXPERIMENTAL",
2666 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2669 # check for RCS/CVS revision markers
2670 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
2672 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
2675 # Blackfin: don't use __builtin_bfin_[cs]sync
2676 if ($line =~ /__builtin_bfin_csync/) {
2677 my $herevet = "$here\n" . cat_vet($line) . "\n";
2679 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
2681 if ($line =~ /__builtin_bfin_ssync/) {
2682 my $herevet = "$here\n" . cat_vet($line) . "\n";
2684 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
2687 # check for old HOTPLUG __dev<foo> section markings
2688 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2689 WARN("HOTPLUG_SECTION",
2690 "Using $1 is unnecessary\n" . $herecurr);
2693 # Check for potential 'bare' types
2694 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2696 #print "LINE<$line>\n";
2697 if ($linenr >= $suppress_statement &&
2698 $realcnt && $sline =~ /.\s*\S/) {
2699 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2700 ctx_statement_block($linenr, $realcnt, 0);
2701 $stat =~ s/\n./\n /g;
2702 $cond =~ s/\n./\n /g;
2704 #print "linenr<$linenr> <$stat>\n";
2705 # If this statement has no statement boundaries within
2706 # it there is no point in retrying a statement scan
2707 # until we hit end of it.
2708 my $frag = $stat; $frag =~ s/;+\s*$//;
2709 if ($frag !~ /(?:{|;)/) {
2710 #print "skip<$line_nr_next>\n";
2711 $suppress_statement = $line_nr_next;
2714 # Find the real next line.
2715 $realline_next = $line_nr_next;
2716 if (defined $realline_next &&
2717 (!defined $lines[$realline_next - 1] ||
2718 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2725 # Ignore goto labels.
2726 if ($s =~ /$Ident:\*$/s) {
2728 # Ignore functions being called
2729 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
2731 } elsif ($s =~ /^.\s*else\b/s) {
2733 # declarations always start with types
2734 } 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) {
2737 possible($type, "A:" . $s);
2739 # definitions in global scope can only start with types
2740 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
2741 possible($1, "B:" . $s);
2744 # any (foo ... *) is a pointer cast, and foo is a type
2745 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
2746 possible($1, "C:" . $s);
2749 # Check for any sort of function declaration.
2750 # int foo(something bar, other baz);
2751 # void (*store_gdt)(x86_descr_ptr *);
2752 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
2753 my ($name_len) = length($1);
2756 substr($ctx, 0, $name_len + 1, '');
2757 $ctx =~ s/\)[^\)]*$//;
2759 for my $arg (split(/\s*,\s*/, $ctx)) {
2760 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
2762 possible($1, "D:" . $s);
2770 # Checks which may be anchored in the context.
2773 # Check for switch () and associated case and default
2774 # statements should be at the same indent.
2775 if ($line=~/\bswitch\s*\(.*\)/) {
2778 my @ctx = ctx_block_outer($linenr, $realcnt);
2780 for my $ctx (@ctx) {
2781 my ($clen, $cindent) = line_stats($ctx);
2782 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2783 $indent != $cindent) {
2784 $err .= "$sep$ctx\n";
2791 ERROR("SWITCH_CASE_INDENT_LEVEL",
2792 "switch and case should be at the same indent\n$hereline$err");
2796 # if/while/etc brace do not go on next line, unless defining a do while loop,
2797 # or if that brace on the next line is for something else
2798 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
2799 my $pre_ctx = "$1$2";
2801 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
2803 if ($line =~ /^\+\t{6,}/) {
2804 WARN("DEEP_INDENTATION",
2805 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2808 my $ctx_cnt = $realcnt - $#ctx - 1;
2809 my $ctx = join("\n", @ctx);
2811 my $ctx_ln = $linenr;
2812 my $ctx_skip = $realcnt;
2814 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2815 defined $lines[$ctx_ln - 1] &&
2816 $lines[$ctx_ln - 1] =~ /^-/)) {
2817 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2818 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
2822 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2823 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
2825 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
2827 "that open brace { should be on the previous line\n" .
2828 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2830 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2831 $ctx =~ /\)\s*\;\s*$/ &&
2832 defined $lines[$ctx_ln - 1])
2834 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2835 if ($nindent > $indent) {
2836 WARN("TRAILING_SEMICOLON",
2837 "trailing semicolon indicates no statements, indent implies otherwise\n" .
2838 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2843 # Check relative indent for conditionals and blocks.
2844 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2845 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2846 ctx_statement_block($linenr, $realcnt, 0)
2847 if (!defined $stat);
2848 my ($s, $c) = ($stat, $cond);
2850 substr($s, 0, length($c), '');
2852 # Make sure we remove the line prefixes as we have
2853 # none on the first line, and are going to readd them
2857 # Find out how long the conditional actually is.
2858 my @newlines = ($c =~ /\n/gs);
2859 my $cond_lines = 1 + $#newlines;
2861 # We want to check the first line inside the block
2862 # starting at the end of the conditional, so remove:
2863 # 1) any blank line termination
2864 # 2) any opening brace { on end of the line
2866 my $continuation = 0;
2868 $s =~ s/^.*\bdo\b//;
2870 if ($s =~ s/^\s*\\//) {
2873 if ($s =~ s/^\s*?\n//) {
2878 # Also ignore a loop construct at the end of a
2879 # preprocessor statement.
2880 if (($prevline =~ /^.\s*#\s*define\s/ ||
2881 $prevline =~ /\\\s*$/) && $continuation == 0) {
2887 while ($cond_ptr != $cond_lines) {
2888 $cond_ptr = $cond_lines;
2890 # If we see an #else/#elif then the code
2892 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2897 # 1) blank lines, they should be at 0,
2898 # 2) preprocessor lines, and
2900 if ($continuation ||
2902 $s =~ /^\s*#\s*?/ ||
2903 $s =~ /^\s*$Ident\s*:/) {
2904 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
2905 if ($s =~ s/^.*?\n//) {
2911 my (undef, $sindent) = line_stats("+" . $s);
2912 my $stat_real = raw_line($linenr, $cond_lines);
2914 # Check if either of these lines are modified, else
2915 # this is not this patch's fault.
2916 if (!defined($stat_real) ||
2917 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2920 if (defined($stat_real) && $cond_lines > 1) {
2921 $stat_real = "[...]\n$stat_real";
2924 #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";
2926 if ($check && (($sindent % 8) != 0 ||
2927 ($sindent <= $indent && $s ne ''))) {
2928 WARN("SUSPECT_CODE_INDENT",
2929 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
2933 # Track the 'values' across context and added lines.
2934 my $opline = $line; $opline =~ s/^./ /;
2935 my ($curr_values, $curr_vars) =
2936 annotate_values($opline . "\n", $prev_values);
2937 $curr_values = $prev_values . $curr_values;
2939 my $outline = $opline; $outline =~ s/\t/ /g;
2940 print "$linenr > .$outline\n";
2941 print "$linenr > $curr_values\n";
2942 print "$linenr > $curr_vars\n";
2944 $prev_values = substr($curr_values, -1);
2946 #ignore lines not being added
2947 next if ($line =~ /^[^\+]/);
2949 # TEST: allow direct testing of the type matcher.
2951 if ($line =~ /^.\s*$Declare\s*$/) {
2953 "TEST: is type\n" . $herecurr);
2954 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
2955 ERROR("TEST_NOT_TYPE",
2956 "TEST: is not type ($1 is)\n". $herecurr);
2960 # TEST: allow direct testing of the attribute matcher.
2962 if ($line =~ /^.\s*$Modifier\s*$/) {
2964 "TEST: is attr\n" . $herecurr);
2965 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
2966 ERROR("TEST_NOT_ATTR",
2967 "TEST: is not attr ($1 is)\n". $herecurr);
2972 # check for initialisation to aggregates open brace on the next line
2973 if ($line =~ /^.\s*{/ &&
2974 $prevline =~ /(?:^|[^=])=\s*$/) {
2975 if (ERROR("OPEN_BRACE",
2976 "that open brace { should be on the previous line\n" . $hereprev) &&
2977 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
2978 fix_delete_line($fixlinenr - 1, $prevrawline);
2979 fix_delete_line($fixlinenr, $rawline);
2980 my $fixedline = $prevrawline;
2981 $fixedline =~ s/\s*=\s*$/ = {/;
2982 fix_insert_line($fixlinenr, $fixedline);
2984 $fixedline =~ s/^(.\s*){\s*/$1/;
2985 fix_insert_line($fixlinenr, $fixedline);
2990 # Checks which are anchored on the added line.
2993 # check for malformed paths in #include statements (uses RAW line)
2994 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
2996 if ($path =~ m{//}) {
2997 ERROR("MALFORMED_INCLUDE",
2998 "malformed #include filename\n" . $herecurr);
3000 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3001 ERROR("UAPI_INCLUDE",
3002 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
3006 # no C99 // comments
3007 if ($line =~ m{//}) {
3008 if (ERROR("C99_COMMENTS",
3009 "do not use C99 // comments\n" . $herecurr) &&
3011 my $line = $fixed[$fixlinenr];
3012 if ($line =~ /\/\/(.*)$/) {
3013 my $comment = trim($1);
3014 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
3018 # Remove C99 comments.
3020 $opline =~ s@//.*@@;
3022 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3023 # the whole statement.
3024 #print "APW <$lines[$realline_next - 1]>\n";
3025 if (defined $realline_next &&
3026 exists $lines[$realline_next - 1] &&
3027 !defined $suppress_export{$realline_next} &&
3028 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3029 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3030 # Handle definitions which produce identifiers with
3033 # EXPORT_SYMBOL(something_foo);
3035 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
3036 $name =~ /^${Ident}_$2/) {
3037 #print "FOO C name<$name>\n";
3038 $suppress_export{$realline_next} = 1;
3040 } elsif ($stat !~ /(?:
3042 ^.DEFINE_$Ident\(\Q$name\E\)|
3043 ^.DECLARE_$Ident\(\Q$name\E\)|
3044 ^.LIST_HEAD\(\Q$name\E\)|
3045 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3046 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
3048 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3049 $suppress_export{$realline_next} = 2;
3051 $suppress_export{$realline_next} = 1;
3054 if (!defined $suppress_export{$linenr} &&
3055 $prevline =~ /^.\s*$/ &&
3056 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3057 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3058 #print "FOO B <$lines[$linenr - 1]>\n";
3059 $suppress_export{$linenr} = 2;
3061 if (defined $suppress_export{$linenr} &&
3062 $suppress_export{$linenr} == 2) {
3063 WARN("EXPORT_SYMBOL",
3064 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
3067 # check for global initialisers.
3068 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
3069 if (ERROR("GLOBAL_INITIALISERS",
3070 "do not initialise globals to 0 or NULL\n" .
3073 $fixed[$fixlinenr] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
3076 # check for static initialisers.
3077 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
3078 if (ERROR("INITIALISED_STATIC",
3079 "do not initialise statics to 0 or NULL\n" .
3082 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
3086 # check for misordered declarations of char/short/int/long with signed/unsigned
3087 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3089 WARN("MISORDERED_TYPE",
3090 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3093 # check for static const char * arrays.
3094 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
3095 WARN("STATIC_CONST_CHAR_ARRAY",
3096 "static const char * array should probably be static const char * const\n" .
3100 # check for static char foo[] = "bar" declarations.
3101 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
3102 WARN("STATIC_CONST_CHAR_ARRAY",
3103 "static char array declaration should probably be static const char\n" .
3107 # check for non-global char *foo[] = {"bar", ...} declarations.
3108 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3109 WARN("STATIC_CONST_CHAR_ARRAY",
3110 "char * array declaration might be better as static const\n" .
3114 # check for function declarations without arguments like "int foo()"
3115 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3116 if (ERROR("FUNCTION_WITHOUT_ARGS",
3117 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3119 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
3123 # check for uses of DEFINE_PCI_DEVICE_TABLE
3124 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
3125 if (WARN("DEFINE_PCI_DEVICE_TABLE",
3126 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
3128 $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
3132 # check for new typedefs, only function parameters and sparse annotations
3134 if ($line =~ /\btypedef\s/ &&
3135 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
3136 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
3137 $line !~ /\b$typeTypedefs\b/ &&
3138 $line !~ /\b__bitwise(?:__|)\b/) {
3139 WARN("NEW_TYPEDEFS",
3140 "do not add new typedefs\n" . $herecurr);
3143 # * goes on variable not on type
3145 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3147 my ($ident, $from, $to) = ($1, $2, $2);
3149 # Should start with a space.
3150 $to =~ s/^(\S)/ $1/;
3151 # Should not end with a space.
3153 # '*'s should not have spaces between.
3154 while ($to =~ s/\*\s+\*/\*\*/) {
3157 ## print "1: from<$from> to<$to> ident<$ident>\n";
3159 if (ERROR("POINTER_LOCATION",
3160 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3162 my $sub_from = $ident;
3163 my $sub_to = $ident;
3164 $sub_to =~ s/\Q$from\E/$to/;
3165 $fixed[$fixlinenr] =~
3166 s@\Q$sub_from\E@$sub_to@;
3170 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3172 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
3174 # Should start with a space.
3175 $to =~ s/^(\S)/ $1/;
3176 # Should not end with a space.
3178 # '*'s should not have spaces between.
3179 while ($to =~ s/\*\s+\*/\*\*/) {
3181 # Modifiers should have spaces.
3182 $to =~ s/(\b$Modifier$)/$1 /;
3184 ## print "2: from<$from> to<$to> ident<$ident>\n";
3185 if ($from ne $to && $ident !~ /^$Modifier$/) {
3186 if (ERROR("POINTER_LOCATION",
3187 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3190 my $sub_from = $match;
3191 my $sub_to = $match;
3192 $sub_to =~ s/\Q$from\E/$to/;
3193 $fixed[$fixlinenr] =~
3194 s@\Q$sub_from\E@$sub_to@;
3199 # # no BUG() or BUG_ON()
3200 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
3201 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
3202 # print "$herecurr";
3206 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
3207 WARN("LINUX_VERSION_CODE",
3208 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3211 # check for uses of printk_ratelimit
3212 if ($line =~ /\bprintk_ratelimit\s*\(/) {
3213 WARN("PRINTK_RATELIMITED",
3214 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
3217 # printk should use KERN_* levels. Note that follow on printk's on the
3218 # same line do not need a level, so we use the current block context
3219 # to try and find and validate the current printk. In summary the current
3220 # printk includes all preceding printk's which have no newline on the end.
3221 # we assume the first bad printk is the one to report.
3222 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
3224 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3225 #print "CHECK<$lines[$ln - 1]\n";
3226 # we have a preceding printk if it ends
3227 # with "\n" ignore it, else it is to blame
3228 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3229 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3236 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3237 "printk() should include KERN_ facility level\n" . $herecurr);
3241 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3243 my $level = lc($orig);
3244 $level = "warn" if ($level eq "warning");
3245 my $level2 = $level;
3246 $level2 = "dbg" if ($level eq "debug");
3247 WARN("PREFER_PR_LEVEL",
3248 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
3251 if ($line =~ /\bpr_warning\s*\(/) {
3252 if (WARN("PREFER_PR_LEVEL",
3253 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3255 $fixed[$fixlinenr] =~
3256 s/\bpr_warning\b/pr_warn/;
3260 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3262 my $level = lc($orig);
3263 $level = "warn" if ($level eq "warning");
3264 $level = "dbg" if ($level eq "debug");
3265 WARN("PREFER_DEV_LEVEL",
3266 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3269 # function brace can't be on same line, except for #defines of do while,
3270 # or if closed on same line
3271 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
3272 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
3273 if (ERROR("OPEN_BRACE",
3274 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3276 fix_delete_line($fixlinenr, $rawline);
3277 my $fixed_line = $rawline;
3278 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3281 fix_insert_line($fixlinenr, ltrim($line1));
3282 fix_insert_line($fixlinenr, "\+{");
3283 if ($line2 !~ /^\s*$/) {
3284 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3289 # open braces for enum, union and struct go on the same line.
3290 if ($line =~ /^.\s*{/ &&
3291 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
3292 if (ERROR("OPEN_BRACE",
3293 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3294 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3295 fix_delete_line($fixlinenr - 1, $prevrawline);
3296 fix_delete_line($fixlinenr, $rawline);
3297 my $fixedline = rtrim($prevrawline) . " {";
3298 fix_insert_line($fixlinenr, $fixedline);
3299 $fixedline = $rawline;
3300 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3301 if ($fixedline !~ /^\+\s*$/) {
3302 fix_insert_line($fixlinenr, $fixedline);
3307 # missing space after union, struct or enum definition
3308 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3310 "missing space after $1 definition\n" . $herecurr) &&
3312 $fixed[$fixlinenr] =~
3313 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3317 # Function pointer declarations
3318 # check spacing between type, funcptr, and args
3319 # canonical declaration is "type (*funcptr)(args...)"
3320 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
3322 my $pre_pointer_space = $2;
3323 my $post_pointer_space = $3;
3325 my $post_funcname_space = $5;
3326 my $pre_args_space = $6;
3328 # the $Declare variable will capture all spaces after the type
3329 # so check it for a missing trailing missing space but pointer return types
3330 # don't need a space so don't warn for those.
3331 my $post_declare_space = "";
3332 if ($declare =~ /(\s+)$/) {
3333 $post_declare_space = $1;
3334 $declare = rtrim($declare);
3336 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
3338 "missing space after return type\n" . $herecurr);
3339 $post_declare_space = " ";
3342 # unnecessary space "type (*funcptr)(args...)"
3343 # This test is not currently implemented because these declarations are
3345 # int foo(int bar, ...)
3346 # and this is form shouldn't/doesn't generate a checkpatch warning.
3348 # elsif ($declare =~ /\s{2,}$/) {
3350 # "Multiple spaces after return type\n" . $herecurr);
3353 # unnecessary space "type ( *funcptr)(args...)"
3354 if (defined $pre_pointer_space &&
3355 $pre_pointer_space =~ /^\s/) {
3357 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3360 # unnecessary space "type (* funcptr)(args...)"
3361 if (defined $post_pointer_space &&
3362 $post_pointer_space =~ /^\s/) {
3364 "Unnecessary space before function pointer name\n" . $herecurr);
3367 # unnecessary space "type (*funcptr )(args...)"
3368 if (defined $post_funcname_space &&
3369 $post_funcname_space =~ /^\s/) {
3371 "Unnecessary space after function pointer name\n" . $herecurr);
3374 # unnecessary space "type (*funcptr) (args...)"
3375 if (defined $pre_args_space &&
3376 $pre_args_space =~ /^\s/) {
3378 "Unnecessary space before function pointer arguments\n" . $herecurr);
3381 if (show_type("SPACING") && $fix) {
3382 $fixed[$fixlinenr] =~
3383 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3387 # check for spacing round square brackets; allowed:
3388 # 1. with a type on the left -- int [] a;
3389 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3390 # 3. inside a curly brace -- = { [0...10] = 5 }
3391 while ($line =~ /(.*?\s)\[/g) {
3392 my ($where, $prefix) = ($-[1], $1);
3393 if ($prefix !~ /$Type\s+$/ &&
3394 ($where != 0 || $prefix !~ /^.\s+$/) &&
3395 $prefix !~ /[{,]\s+$/) {
3396 if (ERROR("BRACKET_SPACE",
3397 "space prohibited before open square bracket '['\n" . $herecurr) &&
3399 $fixed[$fixlinenr] =~
3400 s/^(\+.*?)\s+\[/$1\[/;
3405 # check for spaces between functions and their parentheses.
3406 while ($line =~ /($Ident)\s+\(/g) {
3408 my $ctx_before = substr($line, 0, $-[1]);
3409 my $ctx = "$ctx_before$name";
3411 # Ignore those directives where spaces _are_ permitted.
3413 if|for|while|switch|return|case|
3414 volatile|__volatile__|
3415 __attribute__|format|__extension__|
3418 # cpp #define statements have non-optional spaces, ie
3419 # if there is a space between the name and the open
3420 # parenthesis it is simply not a parameter group.
3421 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
3423 # cpp #elif statement condition may start with a (
3424 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
3426 # If this whole things ends with a type its most
3427 # likely a typedef for a function.
3428 } elsif ($ctx =~ /$Type$/) {
3432 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3434 $fixed[$fixlinenr] =~
3435 s/\b$name\s+\(/$name\(/;
3440 # Check operator spacing.
3441 if (!($line=~/\#\s*include/)) {
3442 my $fixed_line = "";
3446 <<=|>>=|<=|>=|==|!=|
3447 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3448 =>|->|<<|>>|<|>|=|!|~|
3449 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
3452 my @elements = split(/($ops|;)/, $opline);
3454 ## print("element count: <" . $#elements . ">\n");
3455 ## foreach my $el (@elements) {
3456 ## print("el: <$el>\n");
3459 my @fix_elements = ();
3462 foreach my $el (@elements) {
3463 push(@fix_elements, substr($rawline, $off, length($el)));
3464 $off += length($el);
3469 my $blank = copy_spacing($opline);
3470 my $last_after = -1;
3472 for (my $n = 0; $n < $#elements; $n += 2) {
3474 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3476 ## print("n: <$n> good: <$good>\n");
3478 $off += length($elements[$n]);
3480 # Pick up the preceding and succeeding characters.
3481 my $ca = substr($opline, 0, $off);
3483 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3484 $cc = substr($opline, $off + length($elements[$n + 1]));
3486 my $cb = "$ca$;$cc";
3489 $a = 'V' if ($elements[$n] ne '');
3490 $a = 'W' if ($elements[$n] =~ /\s$/);
3491 $a = 'C' if ($elements[$n] =~ /$;$/);
3492 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3493 $a = 'O' if ($elements[$n] eq '');
3494 $a = 'E' if ($ca =~ /^\s*$/);
3496 my $op = $elements[$n + 1];
3499 if (defined $elements[$n + 2]) {
3500 $c = 'V' if ($elements[$n + 2] ne '');
3501 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
3502 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
3503 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3504 $c = 'O' if ($elements[$n + 2] eq '');
3505 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
3510 my $ctx = "${a}x${c}";
3512 my $at = "(ctx:$ctx)";
3514 my $ptr = substr($blank, 0, $off) . "^";
3515 my $hereptr = "$hereline$ptr\n";
3517 # Pull out the value of this operator.
3518 my $op_type = substr($curr_values, $off + 1, 1);
3520 # Get the full operator variant.
3521 my $opv = $op . substr($curr_vars, $off, 1);
3523 # Ignore operators passed as parameters.
3524 if ($op_type ne 'V' &&
3525 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
3528 # } elsif ($op =~ /^$;+$/) {
3530 # ; should have either the end of line or a space or \ after it
3531 } elsif ($op eq ';') {
3532 if ($ctx !~ /.x[WEBC]/ &&
3533 $cc !~ /^\\/ && $cc !~ /^;/) {
3534 if (ERROR("SPACING",
3535 "space required after that '$op' $at\n" . $hereptr)) {
3536 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3542 } elsif ($op eq '//') {
3544 # : when part of a bitfield
3545 } elsif ($opv eq ':B') {
3546 # skip the bitfield test for now
3550 } elsif ($op eq '->') {
3551 if ($ctx =~ /Wx.|.xW/) {
3552 if (ERROR("SPACING",
3553 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
3554 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3555 if (defined $fix_elements[$n + 2]) {
3556 $fix_elements[$n + 2] =~ s/^\s+//;
3562 # , must have a space on the right.
3563 } elsif ($op eq ',') {
3564 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
3565 if (ERROR("SPACING",
3566 "space required after that '$op' $at\n" . $hereptr)) {
3567 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3573 # '*' as part of a type definition -- reported already.
3574 } elsif ($opv eq '*_') {
3575 #warn "'*' is part of type\n";
3577 # unary operators should have a space before and
3578 # none after. May be left adjacent to another
3579 # unary operator, or a cast
3580 } elsif ($op eq '!' || $op eq '~' ||
3581 $opv eq '*U' || $opv eq '-U' ||
3582 $opv eq '&U' || $opv eq '&&U') {
3583 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
3584 if (ERROR("SPACING",
3585 "space required before that '$op' $at\n" . $hereptr)) {
3586 if ($n != $last_after + 2) {
3587 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3592 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
3593 # A unary '*' may be const
3595 } elsif ($ctx =~ /.xW/) {
3596 if (ERROR("SPACING",
3597 "space prohibited after that '$op' $at\n" . $hereptr)) {
3598 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
3599 if (defined $fix_elements[$n + 2]) {
3600 $fix_elements[$n + 2] =~ s/^\s+//;
3606 # unary ++ and unary -- are allowed no space on one side.
3607 } elsif ($op eq '++' or $op eq '--') {
3608 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
3609 if (ERROR("SPACING",
3610 "space required one side of that '$op' $at\n" . $hereptr)) {
3611 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3615 if ($ctx =~ /Wx[BE]/ ||
3616 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
3617 if (ERROR("SPACING",
3618 "space prohibited before that '$op' $at\n" . $hereptr)) {
3619 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3623 if ($ctx =~ /ExW/) {
3624 if (ERROR("SPACING",
3625 "space prohibited after that '$op' $at\n" . $hereptr)) {
3626 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3627 if (defined $fix_elements[$n + 2]) {
3628 $fix_elements[$n + 2] =~ s/^\s+//;
3634 # << and >> may either have or not have spaces both sides
3635 } elsif ($op eq '<<' or $op eq '>>' or
3636 $op eq '&' or $op eq '^' or $op eq '|' or
3637 $op eq '+' or $op eq '-' or
3638 $op eq '*' or $op eq '/' or
3641 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
3642 if (ERROR("SPACING",
3643 "need consistent spacing around '$op' $at\n" . $hereptr)) {
3644 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3645 if (defined $fix_elements[$n + 2]) {
3646 $fix_elements[$n + 2] =~ s/^\s+//;
3652 # A colon needs no spaces before when it is
3653 # terminating a case value or a label.
3654 } elsif ($opv eq ':C' || $opv eq ':L') {
3655 if ($ctx =~ /Wx./) {
3656 if (ERROR("SPACING",
3657 "space prohibited before that '$op' $at\n" . $hereptr)) {
3658 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3663 # All the others need spaces both sides.
3664 } elsif ($ctx !~ /[EWC]x[CWE]/) {
3667 # Ignore email addresses <foo@bar>
3669 $cc =~ /^\S+\@\S+>/) ||
3671 $ca =~ /<\S+\@\S+$/))
3676 # messages are ERROR, but ?: are CHK
3678 my $msg_type = \&ERROR;
3679 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
3681 if (&{$msg_type}("SPACING",
3682 "spaces required around that '$op' $at\n" . $hereptr)) {
3683 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3684 if (defined $fix_elements[$n + 2]) {
3685 $fix_elements[$n + 2] =~ s/^\s+//;
3691 $off += length($elements[$n + 1]);
3693 ## print("n: <$n> GOOD: <$good>\n");
3695 $fixed_line = $fixed_line . $good;
3698 if (($#elements % 2) == 0) {
3699 $fixed_line = $fixed_line . $fix_elements[$#elements];
3702 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
3703 $fixed[$fixlinenr] = $fixed_line;
3709 # check for whitespace before a non-naked semicolon
3710 if ($line =~ /^\+.*\S\s+;\s*$/) {
3712 "space prohibited before semicolon\n" . $herecurr) &&
3714 1 while $fixed[$fixlinenr] =~
3715 s/^(\+.*\S)\s+;/$1;/;
3719 # check for multiple assignments
3720 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
3721 CHK("MULTIPLE_ASSIGNMENTS",
3722 "multiple assignments should be avoided\n" . $herecurr);
3725 ## # check for multiple declarations, allowing for a function declaration
3727 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3728 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3730 ## # Remove any bracketed sections to ensure we do not
3731 ## # falsly report the parameters of functions.
3733 ## while ($ln =~ s/\([^\(\)]*\)//g) {
3735 ## if ($ln =~ /,/) {
3736 ## WARN("MULTIPLE_DECLARATION",
3737 ## "declaring multiple variables together should be avoided\n" . $herecurr);
3741 #need space before brace following if, while, etc
3742 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3744 if (ERROR("SPACING",
3745 "space required before the open brace '{'\n" . $herecurr) &&
3747 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
3751 ## # check for blank lines before declarations
3752 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3753 ## $prevrawline =~ /^.\s*$/) {
3755 ## "No blank lines before declarations\n" . $hereprev);
3759 # closing brace should have a space following it when it has anything
3761 if ($line =~ /}(?!(?:,|;|\)))\S/) {
3762 if (ERROR("SPACING",
3763 "space required after that close brace '}'\n" . $herecurr) &&
3765 $fixed[$fixlinenr] =~
3766 s/}((?!(?:,|;|\)))\S)/} $1/;
3770 # check spacing on square brackets
3771 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
3772 if (ERROR("SPACING",
3773 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3775 $fixed[$fixlinenr] =~
3779 if ($line =~ /\s\]/) {
3780 if (ERROR("SPACING",
3781 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3783 $fixed[$fixlinenr] =~
3788 # check spacing on parentheses
3789 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3790 $line !~ /for\s*\(\s+;/) {
3791 if (ERROR("SPACING",
3792 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3794 $fixed[$fixlinenr] =~
3798 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
3799 $line !~ /for\s*\(.*;\s+\)/ &&
3800 $line !~ /:\s+\)/) {
3801 if (ERROR("SPACING",
3802 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3804 $fixed[$fixlinenr] =~
3809 # check unnecessary parentheses around addressof/dereference single $Lvals
3810 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
3812 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
3813 CHK("UNNECESSARY_PARENTHESES",
3814 "Unnecessary parentheses around $1\n" . $herecurr);
3817 #goto labels aren't indented, allow a single space however
3818 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
3819 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
3820 if (WARN("INDENTED_LABEL",
3821 "labels should not be indented\n" . $herecurr) &&
3823 $fixed[$fixlinenr] =~
3828 # return is not a function
3829 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
3831 if ($^V && $^V ge 5.10.0 &&
3832 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
3834 $value = deparenthesize($value);
3835 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
3836 ERROR("RETURN_PARENTHESES",
3837 "return is not a function, parentheses are not required\n" . $herecurr);
3839 } elsif ($spacing !~ /\s+/) {
3841 "space required before the open parenthesis '('\n" . $herecurr);
3845 # unnecessary return in a void function
3846 # at end-of-function, with the previous line a single leading tab, then return;
3847 # and the line before that not a goto label target like "out:"
3848 if ($sline =~ /^[ \+]}\s*$/ &&
3849 $prevline =~ /^\+\treturn\s*;\s*$/ &&
3851 $lines[$linenr - 3] =~ /^[ +]/ &&
3852 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
3854 "void function return statements are not generally useful\n" . $hereprev);
3857 # if statements using unnecessary parentheses - ie: if ((foo == bar))
3858 if ($^V && $^V ge 5.10.0 &&
3859 $line =~ /\bif\s*((?:\(\s*){2,})/) {
3860 my $openparens = $1;
3861 my $count = $openparens =~ tr@\(@\(@;
3863 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3864 my $comp = $4; #Not $1 because of $LvalOrFunc
3865 $msg = " - maybe == should be = ?" if ($comp eq "==");
3866 WARN("UNNECESSARY_PARENTHESES",
3867 "Unnecessary parentheses$msg\n" . $herecurr);
3871 # Return of what appears to be an errno should normally be -'ve
3872 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
3874 if ($name ne 'EOF' && $name ne 'ERROR') {
3875 WARN("USE_NEGATIVE_ERRNO",
3876 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
3880 # Need a space before open parenthesis after if, while etc
3881 if ($line =~ /\b(if|while|for|switch)\(/) {
3882 if (ERROR("SPACING",
3883 "space required before the open parenthesis '('\n" . $herecurr) &&
3885 $fixed[$fixlinenr] =~
3886 s/\b(if|while|for|switch)\(/$1 \(/;
3890 # Check for illegal assignment in if conditional -- and check for trailing
3891 # statements after the conditional.
3892 if ($line =~ /do\s*(?!{)/) {
3893 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3894 ctx_statement_block($linenr, $realcnt, 0)
3895 if (!defined $stat);
3896 my ($stat_next) = ctx_statement_block($line_nr_next,
3897 $remain_next, $off_next);
3898 $stat_next =~ s/\n./\n /g;
3899 ##print "stat<$stat> stat_next<$stat_next>\n";
3901 if ($stat_next =~ /^\s*while\b/) {
3902 # If the statement carries leading newlines,
3903 # then count those as offsets.
3905 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
3907 statement_rawlines($whitespace) - 1;
3909 $suppress_whiletrailers{$line_nr_next +
3913 if (!defined $suppress_whiletrailers{$linenr} &&
3914 defined($stat) && defined($cond) &&
3915 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
3916 my ($s, $c) = ($stat, $cond);
3918 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
3919 ERROR("ASSIGN_IN_IF",
3920 "do not use assignment in if condition\n" . $herecurr);
3923 # Find out what is on the end of the line after the
3925 substr($s, 0, length($c), '');
3927 $s =~ s/$;//g; # Remove any comments
3928 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
3929 $c !~ /}\s*while\s*/)
3931 # Find out how long the conditional actually is.
3932 my @newlines = ($c =~ /\n/gs);
3933 my $cond_lines = 1 + $#newlines;
3936 $stat_real = raw_line($linenr, $cond_lines)
3937 . "\n" if ($cond_lines);
3938 if (defined($stat_real) && $cond_lines > 1) {
3939 $stat_real = "[...]\n$stat_real";
3942 ERROR("TRAILING_STATEMENTS",
3943 "trailing statements should be on next line\n" . $herecurr . $stat_real);
3947 # Check for bitwise tests written as boolean
3959 WARN("HEXADECIMAL_BOOLEAN_TEST",
3960 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
3963 # if and else should not have general statements after it
3964 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
3966 $s =~ s/$;//g; # Remove any comments
3967 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
3968 ERROR("TRAILING_STATEMENTS",
3969 "trailing statements should be on next line\n" . $herecurr);
3972 # if should not continue a brace
3973 if ($line =~ /}\s*if\b/) {
3974 ERROR("TRAILING_STATEMENTS",
3975 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
3978 # case and default should not have general statements after them
3979 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
3981 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
3985 ERROR("TRAILING_STATEMENTS",
3986 "trailing statements should be on next line\n" . $herecurr);
3989 # Check for }<nl>else {, these must be at the same
3990 # indent level to be relevant to each other.
3991 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
3992 $previndent == $indent) {
3993 if (ERROR("ELSE_AFTER_BRACE",
3994 "else should follow close brace '}'\n" . $hereprev) &&
3995 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3996 fix_delete_line($fixlinenr - 1, $prevrawline);
3997 fix_delete_line($fixlinenr, $rawline);
3998 my $fixedline = $prevrawline;
3999 $fixedline =~ s/}\s*$//;
4000 if ($fixedline !~ /^\+\s*$/) {
4001 fix_insert_line($fixlinenr, $fixedline);
4003 $fixedline = $rawline;
4004 $fixedline =~ s/^(.\s*)else/$1} else/;
4005 fix_insert_line($fixlinenr, $fixedline);
4009 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4010 $previndent == $indent) {
4011 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4013 # Find out what is on the end of the line after the
4015 substr($s, 0, length($c), '');
4018 if ($s =~ /^\s*;/) {
4019 if (ERROR("WHILE_AFTER_BRACE",
4020 "while should follow close brace '}'\n" . $hereprev) &&
4021 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4022 fix_delete_line($fixlinenr - 1, $prevrawline);
4023 fix_delete_line($fixlinenr, $rawline);
4024 my $fixedline = $prevrawline;
4025 my $trailing = $rawline;
4026 $trailing =~ s/^\+//;
4027 $trailing = trim($trailing);
4028 $fixedline =~ s/}\s*$/} $trailing/;
4029 fix_insert_line($fixlinenr, $fixedline);
4034 #Specific variable tests
4035 while ($line =~ m{($Constant|$Lval)}g) {
4038 #gcc binary extension
4039 if ($var =~ /^$Binary$/) {
4040 if (WARN("GCC_BINARY_CONSTANT",
4041 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4043 my $hexval = sprintf("0x%x", oct($var));
4044 $fixed[$fixlinenr] =~
4045 s/\b$var\b/$hexval/;
4050 if ($var !~ /^$Constant$/ &&
4051 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
4052 #Ignore Page<foo> variants
4053 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
4054 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4055 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) {
4056 while ($var =~ m{($Ident)}g) {
4058 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
4060 seed_camelcase_includes();
4061 if (!$file && !$camelcase_file_seeded) {
4062 seed_camelcase_file($realfile);
4063 $camelcase_file_seeded = 1;
4066 if (!defined $camelcase{$word}) {
4067 $camelcase{$word} = 1;
4069 "Avoid CamelCase: <$word>\n" . $herecurr);
4075 #no spaces allowed after \ in define
4076 if ($line =~ /\#\s*define.*\\\s+$/) {
4077 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4078 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4080 $fixed[$fixlinenr] =~ s/\s+$//;
4084 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
4085 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
4087 my $checkfile = "include/linux/$file";
4088 if (-f "$root/$checkfile" &&
4089 $realfile ne $checkfile &&
4090 $1 !~ /$allowed_asm_includes/)
4092 if ($realfile =~ m{^arch/}) {
4093 CHK("ARCH_INCLUDE_LINUX",
4094 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4096 WARN("INCLUDE_LINUX",
4097 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4102 # multi-statement macros should be enclosed in a do while loop, grab the
4103 # first statement and ensure its the whole macro if its not enclosed
4104 # in a known good container
4105 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4106 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
4109 my ($off, $dstat, $dcond, $rest);
4111 my $has_flow_statement = 0;
4112 my $has_arg_concat = 0;
4113 ($dstat, $dcond, $ln, $cnt, $off) =
4114 ctx_statement_block($linenr, $realcnt, 0);
4116 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4117 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4119 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
4120 $has_arg_concat = 1 if ($ctx =~ /\#\#/);
4122 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
4124 $dstat =~ s/\\\n.//g;
4125 $dstat =~ s/^\s*//s;
4126 $dstat =~ s/\s*$//s;
4128 # Flatten any parentheses and braces
4129 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4130 $dstat =~ s/\{[^\{\}]*\}/1/ ||
4131 $dstat =~ s/\[[^\[\]]*\]/1/)
4135 # Flatten any obvious string concatentation.
4136 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
4137 $dstat =~ s/$Ident\s*("X*")/$1/)
4141 my $exceptions = qr{
4153 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4155 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4156 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
4157 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4158 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
4159 $dstat !~ /$exceptions/ &&
4160 $dstat !~ /^\.$Ident\s*=/ && # .foo =
4161 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
4162 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
4163 $dstat !~ /^for\s*$Constant$/ && # for (...)
4164 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4165 $dstat !~ /^do\s*{/ && # do {...
4166 $dstat !~ /^\({/ && # ({...
4167 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
4170 my $herectx = $here . "\n";
4171 my $cnt = statement_rawlines($ctx);
4173 for (my $n = 0; $n < $cnt; $n++) {
4174 $herectx .= raw_line($linenr, $n) . "\n";
4177 if ($dstat =~ /;/) {
4178 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4179 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4181 ERROR("COMPLEX_MACRO",
4182 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
4186 # check for macros with flow control, but without ## concatenation
4187 # ## concatenation is commonly a macro that defines a function so ignore those
4188 if ($has_flow_statement && !$has_arg_concat) {
4189 my $herectx = $here . "\n";
4190 my $cnt = statement_rawlines($ctx);
4192 for (my $n = 0; $n < $cnt; $n++) {
4193 $herectx .= raw_line($linenr, $n) . "\n";
4195 WARN("MACRO_WITH_FLOW_CONTROL",
4196 "Macros with flow control statements should be avoided\n" . "$herectx");
4199 # check for line continuations outside of #defines, preprocessor #, and asm
4202 if ($prevline !~ /^..*\\$/ &&
4203 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4204 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
4205 $line =~ /^\+.*\\$/) {
4206 WARN("LINE_CONTINUATIONS",
4207 "Avoid unnecessary line continuations\n" . $herecurr);
4211 # do {} while (0) macro tests:
4212 # single-statement macros do not need to be enclosed in do while (0) loop,
4213 # macro should not end with a semicolon
4214 if ($^V && $^V ge 5.10.0 &&
4215 $realfile !~ m@/vmlinux.lds.h$@ &&
4216 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4219 my ($off, $dstat, $dcond, $rest);
4221 ($dstat, $dcond, $ln, $cnt, $off) =
4222 ctx_statement_block($linenr, $realcnt, 0);
4225 $dstat =~ s/\\\n.//g;
4227 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4232 my $cnt = statement_rawlines($ctx);
4233 my $herectx = $here . "\n";
4235 for (my $n = 0; $n < $cnt; $n++) {
4236 $herectx .= raw_line($linenr, $n) . "\n";
4239 if (($stmts =~ tr/;/;/) == 1 &&
4240 $stmts !~ /^\s*(if|while|for|switch)\b/) {
4241 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4242 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4244 if (defined $semis && $semis ne "") {
4245 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4246 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4248 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4250 my $cnt = statement_rawlines($ctx);
4251 my $herectx = $here . "\n";
4253 for (my $n = 0; $n < $cnt; $n++) {
4254 $herectx .= raw_line($linenr, $n) . "\n";
4257 WARN("TRAILING_SEMICOLON",
4258 "macros should not use a trailing semicolon\n" . "$herectx");
4262 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4263 # all assignments may have only one of the following with an assignment:
4266 # VMLINUX_SYMBOL(...)
4267 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
4268 WARN("MISSING_VMLINUX_SYMBOL",
4269 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
4272 # check for redundant bracing round if etc
4273 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4274 my ($level, $endln, @chunks) =
4275 ctx_statement_full($linenr, $realcnt, 1);
4276 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
4277 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4278 if ($#chunks > 0 && $level == 0) {
4282 my $herectx = $here . "\n";
4283 my $ln = $linenr - 1;
4284 for my $chunk (@chunks) {
4285 my ($cond, $block) = @{$chunk};
4287 # If the condition carries leading newlines, then count those as offsets.
4288 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4289 my $offset = statement_rawlines($whitespace) - 1;
4291 $allowed[$allow] = 0;
4292 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4294 # We have looked at and allowed this specific line.
4295 $suppress_ifbraces{$ln + $offset} = 1;
4297 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
4298 $ln += statement_rawlines($block) - 1;
4300 substr($block, 0, length($cond), '');
4302 $seen++ if ($block =~ /^\s*{/);
4304 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
4305 if (statement_lines($cond) > 1) {
4306 #print "APW: ALLOWED: cond<$cond>\n";
4307 $allowed[$allow] = 1;
4309 if ($block =~/\b(?:if|for|while)\b/) {
4310 #print "APW: ALLOWED: block<$block>\n";
4311 $allowed[$allow] = 1;
4313 if (statement_block_size($block) > 1) {
4314 #print "APW: ALLOWED: lines block<$block>\n";
4315 $allowed[$allow] = 1;
4320 my $sum_allowed = 0;
4321 foreach (@allowed) {
4324 if ($sum_allowed == 0) {
4326 "braces {} are not necessary for any arm of this statement\n" . $herectx);
4327 } elsif ($sum_allowed != $allow &&
4330 "braces {} should be used on all arms of this statement\n" . $herectx);
4335 if (!defined $suppress_ifbraces{$linenr - 1} &&
4336 $line =~ /\b(if|while|for|else)\b/) {
4339 # Check the pre-context.
4340 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
4341 #print "APW: ALLOWED: pre<$1>\n";
4345 my ($level, $endln, @chunks) =
4346 ctx_statement_full($linenr, $realcnt, $-[0]);
4348 # Check the condition.
4349 my ($cond, $block) = @{$chunks[0]};
4350 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
4351 if (defined $cond) {
4352 substr($block, 0, length($cond), '');
4354 if (statement_lines($cond) > 1) {
4355 #print "APW: ALLOWED: cond<$cond>\n";
4358 if ($block =~/\b(?:if|for|while)\b/) {
4359 #print "APW: ALLOWED: block<$block>\n";
4362 if (statement_block_size($block) > 1) {
4363 #print "APW: ALLOWED: lines block<$block>\n";
4366 # Check the post-context.
4367 if (defined $chunks[1]) {
4368 my ($cond, $block) = @{$chunks[1]};
4369 if (defined $cond) {
4370 substr($block, 0, length($cond), '');
4372 if ($block =~ /^\s*\{/) {
4373 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4377 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
4378 my $herectx = $here . "\n";
4379 my $cnt = statement_rawlines($block);
4381 for (my $n = 0; $n < $cnt; $n++) {
4382 $herectx .= raw_line($linenr, $n) . "\n";
4386 "braces {} are not necessary for single statement blocks\n" . $herectx);
4390 # check for unnecessary blank lines around braces
4391 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
4393 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
4395 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
4397 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
4400 # no volatiles please
4401 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
4402 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
4404 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
4407 # concatenated string without spaces between elements
4408 if ($line =~ /"X+"[A-Z_]+/ || $line =~ /[A-Z_]+"X+"/) {
4409 CHK("CONCATENATED_STRING",
4410 "Concatenated strings should use spaces between elements\n" . $herecurr);
4414 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
4415 CHK("REDUNDANT_CODE",
4416 "if this code is redundant consider removing it\n" .
4420 # check for needless "if (<foo>) fn(<foo>)" uses
4421 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
4422 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
4423 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
4425 "$1(NULL) is safe this check is probably not required\n" . $hereprev);
4429 # check for unnecessary "Out of Memory" messages
4430 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
4431 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
4432 (defined $1 || defined $3) &&
4435 my $testline = $lines[$linenr - 3];
4437 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
4438 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
4440 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
4442 "Possible unnecessary 'out of memory' message\n" . $hereprev);
4446 # check for bad placement of section $InitAttribute (e.g.: __initdata)
4447 if ($line =~ /(\b$InitAttribute\b)/) {
4449 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
4452 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
4453 ERROR("MISPLACED_INIT",
4454 "$attr should be placed after $var\n" . $herecurr)) ||
4455 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
4456 WARN("MISPLACED_INIT",
4457 "$attr should be placed after $var\n" . $herecurr))) &&
4459 $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;
4464 # check for $InitAttributeData (ie: __initdata) with const
4465 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
4467 $attr =~ /($InitAttributePrefix)(.*)/;
4468 my $attr_prefix = $1;
4470 if (ERROR("INIT_ATTRIBUTE",
4471 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
4473 $fixed[$fixlinenr] =~
4474 s/$InitAttributeData/${attr_prefix}initconst/;
4478 # check for $InitAttributeConst (ie: __initconst) without const
4479 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
4481 if (ERROR("INIT_ATTRIBUTE",
4482 "Use of $attr requires a separate use of const\n" . $herecurr) &&
4484 my $lead = $fixed[$fixlinenr] =~
4485 /(^\+\s*(?:static\s+))/;
4487 $lead = "$lead " if ($lead !~ /^\+$/);
4488 $lead = "${lead}const ";
4489 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
4493 # don't use __constant_<foo> functions outside of include/uapi/
4494 if ($realfile !~ m@^include/uapi/@ &&
4495 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
4496 my $constant_func = $1;
4497 my $func = $constant_func;
4498 $func =~ s/^__constant_//;
4499 if (WARN("CONSTANT_CONVERSION",
4500 "$constant_func should be $func\n" . $herecurr) &&
4502 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
4506 # prefer usleep_range over udelay
4507 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
4509 # ignore udelay's < 10, however
4510 if (! ($delay < 10) ) {
4512 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4514 if ($delay > 2000) {
4516 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
4520 # warn about unexpectedly long msleep's
4521 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
4524 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4528 # check for comparisons of jiffies
4529 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
4530 WARN("JIFFIES_COMPARISON",
4531 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4534 # check for comparisons of get_jiffies_64()
4535 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
4536 WARN("JIFFIES_COMPARISON",
4537 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4540 # warn about #ifdefs in C files
4541 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
4542 # print "#ifdef in C files should be avoided\n";
4543 # print "$herecurr";
4547 # warn about spacing in #ifdefs
4548 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
4549 if (ERROR("SPACING",
4550 "exactly one space required after that #$1\n" . $herecurr) &&
4552 $fixed[$fixlinenr] =~
4553 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
4558 # check for spinlock_t definitions without a comment.
4559 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
4560 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
4562 if (!ctx_has_comment($first_line, $linenr)) {
4563 CHK("UNCOMMENTED_DEFINITION",
4564 "$1 definition without comment\n" . $herecurr);
4567 # check for memory barriers without a comment.
4568 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4569 if (!ctx_has_comment($first_line, $linenr)) {
4570 WARN("MEMORY_BARRIER",
4571 "memory barrier without comment\n" . $herecurr);
4574 # check of hardware specific defines
4575 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
4577 "architecture specific defines should be avoided\n" . $herecurr);
4580 # Check that the storage class is at the beginning of a declaration
4581 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
4582 WARN("STORAGE_CLASS",
4583 "storage class should be at the beginning of the declaration\n" . $herecurr)
4586 # check the location of the inline attribute, that it is between
4587 # storage class and type.
4588 if ($line =~ /\b$Type\s+$Inline\b/ ||
4589 $line =~ /\b$Inline\s+$Storage\b/) {
4590 ERROR("INLINE_LOCATION",
4591 "inline keyword should sit between storage class and type\n" . $herecurr);
4594 # Check for __inline__ and __inline, prefer inline
4595 if ($realfile !~ m@\binclude/uapi/@ &&
4596 $line =~ /\b(__inline__|__inline)\b/) {
4598 "plain inline is preferred over $1\n" . $herecurr) &&
4600 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
4605 # Check for __attribute__ packed, prefer __packed
4606 if ($realfile !~ m@\binclude/uapi/@ &&
4607 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
4608 WARN("PREFER_PACKED",
4609 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
4612 # Check for __attribute__ aligned, prefer __aligned
4613 if ($realfile !~ m@\binclude/uapi/@ &&
4614 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
4615 WARN("PREFER_ALIGNED",
4616 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
4619 # Check for __attribute__ format(printf, prefer __printf
4620 if ($realfile !~ m@\binclude/uapi/@ &&
4621 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
4622 if (WARN("PREFER_PRINTF",
4623 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4625 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
4630 # Check for __attribute__ format(scanf, prefer __scanf
4631 if ($realfile !~ m@\binclude/uapi/@ &&
4632 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
4633 if (WARN("PREFER_SCANF",
4634 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4636 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
4640 # check for sizeof(&)
4641 if ($line =~ /\bsizeof\s*\(\s*\&/) {
4642 WARN("SIZEOF_ADDRESS",
4643 "sizeof(& should be avoided\n" . $herecurr);
4646 # check for sizeof without parenthesis
4647 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
4648 if (WARN("SIZEOF_PARENTHESIS",
4649 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
4651 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
4655 # check for line continuations in quoted strings with odd counts of "
4656 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
4657 WARN("LINE_CONTINUATIONS",
4658 "Avoid line continuations in quoted strings\n" . $herecurr);
4661 # check for struct spinlock declarations
4662 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
4663 WARN("USE_SPINLOCK_T",
4664 "struct spinlock should be spinlock_t\n" . $herecurr);
4667 # check for seq_printf uses that could be seq_puts
4668 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
4669 my $fmt = get_quoted_string($line, $rawline);
4670 if ($fmt ne "" && $fmt !~ /[^\\]\%/) {
4671 if (WARN("PREFER_SEQ_PUTS",
4672 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
4674 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
4679 # Check for misused memsets
4680 if ($^V && $^V ge 5.10.0 &&
4682 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
4688 if ($ms_size =~ /^(0x|)0$/i) {
4690 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
4691 } elsif ($ms_size =~ /^(0x|)1$/i) {
4693 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
4697 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
4698 if ($^V && $^V ge 5.10.0 &&
4699 $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) {
4700 if (WARN("PREFER_ETHER_ADDR_COPY",
4701 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
4703 $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
4707 # typecasts on min/max could be min_t/max_t
4708 if ($^V && $^V ge 5.10.0 &&
4710 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
4711 if (defined $2 || defined $7) {
4713 my $cast1 = deparenthesize($2);
4715 my $cast2 = deparenthesize($7);
4719 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
4720 $cast = "$cast1 or $cast2";
4721 } elsif ($cast1 ne "") {
4727 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
4731 # check usleep_range arguments
4732 if ($^V && $^V ge 5.10.0 &&
4734 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
4738 WARN("USLEEP_RANGE",
4739 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4740 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
4742 WARN("USLEEP_RANGE",
4743 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4747 # check for naked sscanf
4748 if ($^V && $^V ge 5.10.0 &&
4750 $line =~ /\bsscanf\b/ &&
4751 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
4752 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
4753 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
4754 my $lc = $stat =~ tr@\n@@;
4755 $lc = $lc + $linenr;
4756 my $stat_real = raw_line($linenr, 0);
4757 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4758 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4760 WARN("NAKED_SSCANF",
4761 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
4764 # check for simple sscanf that should be kstrto<foo>
4765 if ($^V && $^V ge 5.10.0 &&
4767 $line =~ /\bsscanf\b/) {
4768 my $lc = $stat =~ tr@\n@@;
4769 $lc = $lc + $linenr;
4770 my $stat_real = raw_line($linenr, 0);
4771 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4772 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4774 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
4776 my $count = $format =~ tr@%@%@;
4778 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
4779 WARN("SSCANF_TO_KSTRTO",
4780 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
4785 # check for new externs in .h files.
4786 if ($realfile =~ /\.h$/ &&
4787 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
4788 if (CHK("AVOID_EXTERNS",
4789 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
4791 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
4795 # check for new externs in .c files.
4796 if ($realfile =~ /\.c$/ && defined $stat &&
4797 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
4799 my $function_name = $1;
4800 my $paren_space = $2;
4803 if (defined $cond) {
4804 substr($s, 0, length($cond), '');
4806 if ($s =~ /^\s*;/ &&
4807 $function_name ne 'uninitialized_var')
4809 WARN("AVOID_EXTERNS",
4810 "externs should be avoided in .c files\n" . $herecurr);
4813 if ($paren_space =~ /\n/) {
4814 WARN("FUNCTION_ARGUMENTS",
4815 "arguments for function declarations should follow identifier\n" . $herecurr);
4818 } elsif ($realfile =~ /\.c$/ && defined $stat &&
4819 $stat =~ /^.\s*extern\s+/)
4821 WARN("AVOID_EXTERNS",
4822 "externs should be avoided in .c files\n" . $herecurr);
4825 # checks for new __setup's
4826 if ($rawline =~ /\b__setup\("([^"]*)"/) {
4829 if (!grep(/$name/, @setup_docs)) {
4830 CHK("UNDOCUMENTED_SETUP",
4831 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
4835 # check for pointless casting of kmalloc return
4836 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
4837 WARN("UNNECESSARY_CASTS",
4838 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
4842 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
4843 if ($^V && $^V ge 5.10.0 &&
4844 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
4845 CHK("ALLOC_SIZEOF_STRUCT",
4846 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
4849 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
4850 if ($^V && $^V ge 5.10.0 &&
4851 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
4855 my $newfunc = "kmalloc_array";
4856 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
4859 if ($a1 =~ /^sizeof\s*\S/) {
4863 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
4864 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
4865 if (WARN("ALLOC_WITH_MULTIPLY",
4866 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
4868 $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;
4874 # check for krealloc arg reuse
4875 if ($^V && $^V ge 5.10.0 &&
4876 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
4877 WARN("KREALLOC_ARG_REUSE",
4878 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
4881 # check for alloc argument mismatch
4882 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
4883 WARN("ALLOC_ARRAY_ARGS",
4884 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
4887 # check for multiple semicolons
4888 if ($line =~ /;\s*;\s*$/) {
4889 if (WARN("ONE_SEMICOLON",
4890 "Statements terminations use 1 semicolon\n" . $herecurr) &&
4892 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
4896 # check for case / default statements not preceded by break/fallthrough/switch
4897 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
4899 my $has_statement = 0;
4901 my $prevline = $linenr;
4902 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
4904 my $rline = $rawlines[$prevline - 1];
4905 my $fline = $lines[$prevline - 1];
4906 last if ($fline =~ /^\@\@/);
4907 next if ($fline =~ /^\-/);
4908 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
4909 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
4910 next if ($fline =~ /^.[\s$;]*$/);
4913 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
4915 if (!$has_break && $has_statement) {
4916 WARN("MISSING_BREAK",
4917 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
4921 # check for switch/default statements without a break;
4922 if ($^V && $^V ge 5.10.0 &&
4924 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
4926 my $herectx = $here . "\n";
4927 my $cnt = statement_rawlines($stat);
4928 for (my $n = 0; $n < $cnt; $n++) {
4929 $herectx .= raw_line($linenr, $n) . "\n";
4931 WARN("DEFAULT_NO_BREAK",
4932 "switch default: should use break\n" . $herectx);
4935 # check for gcc specific __FUNCTION__
4936 if ($line =~ /\b__FUNCTION__\b/) {
4937 if (WARN("USE_FUNC",
4938 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
4940 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
4944 # check for use of yield()
4945 if ($line =~ /\byield\s*\(\s*\)/) {
4947 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
4950 # check for comparisons against true and false
4951 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
4959 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
4961 my $type = lc($otype);
4962 if ($type =~ /^(?:true|false)$/) {
4963 if (("$test" eq "==" && "$type" eq "true") ||
4964 ("$test" eq "!=" && "$type" eq "false")) {
4968 CHK("BOOL_COMPARISON",
4969 "Using comparison to $otype is error prone\n" . $herecurr);
4971 ## maybe suggesting a correct construct would better
4972 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
4977 # check for semaphores initialized locked
4978 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
4979 WARN("CONSIDER_COMPLETION",
4980 "consider using a completion\n" . $herecurr);
4983 # recommend kstrto* over simple_strto* and strict_strto*
4984 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
4985 WARN("CONSIDER_KSTRTO",
4986 "$1 is obsolete, use k$3 instead\n" . $herecurr);
4989 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
4990 if ($line =~ /^.\s*__initcall\s*\(/) {
4991 WARN("USE_DEVICE_INITCALL",
4992 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
4995 # check for various ops structs, ensure they are const.
4996 my $struct_ops = qr{acpi_dock_ops|
4997 address_space_operations|
4999 block_device_operations|
5004 file_lock_operations|
5014 lock_manager_operations|
5020 pipe_buf_operations|
5021 platform_hibernation_ops|
5022 platform_suspend_ops|
5027 soc_pcmcia_socket_ops|
5033 if ($line !~ /\bconst\b/ &&
5034 $line =~ /\bstruct\s+($struct_ops)\b/) {
5035 WARN("CONST_STRUCT",
5036 "struct $1 should normally be const\n" .
5040 # use of NR_CPUS is usually wrong
5041 # ignore definitions of NR_CPUS and usage to define arrays as likely right
5042 if ($line =~ /\bNR_CPUS\b/ &&
5043 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
5044 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
5045 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
5046 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
5047 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
5050 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
5053 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
5054 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
5055 ERROR("DEFINE_ARCH_HAS",
5056 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
5059 # check for %L{u,d,i} in strings
5061 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
5062 $string = substr($rawline, $-[1], $+[1] - $-[1]);
5063 $string =~ s/%%/__/g;
5064 if ($string =~ /(?<!%)%L[udi]/) {
5066 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
5071 # whine mightly about in_atomic
5072 if ($line =~ /\bin_atomic\s*\(/) {
5073 if ($realfile =~ m@^drivers/@) {
5075 "do not use in_atomic in drivers\n" . $herecurr);
5076 } elsif ($realfile !~ m@^kernel/@) {
5078 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
5082 # check for lockdep_set_novalidate_class
5083 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
5084 $line =~ /__lockdep_no_validate__\s*\)/ ) {
5085 if ($realfile !~ m@^kernel/lockdep@ &&
5086 $realfile !~ m@^include/linux/lockdep@ &&
5087 $realfile !~ m@^drivers/base/core@) {
5089 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
5093 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
5094 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
5095 WARN("EXPORTED_WORLD_WRITABLE",
5096 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5099 # Mode permission misuses where it seems decimal should be octal
5100 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5101 if ($^V && $^V ge 5.10.0 &&
5102 $line =~ /$mode_perms_search/) {
5103 foreach my $entry (@mode_permission_funcs) {
5104 my $func = $entry->[0];
5105 my $arg_pos = $entry->[1];
5110 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
5112 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
5113 if ($line =~ /$test/) {
5115 $val = $6 if ($skip_args ne "");
5117 if ($val !~ /^0$/ &&
5118 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
5119 length($val) ne 4)) {
5120 ERROR("NON_OCTAL_PERMISSIONS",
5121 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
5128 # If we have no input at all, then there is nothing to report on
5129 # so just keep quiet.
5130 if ($#rawlines == -1) {
5134 # In mailback mode only produce a report in the negative, for
5135 # things that appear to be patches.
5136 if ($mailback && ($clean == 1 || !$is_patch)) {
5140 # This is not a patch, and we are are in 'no-patch' mode so
5142 if (!$chk_patch && !$is_patch) {
5147 ERROR("NOT_UNIFIED_DIFF",
5148 "Does not appear to be a unified-diff format patch\n");
5150 if ($is_patch && $chk_signoff && $signoff == 0) {
5151 ERROR("MISSING_SIGN_OFF",
5152 "Missing Signed-off-by: line(s)\n");
5155 print report_dump();
5156 if ($summary && !($clean == 1 && $quiet == 1)) {
5157 print "$filename " if ($summary_file);
5158 print "total: $cnt_error errors, $cnt_warn warnings, " .
5159 (($check)? "$cnt_chk checks, " : "") .
5160 "$cnt_lines lines checked\n";
5161 print "\n" if ($quiet == 0);
5166 if ($^V lt 5.10.0) {
5167 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
5168 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
5171 # If there were whitespace errors which cleanpatch can fix
5172 # then suggest that.
5173 if ($rpt_cleaners) {
5174 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
5175 print " scripts/cleanfile\n\n";
5180 hash_show_words(\%use_type, "Used");
5181 hash_show_words(\%ignore_type, "Ignored");
5183 if ($clean == 0 && $fix &&
5184 ("@rawlines" ne "@fixed" ||
5185 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
5186 my $newfile = $filename;
5187 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
5191 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
5193 open($f, '>', $newfile)
5194 or die "$P: Can't open $newfile for write\n";
5195 foreach my $fixed_line (@fixed) {
5198 if ($linecount > 3) {
5199 $fixed_line =~ s/^\+//;
5200 print $f $fixed_line . "\n";
5203 print $f $fixed_line . "\n";
5210 Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
5212 Do _NOT_ trust the results written to this file.
5213 Do _NOT_ submit these changes without inspecting them for correctness.
5215 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
5216 No warranties, expressed or implied...
5222 if ($clean == 1 && $quiet == 0) {
5223 print "$vname has no obvious style problems and is ready for submission.\n"
5225 if ($clean == 0 && $quiet == 0) {
5227 $vname has style problems, please review.
5229 If any of these errors are false positives, please report
5230 them to the maintainer, see CHECKPATCH in MAINTAINERS.