2 # (c) 2001, Dave Jones. (the file handling bit)
3 # (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
4 # (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
5 # (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
6 # Licensed under the terms of the GNU GPL License version 2
14 my $D = dirname(abs_path($P));
18 use Getopt::Long qw(:config no_auto_abbrev);
44 my $configuration_file = ".checkpatch.conf";
45 my $max_line_length = 80;
46 my $ignore_perl_version = 0;
47 my $minimum_perl_version = 5.10.0;
48 my $min_conf_desc_length = 4;
49 my $spelling_file = "$D/spelling.txt";
51 my $codespellfile = "/usr/local/share/codespell/dictionary.txt";
57 Usage: $P [OPTION]... [FILE]...
62 --no-tree run without a kernel tree
63 --no-signoff do not check for 'Signed-off-by' line
64 --patch treat FILE as patchfile (default)
65 --emacs emacs compile window format
66 --terse one line per report
67 -f, --file treat FILE as regular source file
68 --subjective, --strict enable more subjective tests
69 --types TYPE(,TYPE2...) show only these comma separated message types
70 --ignore TYPE(,TYPE2...) ignore various comma separated message types
71 --max-line-length=n set the maximum line length, if exceeded, warn
72 --min-conf-desc-length=n set the min description length, if shorter, warn
73 --show-types show the message "types" in the output
74 --root=PATH PATH to the kernel tree root
75 --no-summary suppress the per-file summary
76 --mailback only produce a report in case of warnings/errors
77 --summary-file include the filename in summary
78 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
79 'values', 'possible', 'type', and 'attr' (default
81 --test-only=WORD report only warnings/errors containing WORD
83 --fix EXPERIMENTAL - may create horrible results
84 If correctable single-line errors exist, create
85 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
86 with potential errors corrected to the preferred
88 --fix-inplace EXPERIMENTAL - may create horrible results
89 Is the same as --fix, but overwrites the input
90 file. It's your fault if there's no backup or git
91 --ignore-perl-version override checking of perl version. expect
93 --codespell Use the codespell dictionary for spelling/typos
94 (default:/usr/local/share/codespell/dictionary.txt)
95 --codespellfile Use this codespell dictionary
96 -h, --help, --version display this help and exit
98 When FILE is - read standard input.
104 my $conf = which_conf($configuration_file);
107 open(my $conffile, '<', "$conf")
108 or warn "$P: Can't find a readable $configuration_file file $!\n";
110 while (<$conffile>) {
113 $line =~ s/\s*\n?$//g;
117 next if ($line =~ m/^\s*#/);
118 next if ($line =~ m/^\s*$/);
120 my @words = split(" ", $line);
121 foreach my $word (@words) {
122 last if ($word =~ m/^#/);
123 push (@conf_args, $word);
127 unshift(@ARGV, @conf_args) if @conf_args;
131 'q|quiet+' => \$quiet,
133 'signoff!' => \$chk_signoff,
134 'patch!' => \$chk_patch,
138 'subjective!' => \$check,
139 'strict!' => \$check,
140 'ignore=s' => \@ignore,
142 'show-types!' => \$show_types,
143 'max-line-length=i' => \$max_line_length,
144 'min-conf-desc-length=i' => \$min_conf_desc_length,
146 'summary!' => \$summary,
147 'mailback!' => \$mailback,
148 'summary-file!' => \$summary_file,
150 'fix-inplace!' => \$fix_inplace,
151 'ignore-perl-version!' => \$ignore_perl_version,
152 'debug=s' => \%debug,
153 'test-only=s' => \$tst_only,
154 'codespell!' => \$codespell,
155 'codespellfile=s' => \$codespellfile,
162 $fix = 1 if ($fix_inplace);
163 $check_orig = $check;
167 if ($^V && $^V lt $minimum_perl_version) {
168 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
169 if (!$ignore_perl_version) {
175 print "$P: no input files\n";
179 sub hash_save_array_words {
180 my ($hashRef, $arrayRef) = @_;
182 my @array = split(/,/, join(',', @$arrayRef));
183 foreach my $word (@array) {
184 $word =~ s/\s*\n?$//g;
187 $word =~ tr/[a-z]/[A-Z]/;
189 next if ($word =~ m/^\s*#/);
190 next if ($word =~ m/^\s*$/);
196 sub hash_show_words {
197 my ($hashRef, $prefix) = @_;
199 if ($quiet == 0 && keys %$hashRef) {
200 print "NOTE: $prefix message types:";
201 foreach my $word (sort keys %$hashRef) {
208 hash_save_array_words(\%ignore_type, \@ignore);
209 hash_save_array_words(\%use_type, \@use);
212 my $dbg_possible = 0;
215 for my $key (keys %debug) {
217 eval "\${dbg_$key} = '$debug{$key}';";
221 my $rpt_cleaners = 0;
230 if (!top_of_kernel_tree($root)) {
231 die "$P: $root: --root does not point at a valid tree\n";
234 if (top_of_kernel_tree('.')) {
236 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
237 top_of_kernel_tree($1)) {
242 if (!defined $root) {
243 print "Must be run from the top-level dir. of a kernel tree\n";
248 my $emitted_corrupt = 0;
251 [A-Za-z_][A-Za-z\d_]*
252 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
254 our $Storage = qr{extern|static|asmlinkage};
266 our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
267 our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
268 our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
269 our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
270 our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
272 # Notes to $Attribute:
273 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
294 ____cacheline_aligned|
295 ____cacheline_aligned_in_smp|
296 ____cacheline_internodealigned_in_smp|
300 our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
301 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
302 our $Lval = qr{$Ident(?:$Member)*};
304 our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
305 our $Binary = qr{(?i)0b[01]+$Int_type?};
306 our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
307 our $Int = qr{[0-9]+$Int_type?};
308 our $Octal = qr{0[0-7]+$Int_type?};
309 our $String = qr{"[X\t]*"};
310 our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
311 our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
312 our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
313 our $Float = qr{$Float_hex|$Float_dec|$Float_int};
314 our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
315 our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
316 our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
317 our $Arithmetic = qr{\+|-|\*|\/|%};
321 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
324 our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
327 our $NonptrTypeMisordered;
328 our $NonptrTypeWithAttr;
332 our $DeclareMisordered;
334 our $NON_ASCII_UTF8 = qr{
335 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
336 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
337 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
338 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
339 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
340 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
341 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
345 [\x09\x0A\x0D\x20-\x7E] # ASCII
349 our $typeOtherOSTypedefs = qr{(?x:
350 u_(?:char|short|int|long) | # bsd
351 u(?:nchar|short|int|long) # sysv
354 our $typeTypedefs = qr{(?x:
355 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
359 our $logFunctions = qr{(?x:
360 printk(?:_ratelimited|_once|)|
361 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
362 WARN(?:_RATELIMIT|_ONCE|)|
365 seq_vprintf|seq_printf|seq_puts
368 our $signature_tags = qr{(?xi:
379 our @typeListMisordered = (
380 qr{char\s+(?:un)?signed},
381 qr{int\s+(?:(?:un)?signed\s+)?short\s},
382 qr{int\s+short(?:\s+(?:un)?signed)},
383 qr{short\s+int(?:\s+(?:un)?signed)},
384 qr{(?:un)?signed\s+int\s+short},
385 qr{short\s+(?:un)?signed},
386 qr{long\s+int\s+(?:un)?signed},
387 qr{int\s+long\s+(?:un)?signed},
388 qr{long\s+(?:un)?signed\s+int},
389 qr{int\s+(?:un)?signed\s+long},
390 qr{int\s+(?:un)?signed},
391 qr{int\s+long\s+long\s+(?:un)?signed},
392 qr{long\s+long\s+int\s+(?:un)?signed},
393 qr{long\s+long\s+(?:un)?signed\s+int},
394 qr{long\s+long\s+(?:un)?signed},
395 qr{long\s+(?:un)?signed},
400 qr{(?:(?:un)?signed\s+)?char},
401 qr{(?:(?:un)?signed\s+)?short\s+int},
402 qr{(?:(?:un)?signed\s+)?short},
403 qr{(?:(?:un)?signed\s+)?int},
404 qr{(?:(?:un)?signed\s+)?long\s+int},
405 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
406 qr{(?:(?:un)?signed\s+)?long\s+long},
407 qr{(?:(?:un)?signed\s+)?long},
416 qr{${Ident}_handler},
417 qr{${Ident}_handler_fn},
420 our @typeListWithAttr = (
422 qr{struct\s+$InitAttribute\s+$Ident},
423 qr{union\s+$InitAttribute\s+$Ident},
426 our @modifierList = (
430 our @mode_permission_funcs = (
432 ["module_param_(?:array|named|string)", 4],
433 ["module_param_array_named", 5],
434 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
435 ["proc_create(?:_data|)", 2],
436 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
439 #Create a search pattern for all these functions to speed up a loop below
440 our $mode_perms_search = "";
441 foreach my $entry (@mode_permission_funcs) {
442 $mode_perms_search .= '|' if ($mode_perms_search ne "");
443 $mode_perms_search .= $entry->[0];
446 our $mode_perms_world_writable = qr{
454 our $allowed_asm_includes = qr{(?x:
460 # memory.h: ARM has a custom one
462 # Load common spelling mistakes and build regular expression list.
466 if (open(my $spelling, '<', $spelling_file)) {
467 while (<$spelling>) {
470 $line =~ s/\s*\n?$//g;
473 next if ($line =~ m/^\s*#/);
474 next if ($line =~ m/^\s*$/);
476 my ($suspect, $fix) = split(/\|\|/, $line);
478 $spelling_fix{$suspect} = $fix;
482 warn "No typos will be found - file '$spelling_file': $!\n";
486 if (open(my $spelling, '<', $codespellfile)) {
487 while (<$spelling>) {
490 $line =~ s/\s*\n?$//g;
493 next if ($line =~ m/^\s*#/);
494 next if ($line =~ m/^\s*$/);
495 next if ($line =~ m/, disabled/i);
499 my ($suspect, $fix) = split(/->/, $line);
501 $spelling_fix{$suspect} = $fix;
505 warn "No codespell typos will be found - file '$codespellfile': $!\n";
509 $misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
512 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
513 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
514 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
515 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
516 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
518 (?:$Modifier\s+|const\s+)*
520 (?:typeof|__typeof__)\s*\([^\)]*\)|
521 (?:$typeOtherOSTypedefs\b)|
525 (?:\s+$Modifier|\s+const)*
527 $NonptrTypeMisordered = qr{
528 (?:$Modifier\s+|const\s+)*
532 (?:\s+$Modifier|\s+const)*
534 $NonptrTypeWithAttr = qr{
535 (?:$Modifier\s+|const\s+)*
537 (?:typeof|__typeof__)\s*\([^\)]*\)|
539 (?:$typeOtherOSTypedefs\b)|
542 (?:\s+$Modifier|\s+const)*
546 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
547 (?:\s+$Inline|\s+$Modifier)*
549 $TypeMisordered = qr{
550 $NonptrTypeMisordered
551 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
552 (?:\s+$Inline|\s+$Modifier)*
554 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
555 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
559 our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
561 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
562 # requires at least perl version v5.10.0
563 # Any use must be runtime checked with $^V
565 our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
566 our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
567 our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
569 our $declaration_macros = qr{(?x:
570 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,2}\s*\(|
571 (?:$Storage\s+)?LIST_HEAD\s*\(|
572 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
577 return "" if (!defined($string));
579 while ($string =~ /^\s*\(.*\)\s*$/) {
580 $string =~ s@^\s*\(\s*@@;
581 $string =~ s@\s*\)\s*$@@;
584 $string =~ s@\s+@ @g;
589 sub seed_camelcase_file {
592 return if (!(-f $file));
596 open(my $include_file, '<', "$file")
597 or warn "$P: Can't read '$file' $!\n";
598 my $text = <$include_file>;
599 close($include_file);
601 my @lines = split('\n', $text);
603 foreach my $line (@lines) {
604 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
605 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
607 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
609 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
615 my $camelcase_seeded = 0;
616 sub seed_camelcase_includes {
617 return if ($camelcase_seeded);
620 my $camelcase_cache = "";
621 my @include_files = ();
623 $camelcase_seeded = 1;
626 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
627 chomp $git_last_include_commit;
628 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
630 my $last_mod_date = 0;
631 $files = `find $root/include -name "*.h"`;
632 @include_files = split('\n', $files);
633 foreach my $file (@include_files) {
634 my $date = POSIX::strftime("%Y%m%d%H%M",
635 localtime((stat $file)[9]));
636 $last_mod_date = $date if ($last_mod_date < $date);
638 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
641 if ($camelcase_cache ne "" && -f $camelcase_cache) {
642 open(my $camelcase_file, '<', "$camelcase_cache")
643 or warn "$P: Can't read '$camelcase_cache' $!\n";
644 while (<$camelcase_file>) {
648 close($camelcase_file);
654 $files = `git ls-files "include/*.h"`;
655 @include_files = split('\n', $files);
658 foreach my $file (@include_files) {
659 seed_camelcase_file($file);
662 if ($camelcase_cache ne "") {
663 unlink glob ".checkpatch-camelcase.*";
664 open(my $camelcase_file, '>', "$camelcase_cache")
665 or warn "$P: Can't write '$camelcase_cache' $!\n";
666 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
667 print $camelcase_file ("$_\n");
669 close($camelcase_file);
673 sub git_commit_info {
674 my ($commit, $id, $desc) = @_;
676 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
678 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
679 $output =~ s/^\s*//gm;
680 my @lines = split("\n", $output);
682 return ($id, $desc) if ($#lines < 0);
684 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
685 # Maybe one day convert this block of bash into something that returns
686 # all matching commit ids, but it's very slow...
688 # echo "checking commits $1..."
689 # git rev-list --remotes | grep -i "^$1" |
690 # while read line ; do
691 # git log --format='%H %s' -1 $line |
692 # echo "commit $(cut -c 1-12,41-)"
694 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
696 $id = substr($lines[0], 0, 12);
697 $desc = substr($lines[0], 41);
703 $chk_signoff = 0 if ($file);
708 my @fixed_inserted = ();
709 my @fixed_deleted = ();
713 for my $filename (@ARGV) {
716 open($FILE, '-|', "diff -u /dev/null $filename") ||
717 die "$P: $filename: diff failed - $!\n";
718 } elsif ($filename eq '-') {
719 open($FILE, '<&STDIN');
721 open($FILE, '<', "$filename") ||
722 die "$P: $filename: open failed - $!\n";
724 if ($filename eq '-') {
725 $vname = 'Your patch';
734 if (!process($filename)) {
740 @fixed_inserted = ();
747 sub top_of_kernel_tree {
751 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
752 "README", "Documentation", "arch", "include", "drivers",
753 "fs", "init", "ipc", "kernel", "lib", "scripts",
756 foreach my $check (@tree_check) {
757 if (! -e $root . '/' . $check) {
765 my ($formatted_email) = @_;
771 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
774 $comment = $3 if defined $3;
775 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
777 $comment = $2 if defined $2;
778 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
780 $comment = $2 if defined $2;
781 $formatted_email =~ s/$address.*$//;
782 $name = $formatted_email;
784 $name =~ s/^\"|\"$//g;
785 # If there's a name left after stripping spaces and
786 # leading quotes, and the address doesn't have both
787 # leading and trailing angle brackets, the address
789 # "joe smith joe@smith.com" bad
790 # "joe smith <joe@smith.com" bad
791 if ($name ne "" && $address !~ /^<[^>]+>$/) {
799 $name =~ s/^\"|\"$//g;
800 $address = trim($address);
801 $address =~ s/^\<|\>$//g;
803 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
804 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
808 return ($name, $address, $comment);
812 my ($name, $address) = @_;
817 $name =~ s/^\"|\"$//g;
818 $address = trim($address);
820 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
821 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
826 $formatted_email = "$address";
828 $formatted_email = "$name <$address>";
831 return $formatted_email;
837 foreach my $path (split(/:/, $ENV{PATH})) {
838 if (-e "$path/$bin") {
849 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
850 if (-e "$path/$conf") {
851 return "$path/$conf";
863 for my $c (split(//, $str)) {
867 for (; ($n % 8) != 0; $n++) {
879 (my $res = shift) =~ tr/\t/ /c;
886 # Drop the diff line leader and expand tabs
888 $line = expand_tabs($line);
890 # Pick the indent from the front of the line.
891 my ($white) = ($line =~ /^(\s*)/);
893 return (length($line), length($white));
896 my $sanitise_quote = '';
898 sub sanitise_line_reset {
899 my ($in_comment) = @_;
902 $sanitise_quote = '*/';
904 $sanitise_quote = '';
917 # Always copy over the diff marker.
918 $res = substr($line, 0, 1);
920 for ($off = 1; $off < length($line); $off++) {
921 $c = substr($line, $off, 1);
923 # Comments we are wacking completly including the begin
924 # and end, all to $;.
925 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
926 $sanitise_quote = '*/';
928 substr($res, $off, 2, "$;$;");
932 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
933 $sanitise_quote = '';
934 substr($res, $off, 2, "$;$;");
938 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
939 $sanitise_quote = '//';
941 substr($res, $off, 2, $sanitise_quote);
946 # A \ in a string means ignore the next character.
947 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
949 substr($res, $off, 2, 'XX');
954 if ($c eq "'" || $c eq '"') {
955 if ($sanitise_quote eq '') {
956 $sanitise_quote = $c;
958 substr($res, $off, 1, $c);
960 } elsif ($sanitise_quote eq $c) {
961 $sanitise_quote = '';
965 #print "c<$c> SQ<$sanitise_quote>\n";
966 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
967 substr($res, $off, 1, $;);
968 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
969 substr($res, $off, 1, $;);
970 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
971 substr($res, $off, 1, 'X');
973 substr($res, $off, 1, $c);
977 if ($sanitise_quote eq '//') {
978 $sanitise_quote = '';
981 # The pathname on a #include may be surrounded by '<' and '>'.
982 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
983 my $clean = 'X' x length($1);
984 $res =~ s@\<.*\>@<$clean>@;
986 # The whole of a #error is a string.
987 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
988 my $clean = 'X' x length($1);
989 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
995 sub get_quoted_string {
996 my ($line, $rawline) = @_;
998 return "" if ($line !~ m/(\"[X\t]+\")/g);
999 return substr($rawline, $-[0], $+[0] - $-[0]);
1002 sub ctx_statement_block {
1003 my ($linenr, $remain, $off) = @_;
1004 my $line = $linenr - 1;
1007 my $coff = $off - 1;
1021 @stack = (['', 0]) if ($#stack == -1);
1023 #warn "CSB: blk<$blk> remain<$remain>\n";
1024 # If we are about to drop off the end, pull in more
1027 for (; $remain > 0; $line++) {
1028 last if (!defined $lines[$line]);
1029 next if ($lines[$line] =~ /^-/);
1032 $blk .= $lines[$line] . "\n";
1033 $len = length($blk);
1037 # Bail if there is no further context.
1038 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1042 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1048 $c = substr($blk, $off, 1);
1049 $remainder = substr($blk, $off);
1051 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1053 # Handle nested #if/#else.
1054 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1055 push(@stack, [ $type, $level ]);
1056 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1057 ($type, $level) = @{$stack[$#stack - 1]};
1058 } elsif ($remainder =~ /^#\s*endif\b/) {
1059 ($type, $level) = @{pop(@stack)};
1062 # Statement ends at the ';' or a close '}' at the
1064 if ($level == 0 && $c eq ';') {
1068 # An else is really a conditional as long as its not else if
1069 if ($level == 0 && $coff_set == 0 &&
1070 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1071 $remainder =~ /^(else)(?:\s|{)/ &&
1072 $remainder !~ /^else\s+if\b/) {
1073 $coff = $off + length($1) - 1;
1075 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1076 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1079 if (($type eq '' || $type eq '(') && $c eq '(') {
1083 if ($type eq '(' && $c eq ')') {
1085 $type = ($level != 0)? '(' : '';
1087 if ($level == 0 && $coff < $soff) {
1090 #warn "CSB: mark coff<$coff>\n";
1093 if (($type eq '' || $type eq '{') && $c eq '{') {
1097 if ($type eq '{' && $c eq '}') {
1099 $type = ($level != 0)? '{' : '';
1102 if (substr($blk, $off + 1, 1) eq ';') {
1108 # Preprocessor commands end at the newline unless escaped.
1109 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1117 # We are truly at the end, so shuffle to the next line.
1124 my $statement = substr($blk, $soff, $off - $soff + 1);
1125 my $condition = substr($blk, $soff, $coff - $soff + 1);
1127 #warn "STATEMENT<$statement>\n";
1128 #warn "CONDITION<$condition>\n";
1130 #print "coff<$coff> soff<$off> loff<$loff>\n";
1132 return ($statement, $condition,
1133 $line, $remain + 1, $off - $loff + 1, $level);
1136 sub statement_lines {
1139 # Strip the diff line prefixes and rip blank lines at start and end.
1140 $stmt =~ s/(^|\n)./$1/g;
1144 my @stmt_lines = ($stmt =~ /\n/g);
1146 return $#stmt_lines + 2;
1149 sub statement_rawlines {
1152 my @stmt_lines = ($stmt =~ /\n/g);
1154 return $#stmt_lines + 2;
1157 sub statement_block_size {
1160 $stmt =~ s/(^|\n)./$1/g;
1166 my @stmt_lines = ($stmt =~ /\n/g);
1167 my @stmt_statements = ($stmt =~ /;/g);
1169 my $stmt_lines = $#stmt_lines + 2;
1170 my $stmt_statements = $#stmt_statements + 1;
1172 if ($stmt_lines > $stmt_statements) {
1175 return $stmt_statements;
1179 sub ctx_statement_full {
1180 my ($linenr, $remain, $off) = @_;
1181 my ($statement, $condition, $level);
1185 # Grab the first conditional/block pair.
1186 ($statement, $condition, $linenr, $remain, $off, $level) =
1187 ctx_statement_block($linenr, $remain, $off);
1188 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1189 push(@chunks, [ $condition, $statement ]);
1190 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1191 return ($level, $linenr, @chunks);
1194 # Pull in the following conditional/block pairs and see if they
1195 # could continue the statement.
1197 ($statement, $condition, $linenr, $remain, $off, $level) =
1198 ctx_statement_block($linenr, $remain, $off);
1199 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1200 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1202 push(@chunks, [ $condition, $statement ]);
1205 return ($level, $linenr, @chunks);
1209 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1211 my $start = $linenr - 1;
1218 my @stack = ($level);
1219 for ($line = $start; $remain > 0; $line++) {
1220 next if ($rawlines[$line] =~ /^-/);
1223 $blk .= $rawlines[$line];
1225 # Handle nested #if/#else.
1226 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1227 push(@stack, $level);
1228 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1229 $level = $stack[$#stack - 1];
1230 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1231 $level = pop(@stack);
1234 foreach my $c (split(//, $lines[$line])) {
1235 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1241 if ($c eq $close && $level > 0) {
1243 last if ($level == 0);
1244 } elsif ($c eq $open) {
1249 if (!$outer || $level <= 1) {
1250 push(@res, $rawlines[$line]);
1253 last if ($level == 0);
1256 return ($level, @res);
1258 sub ctx_block_outer {
1259 my ($linenr, $remain) = @_;
1261 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1265 my ($linenr, $remain) = @_;
1267 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1271 my ($linenr, $remain, $off) = @_;
1273 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1276 sub ctx_block_level {
1277 my ($linenr, $remain) = @_;
1279 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1281 sub ctx_statement_level {
1282 my ($linenr, $remain, $off) = @_;
1284 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1287 sub ctx_locate_comment {
1288 my ($first_line, $end_line) = @_;
1290 # Catch a comment on the end of the line itself.
1291 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1292 return $current_comment if (defined $current_comment);
1294 # Look through the context and try and figure out if there is a
1297 $current_comment = '';
1298 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1299 my $line = $rawlines[$linenr - 1];
1301 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1304 if ($line =~ m@/\*@) {
1307 if (!$in_comment && $current_comment ne '') {
1308 $current_comment = '';
1310 $current_comment .= $line . "\n" if ($in_comment);
1311 if ($line =~ m@\*/@) {
1316 chomp($current_comment);
1317 return($current_comment);
1319 sub ctx_has_comment {
1320 my ($first_line, $end_line) = @_;
1321 my $cmt = ctx_locate_comment($first_line, $end_line);
1323 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1324 ##print "CMMT: $cmt\n";
1326 return ($cmt ne '');
1330 my ($linenr, $cnt) = @_;
1332 my $offset = $linenr - 1;
1337 $line = $rawlines[$offset++];
1338 next if (defined($line) && $line =~ /^-/);
1350 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1353 $coded = sprintf("^%c", unpack('C', $2) + 64);
1362 my $av_preprocessor = 0;
1367 sub annotate_reset {
1368 $av_preprocessor = 0;
1370 @av_paren_type = ('E');
1371 $av_pend_colon = 'O';
1374 sub annotate_values {
1375 my ($stream, $type) = @_;
1378 my $var = '_' x length($stream);
1381 print "$stream\n" if ($dbg_values > 1);
1383 while (length($cur)) {
1384 @av_paren_type = ('E') if ($#av_paren_type < 0);
1385 print " <" . join('', @av_paren_type) .
1386 "> <$type> <$av_pending>" if ($dbg_values > 1);
1387 if ($cur =~ /^(\s+)/o) {
1388 print "WS($1)\n" if ($dbg_values > 1);
1389 if ($1 =~ /\n/ && $av_preprocessor) {
1390 $type = pop(@av_paren_type);
1391 $av_preprocessor = 0;
1394 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1395 print "CAST($1)\n" if ($dbg_values > 1);
1396 push(@av_paren_type, $type);
1399 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1400 print "DECLARE($1)\n" if ($dbg_values > 1);
1403 } elsif ($cur =~ /^($Modifier)\s*/) {
1404 print "MODIFIER($1)\n" if ($dbg_values > 1);
1407 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1408 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1409 $av_preprocessor = 1;
1410 push(@av_paren_type, $type);
1416 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1417 print "UNDEF($1)\n" if ($dbg_values > 1);
1418 $av_preprocessor = 1;
1419 push(@av_paren_type, $type);
1421 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1422 print "PRE_START($1)\n" if ($dbg_values > 1);
1423 $av_preprocessor = 1;
1425 push(@av_paren_type, $type);
1426 push(@av_paren_type, $type);
1429 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1430 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1431 $av_preprocessor = 1;
1433 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1437 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1438 print "PRE_END($1)\n" if ($dbg_values > 1);
1440 $av_preprocessor = 1;
1442 # Assume all arms of the conditional end as this
1443 # one does, and continue as if the #endif was not here.
1444 pop(@av_paren_type);
1445 push(@av_paren_type, $type);
1448 } elsif ($cur =~ /^(\\\n)/o) {
1449 print "PRECONT($1)\n" if ($dbg_values > 1);
1451 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1452 print "ATTR($1)\n" if ($dbg_values > 1);
1453 $av_pending = $type;
1456 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1457 print "SIZEOF($1)\n" if ($dbg_values > 1);
1463 } elsif ($cur =~ /^(if|while|for)\b/o) {
1464 print "COND($1)\n" if ($dbg_values > 1);
1468 } elsif ($cur =~/^(case)/o) {
1469 print "CASE($1)\n" if ($dbg_values > 1);
1470 $av_pend_colon = 'C';
1473 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1474 print "KEYWORD($1)\n" if ($dbg_values > 1);
1477 } elsif ($cur =~ /^(\()/o) {
1478 print "PAREN('$1')\n" if ($dbg_values > 1);
1479 push(@av_paren_type, $av_pending);
1483 } elsif ($cur =~ /^(\))/o) {
1484 my $new_type = pop(@av_paren_type);
1485 if ($new_type ne '_') {
1487 print "PAREN('$1') -> $type\n"
1488 if ($dbg_values > 1);
1490 print "PAREN('$1')\n" if ($dbg_values > 1);
1493 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1494 print "FUNC($1)\n" if ($dbg_values > 1);
1498 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1499 if (defined $2 && $type eq 'C' || $type eq 'T') {
1500 $av_pend_colon = 'B';
1501 } elsif ($type eq 'E') {
1502 $av_pend_colon = 'L';
1504 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1507 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1508 print "IDENT($1)\n" if ($dbg_values > 1);
1511 } elsif ($cur =~ /^($Assignment)/o) {
1512 print "ASSIGN($1)\n" if ($dbg_values > 1);
1515 } elsif ($cur =~/^(;|{|})/) {
1516 print "END($1)\n" if ($dbg_values > 1);
1518 $av_pend_colon = 'O';
1520 } elsif ($cur =~/^(,)/) {
1521 print "COMMA($1)\n" if ($dbg_values > 1);
1524 } elsif ($cur =~ /^(\?)/o) {
1525 print "QUESTION($1)\n" if ($dbg_values > 1);
1528 } elsif ($cur =~ /^(:)/o) {
1529 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1531 substr($var, length($res), 1, $av_pend_colon);
1532 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1537 $av_pend_colon = 'O';
1539 } elsif ($cur =~ /^(\[)/o) {
1540 print "CLOSE($1)\n" if ($dbg_values > 1);
1543 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1546 print "OPV($1)\n" if ($dbg_values > 1);
1553 substr($var, length($res), 1, $variant);
1556 } elsif ($cur =~ /^($Operators)/o) {
1557 print "OP($1)\n" if ($dbg_values > 1);
1558 if ($1 ne '++' && $1 ne '--') {
1562 } elsif ($cur =~ /(^.)/o) {
1563 print "C($1)\n" if ($dbg_values > 1);
1566 $cur = substr($cur, length($1));
1567 $res .= $type x length($1);
1571 return ($res, $var);
1575 my ($possible, $line) = @_;
1576 my $notPermitted = qr{(?:
1593 ^(?:typedef|struct|enum)\b
1595 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1596 if ($possible !~ $notPermitted) {
1597 # Check for modifiers.
1598 $possible =~ s/\s*$Storage\s*//g;
1599 $possible =~ s/\s*$Sparse\s*//g;
1600 if ($possible =~ /^\s*$/) {
1602 } elsif ($possible =~ /\s/) {
1603 $possible =~ s/\s*$Type\s*//g;
1604 for my $modifier (split(' ', $possible)) {
1605 if ($modifier !~ $notPermitted) {
1606 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1607 push(@modifierList, $modifier);
1612 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1613 push(@typeList, $possible);
1617 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1626 return defined $use_type{$type} if (scalar keys %use_type > 0);
1628 return !defined $ignore_type{$type};
1632 my ($level, $type, $msg) = @_;
1634 if (!show_type($type) ||
1635 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
1640 $line = "$prefix$level:$type: $msg\n";
1642 $line = "$prefix$level: $msg\n";
1644 $line = (split('\n', $line))[0] . "\n" if ($terse);
1646 push(our @report, $line);
1655 sub fixup_current_range {
1656 my ($lineRef, $offset, $length) = @_;
1658 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1661 my $no = $o + $offset;
1662 my $nl = $l + $length;
1663 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1667 sub fix_inserted_deleted_lines {
1668 my ($linesRef, $insertedRef, $deletedRef) = @_;
1670 my $range_last_linenr = 0;
1671 my $delta_offset = 0;
1676 my $next_insert = 0;
1677 my $next_delete = 0;
1681 my $inserted = @{$insertedRef}[$next_insert++];
1682 my $deleted = @{$deletedRef}[$next_delete++];
1684 foreach my $old_line (@{$linesRef}) {
1686 my $line = $old_line; #don't modify the array
1687 if ($line =~ /^(?:\+\+\+\|\-\-\-)\s+\S+/) { #new filename
1689 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1690 $range_last_linenr = $new_linenr;
1691 fixup_current_range(\$line, $delta_offset, 0);
1694 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1695 $deleted = @{$deletedRef}[$next_delete++];
1697 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1700 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1701 push(@lines, ${$inserted}{'LINE'});
1702 $inserted = @{$insertedRef}[$next_insert++];
1704 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1708 push(@lines, $line);
1718 sub fix_insert_line {
1719 my ($linenr, $line) = @_;
1725 push(@fixed_inserted, $inserted);
1728 sub fix_delete_line {
1729 my ($linenr, $line) = @_;
1736 push(@fixed_deleted, $deleted);
1740 my ($type, $msg) = @_;
1742 if (report("ERROR", $type, $msg)) {
1750 my ($type, $msg) = @_;
1752 if (report("WARNING", $type, $msg)) {
1760 my ($type, $msg) = @_;
1762 if ($check && report("CHECK", $type, $msg)) {
1770 sub check_absolute_file {
1771 my ($absolute, $herecurr) = @_;
1772 my $file = $absolute;
1774 ##print "absolute<$absolute>\n";
1776 # See if any suffix of this path is a path within the tree.
1777 while ($file =~ s@^[^/]*/@@) {
1778 if (-f "$root/$file") {
1779 ##print "file<$file>\n";
1787 # It is, so see if the prefix is acceptable.
1788 my $prefix = $absolute;
1789 substr($prefix, -length($file)) = '';
1791 ##print "prefix<$prefix>\n";
1792 if ($prefix ne ".../") {
1793 WARN("USE_RELATIVE_PATH",
1794 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1801 $string =~ s/^\s+|\s+$//g;
1809 $string =~ s/^\s+//;
1817 $string =~ s/\s+$//;
1822 sub string_find_replace {
1823 my ($string, $find, $replace) = @_;
1825 $string =~ s/$find/$replace/g;
1833 my $source_indent = 8;
1834 my $max_spaces_before_tab = $source_indent - 1;
1835 my $spaces_to_tab = " " x $source_indent;
1837 #convert leading spaces to tabs
1838 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1839 #Remove spaces before a tab
1840 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1845 sub pos_last_openparen {
1850 my $opens = $line =~ tr/\(/\(/;
1851 my $closes = $line =~ tr/\)/\)/;
1853 my $last_openparen = 0;
1855 if (($opens == 0) || ($closes >= $opens)) {
1859 my $len = length($line);
1861 for ($pos = 0; $pos < $len; $pos++) {
1862 my $string = substr($line, $pos);
1863 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1864 $pos += length($1) - 1;
1865 } elsif (substr($line, $pos, 1) eq '(') {
1866 $last_openparen = $pos;
1867 } elsif (index($string, '(') == -1) {
1872 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
1876 my $filename = shift;
1882 my $stashrawline="";
1893 my $in_header_lines = $file ? 0 : 1;
1894 my $in_commit_log = 0; #Scanning lines before patch
1895 my $reported_maintainer_file = 0;
1896 my $non_utf8_charset = 0;
1898 my $last_blank_line = 0;
1899 my $last_coalesced_string_linenr = -1;
1907 # Trace the real file/line as we go.
1913 my $comment_edge = 0;
1917 my $prev_values = 'E';
1920 my %suppress_ifbraces;
1921 my %suppress_whiletrailers;
1922 my %suppress_export;
1923 my $suppress_statement = 0;
1925 my %signatures = ();
1927 # Pre-scan the patch sanitizing the lines.
1928 # Pre-scan the patch looking for any __setup documentation.
1930 my @setup_docs = ();
1933 my $camelcase_file_seeded = 0;
1935 sanitise_line_reset();
1937 foreach my $rawline (@rawlines) {
1941 push(@fixed, $rawline) if ($fix);
1943 if ($rawline=~/^\+\+\+\s+(\S+)/) {
1945 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1950 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1959 # Guestimate if this is a continuing comment. Run
1960 # the context looking for a comment "edge". If this
1961 # edge is a close comment then we must be in a comment
1965 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1966 next if (defined $rawlines[$ln - 1] &&
1967 $rawlines[$ln - 1] =~ /^-/);
1969 #print "RAW<$rawlines[$ln - 1]>\n";
1970 last if (!defined $rawlines[$ln - 1]);
1971 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1972 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1977 if (defined $edge && $edge eq '*/') {
1981 # Guestimate if this is a continuing comment. If this
1982 # is the start of a diff block and this line starts
1983 # ' *' then it is very likely a comment.
1984 if (!defined $edge &&
1985 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1990 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1991 sanitise_line_reset($in_comment);
1993 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1994 # Standardise the strings and chars within the input to
1995 # simplify matching -- only bother with positive lines.
1996 $line = sanitise_line($rawline);
1998 push(@lines, $line);
2001 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2006 #print "==>$rawline\n";
2007 #print "-->$line\n";
2009 if ($setup_docs && $line =~ /^\+/) {
2010 push(@setup_docs, $line);
2019 foreach my $line (@lines) {
2022 my $sline = $line; #copy of $line
2023 $sline =~ s/$;/ /g; #with comments as spaces
2025 my $rawline = $rawlines[$linenr - 1];
2027 #extract the line range in the file after the patch is applied
2028 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2030 $first_line = $linenr + 1;
2040 %suppress_ifbraces = ();
2041 %suppress_whiletrailers = ();
2042 %suppress_export = ();
2043 $suppress_statement = 0;
2046 # track the line number as we move through the hunk, note that
2047 # new versions of GNU diff omit the leading space on completely
2048 # blank context lines so we need to count that too.
2049 } elsif ($line =~ /^( |\+|$)/) {
2051 $realcnt-- if ($realcnt != 0);
2053 # Measure the line length and indent.
2054 ($length, $indent) = line_stats($rawline);
2056 # Track the previous line.
2057 ($prevline, $stashline) = ($stashline, $line);
2058 ($previndent, $stashindent) = ($stashindent, $indent);
2059 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2061 #warn "line<$line>\n";
2063 } elsif ($realcnt == 1) {
2067 my $hunk_line = ($realcnt != 0);
2069 #make up the handle for any error we report on this line
2070 $prefix = "$filename:$realline: " if ($emacs && $file);
2071 $prefix = "$filename:$linenr: " if ($emacs && !$file);
2073 $here = "#$linenr: " if (!$file);
2074 $here = "#$realline: " if ($file);
2077 # extract the filename as it passes
2078 if ($line =~ /^diff --git.*?(\S+)$/) {
2080 $realfile =~ s@^([^/]*)/@@ if (!$file);
2083 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2085 $realfile =~ s@^([^/]*)/@@ if (!$file);
2089 if (!$file && $tree && $p1_prefix ne '' &&
2090 -e "$root/$p1_prefix") {
2091 WARN("PATCH_PREFIX",
2092 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
2095 if ($realfile =~ m@^include/asm/@) {
2096 ERROR("MODIFIED_INCLUDE_ASM",
2097 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2103 if ($realfile =~ m@^(drivers/net/|net/)@) {
2106 $check = $check_orig;
2111 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
2113 my $hereline = "$here\n$rawline\n";
2114 my $herecurr = "$here\n$rawline\n";
2115 my $hereprev = "$here\n$prevrawline\n$rawline\n";
2117 $cnt_lines++ if ($realcnt != 0);
2119 # Check for incorrect file permissions
2120 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2121 my $permhere = $here . "FILE: $realfile\n";
2122 if ($realfile !~ m@scripts/@ &&
2123 $realfile !~ /\.(py|pl|awk|sh)$/) {
2124 ERROR("EXECUTE_PERMISSIONS",
2125 "do not set execute permissions for source files\n" . $permhere);
2129 # Check the patch for a signoff:
2130 if ($line =~ /^\s*signed-off-by:/i) {
2135 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2136 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2137 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2138 $reported_maintainer_file = 1;
2141 # Check signature styles
2142 if (!$in_header_lines &&
2143 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
2144 my $space_before = $1;
2146 my $space_after = $3;
2148 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2150 if ($sign_off !~ /$signature_tags/) {
2151 WARN("BAD_SIGN_OFF",
2152 "Non-standard signature: $sign_off\n" . $herecurr);
2154 if (defined $space_before && $space_before ne "") {
2155 if (WARN("BAD_SIGN_OFF",
2156 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2158 $fixed[$fixlinenr] =
2159 "$ucfirst_sign_off $email";
2162 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
2163 if (WARN("BAD_SIGN_OFF",
2164 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2166 $fixed[$fixlinenr] =
2167 "$ucfirst_sign_off $email";
2171 if (!defined $space_after || $space_after ne " ") {
2172 if (WARN("BAD_SIGN_OFF",
2173 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2175 $fixed[$fixlinenr] =
2176 "$ucfirst_sign_off $email";
2180 my ($email_name, $email_address, $comment) = parse_email($email);
2181 my $suggested_email = format_email(($email_name, $email_address));
2182 if ($suggested_email eq "") {
2183 ERROR("BAD_SIGN_OFF",
2184 "Unrecognized email address: '$email'\n" . $herecurr);
2186 my $dequoted = $suggested_email;
2187 $dequoted =~ s/^"//;
2188 $dequoted =~ s/" </ </;
2189 # Don't force email to have quotes
2190 # Allow just an angle bracketed address
2191 if ("$dequoted$comment" ne $email &&
2192 "<$email_address>$comment" ne $email &&
2193 "$suggested_email$comment" ne $email) {
2194 WARN("BAD_SIGN_OFF",
2195 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
2199 # Check for duplicate signatures
2200 my $sig_nospace = $line;
2201 $sig_nospace =~ s/\s//g;
2202 $sig_nospace = lc($sig_nospace);
2203 if (defined $signatures{$sig_nospace}) {
2204 WARN("BAD_SIGN_OFF",
2205 "Duplicate signature\n" . $herecurr);
2207 $signatures{$sig_nospace} = 1;
2211 # Check email subject for common tools that don't need to be mentioned
2212 if ($in_header_lines &&
2213 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2214 WARN("EMAIL_SUBJECT",
2215 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2218 # Check for old stable address
2219 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2220 ERROR("STABLE_ADDRESS",
2221 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2224 # Check for unwanted Gerrit info
2225 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2226 ERROR("GERRIT_CHANGE_ID",
2227 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2230 # Check for git id commit length and improperly formed commit descriptions
2231 if ($in_commit_log && $line =~ /\b(c)ommit\s+([0-9a-f]{5,})/i) {
2233 my $orig_commit = lc($2);
2240 my $id = '0123456789ab';
2241 my $orig_desc = "commit description";
2242 my $description = "";
2244 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2245 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2246 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2247 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2248 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2251 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2252 defined $rawlines[$linenr] &&
2253 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2256 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2257 defined $rawlines[$linenr] &&
2258 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2259 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2261 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2262 $orig_desc .= " " . $1;
2266 ($id, $description) = git_commit_info($orig_commit,
2269 if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) {
2270 ERROR("GIT_COMMIT_ID",
2271 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2275 # Check for added, moved or deleted files
2276 if (!$reported_maintainer_file && !$in_commit_log &&
2277 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2278 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2279 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2280 (defined($1) || defined($2))))) {
2281 $reported_maintainer_file = 1;
2282 WARN("FILE_PATH_CHANGES",
2283 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2286 # Check for wrappage within a valid hunk of the file
2287 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
2288 ERROR("CORRUPTED_PATCH",
2289 "patch seems to be corrupt (line wrapped?)\n" .
2290 $herecurr) if (!$emitted_corrupt++);
2293 # Check for absolute kernel paths.
2295 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2298 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2299 check_absolute_file($1, $herecurr)) {
2302 check_absolute_file($file, $herecurr);
2307 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2308 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
2309 $rawline !~ m/^$UTF8*$/) {
2310 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2312 my $blank = copy_spacing($rawline);
2313 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2314 my $hereptr = "$hereline$ptr\n";
2317 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
2320 # Check if it's the start of a commit log
2321 # (not a header line and we haven't seen the patch filename)
2322 if ($in_header_lines && $realfile =~ /^$/ &&
2323 !($rawline =~ /^\s+\S/ ||
2324 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
2325 $in_header_lines = 0;
2329 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2330 # declined it, i.e defined some charset where it is missing.
2331 if ($in_header_lines &&
2332 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2334 $non_utf8_charset = 1;
2337 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
2338 $rawline =~ /$NON_ASCII_UTF8/) {
2339 WARN("UTF8_BEFORE_PATCH",
2340 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2343 # Check for various typo / spelling mistakes
2344 if (defined($misspellings) &&
2345 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
2346 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
2348 my $typo_fix = $spelling_fix{lc($typo)};
2349 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2350 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2351 my $msg_type = \&WARN;
2352 $msg_type = \&CHK if ($file);
2353 if (&{$msg_type}("TYPO_SPELLING",
2354 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2356 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2361 # ignore non-hunk lines and lines being removed
2362 next if (!$hunk_line || $line =~ /^-/);
2364 #trailing whitespace
2365 if ($line =~ /^\+.*\015/) {
2366 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2367 if (ERROR("DOS_LINE_ENDINGS",
2368 "DOS line endings\n" . $herevet) &&
2370 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
2372 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2373 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2374 if (ERROR("TRAILING_WHITESPACE",
2375 "trailing whitespace\n" . $herevet) &&
2377 $fixed[$fixlinenr] =~ s/\s+$//;
2383 # Check for FSF mailing addresses.
2384 if ($rawline =~ /\bwrite to the Free/i ||
2385 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2386 $rawline =~ /\b51\s+Franklin\s+St/i) {
2387 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2388 my $msg_type = \&ERROR;
2389 $msg_type = \&CHK if ($file);
2390 &{$msg_type}("FSF_MAILING_ADDRESS",
2391 "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)
2394 # check for Kconfig help text having a real description
2395 # Only applies when adding the entry originally, after that we do not have
2396 # sufficient context to determine whether it is indeed long enough.
2397 if ($realfile =~ /Kconfig/ &&
2398 $line =~ /^\+\s*config\s+/) {
2401 my $ln = $linenr + 1;
2405 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
2406 $f = $lines[$ln - 1];
2407 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2408 $is_end = $lines[$ln - 1] =~ /^\+/;
2410 next if ($f =~ /^-/);
2411 last if (!$file && $f =~ /^\@\@/);
2413 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
2415 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
2422 next if ($f =~ /^$/);
2423 if ($f =~ /^\s*config\s/) {
2429 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2430 WARN("CONFIG_DESCRIPTION",
2431 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2433 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2436 # discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2437 if ($realfile =~ /Kconfig/ &&
2438 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2439 WARN("CONFIG_EXPERIMENTAL",
2440 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2443 # discourage the use of boolean for type definition attributes of Kconfig options
2444 if ($realfile =~ /Kconfig/ &&
2445 $line =~ /^\+\s*\bboolean\b/) {
2446 WARN("CONFIG_TYPE_BOOLEAN",
2447 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2450 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2451 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2454 'EXTRA_AFLAGS' => 'asflags-y',
2455 'EXTRA_CFLAGS' => 'ccflags-y',
2456 'EXTRA_CPPFLAGS' => 'cppflags-y',
2457 'EXTRA_LDFLAGS' => 'ldflags-y',
2460 WARN("DEPRECATED_VARIABLE",
2461 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2464 # check for DT compatible documentation
2465 if (defined $root &&
2466 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2467 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2469 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2471 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2472 my $vp_file = $dt_path . "vendor-prefixes.txt";
2474 foreach my $compat (@compats) {
2475 my $compat2 = $compat;
2476 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2477 my $compat3 = $compat;
2478 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2479 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
2481 WARN("UNDOCUMENTED_DT_STRING",
2482 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2485 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2487 `grep -Eq "^$vendor\\b" $vp_file`;
2489 WARN("UNDOCUMENTED_DT_STRING",
2490 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2495 # check we are in a valid source file if not then ignore this hunk
2496 next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/);
2499 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
2500 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
2501 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
2502 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
2503 $length > $max_line_length)
2506 "line over $max_line_length characters\n" . $herecurr);
2509 # check for adding lines without a newline.
2510 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2511 WARN("MISSING_EOF_NEWLINE",
2512 "adding a line without newline at end of file\n" . $herecurr);
2515 # Blackfin: use hi/lo macros
2516 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2517 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2518 my $herevet = "$here\n" . cat_vet($line) . "\n";
2520 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
2522 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2523 my $herevet = "$here\n" . cat_vet($line) . "\n";
2525 "use the HI() macro, not (... >> 16)\n" . $herevet);
2529 # check we are in a valid source file C or perl if not then ignore this hunk
2530 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
2532 # at the beginning of a line any tabs must come first and anything
2533 # more than 8 must use tabs.
2534 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2535 $rawline =~ /^\+\s* \s*/) {
2536 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2538 if (ERROR("CODE_INDENT",
2539 "code indent should use tabs where possible\n" . $herevet) &&
2541 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2545 # check for space before tabs.
2546 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2547 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2548 if (WARN("SPACE_BEFORE_TAB",
2549 "please, no space before tabs\n" . $herevet) &&
2551 while ($fixed[$fixlinenr] =~
2552 s/(^\+.*) {8,8}\t/$1\t\t/) {}
2553 while ($fixed[$fixlinenr] =~
2554 s/(^\+.*) +\t/$1\t/) {}
2558 # check for && or || at the start of a line
2559 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2560 CHK("LOGICAL_CONTINUATIONS",
2561 "Logical continuations should be on the previous line\n" . $hereprev);
2564 # check multi-line statement indentation matches previous line
2565 if ($^V && $^V ge 5.10.0 &&
2566 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2567 $prevline =~ /^\+(\t*)(.*)$/;
2571 my $pos = pos_last_openparen($rest);
2573 $line =~ /^(\+| )([ \t]*)/;
2576 my $goodtabindent = $oldindent .
2579 my $goodspaceindent = $oldindent . " " x $pos;
2581 if ($newindent ne $goodtabindent &&
2582 $newindent ne $goodspaceindent) {
2584 if (CHK("PARENTHESIS_ALIGNMENT",
2585 "Alignment should match open parenthesis\n" . $hereprev) &&
2586 $fix && $line =~ /^\+/) {
2587 $fixed[$fixlinenr] =~
2588 s/^\+[ \t]*/\+$goodtabindent/;
2594 # check for space after cast like "(int) foo" or "(struct foo) bar"
2595 # avoid checking a few false positives:
2596 # "sizeof(<type>)" or "__alignof__(<type>)"
2597 # function pointer declarations like "(*foo)(int) = bar;"
2598 # structure definitions like "(struct foo) { 0 };"
2599 # multiline macros that define functions
2600 # known attributes or the __attribute__ keyword
2601 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
2602 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
2604 "No space is necessary after a cast\n" . $herecurr) &&
2606 $fixed[$fixlinenr] =~
2607 s/(\(\s*$Type\s*\))[ \t]+/$1/;
2611 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2612 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
2613 $rawline =~ /^\+[ \t]*\*/ &&
2615 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2616 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2619 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2620 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2621 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
2622 $rawline =~ /^\+/ && #line is new
2623 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2624 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2625 "networking block comments start with * on subsequent lines\n" . $hereprev);
2628 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2629 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2630 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2631 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2632 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
2633 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2634 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2637 # check for missing blank lines after struct/union declarations
2638 # with exceptions for various attributes and macros
2639 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2641 !($line =~ /^\+\s*$/ ||
2642 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2643 $line =~ /^\+\s*MODULE_/i ||
2644 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2645 $line =~ /^\+[a-z_]*init/ ||
2646 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2647 $line =~ /^\+\s*DECLARE/ ||
2648 $line =~ /^\+\s*__setup/)) {
2649 if (CHK("LINE_SPACING",
2650 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
2652 fix_insert_line($fixlinenr, "\+");
2656 # check for multiple consecutive blank lines
2657 if ($prevline =~ /^[\+ ]\s*$/ &&
2658 $line =~ /^\+\s*$/ &&
2659 $last_blank_line != ($linenr - 1)) {
2660 if (CHK("LINE_SPACING",
2661 "Please don't use multiple blank lines\n" . $hereprev) &&
2663 fix_delete_line($fixlinenr, $rawline);
2666 $last_blank_line = $linenr;
2669 # check for missing blank lines after declarations
2670 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2671 # actual declarations
2672 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2673 # function pointer declarations
2674 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2675 # foo bar; where foo is some local typedef or #define
2676 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2677 # known declaration macros
2678 $prevline =~ /^\+\s+$declaration_macros/) &&
2679 # for "else if" which can look like "$Ident $Ident"
2680 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2681 # other possible extensions of declaration lines
2682 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2683 # not starting a section or a macro "\" extended line
2684 $prevline =~ /(?:\{\s*|\\)$/) &&
2685 # looks like a declaration
2686 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2687 # function pointer declarations
2688 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2689 # foo bar; where foo is some local typedef or #define
2690 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2691 # known declaration macros
2692 $sline =~ /^\+\s+$declaration_macros/ ||
2693 # start of struct or union or enum
2694 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
2695 # start or end of block or continuation of declaration
2696 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
2697 # bitfield continuation
2698 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
2699 # other possible extensions of declaration lines
2700 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
2701 # indentation of previous and current line are the same
2702 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
2703 if (WARN("LINE_SPACING",
2704 "Missing a blank line after declarations\n" . $hereprev) &&
2706 fix_insert_line($fixlinenr, "\+");
2710 # check for spaces at the beginning of a line.
2712 # 1) within comments
2713 # 2) indented preprocessor commands
2715 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
2716 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2717 if (WARN("LEADING_SPACE",
2718 "please, no spaces at the start of a line\n" . $herevet) &&
2720 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2724 # check we are in a valid C source file if not then ignore this hunk
2725 next if ($realfile !~ /\.(h|c)$/);
2727 # check indentation of any line with a bare else
2728 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
2729 # if the previous line is a break or return and is indented 1 tab more...
2730 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
2731 my $tabs = length($1) + 1;
2732 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
2733 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
2734 defined $lines[$linenr] &&
2735 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
2736 WARN("UNNECESSARY_ELSE",
2737 "else is not generally useful after a break or return\n" . $hereprev);
2741 # check indentation of a line with a break;
2742 # if the previous line is a goto or return and is indented the same # of tabs
2743 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
2745 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
2746 WARN("UNNECESSARY_BREAK",
2747 "break is not useful after a goto or return\n" . $hereprev);
2751 # discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2752 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2753 WARN("CONFIG_EXPERIMENTAL",
2754 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2757 # check for RCS/CVS revision markers
2758 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
2760 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
2763 # Blackfin: don't use __builtin_bfin_[cs]sync
2764 if ($line =~ /__builtin_bfin_csync/) {
2765 my $herevet = "$here\n" . cat_vet($line) . "\n";
2767 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
2769 if ($line =~ /__builtin_bfin_ssync/) {
2770 my $herevet = "$here\n" . cat_vet($line) . "\n";
2772 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
2775 # check for old HOTPLUG __dev<foo> section markings
2776 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2777 WARN("HOTPLUG_SECTION",
2778 "Using $1 is unnecessary\n" . $herecurr);
2781 # Check for potential 'bare' types
2782 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2784 #print "LINE<$line>\n";
2785 if ($linenr >= $suppress_statement &&
2786 $realcnt && $sline =~ /.\s*\S/) {
2787 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2788 ctx_statement_block($linenr, $realcnt, 0);
2789 $stat =~ s/\n./\n /g;
2790 $cond =~ s/\n./\n /g;
2792 #print "linenr<$linenr> <$stat>\n";
2793 # If this statement has no statement boundaries within
2794 # it there is no point in retrying a statement scan
2795 # until we hit end of it.
2796 my $frag = $stat; $frag =~ s/;+\s*$//;
2797 if ($frag !~ /(?:{|;)/) {
2798 #print "skip<$line_nr_next>\n";
2799 $suppress_statement = $line_nr_next;
2802 # Find the real next line.
2803 $realline_next = $line_nr_next;
2804 if (defined $realline_next &&
2805 (!defined $lines[$realline_next - 1] ||
2806 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2813 # Ignore goto labels.
2814 if ($s =~ /$Ident:\*$/s) {
2816 # Ignore functions being called
2817 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
2819 } elsif ($s =~ /^.\s*else\b/s) {
2821 # declarations always start with types
2822 } 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) {
2825 possible($type, "A:" . $s);
2827 # definitions in global scope can only start with types
2828 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
2829 possible($1, "B:" . $s);
2832 # any (foo ... *) is a pointer cast, and foo is a type
2833 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
2834 possible($1, "C:" . $s);
2837 # Check for any sort of function declaration.
2838 # int foo(something bar, other baz);
2839 # void (*store_gdt)(x86_descr_ptr *);
2840 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
2841 my ($name_len) = length($1);
2844 substr($ctx, 0, $name_len + 1, '');
2845 $ctx =~ s/\)[^\)]*$//;
2847 for my $arg (split(/\s*,\s*/, $ctx)) {
2848 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
2850 possible($1, "D:" . $s);
2858 # Checks which may be anchored in the context.
2861 # Check for switch () and associated case and default
2862 # statements should be at the same indent.
2863 if ($line=~/\bswitch\s*\(.*\)/) {
2866 my @ctx = ctx_block_outer($linenr, $realcnt);
2868 for my $ctx (@ctx) {
2869 my ($clen, $cindent) = line_stats($ctx);
2870 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2871 $indent != $cindent) {
2872 $err .= "$sep$ctx\n";
2879 ERROR("SWITCH_CASE_INDENT_LEVEL",
2880 "switch and case should be at the same indent\n$hereline$err");
2884 # if/while/etc brace do not go on next line, unless defining a do while loop,
2885 # or if that brace on the next line is for something else
2886 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
2887 my $pre_ctx = "$1$2";
2889 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
2891 if ($line =~ /^\+\t{6,}/) {
2892 WARN("DEEP_INDENTATION",
2893 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2896 my $ctx_cnt = $realcnt - $#ctx - 1;
2897 my $ctx = join("\n", @ctx);
2899 my $ctx_ln = $linenr;
2900 my $ctx_skip = $realcnt;
2902 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2903 defined $lines[$ctx_ln - 1] &&
2904 $lines[$ctx_ln - 1] =~ /^-/)) {
2905 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2906 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
2910 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2911 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
2913 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
2915 "that open brace { should be on the previous line\n" .
2916 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2918 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2919 $ctx =~ /\)\s*\;\s*$/ &&
2920 defined $lines[$ctx_ln - 1])
2922 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2923 if ($nindent > $indent) {
2924 WARN("TRAILING_SEMICOLON",
2925 "trailing semicolon indicates no statements, indent implies otherwise\n" .
2926 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2931 # Check relative indent for conditionals and blocks.
2932 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2933 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2934 ctx_statement_block($linenr, $realcnt, 0)
2935 if (!defined $stat);
2936 my ($s, $c) = ($stat, $cond);
2938 substr($s, 0, length($c), '');
2940 # Make sure we remove the line prefixes as we have
2941 # none on the first line, and are going to readd them
2945 # Find out how long the conditional actually is.
2946 my @newlines = ($c =~ /\n/gs);
2947 my $cond_lines = 1 + $#newlines;
2949 # We want to check the first line inside the block
2950 # starting at the end of the conditional, so remove:
2951 # 1) any blank line termination
2952 # 2) any opening brace { on end of the line
2954 my $continuation = 0;
2956 $s =~ s/^.*\bdo\b//;
2958 if ($s =~ s/^\s*\\//) {
2961 if ($s =~ s/^\s*?\n//) {
2966 # Also ignore a loop construct at the end of a
2967 # preprocessor statement.
2968 if (($prevline =~ /^.\s*#\s*define\s/ ||
2969 $prevline =~ /\\\s*$/) && $continuation == 0) {
2975 while ($cond_ptr != $cond_lines) {
2976 $cond_ptr = $cond_lines;
2978 # If we see an #else/#elif then the code
2980 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2985 # 1) blank lines, they should be at 0,
2986 # 2) preprocessor lines, and
2988 if ($continuation ||
2990 $s =~ /^\s*#\s*?/ ||
2991 $s =~ /^\s*$Ident\s*:/) {
2992 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
2993 if ($s =~ s/^.*?\n//) {
2999 my (undef, $sindent) = line_stats("+" . $s);
3000 my $stat_real = raw_line($linenr, $cond_lines);
3002 # Check if either of these lines are modified, else
3003 # this is not this patch's fault.
3004 if (!defined($stat_real) ||
3005 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3008 if (defined($stat_real) && $cond_lines > 1) {
3009 $stat_real = "[...]\n$stat_real";
3012 #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";
3014 if ($check && (($sindent % 8) != 0 ||
3015 ($sindent <= $indent && $s ne ''))) {
3016 WARN("SUSPECT_CODE_INDENT",
3017 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3021 # Track the 'values' across context and added lines.
3022 my $opline = $line; $opline =~ s/^./ /;
3023 my ($curr_values, $curr_vars) =
3024 annotate_values($opline . "\n", $prev_values);
3025 $curr_values = $prev_values . $curr_values;
3027 my $outline = $opline; $outline =~ s/\t/ /g;
3028 print "$linenr > .$outline\n";
3029 print "$linenr > $curr_values\n";
3030 print "$linenr > $curr_vars\n";
3032 $prev_values = substr($curr_values, -1);
3034 #ignore lines not being added
3035 next if ($line =~ /^[^\+]/);
3037 # TEST: allow direct testing of the type matcher.
3039 if ($line =~ /^.\s*$Declare\s*$/) {
3041 "TEST: is type\n" . $herecurr);
3042 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
3043 ERROR("TEST_NOT_TYPE",
3044 "TEST: is not type ($1 is)\n". $herecurr);
3048 # TEST: allow direct testing of the attribute matcher.
3050 if ($line =~ /^.\s*$Modifier\s*$/) {
3052 "TEST: is attr\n" . $herecurr);
3053 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
3054 ERROR("TEST_NOT_ATTR",
3055 "TEST: is not attr ($1 is)\n". $herecurr);
3060 # check for initialisation to aggregates open brace on the next line
3061 if ($line =~ /^.\s*{/ &&
3062 $prevline =~ /(?:^|[^=])=\s*$/) {
3063 if (ERROR("OPEN_BRACE",
3064 "that open brace { should be on the previous line\n" . $hereprev) &&
3065 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3066 fix_delete_line($fixlinenr - 1, $prevrawline);
3067 fix_delete_line($fixlinenr, $rawline);
3068 my $fixedline = $prevrawline;
3069 $fixedline =~ s/\s*=\s*$/ = {/;
3070 fix_insert_line($fixlinenr, $fixedline);
3072 $fixedline =~ s/^(.\s*){\s*/$1/;
3073 fix_insert_line($fixlinenr, $fixedline);
3078 # Checks which are anchored on the added line.
3081 # check for malformed paths in #include statements (uses RAW line)
3082 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
3084 if ($path =~ m{//}) {
3085 ERROR("MALFORMED_INCLUDE",
3086 "malformed #include filename\n" . $herecurr);
3088 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3089 ERROR("UAPI_INCLUDE",
3090 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
3094 # no C99 // comments
3095 if ($line =~ m{//}) {
3096 if (ERROR("C99_COMMENTS",
3097 "do not use C99 // comments\n" . $herecurr) &&
3099 my $line = $fixed[$fixlinenr];
3100 if ($line =~ /\/\/(.*)$/) {
3101 my $comment = trim($1);
3102 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
3106 # Remove C99 comments.
3108 $opline =~ s@//.*@@;
3110 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3111 # the whole statement.
3112 #print "APW <$lines[$realline_next - 1]>\n";
3113 if (defined $realline_next &&
3114 exists $lines[$realline_next - 1] &&
3115 !defined $suppress_export{$realline_next} &&
3116 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3117 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3118 # Handle definitions which produce identifiers with
3121 # EXPORT_SYMBOL(something_foo);
3123 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
3124 $name =~ /^${Ident}_$2/) {
3125 #print "FOO C name<$name>\n";
3126 $suppress_export{$realline_next} = 1;
3128 } elsif ($stat !~ /(?:
3130 ^.DEFINE_$Ident\(\Q$name\E\)|
3131 ^.DECLARE_$Ident\(\Q$name\E\)|
3132 ^.LIST_HEAD\(\Q$name\E\)|
3133 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3134 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
3136 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3137 $suppress_export{$realline_next} = 2;
3139 $suppress_export{$realline_next} = 1;
3142 if (!defined $suppress_export{$linenr} &&
3143 $prevline =~ /^.\s*$/ &&
3144 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3145 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3146 #print "FOO B <$lines[$linenr - 1]>\n";
3147 $suppress_export{$linenr} = 2;
3149 if (defined $suppress_export{$linenr} &&
3150 $suppress_export{$linenr} == 2) {
3151 WARN("EXPORT_SYMBOL",
3152 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
3155 # check for global initialisers.
3156 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
3157 if (ERROR("GLOBAL_INITIALISERS",
3158 "do not initialise globals to 0 or NULL\n" .
3161 $fixed[$fixlinenr] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
3164 # check for static initialisers.
3165 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
3166 if (ERROR("INITIALISED_STATIC",
3167 "do not initialise statics to 0 or NULL\n" .
3170 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
3174 # check for misordered declarations of char/short/int/long with signed/unsigned
3175 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3177 WARN("MISORDERED_TYPE",
3178 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3181 # check for static const char * arrays.
3182 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
3183 WARN("STATIC_CONST_CHAR_ARRAY",
3184 "static const char * array should probably be static const char * const\n" .
3188 # check for static char foo[] = "bar" declarations.
3189 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
3190 WARN("STATIC_CONST_CHAR_ARRAY",
3191 "static char array declaration should probably be static const char\n" .
3195 # check for non-global char *foo[] = {"bar", ...} declarations.
3196 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3197 WARN("STATIC_CONST_CHAR_ARRAY",
3198 "char * array declaration might be better as static const\n" .
3202 # check for function declarations without arguments like "int foo()"
3203 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3204 if (ERROR("FUNCTION_WITHOUT_ARGS",
3205 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3207 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
3211 # check for uses of DEFINE_PCI_DEVICE_TABLE
3212 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
3213 if (WARN("DEFINE_PCI_DEVICE_TABLE",
3214 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
3216 $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
3220 # check for new typedefs, only function parameters and sparse annotations
3222 if ($line =~ /\btypedef\s/ &&
3223 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
3224 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
3225 $line !~ /\b$typeTypedefs\b/ &&
3226 $line !~ /\b$typeOtherOSTypedefs\b/ &&
3227 $line !~ /\b__bitwise(?:__|)\b/) {
3228 WARN("NEW_TYPEDEFS",
3229 "do not add new typedefs\n" . $herecurr);
3232 # * goes on variable not on type
3234 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3236 my ($ident, $from, $to) = ($1, $2, $2);
3238 # Should start with a space.
3239 $to =~ s/^(\S)/ $1/;
3240 # Should not end with a space.
3242 # '*'s should not have spaces between.
3243 while ($to =~ s/\*\s+\*/\*\*/) {
3246 ## print "1: from<$from> to<$to> ident<$ident>\n";
3248 if (ERROR("POINTER_LOCATION",
3249 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3251 my $sub_from = $ident;
3252 my $sub_to = $ident;
3253 $sub_to =~ s/\Q$from\E/$to/;
3254 $fixed[$fixlinenr] =~
3255 s@\Q$sub_from\E@$sub_to@;
3259 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3261 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
3263 # Should start with a space.
3264 $to =~ s/^(\S)/ $1/;
3265 # Should not end with a space.
3267 # '*'s should not have spaces between.
3268 while ($to =~ s/\*\s+\*/\*\*/) {
3270 # Modifiers should have spaces.
3271 $to =~ s/(\b$Modifier$)/$1 /;
3273 ## print "2: from<$from> to<$to> ident<$ident>\n";
3274 if ($from ne $to && $ident !~ /^$Modifier$/) {
3275 if (ERROR("POINTER_LOCATION",
3276 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3279 my $sub_from = $match;
3280 my $sub_to = $match;
3281 $sub_to =~ s/\Q$from\E/$to/;
3282 $fixed[$fixlinenr] =~
3283 s@\Q$sub_from\E@$sub_to@;
3288 # # no BUG() or BUG_ON()
3289 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
3290 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
3291 # print "$herecurr";
3295 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
3296 WARN("LINUX_VERSION_CODE",
3297 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3300 # check for uses of printk_ratelimit
3301 if ($line =~ /\bprintk_ratelimit\s*\(/) {
3302 WARN("PRINTK_RATELIMITED",
3303 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
3306 # printk should use KERN_* levels. Note that follow on printk's on the
3307 # same line do not need a level, so we use the current block context
3308 # to try and find and validate the current printk. In summary the current
3309 # printk includes all preceding printk's which have no newline on the end.
3310 # we assume the first bad printk is the one to report.
3311 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
3313 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3314 #print "CHECK<$lines[$ln - 1]\n";
3315 # we have a preceding printk if it ends
3316 # with "\n" ignore it, else it is to blame
3317 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3318 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3325 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3326 "printk() should include KERN_ facility level\n" . $herecurr);
3330 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3332 my $level = lc($orig);
3333 $level = "warn" if ($level eq "warning");
3334 my $level2 = $level;
3335 $level2 = "dbg" if ($level eq "debug");
3336 WARN("PREFER_PR_LEVEL",
3337 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
3340 if ($line =~ /\bpr_warning\s*\(/) {
3341 if (WARN("PREFER_PR_LEVEL",
3342 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3344 $fixed[$fixlinenr] =~
3345 s/\bpr_warning\b/pr_warn/;
3349 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3351 my $level = lc($orig);
3352 $level = "warn" if ($level eq "warning");
3353 $level = "dbg" if ($level eq "debug");
3354 WARN("PREFER_DEV_LEVEL",
3355 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3358 # function brace can't be on same line, except for #defines of do while,
3359 # or if closed on same line
3360 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
3361 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
3362 if (ERROR("OPEN_BRACE",
3363 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3365 fix_delete_line($fixlinenr, $rawline);
3366 my $fixed_line = $rawline;
3367 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3370 fix_insert_line($fixlinenr, ltrim($line1));
3371 fix_insert_line($fixlinenr, "\+{");
3372 if ($line2 !~ /^\s*$/) {
3373 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3378 # open braces for enum, union and struct go on the same line.
3379 if ($line =~ /^.\s*{/ &&
3380 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
3381 if (ERROR("OPEN_BRACE",
3382 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3383 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3384 fix_delete_line($fixlinenr - 1, $prevrawline);
3385 fix_delete_line($fixlinenr, $rawline);
3386 my $fixedline = rtrim($prevrawline) . " {";
3387 fix_insert_line($fixlinenr, $fixedline);
3388 $fixedline = $rawline;
3389 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3390 if ($fixedline !~ /^\+\s*$/) {
3391 fix_insert_line($fixlinenr, $fixedline);
3396 # missing space after union, struct or enum definition
3397 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3399 "missing space after $1 definition\n" . $herecurr) &&
3401 $fixed[$fixlinenr] =~
3402 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3406 # Function pointer declarations
3407 # check spacing between type, funcptr, and args
3408 # canonical declaration is "type (*funcptr)(args...)"
3409 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
3411 my $pre_pointer_space = $2;
3412 my $post_pointer_space = $3;
3414 my $post_funcname_space = $5;
3415 my $pre_args_space = $6;
3417 # the $Declare variable will capture all spaces after the type
3418 # so check it for a missing trailing missing space but pointer return types
3419 # don't need a space so don't warn for those.
3420 my $post_declare_space = "";
3421 if ($declare =~ /(\s+)$/) {
3422 $post_declare_space = $1;
3423 $declare = rtrim($declare);
3425 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
3427 "missing space after return type\n" . $herecurr);
3428 $post_declare_space = " ";
3431 # unnecessary space "type (*funcptr)(args...)"
3432 # This test is not currently implemented because these declarations are
3434 # int foo(int bar, ...)
3435 # and this is form shouldn't/doesn't generate a checkpatch warning.
3437 # elsif ($declare =~ /\s{2,}$/) {
3439 # "Multiple spaces after return type\n" . $herecurr);
3442 # unnecessary space "type ( *funcptr)(args...)"
3443 if (defined $pre_pointer_space &&
3444 $pre_pointer_space =~ /^\s/) {
3446 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3449 # unnecessary space "type (* funcptr)(args...)"
3450 if (defined $post_pointer_space &&
3451 $post_pointer_space =~ /^\s/) {
3453 "Unnecessary space before function pointer name\n" . $herecurr);
3456 # unnecessary space "type (*funcptr )(args...)"
3457 if (defined $post_funcname_space &&
3458 $post_funcname_space =~ /^\s/) {
3460 "Unnecessary space after function pointer name\n" . $herecurr);
3463 # unnecessary space "type (*funcptr) (args...)"
3464 if (defined $pre_args_space &&
3465 $pre_args_space =~ /^\s/) {
3467 "Unnecessary space before function pointer arguments\n" . $herecurr);
3470 if (show_type("SPACING") && $fix) {
3471 $fixed[$fixlinenr] =~
3472 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3476 # check for spacing round square brackets; allowed:
3477 # 1. with a type on the left -- int [] a;
3478 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3479 # 3. inside a curly brace -- = { [0...10] = 5 }
3480 while ($line =~ /(.*?\s)\[/g) {
3481 my ($where, $prefix) = ($-[1], $1);
3482 if ($prefix !~ /$Type\s+$/ &&
3483 ($where != 0 || $prefix !~ /^.\s+$/) &&
3484 $prefix !~ /[{,]\s+$/) {
3485 if (ERROR("BRACKET_SPACE",
3486 "space prohibited before open square bracket '['\n" . $herecurr) &&
3488 $fixed[$fixlinenr] =~
3489 s/^(\+.*?)\s+\[/$1\[/;
3494 # check for spaces between functions and their parentheses.
3495 while ($line =~ /($Ident)\s+\(/g) {
3497 my $ctx_before = substr($line, 0, $-[1]);
3498 my $ctx = "$ctx_before$name";
3500 # Ignore those directives where spaces _are_ permitted.
3502 if|for|while|switch|return|case|
3503 volatile|__volatile__|
3504 __attribute__|format|__extension__|
3507 # cpp #define statements have non-optional spaces, ie
3508 # if there is a space between the name and the open
3509 # parenthesis it is simply not a parameter group.
3510 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
3512 # cpp #elif statement condition may start with a (
3513 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
3515 # If this whole things ends with a type its most
3516 # likely a typedef for a function.
3517 } elsif ($ctx =~ /$Type$/) {
3521 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3523 $fixed[$fixlinenr] =~
3524 s/\b$name\s+\(/$name\(/;
3529 # Check operator spacing.
3530 if (!($line=~/\#\s*include/)) {
3531 my $fixed_line = "";
3535 <<=|>>=|<=|>=|==|!=|
3536 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3537 =>|->|<<|>>|<|>|=|!|~|
3538 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
3541 my @elements = split(/($ops|;)/, $opline);
3543 ## print("element count: <" . $#elements . ">\n");
3544 ## foreach my $el (@elements) {
3545 ## print("el: <$el>\n");
3548 my @fix_elements = ();
3551 foreach my $el (@elements) {
3552 push(@fix_elements, substr($rawline, $off, length($el)));
3553 $off += length($el);
3558 my $blank = copy_spacing($opline);
3559 my $last_after = -1;
3561 for (my $n = 0; $n < $#elements; $n += 2) {
3563 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3565 ## print("n: <$n> good: <$good>\n");
3567 $off += length($elements[$n]);
3569 # Pick up the preceding and succeeding characters.
3570 my $ca = substr($opline, 0, $off);
3572 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3573 $cc = substr($opline, $off + length($elements[$n + 1]));
3575 my $cb = "$ca$;$cc";
3578 $a = 'V' if ($elements[$n] ne '');
3579 $a = 'W' if ($elements[$n] =~ /\s$/);
3580 $a = 'C' if ($elements[$n] =~ /$;$/);
3581 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3582 $a = 'O' if ($elements[$n] eq '');
3583 $a = 'E' if ($ca =~ /^\s*$/);
3585 my $op = $elements[$n + 1];
3588 if (defined $elements[$n + 2]) {
3589 $c = 'V' if ($elements[$n + 2] ne '');
3590 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
3591 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
3592 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3593 $c = 'O' if ($elements[$n + 2] eq '');
3594 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
3599 my $ctx = "${a}x${c}";
3601 my $at = "(ctx:$ctx)";
3603 my $ptr = substr($blank, 0, $off) . "^";
3604 my $hereptr = "$hereline$ptr\n";
3606 # Pull out the value of this operator.
3607 my $op_type = substr($curr_values, $off + 1, 1);
3609 # Get the full operator variant.
3610 my $opv = $op . substr($curr_vars, $off, 1);
3612 # Ignore operators passed as parameters.
3613 if ($op_type ne 'V' &&
3614 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
3617 # } elsif ($op =~ /^$;+$/) {
3619 # ; should have either the end of line or a space or \ after it
3620 } elsif ($op eq ';') {
3621 if ($ctx !~ /.x[WEBC]/ &&
3622 $cc !~ /^\\/ && $cc !~ /^;/) {
3623 if (ERROR("SPACING",
3624 "space required after that '$op' $at\n" . $hereptr)) {
3625 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3631 } elsif ($op eq '//') {
3633 # : when part of a bitfield
3634 } elsif ($opv eq ':B') {
3635 # skip the bitfield test for now
3639 } elsif ($op eq '->') {
3640 if ($ctx =~ /Wx.|.xW/) {
3641 if (ERROR("SPACING",
3642 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
3643 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3644 if (defined $fix_elements[$n + 2]) {
3645 $fix_elements[$n + 2] =~ s/^\s+//;
3651 # , must not have a space before and must have a space on the right.
3652 } elsif ($op eq ',') {
3653 my $rtrim_before = 0;
3654 my $space_after = 0;
3655 if ($ctx =~ /Wx./) {
3656 if (ERROR("SPACING",
3657 "space prohibited before that '$op' $at\n" . $hereptr)) {
3662 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
3663 if (ERROR("SPACING",
3664 "space required after that '$op' $at\n" . $hereptr)) {
3670 if ($rtrim_before || $space_after) {
3671 if ($rtrim_before) {
3672 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3674 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3681 # '*' as part of a type definition -- reported already.
3682 } elsif ($opv eq '*_') {
3683 #warn "'*' is part of type\n";
3685 # unary operators should have a space before and
3686 # none after. May be left adjacent to another
3687 # unary operator, or a cast
3688 } elsif ($op eq '!' || $op eq '~' ||
3689 $opv eq '*U' || $opv eq '-U' ||
3690 $opv eq '&U' || $opv eq '&&U') {
3691 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
3692 if (ERROR("SPACING",
3693 "space required before that '$op' $at\n" . $hereptr)) {
3694 if ($n != $last_after + 2) {
3695 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3700 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
3701 # A unary '*' may be const
3703 } elsif ($ctx =~ /.xW/) {
3704 if (ERROR("SPACING",
3705 "space prohibited after that '$op' $at\n" . $hereptr)) {
3706 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
3707 if (defined $fix_elements[$n + 2]) {
3708 $fix_elements[$n + 2] =~ s/^\s+//;
3714 # unary ++ and unary -- are allowed no space on one side.
3715 } elsif ($op eq '++' or $op eq '--') {
3716 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
3717 if (ERROR("SPACING",
3718 "space required one side of that '$op' $at\n" . $hereptr)) {
3719 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3723 if ($ctx =~ /Wx[BE]/ ||
3724 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
3725 if (ERROR("SPACING",
3726 "space prohibited before that '$op' $at\n" . $hereptr)) {
3727 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3731 if ($ctx =~ /ExW/) {
3732 if (ERROR("SPACING",
3733 "space prohibited after that '$op' $at\n" . $hereptr)) {
3734 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3735 if (defined $fix_elements[$n + 2]) {
3736 $fix_elements[$n + 2] =~ s/^\s+//;
3742 # << and >> may either have or not have spaces both sides
3743 } elsif ($op eq '<<' or $op eq '>>' or
3744 $op eq '&' or $op eq '^' or $op eq '|' or
3745 $op eq '+' or $op eq '-' or
3746 $op eq '*' or $op eq '/' or
3750 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
3752 "spaces preferred around that '$op' $at\n" . $hereptr)) {
3753 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3754 $fix_elements[$n + 2] =~ s/^\s+//;
3757 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
3759 "space preferred before that '$op' $at\n" . $hereptr)) {
3760 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
3764 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
3765 if (ERROR("SPACING",
3766 "need consistent spacing around '$op' $at\n" . $hereptr)) {
3767 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3768 if (defined $fix_elements[$n + 2]) {
3769 $fix_elements[$n + 2] =~ s/^\s+//;
3775 # A colon needs no spaces before when it is
3776 # terminating a case value or a label.
3777 } elsif ($opv eq ':C' || $opv eq ':L') {
3778 if ($ctx =~ /Wx./) {
3779 if (ERROR("SPACING",
3780 "space prohibited before that '$op' $at\n" . $hereptr)) {
3781 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3786 # All the others need spaces both sides.
3787 } elsif ($ctx !~ /[EWC]x[CWE]/) {
3790 # Ignore email addresses <foo@bar>
3792 $cc =~ /^\S+\@\S+>/) ||
3794 $ca =~ /<\S+\@\S+$/))
3799 # messages are ERROR, but ?: are CHK
3801 my $msg_type = \&ERROR;
3802 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
3804 if (&{$msg_type}("SPACING",
3805 "spaces required around that '$op' $at\n" . $hereptr)) {
3806 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3807 if (defined $fix_elements[$n + 2]) {
3808 $fix_elements[$n + 2] =~ s/^\s+//;
3814 $off += length($elements[$n + 1]);
3816 ## print("n: <$n> GOOD: <$good>\n");
3818 $fixed_line = $fixed_line . $good;
3821 if (($#elements % 2) == 0) {
3822 $fixed_line = $fixed_line . $fix_elements[$#elements];
3825 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
3826 $fixed[$fixlinenr] = $fixed_line;
3832 # check for whitespace before a non-naked semicolon
3833 if ($line =~ /^\+.*\S\s+;\s*$/) {
3835 "space prohibited before semicolon\n" . $herecurr) &&
3837 1 while $fixed[$fixlinenr] =~
3838 s/^(\+.*\S)\s+;/$1;/;
3842 # check for multiple assignments
3843 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
3844 CHK("MULTIPLE_ASSIGNMENTS",
3845 "multiple assignments should be avoided\n" . $herecurr);
3848 ## # check for multiple declarations, allowing for a function declaration
3850 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3851 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3853 ## # Remove any bracketed sections to ensure we do not
3854 ## # falsly report the parameters of functions.
3856 ## while ($ln =~ s/\([^\(\)]*\)//g) {
3858 ## if ($ln =~ /,/) {
3859 ## WARN("MULTIPLE_DECLARATION",
3860 ## "declaring multiple variables together should be avoided\n" . $herecurr);
3864 #need space before brace following if, while, etc
3865 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3867 if (ERROR("SPACING",
3868 "space required before the open brace '{'\n" . $herecurr) &&
3870 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
3874 ## # check for blank lines before declarations
3875 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3876 ## $prevrawline =~ /^.\s*$/) {
3878 ## "No blank lines before declarations\n" . $hereprev);
3882 # closing brace should have a space following it when it has anything
3884 if ($line =~ /}(?!(?:,|;|\)))\S/) {
3885 if (ERROR("SPACING",
3886 "space required after that close brace '}'\n" . $herecurr) &&
3888 $fixed[$fixlinenr] =~
3889 s/}((?!(?:,|;|\)))\S)/} $1/;
3893 # check spacing on square brackets
3894 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
3895 if (ERROR("SPACING",
3896 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3898 $fixed[$fixlinenr] =~
3902 if ($line =~ /\s\]/) {
3903 if (ERROR("SPACING",
3904 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3906 $fixed[$fixlinenr] =~
3911 # check spacing on parentheses
3912 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3913 $line !~ /for\s*\(\s+;/) {
3914 if (ERROR("SPACING",
3915 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3917 $fixed[$fixlinenr] =~
3921 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
3922 $line !~ /for\s*\(.*;\s+\)/ &&
3923 $line !~ /:\s+\)/) {
3924 if (ERROR("SPACING",
3925 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3927 $fixed[$fixlinenr] =~
3932 # check unnecessary parentheses around addressof/dereference single $Lvals
3933 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
3935 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
3937 if (CHK("UNNECESSARY_PARENTHESES",
3938 "Unnecessary parentheses around $var\n" . $herecurr) &&
3940 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
3944 # check for unnecessary parentheses around function pointer uses
3945 # ie: (foo->bar)(); should be foo->bar();
3946 # but not "if (foo->bar) (" to avoid some false positives
3947 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
3949 if (CHK("UNNECESSARY_PARENTHESES",
3950 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
3952 my $var2 = deparenthesize($var);
3954 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
3958 #goto labels aren't indented, allow a single space however
3959 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
3960 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
3961 if (WARN("INDENTED_LABEL",
3962 "labels should not be indented\n" . $herecurr) &&
3964 $fixed[$fixlinenr] =~
3969 # return is not a function
3970 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
3972 if ($^V && $^V ge 5.10.0 &&
3973 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
3975 $value = deparenthesize($value);
3976 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
3977 ERROR("RETURN_PARENTHESES",
3978 "return is not a function, parentheses are not required\n" . $herecurr);
3980 } elsif ($spacing !~ /\s+/) {
3982 "space required before the open parenthesis '('\n" . $herecurr);
3986 # unnecessary return in a void function
3987 # at end-of-function, with the previous line a single leading tab, then return;
3988 # and the line before that not a goto label target like "out:"
3989 if ($sline =~ /^[ \+]}\s*$/ &&
3990 $prevline =~ /^\+\treturn\s*;\s*$/ &&
3992 $lines[$linenr - 3] =~ /^[ +]/ &&
3993 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
3995 "void function return statements are not generally useful\n" . $hereprev);
3998 # if statements using unnecessary parentheses - ie: if ((foo == bar))
3999 if ($^V && $^V ge 5.10.0 &&
4000 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4001 my $openparens = $1;
4002 my $count = $openparens =~ tr@\(@\(@;
4004 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4005 my $comp = $4; #Not $1 because of $LvalOrFunc
4006 $msg = " - maybe == should be = ?" if ($comp eq "==");
4007 WARN("UNNECESSARY_PARENTHESES",
4008 "Unnecessary parentheses$msg\n" . $herecurr);
4012 # Return of what appears to be an errno should normally be negative
4013 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
4015 if ($name ne 'EOF' && $name ne 'ERROR') {
4016 WARN("USE_NEGATIVE_ERRNO",
4017 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
4021 # Need a space before open parenthesis after if, while etc
4022 if ($line =~ /\b(if|while|for|switch)\(/) {
4023 if (ERROR("SPACING",
4024 "space required before the open parenthesis '('\n" . $herecurr) &&
4026 $fixed[$fixlinenr] =~
4027 s/\b(if|while|for|switch)\(/$1 \(/;
4031 # Check for illegal assignment in if conditional -- and check for trailing
4032 # statements after the conditional.
4033 if ($line =~ /do\s*(?!{)/) {
4034 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4035 ctx_statement_block($linenr, $realcnt, 0)
4036 if (!defined $stat);
4037 my ($stat_next) = ctx_statement_block($line_nr_next,
4038 $remain_next, $off_next);
4039 $stat_next =~ s/\n./\n /g;
4040 ##print "stat<$stat> stat_next<$stat_next>\n";
4042 if ($stat_next =~ /^\s*while\b/) {
4043 # If the statement carries leading newlines,
4044 # then count those as offsets.
4046 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4048 statement_rawlines($whitespace) - 1;
4050 $suppress_whiletrailers{$line_nr_next +
4054 if (!defined $suppress_whiletrailers{$linenr} &&
4055 defined($stat) && defined($cond) &&
4056 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
4057 my ($s, $c) = ($stat, $cond);
4059 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
4060 ERROR("ASSIGN_IN_IF",
4061 "do not use assignment in if condition\n" . $herecurr);
4064 # Find out what is on the end of the line after the
4066 substr($s, 0, length($c), '');
4068 $s =~ s/$;//g; # Remove any comments
4069 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4070 $c !~ /}\s*while\s*/)
4072 # Find out how long the conditional actually is.
4073 my @newlines = ($c =~ /\n/gs);
4074 my $cond_lines = 1 + $#newlines;
4077 $stat_real = raw_line($linenr, $cond_lines)
4078 . "\n" if ($cond_lines);
4079 if (defined($stat_real) && $cond_lines > 1) {
4080 $stat_real = "[...]\n$stat_real";
4083 ERROR("TRAILING_STATEMENTS",
4084 "trailing statements should be on next line\n" . $herecurr . $stat_real);
4088 # Check for bitwise tests written as boolean
4100 WARN("HEXADECIMAL_BOOLEAN_TEST",
4101 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
4104 # if and else should not have general statements after it
4105 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4107 $s =~ s/$;//g; # Remove any comments
4108 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
4109 ERROR("TRAILING_STATEMENTS",
4110 "trailing statements should be on next line\n" . $herecurr);
4113 # if should not continue a brace
4114 if ($line =~ /}\s*if\b/) {
4115 ERROR("TRAILING_STATEMENTS",
4116 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
4119 # case and default should not have general statements after them
4120 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4122 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
4126 ERROR("TRAILING_STATEMENTS",
4127 "trailing statements should be on next line\n" . $herecurr);
4130 # Check for }<nl>else {, these must be at the same
4131 # indent level to be relevant to each other.
4132 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4133 $previndent == $indent) {
4134 if (ERROR("ELSE_AFTER_BRACE",
4135 "else should follow close brace '}'\n" . $hereprev) &&
4136 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4137 fix_delete_line($fixlinenr - 1, $prevrawline);
4138 fix_delete_line($fixlinenr, $rawline);
4139 my $fixedline = $prevrawline;
4140 $fixedline =~ s/}\s*$//;
4141 if ($fixedline !~ /^\+\s*$/) {
4142 fix_insert_line($fixlinenr, $fixedline);
4144 $fixedline = $rawline;
4145 $fixedline =~ s/^(.\s*)else/$1} else/;
4146 fix_insert_line($fixlinenr, $fixedline);
4150 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4151 $previndent == $indent) {
4152 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4154 # Find out what is on the end of the line after the
4156 substr($s, 0, length($c), '');
4159 if ($s =~ /^\s*;/) {
4160 if (ERROR("WHILE_AFTER_BRACE",
4161 "while should follow close brace '}'\n" . $hereprev) &&
4162 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4163 fix_delete_line($fixlinenr - 1, $prevrawline);
4164 fix_delete_line($fixlinenr, $rawline);
4165 my $fixedline = $prevrawline;
4166 my $trailing = $rawline;
4167 $trailing =~ s/^\+//;
4168 $trailing = trim($trailing);
4169 $fixedline =~ s/}\s*$/} $trailing/;
4170 fix_insert_line($fixlinenr, $fixedline);
4175 #Specific variable tests
4176 while ($line =~ m{($Constant|$Lval)}g) {
4179 #gcc binary extension
4180 if ($var =~ /^$Binary$/) {
4181 if (WARN("GCC_BINARY_CONSTANT",
4182 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4184 my $hexval = sprintf("0x%x", oct($var));
4185 $fixed[$fixlinenr] =~
4186 s/\b$var\b/$hexval/;
4191 if ($var !~ /^$Constant$/ &&
4192 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
4193 #Ignore Page<foo> variants
4194 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
4195 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4196 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4197 #Ignore some three character SI units explicitly, like MiB and KHz
4198 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
4199 while ($var =~ m{($Ident)}g) {
4201 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
4203 seed_camelcase_includes();
4204 if (!$file && !$camelcase_file_seeded) {
4205 seed_camelcase_file($realfile);
4206 $camelcase_file_seeded = 1;
4209 if (!defined $camelcase{$word}) {
4210 $camelcase{$word} = 1;
4212 "Avoid CamelCase: <$word>\n" . $herecurr);
4218 #no spaces allowed after \ in define
4219 if ($line =~ /\#\s*define.*\\\s+$/) {
4220 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4221 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4223 $fixed[$fixlinenr] =~ s/\s+$//;
4227 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
4228 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
4230 my $checkfile = "include/linux/$file";
4231 if (-f "$root/$checkfile" &&
4232 $realfile ne $checkfile &&
4233 $1 !~ /$allowed_asm_includes/)
4235 if ($realfile =~ m{^arch/}) {
4236 CHK("ARCH_INCLUDE_LINUX",
4237 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4239 WARN("INCLUDE_LINUX",
4240 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4245 # multi-statement macros should be enclosed in a do while loop, grab the
4246 # first statement and ensure its the whole macro if its not enclosed
4247 # in a known good container
4248 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4249 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
4252 my ($off, $dstat, $dcond, $rest);
4254 my $has_flow_statement = 0;
4255 my $has_arg_concat = 0;
4256 ($dstat, $dcond, $ln, $cnt, $off) =
4257 ctx_statement_block($linenr, $realcnt, 0);
4259 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4260 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4262 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
4263 $has_arg_concat = 1 if ($ctx =~ /\#\#/);
4265 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
4267 $dstat =~ s/\\\n.//g;
4268 $dstat =~ s/^\s*//s;
4269 $dstat =~ s/\s*$//s;
4271 # Flatten any parentheses and braces
4272 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4273 $dstat =~ s/\{[^\{\}]*\}/1/ ||
4274 $dstat =~ s/\[[^\[\]]*\]/1/)
4278 # Flatten any obvious string concatentation.
4279 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
4280 $dstat =~ s/$Ident\s*("X*")/$1/)
4284 my $exceptions = qr{
4296 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4298 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4299 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
4300 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4301 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
4302 $dstat !~ /$exceptions/ &&
4303 $dstat !~ /^\.$Ident\s*=/ && # .foo =
4304 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
4305 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
4306 $dstat !~ /^for\s*$Constant$/ && # for (...)
4307 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4308 $dstat !~ /^do\s*{/ && # do {...
4309 $dstat !~ /^\({/ && # ({...
4310 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
4313 my $herectx = $here . "\n";
4314 my $cnt = statement_rawlines($ctx);
4316 for (my $n = 0; $n < $cnt; $n++) {
4317 $herectx .= raw_line($linenr, $n) . "\n";
4320 if ($dstat =~ /;/) {
4321 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4322 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4324 ERROR("COMPLEX_MACRO",
4325 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
4329 # check for macros with flow control, but without ## concatenation
4330 # ## concatenation is commonly a macro that defines a function so ignore those
4331 if ($has_flow_statement && !$has_arg_concat) {
4332 my $herectx = $here . "\n";
4333 my $cnt = statement_rawlines($ctx);
4335 for (my $n = 0; $n < $cnt; $n++) {
4336 $herectx .= raw_line($linenr, $n) . "\n";
4338 WARN("MACRO_WITH_FLOW_CONTROL",
4339 "Macros with flow control statements should be avoided\n" . "$herectx");
4342 # check for line continuations outside of #defines, preprocessor #, and asm
4345 if ($prevline !~ /^..*\\$/ &&
4346 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4347 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
4348 $line =~ /^\+.*\\$/) {
4349 WARN("LINE_CONTINUATIONS",
4350 "Avoid unnecessary line continuations\n" . $herecurr);
4354 # do {} while (0) macro tests:
4355 # single-statement macros do not need to be enclosed in do while (0) loop,
4356 # macro should not end with a semicolon
4357 if ($^V && $^V ge 5.10.0 &&
4358 $realfile !~ m@/vmlinux.lds.h$@ &&
4359 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4362 my ($off, $dstat, $dcond, $rest);
4364 ($dstat, $dcond, $ln, $cnt, $off) =
4365 ctx_statement_block($linenr, $realcnt, 0);
4368 $dstat =~ s/\\\n.//g;
4371 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4376 my $cnt = statement_rawlines($ctx);
4377 my $herectx = $here . "\n";
4379 for (my $n = 0; $n < $cnt; $n++) {
4380 $herectx .= raw_line($linenr, $n) . "\n";
4383 if (($stmts =~ tr/;/;/) == 1 &&
4384 $stmts !~ /^\s*(if|while|for|switch)\b/) {
4385 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4386 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4388 if (defined $semis && $semis ne "") {
4389 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4390 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4392 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4394 my $cnt = statement_rawlines($ctx);
4395 my $herectx = $here . "\n";
4397 for (my $n = 0; $n < $cnt; $n++) {
4398 $herectx .= raw_line($linenr, $n) . "\n";
4401 WARN("TRAILING_SEMICOLON",
4402 "macros should not use a trailing semicolon\n" . "$herectx");
4406 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4407 # all assignments may have only one of the following with an assignment:
4410 # VMLINUX_SYMBOL(...)
4411 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
4412 WARN("MISSING_VMLINUX_SYMBOL",
4413 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
4416 # check for redundant bracing round if etc
4417 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4418 my ($level, $endln, @chunks) =
4419 ctx_statement_full($linenr, $realcnt, 1);
4420 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
4421 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4422 if ($#chunks > 0 && $level == 0) {
4426 my $herectx = $here . "\n";
4427 my $ln = $linenr - 1;
4428 for my $chunk (@chunks) {
4429 my ($cond, $block) = @{$chunk};
4431 # If the condition carries leading newlines, then count those as offsets.
4432 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4433 my $offset = statement_rawlines($whitespace) - 1;
4435 $allowed[$allow] = 0;
4436 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4438 # We have looked at and allowed this specific line.
4439 $suppress_ifbraces{$ln + $offset} = 1;
4441 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
4442 $ln += statement_rawlines($block) - 1;
4444 substr($block, 0, length($cond), '');
4446 $seen++ if ($block =~ /^\s*{/);
4448 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
4449 if (statement_lines($cond) > 1) {
4450 #print "APW: ALLOWED: cond<$cond>\n";
4451 $allowed[$allow] = 1;
4453 if ($block =~/\b(?:if|for|while)\b/) {
4454 #print "APW: ALLOWED: block<$block>\n";
4455 $allowed[$allow] = 1;
4457 if (statement_block_size($block) > 1) {
4458 #print "APW: ALLOWED: lines block<$block>\n";
4459 $allowed[$allow] = 1;
4464 my $sum_allowed = 0;
4465 foreach (@allowed) {
4468 if ($sum_allowed == 0) {
4470 "braces {} are not necessary for any arm of this statement\n" . $herectx);
4471 } elsif ($sum_allowed != $allow &&
4474 "braces {} should be used on all arms of this statement\n" . $herectx);
4479 if (!defined $suppress_ifbraces{$linenr - 1} &&
4480 $line =~ /\b(if|while|for|else)\b/) {
4483 # Check the pre-context.
4484 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
4485 #print "APW: ALLOWED: pre<$1>\n";
4489 my ($level, $endln, @chunks) =
4490 ctx_statement_full($linenr, $realcnt, $-[0]);
4492 # Check the condition.
4493 my ($cond, $block) = @{$chunks[0]};
4494 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
4495 if (defined $cond) {
4496 substr($block, 0, length($cond), '');
4498 if (statement_lines($cond) > 1) {
4499 #print "APW: ALLOWED: cond<$cond>\n";
4502 if ($block =~/\b(?:if|for|while)\b/) {
4503 #print "APW: ALLOWED: block<$block>\n";
4506 if (statement_block_size($block) > 1) {
4507 #print "APW: ALLOWED: lines block<$block>\n";
4510 # Check the post-context.
4511 if (defined $chunks[1]) {
4512 my ($cond, $block) = @{$chunks[1]};
4513 if (defined $cond) {
4514 substr($block, 0, length($cond), '');
4516 if ($block =~ /^\s*\{/) {
4517 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4521 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
4522 my $herectx = $here . "\n";
4523 my $cnt = statement_rawlines($block);
4525 for (my $n = 0; $n < $cnt; $n++) {
4526 $herectx .= raw_line($linenr, $n) . "\n";
4530 "braces {} are not necessary for single statement blocks\n" . $herectx);
4534 # check for unnecessary blank lines around braces
4535 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
4537 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
4538 $fix && $prevrawline =~ /^\+/) {
4539 fix_delete_line($fixlinenr - 1, $prevrawline);
4542 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
4544 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
4546 fix_delete_line($fixlinenr, $rawline);
4550 # no volatiles please
4551 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
4552 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
4554 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
4557 # Check for user-visible strings broken across lines, which breaks the ability
4558 # to grep for the string. Make exceptions when the previous string ends in a
4559 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
4560 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
4561 if ($line =~ /^\+\s*"[X\t]*"/ &&
4562 $prevline =~ /"\s*$/ &&
4563 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
4564 if (WARN("SPLIT_STRING",
4565 "quoted string split across lines\n" . $hereprev) &&
4567 $prevrawline =~ /^\+.*"\s*$/ &&
4568 $last_coalesced_string_linenr != $linenr - 1) {
4569 my $extracted_string = get_quoted_string($line, $rawline);
4570 my $comma_close = "";
4571 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
4575 fix_delete_line($fixlinenr - 1, $prevrawline);
4576 fix_delete_line($fixlinenr, $rawline);
4577 my $fixedline = $prevrawline;
4578 $fixedline =~ s/"\s*$//;
4579 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
4580 fix_insert_line($fixlinenr - 1, $fixedline);
4581 $fixedline = $rawline;
4582 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
4583 if ($fixedline !~ /\+\s*$/) {
4584 fix_insert_line($fixlinenr, $fixedline);
4586 $last_coalesced_string_linenr = $linenr;
4590 # check for missing a space in a string concatenation
4591 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
4592 WARN('MISSING_SPACE',
4593 "break quoted strings at a space character\n" . $hereprev);
4596 # check for spaces before a quoted newline
4597 if ($rawline =~ /^.*\".*\s\\n/) {
4598 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
4599 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
4601 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
4606 # concatenated string without spaces between elements
4607 if ($line =~ /"X+"[A-Z_]+/ || $line =~ /[A-Z_]+"X+"/) {
4608 CHK("CONCATENATED_STRING",
4609 "Concatenated strings should use spaces between elements\n" . $herecurr);
4612 # uncoalesced string fragments
4613 if ($line =~ /"X*"\s*"/) {
4614 WARN("STRING_FRAGMENTS",
4615 "Consecutive strings are generally better as a single string\n" . $herecurr);
4618 # check for %L{u,d,i} in strings
4620 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4621 $string = substr($rawline, $-[1], $+[1] - $-[1]);
4622 $string =~ s/%%/__/g;
4623 if ($string =~ /(?<!%)%L[udi]/) {
4625 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
4630 # check for line continuations in quoted strings with odd counts of "
4631 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
4632 WARN("LINE_CONTINUATIONS",
4633 "Avoid line continuations in quoted strings\n" . $herecurr);
4637 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
4638 CHK("REDUNDANT_CODE",
4639 "if this code is redundant consider removing it\n" .
4643 # check for needless "if (<foo>) fn(<foo>)" uses
4644 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
4645 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
4646 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
4648 "$1(NULL) is safe and this check is probably not required\n" . $hereprev);
4652 # check for unnecessary "Out of Memory" messages
4653 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
4654 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
4655 (defined $1 || defined $3) &&
4658 my $testline = $lines[$linenr - 3];
4660 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
4661 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
4663 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
4665 "Possible unnecessary 'out of memory' message\n" . $hereprev);
4669 # check for logging functions with KERN_<LEVEL>
4670 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
4671 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
4673 if (WARN("UNNECESSARY_KERN_LEVEL",
4674 "Possible unnecessary $level\n" . $herecurr) &&
4676 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
4680 # check for mask then right shift without a parentheses
4681 if ($^V && $^V ge 5.10.0 &&
4682 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
4683 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
4684 WARN("MASK_THEN_SHIFT",
4685 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
4688 # check for pointer comparisons to NULL
4689 if ($^V && $^V ge 5.10.0) {
4690 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
4693 $equal = "" if ($4 eq "!=");
4694 if (CHK("COMPARISON_TO_NULL",
4695 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
4697 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
4702 # check for bad placement of section $InitAttribute (e.g.: __initdata)
4703 if ($line =~ /(\b$InitAttribute\b)/) {
4705 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
4708 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
4709 ERROR("MISPLACED_INIT",
4710 "$attr should be placed after $var\n" . $herecurr)) ||
4711 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
4712 WARN("MISPLACED_INIT",
4713 "$attr should be placed after $var\n" . $herecurr))) &&
4715 $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;
4720 # check for $InitAttributeData (ie: __initdata) with const
4721 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
4723 $attr =~ /($InitAttributePrefix)(.*)/;
4724 my $attr_prefix = $1;
4726 if (ERROR("INIT_ATTRIBUTE",
4727 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
4729 $fixed[$fixlinenr] =~
4730 s/$InitAttributeData/${attr_prefix}initconst/;
4734 # check for $InitAttributeConst (ie: __initconst) without const
4735 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
4737 if (ERROR("INIT_ATTRIBUTE",
4738 "Use of $attr requires a separate use of const\n" . $herecurr) &&
4740 my $lead = $fixed[$fixlinenr] =~
4741 /(^\+\s*(?:static\s+))/;
4743 $lead = "$lead " if ($lead !~ /^\+$/);
4744 $lead = "${lead}const ";
4745 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
4749 # don't use __constant_<foo> functions outside of include/uapi/
4750 if ($realfile !~ m@^include/uapi/@ &&
4751 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
4752 my $constant_func = $1;
4753 my $func = $constant_func;
4754 $func =~ s/^__constant_//;
4755 if (WARN("CONSTANT_CONVERSION",
4756 "$constant_func should be $func\n" . $herecurr) &&
4758 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
4762 # prefer usleep_range over udelay
4763 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
4765 # ignore udelay's < 10, however
4766 if (! ($delay < 10) ) {
4768 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4770 if ($delay > 2000) {
4772 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
4776 # warn about unexpectedly long msleep's
4777 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
4780 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4784 # check for comparisons of jiffies
4785 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
4786 WARN("JIFFIES_COMPARISON",
4787 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4790 # check for comparisons of get_jiffies_64()
4791 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
4792 WARN("JIFFIES_COMPARISON",
4793 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4796 # warn about #ifdefs in C files
4797 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
4798 # print "#ifdef in C files should be avoided\n";
4799 # print "$herecurr";
4803 # warn about spacing in #ifdefs
4804 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
4805 if (ERROR("SPACING",
4806 "exactly one space required after that #$1\n" . $herecurr) &&
4808 $fixed[$fixlinenr] =~
4809 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
4814 # check for spinlock_t definitions without a comment.
4815 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
4816 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
4818 if (!ctx_has_comment($first_line, $linenr)) {
4819 CHK("UNCOMMENTED_DEFINITION",
4820 "$1 definition without comment\n" . $herecurr);
4823 # check for memory barriers without a comment.
4824 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4825 if (!ctx_has_comment($first_line, $linenr)) {
4826 WARN("MEMORY_BARRIER",
4827 "memory barrier without comment\n" . $herecurr);
4830 # check of hardware specific defines
4831 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
4833 "architecture specific defines should be avoided\n" . $herecurr);
4836 # Check that the storage class is at the beginning of a declaration
4837 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
4838 WARN("STORAGE_CLASS",
4839 "storage class should be at the beginning of the declaration\n" . $herecurr)
4842 # check the location of the inline attribute, that it is between
4843 # storage class and type.
4844 if ($line =~ /\b$Type\s+$Inline\b/ ||
4845 $line =~ /\b$Inline\s+$Storage\b/) {
4846 ERROR("INLINE_LOCATION",
4847 "inline keyword should sit between storage class and type\n" . $herecurr);
4850 # Check for __inline__ and __inline, prefer inline
4851 if ($realfile !~ m@\binclude/uapi/@ &&
4852 $line =~ /\b(__inline__|__inline)\b/) {
4854 "plain inline is preferred over $1\n" . $herecurr) &&
4856 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
4861 # Check for __attribute__ packed, prefer __packed
4862 if ($realfile !~ m@\binclude/uapi/@ &&
4863 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
4864 WARN("PREFER_PACKED",
4865 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
4868 # Check for __attribute__ aligned, prefer __aligned
4869 if ($realfile !~ m@\binclude/uapi/@ &&
4870 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
4871 WARN("PREFER_ALIGNED",
4872 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
4875 # Check for __attribute__ format(printf, prefer __printf
4876 if ($realfile !~ m@\binclude/uapi/@ &&
4877 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
4878 if (WARN("PREFER_PRINTF",
4879 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4881 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
4886 # Check for __attribute__ format(scanf, prefer __scanf
4887 if ($realfile !~ m@\binclude/uapi/@ &&
4888 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
4889 if (WARN("PREFER_SCANF",
4890 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4892 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
4896 # Check for __attribute__ weak, or __weak declarations (may have link issues)
4897 if ($^V && $^V ge 5.10.0 &&
4898 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
4899 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
4900 $line =~ /\b__weak\b/)) {
4901 ERROR("WEAK_DECLARATION",
4902 "Using weak declarations can have unintended link defects\n" . $herecurr);
4905 # check for sizeof(&)
4906 if ($line =~ /\bsizeof\s*\(\s*\&/) {
4907 WARN("SIZEOF_ADDRESS",
4908 "sizeof(& should be avoided\n" . $herecurr);
4911 # check for sizeof without parenthesis
4912 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
4913 if (WARN("SIZEOF_PARENTHESIS",
4914 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
4916 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
4920 # check for struct spinlock declarations
4921 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
4922 WARN("USE_SPINLOCK_T",
4923 "struct spinlock should be spinlock_t\n" . $herecurr);
4926 # check for seq_printf uses that could be seq_puts
4927 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
4928 my $fmt = get_quoted_string($line, $rawline);
4931 if (WARN("PREFER_SEQ_PUTS",
4932 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
4934 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
4939 # Check for misused memsets
4940 if ($^V && $^V ge 5.10.0 &&
4942 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
4948 if ($ms_size =~ /^(0x|)0$/i) {
4950 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
4951 } elsif ($ms_size =~ /^(0x|)1$/i) {
4953 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
4957 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
4958 if ($^V && $^V ge 5.10.0 &&
4959 $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) {
4960 if (WARN("PREFER_ETHER_ADDR_COPY",
4961 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
4963 $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
4967 # typecasts on min/max could be min_t/max_t
4968 if ($^V && $^V ge 5.10.0 &&
4970 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
4971 if (defined $2 || defined $7) {
4973 my $cast1 = deparenthesize($2);
4975 my $cast2 = deparenthesize($7);
4979 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
4980 $cast = "$cast1 or $cast2";
4981 } elsif ($cast1 ne "") {
4987 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
4991 # check usleep_range arguments
4992 if ($^V && $^V ge 5.10.0 &&
4994 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
4998 WARN("USLEEP_RANGE",
4999 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5000 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5002 WARN("USLEEP_RANGE",
5003 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5007 # check for naked sscanf
5008 if ($^V && $^V ge 5.10.0 &&
5010 $line =~ /\bsscanf\b/ &&
5011 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5012 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5013 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5014 my $lc = $stat =~ tr@\n@@;
5015 $lc = $lc + $linenr;
5016 my $stat_real = raw_line($linenr, 0);
5017 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5018 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5020 WARN("NAKED_SSCANF",
5021 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5024 # check for simple sscanf that should be kstrto<foo>
5025 if ($^V && $^V ge 5.10.0 &&
5027 $line =~ /\bsscanf\b/) {
5028 my $lc = $stat =~ tr@\n@@;
5029 $lc = $lc + $linenr;
5030 my $stat_real = raw_line($linenr, 0);
5031 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5032 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5034 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5036 my $count = $format =~ tr@%@%@;
5038 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5039 WARN("SSCANF_TO_KSTRTO",
5040 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5045 # check for new externs in .h files.
5046 if ($realfile =~ /\.h$/ &&
5047 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
5048 if (CHK("AVOID_EXTERNS",
5049 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
5051 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
5055 # check for new externs in .c files.
5056 if ($realfile =~ /\.c$/ && defined $stat &&
5057 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
5059 my $function_name = $1;
5060 my $paren_space = $2;
5063 if (defined $cond) {
5064 substr($s, 0, length($cond), '');
5066 if ($s =~ /^\s*;/ &&
5067 $function_name ne 'uninitialized_var')
5069 WARN("AVOID_EXTERNS",
5070 "externs should be avoided in .c files\n" . $herecurr);
5073 if ($paren_space =~ /\n/) {
5074 WARN("FUNCTION_ARGUMENTS",
5075 "arguments for function declarations should follow identifier\n" . $herecurr);
5078 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5079 $stat =~ /^.\s*extern\s+/)
5081 WARN("AVOID_EXTERNS",
5082 "externs should be avoided in .c files\n" . $herecurr);
5085 # checks for new __setup's
5086 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5089 if (!grep(/$name/, @setup_docs)) {
5090 CHK("UNDOCUMENTED_SETUP",
5091 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
5095 # check for pointless casting of kmalloc return
5096 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
5097 WARN("UNNECESSARY_CASTS",
5098 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
5102 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5103 if ($^V && $^V ge 5.10.0 &&
5104 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5105 CHK("ALLOC_SIZEOF_STRUCT",
5106 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
5109 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5110 if ($^V && $^V ge 5.10.0 &&
5111 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
5115 my $newfunc = "kmalloc_array";
5116 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
5119 if ($a1 =~ /^sizeof\s*\S/) {
5123 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
5124 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
5125 if (WARN("ALLOC_WITH_MULTIPLY",
5126 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
5128 $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;
5134 # check for krealloc arg reuse
5135 if ($^V && $^V ge 5.10.0 &&
5136 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
5137 WARN("KREALLOC_ARG_REUSE",
5138 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
5141 # check for alloc argument mismatch
5142 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
5143 WARN("ALLOC_ARRAY_ARGS",
5144 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
5147 # check for multiple semicolons
5148 if ($line =~ /;\s*;\s*$/) {
5149 if (WARN("ONE_SEMICOLON",
5150 "Statements terminations use 1 semicolon\n" . $herecurr) &&
5152 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
5156 # check for #defines like: 1 << <digit> that could be BIT(digit)
5157 if ($line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
5159 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
5160 if (CHK("BIT_MACRO",
5161 "Prefer using the BIT$ull macro\n" . $herecurr) &&
5163 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
5167 # check for case / default statements not preceded by break/fallthrough/switch
5168 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
5170 my $has_statement = 0;
5172 my $prevline = $linenr;
5173 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
5175 my $rline = $rawlines[$prevline - 1];
5176 my $fline = $lines[$prevline - 1];
5177 last if ($fline =~ /^\@\@/);
5178 next if ($fline =~ /^\-/);
5179 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
5180 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
5181 next if ($fline =~ /^.[\s$;]*$/);
5184 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
5186 if (!$has_break && $has_statement) {
5187 WARN("MISSING_BREAK",
5188 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
5192 # check for switch/default statements without a break;
5193 if ($^V && $^V ge 5.10.0 &&
5195 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
5197 my $herectx = $here . "\n";
5198 my $cnt = statement_rawlines($stat);
5199 for (my $n = 0; $n < $cnt; $n++) {
5200 $herectx .= raw_line($linenr, $n) . "\n";
5202 WARN("DEFAULT_NO_BREAK",
5203 "switch default: should use break\n" . $herectx);
5206 # check for gcc specific __FUNCTION__
5207 if ($line =~ /\b__FUNCTION__\b/) {
5208 if (WARN("USE_FUNC",
5209 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
5211 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
5215 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
5216 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
5218 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
5221 # check for use of yield()
5222 if ($line =~ /\byield\s*\(\s*\)/) {
5224 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
5227 # check for comparisons against true and false
5228 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
5236 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
5238 my $type = lc($otype);
5239 if ($type =~ /^(?:true|false)$/) {
5240 if (("$test" eq "==" && "$type" eq "true") ||
5241 ("$test" eq "!=" && "$type" eq "false")) {
5245 CHK("BOOL_COMPARISON",
5246 "Using comparison to $otype is error prone\n" . $herecurr);
5248 ## maybe suggesting a correct construct would better
5249 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5254 # check for semaphores initialized locked
5255 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
5256 WARN("CONSIDER_COMPLETION",
5257 "consider using a completion\n" . $herecurr);
5260 # recommend kstrto* over simple_strto* and strict_strto*
5261 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
5262 WARN("CONSIDER_KSTRTO",
5263 "$1 is obsolete, use k$3 instead\n" . $herecurr);
5266 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
5267 if ($line =~ /^.\s*__initcall\s*\(/) {
5268 WARN("USE_DEVICE_INITCALL",
5269 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
5272 # check for various structs that are normally const (ops, kgdb, device_tree)
5273 my $const_structs = qr{
5275 address_space_operations|
5277 block_device_operations|
5282 file_lock_operations|
5292 lock_manager_operations|
5299 pipe_buf_operations|
5300 platform_hibernation_ops|
5301 platform_suspend_ops|
5306 soc_pcmcia_socket_ops|
5312 if ($line !~ /\bconst\b/ &&
5313 $line =~ /\bstruct\s+($const_structs)\b/) {
5314 WARN("CONST_STRUCT",
5315 "struct $1 should normally be const\n" .
5319 # use of NR_CPUS is usually wrong
5320 # ignore definitions of NR_CPUS and usage to define arrays as likely right
5321 if ($line =~ /\bNR_CPUS\b/ &&
5322 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
5323 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
5324 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
5325 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
5326 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
5329 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
5332 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
5333 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
5334 ERROR("DEFINE_ARCH_HAS",
5335 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
5338 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
5339 if ($^V && $^V ge 5.10.0 &&
5340 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
5341 WARN("LIKELY_MISUSE",
5342 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
5345 # whine mightly about in_atomic
5346 if ($line =~ /\bin_atomic\s*\(/) {
5347 if ($realfile =~ m@^drivers/@) {
5349 "do not use in_atomic in drivers\n" . $herecurr);
5350 } elsif ($realfile !~ m@^kernel/@) {
5352 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
5356 # check for lockdep_set_novalidate_class
5357 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
5358 $line =~ /__lockdep_no_validate__\s*\)/ ) {
5359 if ($realfile !~ m@^kernel/lockdep@ &&
5360 $realfile !~ m@^include/linux/lockdep@ &&
5361 $realfile !~ m@^drivers/base/core@) {
5363 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
5367 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
5368 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
5369 WARN("EXPORTED_WORLD_WRITABLE",
5370 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5373 # Mode permission misuses where it seems decimal should be octal
5374 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5375 if ($^V && $^V ge 5.10.0 &&
5376 $line =~ /$mode_perms_search/) {
5377 foreach my $entry (@mode_permission_funcs) {
5378 my $func = $entry->[0];
5379 my $arg_pos = $entry->[1];
5384 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
5386 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
5387 if ($line =~ /$test/) {
5389 $val = $6 if ($skip_args ne "");
5391 if ($val !~ /^0$/ &&
5392 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
5393 length($val) ne 4)) {
5394 ERROR("NON_OCTAL_PERMISSIONS",
5395 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
5396 } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) {
5397 ERROR("EXPORTED_WORLD_WRITABLE",
5398 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5405 # If we have no input at all, then there is nothing to report on
5406 # so just keep quiet.
5407 if ($#rawlines == -1) {
5411 # In mailback mode only produce a report in the negative, for
5412 # things that appear to be patches.
5413 if ($mailback && ($clean == 1 || !$is_patch)) {
5417 # This is not a patch, and we are are in 'no-patch' mode so
5419 if (!$chk_patch && !$is_patch) {
5424 ERROR("NOT_UNIFIED_DIFF",
5425 "Does not appear to be a unified-diff format patch\n");
5427 if ($is_patch && $chk_signoff && $signoff == 0) {
5428 ERROR("MISSING_SIGN_OFF",
5429 "Missing Signed-off-by: line(s)\n");
5432 print report_dump();
5433 if ($summary && !($clean == 1 && $quiet == 1)) {
5434 print "$filename " if ($summary_file);
5435 print "total: $cnt_error errors, $cnt_warn warnings, " .
5436 (($check)? "$cnt_chk checks, " : "") .
5437 "$cnt_lines lines checked\n";
5438 print "\n" if ($quiet == 0);
5443 if ($^V lt 5.10.0) {
5444 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
5445 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
5448 # If there were whitespace errors which cleanpatch can fix
5449 # then suggest that.
5450 if ($rpt_cleaners) {
5451 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
5452 print " scripts/cleanfile\n\n";
5457 hash_show_words(\%use_type, "Used");
5458 hash_show_words(\%ignore_type, "Ignored");
5460 if ($clean == 0 && $fix &&
5461 ("@rawlines" ne "@fixed" ||
5462 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
5463 my $newfile = $filename;
5464 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
5468 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
5470 open($f, '>', $newfile)
5471 or die "$P: Can't open $newfile for write\n";
5472 foreach my $fixed_line (@fixed) {
5475 if ($linecount > 3) {
5476 $fixed_line =~ s/^\+//;
5477 print $f $fixed_line . "\n";
5480 print $f $fixed_line . "\n";
5487 Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
5489 Do _NOT_ trust the results written to this file.
5490 Do _NOT_ submit these changes without inspecting them for correctness.
5492 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
5493 No warranties, expressed or implied...
5499 if ($clean == 1 && $quiet == 0) {
5500 print "$vname has no obvious style problems and is ready for submission.\n"
5502 if ($clean == 0 && $quiet == 0) {
5504 $vname has style problems, please review.
5506 If any of these errors are false positives, please report
5507 them to the maintainer, see CHECKPATCH in MAINTAINERS.