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";
55 Usage: $P [OPTION]... [FILE]...
60 --no-tree run without a kernel tree
61 --no-signoff do not check for 'Signed-off-by' line
62 --patch treat FILE as patchfile (default)
63 --emacs emacs compile window format
64 --terse one line per report
65 -f, --file treat FILE as regular source file
66 --subjective, --strict enable more subjective tests
67 --types TYPE(,TYPE2...) show only these comma separated message types
68 --ignore TYPE(,TYPE2...) ignore various comma separated message types
69 --max-line-length=n set the maximum line length, if exceeded, warn
70 --min-conf-desc-length=n set the min description length, if shorter, warn
71 --show-types show the message "types" in the output
72 --root=PATH PATH to the kernel tree root
73 --no-summary suppress the per-file summary
74 --mailback only produce a report in case of warnings/errors
75 --summary-file include the filename in summary
76 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
77 'values', 'possible', 'type', and 'attr' (default
79 --test-only=WORD report only warnings/errors containing WORD
81 --fix EXPERIMENTAL - may create horrible results
82 If correctable single-line errors exist, create
83 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
84 with potential errors corrected to the preferred
86 --fix-inplace EXPERIMENTAL - may create horrible results
87 Is the same as --fix, but overwrites the input
88 file. It's your fault if there's no backup or git
89 --ignore-perl-version override checking of perl version. expect
91 -h, --help, --version display this help and exit
93 When FILE is - read standard input.
99 my $conf = which_conf($configuration_file);
102 open(my $conffile, '<', "$conf")
103 or warn "$P: Can't find a readable $configuration_file file $!\n";
105 while (<$conffile>) {
108 $line =~ s/\s*\n?$//g;
112 next if ($line =~ m/^\s*#/);
113 next if ($line =~ m/^\s*$/);
115 my @words = split(" ", $line);
116 foreach my $word (@words) {
117 last if ($word =~ m/^#/);
118 push (@conf_args, $word);
122 unshift(@ARGV, @conf_args) if @conf_args;
126 'q|quiet+' => \$quiet,
128 'signoff!' => \$chk_signoff,
129 'patch!' => \$chk_patch,
133 'subjective!' => \$check,
134 'strict!' => \$check,
135 'ignore=s' => \@ignore,
137 'show-types!' => \$show_types,
138 'max-line-length=i' => \$max_line_length,
139 'min-conf-desc-length=i' => \$min_conf_desc_length,
141 'summary!' => \$summary,
142 'mailback!' => \$mailback,
143 'summary-file!' => \$summary_file,
145 'fix-inplace!' => \$fix_inplace,
146 'ignore-perl-version!' => \$ignore_perl_version,
147 'debug=s' => \%debug,
148 'test-only=s' => \$tst_only,
155 $fix = 1 if ($fix_inplace);
156 $check_orig = $check;
160 if ($^V && $^V lt $minimum_perl_version) {
161 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
162 if (!$ignore_perl_version) {
168 print "$P: no input files\n";
172 sub hash_save_array_words {
173 my ($hashRef, $arrayRef) = @_;
175 my @array = split(/,/, join(',', @$arrayRef));
176 foreach my $word (@array) {
177 $word =~ s/\s*\n?$//g;
180 $word =~ tr/[a-z]/[A-Z]/;
182 next if ($word =~ m/^\s*#/);
183 next if ($word =~ m/^\s*$/);
189 sub hash_show_words {
190 my ($hashRef, $prefix) = @_;
192 if ($quiet == 0 && keys %$hashRef) {
193 print "NOTE: $prefix message types:";
194 foreach my $word (sort keys %$hashRef) {
201 hash_save_array_words(\%ignore_type, \@ignore);
202 hash_save_array_words(\%use_type, \@use);
205 my $dbg_possible = 0;
208 for my $key (keys %debug) {
210 eval "\${dbg_$key} = '$debug{$key}';";
214 my $rpt_cleaners = 0;
223 if (!top_of_kernel_tree($root)) {
224 die "$P: $root: --root does not point at a valid tree\n";
227 if (top_of_kernel_tree('.')) {
229 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
230 top_of_kernel_tree($1)) {
235 if (!defined $root) {
236 print "Must be run from the top-level dir. of a kernel tree\n";
241 my $emitted_corrupt = 0;
244 [A-Za-z_][A-Za-z\d_]*
245 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
247 our $Storage = qr{extern|static|asmlinkage};
259 our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
260 our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
261 our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
262 our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
263 our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
265 # Notes to $Attribute:
266 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
287 ____cacheline_aligned|
288 ____cacheline_aligned_in_smp|
289 ____cacheline_internodealigned_in_smp|
293 our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
294 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
295 our $Lval = qr{$Ident(?:$Member)*};
297 our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
298 our $Binary = qr{(?i)0b[01]+$Int_type?};
299 our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
300 our $Int = qr{[0-9]+$Int_type?};
301 our $Octal = qr{0[0-7]+$Int_type?};
302 our $String = qr{"[X\t]*"};
303 our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
304 our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
305 our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
306 our $Float = qr{$Float_hex|$Float_dec|$Float_int};
307 our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
308 our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
309 our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
310 our $Arithmetic = qr{\+|-|\*|\/|%};
314 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
317 our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
320 our $NonptrTypeMisordered;
321 our $NonptrTypeWithAttr;
325 our $DeclareMisordered;
327 our $NON_ASCII_UTF8 = qr{
328 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
329 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
330 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
331 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
332 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
333 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
334 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
338 [\x09\x0A\x0D\x20-\x7E] # ASCII
342 our $typeOtherOSTypedefs = qr{(?x:
343 u_(?:char|short|int|long) | # bsd
344 u(?:nchar|short|int|long) # sysv
347 our $typeTypedefs = qr{(?x:
348 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
352 our $logFunctions = qr{(?x:
353 printk(?:_ratelimited|_once|)|
354 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
355 WARN(?:_RATELIMIT|_ONCE|)|
358 seq_vprintf|seq_printf|seq_puts
361 our $signature_tags = qr{(?xi:
372 our @typeListMisordered = (
373 qr{char\s+(?:un)?signed},
374 qr{int\s+(?:(?:un)?signed\s+)?short\s},
375 qr{int\s+short(?:\s+(?:un)?signed)},
376 qr{short\s+int(?:\s+(?:un)?signed)},
377 qr{(?:un)?signed\s+int\s+short},
378 qr{short\s+(?:un)?signed},
379 qr{long\s+int\s+(?:un)?signed},
380 qr{int\s+long\s+(?:un)?signed},
381 qr{long\s+(?:un)?signed\s+int},
382 qr{int\s+(?:un)?signed\s+long},
383 qr{int\s+(?:un)?signed},
384 qr{int\s+long\s+long\s+(?:un)?signed},
385 qr{long\s+long\s+int\s+(?:un)?signed},
386 qr{long\s+long\s+(?:un)?signed\s+int},
387 qr{long\s+long\s+(?:un)?signed},
388 qr{long\s+(?:un)?signed},
393 qr{(?:(?:un)?signed\s+)?char},
394 qr{(?:(?:un)?signed\s+)?short\s+int},
395 qr{(?:(?:un)?signed\s+)?short},
396 qr{(?:(?:un)?signed\s+)?int},
397 qr{(?:(?:un)?signed\s+)?long\s+int},
398 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
399 qr{(?:(?:un)?signed\s+)?long\s+long},
400 qr{(?:(?:un)?signed\s+)?long},
409 qr{${Ident}_handler},
410 qr{${Ident}_handler_fn},
413 our @typeListWithAttr = (
415 qr{struct\s+$InitAttribute\s+$Ident},
416 qr{union\s+$InitAttribute\s+$Ident},
419 our @modifierList = (
423 our @mode_permission_funcs = (
425 ["module_param_(?:array|named|string)", 4],
426 ["module_param_array_named", 5],
427 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
428 ["proc_create(?:_data|)", 2],
429 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
432 #Create a search pattern for all these functions to speed up a loop below
433 our $mode_perms_search = "";
434 foreach my $entry (@mode_permission_funcs) {
435 $mode_perms_search .= '|' if ($mode_perms_search ne "");
436 $mode_perms_search .= $entry->[0];
439 our $allowed_asm_includes = qr{(?x:
445 # memory.h: ARM has a custom one
447 # Load common spelling mistakes and build regular expression list.
451 if (open(my $spelling, '<', $spelling_file)) {
453 while (<$spelling>) {
456 $line =~ s/\s*\n?$//g;
459 next if ($line =~ m/^\s*#/);
460 next if ($line =~ m/^\s*$/);
462 my ($suspect, $fix) = split(/\|\|/, $line);
464 push(@spelling_list, $suspect);
465 $spelling_fix{$suspect} = $fix;
468 $misspellings = join("|", @spelling_list);
470 warn "No typos will be found - file '$spelling_file': $!\n";
474 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
475 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
476 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
477 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
478 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
480 (?:$Modifier\s+|const\s+)*
482 (?:typeof|__typeof__)\s*\([^\)]*\)|
483 (?:$typeOtherOSTypedefs\b)|
487 (?:\s+$Modifier|\s+const)*
489 $NonptrTypeMisordered = qr{
490 (?:$Modifier\s+|const\s+)*
494 (?:\s+$Modifier|\s+const)*
496 $NonptrTypeWithAttr = qr{
497 (?:$Modifier\s+|const\s+)*
499 (?:typeof|__typeof__)\s*\([^\)]*\)|
501 (?:$typeOtherOSTypedefs\b)|
504 (?:\s+$Modifier|\s+const)*
508 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
509 (?:\s+$Inline|\s+$Modifier)*
511 $TypeMisordered = qr{
512 $NonptrTypeMisordered
513 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
514 (?:\s+$Inline|\s+$Modifier)*
516 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
517 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
521 our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
523 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
524 # requires at least perl version v5.10.0
525 # Any use must be runtime checked with $^V
527 our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
528 our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
529 our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
531 our $declaration_macros = qr{(?x:
532 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,2}\s*\(|
533 (?:$Storage\s+)?LIST_HEAD\s*\(|
534 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
539 return "" if (!defined($string));
541 while ($string =~ /^\s*\(.*\)\s*$/) {
542 $string =~ s@^\s*\(\s*@@;
543 $string =~ s@\s*\)\s*$@@;
546 $string =~ s@\s+@ @g;
551 sub seed_camelcase_file {
554 return if (!(-f $file));
558 open(my $include_file, '<', "$file")
559 or warn "$P: Can't read '$file' $!\n";
560 my $text = <$include_file>;
561 close($include_file);
563 my @lines = split('\n', $text);
565 foreach my $line (@lines) {
566 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
567 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
569 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
571 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
577 my $camelcase_seeded = 0;
578 sub seed_camelcase_includes {
579 return if ($camelcase_seeded);
582 my $camelcase_cache = "";
583 my @include_files = ();
585 $camelcase_seeded = 1;
588 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
589 chomp $git_last_include_commit;
590 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
592 my $last_mod_date = 0;
593 $files = `find $root/include -name "*.h"`;
594 @include_files = split('\n', $files);
595 foreach my $file (@include_files) {
596 my $date = POSIX::strftime("%Y%m%d%H%M",
597 localtime((stat $file)[9]));
598 $last_mod_date = $date if ($last_mod_date < $date);
600 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
603 if ($camelcase_cache ne "" && -f $camelcase_cache) {
604 open(my $camelcase_file, '<', "$camelcase_cache")
605 or warn "$P: Can't read '$camelcase_cache' $!\n";
606 while (<$camelcase_file>) {
610 close($camelcase_file);
616 $files = `git ls-files "include/*.h"`;
617 @include_files = split('\n', $files);
620 foreach my $file (@include_files) {
621 seed_camelcase_file($file);
624 if ($camelcase_cache ne "") {
625 unlink glob ".checkpatch-camelcase.*";
626 open(my $camelcase_file, '>', "$camelcase_cache")
627 or warn "$P: Can't write '$camelcase_cache' $!\n";
628 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
629 print $camelcase_file ("$_\n");
631 close($camelcase_file);
635 sub git_commit_info {
636 my ($commit, $id, $desc) = @_;
638 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
640 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
641 $output =~ s/^\s*//gm;
642 my @lines = split("\n", $output);
644 return ($id, $desc) if ($#lines < 0);
646 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
647 # Maybe one day convert this block of bash into something that returns
648 # all matching commit ids, but it's very slow...
650 # echo "checking commits $1..."
651 # git rev-list --remotes | grep -i "^$1" |
652 # while read line ; do
653 # git log --format='%H %s' -1 $line |
654 # echo "commit $(cut -c 1-12,41-)"
656 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
658 $id = substr($lines[0], 0, 12);
659 $desc = substr($lines[0], 41);
665 $chk_signoff = 0 if ($file);
670 my @fixed_inserted = ();
671 my @fixed_deleted = ();
675 for my $filename (@ARGV) {
678 open($FILE, '-|', "diff -u /dev/null $filename") ||
679 die "$P: $filename: diff failed - $!\n";
680 } elsif ($filename eq '-') {
681 open($FILE, '<&STDIN');
683 open($FILE, '<', "$filename") ||
684 die "$P: $filename: open failed - $!\n";
686 if ($filename eq '-') {
687 $vname = 'Your patch';
696 if (!process($filename)) {
702 @fixed_inserted = ();
709 sub top_of_kernel_tree {
713 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
714 "README", "Documentation", "arch", "include", "drivers",
715 "fs", "init", "ipc", "kernel", "lib", "scripts",
718 foreach my $check (@tree_check) {
719 if (! -e $root . '/' . $check) {
727 my ($formatted_email) = @_;
733 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
736 $comment = $3 if defined $3;
737 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
739 $comment = $2 if defined $2;
740 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
742 $comment = $2 if defined $2;
743 $formatted_email =~ s/$address.*$//;
744 $name = $formatted_email;
746 $name =~ s/^\"|\"$//g;
747 # If there's a name left after stripping spaces and
748 # leading quotes, and the address doesn't have both
749 # leading and trailing angle brackets, the address
751 # "joe smith joe@smith.com" bad
752 # "joe smith <joe@smith.com" bad
753 if ($name ne "" && $address !~ /^<[^>]+>$/) {
761 $name =~ s/^\"|\"$//g;
762 $address = trim($address);
763 $address =~ s/^\<|\>$//g;
765 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
766 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
770 return ($name, $address, $comment);
774 my ($name, $address) = @_;
779 $name =~ s/^\"|\"$//g;
780 $address = trim($address);
782 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
783 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
788 $formatted_email = "$address";
790 $formatted_email = "$name <$address>";
793 return $formatted_email;
799 foreach my $path (split(/:/, $ENV{PATH})) {
800 if (-e "$path/$bin") {
811 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
812 if (-e "$path/$conf") {
813 return "$path/$conf";
825 for my $c (split(//, $str)) {
829 for (; ($n % 8) != 0; $n++) {
841 (my $res = shift) =~ tr/\t/ /c;
848 # Drop the diff line leader and expand tabs
850 $line = expand_tabs($line);
852 # Pick the indent from the front of the line.
853 my ($white) = ($line =~ /^(\s*)/);
855 return (length($line), length($white));
858 my $sanitise_quote = '';
860 sub sanitise_line_reset {
861 my ($in_comment) = @_;
864 $sanitise_quote = '*/';
866 $sanitise_quote = '';
879 # Always copy over the diff marker.
880 $res = substr($line, 0, 1);
882 for ($off = 1; $off < length($line); $off++) {
883 $c = substr($line, $off, 1);
885 # Comments we are wacking completly including the begin
886 # and end, all to $;.
887 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
888 $sanitise_quote = '*/';
890 substr($res, $off, 2, "$;$;");
894 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
895 $sanitise_quote = '';
896 substr($res, $off, 2, "$;$;");
900 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
901 $sanitise_quote = '//';
903 substr($res, $off, 2, $sanitise_quote);
908 # A \ in a string means ignore the next character.
909 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
911 substr($res, $off, 2, 'XX');
916 if ($c eq "'" || $c eq '"') {
917 if ($sanitise_quote eq '') {
918 $sanitise_quote = $c;
920 substr($res, $off, 1, $c);
922 } elsif ($sanitise_quote eq $c) {
923 $sanitise_quote = '';
927 #print "c<$c> SQ<$sanitise_quote>\n";
928 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
929 substr($res, $off, 1, $;);
930 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
931 substr($res, $off, 1, $;);
932 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
933 substr($res, $off, 1, 'X');
935 substr($res, $off, 1, $c);
939 if ($sanitise_quote eq '//') {
940 $sanitise_quote = '';
943 # The pathname on a #include may be surrounded by '<' and '>'.
944 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
945 my $clean = 'X' x length($1);
946 $res =~ s@\<.*\>@<$clean>@;
948 # The whole of a #error is a string.
949 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
950 my $clean = 'X' x length($1);
951 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
957 sub get_quoted_string {
958 my ($line, $rawline) = @_;
960 return "" if ($line !~ m/(\"[X\t]+\")/g);
961 return substr($rawline, $-[0], $+[0] - $-[0]);
964 sub ctx_statement_block {
965 my ($linenr, $remain, $off) = @_;
966 my $line = $linenr - 1;
983 @stack = (['', 0]) if ($#stack == -1);
985 #warn "CSB: blk<$blk> remain<$remain>\n";
986 # If we are about to drop off the end, pull in more
989 for (; $remain > 0; $line++) {
990 last if (!defined $lines[$line]);
991 next if ($lines[$line] =~ /^-/);
994 $blk .= $lines[$line] . "\n";
999 # Bail if there is no further context.
1000 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1004 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1010 $c = substr($blk, $off, 1);
1011 $remainder = substr($blk, $off);
1013 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1015 # Handle nested #if/#else.
1016 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1017 push(@stack, [ $type, $level ]);
1018 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1019 ($type, $level) = @{$stack[$#stack - 1]};
1020 } elsif ($remainder =~ /^#\s*endif\b/) {
1021 ($type, $level) = @{pop(@stack)};
1024 # Statement ends at the ';' or a close '}' at the
1026 if ($level == 0 && $c eq ';') {
1030 # An else is really a conditional as long as its not else if
1031 if ($level == 0 && $coff_set == 0 &&
1032 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1033 $remainder =~ /^(else)(?:\s|{)/ &&
1034 $remainder !~ /^else\s+if\b/) {
1035 $coff = $off + length($1) - 1;
1037 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1038 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1041 if (($type eq '' || $type eq '(') && $c eq '(') {
1045 if ($type eq '(' && $c eq ')') {
1047 $type = ($level != 0)? '(' : '';
1049 if ($level == 0 && $coff < $soff) {
1052 #warn "CSB: mark coff<$coff>\n";
1055 if (($type eq '' || $type eq '{') && $c eq '{') {
1059 if ($type eq '{' && $c eq '}') {
1061 $type = ($level != 0)? '{' : '';
1064 if (substr($blk, $off + 1, 1) eq ';') {
1070 # Preprocessor commands end at the newline unless escaped.
1071 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1079 # We are truly at the end, so shuffle to the next line.
1086 my $statement = substr($blk, $soff, $off - $soff + 1);
1087 my $condition = substr($blk, $soff, $coff - $soff + 1);
1089 #warn "STATEMENT<$statement>\n";
1090 #warn "CONDITION<$condition>\n";
1092 #print "coff<$coff> soff<$off> loff<$loff>\n";
1094 return ($statement, $condition,
1095 $line, $remain + 1, $off - $loff + 1, $level);
1098 sub statement_lines {
1101 # Strip the diff line prefixes and rip blank lines at start and end.
1102 $stmt =~ s/(^|\n)./$1/g;
1106 my @stmt_lines = ($stmt =~ /\n/g);
1108 return $#stmt_lines + 2;
1111 sub statement_rawlines {
1114 my @stmt_lines = ($stmt =~ /\n/g);
1116 return $#stmt_lines + 2;
1119 sub statement_block_size {
1122 $stmt =~ s/(^|\n)./$1/g;
1128 my @stmt_lines = ($stmt =~ /\n/g);
1129 my @stmt_statements = ($stmt =~ /;/g);
1131 my $stmt_lines = $#stmt_lines + 2;
1132 my $stmt_statements = $#stmt_statements + 1;
1134 if ($stmt_lines > $stmt_statements) {
1137 return $stmt_statements;
1141 sub ctx_statement_full {
1142 my ($linenr, $remain, $off) = @_;
1143 my ($statement, $condition, $level);
1147 # Grab the first conditional/block pair.
1148 ($statement, $condition, $linenr, $remain, $off, $level) =
1149 ctx_statement_block($linenr, $remain, $off);
1150 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1151 push(@chunks, [ $condition, $statement ]);
1152 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1153 return ($level, $linenr, @chunks);
1156 # Pull in the following conditional/block pairs and see if they
1157 # could continue the statement.
1159 ($statement, $condition, $linenr, $remain, $off, $level) =
1160 ctx_statement_block($linenr, $remain, $off);
1161 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1162 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1164 push(@chunks, [ $condition, $statement ]);
1167 return ($level, $linenr, @chunks);
1171 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1173 my $start = $linenr - 1;
1180 my @stack = ($level);
1181 for ($line = $start; $remain > 0; $line++) {
1182 next if ($rawlines[$line] =~ /^-/);
1185 $blk .= $rawlines[$line];
1187 # Handle nested #if/#else.
1188 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1189 push(@stack, $level);
1190 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1191 $level = $stack[$#stack - 1];
1192 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1193 $level = pop(@stack);
1196 foreach my $c (split(//, $lines[$line])) {
1197 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1203 if ($c eq $close && $level > 0) {
1205 last if ($level == 0);
1206 } elsif ($c eq $open) {
1211 if (!$outer || $level <= 1) {
1212 push(@res, $rawlines[$line]);
1215 last if ($level == 0);
1218 return ($level, @res);
1220 sub ctx_block_outer {
1221 my ($linenr, $remain) = @_;
1223 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1227 my ($linenr, $remain) = @_;
1229 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1233 my ($linenr, $remain, $off) = @_;
1235 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1238 sub ctx_block_level {
1239 my ($linenr, $remain) = @_;
1241 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1243 sub ctx_statement_level {
1244 my ($linenr, $remain, $off) = @_;
1246 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1249 sub ctx_locate_comment {
1250 my ($first_line, $end_line) = @_;
1252 # Catch a comment on the end of the line itself.
1253 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1254 return $current_comment if (defined $current_comment);
1256 # Look through the context and try and figure out if there is a
1259 $current_comment = '';
1260 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1261 my $line = $rawlines[$linenr - 1];
1263 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1266 if ($line =~ m@/\*@) {
1269 if (!$in_comment && $current_comment ne '') {
1270 $current_comment = '';
1272 $current_comment .= $line . "\n" if ($in_comment);
1273 if ($line =~ m@\*/@) {
1278 chomp($current_comment);
1279 return($current_comment);
1281 sub ctx_has_comment {
1282 my ($first_line, $end_line) = @_;
1283 my $cmt = ctx_locate_comment($first_line, $end_line);
1285 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1286 ##print "CMMT: $cmt\n";
1288 return ($cmt ne '');
1292 my ($linenr, $cnt) = @_;
1294 my $offset = $linenr - 1;
1299 $line = $rawlines[$offset++];
1300 next if (defined($line) && $line =~ /^-/);
1312 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1315 $coded = sprintf("^%c", unpack('C', $2) + 64);
1324 my $av_preprocessor = 0;
1329 sub annotate_reset {
1330 $av_preprocessor = 0;
1332 @av_paren_type = ('E');
1333 $av_pend_colon = 'O';
1336 sub annotate_values {
1337 my ($stream, $type) = @_;
1340 my $var = '_' x length($stream);
1343 print "$stream\n" if ($dbg_values > 1);
1345 while (length($cur)) {
1346 @av_paren_type = ('E') if ($#av_paren_type < 0);
1347 print " <" . join('', @av_paren_type) .
1348 "> <$type> <$av_pending>" if ($dbg_values > 1);
1349 if ($cur =~ /^(\s+)/o) {
1350 print "WS($1)\n" if ($dbg_values > 1);
1351 if ($1 =~ /\n/ && $av_preprocessor) {
1352 $type = pop(@av_paren_type);
1353 $av_preprocessor = 0;
1356 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1357 print "CAST($1)\n" if ($dbg_values > 1);
1358 push(@av_paren_type, $type);
1361 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1362 print "DECLARE($1)\n" if ($dbg_values > 1);
1365 } elsif ($cur =~ /^($Modifier)\s*/) {
1366 print "MODIFIER($1)\n" if ($dbg_values > 1);
1369 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1370 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1371 $av_preprocessor = 1;
1372 push(@av_paren_type, $type);
1378 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1379 print "UNDEF($1)\n" if ($dbg_values > 1);
1380 $av_preprocessor = 1;
1381 push(@av_paren_type, $type);
1383 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1384 print "PRE_START($1)\n" if ($dbg_values > 1);
1385 $av_preprocessor = 1;
1387 push(@av_paren_type, $type);
1388 push(@av_paren_type, $type);
1391 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1392 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1393 $av_preprocessor = 1;
1395 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1399 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1400 print "PRE_END($1)\n" if ($dbg_values > 1);
1402 $av_preprocessor = 1;
1404 # Assume all arms of the conditional end as this
1405 # one does, and continue as if the #endif was not here.
1406 pop(@av_paren_type);
1407 push(@av_paren_type, $type);
1410 } elsif ($cur =~ /^(\\\n)/o) {
1411 print "PRECONT($1)\n" if ($dbg_values > 1);
1413 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1414 print "ATTR($1)\n" if ($dbg_values > 1);
1415 $av_pending = $type;
1418 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1419 print "SIZEOF($1)\n" if ($dbg_values > 1);
1425 } elsif ($cur =~ /^(if|while|for)\b/o) {
1426 print "COND($1)\n" if ($dbg_values > 1);
1430 } elsif ($cur =~/^(case)/o) {
1431 print "CASE($1)\n" if ($dbg_values > 1);
1432 $av_pend_colon = 'C';
1435 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1436 print "KEYWORD($1)\n" if ($dbg_values > 1);
1439 } elsif ($cur =~ /^(\()/o) {
1440 print "PAREN('$1')\n" if ($dbg_values > 1);
1441 push(@av_paren_type, $av_pending);
1445 } elsif ($cur =~ /^(\))/o) {
1446 my $new_type = pop(@av_paren_type);
1447 if ($new_type ne '_') {
1449 print "PAREN('$1') -> $type\n"
1450 if ($dbg_values > 1);
1452 print "PAREN('$1')\n" if ($dbg_values > 1);
1455 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1456 print "FUNC($1)\n" if ($dbg_values > 1);
1460 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1461 if (defined $2 && $type eq 'C' || $type eq 'T') {
1462 $av_pend_colon = 'B';
1463 } elsif ($type eq 'E') {
1464 $av_pend_colon = 'L';
1466 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1469 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1470 print "IDENT($1)\n" if ($dbg_values > 1);
1473 } elsif ($cur =~ /^($Assignment)/o) {
1474 print "ASSIGN($1)\n" if ($dbg_values > 1);
1477 } elsif ($cur =~/^(;|{|})/) {
1478 print "END($1)\n" if ($dbg_values > 1);
1480 $av_pend_colon = 'O';
1482 } elsif ($cur =~/^(,)/) {
1483 print "COMMA($1)\n" if ($dbg_values > 1);
1486 } elsif ($cur =~ /^(\?)/o) {
1487 print "QUESTION($1)\n" if ($dbg_values > 1);
1490 } elsif ($cur =~ /^(:)/o) {
1491 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1493 substr($var, length($res), 1, $av_pend_colon);
1494 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1499 $av_pend_colon = 'O';
1501 } elsif ($cur =~ /^(\[)/o) {
1502 print "CLOSE($1)\n" if ($dbg_values > 1);
1505 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1508 print "OPV($1)\n" if ($dbg_values > 1);
1515 substr($var, length($res), 1, $variant);
1518 } elsif ($cur =~ /^($Operators)/o) {
1519 print "OP($1)\n" if ($dbg_values > 1);
1520 if ($1 ne '++' && $1 ne '--') {
1524 } elsif ($cur =~ /(^.)/o) {
1525 print "C($1)\n" if ($dbg_values > 1);
1528 $cur = substr($cur, length($1));
1529 $res .= $type x length($1);
1533 return ($res, $var);
1537 my ($possible, $line) = @_;
1538 my $notPermitted = qr{(?:
1555 ^(?:typedef|struct|enum)\b
1557 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1558 if ($possible !~ $notPermitted) {
1559 # Check for modifiers.
1560 $possible =~ s/\s*$Storage\s*//g;
1561 $possible =~ s/\s*$Sparse\s*//g;
1562 if ($possible =~ /^\s*$/) {
1564 } elsif ($possible =~ /\s/) {
1565 $possible =~ s/\s*$Type\s*//g;
1566 for my $modifier (split(' ', $possible)) {
1567 if ($modifier !~ $notPermitted) {
1568 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1569 push(@modifierList, $modifier);
1574 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1575 push(@typeList, $possible);
1579 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1588 return defined $use_type{$type} if (scalar keys %use_type > 0);
1590 return !defined $ignore_type{$type};
1594 my ($level, $type, $msg) = @_;
1596 if (!show_type($type) ||
1597 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
1602 $line = "$prefix$level:$type: $msg\n";
1604 $line = "$prefix$level: $msg\n";
1606 $line = (split('\n', $line))[0] . "\n" if ($terse);
1608 push(our @report, $line);
1617 sub fixup_current_range {
1618 my ($lineRef, $offset, $length) = @_;
1620 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1623 my $no = $o + $offset;
1624 my $nl = $l + $length;
1625 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1629 sub fix_inserted_deleted_lines {
1630 my ($linesRef, $insertedRef, $deletedRef) = @_;
1632 my $range_last_linenr = 0;
1633 my $delta_offset = 0;
1638 my $next_insert = 0;
1639 my $next_delete = 0;
1643 my $inserted = @{$insertedRef}[$next_insert++];
1644 my $deleted = @{$deletedRef}[$next_delete++];
1646 foreach my $old_line (@{$linesRef}) {
1648 my $line = $old_line; #don't modify the array
1649 if ($line =~ /^(?:\+\+\+\|\-\-\-)\s+\S+/) { #new filename
1651 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1652 $range_last_linenr = $new_linenr;
1653 fixup_current_range(\$line, $delta_offset, 0);
1656 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1657 $deleted = @{$deletedRef}[$next_delete++];
1659 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1662 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1663 push(@lines, ${$inserted}{'LINE'});
1664 $inserted = @{$insertedRef}[$next_insert++];
1666 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1670 push(@lines, $line);
1680 sub fix_insert_line {
1681 my ($linenr, $line) = @_;
1687 push(@fixed_inserted, $inserted);
1690 sub fix_delete_line {
1691 my ($linenr, $line) = @_;
1698 push(@fixed_deleted, $deleted);
1702 my ($type, $msg) = @_;
1704 if (report("ERROR", $type, $msg)) {
1712 my ($type, $msg) = @_;
1714 if (report("WARNING", $type, $msg)) {
1722 my ($type, $msg) = @_;
1724 if ($check && report("CHECK", $type, $msg)) {
1732 sub check_absolute_file {
1733 my ($absolute, $herecurr) = @_;
1734 my $file = $absolute;
1736 ##print "absolute<$absolute>\n";
1738 # See if any suffix of this path is a path within the tree.
1739 while ($file =~ s@^[^/]*/@@) {
1740 if (-f "$root/$file") {
1741 ##print "file<$file>\n";
1749 # It is, so see if the prefix is acceptable.
1750 my $prefix = $absolute;
1751 substr($prefix, -length($file)) = '';
1753 ##print "prefix<$prefix>\n";
1754 if ($prefix ne ".../") {
1755 WARN("USE_RELATIVE_PATH",
1756 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1763 $string =~ s/^\s+|\s+$//g;
1771 $string =~ s/^\s+//;
1779 $string =~ s/\s+$//;
1784 sub string_find_replace {
1785 my ($string, $find, $replace) = @_;
1787 $string =~ s/$find/$replace/g;
1795 my $source_indent = 8;
1796 my $max_spaces_before_tab = $source_indent - 1;
1797 my $spaces_to_tab = " " x $source_indent;
1799 #convert leading spaces to tabs
1800 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1801 #Remove spaces before a tab
1802 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1807 sub pos_last_openparen {
1812 my $opens = $line =~ tr/\(/\(/;
1813 my $closes = $line =~ tr/\)/\)/;
1815 my $last_openparen = 0;
1817 if (($opens == 0) || ($closes >= $opens)) {
1821 my $len = length($line);
1823 for ($pos = 0; $pos < $len; $pos++) {
1824 my $string = substr($line, $pos);
1825 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1826 $pos += length($1) - 1;
1827 } elsif (substr($line, $pos, 1) eq '(') {
1828 $last_openparen = $pos;
1829 } elsif (index($string, '(') == -1) {
1834 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
1838 my $filename = shift;
1844 my $stashrawline="";
1855 my $in_header_lines = $file ? 0 : 1;
1856 my $in_commit_log = 0; #Scanning lines before patch
1857 my $reported_maintainer_file = 0;
1858 my $non_utf8_charset = 0;
1860 my $last_blank_line = 0;
1861 my $last_coalesced_string_linenr = -1;
1869 # Trace the real file/line as we go.
1875 my $comment_edge = 0;
1879 my $prev_values = 'E';
1882 my %suppress_ifbraces;
1883 my %suppress_whiletrailers;
1884 my %suppress_export;
1885 my $suppress_statement = 0;
1887 my %signatures = ();
1889 # Pre-scan the patch sanitizing the lines.
1890 # Pre-scan the patch looking for any __setup documentation.
1892 my @setup_docs = ();
1895 my $camelcase_file_seeded = 0;
1897 sanitise_line_reset();
1899 foreach my $rawline (@rawlines) {
1903 push(@fixed, $rawline) if ($fix);
1905 if ($rawline=~/^\+\+\+\s+(\S+)/) {
1907 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1912 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1921 # Guestimate if this is a continuing comment. Run
1922 # the context looking for a comment "edge". If this
1923 # edge is a close comment then we must be in a comment
1927 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1928 next if (defined $rawlines[$ln - 1] &&
1929 $rawlines[$ln - 1] =~ /^-/);
1931 #print "RAW<$rawlines[$ln - 1]>\n";
1932 last if (!defined $rawlines[$ln - 1]);
1933 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1934 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1939 if (defined $edge && $edge eq '*/') {
1943 # Guestimate if this is a continuing comment. If this
1944 # is the start of a diff block and this line starts
1945 # ' *' then it is very likely a comment.
1946 if (!defined $edge &&
1947 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1952 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1953 sanitise_line_reset($in_comment);
1955 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1956 # Standardise the strings and chars within the input to
1957 # simplify matching -- only bother with positive lines.
1958 $line = sanitise_line($rawline);
1960 push(@lines, $line);
1963 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1968 #print "==>$rawline\n";
1969 #print "-->$line\n";
1971 if ($setup_docs && $line =~ /^\+/) {
1972 push(@setup_docs, $line);
1981 foreach my $line (@lines) {
1984 my $sline = $line; #copy of $line
1985 $sline =~ s/$;/ /g; #with comments as spaces
1987 my $rawline = $rawlines[$linenr - 1];
1989 #extract the line range in the file after the patch is applied
1990 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1992 $first_line = $linenr + 1;
2002 %suppress_ifbraces = ();
2003 %suppress_whiletrailers = ();
2004 %suppress_export = ();
2005 $suppress_statement = 0;
2008 # track the line number as we move through the hunk, note that
2009 # new versions of GNU diff omit the leading space on completely
2010 # blank context lines so we need to count that too.
2011 } elsif ($line =~ /^( |\+|$)/) {
2013 $realcnt-- if ($realcnt != 0);
2015 # Measure the line length and indent.
2016 ($length, $indent) = line_stats($rawline);
2018 # Track the previous line.
2019 ($prevline, $stashline) = ($stashline, $line);
2020 ($previndent, $stashindent) = ($stashindent, $indent);
2021 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2023 #warn "line<$line>\n";
2025 } elsif ($realcnt == 1) {
2029 my $hunk_line = ($realcnt != 0);
2031 #make up the handle for any error we report on this line
2032 $prefix = "$filename:$realline: " if ($emacs && $file);
2033 $prefix = "$filename:$linenr: " if ($emacs && !$file);
2035 $here = "#$linenr: " if (!$file);
2036 $here = "#$realline: " if ($file);
2039 # extract the filename as it passes
2040 if ($line =~ /^diff --git.*?(\S+)$/) {
2042 $realfile =~ s@^([^/]*)/@@ if (!$file);
2045 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2047 $realfile =~ s@^([^/]*)/@@ if (!$file);
2051 if (!$file && $tree && $p1_prefix ne '' &&
2052 -e "$root/$p1_prefix") {
2053 WARN("PATCH_PREFIX",
2054 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
2057 if ($realfile =~ m@^include/asm/@) {
2058 ERROR("MODIFIED_INCLUDE_ASM",
2059 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2065 if ($realfile =~ m@^(drivers/net/|net/)@) {
2068 $check = $check_orig;
2073 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
2075 my $hereline = "$here\n$rawline\n";
2076 my $herecurr = "$here\n$rawline\n";
2077 my $hereprev = "$here\n$prevrawline\n$rawline\n";
2079 $cnt_lines++ if ($realcnt != 0);
2081 # Check for incorrect file permissions
2082 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2083 my $permhere = $here . "FILE: $realfile\n";
2084 if ($realfile !~ m@scripts/@ &&
2085 $realfile !~ /\.(py|pl|awk|sh)$/) {
2086 ERROR("EXECUTE_PERMISSIONS",
2087 "do not set execute permissions for source files\n" . $permhere);
2091 # Check the patch for a signoff:
2092 if ($line =~ /^\s*signed-off-by:/i) {
2097 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2098 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2099 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2100 $reported_maintainer_file = 1;
2103 # Check signature styles
2104 if (!$in_header_lines &&
2105 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
2106 my $space_before = $1;
2108 my $space_after = $3;
2110 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2112 if ($sign_off !~ /$signature_tags/) {
2113 WARN("BAD_SIGN_OFF",
2114 "Non-standard signature: $sign_off\n" . $herecurr);
2116 if (defined $space_before && $space_before ne "") {
2117 if (WARN("BAD_SIGN_OFF",
2118 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2120 $fixed[$fixlinenr] =
2121 "$ucfirst_sign_off $email";
2124 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
2125 if (WARN("BAD_SIGN_OFF",
2126 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2128 $fixed[$fixlinenr] =
2129 "$ucfirst_sign_off $email";
2133 if (!defined $space_after || $space_after ne " ") {
2134 if (WARN("BAD_SIGN_OFF",
2135 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2137 $fixed[$fixlinenr] =
2138 "$ucfirst_sign_off $email";
2142 my ($email_name, $email_address, $comment) = parse_email($email);
2143 my $suggested_email = format_email(($email_name, $email_address));
2144 if ($suggested_email eq "") {
2145 ERROR("BAD_SIGN_OFF",
2146 "Unrecognized email address: '$email'\n" . $herecurr);
2148 my $dequoted = $suggested_email;
2149 $dequoted =~ s/^"//;
2150 $dequoted =~ s/" </ </;
2151 # Don't force email to have quotes
2152 # Allow just an angle bracketed address
2153 if ("$dequoted$comment" ne $email &&
2154 "<$email_address>$comment" ne $email &&
2155 "$suggested_email$comment" ne $email) {
2156 WARN("BAD_SIGN_OFF",
2157 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
2161 # Check for duplicate signatures
2162 my $sig_nospace = $line;
2163 $sig_nospace =~ s/\s//g;
2164 $sig_nospace = lc($sig_nospace);
2165 if (defined $signatures{$sig_nospace}) {
2166 WARN("BAD_SIGN_OFF",
2167 "Duplicate signature\n" . $herecurr);
2169 $signatures{$sig_nospace} = 1;
2173 # Check email subject for common tools that don't need to be mentioned
2174 if ($in_header_lines &&
2175 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2176 WARN("EMAIL_SUBJECT",
2177 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2180 # Check for old stable address
2181 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2182 ERROR("STABLE_ADDRESS",
2183 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2186 # Check for unwanted Gerrit info
2187 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2188 ERROR("GERRIT_CHANGE_ID",
2189 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2192 # Check for git id commit length and improperly formed commit descriptions
2193 if ($in_commit_log && $line =~ /\b(c)ommit\s+([0-9a-f]{5,})/i) {
2195 my $orig_commit = lc($2);
2202 my $id = '0123456789ab';
2203 my $orig_desc = "commit description";
2204 my $description = "";
2206 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2207 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2208 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2209 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2210 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2213 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2214 defined $rawlines[$linenr] &&
2215 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2218 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2219 defined $rawlines[$linenr] &&
2220 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2221 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2223 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2224 $orig_desc .= " " . $1;
2228 ($id, $description) = git_commit_info($orig_commit,
2231 if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) {
2232 ERROR("GIT_COMMIT_ID",
2233 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2237 # Check for added, moved or deleted files
2238 if (!$reported_maintainer_file && !$in_commit_log &&
2239 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2240 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2241 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2242 (defined($1) || defined($2))))) {
2243 $reported_maintainer_file = 1;
2244 WARN("FILE_PATH_CHANGES",
2245 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2248 # Check for wrappage within a valid hunk of the file
2249 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
2250 ERROR("CORRUPTED_PATCH",
2251 "patch seems to be corrupt (line wrapped?)\n" .
2252 $herecurr) if (!$emitted_corrupt++);
2255 # Check for absolute kernel paths.
2257 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2260 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2261 check_absolute_file($1, $herecurr)) {
2264 check_absolute_file($file, $herecurr);
2269 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2270 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
2271 $rawline !~ m/^$UTF8*$/) {
2272 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2274 my $blank = copy_spacing($rawline);
2275 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2276 my $hereptr = "$hereline$ptr\n";
2279 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
2282 # Check if it's the start of a commit log
2283 # (not a header line and we haven't seen the patch filename)
2284 if ($in_header_lines && $realfile =~ /^$/ &&
2285 !($rawline =~ /^\s+\S/ ||
2286 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
2287 $in_header_lines = 0;
2291 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2292 # declined it, i.e defined some charset where it is missing.
2293 if ($in_header_lines &&
2294 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2296 $non_utf8_charset = 1;
2299 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
2300 $rawline =~ /$NON_ASCII_UTF8/) {
2301 WARN("UTF8_BEFORE_PATCH",
2302 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2305 # Check for various typo / spelling mistakes
2306 if (defined($misspellings) && ($in_commit_log || $line =~ /^\+/)) {
2307 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:$|[^a-z@])/gi) {
2309 my $typo_fix = $spelling_fix{lc($typo)};
2310 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2311 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2312 my $msg_type = \&WARN;
2313 $msg_type = \&CHK if ($file);
2314 if (&{$msg_type}("TYPO_SPELLING",
2315 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2317 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2322 # ignore non-hunk lines and lines being removed
2323 next if (!$hunk_line || $line =~ /^-/);
2325 #trailing whitespace
2326 if ($line =~ /^\+.*\015/) {
2327 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2328 if (ERROR("DOS_LINE_ENDINGS",
2329 "DOS line endings\n" . $herevet) &&
2331 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
2333 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2334 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2335 if (ERROR("TRAILING_WHITESPACE",
2336 "trailing whitespace\n" . $herevet) &&
2338 $fixed[$fixlinenr] =~ s/\s+$//;
2344 # Check for FSF mailing addresses.
2345 if ($rawline =~ /\bwrite to the Free/i ||
2346 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2347 $rawline =~ /\b51\s+Franklin\s+St/i) {
2348 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2349 my $msg_type = \&ERROR;
2350 $msg_type = \&CHK if ($file);
2351 &{$msg_type}("FSF_MAILING_ADDRESS",
2352 "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)
2355 # check for Kconfig help text having a real description
2356 # Only applies when adding the entry originally, after that we do not have
2357 # sufficient context to determine whether it is indeed long enough.
2358 if ($realfile =~ /Kconfig/ &&
2359 $line =~ /^\+\s*config\s+/) {
2362 my $ln = $linenr + 1;
2366 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
2367 $f = $lines[$ln - 1];
2368 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2369 $is_end = $lines[$ln - 1] =~ /^\+/;
2371 next if ($f =~ /^-/);
2372 last if (!$file && $f =~ /^\@\@/);
2374 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
2376 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
2383 next if ($f =~ /^$/);
2384 if ($f =~ /^\s*config\s/) {
2390 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2391 WARN("CONFIG_DESCRIPTION",
2392 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2394 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2397 # discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2398 if ($realfile =~ /Kconfig/ &&
2399 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2400 WARN("CONFIG_EXPERIMENTAL",
2401 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2404 # discourage the use of boolean for type definition attributes of Kconfig options
2405 if ($realfile =~ /Kconfig/ &&
2406 $line =~ /^\+\s*\bboolean\b/) {
2407 WARN("CONFIG_TYPE_BOOLEAN",
2408 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2411 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2412 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2415 'EXTRA_AFLAGS' => 'asflags-y',
2416 'EXTRA_CFLAGS' => 'ccflags-y',
2417 'EXTRA_CPPFLAGS' => 'cppflags-y',
2418 'EXTRA_LDFLAGS' => 'ldflags-y',
2421 WARN("DEPRECATED_VARIABLE",
2422 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2425 # check for DT compatible documentation
2426 if (defined $root &&
2427 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2428 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2430 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2432 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2433 my $vp_file = $dt_path . "vendor-prefixes.txt";
2435 foreach my $compat (@compats) {
2436 my $compat2 = $compat;
2437 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2438 my $compat3 = $compat;
2439 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2440 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
2442 WARN("UNDOCUMENTED_DT_STRING",
2443 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2446 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2448 `grep -Eq "^$vendor\\b" $vp_file`;
2450 WARN("UNDOCUMENTED_DT_STRING",
2451 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2456 # check we are in a valid source file if not then ignore this hunk
2457 next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/);
2460 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
2461 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
2462 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
2463 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
2464 $length > $max_line_length)
2467 "line over $max_line_length characters\n" . $herecurr);
2470 # check for adding lines without a newline.
2471 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2472 WARN("MISSING_EOF_NEWLINE",
2473 "adding a line without newline at end of file\n" . $herecurr);
2476 # Blackfin: use hi/lo macros
2477 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2478 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2479 my $herevet = "$here\n" . cat_vet($line) . "\n";
2481 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
2483 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2484 my $herevet = "$here\n" . cat_vet($line) . "\n";
2486 "use the HI() macro, not (... >> 16)\n" . $herevet);
2490 # check we are in a valid source file C or perl if not then ignore this hunk
2491 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
2493 # at the beginning of a line any tabs must come first and anything
2494 # more than 8 must use tabs.
2495 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2496 $rawline =~ /^\+\s* \s*/) {
2497 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2499 if (ERROR("CODE_INDENT",
2500 "code indent should use tabs where possible\n" . $herevet) &&
2502 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2506 # check for space before tabs.
2507 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2508 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2509 if (WARN("SPACE_BEFORE_TAB",
2510 "please, no space before tabs\n" . $herevet) &&
2512 while ($fixed[$fixlinenr] =~
2513 s/(^\+.*) {8,8}\t/$1\t\t/) {}
2514 while ($fixed[$fixlinenr] =~
2515 s/(^\+.*) +\t/$1\t/) {}
2519 # check for && or || at the start of a line
2520 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2521 CHK("LOGICAL_CONTINUATIONS",
2522 "Logical continuations should be on the previous line\n" . $hereprev);
2525 # check multi-line statement indentation matches previous line
2526 if ($^V && $^V ge 5.10.0 &&
2527 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2528 $prevline =~ /^\+(\t*)(.*)$/;
2532 my $pos = pos_last_openparen($rest);
2534 $line =~ /^(\+| )([ \t]*)/;
2537 my $goodtabindent = $oldindent .
2540 my $goodspaceindent = $oldindent . " " x $pos;
2542 if ($newindent ne $goodtabindent &&
2543 $newindent ne $goodspaceindent) {
2545 if (CHK("PARENTHESIS_ALIGNMENT",
2546 "Alignment should match open parenthesis\n" . $hereprev) &&
2547 $fix && $line =~ /^\+/) {
2548 $fixed[$fixlinenr] =~
2549 s/^\+[ \t]*/\+$goodtabindent/;
2555 # check for space after cast like "(int) foo" or "(struct foo) bar"
2556 # avoid checking a few false positives:
2557 # "sizeof(<type>)" or "__alignof__(<type>)"
2558 # function pointer declarations like "(*foo)(int) = bar;"
2559 # structure definitions like "(struct foo) { 0 };"
2560 # multiline macros that define functions
2561 # known attributes or the __attribute__ keyword
2562 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
2563 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
2565 "No space is necessary after a cast\n" . $herecurr) &&
2567 $fixed[$fixlinenr] =~
2568 s/(\(\s*$Type\s*\))[ \t]+/$1/;
2572 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2573 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
2574 $rawline =~ /^\+[ \t]*\*/ &&
2576 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2577 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2580 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2581 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2582 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
2583 $rawline =~ /^\+/ && #line is new
2584 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2585 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2586 "networking block comments start with * on subsequent lines\n" . $hereprev);
2589 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2590 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2591 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2592 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2593 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
2594 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2595 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2598 # check for missing blank lines after struct/union declarations
2599 # with exceptions for various attributes and macros
2600 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2602 !($line =~ /^\+\s*$/ ||
2603 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2604 $line =~ /^\+\s*MODULE_/i ||
2605 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2606 $line =~ /^\+[a-z_]*init/ ||
2607 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2608 $line =~ /^\+\s*DECLARE/ ||
2609 $line =~ /^\+\s*__setup/)) {
2610 if (CHK("LINE_SPACING",
2611 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
2613 fix_insert_line($fixlinenr, "\+");
2617 # check for multiple consecutive blank lines
2618 if ($prevline =~ /^[\+ ]\s*$/ &&
2619 $line =~ /^\+\s*$/ &&
2620 $last_blank_line != ($linenr - 1)) {
2621 if (CHK("LINE_SPACING",
2622 "Please don't use multiple blank lines\n" . $hereprev) &&
2624 fix_delete_line($fixlinenr, $rawline);
2627 $last_blank_line = $linenr;
2630 # check for missing blank lines after declarations
2631 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2632 # actual declarations
2633 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2634 # function pointer declarations
2635 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2636 # foo bar; where foo is some local typedef or #define
2637 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2638 # known declaration macros
2639 $prevline =~ /^\+\s+$declaration_macros/) &&
2640 # for "else if" which can look like "$Ident $Ident"
2641 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2642 # other possible extensions of declaration lines
2643 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2644 # not starting a section or a macro "\" extended line
2645 $prevline =~ /(?:\{\s*|\\)$/) &&
2646 # looks like a declaration
2647 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2648 # function pointer declarations
2649 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2650 # foo bar; where foo is some local typedef or #define
2651 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2652 # known declaration macros
2653 $sline =~ /^\+\s+$declaration_macros/ ||
2654 # start of struct or union or enum
2655 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
2656 # start or end of block or continuation of declaration
2657 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
2658 # bitfield continuation
2659 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
2660 # other possible extensions of declaration lines
2661 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
2662 # indentation of previous and current line are the same
2663 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
2664 if (WARN("LINE_SPACING",
2665 "Missing a blank line after declarations\n" . $hereprev) &&
2667 fix_insert_line($fixlinenr, "\+");
2671 # check for spaces at the beginning of a line.
2673 # 1) within comments
2674 # 2) indented preprocessor commands
2676 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
2677 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2678 if (WARN("LEADING_SPACE",
2679 "please, no spaces at the start of a line\n" . $herevet) &&
2681 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2685 # check we are in a valid C source file if not then ignore this hunk
2686 next if ($realfile !~ /\.(h|c)$/);
2688 # check indentation of any line with a bare else
2689 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
2690 # if the previous line is a break or return and is indented 1 tab more...
2691 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
2692 my $tabs = length($1) + 1;
2693 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
2694 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
2695 defined $lines[$linenr] &&
2696 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
2697 WARN("UNNECESSARY_ELSE",
2698 "else is not generally useful after a break or return\n" . $hereprev);
2702 # check indentation of a line with a break;
2703 # if the previous line is a goto or return and is indented the same # of tabs
2704 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
2706 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
2707 WARN("UNNECESSARY_BREAK",
2708 "break is not useful after a goto or return\n" . $hereprev);
2712 # discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2713 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2714 WARN("CONFIG_EXPERIMENTAL",
2715 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2718 # check for RCS/CVS revision markers
2719 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
2721 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
2724 # Blackfin: don't use __builtin_bfin_[cs]sync
2725 if ($line =~ /__builtin_bfin_csync/) {
2726 my $herevet = "$here\n" . cat_vet($line) . "\n";
2728 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
2730 if ($line =~ /__builtin_bfin_ssync/) {
2731 my $herevet = "$here\n" . cat_vet($line) . "\n";
2733 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
2736 # check for old HOTPLUG __dev<foo> section markings
2737 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2738 WARN("HOTPLUG_SECTION",
2739 "Using $1 is unnecessary\n" . $herecurr);
2742 # Check for potential 'bare' types
2743 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2745 #print "LINE<$line>\n";
2746 if ($linenr >= $suppress_statement &&
2747 $realcnt && $sline =~ /.\s*\S/) {
2748 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2749 ctx_statement_block($linenr, $realcnt, 0);
2750 $stat =~ s/\n./\n /g;
2751 $cond =~ s/\n./\n /g;
2753 #print "linenr<$linenr> <$stat>\n";
2754 # If this statement has no statement boundaries within
2755 # it there is no point in retrying a statement scan
2756 # until we hit end of it.
2757 my $frag = $stat; $frag =~ s/;+\s*$//;
2758 if ($frag !~ /(?:{|;)/) {
2759 #print "skip<$line_nr_next>\n";
2760 $suppress_statement = $line_nr_next;
2763 # Find the real next line.
2764 $realline_next = $line_nr_next;
2765 if (defined $realline_next &&
2766 (!defined $lines[$realline_next - 1] ||
2767 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2774 # Ignore goto labels.
2775 if ($s =~ /$Ident:\*$/s) {
2777 # Ignore functions being called
2778 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
2780 } elsif ($s =~ /^.\s*else\b/s) {
2782 # declarations always start with types
2783 } 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) {
2786 possible($type, "A:" . $s);
2788 # definitions in global scope can only start with types
2789 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
2790 possible($1, "B:" . $s);
2793 # any (foo ... *) is a pointer cast, and foo is a type
2794 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
2795 possible($1, "C:" . $s);
2798 # Check for any sort of function declaration.
2799 # int foo(something bar, other baz);
2800 # void (*store_gdt)(x86_descr_ptr *);
2801 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
2802 my ($name_len) = length($1);
2805 substr($ctx, 0, $name_len + 1, '');
2806 $ctx =~ s/\)[^\)]*$//;
2808 for my $arg (split(/\s*,\s*/, $ctx)) {
2809 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
2811 possible($1, "D:" . $s);
2819 # Checks which may be anchored in the context.
2822 # Check for switch () and associated case and default
2823 # statements should be at the same indent.
2824 if ($line=~/\bswitch\s*\(.*\)/) {
2827 my @ctx = ctx_block_outer($linenr, $realcnt);
2829 for my $ctx (@ctx) {
2830 my ($clen, $cindent) = line_stats($ctx);
2831 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2832 $indent != $cindent) {
2833 $err .= "$sep$ctx\n";
2840 ERROR("SWITCH_CASE_INDENT_LEVEL",
2841 "switch and case should be at the same indent\n$hereline$err");
2845 # if/while/etc brace do not go on next line, unless defining a do while loop,
2846 # or if that brace on the next line is for something else
2847 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
2848 my $pre_ctx = "$1$2";
2850 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
2852 if ($line =~ /^\+\t{6,}/) {
2853 WARN("DEEP_INDENTATION",
2854 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2857 my $ctx_cnt = $realcnt - $#ctx - 1;
2858 my $ctx = join("\n", @ctx);
2860 my $ctx_ln = $linenr;
2861 my $ctx_skip = $realcnt;
2863 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2864 defined $lines[$ctx_ln - 1] &&
2865 $lines[$ctx_ln - 1] =~ /^-/)) {
2866 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2867 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
2871 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2872 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
2874 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
2876 "that open brace { should be on the previous line\n" .
2877 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2879 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2880 $ctx =~ /\)\s*\;\s*$/ &&
2881 defined $lines[$ctx_ln - 1])
2883 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2884 if ($nindent > $indent) {
2885 WARN("TRAILING_SEMICOLON",
2886 "trailing semicolon indicates no statements, indent implies otherwise\n" .
2887 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2892 # Check relative indent for conditionals and blocks.
2893 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2894 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2895 ctx_statement_block($linenr, $realcnt, 0)
2896 if (!defined $stat);
2897 my ($s, $c) = ($stat, $cond);
2899 substr($s, 0, length($c), '');
2901 # Make sure we remove the line prefixes as we have
2902 # none on the first line, and are going to readd them
2906 # Find out how long the conditional actually is.
2907 my @newlines = ($c =~ /\n/gs);
2908 my $cond_lines = 1 + $#newlines;
2910 # We want to check the first line inside the block
2911 # starting at the end of the conditional, so remove:
2912 # 1) any blank line termination
2913 # 2) any opening brace { on end of the line
2915 my $continuation = 0;
2917 $s =~ s/^.*\bdo\b//;
2919 if ($s =~ s/^\s*\\//) {
2922 if ($s =~ s/^\s*?\n//) {
2927 # Also ignore a loop construct at the end of a
2928 # preprocessor statement.
2929 if (($prevline =~ /^.\s*#\s*define\s/ ||
2930 $prevline =~ /\\\s*$/) && $continuation == 0) {
2936 while ($cond_ptr != $cond_lines) {
2937 $cond_ptr = $cond_lines;
2939 # If we see an #else/#elif then the code
2941 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2946 # 1) blank lines, they should be at 0,
2947 # 2) preprocessor lines, and
2949 if ($continuation ||
2951 $s =~ /^\s*#\s*?/ ||
2952 $s =~ /^\s*$Ident\s*:/) {
2953 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
2954 if ($s =~ s/^.*?\n//) {
2960 my (undef, $sindent) = line_stats("+" . $s);
2961 my $stat_real = raw_line($linenr, $cond_lines);
2963 # Check if either of these lines are modified, else
2964 # this is not this patch's fault.
2965 if (!defined($stat_real) ||
2966 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2969 if (defined($stat_real) && $cond_lines > 1) {
2970 $stat_real = "[...]\n$stat_real";
2973 #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";
2975 if ($check && (($sindent % 8) != 0 ||
2976 ($sindent <= $indent && $s ne ''))) {
2977 WARN("SUSPECT_CODE_INDENT",
2978 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
2982 # Track the 'values' across context and added lines.
2983 my $opline = $line; $opline =~ s/^./ /;
2984 my ($curr_values, $curr_vars) =
2985 annotate_values($opline . "\n", $prev_values);
2986 $curr_values = $prev_values . $curr_values;
2988 my $outline = $opline; $outline =~ s/\t/ /g;
2989 print "$linenr > .$outline\n";
2990 print "$linenr > $curr_values\n";
2991 print "$linenr > $curr_vars\n";
2993 $prev_values = substr($curr_values, -1);
2995 #ignore lines not being added
2996 next if ($line =~ /^[^\+]/);
2998 # TEST: allow direct testing of the type matcher.
3000 if ($line =~ /^.\s*$Declare\s*$/) {
3002 "TEST: is type\n" . $herecurr);
3003 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
3004 ERROR("TEST_NOT_TYPE",
3005 "TEST: is not type ($1 is)\n". $herecurr);
3009 # TEST: allow direct testing of the attribute matcher.
3011 if ($line =~ /^.\s*$Modifier\s*$/) {
3013 "TEST: is attr\n" . $herecurr);
3014 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
3015 ERROR("TEST_NOT_ATTR",
3016 "TEST: is not attr ($1 is)\n". $herecurr);
3021 # check for initialisation to aggregates open brace on the next line
3022 if ($line =~ /^.\s*{/ &&
3023 $prevline =~ /(?:^|[^=])=\s*$/) {
3024 if (ERROR("OPEN_BRACE",
3025 "that open brace { should be on the previous line\n" . $hereprev) &&
3026 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3027 fix_delete_line($fixlinenr - 1, $prevrawline);
3028 fix_delete_line($fixlinenr, $rawline);
3029 my $fixedline = $prevrawline;
3030 $fixedline =~ s/\s*=\s*$/ = {/;
3031 fix_insert_line($fixlinenr, $fixedline);
3033 $fixedline =~ s/^(.\s*){\s*/$1/;
3034 fix_insert_line($fixlinenr, $fixedline);
3039 # Checks which are anchored on the added line.
3042 # check for malformed paths in #include statements (uses RAW line)
3043 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
3045 if ($path =~ m{//}) {
3046 ERROR("MALFORMED_INCLUDE",
3047 "malformed #include filename\n" . $herecurr);
3049 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3050 ERROR("UAPI_INCLUDE",
3051 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
3055 # no C99 // comments
3056 if ($line =~ m{//}) {
3057 if (ERROR("C99_COMMENTS",
3058 "do not use C99 // comments\n" . $herecurr) &&
3060 my $line = $fixed[$fixlinenr];
3061 if ($line =~ /\/\/(.*)$/) {
3062 my $comment = trim($1);
3063 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
3067 # Remove C99 comments.
3069 $opline =~ s@//.*@@;
3071 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3072 # the whole statement.
3073 #print "APW <$lines[$realline_next - 1]>\n";
3074 if (defined $realline_next &&
3075 exists $lines[$realline_next - 1] &&
3076 !defined $suppress_export{$realline_next} &&
3077 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3078 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3079 # Handle definitions which produce identifiers with
3082 # EXPORT_SYMBOL(something_foo);
3084 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
3085 $name =~ /^${Ident}_$2/) {
3086 #print "FOO C name<$name>\n";
3087 $suppress_export{$realline_next} = 1;
3089 } elsif ($stat !~ /(?:
3091 ^.DEFINE_$Ident\(\Q$name\E\)|
3092 ^.DECLARE_$Ident\(\Q$name\E\)|
3093 ^.LIST_HEAD\(\Q$name\E\)|
3094 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3095 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
3097 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3098 $suppress_export{$realline_next} = 2;
3100 $suppress_export{$realline_next} = 1;
3103 if (!defined $suppress_export{$linenr} &&
3104 $prevline =~ /^.\s*$/ &&
3105 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3106 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3107 #print "FOO B <$lines[$linenr - 1]>\n";
3108 $suppress_export{$linenr} = 2;
3110 if (defined $suppress_export{$linenr} &&
3111 $suppress_export{$linenr} == 2) {
3112 WARN("EXPORT_SYMBOL",
3113 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
3116 # check for global initialisers.
3117 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
3118 if (ERROR("GLOBAL_INITIALISERS",
3119 "do not initialise globals to 0 or NULL\n" .
3122 $fixed[$fixlinenr] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
3125 # check for static initialisers.
3126 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
3127 if (ERROR("INITIALISED_STATIC",
3128 "do not initialise statics to 0 or NULL\n" .
3131 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
3135 # check for misordered declarations of char/short/int/long with signed/unsigned
3136 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3138 WARN("MISORDERED_TYPE",
3139 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3142 # check for static const char * arrays.
3143 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
3144 WARN("STATIC_CONST_CHAR_ARRAY",
3145 "static const char * array should probably be static const char * const\n" .
3149 # check for static char foo[] = "bar" declarations.
3150 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
3151 WARN("STATIC_CONST_CHAR_ARRAY",
3152 "static char array declaration should probably be static const char\n" .
3156 # check for non-global char *foo[] = {"bar", ...} declarations.
3157 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3158 WARN("STATIC_CONST_CHAR_ARRAY",
3159 "char * array declaration might be better as static const\n" .
3163 # check for function declarations without arguments like "int foo()"
3164 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3165 if (ERROR("FUNCTION_WITHOUT_ARGS",
3166 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3168 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
3172 # check for uses of DEFINE_PCI_DEVICE_TABLE
3173 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
3174 if (WARN("DEFINE_PCI_DEVICE_TABLE",
3175 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
3177 $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
3181 # check for new typedefs, only function parameters and sparse annotations
3183 if ($line =~ /\btypedef\s/ &&
3184 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
3185 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
3186 $line !~ /\b$typeTypedefs\b/ &&
3187 $line !~ /\b$typeOtherOSTypedefs\b/ &&
3188 $line !~ /\b__bitwise(?:__|)\b/) {
3189 WARN("NEW_TYPEDEFS",
3190 "do not add new typedefs\n" . $herecurr);
3193 # * goes on variable not on type
3195 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3197 my ($ident, $from, $to) = ($1, $2, $2);
3199 # Should start with a space.
3200 $to =~ s/^(\S)/ $1/;
3201 # Should not end with a space.
3203 # '*'s should not have spaces between.
3204 while ($to =~ s/\*\s+\*/\*\*/) {
3207 ## print "1: from<$from> to<$to> ident<$ident>\n";
3209 if (ERROR("POINTER_LOCATION",
3210 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3212 my $sub_from = $ident;
3213 my $sub_to = $ident;
3214 $sub_to =~ s/\Q$from\E/$to/;
3215 $fixed[$fixlinenr] =~
3216 s@\Q$sub_from\E@$sub_to@;
3220 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3222 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
3224 # Should start with a space.
3225 $to =~ s/^(\S)/ $1/;
3226 # Should not end with a space.
3228 # '*'s should not have spaces between.
3229 while ($to =~ s/\*\s+\*/\*\*/) {
3231 # Modifiers should have spaces.
3232 $to =~ s/(\b$Modifier$)/$1 /;
3234 ## print "2: from<$from> to<$to> ident<$ident>\n";
3235 if ($from ne $to && $ident !~ /^$Modifier$/) {
3236 if (ERROR("POINTER_LOCATION",
3237 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3240 my $sub_from = $match;
3241 my $sub_to = $match;
3242 $sub_to =~ s/\Q$from\E/$to/;
3243 $fixed[$fixlinenr] =~
3244 s@\Q$sub_from\E@$sub_to@;
3249 # # no BUG() or BUG_ON()
3250 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
3251 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
3252 # print "$herecurr";
3256 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
3257 WARN("LINUX_VERSION_CODE",
3258 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3261 # check for uses of printk_ratelimit
3262 if ($line =~ /\bprintk_ratelimit\s*\(/) {
3263 WARN("PRINTK_RATELIMITED",
3264 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
3267 # printk should use KERN_* levels. Note that follow on printk's on the
3268 # same line do not need a level, so we use the current block context
3269 # to try and find and validate the current printk. In summary the current
3270 # printk includes all preceding printk's which have no newline on the end.
3271 # we assume the first bad printk is the one to report.
3272 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
3274 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3275 #print "CHECK<$lines[$ln - 1]\n";
3276 # we have a preceding printk if it ends
3277 # with "\n" ignore it, else it is to blame
3278 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3279 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3286 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3287 "printk() should include KERN_ facility level\n" . $herecurr);
3291 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3293 my $level = lc($orig);
3294 $level = "warn" if ($level eq "warning");
3295 my $level2 = $level;
3296 $level2 = "dbg" if ($level eq "debug");
3297 WARN("PREFER_PR_LEVEL",
3298 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
3301 if ($line =~ /\bpr_warning\s*\(/) {
3302 if (WARN("PREFER_PR_LEVEL",
3303 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3305 $fixed[$fixlinenr] =~
3306 s/\bpr_warning\b/pr_warn/;
3310 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3312 my $level = lc($orig);
3313 $level = "warn" if ($level eq "warning");
3314 $level = "dbg" if ($level eq "debug");
3315 WARN("PREFER_DEV_LEVEL",
3316 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3319 # function brace can't be on same line, except for #defines of do while,
3320 # or if closed on same line
3321 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
3322 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
3323 if (ERROR("OPEN_BRACE",
3324 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3326 fix_delete_line($fixlinenr, $rawline);
3327 my $fixed_line = $rawline;
3328 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3331 fix_insert_line($fixlinenr, ltrim($line1));
3332 fix_insert_line($fixlinenr, "\+{");
3333 if ($line2 !~ /^\s*$/) {
3334 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3339 # open braces for enum, union and struct go on the same line.
3340 if ($line =~ /^.\s*{/ &&
3341 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
3342 if (ERROR("OPEN_BRACE",
3343 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3344 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3345 fix_delete_line($fixlinenr - 1, $prevrawline);
3346 fix_delete_line($fixlinenr, $rawline);
3347 my $fixedline = rtrim($prevrawline) . " {";
3348 fix_insert_line($fixlinenr, $fixedline);
3349 $fixedline = $rawline;
3350 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3351 if ($fixedline !~ /^\+\s*$/) {
3352 fix_insert_line($fixlinenr, $fixedline);
3357 # missing space after union, struct or enum definition
3358 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3360 "missing space after $1 definition\n" . $herecurr) &&
3362 $fixed[$fixlinenr] =~
3363 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3367 # Function pointer declarations
3368 # check spacing between type, funcptr, and args
3369 # canonical declaration is "type (*funcptr)(args...)"
3370 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
3372 my $pre_pointer_space = $2;
3373 my $post_pointer_space = $3;
3375 my $post_funcname_space = $5;
3376 my $pre_args_space = $6;
3378 # the $Declare variable will capture all spaces after the type
3379 # so check it for a missing trailing missing space but pointer return types
3380 # don't need a space so don't warn for those.
3381 my $post_declare_space = "";
3382 if ($declare =~ /(\s+)$/) {
3383 $post_declare_space = $1;
3384 $declare = rtrim($declare);
3386 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
3388 "missing space after return type\n" . $herecurr);
3389 $post_declare_space = " ";
3392 # unnecessary space "type (*funcptr)(args...)"
3393 # This test is not currently implemented because these declarations are
3395 # int foo(int bar, ...)
3396 # and this is form shouldn't/doesn't generate a checkpatch warning.
3398 # elsif ($declare =~ /\s{2,}$/) {
3400 # "Multiple spaces after return type\n" . $herecurr);
3403 # unnecessary space "type ( *funcptr)(args...)"
3404 if (defined $pre_pointer_space &&
3405 $pre_pointer_space =~ /^\s/) {
3407 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3410 # unnecessary space "type (* funcptr)(args...)"
3411 if (defined $post_pointer_space &&
3412 $post_pointer_space =~ /^\s/) {
3414 "Unnecessary space before function pointer name\n" . $herecurr);
3417 # unnecessary space "type (*funcptr )(args...)"
3418 if (defined $post_funcname_space &&
3419 $post_funcname_space =~ /^\s/) {
3421 "Unnecessary space after function pointer name\n" . $herecurr);
3424 # unnecessary space "type (*funcptr) (args...)"
3425 if (defined $pre_args_space &&
3426 $pre_args_space =~ /^\s/) {
3428 "Unnecessary space before function pointer arguments\n" . $herecurr);
3431 if (show_type("SPACING") && $fix) {
3432 $fixed[$fixlinenr] =~
3433 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3437 # check for spacing round square brackets; allowed:
3438 # 1. with a type on the left -- int [] a;
3439 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3440 # 3. inside a curly brace -- = { [0...10] = 5 }
3441 while ($line =~ /(.*?\s)\[/g) {
3442 my ($where, $prefix) = ($-[1], $1);
3443 if ($prefix !~ /$Type\s+$/ &&
3444 ($where != 0 || $prefix !~ /^.\s+$/) &&
3445 $prefix !~ /[{,]\s+$/) {
3446 if (ERROR("BRACKET_SPACE",
3447 "space prohibited before open square bracket '['\n" . $herecurr) &&
3449 $fixed[$fixlinenr] =~
3450 s/^(\+.*?)\s+\[/$1\[/;
3455 # check for spaces between functions and their parentheses.
3456 while ($line =~ /($Ident)\s+\(/g) {
3458 my $ctx_before = substr($line, 0, $-[1]);
3459 my $ctx = "$ctx_before$name";
3461 # Ignore those directives where spaces _are_ permitted.
3463 if|for|while|switch|return|case|
3464 volatile|__volatile__|
3465 __attribute__|format|__extension__|
3468 # cpp #define statements have non-optional spaces, ie
3469 # if there is a space between the name and the open
3470 # parenthesis it is simply not a parameter group.
3471 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
3473 # cpp #elif statement condition may start with a (
3474 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
3476 # If this whole things ends with a type its most
3477 # likely a typedef for a function.
3478 } elsif ($ctx =~ /$Type$/) {
3482 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3484 $fixed[$fixlinenr] =~
3485 s/\b$name\s+\(/$name\(/;
3490 # Check operator spacing.
3491 if (!($line=~/\#\s*include/)) {
3492 my $fixed_line = "";
3496 <<=|>>=|<=|>=|==|!=|
3497 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3498 =>|->|<<|>>|<|>|=|!|~|
3499 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
3502 my @elements = split(/($ops|;)/, $opline);
3504 ## print("element count: <" . $#elements . ">\n");
3505 ## foreach my $el (@elements) {
3506 ## print("el: <$el>\n");
3509 my @fix_elements = ();
3512 foreach my $el (@elements) {
3513 push(@fix_elements, substr($rawline, $off, length($el)));
3514 $off += length($el);
3519 my $blank = copy_spacing($opline);
3520 my $last_after = -1;
3522 for (my $n = 0; $n < $#elements; $n += 2) {
3524 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3526 ## print("n: <$n> good: <$good>\n");
3528 $off += length($elements[$n]);
3530 # Pick up the preceding and succeeding characters.
3531 my $ca = substr($opline, 0, $off);
3533 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3534 $cc = substr($opline, $off + length($elements[$n + 1]));
3536 my $cb = "$ca$;$cc";
3539 $a = 'V' if ($elements[$n] ne '');
3540 $a = 'W' if ($elements[$n] =~ /\s$/);
3541 $a = 'C' if ($elements[$n] =~ /$;$/);
3542 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3543 $a = 'O' if ($elements[$n] eq '');
3544 $a = 'E' if ($ca =~ /^\s*$/);
3546 my $op = $elements[$n + 1];
3549 if (defined $elements[$n + 2]) {
3550 $c = 'V' if ($elements[$n + 2] ne '');
3551 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
3552 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
3553 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3554 $c = 'O' if ($elements[$n + 2] eq '');
3555 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
3560 my $ctx = "${a}x${c}";
3562 my $at = "(ctx:$ctx)";
3564 my $ptr = substr($blank, 0, $off) . "^";
3565 my $hereptr = "$hereline$ptr\n";
3567 # Pull out the value of this operator.
3568 my $op_type = substr($curr_values, $off + 1, 1);
3570 # Get the full operator variant.
3571 my $opv = $op . substr($curr_vars, $off, 1);
3573 # Ignore operators passed as parameters.
3574 if ($op_type ne 'V' &&
3575 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
3578 # } elsif ($op =~ /^$;+$/) {
3580 # ; should have either the end of line or a space or \ after it
3581 } elsif ($op eq ';') {
3582 if ($ctx !~ /.x[WEBC]/ &&
3583 $cc !~ /^\\/ && $cc !~ /^;/) {
3584 if (ERROR("SPACING",
3585 "space required after that '$op' $at\n" . $hereptr)) {
3586 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3592 } elsif ($op eq '//') {
3594 # : when part of a bitfield
3595 } elsif ($opv eq ':B') {
3596 # skip the bitfield test for now
3600 } elsif ($op eq '->') {
3601 if ($ctx =~ /Wx.|.xW/) {
3602 if (ERROR("SPACING",
3603 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
3604 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3605 if (defined $fix_elements[$n + 2]) {
3606 $fix_elements[$n + 2] =~ s/^\s+//;
3612 # , must not have a space before and must have a space on the right.
3613 } elsif ($op eq ',') {
3614 my $rtrim_before = 0;
3615 my $space_after = 0;
3616 if ($ctx =~ /Wx./) {
3617 if (ERROR("SPACING",
3618 "space prohibited before that '$op' $at\n" . $hereptr)) {
3623 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
3624 if (ERROR("SPACING",
3625 "space required after that '$op' $at\n" . $hereptr)) {
3631 if ($rtrim_before || $space_after) {
3632 if ($rtrim_before) {
3633 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3635 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3642 # '*' as part of a type definition -- reported already.
3643 } elsif ($opv eq '*_') {
3644 #warn "'*' is part of type\n";
3646 # unary operators should have a space before and
3647 # none after. May be left adjacent to another
3648 # unary operator, or a cast
3649 } elsif ($op eq '!' || $op eq '~' ||
3650 $opv eq '*U' || $opv eq '-U' ||
3651 $opv eq '&U' || $opv eq '&&U') {
3652 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
3653 if (ERROR("SPACING",
3654 "space required before that '$op' $at\n" . $hereptr)) {
3655 if ($n != $last_after + 2) {
3656 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3661 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
3662 # A unary '*' may be const
3664 } elsif ($ctx =~ /.xW/) {
3665 if (ERROR("SPACING",
3666 "space prohibited after that '$op' $at\n" . $hereptr)) {
3667 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
3668 if (defined $fix_elements[$n + 2]) {
3669 $fix_elements[$n + 2] =~ s/^\s+//;
3675 # unary ++ and unary -- are allowed no space on one side.
3676 } elsif ($op eq '++' or $op eq '--') {
3677 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
3678 if (ERROR("SPACING",
3679 "space required one side of that '$op' $at\n" . $hereptr)) {
3680 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3684 if ($ctx =~ /Wx[BE]/ ||
3685 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
3686 if (ERROR("SPACING",
3687 "space prohibited before that '$op' $at\n" . $hereptr)) {
3688 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3692 if ($ctx =~ /ExW/) {
3693 if (ERROR("SPACING",
3694 "space prohibited after that '$op' $at\n" . $hereptr)) {
3695 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3696 if (defined $fix_elements[$n + 2]) {
3697 $fix_elements[$n + 2] =~ s/^\s+//;
3703 # << and >> may either have or not have spaces both sides
3704 } elsif ($op eq '<<' or $op eq '>>' or
3705 $op eq '&' or $op eq '^' or $op eq '|' or
3706 $op eq '+' or $op eq '-' or
3707 $op eq '*' or $op eq '/' or
3711 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
3713 "spaces preferred around that '$op' $at\n" . $hereptr)) {
3714 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3715 $fix_elements[$n + 2] =~ s/^\s+//;
3718 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
3720 "space preferred before that '$op' $at\n" . $hereptr)) {
3721 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
3725 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
3726 if (ERROR("SPACING",
3727 "need consistent spacing around '$op' $at\n" . $hereptr)) {
3728 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3729 if (defined $fix_elements[$n + 2]) {
3730 $fix_elements[$n + 2] =~ s/^\s+//;
3736 # A colon needs no spaces before when it is
3737 # terminating a case value or a label.
3738 } elsif ($opv eq ':C' || $opv eq ':L') {
3739 if ($ctx =~ /Wx./) {
3740 if (ERROR("SPACING",
3741 "space prohibited before that '$op' $at\n" . $hereptr)) {
3742 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3747 # All the others need spaces both sides.
3748 } elsif ($ctx !~ /[EWC]x[CWE]/) {
3751 # Ignore email addresses <foo@bar>
3753 $cc =~ /^\S+\@\S+>/) ||
3755 $ca =~ /<\S+\@\S+$/))
3760 # messages are ERROR, but ?: are CHK
3762 my $msg_type = \&ERROR;
3763 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
3765 if (&{$msg_type}("SPACING",
3766 "spaces required around that '$op' $at\n" . $hereptr)) {
3767 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3768 if (defined $fix_elements[$n + 2]) {
3769 $fix_elements[$n + 2] =~ s/^\s+//;
3775 $off += length($elements[$n + 1]);
3777 ## print("n: <$n> GOOD: <$good>\n");
3779 $fixed_line = $fixed_line . $good;
3782 if (($#elements % 2) == 0) {
3783 $fixed_line = $fixed_line . $fix_elements[$#elements];
3786 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
3787 $fixed[$fixlinenr] = $fixed_line;
3793 # check for whitespace before a non-naked semicolon
3794 if ($line =~ /^\+.*\S\s+;\s*$/) {
3796 "space prohibited before semicolon\n" . $herecurr) &&
3798 1 while $fixed[$fixlinenr] =~
3799 s/^(\+.*\S)\s+;/$1;/;
3803 # check for multiple assignments
3804 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
3805 CHK("MULTIPLE_ASSIGNMENTS",
3806 "multiple assignments should be avoided\n" . $herecurr);
3809 ## # check for multiple declarations, allowing for a function declaration
3811 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3812 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3814 ## # Remove any bracketed sections to ensure we do not
3815 ## # falsly report the parameters of functions.
3817 ## while ($ln =~ s/\([^\(\)]*\)//g) {
3819 ## if ($ln =~ /,/) {
3820 ## WARN("MULTIPLE_DECLARATION",
3821 ## "declaring multiple variables together should be avoided\n" . $herecurr);
3825 #need space before brace following if, while, etc
3826 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3828 if (ERROR("SPACING",
3829 "space required before the open brace '{'\n" . $herecurr) &&
3831 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
3835 ## # check for blank lines before declarations
3836 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3837 ## $prevrawline =~ /^.\s*$/) {
3839 ## "No blank lines before declarations\n" . $hereprev);
3843 # closing brace should have a space following it when it has anything
3845 if ($line =~ /}(?!(?:,|;|\)))\S/) {
3846 if (ERROR("SPACING",
3847 "space required after that close brace '}'\n" . $herecurr) &&
3849 $fixed[$fixlinenr] =~
3850 s/}((?!(?:,|;|\)))\S)/} $1/;
3854 # check spacing on square brackets
3855 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
3856 if (ERROR("SPACING",
3857 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3859 $fixed[$fixlinenr] =~
3863 if ($line =~ /\s\]/) {
3864 if (ERROR("SPACING",
3865 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3867 $fixed[$fixlinenr] =~
3872 # check spacing on parentheses
3873 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3874 $line !~ /for\s*\(\s+;/) {
3875 if (ERROR("SPACING",
3876 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3878 $fixed[$fixlinenr] =~
3882 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
3883 $line !~ /for\s*\(.*;\s+\)/ &&
3884 $line !~ /:\s+\)/) {
3885 if (ERROR("SPACING",
3886 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3888 $fixed[$fixlinenr] =~
3893 # check unnecessary parentheses around addressof/dereference single $Lvals
3894 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
3896 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
3898 if (CHK("UNNECESSARY_PARENTHESES",
3899 "Unnecessary parentheses around $var\n" . $herecurr) &&
3901 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
3905 # check for unnecessary parentheses around function pointer uses
3906 # ie: (foo->bar)(); should be foo->bar();
3907 # but not "if (foo->bar) (" to avoid some false positives
3908 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
3910 if (CHK("UNNECESSARY_PARENTHESES",
3911 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
3913 my $var2 = deparenthesize($var);
3915 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
3919 #goto labels aren't indented, allow a single space however
3920 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
3921 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
3922 if (WARN("INDENTED_LABEL",
3923 "labels should not be indented\n" . $herecurr) &&
3925 $fixed[$fixlinenr] =~
3930 # return is not a function
3931 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
3933 if ($^V && $^V ge 5.10.0 &&
3934 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
3936 $value = deparenthesize($value);
3937 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
3938 ERROR("RETURN_PARENTHESES",
3939 "return is not a function, parentheses are not required\n" . $herecurr);
3941 } elsif ($spacing !~ /\s+/) {
3943 "space required before the open parenthesis '('\n" . $herecurr);
3947 # unnecessary return in a void function
3948 # at end-of-function, with the previous line a single leading tab, then return;
3949 # and the line before that not a goto label target like "out:"
3950 if ($sline =~ /^[ \+]}\s*$/ &&
3951 $prevline =~ /^\+\treturn\s*;\s*$/ &&
3953 $lines[$linenr - 3] =~ /^[ +]/ &&
3954 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
3956 "void function return statements are not generally useful\n" . $hereprev);
3959 # if statements using unnecessary parentheses - ie: if ((foo == bar))
3960 if ($^V && $^V ge 5.10.0 &&
3961 $line =~ /\bif\s*((?:\(\s*){2,})/) {
3962 my $openparens = $1;
3963 my $count = $openparens =~ tr@\(@\(@;
3965 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3966 my $comp = $4; #Not $1 because of $LvalOrFunc
3967 $msg = " - maybe == should be = ?" if ($comp eq "==");
3968 WARN("UNNECESSARY_PARENTHESES",
3969 "Unnecessary parentheses$msg\n" . $herecurr);
3973 # Return of what appears to be an errno should normally be -'ve
3974 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
3976 if ($name ne 'EOF' && $name ne 'ERROR') {
3977 WARN("USE_NEGATIVE_ERRNO",
3978 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
3982 # Need a space before open parenthesis after if, while etc
3983 if ($line =~ /\b(if|while|for|switch)\(/) {
3984 if (ERROR("SPACING",
3985 "space required before the open parenthesis '('\n" . $herecurr) &&
3987 $fixed[$fixlinenr] =~
3988 s/\b(if|while|for|switch)\(/$1 \(/;
3992 # Check for illegal assignment in if conditional -- and check for trailing
3993 # statements after the conditional.
3994 if ($line =~ /do\s*(?!{)/) {
3995 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3996 ctx_statement_block($linenr, $realcnt, 0)
3997 if (!defined $stat);
3998 my ($stat_next) = ctx_statement_block($line_nr_next,
3999 $remain_next, $off_next);
4000 $stat_next =~ s/\n./\n /g;
4001 ##print "stat<$stat> stat_next<$stat_next>\n";
4003 if ($stat_next =~ /^\s*while\b/) {
4004 # If the statement carries leading newlines,
4005 # then count those as offsets.
4007 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4009 statement_rawlines($whitespace) - 1;
4011 $suppress_whiletrailers{$line_nr_next +
4015 if (!defined $suppress_whiletrailers{$linenr} &&
4016 defined($stat) && defined($cond) &&
4017 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
4018 my ($s, $c) = ($stat, $cond);
4020 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
4021 ERROR("ASSIGN_IN_IF",
4022 "do not use assignment in if condition\n" . $herecurr);
4025 # Find out what is on the end of the line after the
4027 substr($s, 0, length($c), '');
4029 $s =~ s/$;//g; # Remove any comments
4030 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4031 $c !~ /}\s*while\s*/)
4033 # Find out how long the conditional actually is.
4034 my @newlines = ($c =~ /\n/gs);
4035 my $cond_lines = 1 + $#newlines;
4038 $stat_real = raw_line($linenr, $cond_lines)
4039 . "\n" if ($cond_lines);
4040 if (defined($stat_real) && $cond_lines > 1) {
4041 $stat_real = "[...]\n$stat_real";
4044 ERROR("TRAILING_STATEMENTS",
4045 "trailing statements should be on next line\n" . $herecurr . $stat_real);
4049 # Check for bitwise tests written as boolean
4061 WARN("HEXADECIMAL_BOOLEAN_TEST",
4062 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
4065 # if and else should not have general statements after it
4066 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4068 $s =~ s/$;//g; # Remove any comments
4069 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
4070 ERROR("TRAILING_STATEMENTS",
4071 "trailing statements should be on next line\n" . $herecurr);
4074 # if should not continue a brace
4075 if ($line =~ /}\s*if\b/) {
4076 ERROR("TRAILING_STATEMENTS",
4077 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
4080 # case and default should not have general statements after them
4081 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4083 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
4087 ERROR("TRAILING_STATEMENTS",
4088 "trailing statements should be on next line\n" . $herecurr);
4091 # Check for }<nl>else {, these must be at the same
4092 # indent level to be relevant to each other.
4093 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4094 $previndent == $indent) {
4095 if (ERROR("ELSE_AFTER_BRACE",
4096 "else should follow close brace '}'\n" . $hereprev) &&
4097 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4098 fix_delete_line($fixlinenr - 1, $prevrawline);
4099 fix_delete_line($fixlinenr, $rawline);
4100 my $fixedline = $prevrawline;
4101 $fixedline =~ s/}\s*$//;
4102 if ($fixedline !~ /^\+\s*$/) {
4103 fix_insert_line($fixlinenr, $fixedline);
4105 $fixedline = $rawline;
4106 $fixedline =~ s/^(.\s*)else/$1} else/;
4107 fix_insert_line($fixlinenr, $fixedline);
4111 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4112 $previndent == $indent) {
4113 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4115 # Find out what is on the end of the line after the
4117 substr($s, 0, length($c), '');
4120 if ($s =~ /^\s*;/) {
4121 if (ERROR("WHILE_AFTER_BRACE",
4122 "while should follow close brace '}'\n" . $hereprev) &&
4123 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4124 fix_delete_line($fixlinenr - 1, $prevrawline);
4125 fix_delete_line($fixlinenr, $rawline);
4126 my $fixedline = $prevrawline;
4127 my $trailing = $rawline;
4128 $trailing =~ s/^\+//;
4129 $trailing = trim($trailing);
4130 $fixedline =~ s/}\s*$/} $trailing/;
4131 fix_insert_line($fixlinenr, $fixedline);
4136 #Specific variable tests
4137 while ($line =~ m{($Constant|$Lval)}g) {
4140 #gcc binary extension
4141 if ($var =~ /^$Binary$/) {
4142 if (WARN("GCC_BINARY_CONSTANT",
4143 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4145 my $hexval = sprintf("0x%x", oct($var));
4146 $fixed[$fixlinenr] =~
4147 s/\b$var\b/$hexval/;
4152 if ($var !~ /^$Constant$/ &&
4153 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
4154 #Ignore Page<foo> variants
4155 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
4156 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4157 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4158 #Ignore some three character SI units explicitly, like MiB and KHz
4159 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
4160 while ($var =~ m{($Ident)}g) {
4162 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
4164 seed_camelcase_includes();
4165 if (!$file && !$camelcase_file_seeded) {
4166 seed_camelcase_file($realfile);
4167 $camelcase_file_seeded = 1;
4170 if (!defined $camelcase{$word}) {
4171 $camelcase{$word} = 1;
4173 "Avoid CamelCase: <$word>\n" . $herecurr);
4179 #no spaces allowed after \ in define
4180 if ($line =~ /\#\s*define.*\\\s+$/) {
4181 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4182 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4184 $fixed[$fixlinenr] =~ s/\s+$//;
4188 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
4189 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
4191 my $checkfile = "include/linux/$file";
4192 if (-f "$root/$checkfile" &&
4193 $realfile ne $checkfile &&
4194 $1 !~ /$allowed_asm_includes/)
4196 if ($realfile =~ m{^arch/}) {
4197 CHK("ARCH_INCLUDE_LINUX",
4198 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4200 WARN("INCLUDE_LINUX",
4201 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4206 # multi-statement macros should be enclosed in a do while loop, grab the
4207 # first statement and ensure its the whole macro if its not enclosed
4208 # in a known good container
4209 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4210 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
4213 my ($off, $dstat, $dcond, $rest);
4215 my $has_flow_statement = 0;
4216 my $has_arg_concat = 0;
4217 ($dstat, $dcond, $ln, $cnt, $off) =
4218 ctx_statement_block($linenr, $realcnt, 0);
4220 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4221 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4223 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
4224 $has_arg_concat = 1 if ($ctx =~ /\#\#/);
4226 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
4228 $dstat =~ s/\\\n.//g;
4229 $dstat =~ s/^\s*//s;
4230 $dstat =~ s/\s*$//s;
4232 # Flatten any parentheses and braces
4233 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4234 $dstat =~ s/\{[^\{\}]*\}/1/ ||
4235 $dstat =~ s/\[[^\[\]]*\]/1/)
4239 # Flatten any obvious string concatentation.
4240 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
4241 $dstat =~ s/$Ident\s*("X*")/$1/)
4245 my $exceptions = qr{
4257 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4259 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4260 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
4261 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4262 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
4263 $dstat !~ /$exceptions/ &&
4264 $dstat !~ /^\.$Ident\s*=/ && # .foo =
4265 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
4266 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
4267 $dstat !~ /^for\s*$Constant$/ && # for (...)
4268 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4269 $dstat !~ /^do\s*{/ && # do {...
4270 $dstat !~ /^\({/ && # ({...
4271 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
4274 my $herectx = $here . "\n";
4275 my $cnt = statement_rawlines($ctx);
4277 for (my $n = 0; $n < $cnt; $n++) {
4278 $herectx .= raw_line($linenr, $n) . "\n";
4281 if ($dstat =~ /;/) {
4282 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4283 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4285 ERROR("COMPLEX_MACRO",
4286 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
4290 # check for macros with flow control, but without ## concatenation
4291 # ## concatenation is commonly a macro that defines a function so ignore those
4292 if ($has_flow_statement && !$has_arg_concat) {
4293 my $herectx = $here . "\n";
4294 my $cnt = statement_rawlines($ctx);
4296 for (my $n = 0; $n < $cnt; $n++) {
4297 $herectx .= raw_line($linenr, $n) . "\n";
4299 WARN("MACRO_WITH_FLOW_CONTROL",
4300 "Macros with flow control statements should be avoided\n" . "$herectx");
4303 # check for line continuations outside of #defines, preprocessor #, and asm
4306 if ($prevline !~ /^..*\\$/ &&
4307 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4308 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
4309 $line =~ /^\+.*\\$/) {
4310 WARN("LINE_CONTINUATIONS",
4311 "Avoid unnecessary line continuations\n" . $herecurr);
4315 # do {} while (0) macro tests:
4316 # single-statement macros do not need to be enclosed in do while (0) loop,
4317 # macro should not end with a semicolon
4318 if ($^V && $^V ge 5.10.0 &&
4319 $realfile !~ m@/vmlinux.lds.h$@ &&
4320 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4323 my ($off, $dstat, $dcond, $rest);
4325 ($dstat, $dcond, $ln, $cnt, $off) =
4326 ctx_statement_block($linenr, $realcnt, 0);
4329 $dstat =~ s/\\\n.//g;
4332 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4337 my $cnt = statement_rawlines($ctx);
4338 my $herectx = $here . "\n";
4340 for (my $n = 0; $n < $cnt; $n++) {
4341 $herectx .= raw_line($linenr, $n) . "\n";
4344 if (($stmts =~ tr/;/;/) == 1 &&
4345 $stmts !~ /^\s*(if|while|for|switch)\b/) {
4346 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4347 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4349 if (defined $semis && $semis ne "") {
4350 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4351 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4353 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4355 my $cnt = statement_rawlines($ctx);
4356 my $herectx = $here . "\n";
4358 for (my $n = 0; $n < $cnt; $n++) {
4359 $herectx .= raw_line($linenr, $n) . "\n";
4362 WARN("TRAILING_SEMICOLON",
4363 "macros should not use a trailing semicolon\n" . "$herectx");
4367 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4368 # all assignments may have only one of the following with an assignment:
4371 # VMLINUX_SYMBOL(...)
4372 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
4373 WARN("MISSING_VMLINUX_SYMBOL",
4374 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
4377 # check for redundant bracing round if etc
4378 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4379 my ($level, $endln, @chunks) =
4380 ctx_statement_full($linenr, $realcnt, 1);
4381 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
4382 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4383 if ($#chunks > 0 && $level == 0) {
4387 my $herectx = $here . "\n";
4388 my $ln = $linenr - 1;
4389 for my $chunk (@chunks) {
4390 my ($cond, $block) = @{$chunk};
4392 # If the condition carries leading newlines, then count those as offsets.
4393 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4394 my $offset = statement_rawlines($whitespace) - 1;
4396 $allowed[$allow] = 0;
4397 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4399 # We have looked at and allowed this specific line.
4400 $suppress_ifbraces{$ln + $offset} = 1;
4402 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
4403 $ln += statement_rawlines($block) - 1;
4405 substr($block, 0, length($cond), '');
4407 $seen++ if ($block =~ /^\s*{/);
4409 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
4410 if (statement_lines($cond) > 1) {
4411 #print "APW: ALLOWED: cond<$cond>\n";
4412 $allowed[$allow] = 1;
4414 if ($block =~/\b(?:if|for|while)\b/) {
4415 #print "APW: ALLOWED: block<$block>\n";
4416 $allowed[$allow] = 1;
4418 if (statement_block_size($block) > 1) {
4419 #print "APW: ALLOWED: lines block<$block>\n";
4420 $allowed[$allow] = 1;
4425 my $sum_allowed = 0;
4426 foreach (@allowed) {
4429 if ($sum_allowed == 0) {
4431 "braces {} are not necessary for any arm of this statement\n" . $herectx);
4432 } elsif ($sum_allowed != $allow &&
4435 "braces {} should be used on all arms of this statement\n" . $herectx);
4440 if (!defined $suppress_ifbraces{$linenr - 1} &&
4441 $line =~ /\b(if|while|for|else)\b/) {
4444 # Check the pre-context.
4445 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
4446 #print "APW: ALLOWED: pre<$1>\n";
4450 my ($level, $endln, @chunks) =
4451 ctx_statement_full($linenr, $realcnt, $-[0]);
4453 # Check the condition.
4454 my ($cond, $block) = @{$chunks[0]};
4455 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
4456 if (defined $cond) {
4457 substr($block, 0, length($cond), '');
4459 if (statement_lines($cond) > 1) {
4460 #print "APW: ALLOWED: cond<$cond>\n";
4463 if ($block =~/\b(?:if|for|while)\b/) {
4464 #print "APW: ALLOWED: block<$block>\n";
4467 if (statement_block_size($block) > 1) {
4468 #print "APW: ALLOWED: lines block<$block>\n";
4471 # Check the post-context.
4472 if (defined $chunks[1]) {
4473 my ($cond, $block) = @{$chunks[1]};
4474 if (defined $cond) {
4475 substr($block, 0, length($cond), '');
4477 if ($block =~ /^\s*\{/) {
4478 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4482 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
4483 my $herectx = $here . "\n";
4484 my $cnt = statement_rawlines($block);
4486 for (my $n = 0; $n < $cnt; $n++) {
4487 $herectx .= raw_line($linenr, $n) . "\n";
4491 "braces {} are not necessary for single statement blocks\n" . $herectx);
4495 # check for unnecessary blank lines around braces
4496 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
4498 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
4499 $fix && $prevrawline =~ /^\+/) {
4500 fix_delete_line($fixlinenr - 1, $prevrawline);
4503 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
4505 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
4507 fix_delete_line($fixlinenr, $rawline);
4511 # no volatiles please
4512 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
4513 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
4515 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
4518 # Check for user-visible strings broken across lines, which breaks the ability
4519 # to grep for the string. Make exceptions when the previous string ends in a
4520 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
4521 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
4522 if ($line =~ /^\+\s*"[X\t]*"/ &&
4523 $prevline =~ /"\s*$/ &&
4524 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
4525 if (WARN("SPLIT_STRING",
4526 "quoted string split across lines\n" . $hereprev) &&
4528 $prevrawline =~ /^\+.*"\s*$/ &&
4529 $last_coalesced_string_linenr != $linenr - 1) {
4530 my $extracted_string = get_quoted_string($line, $rawline);
4531 my $comma_close = "";
4532 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
4536 fix_delete_line($fixlinenr - 1, $prevrawline);
4537 fix_delete_line($fixlinenr, $rawline);
4538 my $fixedline = $prevrawline;
4539 $fixedline =~ s/"\s*$//;
4540 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
4541 fix_insert_line($fixlinenr - 1, $fixedline);
4542 $fixedline = $rawline;
4543 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
4544 if ($fixedline !~ /\+\s*$/) {
4545 fix_insert_line($fixlinenr, $fixedline);
4547 $last_coalesced_string_linenr = $linenr;
4551 # check for missing a space in a string concatenation
4552 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
4553 WARN('MISSING_SPACE',
4554 "break quoted strings at a space character\n" . $hereprev);
4557 # check for spaces before a quoted newline
4558 if ($rawline =~ /^.*\".*\s\\n/) {
4559 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
4560 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
4562 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
4567 # concatenated string without spaces between elements
4568 if ($line =~ /"X+"[A-Z_]+/ || $line =~ /[A-Z_]+"X+"/) {
4569 CHK("CONCATENATED_STRING",
4570 "Concatenated strings should use spaces between elements\n" . $herecurr);
4573 # uncoalesced string fragments
4574 if ($line =~ /"X*"\s*"/) {
4575 WARN("STRING_FRAGMENTS",
4576 "Consecutive strings are generally better as a single string\n" . $herecurr);
4579 # check for %L{u,d,i} in strings
4581 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4582 $string = substr($rawline, $-[1], $+[1] - $-[1]);
4583 $string =~ s/%%/__/g;
4584 if ($string =~ /(?<!%)%L[udi]/) {
4586 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
4591 # check for line continuations in quoted strings with odd counts of "
4592 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
4593 WARN("LINE_CONTINUATIONS",
4594 "Avoid line continuations in quoted strings\n" . $herecurr);
4598 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
4599 CHK("REDUNDANT_CODE",
4600 "if this code is redundant consider removing it\n" .
4604 # check for needless "if (<foo>) fn(<foo>)" uses
4605 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
4606 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
4607 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
4609 "$1(NULL) is safe and this check is probably not required\n" . $hereprev);
4613 # check for unnecessary "Out of Memory" messages
4614 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
4615 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
4616 (defined $1 || defined $3) &&
4619 my $testline = $lines[$linenr - 3];
4621 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
4622 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
4624 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
4626 "Possible unnecessary 'out of memory' message\n" . $hereprev);
4630 # check for logging functions with KERN_<LEVEL>
4631 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
4632 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
4634 if (WARN("UNNECESSARY_KERN_LEVEL",
4635 "Possible unnecessary $level\n" . $herecurr) &&
4637 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
4641 # check for mask then right shift without a parentheses
4642 if ($^V && $^V ge 5.10.0 &&
4643 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
4644 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
4645 WARN("MASK_THEN_SHIFT",
4646 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
4649 # check for pointer comparisons to NULL
4650 if ($^V && $^V ge 5.10.0) {
4651 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
4654 $equal = "" if ($4 eq "!=");
4655 if (CHK("COMPARISON_TO_NULL",
4656 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
4658 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
4663 # check for bad placement of section $InitAttribute (e.g.: __initdata)
4664 if ($line =~ /(\b$InitAttribute\b)/) {
4666 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
4669 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
4670 ERROR("MISPLACED_INIT",
4671 "$attr should be placed after $var\n" . $herecurr)) ||
4672 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
4673 WARN("MISPLACED_INIT",
4674 "$attr should be placed after $var\n" . $herecurr))) &&
4676 $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;
4681 # check for $InitAttributeData (ie: __initdata) with const
4682 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
4684 $attr =~ /($InitAttributePrefix)(.*)/;
4685 my $attr_prefix = $1;
4687 if (ERROR("INIT_ATTRIBUTE",
4688 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
4690 $fixed[$fixlinenr] =~
4691 s/$InitAttributeData/${attr_prefix}initconst/;
4695 # check for $InitAttributeConst (ie: __initconst) without const
4696 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
4698 if (ERROR("INIT_ATTRIBUTE",
4699 "Use of $attr requires a separate use of const\n" . $herecurr) &&
4701 my $lead = $fixed[$fixlinenr] =~
4702 /(^\+\s*(?:static\s+))/;
4704 $lead = "$lead " if ($lead !~ /^\+$/);
4705 $lead = "${lead}const ";
4706 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
4710 # don't use __constant_<foo> functions outside of include/uapi/
4711 if ($realfile !~ m@^include/uapi/@ &&
4712 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
4713 my $constant_func = $1;
4714 my $func = $constant_func;
4715 $func =~ s/^__constant_//;
4716 if (WARN("CONSTANT_CONVERSION",
4717 "$constant_func should be $func\n" . $herecurr) &&
4719 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
4723 # prefer usleep_range over udelay
4724 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
4726 # ignore udelay's < 10, however
4727 if (! ($delay < 10) ) {
4729 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4731 if ($delay > 2000) {
4733 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
4737 # warn about unexpectedly long msleep's
4738 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
4741 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4745 # check for comparisons of jiffies
4746 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
4747 WARN("JIFFIES_COMPARISON",
4748 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4751 # check for comparisons of get_jiffies_64()
4752 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
4753 WARN("JIFFIES_COMPARISON",
4754 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4757 # warn about #ifdefs in C files
4758 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
4759 # print "#ifdef in C files should be avoided\n";
4760 # print "$herecurr";
4764 # warn about spacing in #ifdefs
4765 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
4766 if (ERROR("SPACING",
4767 "exactly one space required after that #$1\n" . $herecurr) &&
4769 $fixed[$fixlinenr] =~
4770 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
4775 # check for spinlock_t definitions without a comment.
4776 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
4777 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
4779 if (!ctx_has_comment($first_line, $linenr)) {
4780 CHK("UNCOMMENTED_DEFINITION",
4781 "$1 definition without comment\n" . $herecurr);
4784 # check for memory barriers without a comment.
4785 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4786 if (!ctx_has_comment($first_line, $linenr)) {
4787 WARN("MEMORY_BARRIER",
4788 "memory barrier without comment\n" . $herecurr);
4791 # check of hardware specific defines
4792 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
4794 "architecture specific defines should be avoided\n" . $herecurr);
4797 # Check that the storage class is at the beginning of a declaration
4798 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
4799 WARN("STORAGE_CLASS",
4800 "storage class should be at the beginning of the declaration\n" . $herecurr)
4803 # check the location of the inline attribute, that it is between
4804 # storage class and type.
4805 if ($line =~ /\b$Type\s+$Inline\b/ ||
4806 $line =~ /\b$Inline\s+$Storage\b/) {
4807 ERROR("INLINE_LOCATION",
4808 "inline keyword should sit between storage class and type\n" . $herecurr);
4811 # Check for __inline__ and __inline, prefer inline
4812 if ($realfile !~ m@\binclude/uapi/@ &&
4813 $line =~ /\b(__inline__|__inline)\b/) {
4815 "plain inline is preferred over $1\n" . $herecurr) &&
4817 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
4822 # Check for __attribute__ packed, prefer __packed
4823 if ($realfile !~ m@\binclude/uapi/@ &&
4824 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
4825 WARN("PREFER_PACKED",
4826 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
4829 # Check for __attribute__ aligned, prefer __aligned
4830 if ($realfile !~ m@\binclude/uapi/@ &&
4831 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
4832 WARN("PREFER_ALIGNED",
4833 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
4836 # Check for __attribute__ format(printf, prefer __printf
4837 if ($realfile !~ m@\binclude/uapi/@ &&
4838 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
4839 if (WARN("PREFER_PRINTF",
4840 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4842 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
4847 # Check for __attribute__ format(scanf, prefer __scanf
4848 if ($realfile !~ m@\binclude/uapi/@ &&
4849 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
4850 if (WARN("PREFER_SCANF",
4851 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4853 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
4857 # Check for __attribute__ weak, or __weak declarations (may have link issues)
4858 if ($^V && $^V ge 5.10.0 &&
4859 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
4860 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
4861 $line =~ /\b__weak\b/)) {
4862 ERROR("WEAK_DECLARATION",
4863 "Using weak declarations can have unintended link defects\n" . $herecurr);
4866 # check for sizeof(&)
4867 if ($line =~ /\bsizeof\s*\(\s*\&/) {
4868 WARN("SIZEOF_ADDRESS",
4869 "sizeof(& should be avoided\n" . $herecurr);
4872 # check for sizeof without parenthesis
4873 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
4874 if (WARN("SIZEOF_PARENTHESIS",
4875 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
4877 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
4881 # check for struct spinlock declarations
4882 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
4883 WARN("USE_SPINLOCK_T",
4884 "struct spinlock should be spinlock_t\n" . $herecurr);
4887 # check for seq_printf uses that could be seq_puts
4888 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
4889 my $fmt = get_quoted_string($line, $rawline);
4892 if (WARN("PREFER_SEQ_PUTS",
4893 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
4895 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
4900 # Check for misused memsets
4901 if ($^V && $^V ge 5.10.0 &&
4903 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
4909 if ($ms_size =~ /^(0x|)0$/i) {
4911 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
4912 } elsif ($ms_size =~ /^(0x|)1$/i) {
4914 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
4918 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
4919 if ($^V && $^V ge 5.10.0 &&
4920 $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) {
4921 if (WARN("PREFER_ETHER_ADDR_COPY",
4922 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
4924 $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
4928 # typecasts on min/max could be min_t/max_t
4929 if ($^V && $^V ge 5.10.0 &&
4931 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
4932 if (defined $2 || defined $7) {
4934 my $cast1 = deparenthesize($2);
4936 my $cast2 = deparenthesize($7);
4940 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
4941 $cast = "$cast1 or $cast2";
4942 } elsif ($cast1 ne "") {
4948 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
4952 # check usleep_range arguments
4953 if ($^V && $^V ge 5.10.0 &&
4955 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
4959 WARN("USLEEP_RANGE",
4960 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4961 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
4963 WARN("USLEEP_RANGE",
4964 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4968 # check for naked sscanf
4969 if ($^V && $^V ge 5.10.0 &&
4971 $line =~ /\bsscanf\b/ &&
4972 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
4973 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
4974 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
4975 my $lc = $stat =~ tr@\n@@;
4976 $lc = $lc + $linenr;
4977 my $stat_real = raw_line($linenr, 0);
4978 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4979 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4981 WARN("NAKED_SSCANF",
4982 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
4985 # check for simple sscanf that should be kstrto<foo>
4986 if ($^V && $^V ge 5.10.0 &&
4988 $line =~ /\bsscanf\b/) {
4989 my $lc = $stat =~ tr@\n@@;
4990 $lc = $lc + $linenr;
4991 my $stat_real = raw_line($linenr, 0);
4992 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4993 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4995 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
4997 my $count = $format =~ tr@%@%@;
4999 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5000 WARN("SSCANF_TO_KSTRTO",
5001 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5006 # check for new externs in .h files.
5007 if ($realfile =~ /\.h$/ &&
5008 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
5009 if (CHK("AVOID_EXTERNS",
5010 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
5012 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
5016 # check for new externs in .c files.
5017 if ($realfile =~ /\.c$/ && defined $stat &&
5018 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
5020 my $function_name = $1;
5021 my $paren_space = $2;
5024 if (defined $cond) {
5025 substr($s, 0, length($cond), '');
5027 if ($s =~ /^\s*;/ &&
5028 $function_name ne 'uninitialized_var')
5030 WARN("AVOID_EXTERNS",
5031 "externs should be avoided in .c files\n" . $herecurr);
5034 if ($paren_space =~ /\n/) {
5035 WARN("FUNCTION_ARGUMENTS",
5036 "arguments for function declarations should follow identifier\n" . $herecurr);
5039 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5040 $stat =~ /^.\s*extern\s+/)
5042 WARN("AVOID_EXTERNS",
5043 "externs should be avoided in .c files\n" . $herecurr);
5046 # checks for new __setup's
5047 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5050 if (!grep(/$name/, @setup_docs)) {
5051 CHK("UNDOCUMENTED_SETUP",
5052 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
5056 # check for pointless casting of kmalloc return
5057 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
5058 WARN("UNNECESSARY_CASTS",
5059 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
5063 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5064 if ($^V && $^V ge 5.10.0 &&
5065 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5066 CHK("ALLOC_SIZEOF_STRUCT",
5067 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
5070 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5071 if ($^V && $^V ge 5.10.0 &&
5072 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
5076 my $newfunc = "kmalloc_array";
5077 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
5080 if ($a1 =~ /^sizeof\s*\S/) {
5084 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
5085 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
5086 if (WARN("ALLOC_WITH_MULTIPLY",
5087 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
5089 $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;
5095 # check for krealloc arg reuse
5096 if ($^V && $^V ge 5.10.0 &&
5097 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
5098 WARN("KREALLOC_ARG_REUSE",
5099 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
5102 # check for alloc argument mismatch
5103 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
5104 WARN("ALLOC_ARRAY_ARGS",
5105 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
5108 # check for multiple semicolons
5109 if ($line =~ /;\s*;\s*$/) {
5110 if (WARN("ONE_SEMICOLON",
5111 "Statements terminations use 1 semicolon\n" . $herecurr) &&
5113 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
5117 # check for #defines like: 1 << <digit> that could be BIT(digit)
5118 if ($line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
5120 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
5121 if (CHK("BIT_MACRO",
5122 "Prefer using the BIT$ull macro\n" . $herecurr) &&
5124 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
5128 # check for case / default statements not preceded by break/fallthrough/switch
5129 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
5131 my $has_statement = 0;
5133 my $prevline = $linenr;
5134 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
5136 my $rline = $rawlines[$prevline - 1];
5137 my $fline = $lines[$prevline - 1];
5138 last if ($fline =~ /^\@\@/);
5139 next if ($fline =~ /^\-/);
5140 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
5141 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
5142 next if ($fline =~ /^.[\s$;]*$/);
5145 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
5147 if (!$has_break && $has_statement) {
5148 WARN("MISSING_BREAK",
5149 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
5153 # check for switch/default statements without a break;
5154 if ($^V && $^V ge 5.10.0 &&
5156 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
5158 my $herectx = $here . "\n";
5159 my $cnt = statement_rawlines($stat);
5160 for (my $n = 0; $n < $cnt; $n++) {
5161 $herectx .= raw_line($linenr, $n) . "\n";
5163 WARN("DEFAULT_NO_BREAK",
5164 "switch default: should use break\n" . $herectx);
5167 # check for gcc specific __FUNCTION__
5168 if ($line =~ /\b__FUNCTION__\b/) {
5169 if (WARN("USE_FUNC",
5170 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
5172 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
5176 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
5177 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
5179 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
5182 # check for use of yield()
5183 if ($line =~ /\byield\s*\(\s*\)/) {
5185 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
5188 # check for comparisons against true and false
5189 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
5197 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
5199 my $type = lc($otype);
5200 if ($type =~ /^(?:true|false)$/) {
5201 if (("$test" eq "==" && "$type" eq "true") ||
5202 ("$test" eq "!=" && "$type" eq "false")) {
5206 CHK("BOOL_COMPARISON",
5207 "Using comparison to $otype is error prone\n" . $herecurr);
5209 ## maybe suggesting a correct construct would better
5210 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5215 # check for semaphores initialized locked
5216 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
5217 WARN("CONSIDER_COMPLETION",
5218 "consider using a completion\n" . $herecurr);
5221 # recommend kstrto* over simple_strto* and strict_strto*
5222 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
5223 WARN("CONSIDER_KSTRTO",
5224 "$1 is obsolete, use k$3 instead\n" . $herecurr);
5227 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
5228 if ($line =~ /^.\s*__initcall\s*\(/) {
5229 WARN("USE_DEVICE_INITCALL",
5230 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
5233 # check for various structs that are normally const (ops, kgdb, device_tree)
5234 my $const_structs = qr{
5236 address_space_operations|
5238 block_device_operations|
5243 file_lock_operations|
5253 lock_manager_operations|
5260 pipe_buf_operations|
5261 platform_hibernation_ops|
5262 platform_suspend_ops|
5267 soc_pcmcia_socket_ops|
5273 if ($line !~ /\bconst\b/ &&
5274 $line =~ /\bstruct\s+($const_structs)\b/) {
5275 WARN("CONST_STRUCT",
5276 "struct $1 should normally be const\n" .
5280 # use of NR_CPUS is usually wrong
5281 # ignore definitions of NR_CPUS and usage to define arrays as likely right
5282 if ($line =~ /\bNR_CPUS\b/ &&
5283 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
5284 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
5285 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
5286 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
5287 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
5290 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
5293 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
5294 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
5295 ERROR("DEFINE_ARCH_HAS",
5296 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
5299 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
5300 if ($^V && $^V ge 5.10.0 &&
5301 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
5302 WARN("LIKELY_MISUSE",
5303 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
5306 # whine mightly about in_atomic
5307 if ($line =~ /\bin_atomic\s*\(/) {
5308 if ($realfile =~ m@^drivers/@) {
5310 "do not use in_atomic in drivers\n" . $herecurr);
5311 } elsif ($realfile !~ m@^kernel/@) {
5313 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
5317 # check for lockdep_set_novalidate_class
5318 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
5319 $line =~ /__lockdep_no_validate__\s*\)/ ) {
5320 if ($realfile !~ m@^kernel/lockdep@ &&
5321 $realfile !~ m@^include/linux/lockdep@ &&
5322 $realfile !~ m@^drivers/base/core@) {
5324 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
5328 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
5329 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
5330 WARN("EXPORTED_WORLD_WRITABLE",
5331 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5334 # Mode permission misuses where it seems decimal should be octal
5335 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5336 if ($^V && $^V ge 5.10.0 &&
5337 $line =~ /$mode_perms_search/) {
5338 foreach my $entry (@mode_permission_funcs) {
5339 my $func = $entry->[0];
5340 my $arg_pos = $entry->[1];
5345 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
5347 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
5348 if ($line =~ /$test/) {
5350 $val = $6 if ($skip_args ne "");
5352 if ($val !~ /^0$/ &&
5353 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
5354 length($val) ne 4)) {
5355 ERROR("NON_OCTAL_PERMISSIONS",
5356 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
5357 } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) {
5358 ERROR("EXPORTED_WORLD_WRITABLE",
5359 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5366 # If we have no input at all, then there is nothing to report on
5367 # so just keep quiet.
5368 if ($#rawlines == -1) {
5372 # In mailback mode only produce a report in the negative, for
5373 # things that appear to be patches.
5374 if ($mailback && ($clean == 1 || !$is_patch)) {
5378 # This is not a patch, and we are are in 'no-patch' mode so
5380 if (!$chk_patch && !$is_patch) {
5385 ERROR("NOT_UNIFIED_DIFF",
5386 "Does not appear to be a unified-diff format patch\n");
5388 if ($is_patch && $chk_signoff && $signoff == 0) {
5389 ERROR("MISSING_SIGN_OFF",
5390 "Missing Signed-off-by: line(s)\n");
5393 print report_dump();
5394 if ($summary && !($clean == 1 && $quiet == 1)) {
5395 print "$filename " if ($summary_file);
5396 print "total: $cnt_error errors, $cnt_warn warnings, " .
5397 (($check)? "$cnt_chk checks, " : "") .
5398 "$cnt_lines lines checked\n";
5399 print "\n" if ($quiet == 0);
5404 if ($^V lt 5.10.0) {
5405 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
5406 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
5409 # If there were whitespace errors which cleanpatch can fix
5410 # then suggest that.
5411 if ($rpt_cleaners) {
5412 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
5413 print " scripts/cleanfile\n\n";
5418 hash_show_words(\%use_type, "Used");
5419 hash_show_words(\%ignore_type, "Ignored");
5421 if ($clean == 0 && $fix &&
5422 ("@rawlines" ne "@fixed" ||
5423 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
5424 my $newfile = $filename;
5425 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
5429 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
5431 open($f, '>', $newfile)
5432 or die "$P: Can't open $newfile for write\n";
5433 foreach my $fixed_line (@fixed) {
5436 if ($linecount > 3) {
5437 $fixed_line =~ s/^\+//;
5438 print $f $fixed_line . "\n";
5441 print $f $fixed_line . "\n";
5448 Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
5450 Do _NOT_ trust the results written to this file.
5451 Do _NOT_ submit these changes without inspecting them for correctness.
5453 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
5454 No warranties, expressed or implied...
5460 if ($clean == 1 && $quiet == 0) {
5461 print "$vname has no obvious style problems and is ready for submission.\n"
5463 if ($clean == 0 && $quiet == 0) {
5465 $vname has style problems, please review.
5467 If any of these errors are false positives, please report
5468 them to the maintainer, see CHECKPATCH in MAINTAINERS.