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
14 my $D = dirname(abs_path($P));
18 use Getopt::Long qw(:config no_auto_abbrev);
44 my $configuration_file = ".checkpatch.conf";
45 my $max_line_length = 80;
46 my $ignore_perl_version = 0;
47 my $minimum_perl_version = 5.10.0;
48 my $min_conf_desc_length = 4;
49 my $spelling_file = "$D/spelling.txt";
51 my $codespellfile = "/usr/local/share/codespell/dictionary.txt";
57 Usage: $P [OPTION]... [FILE]...
62 --no-tree run without a kernel tree
63 --no-signoff do not check for 'Signed-off-by' line
64 --patch treat FILE as patchfile (default)
65 --emacs emacs compile window format
66 --terse one line per report
67 -f, --file treat FILE as regular source file
68 --subjective, --strict enable more subjective tests
69 --types TYPE(,TYPE2...) show only these comma separated message types
70 --ignore TYPE(,TYPE2...) ignore various comma separated message types
71 --max-line-length=n set the maximum line length, if exceeded, warn
72 --min-conf-desc-length=n set the min description length, if shorter, warn
73 --show-types show the message "types" in the output
74 --root=PATH PATH to the kernel tree root
75 --no-summary suppress the per-file summary
76 --mailback only produce a report in case of warnings/errors
77 --summary-file include the filename in summary
78 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
79 'values', 'possible', 'type', and 'attr' (default
81 --test-only=WORD report only warnings/errors containing WORD
83 --fix EXPERIMENTAL - may create horrible results
84 If correctable single-line errors exist, create
85 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
86 with potential errors corrected to the preferred
88 --fix-inplace EXPERIMENTAL - may create horrible results
89 Is the same as --fix, but overwrites the input
90 file. It's your fault if there's no backup or git
91 --ignore-perl-version override checking of perl version. expect
93 --codespell Use the codespell dictionary for spelling/typos
94 (default:/usr/local/share/codespell/dictionary.txt)
95 --codespellfile Use this codespell dictionary
96 -h, --help, --version display this help and exit
98 When FILE is - read standard input.
104 my $conf = which_conf($configuration_file);
107 open(my $conffile, '<', "$conf")
108 or warn "$P: Can't find a readable $configuration_file file $!\n";
110 while (<$conffile>) {
113 $line =~ s/\s*\n?$//g;
117 next if ($line =~ m/^\s*#/);
118 next if ($line =~ m/^\s*$/);
120 my @words = split(" ", $line);
121 foreach my $word (@words) {
122 last if ($word =~ m/^#/);
123 push (@conf_args, $word);
127 unshift(@ARGV, @conf_args) if @conf_args;
131 'q|quiet+' => \$quiet,
133 'signoff!' => \$chk_signoff,
134 'patch!' => \$chk_patch,
138 'subjective!' => \$check,
139 'strict!' => \$check,
140 'ignore=s' => \@ignore,
142 'show-types!' => \$show_types,
143 'max-line-length=i' => \$max_line_length,
144 'min-conf-desc-length=i' => \$min_conf_desc_length,
146 'summary!' => \$summary,
147 'mailback!' => \$mailback,
148 'summary-file!' => \$summary_file,
150 'fix-inplace!' => \$fix_inplace,
151 'ignore-perl-version!' => \$ignore_perl_version,
152 'debug=s' => \%debug,
153 'test-only=s' => \$tst_only,
154 'codespell!' => \$codespell,
155 'codespellfile=s' => \$codespellfile,
162 $fix = 1 if ($fix_inplace);
163 $check_orig = $check;
167 if ($^V && $^V lt $minimum_perl_version) {
168 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
169 if (!$ignore_perl_version) {
175 print "$P: no input files\n";
179 sub hash_save_array_words {
180 my ($hashRef, $arrayRef) = @_;
182 my @array = split(/,/, join(',', @$arrayRef));
183 foreach my $word (@array) {
184 $word =~ s/\s*\n?$//g;
187 $word =~ tr/[a-z]/[A-Z]/;
189 next if ($word =~ m/^\s*#/);
190 next if ($word =~ m/^\s*$/);
196 sub hash_show_words {
197 my ($hashRef, $prefix) = @_;
199 if ($quiet == 0 && keys %$hashRef) {
200 print "NOTE: $prefix message types:";
201 foreach my $word (sort keys %$hashRef) {
208 hash_save_array_words(\%ignore_type, \@ignore);
209 hash_save_array_words(\%use_type, \@use);
212 my $dbg_possible = 0;
215 for my $key (keys %debug) {
217 eval "\${dbg_$key} = '$debug{$key}';";
221 my $rpt_cleaners = 0;
230 if (!top_of_kernel_tree($root)) {
231 die "$P: $root: --root does not point at a valid tree\n";
234 if (top_of_kernel_tree('.')) {
236 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
237 top_of_kernel_tree($1)) {
242 if (!defined $root) {
243 print "Must be run from the top-level dir. of a kernel tree\n";
248 my $emitted_corrupt = 0;
251 [A-Za-z_][A-Za-z\d_]*
252 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
254 our $Storage = qr{extern|static|asmlinkage};
266 our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
267 our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
268 our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
269 our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
270 our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
272 # Notes to $Attribute:
273 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
294 ____cacheline_aligned|
295 ____cacheline_aligned_in_smp|
296 ____cacheline_internodealigned_in_smp|
300 our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
301 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
302 our $Lval = qr{$Ident(?:$Member)*};
304 our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
305 our $Binary = qr{(?i)0b[01]+$Int_type?};
306 our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
307 our $Int = qr{[0-9]+$Int_type?};
308 our $Octal = qr{0[0-7]+$Int_type?};
309 our $String = qr{"[X\t]*"};
310 our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
311 our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
312 our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
313 our $Float = qr{$Float_hex|$Float_dec|$Float_int};
314 our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
315 our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
316 our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
317 our $Arithmetic = qr{\+|-|\*|\/|%};
321 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
324 our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
328 our $NonptrTypeMisordered;
329 our $NonptrTypeWithAttr;
333 our $DeclareMisordered;
335 our $NON_ASCII_UTF8 = qr{
336 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
337 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
338 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
339 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
340 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
341 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
342 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
346 [\x09\x0A\x0D\x20-\x7E] # ASCII
350 our $typeOtherOSTypedefs = qr{(?x:
351 u_(?:char|short|int|long) | # bsd
352 u(?:nchar|short|int|long) # sysv
355 our $typeTypedefs = qr{(?x:
356 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
360 our $logFunctions = qr{(?x:
361 printk(?:_ratelimited|_once|)|
362 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
363 WARN(?:_RATELIMIT|_ONCE|)|
366 seq_vprintf|seq_printf|seq_puts
369 our $signature_tags = qr{(?xi:
380 our @typeListMisordered = (
381 qr{char\s+(?:un)?signed},
382 qr{int\s+(?:(?:un)?signed\s+)?short\s},
383 qr{int\s+short(?:\s+(?:un)?signed)},
384 qr{short\s+int(?:\s+(?:un)?signed)},
385 qr{(?:un)?signed\s+int\s+short},
386 qr{short\s+(?:un)?signed},
387 qr{long\s+int\s+(?:un)?signed},
388 qr{int\s+long\s+(?:un)?signed},
389 qr{long\s+(?:un)?signed\s+int},
390 qr{int\s+(?:un)?signed\s+long},
391 qr{int\s+(?:un)?signed},
392 qr{int\s+long\s+long\s+(?:un)?signed},
393 qr{long\s+long\s+int\s+(?:un)?signed},
394 qr{long\s+long\s+(?:un)?signed\s+int},
395 qr{long\s+long\s+(?:un)?signed},
396 qr{long\s+(?:un)?signed},
401 qr{(?:(?:un)?signed\s+)?char},
402 qr{(?:(?:un)?signed\s+)?short\s+int},
403 qr{(?:(?:un)?signed\s+)?short},
404 qr{(?:(?:un)?signed\s+)?int},
405 qr{(?:(?:un)?signed\s+)?long\s+int},
406 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
407 qr{(?:(?:un)?signed\s+)?long\s+long},
408 qr{(?:(?:un)?signed\s+)?long},
417 qr{${Ident}_handler},
418 qr{${Ident}_handler_fn},
421 our @typeListWithAttr = (
423 qr{struct\s+$InitAttribute\s+$Ident},
424 qr{union\s+$InitAttribute\s+$Ident},
427 our @modifierList = (
431 our @mode_permission_funcs = (
433 ["module_param_(?:array|named|string)", 4],
434 ["module_param_array_named", 5],
435 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
436 ["proc_create(?:_data|)", 2],
437 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
440 #Create a search pattern for all these functions to speed up a loop below
441 our $mode_perms_search = "";
442 foreach my $entry (@mode_permission_funcs) {
443 $mode_perms_search .= '|' if ($mode_perms_search ne "");
444 $mode_perms_search .= $entry->[0];
447 our $mode_perms_world_writable = qr{
455 our $allowed_asm_includes = qr{(?x:
461 # memory.h: ARM has a custom one
463 # Load common spelling mistakes and build regular expression list.
467 if (open(my $spelling, '<', $spelling_file)) {
468 while (<$spelling>) {
471 $line =~ s/\s*\n?$//g;
474 next if ($line =~ m/^\s*#/);
475 next if ($line =~ m/^\s*$/);
477 my ($suspect, $fix) = split(/\|\|/, $line);
479 $spelling_fix{$suspect} = $fix;
483 warn "No typos will be found - file '$spelling_file': $!\n";
487 if (open(my $spelling, '<', $codespellfile)) {
488 while (<$spelling>) {
491 $line =~ s/\s*\n?$//g;
494 next if ($line =~ m/^\s*#/);
495 next if ($line =~ m/^\s*$/);
496 next if ($line =~ m/, disabled/i);
500 my ($suspect, $fix) = split(/->/, $line);
502 $spelling_fix{$suspect} = $fix;
506 warn "No codespell typos will be found - file '$codespellfile': $!\n";
510 $misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
513 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
514 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
515 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
516 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
517 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
519 (?:$typeOtherOSTypedefs\b)|
524 (?:$Modifier\s+|const\s+)*
526 (?:typeof|__typeof__)\s*\([^\)]*\)|
527 (?:$typeOtherOSTypedefs\b)|
531 (?:\s+$Modifier|\s+const)*
533 $NonptrTypeMisordered = qr{
534 (?:$Modifier\s+|const\s+)*
538 (?:\s+$Modifier|\s+const)*
540 $NonptrTypeWithAttr = qr{
541 (?:$Modifier\s+|const\s+)*
543 (?:typeof|__typeof__)\s*\([^\)]*\)|
545 (?:$typeOtherOSTypedefs\b)|
548 (?:\s+$Modifier|\s+const)*
552 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
553 (?:\s+$Inline|\s+$Modifier)*
555 $TypeMisordered = qr{
556 $NonptrTypeMisordered
557 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
558 (?:\s+$Inline|\s+$Modifier)*
560 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
561 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
565 our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
567 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
568 # requires at least perl version v5.10.0
569 # Any use must be runtime checked with $^V
571 our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
572 our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
573 our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
575 our $declaration_macros = qr{(?x:
576 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,2}\s*\(|
577 (?:$Storage\s+)?LIST_HEAD\s*\(|
578 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
583 return "" if (!defined($string));
585 while ($string =~ /^\s*\(.*\)\s*$/) {
586 $string =~ s@^\s*\(\s*@@;
587 $string =~ s@\s*\)\s*$@@;
590 $string =~ s@\s+@ @g;
595 sub seed_camelcase_file {
598 return if (!(-f $file));
602 open(my $include_file, '<', "$file")
603 or warn "$P: Can't read '$file' $!\n";
604 my $text = <$include_file>;
605 close($include_file);
607 my @lines = split('\n', $text);
609 foreach my $line (@lines) {
610 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
611 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
613 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
615 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
621 my $camelcase_seeded = 0;
622 sub seed_camelcase_includes {
623 return if ($camelcase_seeded);
626 my $camelcase_cache = "";
627 my @include_files = ();
629 $camelcase_seeded = 1;
632 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
633 chomp $git_last_include_commit;
634 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
636 my $last_mod_date = 0;
637 $files = `find $root/include -name "*.h"`;
638 @include_files = split('\n', $files);
639 foreach my $file (@include_files) {
640 my $date = POSIX::strftime("%Y%m%d%H%M",
641 localtime((stat $file)[9]));
642 $last_mod_date = $date if ($last_mod_date < $date);
644 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
647 if ($camelcase_cache ne "" && -f $camelcase_cache) {
648 open(my $camelcase_file, '<', "$camelcase_cache")
649 or warn "$P: Can't read '$camelcase_cache' $!\n";
650 while (<$camelcase_file>) {
654 close($camelcase_file);
660 $files = `git ls-files "include/*.h"`;
661 @include_files = split('\n', $files);
664 foreach my $file (@include_files) {
665 seed_camelcase_file($file);
668 if ($camelcase_cache ne "") {
669 unlink glob ".checkpatch-camelcase.*";
670 open(my $camelcase_file, '>', "$camelcase_cache")
671 or warn "$P: Can't write '$camelcase_cache' $!\n";
672 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
673 print $camelcase_file ("$_\n");
675 close($camelcase_file);
679 sub git_commit_info {
680 my ($commit, $id, $desc) = @_;
682 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
684 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
685 $output =~ s/^\s*//gm;
686 my @lines = split("\n", $output);
688 return ($id, $desc) if ($#lines < 0);
690 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
691 # Maybe one day convert this block of bash into something that returns
692 # all matching commit ids, but it's very slow...
694 # echo "checking commits $1..."
695 # git rev-list --remotes | grep -i "^$1" |
696 # while read line ; do
697 # git log --format='%H %s' -1 $line |
698 # echo "commit $(cut -c 1-12,41-)"
700 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
702 $id = substr($lines[0], 0, 12);
703 $desc = substr($lines[0], 41);
709 $chk_signoff = 0 if ($file);
714 my @fixed_inserted = ();
715 my @fixed_deleted = ();
719 for my $filename (@ARGV) {
722 open($FILE, '-|', "diff -u /dev/null $filename") ||
723 die "$P: $filename: diff failed - $!\n";
724 } elsif ($filename eq '-') {
725 open($FILE, '<&STDIN');
727 open($FILE, '<', "$filename") ||
728 die "$P: $filename: open failed - $!\n";
730 if ($filename eq '-') {
731 $vname = 'Your patch';
740 if (!process($filename)) {
746 @fixed_inserted = ();
753 sub top_of_kernel_tree {
757 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
758 "README", "Documentation", "arch", "include", "drivers",
759 "fs", "init", "ipc", "kernel", "lib", "scripts",
762 foreach my $check (@tree_check) {
763 if (! -e $root . '/' . $check) {
771 my ($formatted_email) = @_;
777 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
780 $comment = $3 if defined $3;
781 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
783 $comment = $2 if defined $2;
784 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
786 $comment = $2 if defined $2;
787 $formatted_email =~ s/$address.*$//;
788 $name = $formatted_email;
790 $name =~ s/^\"|\"$//g;
791 # If there's a name left after stripping spaces and
792 # leading quotes, and the address doesn't have both
793 # leading and trailing angle brackets, the address
795 # "joe smith joe@smith.com" bad
796 # "joe smith <joe@smith.com" bad
797 if ($name ne "" && $address !~ /^<[^>]+>$/) {
805 $name =~ s/^\"|\"$//g;
806 $address = trim($address);
807 $address =~ s/^\<|\>$//g;
809 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
810 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
814 return ($name, $address, $comment);
818 my ($name, $address) = @_;
823 $name =~ s/^\"|\"$//g;
824 $address = trim($address);
826 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
827 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
832 $formatted_email = "$address";
834 $formatted_email = "$name <$address>";
837 return $formatted_email;
843 foreach my $path (split(/:/, $ENV{PATH})) {
844 if (-e "$path/$bin") {
855 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
856 if (-e "$path/$conf") {
857 return "$path/$conf";
869 for my $c (split(//, $str)) {
873 for (; ($n % 8) != 0; $n++) {
885 (my $res = shift) =~ tr/\t/ /c;
892 # Drop the diff line leader and expand tabs
894 $line = expand_tabs($line);
896 # Pick the indent from the front of the line.
897 my ($white) = ($line =~ /^(\s*)/);
899 return (length($line), length($white));
902 my $sanitise_quote = '';
904 sub sanitise_line_reset {
905 my ($in_comment) = @_;
908 $sanitise_quote = '*/';
910 $sanitise_quote = '';
923 # Always copy over the diff marker.
924 $res = substr($line, 0, 1);
926 for ($off = 1; $off < length($line); $off++) {
927 $c = substr($line, $off, 1);
929 # Comments we are wacking completly including the begin
930 # and end, all to $;.
931 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
932 $sanitise_quote = '*/';
934 substr($res, $off, 2, "$;$;");
938 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
939 $sanitise_quote = '';
940 substr($res, $off, 2, "$;$;");
944 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
945 $sanitise_quote = '//';
947 substr($res, $off, 2, $sanitise_quote);
952 # A \ in a string means ignore the next character.
953 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
955 substr($res, $off, 2, 'XX');
960 if ($c eq "'" || $c eq '"') {
961 if ($sanitise_quote eq '') {
962 $sanitise_quote = $c;
964 substr($res, $off, 1, $c);
966 } elsif ($sanitise_quote eq $c) {
967 $sanitise_quote = '';
971 #print "c<$c> SQ<$sanitise_quote>\n";
972 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
973 substr($res, $off, 1, $;);
974 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
975 substr($res, $off, 1, $;);
976 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
977 substr($res, $off, 1, 'X');
979 substr($res, $off, 1, $c);
983 if ($sanitise_quote eq '//') {
984 $sanitise_quote = '';
987 # The pathname on a #include may be surrounded by '<' and '>'.
988 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
989 my $clean = 'X' x length($1);
990 $res =~ s@\<.*\>@<$clean>@;
992 # The whole of a #error is a string.
993 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
994 my $clean = 'X' x length($1);
995 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
1001 sub get_quoted_string {
1002 my ($line, $rawline) = @_;
1004 return "" if ($line !~ m/(\"[X\t]+\")/g);
1005 return substr($rawline, $-[0], $+[0] - $-[0]);
1008 sub ctx_statement_block {
1009 my ($linenr, $remain, $off) = @_;
1010 my $line = $linenr - 1;
1013 my $coff = $off - 1;
1027 @stack = (['', 0]) if ($#stack == -1);
1029 #warn "CSB: blk<$blk> remain<$remain>\n";
1030 # If we are about to drop off the end, pull in more
1033 for (; $remain > 0; $line++) {
1034 last if (!defined $lines[$line]);
1035 next if ($lines[$line] =~ /^-/);
1038 $blk .= $lines[$line] . "\n";
1039 $len = length($blk);
1043 # Bail if there is no further context.
1044 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1048 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1054 $c = substr($blk, $off, 1);
1055 $remainder = substr($blk, $off);
1057 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1059 # Handle nested #if/#else.
1060 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1061 push(@stack, [ $type, $level ]);
1062 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1063 ($type, $level) = @{$stack[$#stack - 1]};
1064 } elsif ($remainder =~ /^#\s*endif\b/) {
1065 ($type, $level) = @{pop(@stack)};
1068 # Statement ends at the ';' or a close '}' at the
1070 if ($level == 0 && $c eq ';') {
1074 # An else is really a conditional as long as its not else if
1075 if ($level == 0 && $coff_set == 0 &&
1076 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1077 $remainder =~ /^(else)(?:\s|{)/ &&
1078 $remainder !~ /^else\s+if\b/) {
1079 $coff = $off + length($1) - 1;
1081 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1082 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1085 if (($type eq '' || $type eq '(') && $c eq '(') {
1089 if ($type eq '(' && $c eq ')') {
1091 $type = ($level != 0)? '(' : '';
1093 if ($level == 0 && $coff < $soff) {
1096 #warn "CSB: mark coff<$coff>\n";
1099 if (($type eq '' || $type eq '{') && $c eq '{') {
1103 if ($type eq '{' && $c eq '}') {
1105 $type = ($level != 0)? '{' : '';
1108 if (substr($blk, $off + 1, 1) eq ';') {
1114 # Preprocessor commands end at the newline unless escaped.
1115 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1123 # We are truly at the end, so shuffle to the next line.
1130 my $statement = substr($blk, $soff, $off - $soff + 1);
1131 my $condition = substr($blk, $soff, $coff - $soff + 1);
1133 #warn "STATEMENT<$statement>\n";
1134 #warn "CONDITION<$condition>\n";
1136 #print "coff<$coff> soff<$off> loff<$loff>\n";
1138 return ($statement, $condition,
1139 $line, $remain + 1, $off - $loff + 1, $level);
1142 sub statement_lines {
1145 # Strip the diff line prefixes and rip blank lines at start and end.
1146 $stmt =~ s/(^|\n)./$1/g;
1150 my @stmt_lines = ($stmt =~ /\n/g);
1152 return $#stmt_lines + 2;
1155 sub statement_rawlines {
1158 my @stmt_lines = ($stmt =~ /\n/g);
1160 return $#stmt_lines + 2;
1163 sub statement_block_size {
1166 $stmt =~ s/(^|\n)./$1/g;
1172 my @stmt_lines = ($stmt =~ /\n/g);
1173 my @stmt_statements = ($stmt =~ /;/g);
1175 my $stmt_lines = $#stmt_lines + 2;
1176 my $stmt_statements = $#stmt_statements + 1;
1178 if ($stmt_lines > $stmt_statements) {
1181 return $stmt_statements;
1185 sub ctx_statement_full {
1186 my ($linenr, $remain, $off) = @_;
1187 my ($statement, $condition, $level);
1191 # Grab the first conditional/block pair.
1192 ($statement, $condition, $linenr, $remain, $off, $level) =
1193 ctx_statement_block($linenr, $remain, $off);
1194 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1195 push(@chunks, [ $condition, $statement ]);
1196 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1197 return ($level, $linenr, @chunks);
1200 # Pull in the following conditional/block pairs and see if they
1201 # could continue the statement.
1203 ($statement, $condition, $linenr, $remain, $off, $level) =
1204 ctx_statement_block($linenr, $remain, $off);
1205 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1206 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1208 push(@chunks, [ $condition, $statement ]);
1211 return ($level, $linenr, @chunks);
1215 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1217 my $start = $linenr - 1;
1224 my @stack = ($level);
1225 for ($line = $start; $remain > 0; $line++) {
1226 next if ($rawlines[$line] =~ /^-/);
1229 $blk .= $rawlines[$line];
1231 # Handle nested #if/#else.
1232 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1233 push(@stack, $level);
1234 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1235 $level = $stack[$#stack - 1];
1236 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1237 $level = pop(@stack);
1240 foreach my $c (split(//, $lines[$line])) {
1241 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1247 if ($c eq $close && $level > 0) {
1249 last if ($level == 0);
1250 } elsif ($c eq $open) {
1255 if (!$outer || $level <= 1) {
1256 push(@res, $rawlines[$line]);
1259 last if ($level == 0);
1262 return ($level, @res);
1264 sub ctx_block_outer {
1265 my ($linenr, $remain) = @_;
1267 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1271 my ($linenr, $remain) = @_;
1273 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1277 my ($linenr, $remain, $off) = @_;
1279 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1282 sub ctx_block_level {
1283 my ($linenr, $remain) = @_;
1285 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1287 sub ctx_statement_level {
1288 my ($linenr, $remain, $off) = @_;
1290 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1293 sub ctx_locate_comment {
1294 my ($first_line, $end_line) = @_;
1296 # Catch a comment on the end of the line itself.
1297 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1298 return $current_comment if (defined $current_comment);
1300 # Look through the context and try and figure out if there is a
1303 $current_comment = '';
1304 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1305 my $line = $rawlines[$linenr - 1];
1307 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1310 if ($line =~ m@/\*@) {
1313 if (!$in_comment && $current_comment ne '') {
1314 $current_comment = '';
1316 $current_comment .= $line . "\n" if ($in_comment);
1317 if ($line =~ m@\*/@) {
1322 chomp($current_comment);
1323 return($current_comment);
1325 sub ctx_has_comment {
1326 my ($first_line, $end_line) = @_;
1327 my $cmt = ctx_locate_comment($first_line, $end_line);
1329 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1330 ##print "CMMT: $cmt\n";
1332 return ($cmt ne '');
1336 my ($linenr, $cnt) = @_;
1338 my $offset = $linenr - 1;
1343 $line = $rawlines[$offset++];
1344 next if (defined($line) && $line =~ /^-/);
1356 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1359 $coded = sprintf("^%c", unpack('C', $2) + 64);
1368 my $av_preprocessor = 0;
1373 sub annotate_reset {
1374 $av_preprocessor = 0;
1376 @av_paren_type = ('E');
1377 $av_pend_colon = 'O';
1380 sub annotate_values {
1381 my ($stream, $type) = @_;
1384 my $var = '_' x length($stream);
1387 print "$stream\n" if ($dbg_values > 1);
1389 while (length($cur)) {
1390 @av_paren_type = ('E') if ($#av_paren_type < 0);
1391 print " <" . join('', @av_paren_type) .
1392 "> <$type> <$av_pending>" if ($dbg_values > 1);
1393 if ($cur =~ /^(\s+)/o) {
1394 print "WS($1)\n" if ($dbg_values > 1);
1395 if ($1 =~ /\n/ && $av_preprocessor) {
1396 $type = pop(@av_paren_type);
1397 $av_preprocessor = 0;
1400 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1401 print "CAST($1)\n" if ($dbg_values > 1);
1402 push(@av_paren_type, $type);
1405 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1406 print "DECLARE($1)\n" if ($dbg_values > 1);
1409 } elsif ($cur =~ /^($Modifier)\s*/) {
1410 print "MODIFIER($1)\n" if ($dbg_values > 1);
1413 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1414 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1415 $av_preprocessor = 1;
1416 push(@av_paren_type, $type);
1422 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1423 print "UNDEF($1)\n" if ($dbg_values > 1);
1424 $av_preprocessor = 1;
1425 push(@av_paren_type, $type);
1427 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1428 print "PRE_START($1)\n" if ($dbg_values > 1);
1429 $av_preprocessor = 1;
1431 push(@av_paren_type, $type);
1432 push(@av_paren_type, $type);
1435 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1436 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1437 $av_preprocessor = 1;
1439 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1443 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1444 print "PRE_END($1)\n" if ($dbg_values > 1);
1446 $av_preprocessor = 1;
1448 # Assume all arms of the conditional end as this
1449 # one does, and continue as if the #endif was not here.
1450 pop(@av_paren_type);
1451 push(@av_paren_type, $type);
1454 } elsif ($cur =~ /^(\\\n)/o) {
1455 print "PRECONT($1)\n" if ($dbg_values > 1);
1457 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1458 print "ATTR($1)\n" if ($dbg_values > 1);
1459 $av_pending = $type;
1462 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1463 print "SIZEOF($1)\n" if ($dbg_values > 1);
1469 } elsif ($cur =~ /^(if|while|for)\b/o) {
1470 print "COND($1)\n" if ($dbg_values > 1);
1474 } elsif ($cur =~/^(case)/o) {
1475 print "CASE($1)\n" if ($dbg_values > 1);
1476 $av_pend_colon = 'C';
1479 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1480 print "KEYWORD($1)\n" if ($dbg_values > 1);
1483 } elsif ($cur =~ /^(\()/o) {
1484 print "PAREN('$1')\n" if ($dbg_values > 1);
1485 push(@av_paren_type, $av_pending);
1489 } elsif ($cur =~ /^(\))/o) {
1490 my $new_type = pop(@av_paren_type);
1491 if ($new_type ne '_') {
1493 print "PAREN('$1') -> $type\n"
1494 if ($dbg_values > 1);
1496 print "PAREN('$1')\n" if ($dbg_values > 1);
1499 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1500 print "FUNC($1)\n" if ($dbg_values > 1);
1504 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1505 if (defined $2 && $type eq 'C' || $type eq 'T') {
1506 $av_pend_colon = 'B';
1507 } elsif ($type eq 'E') {
1508 $av_pend_colon = 'L';
1510 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1513 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1514 print "IDENT($1)\n" if ($dbg_values > 1);
1517 } elsif ($cur =~ /^($Assignment)/o) {
1518 print "ASSIGN($1)\n" if ($dbg_values > 1);
1521 } elsif ($cur =~/^(;|{|})/) {
1522 print "END($1)\n" if ($dbg_values > 1);
1524 $av_pend_colon = 'O';
1526 } elsif ($cur =~/^(,)/) {
1527 print "COMMA($1)\n" if ($dbg_values > 1);
1530 } elsif ($cur =~ /^(\?)/o) {
1531 print "QUESTION($1)\n" if ($dbg_values > 1);
1534 } elsif ($cur =~ /^(:)/o) {
1535 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1537 substr($var, length($res), 1, $av_pend_colon);
1538 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1543 $av_pend_colon = 'O';
1545 } elsif ($cur =~ /^(\[)/o) {
1546 print "CLOSE($1)\n" if ($dbg_values > 1);
1549 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1552 print "OPV($1)\n" if ($dbg_values > 1);
1559 substr($var, length($res), 1, $variant);
1562 } elsif ($cur =~ /^($Operators)/o) {
1563 print "OP($1)\n" if ($dbg_values > 1);
1564 if ($1 ne '++' && $1 ne '--') {
1568 } elsif ($cur =~ /(^.)/o) {
1569 print "C($1)\n" if ($dbg_values > 1);
1572 $cur = substr($cur, length($1));
1573 $res .= $type x length($1);
1577 return ($res, $var);
1581 my ($possible, $line) = @_;
1582 my $notPermitted = qr{(?:
1599 ^(?:typedef|struct|enum)\b
1601 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1602 if ($possible !~ $notPermitted) {
1603 # Check for modifiers.
1604 $possible =~ s/\s*$Storage\s*//g;
1605 $possible =~ s/\s*$Sparse\s*//g;
1606 if ($possible =~ /^\s*$/) {
1608 } elsif ($possible =~ /\s/) {
1609 $possible =~ s/\s*$Type\s*//g;
1610 for my $modifier (split(' ', $possible)) {
1611 if ($modifier !~ $notPermitted) {
1612 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1613 push(@modifierList, $modifier);
1618 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1619 push(@typeList, $possible);
1623 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1632 return defined $use_type{$type} if (scalar keys %use_type > 0);
1634 return !defined $ignore_type{$type};
1638 my ($level, $type, $msg) = @_;
1640 if (!show_type($type) ||
1641 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
1646 $line = "$prefix$level:$type: $msg\n";
1648 $line = "$prefix$level: $msg\n";
1650 $line = (split('\n', $line))[0] . "\n" if ($terse);
1652 push(our @report, $line);
1661 sub fixup_current_range {
1662 my ($lineRef, $offset, $length) = @_;
1664 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1667 my $no = $o + $offset;
1668 my $nl = $l + $length;
1669 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1673 sub fix_inserted_deleted_lines {
1674 my ($linesRef, $insertedRef, $deletedRef) = @_;
1676 my $range_last_linenr = 0;
1677 my $delta_offset = 0;
1682 my $next_insert = 0;
1683 my $next_delete = 0;
1687 my $inserted = @{$insertedRef}[$next_insert++];
1688 my $deleted = @{$deletedRef}[$next_delete++];
1690 foreach my $old_line (@{$linesRef}) {
1692 my $line = $old_line; #don't modify the array
1693 if ($line =~ /^(?:\+\+\+\|\-\-\-)\s+\S+/) { #new filename
1695 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1696 $range_last_linenr = $new_linenr;
1697 fixup_current_range(\$line, $delta_offset, 0);
1700 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1701 $deleted = @{$deletedRef}[$next_delete++];
1703 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1706 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1707 push(@lines, ${$inserted}{'LINE'});
1708 $inserted = @{$insertedRef}[$next_insert++];
1710 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1714 push(@lines, $line);
1724 sub fix_insert_line {
1725 my ($linenr, $line) = @_;
1731 push(@fixed_inserted, $inserted);
1734 sub fix_delete_line {
1735 my ($linenr, $line) = @_;
1742 push(@fixed_deleted, $deleted);
1746 my ($type, $msg) = @_;
1748 if (report("ERROR", $type, $msg)) {
1756 my ($type, $msg) = @_;
1758 if (report("WARNING", $type, $msg)) {
1766 my ($type, $msg) = @_;
1768 if ($check && report("CHECK", $type, $msg)) {
1776 sub check_absolute_file {
1777 my ($absolute, $herecurr) = @_;
1778 my $file = $absolute;
1780 ##print "absolute<$absolute>\n";
1782 # See if any suffix of this path is a path within the tree.
1783 while ($file =~ s@^[^/]*/@@) {
1784 if (-f "$root/$file") {
1785 ##print "file<$file>\n";
1793 # It is, so see if the prefix is acceptable.
1794 my $prefix = $absolute;
1795 substr($prefix, -length($file)) = '';
1797 ##print "prefix<$prefix>\n";
1798 if ($prefix ne ".../") {
1799 WARN("USE_RELATIVE_PATH",
1800 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1807 $string =~ s/^\s+|\s+$//g;
1815 $string =~ s/^\s+//;
1823 $string =~ s/\s+$//;
1828 sub string_find_replace {
1829 my ($string, $find, $replace) = @_;
1831 $string =~ s/$find/$replace/g;
1839 my $source_indent = 8;
1840 my $max_spaces_before_tab = $source_indent - 1;
1841 my $spaces_to_tab = " " x $source_indent;
1843 #convert leading spaces to tabs
1844 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1845 #Remove spaces before a tab
1846 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1851 sub pos_last_openparen {
1856 my $opens = $line =~ tr/\(/\(/;
1857 my $closes = $line =~ tr/\)/\)/;
1859 my $last_openparen = 0;
1861 if (($opens == 0) || ($closes >= $opens)) {
1865 my $len = length($line);
1867 for ($pos = 0; $pos < $len; $pos++) {
1868 my $string = substr($line, $pos);
1869 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1870 $pos += length($1) - 1;
1871 } elsif (substr($line, $pos, 1) eq '(') {
1872 $last_openparen = $pos;
1873 } elsif (index($string, '(') == -1) {
1878 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
1882 my $filename = shift;
1888 my $stashrawline="";
1899 my $in_header_lines = $file ? 0 : 1;
1900 my $in_commit_log = 0; #Scanning lines before patch
1901 my $commit_log_long_line = 0;
1902 my $reported_maintainer_file = 0;
1903 my $non_utf8_charset = 0;
1905 my $last_blank_line = 0;
1906 my $last_coalesced_string_linenr = -1;
1914 # Trace the real file/line as we go.
1920 my $comment_edge = 0;
1924 my $prev_values = 'E';
1927 my %suppress_ifbraces;
1928 my %suppress_whiletrailers;
1929 my %suppress_export;
1930 my $suppress_statement = 0;
1932 my %signatures = ();
1934 # Pre-scan the patch sanitizing the lines.
1935 # Pre-scan the patch looking for any __setup documentation.
1937 my @setup_docs = ();
1940 my $camelcase_file_seeded = 0;
1942 sanitise_line_reset();
1944 foreach my $rawline (@rawlines) {
1948 push(@fixed, $rawline) if ($fix);
1950 if ($rawline=~/^\+\+\+\s+(\S+)/) {
1952 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1957 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1966 # Guestimate if this is a continuing comment. Run
1967 # the context looking for a comment "edge". If this
1968 # edge is a close comment then we must be in a comment
1972 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1973 next if (defined $rawlines[$ln - 1] &&
1974 $rawlines[$ln - 1] =~ /^-/);
1976 #print "RAW<$rawlines[$ln - 1]>\n";
1977 last if (!defined $rawlines[$ln - 1]);
1978 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1979 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1984 if (defined $edge && $edge eq '*/') {
1988 # Guestimate if this is a continuing comment. If this
1989 # is the start of a diff block and this line starts
1990 # ' *' then it is very likely a comment.
1991 if (!defined $edge &&
1992 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1997 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1998 sanitise_line_reset($in_comment);
2000 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
2001 # Standardise the strings and chars within the input to
2002 # simplify matching -- only bother with positive lines.
2003 $line = sanitise_line($rawline);
2005 push(@lines, $line);
2008 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2013 #print "==>$rawline\n";
2014 #print "-->$line\n";
2016 if ($setup_docs && $line =~ /^\+/) {
2017 push(@setup_docs, $line);
2026 foreach my $line (@lines) {
2029 my $sline = $line; #copy of $line
2030 $sline =~ s/$;/ /g; #with comments as spaces
2032 my $rawline = $rawlines[$linenr - 1];
2034 #extract the line range in the file after the patch is applied
2035 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2037 $first_line = $linenr + 1;
2047 %suppress_ifbraces = ();
2048 %suppress_whiletrailers = ();
2049 %suppress_export = ();
2050 $suppress_statement = 0;
2053 # track the line number as we move through the hunk, note that
2054 # new versions of GNU diff omit the leading space on completely
2055 # blank context lines so we need to count that too.
2056 } elsif ($line =~ /^( |\+|$)/) {
2058 $realcnt-- if ($realcnt != 0);
2060 # Measure the line length and indent.
2061 ($length, $indent) = line_stats($rawline);
2063 # Track the previous line.
2064 ($prevline, $stashline) = ($stashline, $line);
2065 ($previndent, $stashindent) = ($stashindent, $indent);
2066 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2068 #warn "line<$line>\n";
2070 } elsif ($realcnt == 1) {
2074 my $hunk_line = ($realcnt != 0);
2076 #make up the handle for any error we report on this line
2077 $prefix = "$filename:$realline: " if ($emacs && $file);
2078 $prefix = "$filename:$linenr: " if ($emacs && !$file);
2080 $here = "#$linenr: " if (!$file);
2081 $here = "#$realline: " if ($file);
2084 # extract the filename as it passes
2085 if ($line =~ /^diff --git.*?(\S+)$/) {
2087 $realfile =~ s@^([^/]*)/@@ if (!$file);
2090 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2092 $realfile =~ s@^([^/]*)/@@ if (!$file);
2096 if (!$file && $tree && $p1_prefix ne '' &&
2097 -e "$root/$p1_prefix") {
2098 WARN("PATCH_PREFIX",
2099 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
2102 if ($realfile =~ m@^include/asm/@) {
2103 ERROR("MODIFIED_INCLUDE_ASM",
2104 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2110 if ($realfile =~ m@^(drivers/net/|net/)@) {
2113 $check = $check_orig;
2118 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
2120 my $hereline = "$here\n$rawline\n";
2121 my $herecurr = "$here\n$rawline\n";
2122 my $hereprev = "$here\n$prevrawline\n$rawline\n";
2124 $cnt_lines++ if ($realcnt != 0);
2126 # Check for incorrect file permissions
2127 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2128 my $permhere = $here . "FILE: $realfile\n";
2129 if ($realfile !~ m@scripts/@ &&
2130 $realfile !~ /\.(py|pl|awk|sh)$/) {
2131 ERROR("EXECUTE_PERMISSIONS",
2132 "do not set execute permissions for source files\n" . $permhere);
2136 # Check the patch for a signoff:
2137 if ($line =~ /^\s*signed-off-by:/i) {
2142 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2143 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2144 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2145 $reported_maintainer_file = 1;
2148 # Check signature styles
2149 if (!$in_header_lines &&
2150 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
2151 my $space_before = $1;
2153 my $space_after = $3;
2155 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2157 if ($sign_off !~ /$signature_tags/) {
2158 WARN("BAD_SIGN_OFF",
2159 "Non-standard signature: $sign_off\n" . $herecurr);
2161 if (defined $space_before && $space_before ne "") {
2162 if (WARN("BAD_SIGN_OFF",
2163 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2165 $fixed[$fixlinenr] =
2166 "$ucfirst_sign_off $email";
2169 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
2170 if (WARN("BAD_SIGN_OFF",
2171 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2173 $fixed[$fixlinenr] =
2174 "$ucfirst_sign_off $email";
2178 if (!defined $space_after || $space_after ne " ") {
2179 if (WARN("BAD_SIGN_OFF",
2180 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2182 $fixed[$fixlinenr] =
2183 "$ucfirst_sign_off $email";
2187 my ($email_name, $email_address, $comment) = parse_email($email);
2188 my $suggested_email = format_email(($email_name, $email_address));
2189 if ($suggested_email eq "") {
2190 ERROR("BAD_SIGN_OFF",
2191 "Unrecognized email address: '$email'\n" . $herecurr);
2193 my $dequoted = $suggested_email;
2194 $dequoted =~ s/^"//;
2195 $dequoted =~ s/" </ </;
2196 # Don't force email to have quotes
2197 # Allow just an angle bracketed address
2198 if ("$dequoted$comment" ne $email &&
2199 "<$email_address>$comment" ne $email &&
2200 "$suggested_email$comment" ne $email) {
2201 WARN("BAD_SIGN_OFF",
2202 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
2206 # Check for duplicate signatures
2207 my $sig_nospace = $line;
2208 $sig_nospace =~ s/\s//g;
2209 $sig_nospace = lc($sig_nospace);
2210 if (defined $signatures{$sig_nospace}) {
2211 WARN("BAD_SIGN_OFF",
2212 "Duplicate signature\n" . $herecurr);
2214 $signatures{$sig_nospace} = 1;
2218 # Check email subject for common tools that don't need to be mentioned
2219 if ($in_header_lines &&
2220 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2221 WARN("EMAIL_SUBJECT",
2222 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2225 # Check for old stable address
2226 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2227 ERROR("STABLE_ADDRESS",
2228 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2231 # Check for unwanted Gerrit info
2232 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2233 ERROR("GERRIT_CHANGE_ID",
2234 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2237 # Check for line lengths > 75 in commit log, warn once
2238 if ($in_commit_log && !$commit_log_long_line &&
2239 length($line) > 75) {
2240 WARN("COMMIT_LOG_LONG_LINE",
2241 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2242 $commit_log_long_line = 1;
2245 # Check for git id commit length and improperly formed commit descriptions
2246 if ($in_commit_log && $line =~ /\b(c)ommit\s+([0-9a-f]{5,})/i) {
2248 my $orig_commit = lc($2);
2255 my $id = '0123456789ab';
2256 my $orig_desc = "commit description";
2257 my $description = "";
2259 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2260 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2261 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2262 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2263 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2266 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2267 defined $rawlines[$linenr] &&
2268 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2271 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2272 defined $rawlines[$linenr] &&
2273 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2274 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2276 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2277 $orig_desc .= " " . $1;
2281 ($id, $description) = git_commit_info($orig_commit,
2284 if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) {
2285 ERROR("GIT_COMMIT_ID",
2286 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2290 # Check for added, moved or deleted files
2291 if (!$reported_maintainer_file && !$in_commit_log &&
2292 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2293 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2294 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2295 (defined($1) || defined($2))))) {
2296 $reported_maintainer_file = 1;
2297 WARN("FILE_PATH_CHANGES",
2298 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2301 # Check for wrappage within a valid hunk of the file
2302 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
2303 ERROR("CORRUPTED_PATCH",
2304 "patch seems to be corrupt (line wrapped?)\n" .
2305 $herecurr) if (!$emitted_corrupt++);
2308 # Check for absolute kernel paths.
2310 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2313 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2314 check_absolute_file($1, $herecurr)) {
2317 check_absolute_file($file, $herecurr);
2322 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2323 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
2324 $rawline !~ m/^$UTF8*$/) {
2325 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2327 my $blank = copy_spacing($rawline);
2328 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2329 my $hereptr = "$hereline$ptr\n";
2332 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
2335 # Check if it's the start of a commit log
2336 # (not a header line and we haven't seen the patch filename)
2337 if ($in_header_lines && $realfile =~ /^$/ &&
2338 !($rawline =~ /^\s+\S/ ||
2339 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
2340 $in_header_lines = 0;
2344 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2345 # declined it, i.e defined some charset where it is missing.
2346 if ($in_header_lines &&
2347 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2349 $non_utf8_charset = 1;
2352 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
2353 $rawline =~ /$NON_ASCII_UTF8/) {
2354 WARN("UTF8_BEFORE_PATCH",
2355 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2358 # Check for various typo / spelling mistakes
2359 if (defined($misspellings) &&
2360 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
2361 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
2363 my $typo_fix = $spelling_fix{lc($typo)};
2364 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2365 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2366 my $msg_type = \&WARN;
2367 $msg_type = \&CHK if ($file);
2368 if (&{$msg_type}("TYPO_SPELLING",
2369 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2371 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2376 # ignore non-hunk lines and lines being removed
2377 next if (!$hunk_line || $line =~ /^-/);
2379 #trailing whitespace
2380 if ($line =~ /^\+.*\015/) {
2381 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2382 if (ERROR("DOS_LINE_ENDINGS",
2383 "DOS line endings\n" . $herevet) &&
2385 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
2387 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2388 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2389 if (ERROR("TRAILING_WHITESPACE",
2390 "trailing whitespace\n" . $herevet) &&
2392 $fixed[$fixlinenr] =~ s/\s+$//;
2398 # Check for FSF mailing addresses.
2399 if ($rawline =~ /\bwrite to the Free/i ||
2400 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2401 $rawline =~ /\b51\s+Franklin\s+St/i) {
2402 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2403 my $msg_type = \&ERROR;
2404 $msg_type = \&CHK if ($file);
2405 &{$msg_type}("FSF_MAILING_ADDRESS",
2406 "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)
2409 # check for Kconfig help text having a real description
2410 # Only applies when adding the entry originally, after that we do not have
2411 # sufficient context to determine whether it is indeed long enough.
2412 if ($realfile =~ /Kconfig/ &&
2413 $line =~ /^\+\s*config\s+/) {
2416 my $ln = $linenr + 1;
2420 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
2421 $f = $lines[$ln - 1];
2422 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2423 $is_end = $lines[$ln - 1] =~ /^\+/;
2425 next if ($f =~ /^-/);
2426 last if (!$file && $f =~ /^\@\@/);
2428 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
2430 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
2437 next if ($f =~ /^$/);
2438 if ($f =~ /^\s*config\s/) {
2444 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2445 WARN("CONFIG_DESCRIPTION",
2446 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2448 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2451 # discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2452 if ($realfile =~ /Kconfig/ &&
2453 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2454 WARN("CONFIG_EXPERIMENTAL",
2455 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2458 # discourage the use of boolean for type definition attributes of Kconfig options
2459 if ($realfile =~ /Kconfig/ &&
2460 $line =~ /^\+\s*\bboolean\b/) {
2461 WARN("CONFIG_TYPE_BOOLEAN",
2462 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2465 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2466 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2469 'EXTRA_AFLAGS' => 'asflags-y',
2470 'EXTRA_CFLAGS' => 'ccflags-y',
2471 'EXTRA_CPPFLAGS' => 'cppflags-y',
2472 'EXTRA_LDFLAGS' => 'ldflags-y',
2475 WARN("DEPRECATED_VARIABLE",
2476 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2479 # check for DT compatible documentation
2480 if (defined $root &&
2481 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2482 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2484 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2486 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2487 my $vp_file = $dt_path . "vendor-prefixes.txt";
2489 foreach my $compat (@compats) {
2490 my $compat2 = $compat;
2491 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2492 my $compat3 = $compat;
2493 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2494 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
2496 WARN("UNDOCUMENTED_DT_STRING",
2497 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2500 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2502 `grep -Eq "^$vendor\\b" $vp_file`;
2504 WARN("UNDOCUMENTED_DT_STRING",
2505 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2510 # check we are in a valid source file if not then ignore this hunk
2511 next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/);
2514 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
2515 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
2516 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?$String\s*(?:|,|\)\s*;)\s*$/ ||
2517 $line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2518 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) &&
2519 $length > $max_line_length)
2522 "line over $max_line_length characters\n" . $herecurr);
2525 # check for adding lines without a newline.
2526 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2527 WARN("MISSING_EOF_NEWLINE",
2528 "adding a line without newline at end of file\n" . $herecurr);
2531 # Blackfin: use hi/lo macros
2532 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2533 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2534 my $herevet = "$here\n" . cat_vet($line) . "\n";
2536 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
2538 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2539 my $herevet = "$here\n" . cat_vet($line) . "\n";
2541 "use the HI() macro, not (... >> 16)\n" . $herevet);
2545 # check we are in a valid source file C or perl if not then ignore this hunk
2546 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
2548 # at the beginning of a line any tabs must come first and anything
2549 # more than 8 must use tabs.
2550 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2551 $rawline =~ /^\+\s* \s*/) {
2552 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2554 if (ERROR("CODE_INDENT",
2555 "code indent should use tabs where possible\n" . $herevet) &&
2557 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2561 # check for space before tabs.
2562 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2563 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2564 if (WARN("SPACE_BEFORE_TAB",
2565 "please, no space before tabs\n" . $herevet) &&
2567 while ($fixed[$fixlinenr] =~
2568 s/(^\+.*) {8,8}\t/$1\t\t/) {}
2569 while ($fixed[$fixlinenr] =~
2570 s/(^\+.*) +\t/$1\t/) {}
2574 # check for && or || at the start of a line
2575 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2576 CHK("LOGICAL_CONTINUATIONS",
2577 "Logical continuations should be on the previous line\n" . $hereprev);
2580 # check multi-line statement indentation matches previous line
2581 if ($^V && $^V ge 5.10.0 &&
2582 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2583 $prevline =~ /^\+(\t*)(.*)$/;
2587 my $pos = pos_last_openparen($rest);
2589 $line =~ /^(\+| )([ \t]*)/;
2592 my $goodtabindent = $oldindent .
2595 my $goodspaceindent = $oldindent . " " x $pos;
2597 if ($newindent ne $goodtabindent &&
2598 $newindent ne $goodspaceindent) {
2600 if (CHK("PARENTHESIS_ALIGNMENT",
2601 "Alignment should match open parenthesis\n" . $hereprev) &&
2602 $fix && $line =~ /^\+/) {
2603 $fixed[$fixlinenr] =~
2604 s/^\+[ \t]*/\+$goodtabindent/;
2610 # check for space after cast like "(int) foo" or "(struct foo) bar"
2611 # avoid checking a few false positives:
2612 # "sizeof(<type>)" or "__alignof__(<type>)"
2613 # function pointer declarations like "(*foo)(int) = bar;"
2614 # structure definitions like "(struct foo) { 0 };"
2615 # multiline macros that define functions
2616 # known attributes or the __attribute__ keyword
2617 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
2618 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
2620 "No space is necessary after a cast\n" . $herecurr) &&
2622 $fixed[$fixlinenr] =~
2623 s/(\(\s*$Type\s*\))[ \t]+/$1/;
2627 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2628 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
2629 $rawline =~ /^\+[ \t]*\*/ &&
2631 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2632 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2635 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2636 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2637 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
2638 $rawline =~ /^\+/ && #line is new
2639 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2640 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2641 "networking block comments start with * on subsequent lines\n" . $hereprev);
2644 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2645 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2646 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2647 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2648 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
2649 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2650 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2653 # check for missing blank lines after struct/union declarations
2654 # with exceptions for various attributes and macros
2655 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2657 !($line =~ /^\+\s*$/ ||
2658 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2659 $line =~ /^\+\s*MODULE_/i ||
2660 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2661 $line =~ /^\+[a-z_]*init/ ||
2662 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2663 $line =~ /^\+\s*DECLARE/ ||
2664 $line =~ /^\+\s*__setup/)) {
2665 if (CHK("LINE_SPACING",
2666 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
2668 fix_insert_line($fixlinenr, "\+");
2672 # check for multiple consecutive blank lines
2673 if ($prevline =~ /^[\+ ]\s*$/ &&
2674 $line =~ /^\+\s*$/ &&
2675 $last_blank_line != ($linenr - 1)) {
2676 if (CHK("LINE_SPACING",
2677 "Please don't use multiple blank lines\n" . $hereprev) &&
2679 fix_delete_line($fixlinenr, $rawline);
2682 $last_blank_line = $linenr;
2685 # check for missing blank lines after declarations
2686 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2687 # actual declarations
2688 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2689 # function pointer declarations
2690 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2691 # foo bar; where foo is some local typedef or #define
2692 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2693 # known declaration macros
2694 $prevline =~ /^\+\s+$declaration_macros/) &&
2695 # for "else if" which can look like "$Ident $Ident"
2696 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2697 # other possible extensions of declaration lines
2698 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2699 # not starting a section or a macro "\" extended line
2700 $prevline =~ /(?:\{\s*|\\)$/) &&
2701 # looks like a declaration
2702 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2703 # function pointer declarations
2704 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2705 # foo bar; where foo is some local typedef or #define
2706 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2707 # known declaration macros
2708 $sline =~ /^\+\s+$declaration_macros/ ||
2709 # start of struct or union or enum
2710 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
2711 # start or end of block or continuation of declaration
2712 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
2713 # bitfield continuation
2714 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
2715 # other possible extensions of declaration lines
2716 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
2717 # indentation of previous and current line are the same
2718 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
2719 if (WARN("LINE_SPACING",
2720 "Missing a blank line after declarations\n" . $hereprev) &&
2722 fix_insert_line($fixlinenr, "\+");
2726 # check for spaces at the beginning of a line.
2728 # 1) within comments
2729 # 2) indented preprocessor commands
2731 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
2732 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2733 if (WARN("LEADING_SPACE",
2734 "please, no spaces at the start of a line\n" . $herevet) &&
2736 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2740 # check we are in a valid C source file if not then ignore this hunk
2741 next if ($realfile !~ /\.(h|c)$/);
2743 # check indentation of any line with a bare else
2744 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
2745 # if the previous line is a break or return and is indented 1 tab more...
2746 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
2747 my $tabs = length($1) + 1;
2748 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
2749 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
2750 defined $lines[$linenr] &&
2751 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
2752 WARN("UNNECESSARY_ELSE",
2753 "else is not generally useful after a break or return\n" . $hereprev);
2757 # check indentation of a line with a break;
2758 # if the previous line is a goto or return and is indented the same # of tabs
2759 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
2761 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
2762 WARN("UNNECESSARY_BREAK",
2763 "break is not useful after a goto or return\n" . $hereprev);
2767 # discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2768 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2769 WARN("CONFIG_EXPERIMENTAL",
2770 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2773 # check for RCS/CVS revision markers
2774 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
2776 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
2779 # Blackfin: don't use __builtin_bfin_[cs]sync
2780 if ($line =~ /__builtin_bfin_csync/) {
2781 my $herevet = "$here\n" . cat_vet($line) . "\n";
2783 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
2785 if ($line =~ /__builtin_bfin_ssync/) {
2786 my $herevet = "$here\n" . cat_vet($line) . "\n";
2788 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
2791 # check for old HOTPLUG __dev<foo> section markings
2792 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2793 WARN("HOTPLUG_SECTION",
2794 "Using $1 is unnecessary\n" . $herecurr);
2797 # Check for potential 'bare' types
2798 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2800 #print "LINE<$line>\n";
2801 if ($linenr >= $suppress_statement &&
2802 $realcnt && $sline =~ /.\s*\S/) {
2803 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2804 ctx_statement_block($linenr, $realcnt, 0);
2805 $stat =~ s/\n./\n /g;
2806 $cond =~ s/\n./\n /g;
2808 #print "linenr<$linenr> <$stat>\n";
2809 # If this statement has no statement boundaries within
2810 # it there is no point in retrying a statement scan
2811 # until we hit end of it.
2812 my $frag = $stat; $frag =~ s/;+\s*$//;
2813 if ($frag !~ /(?:{|;)/) {
2814 #print "skip<$line_nr_next>\n";
2815 $suppress_statement = $line_nr_next;
2818 # Find the real next line.
2819 $realline_next = $line_nr_next;
2820 if (defined $realline_next &&
2821 (!defined $lines[$realline_next - 1] ||
2822 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2829 # Ignore goto labels.
2830 if ($s =~ /$Ident:\*$/s) {
2832 # Ignore functions being called
2833 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
2835 } elsif ($s =~ /^.\s*else\b/s) {
2837 # declarations always start with types
2838 } 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) {
2841 possible($type, "A:" . $s);
2843 # definitions in global scope can only start with types
2844 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
2845 possible($1, "B:" . $s);
2848 # any (foo ... *) is a pointer cast, and foo is a type
2849 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
2850 possible($1, "C:" . $s);
2853 # Check for any sort of function declaration.
2854 # int foo(something bar, other baz);
2855 # void (*store_gdt)(x86_descr_ptr *);
2856 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
2857 my ($name_len) = length($1);
2860 substr($ctx, 0, $name_len + 1, '');
2861 $ctx =~ s/\)[^\)]*$//;
2863 for my $arg (split(/\s*,\s*/, $ctx)) {
2864 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
2866 possible($1, "D:" . $s);
2874 # Checks which may be anchored in the context.
2877 # Check for switch () and associated case and default
2878 # statements should be at the same indent.
2879 if ($line=~/\bswitch\s*\(.*\)/) {
2882 my @ctx = ctx_block_outer($linenr, $realcnt);
2884 for my $ctx (@ctx) {
2885 my ($clen, $cindent) = line_stats($ctx);
2886 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2887 $indent != $cindent) {
2888 $err .= "$sep$ctx\n";
2895 ERROR("SWITCH_CASE_INDENT_LEVEL",
2896 "switch and case should be at the same indent\n$hereline$err");
2900 # if/while/etc brace do not go on next line, unless defining a do while loop,
2901 # or if that brace on the next line is for something else
2902 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
2903 my $pre_ctx = "$1$2";
2905 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
2907 if ($line =~ /^\+\t{6,}/) {
2908 WARN("DEEP_INDENTATION",
2909 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2912 my $ctx_cnt = $realcnt - $#ctx - 1;
2913 my $ctx = join("\n", @ctx);
2915 my $ctx_ln = $linenr;
2916 my $ctx_skip = $realcnt;
2918 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2919 defined $lines[$ctx_ln - 1] &&
2920 $lines[$ctx_ln - 1] =~ /^-/)) {
2921 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2922 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
2926 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2927 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
2929 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
2931 "that open brace { should be on the previous line\n" .
2932 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2934 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2935 $ctx =~ /\)\s*\;\s*$/ &&
2936 defined $lines[$ctx_ln - 1])
2938 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2939 if ($nindent > $indent) {
2940 WARN("TRAILING_SEMICOLON",
2941 "trailing semicolon indicates no statements, indent implies otherwise\n" .
2942 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2947 # Check relative indent for conditionals and blocks.
2948 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2949 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2950 ctx_statement_block($linenr, $realcnt, 0)
2951 if (!defined $stat);
2952 my ($s, $c) = ($stat, $cond);
2954 substr($s, 0, length($c), '');
2956 # Make sure we remove the line prefixes as we have
2957 # none on the first line, and are going to readd them
2961 # Find out how long the conditional actually is.
2962 my @newlines = ($c =~ /\n/gs);
2963 my $cond_lines = 1 + $#newlines;
2965 # We want to check the first line inside the block
2966 # starting at the end of the conditional, so remove:
2967 # 1) any blank line termination
2968 # 2) any opening brace { on end of the line
2970 my $continuation = 0;
2972 $s =~ s/^.*\bdo\b//;
2974 if ($s =~ s/^\s*\\//) {
2977 if ($s =~ s/^\s*?\n//) {
2982 # Also ignore a loop construct at the end of a
2983 # preprocessor statement.
2984 if (($prevline =~ /^.\s*#\s*define\s/ ||
2985 $prevline =~ /\\\s*$/) && $continuation == 0) {
2991 while ($cond_ptr != $cond_lines) {
2992 $cond_ptr = $cond_lines;
2994 # If we see an #else/#elif then the code
2996 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3001 # 1) blank lines, they should be at 0,
3002 # 2) preprocessor lines, and
3004 if ($continuation ||
3006 $s =~ /^\s*#\s*?/ ||
3007 $s =~ /^\s*$Ident\s*:/) {
3008 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
3009 if ($s =~ s/^.*?\n//) {
3015 my (undef, $sindent) = line_stats("+" . $s);
3016 my $stat_real = raw_line($linenr, $cond_lines);
3018 # Check if either of these lines are modified, else
3019 # this is not this patch's fault.
3020 if (!defined($stat_real) ||
3021 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3024 if (defined($stat_real) && $cond_lines > 1) {
3025 $stat_real = "[...]\n$stat_real";
3028 #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";
3030 if ($check && (($sindent % 8) != 0 ||
3031 ($sindent <= $indent && $s ne ''))) {
3032 WARN("SUSPECT_CODE_INDENT",
3033 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3037 # Track the 'values' across context and added lines.
3038 my $opline = $line; $opline =~ s/^./ /;
3039 my ($curr_values, $curr_vars) =
3040 annotate_values($opline . "\n", $prev_values);
3041 $curr_values = $prev_values . $curr_values;
3043 my $outline = $opline; $outline =~ s/\t/ /g;
3044 print "$linenr > .$outline\n";
3045 print "$linenr > $curr_values\n";
3046 print "$linenr > $curr_vars\n";
3048 $prev_values = substr($curr_values, -1);
3050 #ignore lines not being added
3051 next if ($line =~ /^[^\+]/);
3053 # TEST: allow direct testing of the type matcher.
3055 if ($line =~ /^.\s*$Declare\s*$/) {
3057 "TEST: is type\n" . $herecurr);
3058 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
3059 ERROR("TEST_NOT_TYPE",
3060 "TEST: is not type ($1 is)\n". $herecurr);
3064 # TEST: allow direct testing of the attribute matcher.
3066 if ($line =~ /^.\s*$Modifier\s*$/) {
3068 "TEST: is attr\n" . $herecurr);
3069 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
3070 ERROR("TEST_NOT_ATTR",
3071 "TEST: is not attr ($1 is)\n". $herecurr);
3076 # check for initialisation to aggregates open brace on the next line
3077 if ($line =~ /^.\s*{/ &&
3078 $prevline =~ /(?:^|[^=])=\s*$/) {
3079 if (ERROR("OPEN_BRACE",
3080 "that open brace { should be on the previous line\n" . $hereprev) &&
3081 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3082 fix_delete_line($fixlinenr - 1, $prevrawline);
3083 fix_delete_line($fixlinenr, $rawline);
3084 my $fixedline = $prevrawline;
3085 $fixedline =~ s/\s*=\s*$/ = {/;
3086 fix_insert_line($fixlinenr, $fixedline);
3088 $fixedline =~ s/^(.\s*){\s*/$1/;
3089 fix_insert_line($fixlinenr, $fixedline);
3094 # Checks which are anchored on the added line.
3097 # check for malformed paths in #include statements (uses RAW line)
3098 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
3100 if ($path =~ m{//}) {
3101 ERROR("MALFORMED_INCLUDE",
3102 "malformed #include filename\n" . $herecurr);
3104 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3105 ERROR("UAPI_INCLUDE",
3106 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
3110 # no C99 // comments
3111 if ($line =~ m{//}) {
3112 if (ERROR("C99_COMMENTS",
3113 "do not use C99 // comments\n" . $herecurr) &&
3115 my $line = $fixed[$fixlinenr];
3116 if ($line =~ /\/\/(.*)$/) {
3117 my $comment = trim($1);
3118 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
3122 # Remove C99 comments.
3124 $opline =~ s@//.*@@;
3126 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3127 # the whole statement.
3128 #print "APW <$lines[$realline_next - 1]>\n";
3129 if (defined $realline_next &&
3130 exists $lines[$realline_next - 1] &&
3131 !defined $suppress_export{$realline_next} &&
3132 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3133 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3134 # Handle definitions which produce identifiers with
3137 # EXPORT_SYMBOL(something_foo);
3139 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
3140 $name =~ /^${Ident}_$2/) {
3141 #print "FOO C name<$name>\n";
3142 $suppress_export{$realline_next} = 1;
3144 } elsif ($stat !~ /(?:
3146 ^.DEFINE_$Ident\(\Q$name\E\)|
3147 ^.DECLARE_$Ident\(\Q$name\E\)|
3148 ^.LIST_HEAD\(\Q$name\E\)|
3149 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3150 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
3152 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3153 $suppress_export{$realline_next} = 2;
3155 $suppress_export{$realline_next} = 1;
3158 if (!defined $suppress_export{$linenr} &&
3159 $prevline =~ /^.\s*$/ &&
3160 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3161 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3162 #print "FOO B <$lines[$linenr - 1]>\n";
3163 $suppress_export{$linenr} = 2;
3165 if (defined $suppress_export{$linenr} &&
3166 $suppress_export{$linenr} == 2) {
3167 WARN("EXPORT_SYMBOL",
3168 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
3171 # check for global initialisers.
3172 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
3173 if (ERROR("GLOBAL_INITIALISERS",
3174 "do not initialise globals to 0 or NULL\n" .
3177 $fixed[$fixlinenr] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
3180 # check for static initialisers.
3181 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
3182 if (ERROR("INITIALISED_STATIC",
3183 "do not initialise statics to 0 or NULL\n" .
3186 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
3190 # check for misordered declarations of char/short/int/long with signed/unsigned
3191 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3193 WARN("MISORDERED_TYPE",
3194 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3197 # check for static const char * arrays.
3198 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
3199 WARN("STATIC_CONST_CHAR_ARRAY",
3200 "static const char * array should probably be static const char * const\n" .
3204 # check for static char foo[] = "bar" declarations.
3205 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
3206 WARN("STATIC_CONST_CHAR_ARRAY",
3207 "static char array declaration should probably be static const char\n" .
3211 # check for const <foo> const where <foo> is not a pointer or array type
3212 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3214 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3216 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3217 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3219 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3223 # check for non-global char *foo[] = {"bar", ...} declarations.
3224 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3225 WARN("STATIC_CONST_CHAR_ARRAY",
3226 "char * array declaration might be better as static const\n" .
3230 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3231 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3233 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3235 if (WARN("ARRAY_SIZE",
3236 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3238 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3243 # check for function declarations without arguments like "int foo()"
3244 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3245 if (ERROR("FUNCTION_WITHOUT_ARGS",
3246 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3248 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
3252 # check for uses of DEFINE_PCI_DEVICE_TABLE
3253 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
3254 if (WARN("DEFINE_PCI_DEVICE_TABLE",
3255 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
3257 $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
3261 # check for new typedefs, only function parameters and sparse annotations
3263 if ($line =~ /\btypedef\s/ &&
3264 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
3265 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
3266 $line !~ /\b$typeTypedefs\b/ &&
3267 $line !~ /\b$typeOtherOSTypedefs\b/ &&
3268 $line !~ /\b__bitwise(?:__|)\b/) {
3269 WARN("NEW_TYPEDEFS",
3270 "do not add new typedefs\n" . $herecurr);
3273 # * goes on variable not on type
3275 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3277 my ($ident, $from, $to) = ($1, $2, $2);
3279 # Should start with a space.
3280 $to =~ s/^(\S)/ $1/;
3281 # Should not end with a space.
3283 # '*'s should not have spaces between.
3284 while ($to =~ s/\*\s+\*/\*\*/) {
3287 ## print "1: from<$from> to<$to> ident<$ident>\n";
3289 if (ERROR("POINTER_LOCATION",
3290 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3292 my $sub_from = $ident;
3293 my $sub_to = $ident;
3294 $sub_to =~ s/\Q$from\E/$to/;
3295 $fixed[$fixlinenr] =~
3296 s@\Q$sub_from\E@$sub_to@;
3300 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3302 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
3304 # Should start with a space.
3305 $to =~ s/^(\S)/ $1/;
3306 # Should not end with a space.
3308 # '*'s should not have spaces between.
3309 while ($to =~ s/\*\s+\*/\*\*/) {
3311 # Modifiers should have spaces.
3312 $to =~ s/(\b$Modifier$)/$1 /;
3314 ## print "2: from<$from> to<$to> ident<$ident>\n";
3315 if ($from ne $to && $ident !~ /^$Modifier$/) {
3316 if (ERROR("POINTER_LOCATION",
3317 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3320 my $sub_from = $match;
3321 my $sub_to = $match;
3322 $sub_to =~ s/\Q$from\E/$to/;
3323 $fixed[$fixlinenr] =~
3324 s@\Q$sub_from\E@$sub_to@;
3329 # # no BUG() or BUG_ON()
3330 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
3331 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
3332 # print "$herecurr";
3336 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
3337 WARN("LINUX_VERSION_CODE",
3338 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3341 # check for uses of printk_ratelimit
3342 if ($line =~ /\bprintk_ratelimit\s*\(/) {
3343 WARN("PRINTK_RATELIMITED",
3344 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
3347 # printk should use KERN_* levels. Note that follow on printk's on the
3348 # same line do not need a level, so we use the current block context
3349 # to try and find and validate the current printk. In summary the current
3350 # printk includes all preceding printk's which have no newline on the end.
3351 # we assume the first bad printk is the one to report.
3352 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
3354 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3355 #print "CHECK<$lines[$ln - 1]\n";
3356 # we have a preceding printk if it ends
3357 # with "\n" ignore it, else it is to blame
3358 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3359 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3366 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3367 "printk() should include KERN_ facility level\n" . $herecurr);
3371 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3373 my $level = lc($orig);
3374 $level = "warn" if ($level eq "warning");
3375 my $level2 = $level;
3376 $level2 = "dbg" if ($level eq "debug");
3377 WARN("PREFER_PR_LEVEL",
3378 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
3381 if ($line =~ /\bpr_warning\s*\(/) {
3382 if (WARN("PREFER_PR_LEVEL",
3383 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3385 $fixed[$fixlinenr] =~
3386 s/\bpr_warning\b/pr_warn/;
3390 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3392 my $level = lc($orig);
3393 $level = "warn" if ($level eq "warning");
3394 $level = "dbg" if ($level eq "debug");
3395 WARN("PREFER_DEV_LEVEL",
3396 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3399 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
3400 # number of false positives, but assembly files are not checked, so at
3401 # least the arch entry code will not trigger this warning.
3402 if ($line =~ /\bENOSYS\b/) {
3404 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3407 # function brace can't be on same line, except for #defines of do while,
3408 # or if closed on same line
3409 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
3410 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
3411 if (ERROR("OPEN_BRACE",
3412 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3414 fix_delete_line($fixlinenr, $rawline);
3415 my $fixed_line = $rawline;
3416 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3419 fix_insert_line($fixlinenr, ltrim($line1));
3420 fix_insert_line($fixlinenr, "\+{");
3421 if ($line2 !~ /^\s*$/) {
3422 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3427 # open braces for enum, union and struct go on the same line.
3428 if ($line =~ /^.\s*{/ &&
3429 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
3430 if (ERROR("OPEN_BRACE",
3431 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3432 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3433 fix_delete_line($fixlinenr - 1, $prevrawline);
3434 fix_delete_line($fixlinenr, $rawline);
3435 my $fixedline = rtrim($prevrawline) . " {";
3436 fix_insert_line($fixlinenr, $fixedline);
3437 $fixedline = $rawline;
3438 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3439 if ($fixedline !~ /^\+\s*$/) {
3440 fix_insert_line($fixlinenr, $fixedline);
3445 # missing space after union, struct or enum definition
3446 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3448 "missing space after $1 definition\n" . $herecurr) &&
3450 $fixed[$fixlinenr] =~
3451 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3455 # Function pointer declarations
3456 # check spacing between type, funcptr, and args
3457 # canonical declaration is "type (*funcptr)(args...)"
3458 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
3460 my $pre_pointer_space = $2;
3461 my $post_pointer_space = $3;
3463 my $post_funcname_space = $5;
3464 my $pre_args_space = $6;
3466 # the $Declare variable will capture all spaces after the type
3467 # so check it for a missing trailing missing space but pointer return types
3468 # don't need a space so don't warn for those.
3469 my $post_declare_space = "";
3470 if ($declare =~ /(\s+)$/) {
3471 $post_declare_space = $1;
3472 $declare = rtrim($declare);
3474 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
3476 "missing space after return type\n" . $herecurr);
3477 $post_declare_space = " ";
3480 # unnecessary space "type (*funcptr)(args...)"
3481 # This test is not currently implemented because these declarations are
3483 # int foo(int bar, ...)
3484 # and this is form shouldn't/doesn't generate a checkpatch warning.
3486 # elsif ($declare =~ /\s{2,}$/) {
3488 # "Multiple spaces after return type\n" . $herecurr);
3491 # unnecessary space "type ( *funcptr)(args...)"
3492 if (defined $pre_pointer_space &&
3493 $pre_pointer_space =~ /^\s/) {
3495 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3498 # unnecessary space "type (* funcptr)(args...)"
3499 if (defined $post_pointer_space &&
3500 $post_pointer_space =~ /^\s/) {
3502 "Unnecessary space before function pointer name\n" . $herecurr);
3505 # unnecessary space "type (*funcptr )(args...)"
3506 if (defined $post_funcname_space &&
3507 $post_funcname_space =~ /^\s/) {
3509 "Unnecessary space after function pointer name\n" . $herecurr);
3512 # unnecessary space "type (*funcptr) (args...)"
3513 if (defined $pre_args_space &&
3514 $pre_args_space =~ /^\s/) {
3516 "Unnecessary space before function pointer arguments\n" . $herecurr);
3519 if (show_type("SPACING") && $fix) {
3520 $fixed[$fixlinenr] =~
3521 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3525 # check for spacing round square brackets; allowed:
3526 # 1. with a type on the left -- int [] a;
3527 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3528 # 3. inside a curly brace -- = { [0...10] = 5 }
3529 while ($line =~ /(.*?\s)\[/g) {
3530 my ($where, $prefix) = ($-[1], $1);
3531 if ($prefix !~ /$Type\s+$/ &&
3532 ($where != 0 || $prefix !~ /^.\s+$/) &&
3533 $prefix !~ /[{,]\s+$/) {
3534 if (ERROR("BRACKET_SPACE",
3535 "space prohibited before open square bracket '['\n" . $herecurr) &&
3537 $fixed[$fixlinenr] =~
3538 s/^(\+.*?)\s+\[/$1\[/;
3543 # check for spaces between functions and their parentheses.
3544 while ($line =~ /($Ident)\s+\(/g) {
3546 my $ctx_before = substr($line, 0, $-[1]);
3547 my $ctx = "$ctx_before$name";
3549 # Ignore those directives where spaces _are_ permitted.
3551 if|for|while|switch|return|case|
3552 volatile|__volatile__|
3553 __attribute__|format|__extension__|
3556 # cpp #define statements have non-optional spaces, ie
3557 # if there is a space between the name and the open
3558 # parenthesis it is simply not a parameter group.
3559 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
3561 # cpp #elif statement condition may start with a (
3562 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
3564 # If this whole things ends with a type its most
3565 # likely a typedef for a function.
3566 } elsif ($ctx =~ /$Type$/) {
3570 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3572 $fixed[$fixlinenr] =~
3573 s/\b$name\s+\(/$name\(/;
3578 # Check operator spacing.
3579 if (!($line=~/\#\s*include/)) {
3580 my $fixed_line = "";
3584 <<=|>>=|<=|>=|==|!=|
3585 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3586 =>|->|<<|>>|<|>|=|!|~|
3587 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
3590 my @elements = split(/($ops|;)/, $opline);
3592 ## print("element count: <" . $#elements . ">\n");
3593 ## foreach my $el (@elements) {
3594 ## print("el: <$el>\n");
3597 my @fix_elements = ();
3600 foreach my $el (@elements) {
3601 push(@fix_elements, substr($rawline, $off, length($el)));
3602 $off += length($el);
3607 my $blank = copy_spacing($opline);
3608 my $last_after = -1;
3610 for (my $n = 0; $n < $#elements; $n += 2) {
3612 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3614 ## print("n: <$n> good: <$good>\n");
3616 $off += length($elements[$n]);
3618 # Pick up the preceding and succeeding characters.
3619 my $ca = substr($opline, 0, $off);
3621 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3622 $cc = substr($opline, $off + length($elements[$n + 1]));
3624 my $cb = "$ca$;$cc";
3627 $a = 'V' if ($elements[$n] ne '');
3628 $a = 'W' if ($elements[$n] =~ /\s$/);
3629 $a = 'C' if ($elements[$n] =~ /$;$/);
3630 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3631 $a = 'O' if ($elements[$n] eq '');
3632 $a = 'E' if ($ca =~ /^\s*$/);
3634 my $op = $elements[$n + 1];
3637 if (defined $elements[$n + 2]) {
3638 $c = 'V' if ($elements[$n + 2] ne '');
3639 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
3640 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
3641 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3642 $c = 'O' if ($elements[$n + 2] eq '');
3643 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
3648 my $ctx = "${a}x${c}";
3650 my $at = "(ctx:$ctx)";
3652 my $ptr = substr($blank, 0, $off) . "^";
3653 my $hereptr = "$hereline$ptr\n";
3655 # Pull out the value of this operator.
3656 my $op_type = substr($curr_values, $off + 1, 1);
3658 # Get the full operator variant.
3659 my $opv = $op . substr($curr_vars, $off, 1);
3661 # Ignore operators passed as parameters.
3662 if ($op_type ne 'V' &&
3663 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
3666 # } elsif ($op =~ /^$;+$/) {
3668 # ; should have either the end of line or a space or \ after it
3669 } elsif ($op eq ';') {
3670 if ($ctx !~ /.x[WEBC]/ &&
3671 $cc !~ /^\\/ && $cc !~ /^;/) {
3672 if (ERROR("SPACING",
3673 "space required after that '$op' $at\n" . $hereptr)) {
3674 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3680 } elsif ($op eq '//') {
3682 # : when part of a bitfield
3683 } elsif ($opv eq ':B') {
3684 # skip the bitfield test for now
3688 } elsif ($op eq '->') {
3689 if ($ctx =~ /Wx.|.xW/) {
3690 if (ERROR("SPACING",
3691 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
3692 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3693 if (defined $fix_elements[$n + 2]) {
3694 $fix_elements[$n + 2] =~ s/^\s+//;
3700 # , must not have a space before and must have a space on the right.
3701 } elsif ($op eq ',') {
3702 my $rtrim_before = 0;
3703 my $space_after = 0;
3704 if ($ctx =~ /Wx./) {
3705 if (ERROR("SPACING",
3706 "space prohibited before that '$op' $at\n" . $hereptr)) {
3711 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
3712 if (ERROR("SPACING",
3713 "space required after that '$op' $at\n" . $hereptr)) {
3719 if ($rtrim_before || $space_after) {
3720 if ($rtrim_before) {
3721 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3723 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3730 # '*' as part of a type definition -- reported already.
3731 } elsif ($opv eq '*_') {
3732 #warn "'*' is part of type\n";
3734 # unary operators should have a space before and
3735 # none after. May be left adjacent to another
3736 # unary operator, or a cast
3737 } elsif ($op eq '!' || $op eq '~' ||
3738 $opv eq '*U' || $opv eq '-U' ||
3739 $opv eq '&U' || $opv eq '&&U') {
3740 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
3741 if (ERROR("SPACING",
3742 "space required before that '$op' $at\n" . $hereptr)) {
3743 if ($n != $last_after + 2) {
3744 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3749 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
3750 # A unary '*' may be const
3752 } elsif ($ctx =~ /.xW/) {
3753 if (ERROR("SPACING",
3754 "space prohibited after that '$op' $at\n" . $hereptr)) {
3755 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
3756 if (defined $fix_elements[$n + 2]) {
3757 $fix_elements[$n + 2] =~ s/^\s+//;
3763 # unary ++ and unary -- are allowed no space on one side.
3764 } elsif ($op eq '++' or $op eq '--') {
3765 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
3766 if (ERROR("SPACING",
3767 "space required one side of that '$op' $at\n" . $hereptr)) {
3768 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3772 if ($ctx =~ /Wx[BE]/ ||
3773 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
3774 if (ERROR("SPACING",
3775 "space prohibited before that '$op' $at\n" . $hereptr)) {
3776 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3780 if ($ctx =~ /ExW/) {
3781 if (ERROR("SPACING",
3782 "space prohibited after that '$op' $at\n" . $hereptr)) {
3783 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3784 if (defined $fix_elements[$n + 2]) {
3785 $fix_elements[$n + 2] =~ s/^\s+//;
3791 # << and >> may either have or not have spaces both sides
3792 } elsif ($op eq '<<' or $op eq '>>' or
3793 $op eq '&' or $op eq '^' or $op eq '|' or
3794 $op eq '+' or $op eq '-' or
3795 $op eq '*' or $op eq '/' or
3799 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
3801 "spaces preferred around that '$op' $at\n" . $hereptr)) {
3802 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3803 $fix_elements[$n + 2] =~ s/^\s+//;
3806 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
3808 "space preferred before that '$op' $at\n" . $hereptr)) {
3809 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
3813 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
3814 if (ERROR("SPACING",
3815 "need consistent spacing around '$op' $at\n" . $hereptr)) {
3816 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3817 if (defined $fix_elements[$n + 2]) {
3818 $fix_elements[$n + 2] =~ s/^\s+//;
3824 # A colon needs no spaces before when it is
3825 # terminating a case value or a label.
3826 } elsif ($opv eq ':C' || $opv eq ':L') {
3827 if ($ctx =~ /Wx./) {
3828 if (ERROR("SPACING",
3829 "space prohibited before that '$op' $at\n" . $hereptr)) {
3830 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3835 # All the others need spaces both sides.
3836 } elsif ($ctx !~ /[EWC]x[CWE]/) {
3839 # Ignore email addresses <foo@bar>
3841 $cc =~ /^\S+\@\S+>/) ||
3843 $ca =~ /<\S+\@\S+$/))
3848 # messages are ERROR, but ?: are CHK
3850 my $msg_type = \&ERROR;
3851 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
3853 if (&{$msg_type}("SPACING",
3854 "spaces required around that '$op' $at\n" . $hereptr)) {
3855 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3856 if (defined $fix_elements[$n + 2]) {
3857 $fix_elements[$n + 2] =~ s/^\s+//;
3863 $off += length($elements[$n + 1]);
3865 ## print("n: <$n> GOOD: <$good>\n");
3867 $fixed_line = $fixed_line . $good;
3870 if (($#elements % 2) == 0) {
3871 $fixed_line = $fixed_line . $fix_elements[$#elements];
3874 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
3875 $fixed[$fixlinenr] = $fixed_line;
3881 # check for whitespace before a non-naked semicolon
3882 if ($line =~ /^\+.*\S\s+;\s*$/) {
3884 "space prohibited before semicolon\n" . $herecurr) &&
3886 1 while $fixed[$fixlinenr] =~
3887 s/^(\+.*\S)\s+;/$1;/;
3891 # check for multiple assignments
3892 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
3893 CHK("MULTIPLE_ASSIGNMENTS",
3894 "multiple assignments should be avoided\n" . $herecurr);
3897 ## # check for multiple declarations, allowing for a function declaration
3899 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3900 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3902 ## # Remove any bracketed sections to ensure we do not
3903 ## # falsly report the parameters of functions.
3905 ## while ($ln =~ s/\([^\(\)]*\)//g) {
3907 ## if ($ln =~ /,/) {
3908 ## WARN("MULTIPLE_DECLARATION",
3909 ## "declaring multiple variables together should be avoided\n" . $herecurr);
3913 #need space before brace following if, while, etc
3914 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3916 if (ERROR("SPACING",
3917 "space required before the open brace '{'\n" . $herecurr) &&
3919 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
3923 ## # check for blank lines before declarations
3924 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3925 ## $prevrawline =~ /^.\s*$/) {
3927 ## "No blank lines before declarations\n" . $hereprev);
3931 # closing brace should have a space following it when it has anything
3933 if ($line =~ /}(?!(?:,|;|\)))\S/) {
3934 if (ERROR("SPACING",
3935 "space required after that close brace '}'\n" . $herecurr) &&
3937 $fixed[$fixlinenr] =~
3938 s/}((?!(?:,|;|\)))\S)/} $1/;
3942 # check spacing on square brackets
3943 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
3944 if (ERROR("SPACING",
3945 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3947 $fixed[$fixlinenr] =~
3951 if ($line =~ /\s\]/) {
3952 if (ERROR("SPACING",
3953 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3955 $fixed[$fixlinenr] =~
3960 # check spacing on parentheses
3961 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3962 $line !~ /for\s*\(\s+;/) {
3963 if (ERROR("SPACING",
3964 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3966 $fixed[$fixlinenr] =~
3970 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
3971 $line !~ /for\s*\(.*;\s+\)/ &&
3972 $line !~ /:\s+\)/) {
3973 if (ERROR("SPACING",
3974 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3976 $fixed[$fixlinenr] =~
3981 # check unnecessary parentheses around addressof/dereference single $Lvals
3982 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
3984 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
3986 if (CHK("UNNECESSARY_PARENTHESES",
3987 "Unnecessary parentheses around $var\n" . $herecurr) &&
3989 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
3993 # check for unnecessary parentheses around function pointer uses
3994 # ie: (foo->bar)(); should be foo->bar();
3995 # but not "if (foo->bar) (" to avoid some false positives
3996 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
3998 if (CHK("UNNECESSARY_PARENTHESES",
3999 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4001 my $var2 = deparenthesize($var);
4003 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4007 #goto labels aren't indented, allow a single space however
4008 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
4009 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
4010 if (WARN("INDENTED_LABEL",
4011 "labels should not be indented\n" . $herecurr) &&
4013 $fixed[$fixlinenr] =~
4018 # return is not a function
4019 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
4021 if ($^V && $^V ge 5.10.0 &&
4022 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4024 $value = deparenthesize($value);
4025 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4026 ERROR("RETURN_PARENTHESES",
4027 "return is not a function, parentheses are not required\n" . $herecurr);
4029 } elsif ($spacing !~ /\s+/) {
4031 "space required before the open parenthesis '('\n" . $herecurr);
4035 # unnecessary return in a void function
4036 # at end-of-function, with the previous line a single leading tab, then return;
4037 # and the line before that not a goto label target like "out:"
4038 if ($sline =~ /^[ \+]}\s*$/ &&
4039 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4041 $lines[$linenr - 3] =~ /^[ +]/ &&
4042 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
4044 "void function return statements are not generally useful\n" . $hereprev);
4047 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4048 if ($^V && $^V ge 5.10.0 &&
4049 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4050 my $openparens = $1;
4051 my $count = $openparens =~ tr@\(@\(@;
4053 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4054 my $comp = $4; #Not $1 because of $LvalOrFunc
4055 $msg = " - maybe == should be = ?" if ($comp eq "==");
4056 WARN("UNNECESSARY_PARENTHESES",
4057 "Unnecessary parentheses$msg\n" . $herecurr);
4061 # Return of what appears to be an errno should normally be negative
4062 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
4064 if ($name ne 'EOF' && $name ne 'ERROR') {
4065 WARN("USE_NEGATIVE_ERRNO",
4066 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
4070 # Need a space before open parenthesis after if, while etc
4071 if ($line =~ /\b(if|while|for|switch)\(/) {
4072 if (ERROR("SPACING",
4073 "space required before the open parenthesis '('\n" . $herecurr) &&
4075 $fixed[$fixlinenr] =~
4076 s/\b(if|while|for|switch)\(/$1 \(/;
4080 # Check for illegal assignment in if conditional -- and check for trailing
4081 # statements after the conditional.
4082 if ($line =~ /do\s*(?!{)/) {
4083 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4084 ctx_statement_block($linenr, $realcnt, 0)
4085 if (!defined $stat);
4086 my ($stat_next) = ctx_statement_block($line_nr_next,
4087 $remain_next, $off_next);
4088 $stat_next =~ s/\n./\n /g;
4089 ##print "stat<$stat> stat_next<$stat_next>\n";
4091 if ($stat_next =~ /^\s*while\b/) {
4092 # If the statement carries leading newlines,
4093 # then count those as offsets.
4095 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4097 statement_rawlines($whitespace) - 1;
4099 $suppress_whiletrailers{$line_nr_next +
4103 if (!defined $suppress_whiletrailers{$linenr} &&
4104 defined($stat) && defined($cond) &&
4105 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
4106 my ($s, $c) = ($stat, $cond);
4108 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
4109 ERROR("ASSIGN_IN_IF",
4110 "do not use assignment in if condition\n" . $herecurr);
4113 # Find out what is on the end of the line after the
4115 substr($s, 0, length($c), '');
4117 $s =~ s/$;//g; # Remove any comments
4118 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4119 $c !~ /}\s*while\s*/)
4121 # Find out how long the conditional actually is.
4122 my @newlines = ($c =~ /\n/gs);
4123 my $cond_lines = 1 + $#newlines;
4126 $stat_real = raw_line($linenr, $cond_lines)
4127 . "\n" if ($cond_lines);
4128 if (defined($stat_real) && $cond_lines > 1) {
4129 $stat_real = "[...]\n$stat_real";
4132 ERROR("TRAILING_STATEMENTS",
4133 "trailing statements should be on next line\n" . $herecurr . $stat_real);
4137 # Check for bitwise tests written as boolean
4149 WARN("HEXADECIMAL_BOOLEAN_TEST",
4150 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
4153 # if and else should not have general statements after it
4154 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4156 $s =~ s/$;//g; # Remove any comments
4157 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
4158 ERROR("TRAILING_STATEMENTS",
4159 "trailing statements should be on next line\n" . $herecurr);
4162 # if should not continue a brace
4163 if ($line =~ /}\s*if\b/) {
4164 ERROR("TRAILING_STATEMENTS",
4165 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
4168 # case and default should not have general statements after them
4169 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4171 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
4175 ERROR("TRAILING_STATEMENTS",
4176 "trailing statements should be on next line\n" . $herecurr);
4179 # Check for }<nl>else {, these must be at the same
4180 # indent level to be relevant to each other.
4181 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4182 $previndent == $indent) {
4183 if (ERROR("ELSE_AFTER_BRACE",
4184 "else should follow close brace '}'\n" . $hereprev) &&
4185 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4186 fix_delete_line($fixlinenr - 1, $prevrawline);
4187 fix_delete_line($fixlinenr, $rawline);
4188 my $fixedline = $prevrawline;
4189 $fixedline =~ s/}\s*$//;
4190 if ($fixedline !~ /^\+\s*$/) {
4191 fix_insert_line($fixlinenr, $fixedline);
4193 $fixedline = $rawline;
4194 $fixedline =~ s/^(.\s*)else/$1} else/;
4195 fix_insert_line($fixlinenr, $fixedline);
4199 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4200 $previndent == $indent) {
4201 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4203 # Find out what is on the end of the line after the
4205 substr($s, 0, length($c), '');
4208 if ($s =~ /^\s*;/) {
4209 if (ERROR("WHILE_AFTER_BRACE",
4210 "while should follow close brace '}'\n" . $hereprev) &&
4211 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4212 fix_delete_line($fixlinenr - 1, $prevrawline);
4213 fix_delete_line($fixlinenr, $rawline);
4214 my $fixedline = $prevrawline;
4215 my $trailing = $rawline;
4216 $trailing =~ s/^\+//;
4217 $trailing = trim($trailing);
4218 $fixedline =~ s/}\s*$/} $trailing/;
4219 fix_insert_line($fixlinenr, $fixedline);
4224 #Specific variable tests
4225 while ($line =~ m{($Constant|$Lval)}g) {
4228 #gcc binary extension
4229 if ($var =~ /^$Binary$/) {
4230 if (WARN("GCC_BINARY_CONSTANT",
4231 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4233 my $hexval = sprintf("0x%x", oct($var));
4234 $fixed[$fixlinenr] =~
4235 s/\b$var\b/$hexval/;
4240 if ($var !~ /^$Constant$/ &&
4241 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
4242 #Ignore Page<foo> variants
4243 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
4244 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4245 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4246 #Ignore some three character SI units explicitly, like MiB and KHz
4247 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
4248 while ($var =~ m{($Ident)}g) {
4250 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
4252 seed_camelcase_includes();
4253 if (!$file && !$camelcase_file_seeded) {
4254 seed_camelcase_file($realfile);
4255 $camelcase_file_seeded = 1;
4258 if (!defined $camelcase{$word}) {
4259 $camelcase{$word} = 1;
4261 "Avoid CamelCase: <$word>\n" . $herecurr);
4267 #no spaces allowed after \ in define
4268 if ($line =~ /\#\s*define.*\\\s+$/) {
4269 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4270 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4272 $fixed[$fixlinenr] =~ s/\s+$//;
4276 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4277 # itself <asm/foo.h> (uses RAW line)
4278 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
4280 my $checkfile = "include/linux/$file";
4281 if (-f "$root/$checkfile" &&
4282 $realfile ne $checkfile &&
4283 $1 !~ /$allowed_asm_includes/)
4285 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4286 if ($asminclude > 0) {
4287 if ($realfile =~ m{^arch/}) {
4288 CHK("ARCH_INCLUDE_LINUX",
4289 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4291 WARN("INCLUDE_LINUX",
4292 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4298 # multi-statement macros should be enclosed in a do while loop, grab the
4299 # first statement and ensure its the whole macro if its not enclosed
4300 # in a known good container
4301 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4302 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
4305 my ($off, $dstat, $dcond, $rest);
4307 my $has_flow_statement = 0;
4308 my $has_arg_concat = 0;
4309 ($dstat, $dcond, $ln, $cnt, $off) =
4310 ctx_statement_block($linenr, $realcnt, 0);
4312 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4313 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4315 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
4316 $has_arg_concat = 1 if ($ctx =~ /\#\#/);
4318 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
4320 $dstat =~ s/\\\n.//g;
4321 $dstat =~ s/^\s*//s;
4322 $dstat =~ s/\s*$//s;
4324 # Flatten any parentheses and braces
4325 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4326 $dstat =~ s/\{[^\{\}]*\}/1/ ||
4327 $dstat =~ s/\[[^\[\]]*\]/1/)
4331 # Flatten any obvious string concatentation.
4332 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
4333 $dstat =~ s/$Ident\s*("X*")/$1/)
4337 my $exceptions = qr{
4349 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4351 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4352 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
4353 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4354 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
4355 $dstat !~ /$exceptions/ &&
4356 $dstat !~ /^\.$Ident\s*=/ && # .foo =
4357 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
4358 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
4359 $dstat !~ /^for\s*$Constant$/ && # for (...)
4360 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4361 $dstat !~ /^do\s*{/ && # do {...
4362 $dstat !~ /^\({/ && # ({...
4363 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
4366 my $herectx = $here . "\n";
4367 my $cnt = statement_rawlines($ctx);
4369 for (my $n = 0; $n < $cnt; $n++) {
4370 $herectx .= raw_line($linenr, $n) . "\n";
4373 if ($dstat =~ /;/) {
4374 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4375 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4377 ERROR("COMPLEX_MACRO",
4378 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
4382 # check for macros with flow control, but without ## concatenation
4383 # ## concatenation is commonly a macro that defines a function so ignore those
4384 if ($has_flow_statement && !$has_arg_concat) {
4385 my $herectx = $here . "\n";
4386 my $cnt = statement_rawlines($ctx);
4388 for (my $n = 0; $n < $cnt; $n++) {
4389 $herectx .= raw_line($linenr, $n) . "\n";
4391 WARN("MACRO_WITH_FLOW_CONTROL",
4392 "Macros with flow control statements should be avoided\n" . "$herectx");
4395 # check for line continuations outside of #defines, preprocessor #, and asm
4398 if ($prevline !~ /^..*\\$/ &&
4399 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4400 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
4401 $line =~ /^\+.*\\$/) {
4402 WARN("LINE_CONTINUATIONS",
4403 "Avoid unnecessary line continuations\n" . $herecurr);
4407 # do {} while (0) macro tests:
4408 # single-statement macros do not need to be enclosed in do while (0) loop,
4409 # macro should not end with a semicolon
4410 if ($^V && $^V ge 5.10.0 &&
4411 $realfile !~ m@/vmlinux.lds.h$@ &&
4412 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4415 my ($off, $dstat, $dcond, $rest);
4417 ($dstat, $dcond, $ln, $cnt, $off) =
4418 ctx_statement_block($linenr, $realcnt, 0);
4421 $dstat =~ s/\\\n.//g;
4424 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4429 my $cnt = statement_rawlines($ctx);
4430 my $herectx = $here . "\n";
4432 for (my $n = 0; $n < $cnt; $n++) {
4433 $herectx .= raw_line($linenr, $n) . "\n";
4436 if (($stmts =~ tr/;/;/) == 1 &&
4437 $stmts !~ /^\s*(if|while|for|switch)\b/) {
4438 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4439 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4441 if (defined $semis && $semis ne "") {
4442 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4443 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4445 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4447 my $cnt = statement_rawlines($ctx);
4448 my $herectx = $here . "\n";
4450 for (my $n = 0; $n < $cnt; $n++) {
4451 $herectx .= raw_line($linenr, $n) . "\n";
4454 WARN("TRAILING_SEMICOLON",
4455 "macros should not use a trailing semicolon\n" . "$herectx");
4459 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4460 # all assignments may have only one of the following with an assignment:
4463 # VMLINUX_SYMBOL(...)
4464 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
4465 WARN("MISSING_VMLINUX_SYMBOL",
4466 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
4469 # check for redundant bracing round if etc
4470 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4471 my ($level, $endln, @chunks) =
4472 ctx_statement_full($linenr, $realcnt, 1);
4473 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
4474 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4475 if ($#chunks > 0 && $level == 0) {
4479 my $herectx = $here . "\n";
4480 my $ln = $linenr - 1;
4481 for my $chunk (@chunks) {
4482 my ($cond, $block) = @{$chunk};
4484 # If the condition carries leading newlines, then count those as offsets.
4485 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4486 my $offset = statement_rawlines($whitespace) - 1;
4488 $allowed[$allow] = 0;
4489 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4491 # We have looked at and allowed this specific line.
4492 $suppress_ifbraces{$ln + $offset} = 1;
4494 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
4495 $ln += statement_rawlines($block) - 1;
4497 substr($block, 0, length($cond), '');
4499 $seen++ if ($block =~ /^\s*{/);
4501 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
4502 if (statement_lines($cond) > 1) {
4503 #print "APW: ALLOWED: cond<$cond>\n";
4504 $allowed[$allow] = 1;
4506 if ($block =~/\b(?:if|for|while)\b/) {
4507 #print "APW: ALLOWED: block<$block>\n";
4508 $allowed[$allow] = 1;
4510 if (statement_block_size($block) > 1) {
4511 #print "APW: ALLOWED: lines block<$block>\n";
4512 $allowed[$allow] = 1;
4517 my $sum_allowed = 0;
4518 foreach (@allowed) {
4521 if ($sum_allowed == 0) {
4523 "braces {} are not necessary for any arm of this statement\n" . $herectx);
4524 } elsif ($sum_allowed != $allow &&
4527 "braces {} should be used on all arms of this statement\n" . $herectx);
4532 if (!defined $suppress_ifbraces{$linenr - 1} &&
4533 $line =~ /\b(if|while|for|else)\b/) {
4536 # Check the pre-context.
4537 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
4538 #print "APW: ALLOWED: pre<$1>\n";
4542 my ($level, $endln, @chunks) =
4543 ctx_statement_full($linenr, $realcnt, $-[0]);
4545 # Check the condition.
4546 my ($cond, $block) = @{$chunks[0]};
4547 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
4548 if (defined $cond) {
4549 substr($block, 0, length($cond), '');
4551 if (statement_lines($cond) > 1) {
4552 #print "APW: ALLOWED: cond<$cond>\n";
4555 if ($block =~/\b(?:if|for|while)\b/) {
4556 #print "APW: ALLOWED: block<$block>\n";
4559 if (statement_block_size($block) > 1) {
4560 #print "APW: ALLOWED: lines block<$block>\n";
4563 # Check the post-context.
4564 if (defined $chunks[1]) {
4565 my ($cond, $block) = @{$chunks[1]};
4566 if (defined $cond) {
4567 substr($block, 0, length($cond), '');
4569 if ($block =~ /^\s*\{/) {
4570 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4574 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
4575 my $herectx = $here . "\n";
4576 my $cnt = statement_rawlines($block);
4578 for (my $n = 0; $n < $cnt; $n++) {
4579 $herectx .= raw_line($linenr, $n) . "\n";
4583 "braces {} are not necessary for single statement blocks\n" . $herectx);
4587 # check for unnecessary blank lines around braces
4588 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
4590 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
4591 $fix && $prevrawline =~ /^\+/) {
4592 fix_delete_line($fixlinenr - 1, $prevrawline);
4595 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
4597 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
4599 fix_delete_line($fixlinenr, $rawline);
4603 # no volatiles please
4604 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
4605 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
4607 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
4610 # Check for user-visible strings broken across lines, which breaks the ability
4611 # to grep for the string. Make exceptions when the previous string ends in a
4612 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
4613 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
4614 if ($line =~ /^\+\s*"[X\t]*"/ &&
4615 $prevline =~ /"\s*$/ &&
4616 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
4617 if (WARN("SPLIT_STRING",
4618 "quoted string split across lines\n" . $hereprev) &&
4620 $prevrawline =~ /^\+.*"\s*$/ &&
4621 $last_coalesced_string_linenr != $linenr - 1) {
4622 my $extracted_string = get_quoted_string($line, $rawline);
4623 my $comma_close = "";
4624 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
4628 fix_delete_line($fixlinenr - 1, $prevrawline);
4629 fix_delete_line($fixlinenr, $rawline);
4630 my $fixedline = $prevrawline;
4631 $fixedline =~ s/"\s*$//;
4632 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
4633 fix_insert_line($fixlinenr - 1, $fixedline);
4634 $fixedline = $rawline;
4635 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
4636 if ($fixedline !~ /\+\s*$/) {
4637 fix_insert_line($fixlinenr, $fixedline);
4639 $last_coalesced_string_linenr = $linenr;
4643 # check for missing a space in a string concatenation
4644 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
4645 WARN('MISSING_SPACE',
4646 "break quoted strings at a space character\n" . $hereprev);
4649 # check for spaces before a quoted newline
4650 if ($rawline =~ /^.*\".*\s\\n/) {
4651 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
4652 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
4654 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
4659 # concatenated string without spaces between elements
4660 if ($line =~ /"X+"[A-Z_]+/ || $line =~ /[A-Z_]+"X+"/) {
4661 CHK("CONCATENATED_STRING",
4662 "Concatenated strings should use spaces between elements\n" . $herecurr);
4665 # uncoalesced string fragments
4666 if ($line =~ /"X*"\s*"/) {
4667 WARN("STRING_FRAGMENTS",
4668 "Consecutive strings are generally better as a single string\n" . $herecurr);
4671 # check for %L{u,d,i} in strings
4673 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4674 $string = substr($rawline, $-[1], $+[1] - $-[1]);
4675 $string =~ s/%%/__/g;
4676 if ($string =~ /(?<!%)%L[udi]/) {
4678 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
4683 # check for line continuations in quoted strings with odd counts of "
4684 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
4685 WARN("LINE_CONTINUATIONS",
4686 "Avoid line continuations in quoted strings\n" . $herecurr);
4690 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
4691 CHK("REDUNDANT_CODE",
4692 "if this code is redundant consider removing it\n" .
4696 # check for needless "if (<foo>) fn(<foo>)" uses
4697 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
4698 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
4699 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
4701 "$1(NULL) is safe and this check is probably not required\n" . $hereprev);
4705 # check for unnecessary "Out of Memory" messages
4706 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
4707 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
4708 (defined $1 || defined $3) &&
4711 my $testline = $lines[$linenr - 3];
4713 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
4714 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
4716 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
4718 "Possible unnecessary 'out of memory' message\n" . $hereprev);
4722 # check for logging functions with KERN_<LEVEL>
4723 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
4724 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
4726 if (WARN("UNNECESSARY_KERN_LEVEL",
4727 "Possible unnecessary $level\n" . $herecurr) &&
4729 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
4733 # check for mask then right shift without a parentheses
4734 if ($^V && $^V ge 5.10.0 &&
4735 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
4736 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
4737 WARN("MASK_THEN_SHIFT",
4738 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
4741 # check for pointer comparisons to NULL
4742 if ($^V && $^V ge 5.10.0) {
4743 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
4746 $equal = "" if ($4 eq "!=");
4747 if (CHK("COMPARISON_TO_NULL",
4748 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
4750 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
4755 # check for bad placement of section $InitAttribute (e.g.: __initdata)
4756 if ($line =~ /(\b$InitAttribute\b)/) {
4758 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
4761 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
4762 ERROR("MISPLACED_INIT",
4763 "$attr should be placed after $var\n" . $herecurr)) ||
4764 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
4765 WARN("MISPLACED_INIT",
4766 "$attr should be placed after $var\n" . $herecurr))) &&
4768 $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;
4773 # check for $InitAttributeData (ie: __initdata) with const
4774 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
4776 $attr =~ /($InitAttributePrefix)(.*)/;
4777 my $attr_prefix = $1;
4779 if (ERROR("INIT_ATTRIBUTE",
4780 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
4782 $fixed[$fixlinenr] =~
4783 s/$InitAttributeData/${attr_prefix}initconst/;
4787 # check for $InitAttributeConst (ie: __initconst) without const
4788 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
4790 if (ERROR("INIT_ATTRIBUTE",
4791 "Use of $attr requires a separate use of const\n" . $herecurr) &&
4793 my $lead = $fixed[$fixlinenr] =~
4794 /(^\+\s*(?:static\s+))/;
4796 $lead = "$lead " if ($lead !~ /^\+$/);
4797 $lead = "${lead}const ";
4798 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
4802 # check for __read_mostly with const non-pointer (should just be const)
4803 if ($line =~ /\b__read_mostly\b/ &&
4804 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
4805 if (ERROR("CONST_READ_MOSTLY",
4806 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
4808 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
4812 # don't use __constant_<foo> functions outside of include/uapi/
4813 if ($realfile !~ m@^include/uapi/@ &&
4814 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
4815 my $constant_func = $1;
4816 my $func = $constant_func;
4817 $func =~ s/^__constant_//;
4818 if (WARN("CONSTANT_CONVERSION",
4819 "$constant_func should be $func\n" . $herecurr) &&
4821 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
4825 # prefer usleep_range over udelay
4826 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
4828 # ignore udelay's < 10, however
4829 if (! ($delay < 10) ) {
4831 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4833 if ($delay > 2000) {
4835 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
4839 # warn about unexpectedly long msleep's
4840 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
4843 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4847 # check for comparisons of jiffies
4848 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
4849 WARN("JIFFIES_COMPARISON",
4850 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4853 # check for comparisons of get_jiffies_64()
4854 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
4855 WARN("JIFFIES_COMPARISON",
4856 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4859 # warn about #ifdefs in C files
4860 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
4861 # print "#ifdef in C files should be avoided\n";
4862 # print "$herecurr";
4866 # warn about spacing in #ifdefs
4867 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
4868 if (ERROR("SPACING",
4869 "exactly one space required after that #$1\n" . $herecurr) &&
4871 $fixed[$fixlinenr] =~
4872 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
4877 # check for spinlock_t definitions without a comment.
4878 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
4879 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
4881 if (!ctx_has_comment($first_line, $linenr)) {
4882 CHK("UNCOMMENTED_DEFINITION",
4883 "$1 definition without comment\n" . $herecurr);
4886 # check for memory barriers without a comment.
4887 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4888 if (!ctx_has_comment($first_line, $linenr)) {
4889 WARN("MEMORY_BARRIER",
4890 "memory barrier without comment\n" . $herecurr);
4893 # check of hardware specific defines
4894 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
4896 "architecture specific defines should be avoided\n" . $herecurr);
4899 # Check that the storage class is at the beginning of a declaration
4900 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
4901 WARN("STORAGE_CLASS",
4902 "storage class should be at the beginning of the declaration\n" . $herecurr)
4905 # check the location of the inline attribute, that it is between
4906 # storage class and type.
4907 if ($line =~ /\b$Type\s+$Inline\b/ ||
4908 $line =~ /\b$Inline\s+$Storage\b/) {
4909 ERROR("INLINE_LOCATION",
4910 "inline keyword should sit between storage class and type\n" . $herecurr);
4913 # Check for __inline__ and __inline, prefer inline
4914 if ($realfile !~ m@\binclude/uapi/@ &&
4915 $line =~ /\b(__inline__|__inline)\b/) {
4917 "plain inline is preferred over $1\n" . $herecurr) &&
4919 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
4924 # Check for __attribute__ packed, prefer __packed
4925 if ($realfile !~ m@\binclude/uapi/@ &&
4926 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
4927 WARN("PREFER_PACKED",
4928 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
4931 # Check for __attribute__ aligned, prefer __aligned
4932 if ($realfile !~ m@\binclude/uapi/@ &&
4933 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
4934 WARN("PREFER_ALIGNED",
4935 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
4938 # Check for __attribute__ format(printf, prefer __printf
4939 if ($realfile !~ m@\binclude/uapi/@ &&
4940 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
4941 if (WARN("PREFER_PRINTF",
4942 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4944 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
4949 # Check for __attribute__ format(scanf, prefer __scanf
4950 if ($realfile !~ m@\binclude/uapi/@ &&
4951 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
4952 if (WARN("PREFER_SCANF",
4953 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4955 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
4959 # Check for __attribute__ weak, or __weak declarations (may have link issues)
4960 if ($^V && $^V ge 5.10.0 &&
4961 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
4962 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
4963 $line =~ /\b__weak\b/)) {
4964 ERROR("WEAK_DECLARATION",
4965 "Using weak declarations can have unintended link defects\n" . $herecurr);
4968 # check for sizeof(&)
4969 if ($line =~ /\bsizeof\s*\(\s*\&/) {
4970 WARN("SIZEOF_ADDRESS",
4971 "sizeof(& should be avoided\n" . $herecurr);
4974 # check for sizeof without parenthesis
4975 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
4976 if (WARN("SIZEOF_PARENTHESIS",
4977 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
4979 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
4983 # check for struct spinlock declarations
4984 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
4985 WARN("USE_SPINLOCK_T",
4986 "struct spinlock should be spinlock_t\n" . $herecurr);
4989 # check for seq_printf uses that could be seq_puts
4990 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
4991 my $fmt = get_quoted_string($line, $rawline);
4994 if (WARN("PREFER_SEQ_PUTS",
4995 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
4997 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
5002 # Check for misused memsets
5003 if ($^V && $^V ge 5.10.0 &&
5005 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
5011 if ($ms_size =~ /^(0x|)0$/i) {
5013 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
5014 } elsif ($ms_size =~ /^(0x|)1$/i) {
5016 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5020 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5021 if ($^V && $^V ge 5.10.0 &&
5022 $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) {
5023 if (WARN("PREFER_ETHER_ADDR_COPY",
5024 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
5026 $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5030 # typecasts on min/max could be min_t/max_t
5031 if ($^V && $^V ge 5.10.0 &&
5033 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
5034 if (defined $2 || defined $7) {
5036 my $cast1 = deparenthesize($2);
5038 my $cast2 = deparenthesize($7);
5042 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
5043 $cast = "$cast1 or $cast2";
5044 } elsif ($cast1 ne "") {
5050 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
5054 # check usleep_range arguments
5055 if ($^V && $^V ge 5.10.0 &&
5057 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5061 WARN("USLEEP_RANGE",
5062 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5063 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5065 WARN("USLEEP_RANGE",
5066 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5070 # check for naked sscanf
5071 if ($^V && $^V ge 5.10.0 &&
5073 $line =~ /\bsscanf\b/ &&
5074 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5075 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5076 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5077 my $lc = $stat =~ tr@\n@@;
5078 $lc = $lc + $linenr;
5079 my $stat_real = raw_line($linenr, 0);
5080 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5081 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5083 WARN("NAKED_SSCANF",
5084 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5087 # check for simple sscanf that should be kstrto<foo>
5088 if ($^V && $^V ge 5.10.0 &&
5090 $line =~ /\bsscanf\b/) {
5091 my $lc = $stat =~ tr@\n@@;
5092 $lc = $lc + $linenr;
5093 my $stat_real = raw_line($linenr, 0);
5094 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5095 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5097 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5099 my $count = $format =~ tr@%@%@;
5101 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5102 WARN("SSCANF_TO_KSTRTO",
5103 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5108 # check for new externs in .h files.
5109 if ($realfile =~ /\.h$/ &&
5110 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
5111 if (CHK("AVOID_EXTERNS",
5112 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
5114 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
5118 # check for new externs in .c files.
5119 if ($realfile =~ /\.c$/ && defined $stat &&
5120 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
5122 my $function_name = $1;
5123 my $paren_space = $2;
5126 if (defined $cond) {
5127 substr($s, 0, length($cond), '');
5129 if ($s =~ /^\s*;/ &&
5130 $function_name ne 'uninitialized_var')
5132 WARN("AVOID_EXTERNS",
5133 "externs should be avoided in .c files\n" . $herecurr);
5136 if ($paren_space =~ /\n/) {
5137 WARN("FUNCTION_ARGUMENTS",
5138 "arguments for function declarations should follow identifier\n" . $herecurr);
5141 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5142 $stat =~ /^.\s*extern\s+/)
5144 WARN("AVOID_EXTERNS",
5145 "externs should be avoided in .c files\n" . $herecurr);
5148 # checks for new __setup's
5149 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5152 if (!grep(/$name/, @setup_docs)) {
5153 CHK("UNDOCUMENTED_SETUP",
5154 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
5158 # check for pointless casting of kmalloc return
5159 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
5160 WARN("UNNECESSARY_CASTS",
5161 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
5165 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5166 if ($^V && $^V ge 5.10.0 &&
5167 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5168 CHK("ALLOC_SIZEOF_STRUCT",
5169 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
5172 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5173 if ($^V && $^V ge 5.10.0 &&
5174 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
5178 my $newfunc = "kmalloc_array";
5179 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
5182 if ($a1 =~ /^sizeof\s*\S/) {
5186 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
5187 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
5188 if (WARN("ALLOC_WITH_MULTIPLY",
5189 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
5191 $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;
5197 # check for krealloc arg reuse
5198 if ($^V && $^V ge 5.10.0 &&
5199 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
5200 WARN("KREALLOC_ARG_REUSE",
5201 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
5204 # check for alloc argument mismatch
5205 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
5206 WARN("ALLOC_ARRAY_ARGS",
5207 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
5210 # check for multiple semicolons
5211 if ($line =~ /;\s*;\s*$/) {
5212 if (WARN("ONE_SEMICOLON",
5213 "Statements terminations use 1 semicolon\n" . $herecurr) &&
5215 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
5219 # check for #defines like: 1 << <digit> that could be BIT(digit)
5220 if ($line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
5222 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
5223 if (CHK("BIT_MACRO",
5224 "Prefer using the BIT$ull macro\n" . $herecurr) &&
5226 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
5230 # check for case / default statements not preceded by break/fallthrough/switch
5231 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
5233 my $has_statement = 0;
5235 my $prevline = $linenr;
5236 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
5238 my $rline = $rawlines[$prevline - 1];
5239 my $fline = $lines[$prevline - 1];
5240 last if ($fline =~ /^\@\@/);
5241 next if ($fline =~ /^\-/);
5242 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
5243 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
5244 next if ($fline =~ /^.[\s$;]*$/);
5247 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
5249 if (!$has_break && $has_statement) {
5250 WARN("MISSING_BREAK",
5251 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
5255 # check for switch/default statements without a break;
5256 if ($^V && $^V ge 5.10.0 &&
5258 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
5260 my $herectx = $here . "\n";
5261 my $cnt = statement_rawlines($stat);
5262 for (my $n = 0; $n < $cnt; $n++) {
5263 $herectx .= raw_line($linenr, $n) . "\n";
5265 WARN("DEFAULT_NO_BREAK",
5266 "switch default: should use break\n" . $herectx);
5269 # check for gcc specific __FUNCTION__
5270 if ($line =~ /\b__FUNCTION__\b/) {
5271 if (WARN("USE_FUNC",
5272 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
5274 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
5278 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
5279 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
5281 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
5284 # check for use of yield()
5285 if ($line =~ /\byield\s*\(\s*\)/) {
5287 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
5290 # check for comparisons against true and false
5291 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
5299 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
5301 my $type = lc($otype);
5302 if ($type =~ /^(?:true|false)$/) {
5303 if (("$test" eq "==" && "$type" eq "true") ||
5304 ("$test" eq "!=" && "$type" eq "false")) {
5308 CHK("BOOL_COMPARISON",
5309 "Using comparison to $otype is error prone\n" . $herecurr);
5311 ## maybe suggesting a correct construct would better
5312 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5317 # check for semaphores initialized locked
5318 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
5319 WARN("CONSIDER_COMPLETION",
5320 "consider using a completion\n" . $herecurr);
5323 # recommend kstrto* over simple_strto* and strict_strto*
5324 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
5325 WARN("CONSIDER_KSTRTO",
5326 "$1 is obsolete, use k$3 instead\n" . $herecurr);
5329 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
5330 if ($line =~ /^.\s*__initcall\s*\(/) {
5331 WARN("USE_DEVICE_INITCALL",
5332 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
5335 # check for various structs that are normally const (ops, kgdb, device_tree)
5336 my $const_structs = qr{
5338 address_space_operations|
5340 block_device_operations|
5345 file_lock_operations|
5355 lock_manager_operations|
5362 pipe_buf_operations|
5363 platform_hibernation_ops|
5364 platform_suspend_ops|
5369 soc_pcmcia_socket_ops|
5376 if ($line !~ /\bconst\b/ &&
5377 $line =~ /\bstruct\s+($const_structs)\b/) {
5378 WARN("CONST_STRUCT",
5379 "struct $1 should normally be const\n" .
5383 # use of NR_CPUS is usually wrong
5384 # ignore definitions of NR_CPUS and usage to define arrays as likely right
5385 if ($line =~ /\bNR_CPUS\b/ &&
5386 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
5387 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
5388 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
5389 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
5390 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
5393 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
5396 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
5397 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
5398 ERROR("DEFINE_ARCH_HAS",
5399 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
5402 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
5403 if ($^V && $^V ge 5.10.0 &&
5404 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
5405 WARN("LIKELY_MISUSE",
5406 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
5409 # whine mightly about in_atomic
5410 if ($line =~ /\bin_atomic\s*\(/) {
5411 if ($realfile =~ m@^drivers/@) {
5413 "do not use in_atomic in drivers\n" . $herecurr);
5414 } elsif ($realfile !~ m@^kernel/@) {
5416 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
5420 # check for lockdep_set_novalidate_class
5421 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
5422 $line =~ /__lockdep_no_validate__\s*\)/ ) {
5423 if ($realfile !~ m@^kernel/lockdep@ &&
5424 $realfile !~ m@^include/linux/lockdep@ &&
5425 $realfile !~ m@^drivers/base/core@) {
5427 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
5431 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
5432 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
5433 WARN("EXPORTED_WORLD_WRITABLE",
5434 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5437 # Mode permission misuses where it seems decimal should be octal
5438 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5439 if ($^V && $^V ge 5.10.0 &&
5440 $line =~ /$mode_perms_search/) {
5441 foreach my $entry (@mode_permission_funcs) {
5442 my $func = $entry->[0];
5443 my $arg_pos = $entry->[1];
5448 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
5450 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
5451 if ($line =~ /$test/) {
5453 $val = $6 if ($skip_args ne "");
5455 if ($val !~ /^0$/ &&
5456 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
5457 length($val) ne 4)) {
5458 ERROR("NON_OCTAL_PERMISSIONS",
5459 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
5460 } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) {
5461 ERROR("EXPORTED_WORLD_WRITABLE",
5462 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5469 # If we have no input at all, then there is nothing to report on
5470 # so just keep quiet.
5471 if ($#rawlines == -1) {
5475 # In mailback mode only produce a report in the negative, for
5476 # things that appear to be patches.
5477 if ($mailback && ($clean == 1 || !$is_patch)) {
5481 # This is not a patch, and we are are in 'no-patch' mode so
5483 if (!$chk_patch && !$is_patch) {
5488 ERROR("NOT_UNIFIED_DIFF",
5489 "Does not appear to be a unified-diff format patch\n");
5491 if ($is_patch && $chk_signoff && $signoff == 0) {
5492 ERROR("MISSING_SIGN_OFF",
5493 "Missing Signed-off-by: line(s)\n");
5496 print report_dump();
5497 if ($summary && !($clean == 1 && $quiet == 1)) {
5498 print "$filename " if ($summary_file);
5499 print "total: $cnt_error errors, $cnt_warn warnings, " .
5500 (($check)? "$cnt_chk checks, " : "") .
5501 "$cnt_lines lines checked\n";
5502 print "\n" if ($quiet == 0);
5507 if ($^V lt 5.10.0) {
5508 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
5509 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
5512 # If there were whitespace errors which cleanpatch can fix
5513 # then suggest that.
5514 if ($rpt_cleaners) {
5515 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
5516 print " scripts/cleanfile\n\n";
5521 hash_show_words(\%use_type, "Used");
5522 hash_show_words(\%ignore_type, "Ignored");
5524 if ($clean == 0 && $fix &&
5525 ("@rawlines" ne "@fixed" ||
5526 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
5527 my $newfile = $filename;
5528 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
5532 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
5534 open($f, '>', $newfile)
5535 or die "$P: Can't open $newfile for write\n";
5536 foreach my $fixed_line (@fixed) {
5539 if ($linecount > 3) {
5540 $fixed_line =~ s/^\+//;
5541 print $f $fixed_line . "\n";
5544 print $f $fixed_line . "\n";
5551 Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
5553 Do _NOT_ trust the results written to this file.
5554 Do _NOT_ submit these changes without inspecting them for correctness.
5556 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
5557 No warranties, expressed or implied...
5563 if ($clean == 1 && $quiet == 0) {
5564 print "$vname has no obvious style problems and is ready for submission.\n"
5566 if ($clean == 0 && $quiet == 0) {
5568 $vname has style problems, please review.
5570 If any of these errors are false positives, please report
5571 them to the maintainer, see CHECKPATCH in MAINTAINERS.