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 $typeTypedefs = qr{(?x:
343 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
347 our $logFunctions = qr{(?x:
348 printk(?:_ratelimited|_once|)|
349 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
350 WARN(?:_RATELIMIT|_ONCE|)|
353 seq_vprintf|seq_printf|seq_puts
356 our $signature_tags = qr{(?xi:
367 our @typeListMisordered = (
368 qr{char\s+(?:un)?signed},
369 qr{int\s+(?:(?:un)?signed\s+)?short\s},
370 qr{int\s+short(?:\s+(?:un)?signed)},
371 qr{short\s+int(?:\s+(?:un)?signed)},
372 qr{(?:un)?signed\s+int\s+short},
373 qr{short\s+(?:un)?signed},
374 qr{long\s+int\s+(?:un)?signed},
375 qr{int\s+long\s+(?:un)?signed},
376 qr{long\s+(?:un)?signed\s+int},
377 qr{int\s+(?:un)?signed\s+long},
378 qr{int\s+(?:un)?signed},
379 qr{int\s+long\s+long\s+(?:un)?signed},
380 qr{long\s+long\s+int\s+(?:un)?signed},
381 qr{long\s+long\s+(?:un)?signed\s+int},
382 qr{long\s+long\s+(?:un)?signed},
383 qr{long\s+(?:un)?signed},
388 qr{(?:(?:un)?signed\s+)?char},
389 qr{(?:(?:un)?signed\s+)?short\s+int},
390 qr{(?:(?:un)?signed\s+)?short},
391 qr{(?:(?:un)?signed\s+)?int},
392 qr{(?:(?:un)?signed\s+)?long\s+int},
393 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
394 qr{(?:(?:un)?signed\s+)?long\s+long},
395 qr{(?:(?:un)?signed\s+)?long},
404 qr{${Ident}_handler},
405 qr{${Ident}_handler_fn},
408 our @typeListWithAttr = (
410 qr{struct\s+$InitAttribute\s+$Ident},
411 qr{union\s+$InitAttribute\s+$Ident},
414 our @modifierList = (
418 our @mode_permission_funcs = (
420 ["module_param_(?:array|named|string)", 4],
421 ["module_param_array_named", 5],
422 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
423 ["proc_create(?:_data|)", 2],
424 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
427 #Create a search pattern for all these functions to speed up a loop below
428 our $mode_perms_search = "";
429 foreach my $entry (@mode_permission_funcs) {
430 $mode_perms_search .= '|' if ($mode_perms_search ne "");
431 $mode_perms_search .= $entry->[0];
434 our $allowed_asm_includes = qr{(?x:
440 # memory.h: ARM has a custom one
442 # Load common spelling mistakes and build regular expression list.
446 if (open(my $spelling, '<', $spelling_file)) {
448 while (<$spelling>) {
451 $line =~ s/\s*\n?$//g;
454 next if ($line =~ m/^\s*#/);
455 next if ($line =~ m/^\s*$/);
457 my ($suspect, $fix) = split(/\|\|/, $line);
459 push(@spelling_list, $suspect);
460 $spelling_fix{$suspect} = $fix;
463 $misspellings = join("|", @spelling_list);
465 warn "No typos will be found - file '$spelling_file': $!\n";
469 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
470 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
471 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
472 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
473 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
475 (?:$Modifier\s+|const\s+)*
477 (?:typeof|__typeof__)\s*\([^\)]*\)|
481 (?:\s+$Modifier|\s+const)*
483 $NonptrTypeMisordered = qr{
484 (?:$Modifier\s+|const\s+)*
488 (?:\s+$Modifier|\s+const)*
490 $NonptrTypeWithAttr = qr{
491 (?:$Modifier\s+|const\s+)*
493 (?:typeof|__typeof__)\s*\([^\)]*\)|
497 (?:\s+$Modifier|\s+const)*
501 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
502 (?:\s+$Inline|\s+$Modifier)*
504 $TypeMisordered = qr{
505 $NonptrTypeMisordered
506 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
507 (?:\s+$Inline|\s+$Modifier)*
509 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
510 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
514 our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
516 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
517 # requires at least perl version v5.10.0
518 # Any use must be runtime checked with $^V
520 our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
521 our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
522 our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
524 our $declaration_macros = qr{(?x:
525 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,2}\s*\(|
526 (?:$Storage\s+)?LIST_HEAD\s*\(|
527 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
532 return "" if (!defined($string));
534 while ($string =~ /^\s*\(.*\)\s*$/) {
535 $string =~ s@^\s*\(\s*@@;
536 $string =~ s@\s*\)\s*$@@;
539 $string =~ s@\s+@ @g;
544 sub seed_camelcase_file {
547 return if (!(-f $file));
551 open(my $include_file, '<', "$file")
552 or warn "$P: Can't read '$file' $!\n";
553 my $text = <$include_file>;
554 close($include_file);
556 my @lines = split('\n', $text);
558 foreach my $line (@lines) {
559 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
560 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
562 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
564 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
570 my $camelcase_seeded = 0;
571 sub seed_camelcase_includes {
572 return if ($camelcase_seeded);
575 my $camelcase_cache = "";
576 my @include_files = ();
578 $camelcase_seeded = 1;
581 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
582 chomp $git_last_include_commit;
583 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
585 my $last_mod_date = 0;
586 $files = `find $root/include -name "*.h"`;
587 @include_files = split('\n', $files);
588 foreach my $file (@include_files) {
589 my $date = POSIX::strftime("%Y%m%d%H%M",
590 localtime((stat $file)[9]));
591 $last_mod_date = $date if ($last_mod_date < $date);
593 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
596 if ($camelcase_cache ne "" && -f $camelcase_cache) {
597 open(my $camelcase_file, '<', "$camelcase_cache")
598 or warn "$P: Can't read '$camelcase_cache' $!\n";
599 while (<$camelcase_file>) {
603 close($camelcase_file);
609 $files = `git ls-files "include/*.h"`;
610 @include_files = split('\n', $files);
613 foreach my $file (@include_files) {
614 seed_camelcase_file($file);
617 if ($camelcase_cache ne "") {
618 unlink glob ".checkpatch-camelcase.*";
619 open(my $camelcase_file, '>', "$camelcase_cache")
620 or warn "$P: Can't write '$camelcase_cache' $!\n";
621 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
622 print $camelcase_file ("$_\n");
624 close($camelcase_file);
628 sub git_commit_info {
629 my ($commit, $id, $desc) = @_;
631 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
633 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
634 $output =~ s/^\s*//gm;
635 my @lines = split("\n", $output);
637 return ($id, $desc) if ($#lines < 0);
639 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
640 # Maybe one day convert this block of bash into something that returns
641 # all matching commit ids, but it's very slow...
643 # echo "checking commits $1..."
644 # git rev-list --remotes | grep -i "^$1" |
645 # while read line ; do
646 # git log --format='%H %s' -1 $line |
647 # echo "commit $(cut -c 1-12,41-)"
649 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
651 $id = substr($lines[0], 0, 12);
652 $desc = substr($lines[0], 41);
658 $chk_signoff = 0 if ($file);
663 my @fixed_inserted = ();
664 my @fixed_deleted = ();
668 for my $filename (@ARGV) {
671 open($FILE, '-|', "diff -u /dev/null $filename") ||
672 die "$P: $filename: diff failed - $!\n";
673 } elsif ($filename eq '-') {
674 open($FILE, '<&STDIN');
676 open($FILE, '<', "$filename") ||
677 die "$P: $filename: open failed - $!\n";
679 if ($filename eq '-') {
680 $vname = 'Your patch';
689 if (!process($filename)) {
695 @fixed_inserted = ();
702 sub top_of_kernel_tree {
706 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
707 "README", "Documentation", "arch", "include", "drivers",
708 "fs", "init", "ipc", "kernel", "lib", "scripts",
711 foreach my $check (@tree_check) {
712 if (! -e $root . '/' . $check) {
720 my ($formatted_email) = @_;
726 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
729 $comment = $3 if defined $3;
730 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
732 $comment = $2 if defined $2;
733 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
735 $comment = $2 if defined $2;
736 $formatted_email =~ s/$address.*$//;
737 $name = $formatted_email;
739 $name =~ s/^\"|\"$//g;
740 # If there's a name left after stripping spaces and
741 # leading quotes, and the address doesn't have both
742 # leading and trailing angle brackets, the address
744 # "joe smith joe@smith.com" bad
745 # "joe smith <joe@smith.com" bad
746 if ($name ne "" && $address !~ /^<[^>]+>$/) {
754 $name =~ s/^\"|\"$//g;
755 $address = trim($address);
756 $address =~ s/^\<|\>$//g;
758 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
759 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
763 return ($name, $address, $comment);
767 my ($name, $address) = @_;
772 $name =~ s/^\"|\"$//g;
773 $address = trim($address);
775 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
776 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
781 $formatted_email = "$address";
783 $formatted_email = "$name <$address>";
786 return $formatted_email;
792 foreach my $path (split(/:/, $ENV{PATH})) {
793 if (-e "$path/$bin") {
804 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
805 if (-e "$path/$conf") {
806 return "$path/$conf";
818 for my $c (split(//, $str)) {
822 for (; ($n % 8) != 0; $n++) {
834 (my $res = shift) =~ tr/\t/ /c;
841 # Drop the diff line leader and expand tabs
843 $line = expand_tabs($line);
845 # Pick the indent from the front of the line.
846 my ($white) = ($line =~ /^(\s*)/);
848 return (length($line), length($white));
851 my $sanitise_quote = '';
853 sub sanitise_line_reset {
854 my ($in_comment) = @_;
857 $sanitise_quote = '*/';
859 $sanitise_quote = '';
872 # Always copy over the diff marker.
873 $res = substr($line, 0, 1);
875 for ($off = 1; $off < length($line); $off++) {
876 $c = substr($line, $off, 1);
878 # Comments we are wacking completly including the begin
879 # and end, all to $;.
880 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
881 $sanitise_quote = '*/';
883 substr($res, $off, 2, "$;$;");
887 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
888 $sanitise_quote = '';
889 substr($res, $off, 2, "$;$;");
893 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
894 $sanitise_quote = '//';
896 substr($res, $off, 2, $sanitise_quote);
901 # A \ in a string means ignore the next character.
902 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
904 substr($res, $off, 2, 'XX');
909 if ($c eq "'" || $c eq '"') {
910 if ($sanitise_quote eq '') {
911 $sanitise_quote = $c;
913 substr($res, $off, 1, $c);
915 } elsif ($sanitise_quote eq $c) {
916 $sanitise_quote = '';
920 #print "c<$c> SQ<$sanitise_quote>\n";
921 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
922 substr($res, $off, 1, $;);
923 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
924 substr($res, $off, 1, $;);
925 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
926 substr($res, $off, 1, 'X');
928 substr($res, $off, 1, $c);
932 if ($sanitise_quote eq '//') {
933 $sanitise_quote = '';
936 # The pathname on a #include may be surrounded by '<' and '>'.
937 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
938 my $clean = 'X' x length($1);
939 $res =~ s@\<.*\>@<$clean>@;
941 # The whole of a #error is a string.
942 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
943 my $clean = 'X' x length($1);
944 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
950 sub get_quoted_string {
951 my ($line, $rawline) = @_;
953 return "" if ($line !~ m/(\"[X\t]+\")/g);
954 return substr($rawline, $-[0], $+[0] - $-[0]);
957 sub ctx_statement_block {
958 my ($linenr, $remain, $off) = @_;
959 my $line = $linenr - 1;
976 @stack = (['', 0]) if ($#stack == -1);
978 #warn "CSB: blk<$blk> remain<$remain>\n";
979 # If we are about to drop off the end, pull in more
982 for (; $remain > 0; $line++) {
983 last if (!defined $lines[$line]);
984 next if ($lines[$line] =~ /^-/);
987 $blk .= $lines[$line] . "\n";
992 # Bail if there is no further context.
993 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
997 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1003 $c = substr($blk, $off, 1);
1004 $remainder = substr($blk, $off);
1006 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1008 # Handle nested #if/#else.
1009 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1010 push(@stack, [ $type, $level ]);
1011 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1012 ($type, $level) = @{$stack[$#stack - 1]};
1013 } elsif ($remainder =~ /^#\s*endif\b/) {
1014 ($type, $level) = @{pop(@stack)};
1017 # Statement ends at the ';' or a close '}' at the
1019 if ($level == 0 && $c eq ';') {
1023 # An else is really a conditional as long as its not else if
1024 if ($level == 0 && $coff_set == 0 &&
1025 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1026 $remainder =~ /^(else)(?:\s|{)/ &&
1027 $remainder !~ /^else\s+if\b/) {
1028 $coff = $off + length($1) - 1;
1030 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1031 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1034 if (($type eq '' || $type eq '(') && $c eq '(') {
1038 if ($type eq '(' && $c eq ')') {
1040 $type = ($level != 0)? '(' : '';
1042 if ($level == 0 && $coff < $soff) {
1045 #warn "CSB: mark coff<$coff>\n";
1048 if (($type eq '' || $type eq '{') && $c eq '{') {
1052 if ($type eq '{' && $c eq '}') {
1054 $type = ($level != 0)? '{' : '';
1057 if (substr($blk, $off + 1, 1) eq ';') {
1063 # Preprocessor commands end at the newline unless escaped.
1064 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1072 # We are truly at the end, so shuffle to the next line.
1079 my $statement = substr($blk, $soff, $off - $soff + 1);
1080 my $condition = substr($blk, $soff, $coff - $soff + 1);
1082 #warn "STATEMENT<$statement>\n";
1083 #warn "CONDITION<$condition>\n";
1085 #print "coff<$coff> soff<$off> loff<$loff>\n";
1087 return ($statement, $condition,
1088 $line, $remain + 1, $off - $loff + 1, $level);
1091 sub statement_lines {
1094 # Strip the diff line prefixes and rip blank lines at start and end.
1095 $stmt =~ s/(^|\n)./$1/g;
1099 my @stmt_lines = ($stmt =~ /\n/g);
1101 return $#stmt_lines + 2;
1104 sub statement_rawlines {
1107 my @stmt_lines = ($stmt =~ /\n/g);
1109 return $#stmt_lines + 2;
1112 sub statement_block_size {
1115 $stmt =~ s/(^|\n)./$1/g;
1121 my @stmt_lines = ($stmt =~ /\n/g);
1122 my @stmt_statements = ($stmt =~ /;/g);
1124 my $stmt_lines = $#stmt_lines + 2;
1125 my $stmt_statements = $#stmt_statements + 1;
1127 if ($stmt_lines > $stmt_statements) {
1130 return $stmt_statements;
1134 sub ctx_statement_full {
1135 my ($linenr, $remain, $off) = @_;
1136 my ($statement, $condition, $level);
1140 # Grab the first conditional/block pair.
1141 ($statement, $condition, $linenr, $remain, $off, $level) =
1142 ctx_statement_block($linenr, $remain, $off);
1143 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1144 push(@chunks, [ $condition, $statement ]);
1145 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1146 return ($level, $linenr, @chunks);
1149 # Pull in the following conditional/block pairs and see if they
1150 # could continue the statement.
1152 ($statement, $condition, $linenr, $remain, $off, $level) =
1153 ctx_statement_block($linenr, $remain, $off);
1154 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1155 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1157 push(@chunks, [ $condition, $statement ]);
1160 return ($level, $linenr, @chunks);
1164 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1166 my $start = $linenr - 1;
1173 my @stack = ($level);
1174 for ($line = $start; $remain > 0; $line++) {
1175 next if ($rawlines[$line] =~ /^-/);
1178 $blk .= $rawlines[$line];
1180 # Handle nested #if/#else.
1181 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1182 push(@stack, $level);
1183 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1184 $level = $stack[$#stack - 1];
1185 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1186 $level = pop(@stack);
1189 foreach my $c (split(//, $lines[$line])) {
1190 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1196 if ($c eq $close && $level > 0) {
1198 last if ($level == 0);
1199 } elsif ($c eq $open) {
1204 if (!$outer || $level <= 1) {
1205 push(@res, $rawlines[$line]);
1208 last if ($level == 0);
1211 return ($level, @res);
1213 sub ctx_block_outer {
1214 my ($linenr, $remain) = @_;
1216 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1220 my ($linenr, $remain) = @_;
1222 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1226 my ($linenr, $remain, $off) = @_;
1228 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1231 sub ctx_block_level {
1232 my ($linenr, $remain) = @_;
1234 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1236 sub ctx_statement_level {
1237 my ($linenr, $remain, $off) = @_;
1239 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1242 sub ctx_locate_comment {
1243 my ($first_line, $end_line) = @_;
1245 # Catch a comment on the end of the line itself.
1246 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1247 return $current_comment if (defined $current_comment);
1249 # Look through the context and try and figure out if there is a
1252 $current_comment = '';
1253 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1254 my $line = $rawlines[$linenr - 1];
1256 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1259 if ($line =~ m@/\*@) {
1262 if (!$in_comment && $current_comment ne '') {
1263 $current_comment = '';
1265 $current_comment .= $line . "\n" if ($in_comment);
1266 if ($line =~ m@\*/@) {
1271 chomp($current_comment);
1272 return($current_comment);
1274 sub ctx_has_comment {
1275 my ($first_line, $end_line) = @_;
1276 my $cmt = ctx_locate_comment($first_line, $end_line);
1278 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1279 ##print "CMMT: $cmt\n";
1281 return ($cmt ne '');
1285 my ($linenr, $cnt) = @_;
1287 my $offset = $linenr - 1;
1292 $line = $rawlines[$offset++];
1293 next if (defined($line) && $line =~ /^-/);
1305 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1308 $coded = sprintf("^%c", unpack('C', $2) + 64);
1317 my $av_preprocessor = 0;
1322 sub annotate_reset {
1323 $av_preprocessor = 0;
1325 @av_paren_type = ('E');
1326 $av_pend_colon = 'O';
1329 sub annotate_values {
1330 my ($stream, $type) = @_;
1333 my $var = '_' x length($stream);
1336 print "$stream\n" if ($dbg_values > 1);
1338 while (length($cur)) {
1339 @av_paren_type = ('E') if ($#av_paren_type < 0);
1340 print " <" . join('', @av_paren_type) .
1341 "> <$type> <$av_pending>" if ($dbg_values > 1);
1342 if ($cur =~ /^(\s+)/o) {
1343 print "WS($1)\n" if ($dbg_values > 1);
1344 if ($1 =~ /\n/ && $av_preprocessor) {
1345 $type = pop(@av_paren_type);
1346 $av_preprocessor = 0;
1349 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1350 print "CAST($1)\n" if ($dbg_values > 1);
1351 push(@av_paren_type, $type);
1354 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1355 print "DECLARE($1)\n" if ($dbg_values > 1);
1358 } elsif ($cur =~ /^($Modifier)\s*/) {
1359 print "MODIFIER($1)\n" if ($dbg_values > 1);
1362 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1363 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1364 $av_preprocessor = 1;
1365 push(@av_paren_type, $type);
1371 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1372 print "UNDEF($1)\n" if ($dbg_values > 1);
1373 $av_preprocessor = 1;
1374 push(@av_paren_type, $type);
1376 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1377 print "PRE_START($1)\n" if ($dbg_values > 1);
1378 $av_preprocessor = 1;
1380 push(@av_paren_type, $type);
1381 push(@av_paren_type, $type);
1384 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1385 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1386 $av_preprocessor = 1;
1388 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1392 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1393 print "PRE_END($1)\n" if ($dbg_values > 1);
1395 $av_preprocessor = 1;
1397 # Assume all arms of the conditional end as this
1398 # one does, and continue as if the #endif was not here.
1399 pop(@av_paren_type);
1400 push(@av_paren_type, $type);
1403 } elsif ($cur =~ /^(\\\n)/o) {
1404 print "PRECONT($1)\n" if ($dbg_values > 1);
1406 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1407 print "ATTR($1)\n" if ($dbg_values > 1);
1408 $av_pending = $type;
1411 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1412 print "SIZEOF($1)\n" if ($dbg_values > 1);
1418 } elsif ($cur =~ /^(if|while|for)\b/o) {
1419 print "COND($1)\n" if ($dbg_values > 1);
1423 } elsif ($cur =~/^(case)/o) {
1424 print "CASE($1)\n" if ($dbg_values > 1);
1425 $av_pend_colon = 'C';
1428 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1429 print "KEYWORD($1)\n" if ($dbg_values > 1);
1432 } elsif ($cur =~ /^(\()/o) {
1433 print "PAREN('$1')\n" if ($dbg_values > 1);
1434 push(@av_paren_type, $av_pending);
1438 } elsif ($cur =~ /^(\))/o) {
1439 my $new_type = pop(@av_paren_type);
1440 if ($new_type ne '_') {
1442 print "PAREN('$1') -> $type\n"
1443 if ($dbg_values > 1);
1445 print "PAREN('$1')\n" if ($dbg_values > 1);
1448 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1449 print "FUNC($1)\n" if ($dbg_values > 1);
1453 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1454 if (defined $2 && $type eq 'C' || $type eq 'T') {
1455 $av_pend_colon = 'B';
1456 } elsif ($type eq 'E') {
1457 $av_pend_colon = 'L';
1459 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1462 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1463 print "IDENT($1)\n" if ($dbg_values > 1);
1466 } elsif ($cur =~ /^($Assignment)/o) {
1467 print "ASSIGN($1)\n" if ($dbg_values > 1);
1470 } elsif ($cur =~/^(;|{|})/) {
1471 print "END($1)\n" if ($dbg_values > 1);
1473 $av_pend_colon = 'O';
1475 } elsif ($cur =~/^(,)/) {
1476 print "COMMA($1)\n" if ($dbg_values > 1);
1479 } elsif ($cur =~ /^(\?)/o) {
1480 print "QUESTION($1)\n" if ($dbg_values > 1);
1483 } elsif ($cur =~ /^(:)/o) {
1484 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1486 substr($var, length($res), 1, $av_pend_colon);
1487 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1492 $av_pend_colon = 'O';
1494 } elsif ($cur =~ /^(\[)/o) {
1495 print "CLOSE($1)\n" if ($dbg_values > 1);
1498 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1501 print "OPV($1)\n" if ($dbg_values > 1);
1508 substr($var, length($res), 1, $variant);
1511 } elsif ($cur =~ /^($Operators)/o) {
1512 print "OP($1)\n" if ($dbg_values > 1);
1513 if ($1 ne '++' && $1 ne '--') {
1517 } elsif ($cur =~ /(^.)/o) {
1518 print "C($1)\n" if ($dbg_values > 1);
1521 $cur = substr($cur, length($1));
1522 $res .= $type x length($1);
1526 return ($res, $var);
1530 my ($possible, $line) = @_;
1531 my $notPermitted = qr{(?:
1548 ^(?:typedef|struct|enum)\b
1550 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1551 if ($possible !~ $notPermitted) {
1552 # Check for modifiers.
1553 $possible =~ s/\s*$Storage\s*//g;
1554 $possible =~ s/\s*$Sparse\s*//g;
1555 if ($possible =~ /^\s*$/) {
1557 } elsif ($possible =~ /\s/) {
1558 $possible =~ s/\s*$Type\s*//g;
1559 for my $modifier (split(' ', $possible)) {
1560 if ($modifier !~ $notPermitted) {
1561 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1562 push(@modifierList, $modifier);
1567 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1568 push(@typeList, $possible);
1572 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1581 return defined $use_type{$type} if (scalar keys %use_type > 0);
1583 return !defined $ignore_type{$type};
1587 my ($level, $type, $msg) = @_;
1589 if (!show_type($type) ||
1590 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
1595 $line = "$prefix$level:$type: $msg\n";
1597 $line = "$prefix$level: $msg\n";
1599 $line = (split('\n', $line))[0] . "\n" if ($terse);
1601 push(our @report, $line);
1610 sub fixup_current_range {
1611 my ($lineRef, $offset, $length) = @_;
1613 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1616 my $no = $o + $offset;
1617 my $nl = $l + $length;
1618 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1622 sub fix_inserted_deleted_lines {
1623 my ($linesRef, $insertedRef, $deletedRef) = @_;
1625 my $range_last_linenr = 0;
1626 my $delta_offset = 0;
1631 my $next_insert = 0;
1632 my $next_delete = 0;
1636 my $inserted = @{$insertedRef}[$next_insert++];
1637 my $deleted = @{$deletedRef}[$next_delete++];
1639 foreach my $old_line (@{$linesRef}) {
1641 my $line = $old_line; #don't modify the array
1642 if ($line =~ /^(?:\+\+\+\|\-\-\-)\s+\S+/) { #new filename
1644 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1645 $range_last_linenr = $new_linenr;
1646 fixup_current_range(\$line, $delta_offset, 0);
1649 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1650 $deleted = @{$deletedRef}[$next_delete++];
1652 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1655 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1656 push(@lines, ${$inserted}{'LINE'});
1657 $inserted = @{$insertedRef}[$next_insert++];
1659 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1663 push(@lines, $line);
1673 sub fix_insert_line {
1674 my ($linenr, $line) = @_;
1680 push(@fixed_inserted, $inserted);
1683 sub fix_delete_line {
1684 my ($linenr, $line) = @_;
1691 push(@fixed_deleted, $deleted);
1695 my ($type, $msg) = @_;
1697 if (report("ERROR", $type, $msg)) {
1705 my ($type, $msg) = @_;
1707 if (report("WARNING", $type, $msg)) {
1715 my ($type, $msg) = @_;
1717 if ($check && report("CHECK", $type, $msg)) {
1725 sub check_absolute_file {
1726 my ($absolute, $herecurr) = @_;
1727 my $file = $absolute;
1729 ##print "absolute<$absolute>\n";
1731 # See if any suffix of this path is a path within the tree.
1732 while ($file =~ s@^[^/]*/@@) {
1733 if (-f "$root/$file") {
1734 ##print "file<$file>\n";
1742 # It is, so see if the prefix is acceptable.
1743 my $prefix = $absolute;
1744 substr($prefix, -length($file)) = '';
1746 ##print "prefix<$prefix>\n";
1747 if ($prefix ne ".../") {
1748 WARN("USE_RELATIVE_PATH",
1749 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1756 $string =~ s/^\s+|\s+$//g;
1764 $string =~ s/^\s+//;
1772 $string =~ s/\s+$//;
1777 sub string_find_replace {
1778 my ($string, $find, $replace) = @_;
1780 $string =~ s/$find/$replace/g;
1788 my $source_indent = 8;
1789 my $max_spaces_before_tab = $source_indent - 1;
1790 my $spaces_to_tab = " " x $source_indent;
1792 #convert leading spaces to tabs
1793 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1794 #Remove spaces before a tab
1795 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1800 sub pos_last_openparen {
1805 my $opens = $line =~ tr/\(/\(/;
1806 my $closes = $line =~ tr/\)/\)/;
1808 my $last_openparen = 0;
1810 if (($opens == 0) || ($closes >= $opens)) {
1814 my $len = length($line);
1816 for ($pos = 0; $pos < $len; $pos++) {
1817 my $string = substr($line, $pos);
1818 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1819 $pos += length($1) - 1;
1820 } elsif (substr($line, $pos, 1) eq '(') {
1821 $last_openparen = $pos;
1822 } elsif (index($string, '(') == -1) {
1827 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
1831 my $filename = shift;
1837 my $stashrawline="";
1848 my $in_header_lines = $file ? 0 : 1;
1849 my $in_commit_log = 0; #Scanning lines before patch
1850 my $reported_maintainer_file = 0;
1851 my $non_utf8_charset = 0;
1853 my $last_blank_line = 0;
1854 my $last_coalesced_string_linenr = -1;
1862 # Trace the real file/line as we go.
1868 my $comment_edge = 0;
1872 my $prev_values = 'E';
1875 my %suppress_ifbraces;
1876 my %suppress_whiletrailers;
1877 my %suppress_export;
1878 my $suppress_statement = 0;
1880 my %signatures = ();
1882 # Pre-scan the patch sanitizing the lines.
1883 # Pre-scan the patch looking for any __setup documentation.
1885 my @setup_docs = ();
1888 my $camelcase_file_seeded = 0;
1890 sanitise_line_reset();
1892 foreach my $rawline (@rawlines) {
1896 push(@fixed, $rawline) if ($fix);
1898 if ($rawline=~/^\+\+\+\s+(\S+)/) {
1900 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1905 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1914 # Guestimate if this is a continuing comment. Run
1915 # the context looking for a comment "edge". If this
1916 # edge is a close comment then we must be in a comment
1920 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1921 next if (defined $rawlines[$ln - 1] &&
1922 $rawlines[$ln - 1] =~ /^-/);
1924 #print "RAW<$rawlines[$ln - 1]>\n";
1925 last if (!defined $rawlines[$ln - 1]);
1926 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1927 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1932 if (defined $edge && $edge eq '*/') {
1936 # Guestimate if this is a continuing comment. If this
1937 # is the start of a diff block and this line starts
1938 # ' *' then it is very likely a comment.
1939 if (!defined $edge &&
1940 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1945 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1946 sanitise_line_reset($in_comment);
1948 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1949 # Standardise the strings and chars within the input to
1950 # simplify matching -- only bother with positive lines.
1951 $line = sanitise_line($rawline);
1953 push(@lines, $line);
1956 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1961 #print "==>$rawline\n";
1962 #print "-->$line\n";
1964 if ($setup_docs && $line =~ /^\+/) {
1965 push(@setup_docs, $line);
1974 foreach my $line (@lines) {
1977 my $sline = $line; #copy of $line
1978 $sline =~ s/$;/ /g; #with comments as spaces
1980 my $rawline = $rawlines[$linenr - 1];
1982 #extract the line range in the file after the patch is applied
1983 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1985 $first_line = $linenr + 1;
1995 %suppress_ifbraces = ();
1996 %suppress_whiletrailers = ();
1997 %suppress_export = ();
1998 $suppress_statement = 0;
2001 # track the line number as we move through the hunk, note that
2002 # new versions of GNU diff omit the leading space on completely
2003 # blank context lines so we need to count that too.
2004 } elsif ($line =~ /^( |\+|$)/) {
2006 $realcnt-- if ($realcnt != 0);
2008 # Measure the line length and indent.
2009 ($length, $indent) = line_stats($rawline);
2011 # Track the previous line.
2012 ($prevline, $stashline) = ($stashline, $line);
2013 ($previndent, $stashindent) = ($stashindent, $indent);
2014 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2016 #warn "line<$line>\n";
2018 } elsif ($realcnt == 1) {
2022 my $hunk_line = ($realcnt != 0);
2024 #make up the handle for any error we report on this line
2025 $prefix = "$filename:$realline: " if ($emacs && $file);
2026 $prefix = "$filename:$linenr: " if ($emacs && !$file);
2028 $here = "#$linenr: " if (!$file);
2029 $here = "#$realline: " if ($file);
2032 # extract the filename as it passes
2033 if ($line =~ /^diff --git.*?(\S+)$/) {
2035 $realfile =~ s@^([^/]*)/@@ if (!$file);
2038 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2040 $realfile =~ s@^([^/]*)/@@ if (!$file);
2044 if (!$file && $tree && $p1_prefix ne '' &&
2045 -e "$root/$p1_prefix") {
2046 WARN("PATCH_PREFIX",
2047 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
2050 if ($realfile =~ m@^include/asm/@) {
2051 ERROR("MODIFIED_INCLUDE_ASM",
2052 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2058 if ($realfile =~ m@^(drivers/net/|net/)@) {
2061 $check = $check_orig;
2066 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
2068 my $hereline = "$here\n$rawline\n";
2069 my $herecurr = "$here\n$rawline\n";
2070 my $hereprev = "$here\n$prevrawline\n$rawline\n";
2072 $cnt_lines++ if ($realcnt != 0);
2074 # Check for incorrect file permissions
2075 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2076 my $permhere = $here . "FILE: $realfile\n";
2077 if ($realfile !~ m@scripts/@ &&
2078 $realfile !~ /\.(py|pl|awk|sh)$/) {
2079 ERROR("EXECUTE_PERMISSIONS",
2080 "do not set execute permissions for source files\n" . $permhere);
2084 # Check the patch for a signoff:
2085 if ($line =~ /^\s*signed-off-by:/i) {
2090 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2091 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2092 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2093 $reported_maintainer_file = 1;
2096 # Check signature styles
2097 if (!$in_header_lines &&
2098 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
2099 my $space_before = $1;
2101 my $space_after = $3;
2103 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2105 if ($sign_off !~ /$signature_tags/) {
2106 WARN("BAD_SIGN_OFF",
2107 "Non-standard signature: $sign_off\n" . $herecurr);
2109 if (defined $space_before && $space_before ne "") {
2110 if (WARN("BAD_SIGN_OFF",
2111 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2113 $fixed[$fixlinenr] =
2114 "$ucfirst_sign_off $email";
2117 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
2118 if (WARN("BAD_SIGN_OFF",
2119 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2121 $fixed[$fixlinenr] =
2122 "$ucfirst_sign_off $email";
2126 if (!defined $space_after || $space_after ne " ") {
2127 if (WARN("BAD_SIGN_OFF",
2128 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2130 $fixed[$fixlinenr] =
2131 "$ucfirst_sign_off $email";
2135 my ($email_name, $email_address, $comment) = parse_email($email);
2136 my $suggested_email = format_email(($email_name, $email_address));
2137 if ($suggested_email eq "") {
2138 ERROR("BAD_SIGN_OFF",
2139 "Unrecognized email address: '$email'\n" . $herecurr);
2141 my $dequoted = $suggested_email;
2142 $dequoted =~ s/^"//;
2143 $dequoted =~ s/" </ </;
2144 # Don't force email to have quotes
2145 # Allow just an angle bracketed address
2146 if ("$dequoted$comment" ne $email &&
2147 "<$email_address>$comment" ne $email &&
2148 "$suggested_email$comment" ne $email) {
2149 WARN("BAD_SIGN_OFF",
2150 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
2154 # Check for duplicate signatures
2155 my $sig_nospace = $line;
2156 $sig_nospace =~ s/\s//g;
2157 $sig_nospace = lc($sig_nospace);
2158 if (defined $signatures{$sig_nospace}) {
2159 WARN("BAD_SIGN_OFF",
2160 "Duplicate signature\n" . $herecurr);
2162 $signatures{$sig_nospace} = 1;
2166 # Check for old stable address
2167 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2168 ERROR("STABLE_ADDRESS",
2169 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2172 # Check for unwanted Gerrit info
2173 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2174 ERROR("GERRIT_CHANGE_ID",
2175 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2178 # Check for git id commit length and improperly formed commit descriptions
2179 if ($in_commit_log && $line =~ /\b(c)ommit\s+([0-9a-f]{5,})/i) {
2181 my $orig_commit = lc($2);
2187 my $id = '0123456789ab';
2188 my $orig_desc = "commit description";
2189 my $description = "";
2191 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2192 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2193 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2194 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2195 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2197 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2198 defined $rawlines[$linenr] &&
2199 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2201 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2202 defined $rawlines[$linenr] &&
2203 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2204 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2206 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2207 $orig_desc .= " " . $1;
2210 ($id, $description) = git_commit_info($orig_commit,
2213 if ($short || $long || $space || $case || ($orig_desc ne $description)) {
2214 ERROR("GIT_COMMIT_ID",
2215 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2219 # Check for added, moved or deleted files
2220 if (!$reported_maintainer_file && !$in_commit_log &&
2221 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2222 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2223 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2224 (defined($1) || defined($2))))) {
2225 $reported_maintainer_file = 1;
2226 WARN("FILE_PATH_CHANGES",
2227 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2230 # Check for wrappage within a valid hunk of the file
2231 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
2232 ERROR("CORRUPTED_PATCH",
2233 "patch seems to be corrupt (line wrapped?)\n" .
2234 $herecurr) if (!$emitted_corrupt++);
2237 # Check for absolute kernel paths.
2239 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2242 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2243 check_absolute_file($1, $herecurr)) {
2246 check_absolute_file($file, $herecurr);
2251 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2252 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
2253 $rawline !~ m/^$UTF8*$/) {
2254 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2256 my $blank = copy_spacing($rawline);
2257 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2258 my $hereptr = "$hereline$ptr\n";
2261 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
2264 # Check if it's the start of a commit log
2265 # (not a header line and we haven't seen the patch filename)
2266 if ($in_header_lines && $realfile =~ /^$/ &&
2267 !($rawline =~ /^\s+\S/ ||
2268 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
2269 $in_header_lines = 0;
2273 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2274 # declined it, i.e defined some charset where it is missing.
2275 if ($in_header_lines &&
2276 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2278 $non_utf8_charset = 1;
2281 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
2282 $rawline =~ /$NON_ASCII_UTF8/) {
2283 WARN("UTF8_BEFORE_PATCH",
2284 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2287 # Check for various typo / spelling mistakes
2288 if (defined($misspellings) && ($in_commit_log || $line =~ /^\+/)) {
2289 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:$|[^a-z@])/gi) {
2291 my $typo_fix = $spelling_fix{lc($typo)};
2292 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2293 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2294 my $msg_type = \&WARN;
2295 $msg_type = \&CHK if ($file);
2296 if (&{$msg_type}("TYPO_SPELLING",
2297 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2299 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2304 # ignore non-hunk lines and lines being removed
2305 next if (!$hunk_line || $line =~ /^-/);
2307 #trailing whitespace
2308 if ($line =~ /^\+.*\015/) {
2309 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2310 if (ERROR("DOS_LINE_ENDINGS",
2311 "DOS line endings\n" . $herevet) &&
2313 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
2315 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2316 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2317 if (ERROR("TRAILING_WHITESPACE",
2318 "trailing whitespace\n" . $herevet) &&
2320 $fixed[$fixlinenr] =~ s/\s+$//;
2326 # Check for FSF mailing addresses.
2327 if ($rawline =~ /\bwrite to the Free/i ||
2328 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2329 $rawline =~ /\b51\s+Franklin\s+St/i) {
2330 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2331 my $msg_type = \&ERROR;
2332 $msg_type = \&CHK if ($file);
2333 &{$msg_type}("FSF_MAILING_ADDRESS",
2334 "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)
2337 # check for Kconfig help text having a real description
2338 # Only applies when adding the entry originally, after that we do not have
2339 # sufficient context to determine whether it is indeed long enough.
2340 if ($realfile =~ /Kconfig/ &&
2341 $line =~ /^\+\s*config\s+/) {
2344 my $ln = $linenr + 1;
2348 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
2349 $f = $lines[$ln - 1];
2350 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2351 $is_end = $lines[$ln - 1] =~ /^\+/;
2353 next if ($f =~ /^-/);
2354 last if (!$file && $f =~ /^\@\@/);
2356 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
2358 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
2365 next if ($f =~ /^$/);
2366 if ($f =~ /^\s*config\s/) {
2372 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2373 WARN("CONFIG_DESCRIPTION",
2374 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2376 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2379 # discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2380 if ($realfile =~ /Kconfig/ &&
2381 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2382 WARN("CONFIG_EXPERIMENTAL",
2383 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2386 # discourage the use of boolean for type definition attributes of Kconfig options
2387 if ($realfile =~ /Kconfig/ &&
2388 $line =~ /^\+\s*\bboolean\b/) {
2389 WARN("CONFIG_TYPE_BOOLEAN",
2390 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2393 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2394 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2397 'EXTRA_AFLAGS' => 'asflags-y',
2398 'EXTRA_CFLAGS' => 'ccflags-y',
2399 'EXTRA_CPPFLAGS' => 'cppflags-y',
2400 'EXTRA_LDFLAGS' => 'ldflags-y',
2403 WARN("DEPRECATED_VARIABLE",
2404 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2407 # check for DT compatible documentation
2408 if (defined $root &&
2409 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2410 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2412 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2414 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2415 my $vp_file = $dt_path . "vendor-prefixes.txt";
2417 foreach my $compat (@compats) {
2418 my $compat2 = $compat;
2419 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2420 my $compat3 = $compat;
2421 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2422 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
2424 WARN("UNDOCUMENTED_DT_STRING",
2425 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2428 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2430 `grep -Eq "^$vendor\\b" $vp_file`;
2432 WARN("UNDOCUMENTED_DT_STRING",
2433 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2438 # check we are in a valid source file if not then ignore this hunk
2439 next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/);
2442 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
2443 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
2444 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
2445 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
2446 $length > $max_line_length)
2449 "line over $max_line_length characters\n" . $herecurr);
2452 # check for adding lines without a newline.
2453 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2454 WARN("MISSING_EOF_NEWLINE",
2455 "adding a line without newline at end of file\n" . $herecurr);
2458 # Blackfin: use hi/lo macros
2459 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2460 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2461 my $herevet = "$here\n" . cat_vet($line) . "\n";
2463 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
2465 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2466 my $herevet = "$here\n" . cat_vet($line) . "\n";
2468 "use the HI() macro, not (... >> 16)\n" . $herevet);
2472 # check we are in a valid source file C or perl if not then ignore this hunk
2473 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
2475 # at the beginning of a line any tabs must come first and anything
2476 # more than 8 must use tabs.
2477 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2478 $rawline =~ /^\+\s* \s*/) {
2479 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2481 if (ERROR("CODE_INDENT",
2482 "code indent should use tabs where possible\n" . $herevet) &&
2484 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2488 # check for space before tabs.
2489 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2490 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2491 if (WARN("SPACE_BEFORE_TAB",
2492 "please, no space before tabs\n" . $herevet) &&
2494 while ($fixed[$fixlinenr] =~
2495 s/(^\+.*) {8,8}\t/$1\t\t/) {}
2496 while ($fixed[$fixlinenr] =~
2497 s/(^\+.*) +\t/$1\t/) {}
2501 # check for && or || at the start of a line
2502 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2503 CHK("LOGICAL_CONTINUATIONS",
2504 "Logical continuations should be on the previous line\n" . $hereprev);
2507 # check multi-line statement indentation matches previous line
2508 if ($^V && $^V ge 5.10.0 &&
2509 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2510 $prevline =~ /^\+(\t*)(.*)$/;
2514 my $pos = pos_last_openparen($rest);
2516 $line =~ /^(\+| )([ \t]*)/;
2519 my $goodtabindent = $oldindent .
2522 my $goodspaceindent = $oldindent . " " x $pos;
2524 if ($newindent ne $goodtabindent &&
2525 $newindent ne $goodspaceindent) {
2527 if (CHK("PARENTHESIS_ALIGNMENT",
2528 "Alignment should match open parenthesis\n" . $hereprev) &&
2529 $fix && $line =~ /^\+/) {
2530 $fixed[$fixlinenr] =~
2531 s/^\+[ \t]*/\+$goodtabindent/;
2537 if ($line =~ /^\+.*(\w+\s*)?\(\s*$Type\s*\)[ \t]+(?!$Assignment|$Arithmetic|[,;\({\[\<\>])/ &&
2538 (!defined($1) || $1 !~ /sizeof\s*/)) {
2540 "No space is necessary after a cast\n" . $herecurr) &&
2542 $fixed[$fixlinenr] =~
2543 s/(\(\s*$Type\s*\))[ \t]+/$1/;
2547 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2548 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
2549 $rawline =~ /^\+[ \t]*\*/ &&
2551 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2552 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2555 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2556 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2557 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
2558 $rawline =~ /^\+/ && #line is new
2559 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2560 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2561 "networking block comments start with * on subsequent lines\n" . $hereprev);
2564 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2565 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2566 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2567 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2568 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
2569 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2570 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2573 # check for missing blank lines after struct/union declarations
2574 # with exceptions for various attributes and macros
2575 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2577 !($line =~ /^\+\s*$/ ||
2578 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2579 $line =~ /^\+\s*MODULE_/i ||
2580 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2581 $line =~ /^\+[a-z_]*init/ ||
2582 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2583 $line =~ /^\+\s*DECLARE/ ||
2584 $line =~ /^\+\s*__setup/)) {
2585 if (CHK("LINE_SPACING",
2586 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
2588 fix_insert_line($fixlinenr, "\+");
2592 # check for multiple consecutive blank lines
2593 if ($prevline =~ /^[\+ ]\s*$/ &&
2594 $line =~ /^\+\s*$/ &&
2595 $last_blank_line != ($linenr - 1)) {
2596 if (CHK("LINE_SPACING",
2597 "Please don't use multiple blank lines\n" . $hereprev) &&
2599 fix_delete_line($fixlinenr, $rawline);
2602 $last_blank_line = $linenr;
2605 # check for missing blank lines after declarations
2606 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2607 # actual declarations
2608 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2609 # function pointer declarations
2610 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2611 # foo bar; where foo is some local typedef or #define
2612 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2613 # known declaration macros
2614 $prevline =~ /^\+\s+$declaration_macros/) &&
2615 # for "else if" which can look like "$Ident $Ident"
2616 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2617 # other possible extensions of declaration lines
2618 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2619 # not starting a section or a macro "\" extended line
2620 $prevline =~ /(?:\{\s*|\\)$/) &&
2621 # looks like a declaration
2622 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2623 # function pointer declarations
2624 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2625 # foo bar; where foo is some local typedef or #define
2626 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2627 # known declaration macros
2628 $sline =~ /^\+\s+$declaration_macros/ ||
2629 # start of struct or union or enum
2630 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
2631 # start or end of block or continuation of declaration
2632 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
2633 # bitfield continuation
2634 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
2635 # other possible extensions of declaration lines
2636 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
2637 # indentation of previous and current line are the same
2638 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
2639 if (WARN("LINE_SPACING",
2640 "Missing a blank line after declarations\n" . $hereprev) &&
2642 fix_insert_line($fixlinenr, "\+");
2646 # check for spaces at the beginning of a line.
2648 # 1) within comments
2649 # 2) indented preprocessor commands
2651 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
2652 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2653 if (WARN("LEADING_SPACE",
2654 "please, no spaces at the start of a line\n" . $herevet) &&
2656 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2660 # check we are in a valid C source file if not then ignore this hunk
2661 next if ($realfile !~ /\.(h|c)$/);
2663 # check indentation of any line with a bare else
2664 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
2665 # if the previous line is a break or return and is indented 1 tab more...
2666 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
2667 my $tabs = length($1) + 1;
2668 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
2669 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
2670 defined $lines[$linenr] &&
2671 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
2672 WARN("UNNECESSARY_ELSE",
2673 "else is not generally useful after a break or return\n" . $hereprev);
2677 # check indentation of a line with a break;
2678 # if the previous line is a goto or return and is indented the same # of tabs
2679 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
2681 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
2682 WARN("UNNECESSARY_BREAK",
2683 "break is not useful after a goto or return\n" . $hereprev);
2687 # discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2688 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2689 WARN("CONFIG_EXPERIMENTAL",
2690 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2693 # check for RCS/CVS revision markers
2694 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
2696 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
2699 # Blackfin: don't use __builtin_bfin_[cs]sync
2700 if ($line =~ /__builtin_bfin_csync/) {
2701 my $herevet = "$here\n" . cat_vet($line) . "\n";
2703 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
2705 if ($line =~ /__builtin_bfin_ssync/) {
2706 my $herevet = "$here\n" . cat_vet($line) . "\n";
2708 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
2711 # check for old HOTPLUG __dev<foo> section markings
2712 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2713 WARN("HOTPLUG_SECTION",
2714 "Using $1 is unnecessary\n" . $herecurr);
2717 # Check for potential 'bare' types
2718 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2720 #print "LINE<$line>\n";
2721 if ($linenr >= $suppress_statement &&
2722 $realcnt && $sline =~ /.\s*\S/) {
2723 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2724 ctx_statement_block($linenr, $realcnt, 0);
2725 $stat =~ s/\n./\n /g;
2726 $cond =~ s/\n./\n /g;
2728 #print "linenr<$linenr> <$stat>\n";
2729 # If this statement has no statement boundaries within
2730 # it there is no point in retrying a statement scan
2731 # until we hit end of it.
2732 my $frag = $stat; $frag =~ s/;+\s*$//;
2733 if ($frag !~ /(?:{|;)/) {
2734 #print "skip<$line_nr_next>\n";
2735 $suppress_statement = $line_nr_next;
2738 # Find the real next line.
2739 $realline_next = $line_nr_next;
2740 if (defined $realline_next &&
2741 (!defined $lines[$realline_next - 1] ||
2742 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2749 # Ignore goto labels.
2750 if ($s =~ /$Ident:\*$/s) {
2752 # Ignore functions being called
2753 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
2755 } elsif ($s =~ /^.\s*else\b/s) {
2757 # declarations always start with types
2758 } 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) {
2761 possible($type, "A:" . $s);
2763 # definitions in global scope can only start with types
2764 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
2765 possible($1, "B:" . $s);
2768 # any (foo ... *) is a pointer cast, and foo is a type
2769 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
2770 possible($1, "C:" . $s);
2773 # Check for any sort of function declaration.
2774 # int foo(something bar, other baz);
2775 # void (*store_gdt)(x86_descr_ptr *);
2776 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
2777 my ($name_len) = length($1);
2780 substr($ctx, 0, $name_len + 1, '');
2781 $ctx =~ s/\)[^\)]*$//;
2783 for my $arg (split(/\s*,\s*/, $ctx)) {
2784 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
2786 possible($1, "D:" . $s);
2794 # Checks which may be anchored in the context.
2797 # Check for switch () and associated case and default
2798 # statements should be at the same indent.
2799 if ($line=~/\bswitch\s*\(.*\)/) {
2802 my @ctx = ctx_block_outer($linenr, $realcnt);
2804 for my $ctx (@ctx) {
2805 my ($clen, $cindent) = line_stats($ctx);
2806 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2807 $indent != $cindent) {
2808 $err .= "$sep$ctx\n";
2815 ERROR("SWITCH_CASE_INDENT_LEVEL",
2816 "switch and case should be at the same indent\n$hereline$err");
2820 # if/while/etc brace do not go on next line, unless defining a do while loop,
2821 # or if that brace on the next line is for something else
2822 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
2823 my $pre_ctx = "$1$2";
2825 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
2827 if ($line =~ /^\+\t{6,}/) {
2828 WARN("DEEP_INDENTATION",
2829 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2832 my $ctx_cnt = $realcnt - $#ctx - 1;
2833 my $ctx = join("\n", @ctx);
2835 my $ctx_ln = $linenr;
2836 my $ctx_skip = $realcnt;
2838 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2839 defined $lines[$ctx_ln - 1] &&
2840 $lines[$ctx_ln - 1] =~ /^-/)) {
2841 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2842 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
2846 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2847 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
2849 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
2851 "that open brace { should be on the previous line\n" .
2852 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2854 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2855 $ctx =~ /\)\s*\;\s*$/ &&
2856 defined $lines[$ctx_ln - 1])
2858 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2859 if ($nindent > $indent) {
2860 WARN("TRAILING_SEMICOLON",
2861 "trailing semicolon indicates no statements, indent implies otherwise\n" .
2862 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2867 # Check relative indent for conditionals and blocks.
2868 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2869 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2870 ctx_statement_block($linenr, $realcnt, 0)
2871 if (!defined $stat);
2872 my ($s, $c) = ($stat, $cond);
2874 substr($s, 0, length($c), '');
2876 # Make sure we remove the line prefixes as we have
2877 # none on the first line, and are going to readd them
2881 # Find out how long the conditional actually is.
2882 my @newlines = ($c =~ /\n/gs);
2883 my $cond_lines = 1 + $#newlines;
2885 # We want to check the first line inside the block
2886 # starting at the end of the conditional, so remove:
2887 # 1) any blank line termination
2888 # 2) any opening brace { on end of the line
2890 my $continuation = 0;
2892 $s =~ s/^.*\bdo\b//;
2894 if ($s =~ s/^\s*\\//) {
2897 if ($s =~ s/^\s*?\n//) {
2902 # Also ignore a loop construct at the end of a
2903 # preprocessor statement.
2904 if (($prevline =~ /^.\s*#\s*define\s/ ||
2905 $prevline =~ /\\\s*$/) && $continuation == 0) {
2911 while ($cond_ptr != $cond_lines) {
2912 $cond_ptr = $cond_lines;
2914 # If we see an #else/#elif then the code
2916 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2921 # 1) blank lines, they should be at 0,
2922 # 2) preprocessor lines, and
2924 if ($continuation ||
2926 $s =~ /^\s*#\s*?/ ||
2927 $s =~ /^\s*$Ident\s*:/) {
2928 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
2929 if ($s =~ s/^.*?\n//) {
2935 my (undef, $sindent) = line_stats("+" . $s);
2936 my $stat_real = raw_line($linenr, $cond_lines);
2938 # Check if either of these lines are modified, else
2939 # this is not this patch's fault.
2940 if (!defined($stat_real) ||
2941 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2944 if (defined($stat_real) && $cond_lines > 1) {
2945 $stat_real = "[...]\n$stat_real";
2948 #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";
2950 if ($check && (($sindent % 8) != 0 ||
2951 ($sindent <= $indent && $s ne ''))) {
2952 WARN("SUSPECT_CODE_INDENT",
2953 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
2957 # Track the 'values' across context and added lines.
2958 my $opline = $line; $opline =~ s/^./ /;
2959 my ($curr_values, $curr_vars) =
2960 annotate_values($opline . "\n", $prev_values);
2961 $curr_values = $prev_values . $curr_values;
2963 my $outline = $opline; $outline =~ s/\t/ /g;
2964 print "$linenr > .$outline\n";
2965 print "$linenr > $curr_values\n";
2966 print "$linenr > $curr_vars\n";
2968 $prev_values = substr($curr_values, -1);
2970 #ignore lines not being added
2971 next if ($line =~ /^[^\+]/);
2973 # TEST: allow direct testing of the type matcher.
2975 if ($line =~ /^.\s*$Declare\s*$/) {
2977 "TEST: is type\n" . $herecurr);
2978 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
2979 ERROR("TEST_NOT_TYPE",
2980 "TEST: is not type ($1 is)\n". $herecurr);
2984 # TEST: allow direct testing of the attribute matcher.
2986 if ($line =~ /^.\s*$Modifier\s*$/) {
2988 "TEST: is attr\n" . $herecurr);
2989 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
2990 ERROR("TEST_NOT_ATTR",
2991 "TEST: is not attr ($1 is)\n". $herecurr);
2996 # check for initialisation to aggregates open brace on the next line
2997 if ($line =~ /^.\s*{/ &&
2998 $prevline =~ /(?:^|[^=])=\s*$/) {
2999 if (ERROR("OPEN_BRACE",
3000 "that open brace { should be on the previous line\n" . $hereprev) &&
3001 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3002 fix_delete_line($fixlinenr - 1, $prevrawline);
3003 fix_delete_line($fixlinenr, $rawline);
3004 my $fixedline = $prevrawline;
3005 $fixedline =~ s/\s*=\s*$/ = {/;
3006 fix_insert_line($fixlinenr, $fixedline);
3008 $fixedline =~ s/^(.\s*){\s*/$1/;
3009 fix_insert_line($fixlinenr, $fixedline);
3014 # Checks which are anchored on the added line.
3017 # check for malformed paths in #include statements (uses RAW line)
3018 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
3020 if ($path =~ m{//}) {
3021 ERROR("MALFORMED_INCLUDE",
3022 "malformed #include filename\n" . $herecurr);
3024 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3025 ERROR("UAPI_INCLUDE",
3026 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
3030 # no C99 // comments
3031 if ($line =~ m{//}) {
3032 if (ERROR("C99_COMMENTS",
3033 "do not use C99 // comments\n" . $herecurr) &&
3035 my $line = $fixed[$fixlinenr];
3036 if ($line =~ /\/\/(.*)$/) {
3037 my $comment = trim($1);
3038 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
3042 # Remove C99 comments.
3044 $opline =~ s@//.*@@;
3046 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3047 # the whole statement.
3048 #print "APW <$lines[$realline_next - 1]>\n";
3049 if (defined $realline_next &&
3050 exists $lines[$realline_next - 1] &&
3051 !defined $suppress_export{$realline_next} &&
3052 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3053 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3054 # Handle definitions which produce identifiers with
3057 # EXPORT_SYMBOL(something_foo);
3059 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
3060 $name =~ /^${Ident}_$2/) {
3061 #print "FOO C name<$name>\n";
3062 $suppress_export{$realline_next} = 1;
3064 } elsif ($stat !~ /(?:
3066 ^.DEFINE_$Ident\(\Q$name\E\)|
3067 ^.DECLARE_$Ident\(\Q$name\E\)|
3068 ^.LIST_HEAD\(\Q$name\E\)|
3069 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3070 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
3072 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3073 $suppress_export{$realline_next} = 2;
3075 $suppress_export{$realline_next} = 1;
3078 if (!defined $suppress_export{$linenr} &&
3079 $prevline =~ /^.\s*$/ &&
3080 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3081 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3082 #print "FOO B <$lines[$linenr - 1]>\n";
3083 $suppress_export{$linenr} = 2;
3085 if (defined $suppress_export{$linenr} &&
3086 $suppress_export{$linenr} == 2) {
3087 WARN("EXPORT_SYMBOL",
3088 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
3091 # check for global initialisers.
3092 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
3093 if (ERROR("GLOBAL_INITIALISERS",
3094 "do not initialise globals to 0 or NULL\n" .
3097 $fixed[$fixlinenr] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
3100 # check for static initialisers.
3101 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
3102 if (ERROR("INITIALISED_STATIC",
3103 "do not initialise statics to 0 or NULL\n" .
3106 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
3110 # check for misordered declarations of char/short/int/long with signed/unsigned
3111 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3113 WARN("MISORDERED_TYPE",
3114 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3117 # check for static const char * arrays.
3118 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
3119 WARN("STATIC_CONST_CHAR_ARRAY",
3120 "static const char * array should probably be static const char * const\n" .
3124 # check for static char foo[] = "bar" declarations.
3125 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
3126 WARN("STATIC_CONST_CHAR_ARRAY",
3127 "static char array declaration should probably be static const char\n" .
3131 # check for non-global char *foo[] = {"bar", ...} declarations.
3132 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3133 WARN("STATIC_CONST_CHAR_ARRAY",
3134 "char * array declaration might be better as static const\n" .
3138 # check for function declarations without arguments like "int foo()"
3139 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3140 if (ERROR("FUNCTION_WITHOUT_ARGS",
3141 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3143 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
3147 # check for uses of DEFINE_PCI_DEVICE_TABLE
3148 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
3149 if (WARN("DEFINE_PCI_DEVICE_TABLE",
3150 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
3152 $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
3156 # check for new typedefs, only function parameters and sparse annotations
3158 if ($line =~ /\btypedef\s/ &&
3159 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
3160 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
3161 $line !~ /\b$typeTypedefs\b/ &&
3162 $line !~ /\b__bitwise(?:__|)\b/) {
3163 WARN("NEW_TYPEDEFS",
3164 "do not add new typedefs\n" . $herecurr);
3167 # * goes on variable not on type
3169 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3171 my ($ident, $from, $to) = ($1, $2, $2);
3173 # Should start with a space.
3174 $to =~ s/^(\S)/ $1/;
3175 # Should not end with a space.
3177 # '*'s should not have spaces between.
3178 while ($to =~ s/\*\s+\*/\*\*/) {
3181 ## print "1: from<$from> to<$to> ident<$ident>\n";
3183 if (ERROR("POINTER_LOCATION",
3184 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3186 my $sub_from = $ident;
3187 my $sub_to = $ident;
3188 $sub_to =~ s/\Q$from\E/$to/;
3189 $fixed[$fixlinenr] =~
3190 s@\Q$sub_from\E@$sub_to@;
3194 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3196 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
3198 # Should start with a space.
3199 $to =~ s/^(\S)/ $1/;
3200 # Should not end with a space.
3202 # '*'s should not have spaces between.
3203 while ($to =~ s/\*\s+\*/\*\*/) {
3205 # Modifiers should have spaces.
3206 $to =~ s/(\b$Modifier$)/$1 /;
3208 ## print "2: from<$from> to<$to> ident<$ident>\n";
3209 if ($from ne $to && $ident !~ /^$Modifier$/) {
3210 if (ERROR("POINTER_LOCATION",
3211 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3214 my $sub_from = $match;
3215 my $sub_to = $match;
3216 $sub_to =~ s/\Q$from\E/$to/;
3217 $fixed[$fixlinenr] =~
3218 s@\Q$sub_from\E@$sub_to@;
3223 # # no BUG() or BUG_ON()
3224 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
3225 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
3226 # print "$herecurr";
3230 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
3231 WARN("LINUX_VERSION_CODE",
3232 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3235 # check for uses of printk_ratelimit
3236 if ($line =~ /\bprintk_ratelimit\s*\(/) {
3237 WARN("PRINTK_RATELIMITED",
3238 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
3241 # printk should use KERN_* levels. Note that follow on printk's on the
3242 # same line do not need a level, so we use the current block context
3243 # to try and find and validate the current printk. In summary the current
3244 # printk includes all preceding printk's which have no newline on the end.
3245 # we assume the first bad printk is the one to report.
3246 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
3248 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3249 #print "CHECK<$lines[$ln - 1]\n";
3250 # we have a preceding printk if it ends
3251 # with "\n" ignore it, else it is to blame
3252 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3253 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3260 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3261 "printk() should include KERN_ facility level\n" . $herecurr);
3265 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3267 my $level = lc($orig);
3268 $level = "warn" if ($level eq "warning");
3269 my $level2 = $level;
3270 $level2 = "dbg" if ($level eq "debug");
3271 WARN("PREFER_PR_LEVEL",
3272 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
3275 if ($line =~ /\bpr_warning\s*\(/) {
3276 if (WARN("PREFER_PR_LEVEL",
3277 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3279 $fixed[$fixlinenr] =~
3280 s/\bpr_warning\b/pr_warn/;
3284 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3286 my $level = lc($orig);
3287 $level = "warn" if ($level eq "warning");
3288 $level = "dbg" if ($level eq "debug");
3289 WARN("PREFER_DEV_LEVEL",
3290 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3293 # function brace can't be on same line, except for #defines of do while,
3294 # or if closed on same line
3295 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
3296 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
3297 if (ERROR("OPEN_BRACE",
3298 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3300 fix_delete_line($fixlinenr, $rawline);
3301 my $fixed_line = $rawline;
3302 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3305 fix_insert_line($fixlinenr, ltrim($line1));
3306 fix_insert_line($fixlinenr, "\+{");
3307 if ($line2 !~ /^\s*$/) {
3308 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3313 # open braces for enum, union and struct go on the same line.
3314 if ($line =~ /^.\s*{/ &&
3315 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
3316 if (ERROR("OPEN_BRACE",
3317 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3318 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3319 fix_delete_line($fixlinenr - 1, $prevrawline);
3320 fix_delete_line($fixlinenr, $rawline);
3321 my $fixedline = rtrim($prevrawline) . " {";
3322 fix_insert_line($fixlinenr, $fixedline);
3323 $fixedline = $rawline;
3324 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3325 if ($fixedline !~ /^\+\s*$/) {
3326 fix_insert_line($fixlinenr, $fixedline);
3331 # missing space after union, struct or enum definition
3332 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3334 "missing space after $1 definition\n" . $herecurr) &&
3336 $fixed[$fixlinenr] =~
3337 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3341 # Function pointer declarations
3342 # check spacing between type, funcptr, and args
3343 # canonical declaration is "type (*funcptr)(args...)"
3344 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
3346 my $pre_pointer_space = $2;
3347 my $post_pointer_space = $3;
3349 my $post_funcname_space = $5;
3350 my $pre_args_space = $6;
3352 # the $Declare variable will capture all spaces after the type
3353 # so check it for a missing trailing missing space but pointer return types
3354 # don't need a space so don't warn for those.
3355 my $post_declare_space = "";
3356 if ($declare =~ /(\s+)$/) {
3357 $post_declare_space = $1;
3358 $declare = rtrim($declare);
3360 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
3362 "missing space after return type\n" . $herecurr);
3363 $post_declare_space = " ";
3366 # unnecessary space "type (*funcptr)(args...)"
3367 # This test is not currently implemented because these declarations are
3369 # int foo(int bar, ...)
3370 # and this is form shouldn't/doesn't generate a checkpatch warning.
3372 # elsif ($declare =~ /\s{2,}$/) {
3374 # "Multiple spaces after return type\n" . $herecurr);
3377 # unnecessary space "type ( *funcptr)(args...)"
3378 if (defined $pre_pointer_space &&
3379 $pre_pointer_space =~ /^\s/) {
3381 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3384 # unnecessary space "type (* funcptr)(args...)"
3385 if (defined $post_pointer_space &&
3386 $post_pointer_space =~ /^\s/) {
3388 "Unnecessary space before function pointer name\n" . $herecurr);
3391 # unnecessary space "type (*funcptr )(args...)"
3392 if (defined $post_funcname_space &&
3393 $post_funcname_space =~ /^\s/) {
3395 "Unnecessary space after function pointer name\n" . $herecurr);
3398 # unnecessary space "type (*funcptr) (args...)"
3399 if (defined $pre_args_space &&
3400 $pre_args_space =~ /^\s/) {
3402 "Unnecessary space before function pointer arguments\n" . $herecurr);
3405 if (show_type("SPACING") && $fix) {
3406 $fixed[$fixlinenr] =~
3407 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3411 # check for spacing round square brackets; allowed:
3412 # 1. with a type on the left -- int [] a;
3413 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3414 # 3. inside a curly brace -- = { [0...10] = 5 }
3415 while ($line =~ /(.*?\s)\[/g) {
3416 my ($where, $prefix) = ($-[1], $1);
3417 if ($prefix !~ /$Type\s+$/ &&
3418 ($where != 0 || $prefix !~ /^.\s+$/) &&
3419 $prefix !~ /[{,]\s+$/) {
3420 if (ERROR("BRACKET_SPACE",
3421 "space prohibited before open square bracket '['\n" . $herecurr) &&
3423 $fixed[$fixlinenr] =~
3424 s/^(\+.*?)\s+\[/$1\[/;
3429 # check for spaces between functions and their parentheses.
3430 while ($line =~ /($Ident)\s+\(/g) {
3432 my $ctx_before = substr($line, 0, $-[1]);
3433 my $ctx = "$ctx_before$name";
3435 # Ignore those directives where spaces _are_ permitted.
3437 if|for|while|switch|return|case|
3438 volatile|__volatile__|
3439 __attribute__|format|__extension__|
3442 # cpp #define statements have non-optional spaces, ie
3443 # if there is a space between the name and the open
3444 # parenthesis it is simply not a parameter group.
3445 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
3447 # cpp #elif statement condition may start with a (
3448 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
3450 # If this whole things ends with a type its most
3451 # likely a typedef for a function.
3452 } elsif ($ctx =~ /$Type$/) {
3456 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3458 $fixed[$fixlinenr] =~
3459 s/\b$name\s+\(/$name\(/;
3464 # Check operator spacing.
3465 if (!($line=~/\#\s*include/)) {
3466 my $fixed_line = "";
3470 <<=|>>=|<=|>=|==|!=|
3471 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3472 =>|->|<<|>>|<|>|=|!|~|
3473 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
3476 my @elements = split(/($ops|;)/, $opline);
3478 ## print("element count: <" . $#elements . ">\n");
3479 ## foreach my $el (@elements) {
3480 ## print("el: <$el>\n");
3483 my @fix_elements = ();
3486 foreach my $el (@elements) {
3487 push(@fix_elements, substr($rawline, $off, length($el)));
3488 $off += length($el);
3493 my $blank = copy_spacing($opline);
3494 my $last_after = -1;
3496 for (my $n = 0; $n < $#elements; $n += 2) {
3498 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3500 ## print("n: <$n> good: <$good>\n");
3502 $off += length($elements[$n]);
3504 # Pick up the preceding and succeeding characters.
3505 my $ca = substr($opline, 0, $off);
3507 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3508 $cc = substr($opline, $off + length($elements[$n + 1]));
3510 my $cb = "$ca$;$cc";
3513 $a = 'V' if ($elements[$n] ne '');
3514 $a = 'W' if ($elements[$n] =~ /\s$/);
3515 $a = 'C' if ($elements[$n] =~ /$;$/);
3516 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3517 $a = 'O' if ($elements[$n] eq '');
3518 $a = 'E' if ($ca =~ /^\s*$/);
3520 my $op = $elements[$n + 1];
3523 if (defined $elements[$n + 2]) {
3524 $c = 'V' if ($elements[$n + 2] ne '');
3525 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
3526 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
3527 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3528 $c = 'O' if ($elements[$n + 2] eq '');
3529 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
3534 my $ctx = "${a}x${c}";
3536 my $at = "(ctx:$ctx)";
3538 my $ptr = substr($blank, 0, $off) . "^";
3539 my $hereptr = "$hereline$ptr\n";
3541 # Pull out the value of this operator.
3542 my $op_type = substr($curr_values, $off + 1, 1);
3544 # Get the full operator variant.
3545 my $opv = $op . substr($curr_vars, $off, 1);
3547 # Ignore operators passed as parameters.
3548 if ($op_type ne 'V' &&
3549 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
3552 # } elsif ($op =~ /^$;+$/) {
3554 # ; should have either the end of line or a space or \ after it
3555 } elsif ($op eq ';') {
3556 if ($ctx !~ /.x[WEBC]/ &&
3557 $cc !~ /^\\/ && $cc !~ /^;/) {
3558 if (ERROR("SPACING",
3559 "space required after that '$op' $at\n" . $hereptr)) {
3560 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3566 } elsif ($op eq '//') {
3568 # : when part of a bitfield
3569 } elsif ($opv eq ':B') {
3570 # skip the bitfield test for now
3574 } elsif ($op eq '->') {
3575 if ($ctx =~ /Wx.|.xW/) {
3576 if (ERROR("SPACING",
3577 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
3578 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3579 if (defined $fix_elements[$n + 2]) {
3580 $fix_elements[$n + 2] =~ s/^\s+//;
3586 # , must not have a space before and must have a space on the right.
3587 } elsif ($op eq ',') {
3588 my $rtrim_before = 0;
3589 my $space_after = 0;
3590 if ($ctx =~ /Wx./) {
3591 if (ERROR("SPACING",
3592 "space prohibited before that '$op' $at\n" . $hereptr)) {
3597 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
3598 if (ERROR("SPACING",
3599 "space required after that '$op' $at\n" . $hereptr)) {
3605 if ($rtrim_before || $space_after) {
3606 if ($rtrim_before) {
3607 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3609 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3616 # '*' as part of a type definition -- reported already.
3617 } elsif ($opv eq '*_') {
3618 #warn "'*' is part of type\n";
3620 # unary operators should have a space before and
3621 # none after. May be left adjacent to another
3622 # unary operator, or a cast
3623 } elsif ($op eq '!' || $op eq '~' ||
3624 $opv eq '*U' || $opv eq '-U' ||
3625 $opv eq '&U' || $opv eq '&&U') {
3626 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
3627 if (ERROR("SPACING",
3628 "space required before that '$op' $at\n" . $hereptr)) {
3629 if ($n != $last_after + 2) {
3630 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3635 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
3636 # A unary '*' may be const
3638 } elsif ($ctx =~ /.xW/) {
3639 if (ERROR("SPACING",
3640 "space prohibited after that '$op' $at\n" . $hereptr)) {
3641 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
3642 if (defined $fix_elements[$n + 2]) {
3643 $fix_elements[$n + 2] =~ s/^\s+//;
3649 # unary ++ and unary -- are allowed no space on one side.
3650 } elsif ($op eq '++' or $op eq '--') {
3651 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
3652 if (ERROR("SPACING",
3653 "space required one side of that '$op' $at\n" . $hereptr)) {
3654 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3658 if ($ctx =~ /Wx[BE]/ ||
3659 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
3660 if (ERROR("SPACING",
3661 "space prohibited before that '$op' $at\n" . $hereptr)) {
3662 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3666 if ($ctx =~ /ExW/) {
3667 if (ERROR("SPACING",
3668 "space prohibited after that '$op' $at\n" . $hereptr)) {
3669 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3670 if (defined $fix_elements[$n + 2]) {
3671 $fix_elements[$n + 2] =~ s/^\s+//;
3677 # << and >> may either have or not have spaces both sides
3678 } elsif ($op eq '<<' or $op eq '>>' or
3679 $op eq '&' or $op eq '^' or $op eq '|' or
3680 $op eq '+' or $op eq '-' or
3681 $op eq '*' or $op eq '/' or
3684 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
3685 if (ERROR("SPACING",
3686 "need consistent spacing around '$op' $at\n" . $hereptr)) {
3687 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3688 if (defined $fix_elements[$n + 2]) {
3689 $fix_elements[$n + 2] =~ s/^\s+//;
3695 # A colon needs no spaces before when it is
3696 # terminating a case value or a label.
3697 } elsif ($opv eq ':C' || $opv eq ':L') {
3698 if ($ctx =~ /Wx./) {
3699 if (ERROR("SPACING",
3700 "space prohibited before that '$op' $at\n" . $hereptr)) {
3701 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3706 # All the others need spaces both sides.
3707 } elsif ($ctx !~ /[EWC]x[CWE]/) {
3710 # Ignore email addresses <foo@bar>
3712 $cc =~ /^\S+\@\S+>/) ||
3714 $ca =~ /<\S+\@\S+$/))
3719 # messages are ERROR, but ?: are CHK
3721 my $msg_type = \&ERROR;
3722 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
3724 if (&{$msg_type}("SPACING",
3725 "spaces required around that '$op' $at\n" . $hereptr)) {
3726 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3727 if (defined $fix_elements[$n + 2]) {
3728 $fix_elements[$n + 2] =~ s/^\s+//;
3734 $off += length($elements[$n + 1]);
3736 ## print("n: <$n> GOOD: <$good>\n");
3738 $fixed_line = $fixed_line . $good;
3741 if (($#elements % 2) == 0) {
3742 $fixed_line = $fixed_line . $fix_elements[$#elements];
3745 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
3746 $fixed[$fixlinenr] = $fixed_line;
3752 # check for whitespace before a non-naked semicolon
3753 if ($line =~ /^\+.*\S\s+;\s*$/) {
3755 "space prohibited before semicolon\n" . $herecurr) &&
3757 1 while $fixed[$fixlinenr] =~
3758 s/^(\+.*\S)\s+;/$1;/;
3762 # check for multiple assignments
3763 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
3764 CHK("MULTIPLE_ASSIGNMENTS",
3765 "multiple assignments should be avoided\n" . $herecurr);
3768 ## # check for multiple declarations, allowing for a function declaration
3770 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3771 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3773 ## # Remove any bracketed sections to ensure we do not
3774 ## # falsly report the parameters of functions.
3776 ## while ($ln =~ s/\([^\(\)]*\)//g) {
3778 ## if ($ln =~ /,/) {
3779 ## WARN("MULTIPLE_DECLARATION",
3780 ## "declaring multiple variables together should be avoided\n" . $herecurr);
3784 #need space before brace following if, while, etc
3785 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3787 if (ERROR("SPACING",
3788 "space required before the open brace '{'\n" . $herecurr) &&
3790 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
3794 ## # check for blank lines before declarations
3795 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3796 ## $prevrawline =~ /^.\s*$/) {
3798 ## "No blank lines before declarations\n" . $hereprev);
3802 # closing brace should have a space following it when it has anything
3804 if ($line =~ /}(?!(?:,|;|\)))\S/) {
3805 if (ERROR("SPACING",
3806 "space required after that close brace '}'\n" . $herecurr) &&
3808 $fixed[$fixlinenr] =~
3809 s/}((?!(?:,|;|\)))\S)/} $1/;
3813 # check spacing on square brackets
3814 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
3815 if (ERROR("SPACING",
3816 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3818 $fixed[$fixlinenr] =~
3822 if ($line =~ /\s\]/) {
3823 if (ERROR("SPACING",
3824 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3826 $fixed[$fixlinenr] =~
3831 # check spacing on parentheses
3832 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3833 $line !~ /for\s*\(\s+;/) {
3834 if (ERROR("SPACING",
3835 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3837 $fixed[$fixlinenr] =~
3841 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
3842 $line !~ /for\s*\(.*;\s+\)/ &&
3843 $line !~ /:\s+\)/) {
3844 if (ERROR("SPACING",
3845 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3847 $fixed[$fixlinenr] =~
3852 # check unnecessary parentheses around addressof/dereference single $Lvals
3853 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
3855 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
3857 if (CHK("UNNECESSARY_PARENTHESES",
3858 "Unnecessary parentheses around $var\n" . $herecurr) &&
3860 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
3864 # check for unnecessary parentheses around function pointer uses
3865 # ie: (foo->bar)(); should be foo->bar();
3866 # but not "if (foo->bar) (" to avoid some false positives
3867 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
3869 if (CHK("UNNECESSARY_PARENTHESES",
3870 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
3872 my $var2 = deparenthesize($var);
3874 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
3878 #goto labels aren't indented, allow a single space however
3879 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
3880 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
3881 if (WARN("INDENTED_LABEL",
3882 "labels should not be indented\n" . $herecurr) &&
3884 $fixed[$fixlinenr] =~
3889 # return is not a function
3890 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
3892 if ($^V && $^V ge 5.10.0 &&
3893 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
3895 $value = deparenthesize($value);
3896 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
3897 ERROR("RETURN_PARENTHESES",
3898 "return is not a function, parentheses are not required\n" . $herecurr);
3900 } elsif ($spacing !~ /\s+/) {
3902 "space required before the open parenthesis '('\n" . $herecurr);
3906 # unnecessary return in a void function
3907 # at end-of-function, with the previous line a single leading tab, then return;
3908 # and the line before that not a goto label target like "out:"
3909 if ($sline =~ /^[ \+]}\s*$/ &&
3910 $prevline =~ /^\+\treturn\s*;\s*$/ &&
3912 $lines[$linenr - 3] =~ /^[ +]/ &&
3913 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
3915 "void function return statements are not generally useful\n" . $hereprev);
3918 # if statements using unnecessary parentheses - ie: if ((foo == bar))
3919 if ($^V && $^V ge 5.10.0 &&
3920 $line =~ /\bif\s*((?:\(\s*){2,})/) {
3921 my $openparens = $1;
3922 my $count = $openparens =~ tr@\(@\(@;
3924 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3925 my $comp = $4; #Not $1 because of $LvalOrFunc
3926 $msg = " - maybe == should be = ?" if ($comp eq "==");
3927 WARN("UNNECESSARY_PARENTHESES",
3928 "Unnecessary parentheses$msg\n" . $herecurr);
3932 # Return of what appears to be an errno should normally be -'ve
3933 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
3935 if ($name ne 'EOF' && $name ne 'ERROR') {
3936 WARN("USE_NEGATIVE_ERRNO",
3937 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
3941 # Need a space before open parenthesis after if, while etc
3942 if ($line =~ /\b(if|while|for|switch)\(/) {
3943 if (ERROR("SPACING",
3944 "space required before the open parenthesis '('\n" . $herecurr) &&
3946 $fixed[$fixlinenr] =~
3947 s/\b(if|while|for|switch)\(/$1 \(/;
3951 # Check for illegal assignment in if conditional -- and check for trailing
3952 # statements after the conditional.
3953 if ($line =~ /do\s*(?!{)/) {
3954 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3955 ctx_statement_block($linenr, $realcnt, 0)
3956 if (!defined $stat);
3957 my ($stat_next) = ctx_statement_block($line_nr_next,
3958 $remain_next, $off_next);
3959 $stat_next =~ s/\n./\n /g;
3960 ##print "stat<$stat> stat_next<$stat_next>\n";
3962 if ($stat_next =~ /^\s*while\b/) {
3963 # If the statement carries leading newlines,
3964 # then count those as offsets.
3966 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
3968 statement_rawlines($whitespace) - 1;
3970 $suppress_whiletrailers{$line_nr_next +
3974 if (!defined $suppress_whiletrailers{$linenr} &&
3975 defined($stat) && defined($cond) &&
3976 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
3977 my ($s, $c) = ($stat, $cond);
3979 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
3980 ERROR("ASSIGN_IN_IF",
3981 "do not use assignment in if condition\n" . $herecurr);
3984 # Find out what is on the end of the line after the
3986 substr($s, 0, length($c), '');
3988 $s =~ s/$;//g; # Remove any comments
3989 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
3990 $c !~ /}\s*while\s*/)
3992 # Find out how long the conditional actually is.
3993 my @newlines = ($c =~ /\n/gs);
3994 my $cond_lines = 1 + $#newlines;
3997 $stat_real = raw_line($linenr, $cond_lines)
3998 . "\n" if ($cond_lines);
3999 if (defined($stat_real) && $cond_lines > 1) {
4000 $stat_real = "[...]\n$stat_real";
4003 ERROR("TRAILING_STATEMENTS",
4004 "trailing statements should be on next line\n" . $herecurr . $stat_real);
4008 # Check for bitwise tests written as boolean
4020 WARN("HEXADECIMAL_BOOLEAN_TEST",
4021 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
4024 # if and else should not have general statements after it
4025 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4027 $s =~ s/$;//g; # Remove any comments
4028 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
4029 ERROR("TRAILING_STATEMENTS",
4030 "trailing statements should be on next line\n" . $herecurr);
4033 # if should not continue a brace
4034 if ($line =~ /}\s*if\b/) {
4035 ERROR("TRAILING_STATEMENTS",
4036 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
4039 # case and default should not have general statements after them
4040 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4042 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
4046 ERROR("TRAILING_STATEMENTS",
4047 "trailing statements should be on next line\n" . $herecurr);
4050 # Check for }<nl>else {, these must be at the same
4051 # indent level to be relevant to each other.
4052 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4053 $previndent == $indent) {
4054 if (ERROR("ELSE_AFTER_BRACE",
4055 "else should follow close brace '}'\n" . $hereprev) &&
4056 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4057 fix_delete_line($fixlinenr - 1, $prevrawline);
4058 fix_delete_line($fixlinenr, $rawline);
4059 my $fixedline = $prevrawline;
4060 $fixedline =~ s/}\s*$//;
4061 if ($fixedline !~ /^\+\s*$/) {
4062 fix_insert_line($fixlinenr, $fixedline);
4064 $fixedline = $rawline;
4065 $fixedline =~ s/^(.\s*)else/$1} else/;
4066 fix_insert_line($fixlinenr, $fixedline);
4070 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4071 $previndent == $indent) {
4072 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4074 # Find out what is on the end of the line after the
4076 substr($s, 0, length($c), '');
4079 if ($s =~ /^\s*;/) {
4080 if (ERROR("WHILE_AFTER_BRACE",
4081 "while should follow close brace '}'\n" . $hereprev) &&
4082 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4083 fix_delete_line($fixlinenr - 1, $prevrawline);
4084 fix_delete_line($fixlinenr, $rawline);
4085 my $fixedline = $prevrawline;
4086 my $trailing = $rawline;
4087 $trailing =~ s/^\+//;
4088 $trailing = trim($trailing);
4089 $fixedline =~ s/}\s*$/} $trailing/;
4090 fix_insert_line($fixlinenr, $fixedline);
4095 #Specific variable tests
4096 while ($line =~ m{($Constant|$Lval)}g) {
4099 #gcc binary extension
4100 if ($var =~ /^$Binary$/) {
4101 if (WARN("GCC_BINARY_CONSTANT",
4102 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4104 my $hexval = sprintf("0x%x", oct($var));
4105 $fixed[$fixlinenr] =~
4106 s/\b$var\b/$hexval/;
4111 if ($var !~ /^$Constant$/ &&
4112 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
4113 #Ignore Page<foo> variants
4114 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
4115 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4116 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4117 #Ignore some three character SI units explicitly, like MiB and KHz
4118 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
4119 while ($var =~ m{($Ident)}g) {
4121 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
4123 seed_camelcase_includes();
4124 if (!$file && !$camelcase_file_seeded) {
4125 seed_camelcase_file($realfile);
4126 $camelcase_file_seeded = 1;
4129 if (!defined $camelcase{$word}) {
4130 $camelcase{$word} = 1;
4132 "Avoid CamelCase: <$word>\n" . $herecurr);
4138 #no spaces allowed after \ in define
4139 if ($line =~ /\#\s*define.*\\\s+$/) {
4140 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4141 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4143 $fixed[$fixlinenr] =~ s/\s+$//;
4147 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
4148 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
4150 my $checkfile = "include/linux/$file";
4151 if (-f "$root/$checkfile" &&
4152 $realfile ne $checkfile &&
4153 $1 !~ /$allowed_asm_includes/)
4155 if ($realfile =~ m{^arch/}) {
4156 CHK("ARCH_INCLUDE_LINUX",
4157 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4159 WARN("INCLUDE_LINUX",
4160 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4165 # multi-statement macros should be enclosed in a do while loop, grab the
4166 # first statement and ensure its the whole macro if its not enclosed
4167 # in a known good container
4168 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4169 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
4172 my ($off, $dstat, $dcond, $rest);
4174 my $has_flow_statement = 0;
4175 my $has_arg_concat = 0;
4176 ($dstat, $dcond, $ln, $cnt, $off) =
4177 ctx_statement_block($linenr, $realcnt, 0);
4179 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4180 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4182 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
4183 $has_arg_concat = 1 if ($ctx =~ /\#\#/);
4185 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
4187 $dstat =~ s/\\\n.//g;
4188 $dstat =~ s/^\s*//s;
4189 $dstat =~ s/\s*$//s;
4191 # Flatten any parentheses and braces
4192 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4193 $dstat =~ s/\{[^\{\}]*\}/1/ ||
4194 $dstat =~ s/\[[^\[\]]*\]/1/)
4198 # Flatten any obvious string concatentation.
4199 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
4200 $dstat =~ s/$Ident\s*("X*")/$1/)
4204 my $exceptions = qr{
4216 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4218 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4219 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
4220 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4221 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
4222 $dstat !~ /$exceptions/ &&
4223 $dstat !~ /^\.$Ident\s*=/ && # .foo =
4224 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
4225 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
4226 $dstat !~ /^for\s*$Constant$/ && # for (...)
4227 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4228 $dstat !~ /^do\s*{/ && # do {...
4229 $dstat !~ /^\({/ && # ({...
4230 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
4233 my $herectx = $here . "\n";
4234 my $cnt = statement_rawlines($ctx);
4236 for (my $n = 0; $n < $cnt; $n++) {
4237 $herectx .= raw_line($linenr, $n) . "\n";
4240 if ($dstat =~ /;/) {
4241 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4242 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4244 ERROR("COMPLEX_MACRO",
4245 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
4249 # check for macros with flow control, but without ## concatenation
4250 # ## concatenation is commonly a macro that defines a function so ignore those
4251 if ($has_flow_statement && !$has_arg_concat) {
4252 my $herectx = $here . "\n";
4253 my $cnt = statement_rawlines($ctx);
4255 for (my $n = 0; $n < $cnt; $n++) {
4256 $herectx .= raw_line($linenr, $n) . "\n";
4258 WARN("MACRO_WITH_FLOW_CONTROL",
4259 "Macros with flow control statements should be avoided\n" . "$herectx");
4262 # check for line continuations outside of #defines, preprocessor #, and asm
4265 if ($prevline !~ /^..*\\$/ &&
4266 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4267 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
4268 $line =~ /^\+.*\\$/) {
4269 WARN("LINE_CONTINUATIONS",
4270 "Avoid unnecessary line continuations\n" . $herecurr);
4274 # do {} while (0) macro tests:
4275 # single-statement macros do not need to be enclosed in do while (0) loop,
4276 # macro should not end with a semicolon
4277 if ($^V && $^V ge 5.10.0 &&
4278 $realfile !~ m@/vmlinux.lds.h$@ &&
4279 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4282 my ($off, $dstat, $dcond, $rest);
4284 ($dstat, $dcond, $ln, $cnt, $off) =
4285 ctx_statement_block($linenr, $realcnt, 0);
4288 $dstat =~ s/\\\n.//g;
4291 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4296 my $cnt = statement_rawlines($ctx);
4297 my $herectx = $here . "\n";
4299 for (my $n = 0; $n < $cnt; $n++) {
4300 $herectx .= raw_line($linenr, $n) . "\n";
4303 if (($stmts =~ tr/;/;/) == 1 &&
4304 $stmts !~ /^\s*(if|while|for|switch)\b/) {
4305 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4306 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4308 if (defined $semis && $semis ne "") {
4309 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4310 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4312 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4314 my $cnt = statement_rawlines($ctx);
4315 my $herectx = $here . "\n";
4317 for (my $n = 0; $n < $cnt; $n++) {
4318 $herectx .= raw_line($linenr, $n) . "\n";
4321 WARN("TRAILING_SEMICOLON",
4322 "macros should not use a trailing semicolon\n" . "$herectx");
4326 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4327 # all assignments may have only one of the following with an assignment:
4330 # VMLINUX_SYMBOL(...)
4331 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
4332 WARN("MISSING_VMLINUX_SYMBOL",
4333 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
4336 # check for redundant bracing round if etc
4337 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4338 my ($level, $endln, @chunks) =
4339 ctx_statement_full($linenr, $realcnt, 1);
4340 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
4341 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4342 if ($#chunks > 0 && $level == 0) {
4346 my $herectx = $here . "\n";
4347 my $ln = $linenr - 1;
4348 for my $chunk (@chunks) {
4349 my ($cond, $block) = @{$chunk};
4351 # If the condition carries leading newlines, then count those as offsets.
4352 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4353 my $offset = statement_rawlines($whitespace) - 1;
4355 $allowed[$allow] = 0;
4356 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4358 # We have looked at and allowed this specific line.
4359 $suppress_ifbraces{$ln + $offset} = 1;
4361 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
4362 $ln += statement_rawlines($block) - 1;
4364 substr($block, 0, length($cond), '');
4366 $seen++ if ($block =~ /^\s*{/);
4368 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
4369 if (statement_lines($cond) > 1) {
4370 #print "APW: ALLOWED: cond<$cond>\n";
4371 $allowed[$allow] = 1;
4373 if ($block =~/\b(?:if|for|while)\b/) {
4374 #print "APW: ALLOWED: block<$block>\n";
4375 $allowed[$allow] = 1;
4377 if (statement_block_size($block) > 1) {
4378 #print "APW: ALLOWED: lines block<$block>\n";
4379 $allowed[$allow] = 1;
4384 my $sum_allowed = 0;
4385 foreach (@allowed) {
4388 if ($sum_allowed == 0) {
4390 "braces {} are not necessary for any arm of this statement\n" . $herectx);
4391 } elsif ($sum_allowed != $allow &&
4394 "braces {} should be used on all arms of this statement\n" . $herectx);
4399 if (!defined $suppress_ifbraces{$linenr - 1} &&
4400 $line =~ /\b(if|while|for|else)\b/) {
4403 # Check the pre-context.
4404 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
4405 #print "APW: ALLOWED: pre<$1>\n";
4409 my ($level, $endln, @chunks) =
4410 ctx_statement_full($linenr, $realcnt, $-[0]);
4412 # Check the condition.
4413 my ($cond, $block) = @{$chunks[0]};
4414 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
4415 if (defined $cond) {
4416 substr($block, 0, length($cond), '');
4418 if (statement_lines($cond) > 1) {
4419 #print "APW: ALLOWED: cond<$cond>\n";
4422 if ($block =~/\b(?:if|for|while)\b/) {
4423 #print "APW: ALLOWED: block<$block>\n";
4426 if (statement_block_size($block) > 1) {
4427 #print "APW: ALLOWED: lines block<$block>\n";
4430 # Check the post-context.
4431 if (defined $chunks[1]) {
4432 my ($cond, $block) = @{$chunks[1]};
4433 if (defined $cond) {
4434 substr($block, 0, length($cond), '');
4436 if ($block =~ /^\s*\{/) {
4437 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4441 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
4442 my $herectx = $here . "\n";
4443 my $cnt = statement_rawlines($block);
4445 for (my $n = 0; $n < $cnt; $n++) {
4446 $herectx .= raw_line($linenr, $n) . "\n";
4450 "braces {} are not necessary for single statement blocks\n" . $herectx);
4454 # check for unnecessary blank lines around braces
4455 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
4457 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
4459 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
4461 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
4464 # no volatiles please
4465 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
4466 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
4468 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
4471 # Check for user-visible strings broken across lines, which breaks the ability
4472 # to grep for the string. Make exceptions when the previous string ends in a
4473 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
4474 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
4475 if ($line =~ /^\+\s*"[X\t]*"/ &&
4476 $prevline =~ /"\s*$/ &&
4477 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
4478 if (WARN("SPLIT_STRING",
4479 "quoted string split across lines\n" . $hereprev) &&
4481 $prevrawline =~ /^\+.*"\s*$/ &&
4482 $last_coalesced_string_linenr != $linenr - 1) {
4483 my $extracted_string = get_quoted_string($line, $rawline);
4484 my $comma_close = "";
4485 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
4489 fix_delete_line($fixlinenr - 1, $prevrawline);
4490 fix_delete_line($fixlinenr, $rawline);
4491 my $fixedline = $prevrawline;
4492 $fixedline =~ s/"\s*$//;
4493 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
4494 fix_insert_line($fixlinenr - 1, $fixedline);
4495 $fixedline = $rawline;
4496 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
4497 if ($fixedline !~ /\+\s*$/) {
4498 fix_insert_line($fixlinenr, $fixedline);
4500 $last_coalesced_string_linenr = $linenr;
4504 # check for missing a space in a string concatenation
4505 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
4506 WARN('MISSING_SPACE',
4507 "break quoted strings at a space character\n" . $hereprev);
4510 # check for spaces before a quoted newline
4511 if ($rawline =~ /^.*\".*\s\\n/) {
4512 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
4513 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
4515 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
4520 # concatenated string without spaces between elements
4521 if ($line =~ /"X+"[A-Z_]+/ || $line =~ /[A-Z_]+"X+"/) {
4522 CHK("CONCATENATED_STRING",
4523 "Concatenated strings should use spaces between elements\n" . $herecurr);
4526 # uncoalesced string fragments
4527 if ($line =~ /"X*"\s*"/) {
4528 WARN("STRING_FRAGMENTS",
4529 "Consecutive strings are generally better as a single string\n" . $herecurr);
4532 # check for %L{u,d,i} in strings
4534 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4535 $string = substr($rawline, $-[1], $+[1] - $-[1]);
4536 $string =~ s/%%/__/g;
4537 if ($string =~ /(?<!%)%L[udi]/) {
4539 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
4544 # check for line continuations in quoted strings with odd counts of "
4545 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
4546 WARN("LINE_CONTINUATIONS",
4547 "Avoid line continuations in quoted strings\n" . $herecurr);
4551 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
4552 CHK("REDUNDANT_CODE",
4553 "if this code is redundant consider removing it\n" .
4557 # check for needless "if (<foo>) fn(<foo>)" uses
4558 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
4559 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
4560 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
4562 "$1(NULL) is safe and this check is probably not required\n" . $hereprev);
4566 # check for unnecessary "Out of Memory" messages
4567 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
4568 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
4569 (defined $1 || defined $3) &&
4572 my $testline = $lines[$linenr - 3];
4574 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
4575 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
4577 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
4579 "Possible unnecessary 'out of memory' message\n" . $hereprev);
4583 # check for logging functions with KERN_<LEVEL>
4584 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
4585 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
4587 if (WARN("UNNECESSARY_KERN_LEVEL",
4588 "Possible unnecessary $level\n" . $herecurr) &&
4590 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
4594 # check for mask then right shift without a parentheses
4595 if ($^V && $^V ge 5.10.0 &&
4596 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
4597 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
4598 WARN("MASK_THEN_SHIFT",
4599 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
4602 # check for pointer comparisons to NULL
4603 if ($^V && $^V ge 5.10.0) {
4604 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
4607 $equal = "" if ($4 eq "!=");
4608 if (CHK("COMPARISON_TO_NULL",
4609 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
4611 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
4616 # check for bad placement of section $InitAttribute (e.g.: __initdata)
4617 if ($line =~ /(\b$InitAttribute\b)/) {
4619 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
4622 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
4623 ERROR("MISPLACED_INIT",
4624 "$attr should be placed after $var\n" . $herecurr)) ||
4625 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
4626 WARN("MISPLACED_INIT",
4627 "$attr should be placed after $var\n" . $herecurr))) &&
4629 $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;
4634 # check for $InitAttributeData (ie: __initdata) with const
4635 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
4637 $attr =~ /($InitAttributePrefix)(.*)/;
4638 my $attr_prefix = $1;
4640 if (ERROR("INIT_ATTRIBUTE",
4641 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
4643 $fixed[$fixlinenr] =~
4644 s/$InitAttributeData/${attr_prefix}initconst/;
4648 # check for $InitAttributeConst (ie: __initconst) without const
4649 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
4651 if (ERROR("INIT_ATTRIBUTE",
4652 "Use of $attr requires a separate use of const\n" . $herecurr) &&
4654 my $lead = $fixed[$fixlinenr] =~
4655 /(^\+\s*(?:static\s+))/;
4657 $lead = "$lead " if ($lead !~ /^\+$/);
4658 $lead = "${lead}const ";
4659 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
4663 # don't use __constant_<foo> functions outside of include/uapi/
4664 if ($realfile !~ m@^include/uapi/@ &&
4665 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
4666 my $constant_func = $1;
4667 my $func = $constant_func;
4668 $func =~ s/^__constant_//;
4669 if (WARN("CONSTANT_CONVERSION",
4670 "$constant_func should be $func\n" . $herecurr) &&
4672 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
4676 # prefer usleep_range over udelay
4677 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
4679 # ignore udelay's < 10, however
4680 if (! ($delay < 10) ) {
4682 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4684 if ($delay > 2000) {
4686 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
4690 # warn about unexpectedly long msleep's
4691 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
4694 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4698 # check for comparisons of jiffies
4699 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
4700 WARN("JIFFIES_COMPARISON",
4701 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4704 # check for comparisons of get_jiffies_64()
4705 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
4706 WARN("JIFFIES_COMPARISON",
4707 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4710 # warn about #ifdefs in C files
4711 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
4712 # print "#ifdef in C files should be avoided\n";
4713 # print "$herecurr";
4717 # warn about spacing in #ifdefs
4718 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
4719 if (ERROR("SPACING",
4720 "exactly one space required after that #$1\n" . $herecurr) &&
4722 $fixed[$fixlinenr] =~
4723 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
4728 # check for spinlock_t definitions without a comment.
4729 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
4730 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
4732 if (!ctx_has_comment($first_line, $linenr)) {
4733 CHK("UNCOMMENTED_DEFINITION",
4734 "$1 definition without comment\n" . $herecurr);
4737 # check for memory barriers without a comment.
4738 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4739 if (!ctx_has_comment($first_line, $linenr)) {
4740 WARN("MEMORY_BARRIER",
4741 "memory barrier without comment\n" . $herecurr);
4744 # check of hardware specific defines
4745 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
4747 "architecture specific defines should be avoided\n" . $herecurr);
4750 # Check that the storage class is at the beginning of a declaration
4751 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
4752 WARN("STORAGE_CLASS",
4753 "storage class should be at the beginning of the declaration\n" . $herecurr)
4756 # check the location of the inline attribute, that it is between
4757 # storage class and type.
4758 if ($line =~ /\b$Type\s+$Inline\b/ ||
4759 $line =~ /\b$Inline\s+$Storage\b/) {
4760 ERROR("INLINE_LOCATION",
4761 "inline keyword should sit between storage class and type\n" . $herecurr);
4764 # Check for __inline__ and __inline, prefer inline
4765 if ($realfile !~ m@\binclude/uapi/@ &&
4766 $line =~ /\b(__inline__|__inline)\b/) {
4768 "plain inline is preferred over $1\n" . $herecurr) &&
4770 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
4775 # Check for __attribute__ packed, prefer __packed
4776 if ($realfile !~ m@\binclude/uapi/@ &&
4777 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
4778 WARN("PREFER_PACKED",
4779 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
4782 # Check for __attribute__ aligned, prefer __aligned
4783 if ($realfile !~ m@\binclude/uapi/@ &&
4784 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
4785 WARN("PREFER_ALIGNED",
4786 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
4789 # Check for __attribute__ format(printf, prefer __printf
4790 if ($realfile !~ m@\binclude/uapi/@ &&
4791 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
4792 if (WARN("PREFER_PRINTF",
4793 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4795 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
4800 # Check for __attribute__ format(scanf, prefer __scanf
4801 if ($realfile !~ m@\binclude/uapi/@ &&
4802 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
4803 if (WARN("PREFER_SCANF",
4804 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4806 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
4810 # Check for __attribute__ weak, or __weak declarations (may have link issues)
4811 if ($^V && $^V ge 5.10.0 &&
4812 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
4813 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
4814 $line =~ /\b__weak\b/)) {
4815 ERROR("WEAK_DECLARATION",
4816 "Using weak declarations can have unintended link defects\n" . $herecurr);
4819 # check for sizeof(&)
4820 if ($line =~ /\bsizeof\s*\(\s*\&/) {
4821 WARN("SIZEOF_ADDRESS",
4822 "sizeof(& should be avoided\n" . $herecurr);
4825 # check for sizeof without parenthesis
4826 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
4827 if (WARN("SIZEOF_PARENTHESIS",
4828 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
4830 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
4834 # check for struct spinlock declarations
4835 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
4836 WARN("USE_SPINLOCK_T",
4837 "struct spinlock should be spinlock_t\n" . $herecurr);
4840 # check for seq_printf uses that could be seq_puts
4841 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
4842 my $fmt = get_quoted_string($line, $rawline);
4843 if ($fmt ne "" && $fmt !~ /[^\\]\%/) {
4844 if (WARN("PREFER_SEQ_PUTS",
4845 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
4847 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
4852 # Check for misused memsets
4853 if ($^V && $^V ge 5.10.0 &&
4855 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
4861 if ($ms_size =~ /^(0x|)0$/i) {
4863 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
4864 } elsif ($ms_size =~ /^(0x|)1$/i) {
4866 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
4870 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
4871 if ($^V && $^V ge 5.10.0 &&
4872 $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) {
4873 if (WARN("PREFER_ETHER_ADDR_COPY",
4874 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
4876 $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
4880 # typecasts on min/max could be min_t/max_t
4881 if ($^V && $^V ge 5.10.0 &&
4883 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
4884 if (defined $2 || defined $7) {
4886 my $cast1 = deparenthesize($2);
4888 my $cast2 = deparenthesize($7);
4892 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
4893 $cast = "$cast1 or $cast2";
4894 } elsif ($cast1 ne "") {
4900 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
4904 # check usleep_range arguments
4905 if ($^V && $^V ge 5.10.0 &&
4907 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
4911 WARN("USLEEP_RANGE",
4912 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4913 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
4915 WARN("USLEEP_RANGE",
4916 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4920 # check for naked sscanf
4921 if ($^V && $^V ge 5.10.0 &&
4923 $line =~ /\bsscanf\b/ &&
4924 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
4925 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
4926 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
4927 my $lc = $stat =~ tr@\n@@;
4928 $lc = $lc + $linenr;
4929 my $stat_real = raw_line($linenr, 0);
4930 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4931 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4933 WARN("NAKED_SSCANF",
4934 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
4937 # check for simple sscanf that should be kstrto<foo>
4938 if ($^V && $^V ge 5.10.0 &&
4940 $line =~ /\bsscanf\b/) {
4941 my $lc = $stat =~ tr@\n@@;
4942 $lc = $lc + $linenr;
4943 my $stat_real = raw_line($linenr, 0);
4944 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4945 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4947 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
4949 my $count = $format =~ tr@%@%@;
4951 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
4952 WARN("SSCANF_TO_KSTRTO",
4953 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
4958 # check for new externs in .h files.
4959 if ($realfile =~ /\.h$/ &&
4960 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
4961 if (CHK("AVOID_EXTERNS",
4962 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
4964 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
4968 # check for new externs in .c files.
4969 if ($realfile =~ /\.c$/ && defined $stat &&
4970 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
4972 my $function_name = $1;
4973 my $paren_space = $2;
4976 if (defined $cond) {
4977 substr($s, 0, length($cond), '');
4979 if ($s =~ /^\s*;/ &&
4980 $function_name ne 'uninitialized_var')
4982 WARN("AVOID_EXTERNS",
4983 "externs should be avoided in .c files\n" . $herecurr);
4986 if ($paren_space =~ /\n/) {
4987 WARN("FUNCTION_ARGUMENTS",
4988 "arguments for function declarations should follow identifier\n" . $herecurr);
4991 } elsif ($realfile =~ /\.c$/ && defined $stat &&
4992 $stat =~ /^.\s*extern\s+/)
4994 WARN("AVOID_EXTERNS",
4995 "externs should be avoided in .c files\n" . $herecurr);
4998 # checks for new __setup's
4999 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5002 if (!grep(/$name/, @setup_docs)) {
5003 CHK("UNDOCUMENTED_SETUP",
5004 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
5008 # check for pointless casting of kmalloc return
5009 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
5010 WARN("UNNECESSARY_CASTS",
5011 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
5015 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5016 if ($^V && $^V ge 5.10.0 &&
5017 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5018 CHK("ALLOC_SIZEOF_STRUCT",
5019 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
5022 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5023 if ($^V && $^V ge 5.10.0 &&
5024 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
5028 my $newfunc = "kmalloc_array";
5029 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
5032 if ($a1 =~ /^sizeof\s*\S/) {
5036 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
5037 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
5038 if (WARN("ALLOC_WITH_MULTIPLY",
5039 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
5041 $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;
5047 # check for krealloc arg reuse
5048 if ($^V && $^V ge 5.10.0 &&
5049 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
5050 WARN("KREALLOC_ARG_REUSE",
5051 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
5054 # check for alloc argument mismatch
5055 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
5056 WARN("ALLOC_ARRAY_ARGS",
5057 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
5060 # check for multiple semicolons
5061 if ($line =~ /;\s*;\s*$/) {
5062 if (WARN("ONE_SEMICOLON",
5063 "Statements terminations use 1 semicolon\n" . $herecurr) &&
5065 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
5069 # check for #defines like: 1 << <digit> that could be BIT(digit)
5070 if ($line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
5072 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
5073 if (CHK("BIT_MACRO",
5074 "Prefer using the BIT$ull macro\n" . $herecurr) &&
5076 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
5080 # check for case / default statements not preceded by break/fallthrough/switch
5081 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
5083 my $has_statement = 0;
5085 my $prevline = $linenr;
5086 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
5088 my $rline = $rawlines[$prevline - 1];
5089 my $fline = $lines[$prevline - 1];
5090 last if ($fline =~ /^\@\@/);
5091 next if ($fline =~ /^\-/);
5092 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
5093 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
5094 next if ($fline =~ /^.[\s$;]*$/);
5097 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
5099 if (!$has_break && $has_statement) {
5100 WARN("MISSING_BREAK",
5101 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
5105 # check for switch/default statements without a break;
5106 if ($^V && $^V ge 5.10.0 &&
5108 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
5110 my $herectx = $here . "\n";
5111 my $cnt = statement_rawlines($stat);
5112 for (my $n = 0; $n < $cnt; $n++) {
5113 $herectx .= raw_line($linenr, $n) . "\n";
5115 WARN("DEFAULT_NO_BREAK",
5116 "switch default: should use break\n" . $herectx);
5119 # check for gcc specific __FUNCTION__
5120 if ($line =~ /\b__FUNCTION__\b/) {
5121 if (WARN("USE_FUNC",
5122 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
5124 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
5128 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
5129 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
5131 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
5134 # check for use of yield()
5135 if ($line =~ /\byield\s*\(\s*\)/) {
5137 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
5140 # check for comparisons against true and false
5141 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
5149 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
5151 my $type = lc($otype);
5152 if ($type =~ /^(?:true|false)$/) {
5153 if (("$test" eq "==" && "$type" eq "true") ||
5154 ("$test" eq "!=" && "$type" eq "false")) {
5158 CHK("BOOL_COMPARISON",
5159 "Using comparison to $otype is error prone\n" . $herecurr);
5161 ## maybe suggesting a correct construct would better
5162 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5167 # check for semaphores initialized locked
5168 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
5169 WARN("CONSIDER_COMPLETION",
5170 "consider using a completion\n" . $herecurr);
5173 # recommend kstrto* over simple_strto* and strict_strto*
5174 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
5175 WARN("CONSIDER_KSTRTO",
5176 "$1 is obsolete, use k$3 instead\n" . $herecurr);
5179 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
5180 if ($line =~ /^.\s*__initcall\s*\(/) {
5181 WARN("USE_DEVICE_INITCALL",
5182 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
5185 # check for various ops structs, ensure they are const.
5186 my $struct_ops = qr{acpi_dock_ops|
5187 address_space_operations|
5189 block_device_operations|
5194 file_lock_operations|
5204 lock_manager_operations|
5210 pipe_buf_operations|
5211 platform_hibernation_ops|
5212 platform_suspend_ops|
5217 soc_pcmcia_socket_ops|
5223 if ($line !~ /\bconst\b/ &&
5224 $line =~ /\bstruct\s+($struct_ops)\b/) {
5225 WARN("CONST_STRUCT",
5226 "struct $1 should normally be const\n" .
5230 # use of NR_CPUS is usually wrong
5231 # ignore definitions of NR_CPUS and usage to define arrays as likely right
5232 if ($line =~ /\bNR_CPUS\b/ &&
5233 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
5234 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
5235 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
5236 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
5237 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
5240 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
5243 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
5244 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
5245 ERROR("DEFINE_ARCH_HAS",
5246 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
5249 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
5250 if ($^V && $^V ge 5.10.0 &&
5251 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
5252 WARN("LIKELY_MISUSE",
5253 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
5256 # whine mightly about in_atomic
5257 if ($line =~ /\bin_atomic\s*\(/) {
5258 if ($realfile =~ m@^drivers/@) {
5260 "do not use in_atomic in drivers\n" . $herecurr);
5261 } elsif ($realfile !~ m@^kernel/@) {
5263 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
5267 # check for lockdep_set_novalidate_class
5268 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
5269 $line =~ /__lockdep_no_validate__\s*\)/ ) {
5270 if ($realfile !~ m@^kernel/lockdep@ &&
5271 $realfile !~ m@^include/linux/lockdep@ &&
5272 $realfile !~ m@^drivers/base/core@) {
5274 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
5278 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
5279 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
5280 WARN("EXPORTED_WORLD_WRITABLE",
5281 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5284 # Mode permission misuses where it seems decimal should be octal
5285 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5286 if ($^V && $^V ge 5.10.0 &&
5287 $line =~ /$mode_perms_search/) {
5288 foreach my $entry (@mode_permission_funcs) {
5289 my $func = $entry->[0];
5290 my $arg_pos = $entry->[1];
5295 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
5297 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
5298 if ($line =~ /$test/) {
5300 $val = $6 if ($skip_args ne "");
5302 if ($val !~ /^0$/ &&
5303 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
5304 length($val) ne 4)) {
5305 ERROR("NON_OCTAL_PERMISSIONS",
5306 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
5307 } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) {
5308 ERROR("EXPORTED_WORLD_WRITABLE",
5309 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5316 # If we have no input at all, then there is nothing to report on
5317 # so just keep quiet.
5318 if ($#rawlines == -1) {
5322 # In mailback mode only produce a report in the negative, for
5323 # things that appear to be patches.
5324 if ($mailback && ($clean == 1 || !$is_patch)) {
5328 # This is not a patch, and we are are in 'no-patch' mode so
5330 if (!$chk_patch && !$is_patch) {
5335 ERROR("NOT_UNIFIED_DIFF",
5336 "Does not appear to be a unified-diff format patch\n");
5338 if ($is_patch && $chk_signoff && $signoff == 0) {
5339 ERROR("MISSING_SIGN_OFF",
5340 "Missing Signed-off-by: line(s)\n");
5343 print report_dump();
5344 if ($summary && !($clean == 1 && $quiet == 1)) {
5345 print "$filename " if ($summary_file);
5346 print "total: $cnt_error errors, $cnt_warn warnings, " .
5347 (($check)? "$cnt_chk checks, " : "") .
5348 "$cnt_lines lines checked\n";
5349 print "\n" if ($quiet == 0);
5354 if ($^V lt 5.10.0) {
5355 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
5356 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
5359 # If there were whitespace errors which cleanpatch can fix
5360 # then suggest that.
5361 if ($rpt_cleaners) {
5362 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
5363 print " scripts/cleanfile\n\n";
5368 hash_show_words(\%use_type, "Used");
5369 hash_show_words(\%ignore_type, "Ignored");
5371 if ($clean == 0 && $fix &&
5372 ("@rawlines" ne "@fixed" ||
5373 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
5374 my $newfile = $filename;
5375 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
5379 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
5381 open($f, '>', $newfile)
5382 or die "$P: Can't open $newfile for write\n";
5383 foreach my $fixed_line (@fixed) {
5386 if ($linecount > 3) {
5387 $fixed_line =~ s/^\+//;
5388 print $f $fixed_line . "\n";
5391 print $f $fixed_line . "\n";
5398 Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
5400 Do _NOT_ trust the results written to this file.
5401 Do _NOT_ submit these changes without inspecting them for correctness.
5403 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
5404 No warranties, expressed or implied...
5410 if ($clean == 1 && $quiet == 0) {
5411 print "$vname has no obvious style problems and is ready for submission.\n"
5413 if ($clean == 0 && $quiet == 0) {
5415 $vname has style problems, please review.
5417 If any of these errors are false positives, please report
5418 them to the maintainer, see CHECKPATCH in MAINTAINERS.