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
12 use Term::ANSIColor qw(:constants);
15 my $D = dirname(abs_path($P));
19 use Getopt::Long qw(:config no_auto_abbrev);
46 my $configuration_file = ".checkpatch.conf";
47 my $max_line_length = 80;
48 my $ignore_perl_version = 0;
49 my $minimum_perl_version = 5.10.0;
50 my $min_conf_desc_length = 4;
51 my $spelling_file = "$D/spelling.txt";
53 my $codespellfile = "/usr/share/codespell/dictionary.txt";
60 Usage: $P [OPTION]... [FILE]...
65 --no-tree run without a kernel tree
66 --no-signoff do not check for 'Signed-off-by' line
67 --patch treat FILE as patchfile (default)
68 --emacs emacs compile window format
69 --terse one line per report
70 --showfile emit diffed file position, not input file position
71 -f, --file treat FILE as regular source file
72 --subjective, --strict enable more subjective tests
73 --types TYPE(,TYPE2...) show only these comma separated message types
74 --ignore TYPE(,TYPE2...) ignore various comma separated message types
75 --max-line-length=n set the maximum line length, if exceeded, warn
76 --min-conf-desc-length=n set the min description length, if shorter, warn
77 --show-types show the message "types" in the output
78 --root=PATH PATH to the kernel tree root
79 --no-summary suppress the per-file summary
80 --mailback only produce a report in case of warnings/errors
81 --summary-file include the filename in summary
82 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
83 'values', 'possible', 'type', and 'attr' (default
85 --test-only=WORD report only warnings/errors containing WORD
87 --fix EXPERIMENTAL - may create horrible results
88 If correctable single-line errors exist, create
89 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
90 with potential errors corrected to the preferred
92 --fix-inplace EXPERIMENTAL - may create horrible results
93 Is the same as --fix, but overwrites the input
94 file. It's your fault if there's no backup or git
95 --ignore-perl-version override checking of perl version. expect
97 --codespell Use the codespell dictionary for spelling/typos
98 (default:/usr/share/codespell/dictionary.txt)
99 --codespellfile Use this codespell dictionary
100 --color Use colors when output is STDOUT (default: on)
101 -h, --help, --version display this help and exit
103 When FILE is - read standard input.
109 my $conf = which_conf($configuration_file);
112 open(my $conffile, '<', "$conf")
113 or warn "$P: Can't find a readable $configuration_file file $!\n";
115 while (<$conffile>) {
118 $line =~ s/\s*\n?$//g;
122 next if ($line =~ m/^\s*#/);
123 next if ($line =~ m/^\s*$/);
125 my @words = split(" ", $line);
126 foreach my $word (@words) {
127 last if ($word =~ m/^#/);
128 push (@conf_args, $word);
132 unshift(@ARGV, @conf_args) if @conf_args;
136 'q|quiet+' => \$quiet,
138 'signoff!' => \$chk_signoff,
139 'patch!' => \$chk_patch,
142 'showfile!' => \$showfile,
144 'subjective!' => \$check,
145 'strict!' => \$check,
146 'ignore=s' => \@ignore,
148 'show-types!' => \$show_types,
149 'max-line-length=i' => \$max_line_length,
150 'min-conf-desc-length=i' => \$min_conf_desc_length,
152 'summary!' => \$summary,
153 'mailback!' => \$mailback,
154 'summary-file!' => \$summary_file,
156 'fix-inplace!' => \$fix_inplace,
157 'ignore-perl-version!' => \$ignore_perl_version,
158 'debug=s' => \%debug,
159 'test-only=s' => \$tst_only,
160 'codespell!' => \$codespell,
161 'codespellfile=s' => \$codespellfile,
169 $fix = 1 if ($fix_inplace);
170 $check_orig = $check;
174 if ($^V && $^V lt $minimum_perl_version) {
175 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
176 if (!$ignore_perl_version) {
182 print "$P: no input files\n";
186 sub hash_save_array_words {
187 my ($hashRef, $arrayRef) = @_;
189 my @array = split(/,/, join(',', @$arrayRef));
190 foreach my $word (@array) {
191 $word =~ s/\s*\n?$//g;
194 $word =~ tr/[a-z]/[A-Z]/;
196 next if ($word =~ m/^\s*#/);
197 next if ($word =~ m/^\s*$/);
203 sub hash_show_words {
204 my ($hashRef, $prefix) = @_;
206 if (keys %$hashRef) {
207 print "\nNOTE: $prefix message types:";
208 foreach my $word (sort keys %$hashRef) {
215 hash_save_array_words(\%ignore_type, \@ignore);
216 hash_save_array_words(\%use_type, \@use);
219 my $dbg_possible = 0;
222 for my $key (keys %debug) {
224 eval "\${dbg_$key} = '$debug{$key}';";
228 my $rpt_cleaners = 0;
237 if (!top_of_kernel_tree($root)) {
238 die "$P: $root: --root does not point at a valid tree\n";
241 if (top_of_kernel_tree('.')) {
243 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
244 top_of_kernel_tree($1)) {
249 if (!defined $root) {
250 print "Must be run from the top-level dir. of a kernel tree\n";
255 my $emitted_corrupt = 0;
258 [A-Za-z_][A-Za-z\d_]*
259 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
261 our $Storage = qr{extern|static|asmlinkage};
273 our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
274 our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
275 our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
276 our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
277 our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
279 # Notes to $Attribute:
280 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
301 ____cacheline_aligned|
302 ____cacheline_aligned_in_smp|
303 ____cacheline_internodealigned_in_smp|
307 our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
308 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
309 our $Lval = qr{$Ident(?:$Member)*};
311 our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
312 our $Binary = qr{(?i)0b[01]+$Int_type?};
313 our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
314 our $Int = qr{[0-9]+$Int_type?};
315 our $Octal = qr{0[0-7]+$Int_type?};
316 our $String = qr{"[X\t]*"};
317 our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
318 our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
319 our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
320 our $Float = qr{$Float_hex|$Float_dec|$Float_int};
321 our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
322 our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
323 our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
324 our $Arithmetic = qr{\+|-|\*|\/|%};
328 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
331 our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
335 our $NonptrTypeMisordered;
336 our $NonptrTypeWithAttr;
340 our $DeclareMisordered;
342 our $NON_ASCII_UTF8 = qr{
343 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
344 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
345 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
346 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
347 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
348 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
349 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
353 [\x09\x0A\x0D\x20-\x7E] # ASCII
357 our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
358 our $typeOtherOSTypedefs = qr{(?x:
359 u_(?:char|short|int|long) | # bsd
360 u(?:nchar|short|int|long) # sysv
362 our $typeKernelTypedefs = qr{(?x:
363 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
366 our $typeTypedefs = qr{(?x:
368 $typeOtherOSTypedefs\b|
369 $typeKernelTypedefs\b
372 our $logFunctions = qr{(?x:
373 printk(?:_ratelimited|_once|)|
374 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
375 WARN(?:_RATELIMIT|_ONCE|)|
378 seq_vprintf|seq_printf|seq_puts
381 our $signature_tags = qr{(?xi:
392 our @typeListMisordered = (
393 qr{char\s+(?:un)?signed},
394 qr{int\s+(?:(?:un)?signed\s+)?short\s},
395 qr{int\s+short(?:\s+(?:un)?signed)},
396 qr{short\s+int(?:\s+(?:un)?signed)},
397 qr{(?:un)?signed\s+int\s+short},
398 qr{short\s+(?:un)?signed},
399 qr{long\s+int\s+(?:un)?signed},
400 qr{int\s+long\s+(?:un)?signed},
401 qr{long\s+(?:un)?signed\s+int},
402 qr{int\s+(?:un)?signed\s+long},
403 qr{int\s+(?:un)?signed},
404 qr{int\s+long\s+long\s+(?:un)?signed},
405 qr{long\s+long\s+int\s+(?:un)?signed},
406 qr{long\s+long\s+(?:un)?signed\s+int},
407 qr{long\s+long\s+(?:un)?signed},
408 qr{long\s+(?:un)?signed},
413 qr{(?:(?:un)?signed\s+)?char},
414 qr{(?:(?:un)?signed\s+)?short\s+int},
415 qr{(?:(?:un)?signed\s+)?short},
416 qr{(?:(?:un)?signed\s+)?int},
417 qr{(?:(?:un)?signed\s+)?long\s+int},
418 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
419 qr{(?:(?:un)?signed\s+)?long\s+long},
420 qr{(?:(?:un)?signed\s+)?long},
429 qr{${Ident}_handler},
430 qr{${Ident}_handler_fn},
433 our @typeListFile = ();
434 our @typeListWithAttr = (
436 qr{struct\s+$InitAttribute\s+$Ident},
437 qr{union\s+$InitAttribute\s+$Ident},
440 our @modifierList = (
443 our @modifierListFile = ();
445 our @mode_permission_funcs = (
447 ["module_param_(?:array|named|string)", 4],
448 ["module_param_array_named", 5],
449 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
450 ["proc_create(?:_data|)", 2],
451 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
454 #Create a search pattern for all these functions to speed up a loop below
455 our $mode_perms_search = "";
456 foreach my $entry (@mode_permission_funcs) {
457 $mode_perms_search .= '|' if ($mode_perms_search ne "");
458 $mode_perms_search .= $entry->[0];
461 our $mode_perms_world_writable = qr{
469 our $allowed_asm_includes = qr{(?x:
475 # memory.h: ARM has a custom one
477 # Load common spelling mistakes and build regular expression list.
481 if (open(my $spelling, '<', $spelling_file)) {
482 while (<$spelling>) {
485 $line =~ s/\s*\n?$//g;
488 next if ($line =~ m/^\s*#/);
489 next if ($line =~ m/^\s*$/);
491 my ($suspect, $fix) = split(/\|\|/, $line);
493 $spelling_fix{$suspect} = $fix;
497 warn "No typos will be found - file '$spelling_file': $!\n";
501 if (open(my $spelling, '<', $codespellfile)) {
502 while (<$spelling>) {
505 $line =~ s/\s*\n?$//g;
508 next if ($line =~ m/^\s*#/);
509 next if ($line =~ m/^\s*$/);
510 next if ($line =~ m/, disabled/i);
514 my ($suspect, $fix) = split(/->/, $line);
516 $spelling_fix{$suspect} = $fix;
520 warn "No codespell typos will be found - file '$codespellfile': $!\n";
524 $misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
527 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
528 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
529 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
530 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
531 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
537 (?:$Modifier\s+|const\s+)*
539 (?:typeof|__typeof__)\s*\([^\)]*\)|
543 (?:\s+$Modifier|\s+const)*
545 $NonptrTypeMisordered = qr{
546 (?:$Modifier\s+|const\s+)*
550 (?:\s+$Modifier|\s+const)*
552 $NonptrTypeWithAttr = qr{
553 (?:$Modifier\s+|const\s+)*
555 (?:typeof|__typeof__)\s*\([^\)]*\)|
559 (?:\s+$Modifier|\s+const)*
563 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
564 (?:\s+$Inline|\s+$Modifier)*
566 $TypeMisordered = qr{
567 $NonptrTypeMisordered
568 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
569 (?:\s+$Inline|\s+$Modifier)*
571 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
572 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
576 our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
578 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
579 # requires at least perl version v5.10.0
580 # Any use must be runtime checked with $^V
582 our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
583 our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
584 our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
586 our $declaration_macros = qr{(?x:
587 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
588 (?:$Storage\s+)?LIST_HEAD\s*\(|
589 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
594 return "" if (!defined($string));
596 while ($string =~ /^\s*\(.*\)\s*$/) {
597 $string =~ s@^\s*\(\s*@@;
598 $string =~ s@\s*\)\s*$@@;
601 $string =~ s@\s+@ @g;
606 sub seed_camelcase_file {
609 return if (!(-f $file));
613 open(my $include_file, '<', "$file")
614 or warn "$P: Can't read '$file' $!\n";
615 my $text = <$include_file>;
616 close($include_file);
618 my @lines = split('\n', $text);
620 foreach my $line (@lines) {
621 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
622 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
624 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
626 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
632 my $camelcase_seeded = 0;
633 sub seed_camelcase_includes {
634 return if ($camelcase_seeded);
637 my $camelcase_cache = "";
638 my @include_files = ();
640 $camelcase_seeded = 1;
643 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
644 chomp $git_last_include_commit;
645 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
647 my $last_mod_date = 0;
648 $files = `find $root/include -name "*.h"`;
649 @include_files = split('\n', $files);
650 foreach my $file (@include_files) {
651 my $date = POSIX::strftime("%Y%m%d%H%M",
652 localtime((stat $file)[9]));
653 $last_mod_date = $date if ($last_mod_date < $date);
655 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
658 if ($camelcase_cache ne "" && -f $camelcase_cache) {
659 open(my $camelcase_file, '<', "$camelcase_cache")
660 or warn "$P: Can't read '$camelcase_cache' $!\n";
661 while (<$camelcase_file>) {
665 close($camelcase_file);
671 $files = `git ls-files "include/*.h"`;
672 @include_files = split('\n', $files);
675 foreach my $file (@include_files) {
676 seed_camelcase_file($file);
679 if ($camelcase_cache ne "") {
680 unlink glob ".checkpatch-camelcase.*";
681 open(my $camelcase_file, '>', "$camelcase_cache")
682 or warn "$P: Can't write '$camelcase_cache' $!\n";
683 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
684 print $camelcase_file ("$_\n");
686 close($camelcase_file);
690 sub git_commit_info {
691 my ($commit, $id, $desc) = @_;
693 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
695 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
696 $output =~ s/^\s*//gm;
697 my @lines = split("\n", $output);
699 return ($id, $desc) if ($#lines < 0);
701 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
702 # Maybe one day convert this block of bash into something that returns
703 # all matching commit ids, but it's very slow...
705 # echo "checking commits $1..."
706 # git rev-list --remotes | grep -i "^$1" |
707 # while read line ; do
708 # git log --format='%H %s' -1 $line |
709 # echo "commit $(cut -c 1-12,41-)"
711 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
713 $id = substr($lines[0], 0, 12);
714 $desc = substr($lines[0], 41);
720 $chk_signoff = 0 if ($file);
725 my @fixed_inserted = ();
726 my @fixed_deleted = ();
730 for my $filename (@ARGV) {
733 open($FILE, '-|', "diff -u /dev/null $filename") ||
734 die "$P: $filename: diff failed - $!\n";
735 } elsif ($filename eq '-') {
736 open($FILE, '<&STDIN');
738 open($FILE, '<', "$filename") ||
739 die "$P: $filename: open failed - $!\n";
741 if ($filename eq '-') {
742 $vname = 'Your patch';
752 if ($#ARGV > 0 && $quiet == 0) {
753 print '-' x length($vname) . "\n";
755 print '-' x length($vname) . "\n";
758 if (!process($filename)) {
764 @fixed_inserted = ();
767 @modifierListFile = ();
773 hash_show_words(\%use_type, "Used");
774 hash_show_words(\%ignore_type, "Ignored");
779 NOTE: perl $^V is not modern enough to detect all possible issues.
780 An upgrade to at least perl v5.10.0 is suggested.
786 NOTE: If any of the errors are false positives, please report
787 them to the maintainer, see CHECKPATCH in MAINTAINERS.
794 sub top_of_kernel_tree {
798 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
799 "README", "Documentation", "arch", "include", "drivers",
800 "fs", "init", "ipc", "kernel", "lib", "scripts",
803 foreach my $check (@tree_check) {
804 if (! -e $root . '/' . $check) {
812 my ($formatted_email) = @_;
818 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
821 $comment = $3 if defined $3;
822 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
824 $comment = $2 if defined $2;
825 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
827 $comment = $2 if defined $2;
828 $formatted_email =~ s/$address.*$//;
829 $name = $formatted_email;
831 $name =~ s/^\"|\"$//g;
832 # If there's a name left after stripping spaces and
833 # leading quotes, and the address doesn't have both
834 # leading and trailing angle brackets, the address
836 # "joe smith joe@smith.com" bad
837 # "joe smith <joe@smith.com" bad
838 if ($name ne "" && $address !~ /^<[^>]+>$/) {
846 $name =~ s/^\"|\"$//g;
847 $address = trim($address);
848 $address =~ s/^\<|\>$//g;
850 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
851 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
855 return ($name, $address, $comment);
859 my ($name, $address) = @_;
864 $name =~ s/^\"|\"$//g;
865 $address = trim($address);
867 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
868 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
873 $formatted_email = "$address";
875 $formatted_email = "$name <$address>";
878 return $formatted_email;
884 foreach my $path (split(/:/, $ENV{PATH})) {
885 if (-e "$path/$bin") {
896 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
897 if (-e "$path/$conf") {
898 return "$path/$conf";
910 for my $c (split(//, $str)) {
914 for (; ($n % 8) != 0; $n++) {
926 (my $res = shift) =~ tr/\t/ /c;
933 # Drop the diff line leader and expand tabs
935 $line = expand_tabs($line);
937 # Pick the indent from the front of the line.
938 my ($white) = ($line =~ /^(\s*)/);
940 return (length($line), length($white));
943 my $sanitise_quote = '';
945 sub sanitise_line_reset {
946 my ($in_comment) = @_;
949 $sanitise_quote = '*/';
951 $sanitise_quote = '';
964 # Always copy over the diff marker.
965 $res = substr($line, 0, 1);
967 for ($off = 1; $off < length($line); $off++) {
968 $c = substr($line, $off, 1);
970 # Comments we are wacking completly including the begin
971 # and end, all to $;.
972 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
973 $sanitise_quote = '*/';
975 substr($res, $off, 2, "$;$;");
979 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
980 $sanitise_quote = '';
981 substr($res, $off, 2, "$;$;");
985 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
986 $sanitise_quote = '//';
988 substr($res, $off, 2, $sanitise_quote);
993 # A \ in a string means ignore the next character.
994 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
996 substr($res, $off, 2, 'XX');
1001 if ($c eq "'" || $c eq '"') {
1002 if ($sanitise_quote eq '') {
1003 $sanitise_quote = $c;
1005 substr($res, $off, 1, $c);
1007 } elsif ($sanitise_quote eq $c) {
1008 $sanitise_quote = '';
1012 #print "c<$c> SQ<$sanitise_quote>\n";
1013 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1014 substr($res, $off, 1, $;);
1015 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1016 substr($res, $off, 1, $;);
1017 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1018 substr($res, $off, 1, 'X');
1020 substr($res, $off, 1, $c);
1024 if ($sanitise_quote eq '//') {
1025 $sanitise_quote = '';
1028 # The pathname on a #include may be surrounded by '<' and '>'.
1029 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
1030 my $clean = 'X' x length($1);
1031 $res =~ s@\<.*\>@<$clean>@;
1033 # The whole of a #error is a string.
1034 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
1035 my $clean = 'X' x length($1);
1036 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
1042 sub get_quoted_string {
1043 my ($line, $rawline) = @_;
1045 return "" if ($line !~ m/($String)/g);
1046 return substr($rawline, $-[0], $+[0] - $-[0]);
1049 sub ctx_statement_block {
1050 my ($linenr, $remain, $off) = @_;
1051 my $line = $linenr - 1;
1054 my $coff = $off - 1;
1068 @stack = (['', 0]) if ($#stack == -1);
1070 #warn "CSB: blk<$blk> remain<$remain>\n";
1071 # If we are about to drop off the end, pull in more
1074 for (; $remain > 0; $line++) {
1075 last if (!defined $lines[$line]);
1076 next if ($lines[$line] =~ /^-/);
1079 $blk .= $lines[$line] . "\n";
1080 $len = length($blk);
1084 # Bail if there is no further context.
1085 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1089 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1095 $c = substr($blk, $off, 1);
1096 $remainder = substr($blk, $off);
1098 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1100 # Handle nested #if/#else.
1101 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1102 push(@stack, [ $type, $level ]);
1103 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1104 ($type, $level) = @{$stack[$#stack - 1]};
1105 } elsif ($remainder =~ /^#\s*endif\b/) {
1106 ($type, $level) = @{pop(@stack)};
1109 # Statement ends at the ';' or a close '}' at the
1111 if ($level == 0 && $c eq ';') {
1115 # An else is really a conditional as long as its not else if
1116 if ($level == 0 && $coff_set == 0 &&
1117 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1118 $remainder =~ /^(else)(?:\s|{)/ &&
1119 $remainder !~ /^else\s+if\b/) {
1120 $coff = $off + length($1) - 1;
1122 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1123 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1126 if (($type eq '' || $type eq '(') && $c eq '(') {
1130 if ($type eq '(' && $c eq ')') {
1132 $type = ($level != 0)? '(' : '';
1134 if ($level == 0 && $coff < $soff) {
1137 #warn "CSB: mark coff<$coff>\n";
1140 if (($type eq '' || $type eq '{') && $c eq '{') {
1144 if ($type eq '{' && $c eq '}') {
1146 $type = ($level != 0)? '{' : '';
1149 if (substr($blk, $off + 1, 1) eq ';') {
1155 # Preprocessor commands end at the newline unless escaped.
1156 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1164 # We are truly at the end, so shuffle to the next line.
1171 my $statement = substr($blk, $soff, $off - $soff + 1);
1172 my $condition = substr($blk, $soff, $coff - $soff + 1);
1174 #warn "STATEMENT<$statement>\n";
1175 #warn "CONDITION<$condition>\n";
1177 #print "coff<$coff> soff<$off> loff<$loff>\n";
1179 return ($statement, $condition,
1180 $line, $remain + 1, $off - $loff + 1, $level);
1183 sub statement_lines {
1186 # Strip the diff line prefixes and rip blank lines at start and end.
1187 $stmt =~ s/(^|\n)./$1/g;
1191 my @stmt_lines = ($stmt =~ /\n/g);
1193 return $#stmt_lines + 2;
1196 sub statement_rawlines {
1199 my @stmt_lines = ($stmt =~ /\n/g);
1201 return $#stmt_lines + 2;
1204 sub statement_block_size {
1207 $stmt =~ s/(^|\n)./$1/g;
1213 my @stmt_lines = ($stmt =~ /\n/g);
1214 my @stmt_statements = ($stmt =~ /;/g);
1216 my $stmt_lines = $#stmt_lines + 2;
1217 my $stmt_statements = $#stmt_statements + 1;
1219 if ($stmt_lines > $stmt_statements) {
1222 return $stmt_statements;
1226 sub ctx_statement_full {
1227 my ($linenr, $remain, $off) = @_;
1228 my ($statement, $condition, $level);
1232 # Grab the first conditional/block pair.
1233 ($statement, $condition, $linenr, $remain, $off, $level) =
1234 ctx_statement_block($linenr, $remain, $off);
1235 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1236 push(@chunks, [ $condition, $statement ]);
1237 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1238 return ($level, $linenr, @chunks);
1241 # Pull in the following conditional/block pairs and see if they
1242 # could continue the statement.
1244 ($statement, $condition, $linenr, $remain, $off, $level) =
1245 ctx_statement_block($linenr, $remain, $off);
1246 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1247 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1249 push(@chunks, [ $condition, $statement ]);
1252 return ($level, $linenr, @chunks);
1256 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1258 my $start = $linenr - 1;
1265 my @stack = ($level);
1266 for ($line = $start; $remain > 0; $line++) {
1267 next if ($rawlines[$line] =~ /^-/);
1270 $blk .= $rawlines[$line];
1272 # Handle nested #if/#else.
1273 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1274 push(@stack, $level);
1275 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1276 $level = $stack[$#stack - 1];
1277 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1278 $level = pop(@stack);
1281 foreach my $c (split(//, $lines[$line])) {
1282 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1288 if ($c eq $close && $level > 0) {
1290 last if ($level == 0);
1291 } elsif ($c eq $open) {
1296 if (!$outer || $level <= 1) {
1297 push(@res, $rawlines[$line]);
1300 last if ($level == 0);
1303 return ($level, @res);
1305 sub ctx_block_outer {
1306 my ($linenr, $remain) = @_;
1308 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1312 my ($linenr, $remain) = @_;
1314 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1318 my ($linenr, $remain, $off) = @_;
1320 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1323 sub ctx_block_level {
1324 my ($linenr, $remain) = @_;
1326 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1328 sub ctx_statement_level {
1329 my ($linenr, $remain, $off) = @_;
1331 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1334 sub ctx_locate_comment {
1335 my ($first_line, $end_line) = @_;
1337 # Catch a comment on the end of the line itself.
1338 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1339 return $current_comment if (defined $current_comment);
1341 # Look through the context and try and figure out if there is a
1344 $current_comment = '';
1345 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1346 my $line = $rawlines[$linenr - 1];
1348 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1351 if ($line =~ m@/\*@) {
1354 if (!$in_comment && $current_comment ne '') {
1355 $current_comment = '';
1357 $current_comment .= $line . "\n" if ($in_comment);
1358 if ($line =~ m@\*/@) {
1363 chomp($current_comment);
1364 return($current_comment);
1366 sub ctx_has_comment {
1367 my ($first_line, $end_line) = @_;
1368 my $cmt = ctx_locate_comment($first_line, $end_line);
1370 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1371 ##print "CMMT: $cmt\n";
1373 return ($cmt ne '');
1377 my ($linenr, $cnt) = @_;
1379 my $offset = $linenr - 1;
1384 $line = $rawlines[$offset++];
1385 next if (defined($line) && $line =~ /^-/);
1397 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1400 $coded = sprintf("^%c", unpack('C', $2) + 64);
1409 my $av_preprocessor = 0;
1414 sub annotate_reset {
1415 $av_preprocessor = 0;
1417 @av_paren_type = ('E');
1418 $av_pend_colon = 'O';
1421 sub annotate_values {
1422 my ($stream, $type) = @_;
1425 my $var = '_' x length($stream);
1428 print "$stream\n" if ($dbg_values > 1);
1430 while (length($cur)) {
1431 @av_paren_type = ('E') if ($#av_paren_type < 0);
1432 print " <" . join('', @av_paren_type) .
1433 "> <$type> <$av_pending>" if ($dbg_values > 1);
1434 if ($cur =~ /^(\s+)/o) {
1435 print "WS($1)\n" if ($dbg_values > 1);
1436 if ($1 =~ /\n/ && $av_preprocessor) {
1437 $type = pop(@av_paren_type);
1438 $av_preprocessor = 0;
1441 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1442 print "CAST($1)\n" if ($dbg_values > 1);
1443 push(@av_paren_type, $type);
1446 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1447 print "DECLARE($1)\n" if ($dbg_values > 1);
1450 } elsif ($cur =~ /^($Modifier)\s*/) {
1451 print "MODIFIER($1)\n" if ($dbg_values > 1);
1454 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1455 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1456 $av_preprocessor = 1;
1457 push(@av_paren_type, $type);
1463 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1464 print "UNDEF($1)\n" if ($dbg_values > 1);
1465 $av_preprocessor = 1;
1466 push(@av_paren_type, $type);
1468 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1469 print "PRE_START($1)\n" if ($dbg_values > 1);
1470 $av_preprocessor = 1;
1472 push(@av_paren_type, $type);
1473 push(@av_paren_type, $type);
1476 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1477 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1478 $av_preprocessor = 1;
1480 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1484 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1485 print "PRE_END($1)\n" if ($dbg_values > 1);
1487 $av_preprocessor = 1;
1489 # Assume all arms of the conditional end as this
1490 # one does, and continue as if the #endif was not here.
1491 pop(@av_paren_type);
1492 push(@av_paren_type, $type);
1495 } elsif ($cur =~ /^(\\\n)/o) {
1496 print "PRECONT($1)\n" if ($dbg_values > 1);
1498 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1499 print "ATTR($1)\n" if ($dbg_values > 1);
1500 $av_pending = $type;
1503 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1504 print "SIZEOF($1)\n" if ($dbg_values > 1);
1510 } elsif ($cur =~ /^(if|while|for)\b/o) {
1511 print "COND($1)\n" if ($dbg_values > 1);
1515 } elsif ($cur =~/^(case)/o) {
1516 print "CASE($1)\n" if ($dbg_values > 1);
1517 $av_pend_colon = 'C';
1520 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1521 print "KEYWORD($1)\n" if ($dbg_values > 1);
1524 } elsif ($cur =~ /^(\()/o) {
1525 print "PAREN('$1')\n" if ($dbg_values > 1);
1526 push(@av_paren_type, $av_pending);
1530 } elsif ($cur =~ /^(\))/o) {
1531 my $new_type = pop(@av_paren_type);
1532 if ($new_type ne '_') {
1534 print "PAREN('$1') -> $type\n"
1535 if ($dbg_values > 1);
1537 print "PAREN('$1')\n" if ($dbg_values > 1);
1540 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1541 print "FUNC($1)\n" if ($dbg_values > 1);
1545 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1546 if (defined $2 && $type eq 'C' || $type eq 'T') {
1547 $av_pend_colon = 'B';
1548 } elsif ($type eq 'E') {
1549 $av_pend_colon = 'L';
1551 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1554 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1555 print "IDENT($1)\n" if ($dbg_values > 1);
1558 } elsif ($cur =~ /^($Assignment)/o) {
1559 print "ASSIGN($1)\n" if ($dbg_values > 1);
1562 } elsif ($cur =~/^(;|{|})/) {
1563 print "END($1)\n" if ($dbg_values > 1);
1565 $av_pend_colon = 'O';
1567 } elsif ($cur =~/^(,)/) {
1568 print "COMMA($1)\n" if ($dbg_values > 1);
1571 } elsif ($cur =~ /^(\?)/o) {
1572 print "QUESTION($1)\n" if ($dbg_values > 1);
1575 } elsif ($cur =~ /^(:)/o) {
1576 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1578 substr($var, length($res), 1, $av_pend_colon);
1579 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1584 $av_pend_colon = 'O';
1586 } elsif ($cur =~ /^(\[)/o) {
1587 print "CLOSE($1)\n" if ($dbg_values > 1);
1590 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1593 print "OPV($1)\n" if ($dbg_values > 1);
1600 substr($var, length($res), 1, $variant);
1603 } elsif ($cur =~ /^($Operators)/o) {
1604 print "OP($1)\n" if ($dbg_values > 1);
1605 if ($1 ne '++' && $1 ne '--') {
1609 } elsif ($cur =~ /(^.)/o) {
1610 print "C($1)\n" if ($dbg_values > 1);
1613 $cur = substr($cur, length($1));
1614 $res .= $type x length($1);
1618 return ($res, $var);
1622 my ($possible, $line) = @_;
1623 my $notPermitted = qr{(?:
1640 ^(?:typedef|struct|enum)\b
1642 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1643 if ($possible !~ $notPermitted) {
1644 # Check for modifiers.
1645 $possible =~ s/\s*$Storage\s*//g;
1646 $possible =~ s/\s*$Sparse\s*//g;
1647 if ($possible =~ /^\s*$/) {
1649 } elsif ($possible =~ /\s/) {
1650 $possible =~ s/\s*$Type\s*//g;
1651 for my $modifier (split(' ', $possible)) {
1652 if ($modifier !~ $notPermitted) {
1653 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1654 push(@modifierListFile, $modifier);
1659 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1660 push(@typeListFile, $possible);
1664 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1673 return defined $use_type{$type} if (scalar keys %use_type > 0);
1675 return !defined $ignore_type{$type};
1679 my ($level, $type, $msg) = @_;
1681 if (!show_type($type) ||
1682 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
1686 if (-t STDOUT && $color) {
1687 if ($level eq 'ERROR') {
1689 } elsif ($level eq 'WARNING') {
1695 $output .= $prefix . $level . ':';
1697 $output .= BLUE if (-t STDOUT && $color);
1698 $output .= "$type:";
1700 $output .= RESET if (-t STDOUT && $color);
1701 $output .= ' ' . $msg . "\n";
1704 my @lines = split("\n", $output, -1);
1705 splice(@lines, 1, 1);
1706 $output = join("\n", @lines);
1708 $output = (split('\n', $output))[0] . "\n" if ($terse);
1710 push(our @report, $output);
1719 sub fixup_current_range {
1720 my ($lineRef, $offset, $length) = @_;
1722 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1725 my $no = $o + $offset;
1726 my $nl = $l + $length;
1727 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1731 sub fix_inserted_deleted_lines {
1732 my ($linesRef, $insertedRef, $deletedRef) = @_;
1734 my $range_last_linenr = 0;
1735 my $delta_offset = 0;
1740 my $next_insert = 0;
1741 my $next_delete = 0;
1745 my $inserted = @{$insertedRef}[$next_insert++];
1746 my $deleted = @{$deletedRef}[$next_delete++];
1748 foreach my $old_line (@{$linesRef}) {
1750 my $line = $old_line; #don't modify the array
1751 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
1753 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1754 $range_last_linenr = $new_linenr;
1755 fixup_current_range(\$line, $delta_offset, 0);
1758 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1759 $deleted = @{$deletedRef}[$next_delete++];
1761 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1764 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1765 push(@lines, ${$inserted}{'LINE'});
1766 $inserted = @{$insertedRef}[$next_insert++];
1768 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1772 push(@lines, $line);
1782 sub fix_insert_line {
1783 my ($linenr, $line) = @_;
1789 push(@fixed_inserted, $inserted);
1792 sub fix_delete_line {
1793 my ($linenr, $line) = @_;
1800 push(@fixed_deleted, $deleted);
1804 my ($type, $msg) = @_;
1806 if (report("ERROR", $type, $msg)) {
1814 my ($type, $msg) = @_;
1816 if (report("WARNING", $type, $msg)) {
1824 my ($type, $msg) = @_;
1826 if ($check && report("CHECK", $type, $msg)) {
1834 sub check_absolute_file {
1835 my ($absolute, $herecurr) = @_;
1836 my $file = $absolute;
1838 ##print "absolute<$absolute>\n";
1840 # See if any suffix of this path is a path within the tree.
1841 while ($file =~ s@^[^/]*/@@) {
1842 if (-f "$root/$file") {
1843 ##print "file<$file>\n";
1851 # It is, so see if the prefix is acceptable.
1852 my $prefix = $absolute;
1853 substr($prefix, -length($file)) = '';
1855 ##print "prefix<$prefix>\n";
1856 if ($prefix ne ".../") {
1857 WARN("USE_RELATIVE_PATH",
1858 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1865 $string =~ s/^\s+|\s+$//g;
1873 $string =~ s/^\s+//;
1881 $string =~ s/\s+$//;
1886 sub string_find_replace {
1887 my ($string, $find, $replace) = @_;
1889 $string =~ s/$find/$replace/g;
1897 my $source_indent = 8;
1898 my $max_spaces_before_tab = $source_indent - 1;
1899 my $spaces_to_tab = " " x $source_indent;
1901 #convert leading spaces to tabs
1902 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1903 #Remove spaces before a tab
1904 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1909 sub pos_last_openparen {
1914 my $opens = $line =~ tr/\(/\(/;
1915 my $closes = $line =~ tr/\)/\)/;
1917 my $last_openparen = 0;
1919 if (($opens == 0) || ($closes >= $opens)) {
1923 my $len = length($line);
1925 for ($pos = 0; $pos < $len; $pos++) {
1926 my $string = substr($line, $pos);
1927 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1928 $pos += length($1) - 1;
1929 } elsif (substr($line, $pos, 1) eq '(') {
1930 $last_openparen = $pos;
1931 } elsif (index($string, '(') == -1) {
1936 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
1940 my $filename = shift;
1946 my $stashrawline="";
1957 my $in_header_lines = $file ? 0 : 1;
1958 my $in_commit_log = 0; #Scanning lines before patch
1959 my $commit_log_long_line = 0;
1960 my $commit_log_has_diff = 0;
1961 my $reported_maintainer_file = 0;
1962 my $non_utf8_charset = 0;
1964 my $last_blank_line = 0;
1965 my $last_coalesced_string_linenr = -1;
1973 # Trace the real file/line as we go.
1979 my $comment_edge = 0;
1983 my $prev_values = 'E';
1986 my %suppress_ifbraces;
1987 my %suppress_whiletrailers;
1988 my %suppress_export;
1989 my $suppress_statement = 0;
1991 my %signatures = ();
1993 # Pre-scan the patch sanitizing the lines.
1994 # Pre-scan the patch looking for any __setup documentation.
1996 my @setup_docs = ();
1999 my $camelcase_file_seeded = 0;
2001 sanitise_line_reset();
2003 foreach my $rawline (@rawlines) {
2007 push(@fixed, $rawline) if ($fix);
2009 if ($rawline=~/^\+\+\+\s+(\S+)/) {
2011 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
2016 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2025 # Guestimate if this is a continuing comment. Run
2026 # the context looking for a comment "edge". If this
2027 # edge is a close comment then we must be in a comment
2031 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2032 next if (defined $rawlines[$ln - 1] &&
2033 $rawlines[$ln - 1] =~ /^-/);
2035 #print "RAW<$rawlines[$ln - 1]>\n";
2036 last if (!defined $rawlines[$ln - 1]);
2037 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2038 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2043 if (defined $edge && $edge eq '*/') {
2047 # Guestimate if this is a continuing comment. If this
2048 # is the start of a diff block and this line starts
2049 # ' *' then it is very likely a comment.
2050 if (!defined $edge &&
2051 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
2056 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2057 sanitise_line_reset($in_comment);
2059 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
2060 # Standardise the strings and chars within the input to
2061 # simplify matching -- only bother with positive lines.
2062 $line = sanitise_line($rawline);
2064 push(@lines, $line);
2067 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2072 #print "==>$rawline\n";
2073 #print "-->$line\n";
2075 if ($setup_docs && $line =~ /^\+/) {
2076 push(@setup_docs, $line);
2085 foreach my $line (@lines) {
2088 my $sline = $line; #copy of $line
2089 $sline =~ s/$;/ /g; #with comments as spaces
2091 my $rawline = $rawlines[$linenr - 1];
2093 #extract the line range in the file after the patch is applied
2094 if (!$in_commit_log &&
2095 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2097 $first_line = $linenr + 1;
2107 %suppress_ifbraces = ();
2108 %suppress_whiletrailers = ();
2109 %suppress_export = ();
2110 $suppress_statement = 0;
2113 # track the line number as we move through the hunk, note that
2114 # new versions of GNU diff omit the leading space on completely
2115 # blank context lines so we need to count that too.
2116 } elsif ($line =~ /^( |\+|$)/) {
2118 $realcnt-- if ($realcnt != 0);
2120 # Measure the line length and indent.
2121 ($length, $indent) = line_stats($rawline);
2123 # Track the previous line.
2124 ($prevline, $stashline) = ($stashline, $line);
2125 ($previndent, $stashindent) = ($stashindent, $indent);
2126 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2128 #warn "line<$line>\n";
2130 } elsif ($realcnt == 1) {
2134 my $hunk_line = ($realcnt != 0);
2136 $here = "#$linenr: " if (!$file);
2137 $here = "#$realline: " if ($file);
2140 # extract the filename as it passes
2141 if ($line =~ /^diff --git.*?(\S+)$/) {
2143 $realfile =~ s@^([^/]*)/@@ if (!$file);
2146 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2148 $realfile =~ s@^([^/]*)/@@ if (!$file);
2152 if (!$file && $tree && $p1_prefix ne '' &&
2153 -e "$root/$p1_prefix") {
2154 WARN("PATCH_PREFIX",
2155 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
2158 if ($realfile =~ m@^include/asm/@) {
2159 ERROR("MODIFIED_INCLUDE_ASM",
2160 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2165 #make up the handle for any error we report on this line
2167 $prefix = "$realfile:$realline: "
2170 $prefix = "$filename:$realline: ";
2172 $prefix = "$filename:$linenr: ";
2177 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
2180 $check = $check_orig;
2185 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
2187 my $hereline = "$here\n$rawline\n";
2188 my $herecurr = "$here\n$rawline\n";
2189 my $hereprev = "$here\n$prevrawline\n$rawline\n";
2191 $cnt_lines++ if ($realcnt != 0);
2193 # Check if the commit log has what seems like a diff which can confuse patch
2194 if ($in_commit_log && !$commit_log_has_diff &&
2195 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2196 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2197 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2198 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2199 ERROR("DIFF_IN_COMMIT_MSG",
2200 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2201 $commit_log_has_diff = 1;
2204 # Check for incorrect file permissions
2205 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2206 my $permhere = $here . "FILE: $realfile\n";
2207 if ($realfile !~ m@scripts/@ &&
2208 $realfile !~ /\.(py|pl|awk|sh)$/) {
2209 ERROR("EXECUTE_PERMISSIONS",
2210 "do not set execute permissions for source files\n" . $permhere);
2214 # Check the patch for a signoff:
2215 if ($line =~ /^\s*signed-off-by:/i) {
2220 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2221 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2222 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2223 $reported_maintainer_file = 1;
2226 # Check signature styles
2227 if (!$in_header_lines &&
2228 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
2229 my $space_before = $1;
2231 my $space_after = $3;
2233 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2235 if ($sign_off !~ /$signature_tags/) {
2236 WARN("BAD_SIGN_OFF",
2237 "Non-standard signature: $sign_off\n" . $herecurr);
2239 if (defined $space_before && $space_before ne "") {
2240 if (WARN("BAD_SIGN_OFF",
2241 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2243 $fixed[$fixlinenr] =
2244 "$ucfirst_sign_off $email";
2247 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
2248 if (WARN("BAD_SIGN_OFF",
2249 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2251 $fixed[$fixlinenr] =
2252 "$ucfirst_sign_off $email";
2256 if (!defined $space_after || $space_after ne " ") {
2257 if (WARN("BAD_SIGN_OFF",
2258 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2260 $fixed[$fixlinenr] =
2261 "$ucfirst_sign_off $email";
2265 my ($email_name, $email_address, $comment) = parse_email($email);
2266 my $suggested_email = format_email(($email_name, $email_address));
2267 if ($suggested_email eq "") {
2268 ERROR("BAD_SIGN_OFF",
2269 "Unrecognized email address: '$email'\n" . $herecurr);
2271 my $dequoted = $suggested_email;
2272 $dequoted =~ s/^"//;
2273 $dequoted =~ s/" </ </;
2274 # Don't force email to have quotes
2275 # Allow just an angle bracketed address
2276 if ("$dequoted$comment" ne $email &&
2277 "<$email_address>$comment" ne $email &&
2278 "$suggested_email$comment" ne $email) {
2279 WARN("BAD_SIGN_OFF",
2280 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
2284 # Check for duplicate signatures
2285 my $sig_nospace = $line;
2286 $sig_nospace =~ s/\s//g;
2287 $sig_nospace = lc($sig_nospace);
2288 if (defined $signatures{$sig_nospace}) {
2289 WARN("BAD_SIGN_OFF",
2290 "Duplicate signature\n" . $herecurr);
2292 $signatures{$sig_nospace} = 1;
2296 # Check email subject for common tools that don't need to be mentioned
2297 if ($in_header_lines &&
2298 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2299 WARN("EMAIL_SUBJECT",
2300 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2303 # Check for old stable address
2304 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2305 ERROR("STABLE_ADDRESS",
2306 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2309 # Check for unwanted Gerrit info
2310 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2311 ERROR("GERRIT_CHANGE_ID",
2312 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2315 # Check for line lengths > 75 in commit log, warn once
2316 if ($in_commit_log && !$commit_log_long_line &&
2317 length($line) > 75) {
2318 WARN("COMMIT_LOG_LONG_LINE",
2319 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2320 $commit_log_long_line = 1;
2323 # Check for git id commit length and improperly formed commit descriptions
2324 if ($in_commit_log &&
2325 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
2326 $line =~ /\b[0-9a-f]{12,40}\b/i)) {
2327 my $init_char = "c";
2328 my $orig_commit = "";
2335 my $id = '0123456789ab';
2336 my $orig_desc = "commit description";
2337 my $description = "";
2339 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2341 $orig_commit = lc($2);
2342 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2343 $orig_commit = lc($1);
2346 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2347 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2348 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2349 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2350 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2353 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2354 defined $rawlines[$linenr] &&
2355 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2358 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2359 defined $rawlines[$linenr] &&
2360 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2361 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2363 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2364 $orig_desc .= " " . $1;
2368 ($id, $description) = git_commit_info($orig_commit,
2371 if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) {
2372 ERROR("GIT_COMMIT_ID",
2373 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2377 # Check for added, moved or deleted files
2378 if (!$reported_maintainer_file && !$in_commit_log &&
2379 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2380 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2381 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2382 (defined($1) || defined($2))))) {
2383 $reported_maintainer_file = 1;
2384 WARN("FILE_PATH_CHANGES",
2385 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2388 # Check for wrappage within a valid hunk of the file
2389 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
2390 ERROR("CORRUPTED_PATCH",
2391 "patch seems to be corrupt (line wrapped?)\n" .
2392 $herecurr) if (!$emitted_corrupt++);
2395 # Check for absolute kernel paths.
2397 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2400 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2401 check_absolute_file($1, $herecurr)) {
2404 check_absolute_file($file, $herecurr);
2409 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2410 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
2411 $rawline !~ m/^$UTF8*$/) {
2412 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2414 my $blank = copy_spacing($rawline);
2415 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2416 my $hereptr = "$hereline$ptr\n";
2419 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
2422 # Check if it's the start of a commit log
2423 # (not a header line and we haven't seen the patch filename)
2424 if ($in_header_lines && $realfile =~ /^$/ &&
2425 !($rawline =~ /^\s+\S/ ||
2426 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
2427 $in_header_lines = 0;
2431 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2432 # declined it, i.e defined some charset where it is missing.
2433 if ($in_header_lines &&
2434 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2436 $non_utf8_charset = 1;
2439 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
2440 $rawline =~ /$NON_ASCII_UTF8/) {
2441 WARN("UTF8_BEFORE_PATCH",
2442 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2445 # Check for various typo / spelling mistakes
2446 if (defined($misspellings) &&
2447 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
2448 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
2450 my $typo_fix = $spelling_fix{lc($typo)};
2451 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2452 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2453 my $msg_type = \&WARN;
2454 $msg_type = \&CHK if ($file);
2455 if (&{$msg_type}("TYPO_SPELLING",
2456 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2458 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2463 # ignore non-hunk lines and lines being removed
2464 next if (!$hunk_line || $line =~ /^-/);
2466 #trailing whitespace
2467 if ($line =~ /^\+.*\015/) {
2468 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2469 if (ERROR("DOS_LINE_ENDINGS",
2470 "DOS line endings\n" . $herevet) &&
2472 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
2474 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2475 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2476 if (ERROR("TRAILING_WHITESPACE",
2477 "trailing whitespace\n" . $herevet) &&
2479 $fixed[$fixlinenr] =~ s/\s+$//;
2485 # Check for FSF mailing addresses.
2486 if ($rawline =~ /\bwrite to the Free/i ||
2487 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2488 $rawline =~ /\b51\s+Franklin\s+St/i) {
2489 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2490 my $msg_type = \&ERROR;
2491 $msg_type = \&CHK if ($file);
2492 &{$msg_type}("FSF_MAILING_ADDRESS",
2493 "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)
2496 # check for Kconfig help text having a real description
2497 # Only applies when adding the entry originally, after that we do not have
2498 # sufficient context to determine whether it is indeed long enough.
2499 if ($realfile =~ /Kconfig/ &&
2500 $line =~ /^\+\s*config\s+/) {
2503 my $ln = $linenr + 1;
2507 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
2508 $f = $lines[$ln - 1];
2509 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2510 $is_end = $lines[$ln - 1] =~ /^\+/;
2512 next if ($f =~ /^-/);
2513 last if (!$file && $f =~ /^\@\@/);
2515 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
2517 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
2524 next if ($f =~ /^$/);
2525 if ($f =~ /^\s*config\s/) {
2531 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2532 WARN("CONFIG_DESCRIPTION",
2533 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2535 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2538 # discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2539 if ($realfile =~ /Kconfig/ &&
2540 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2541 WARN("CONFIG_EXPERIMENTAL",
2542 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2545 # discourage the use of boolean for type definition attributes of Kconfig options
2546 if ($realfile =~ /Kconfig/ &&
2547 $line =~ /^\+\s*\bboolean\b/) {
2548 WARN("CONFIG_TYPE_BOOLEAN",
2549 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2552 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2553 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2556 'EXTRA_AFLAGS' => 'asflags-y',
2557 'EXTRA_CFLAGS' => 'ccflags-y',
2558 'EXTRA_CPPFLAGS' => 'cppflags-y',
2559 'EXTRA_LDFLAGS' => 'ldflags-y',
2562 WARN("DEPRECATED_VARIABLE",
2563 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2566 # check for DT compatible documentation
2567 if (defined $root &&
2568 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2569 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2571 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2573 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2574 my $vp_file = $dt_path . "vendor-prefixes.txt";
2576 foreach my $compat (@compats) {
2577 my $compat2 = $compat;
2578 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2579 my $compat3 = $compat;
2580 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2581 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
2583 WARN("UNDOCUMENTED_DT_STRING",
2584 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2587 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2589 `grep -Eq "^$vendor\\b" $vp_file`;
2591 WARN("UNDOCUMENTED_DT_STRING",
2592 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2597 # check we are in a valid source file if not then ignore this hunk
2598 next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/);
2600 # line length limit (with some exclusions)
2602 # There are a few types of lines that may extend beyond $max_line_length:
2603 # logging functions like pr_info that end in a string
2604 # lines with a single string
2605 # #defines that are a single string
2607 # There are 3 different line length message types:
2608 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength
2609 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2610 # LONG_LINE all other lines longer than $max_line_length
2612 # if LONG_LINE is ignored, the other 2 types are also ignored
2615 if ($line =~ /^\+/ && $length > $max_line_length) {
2616 my $msg_type = "LONG_LINE";
2618 # Check the allowed long line types first
2620 # logging functions that end in a string that starts
2621 # before $max_line_length
2622 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2623 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2626 # lines with only strings (w/ possible termination)
2627 # #defines with only strings
2628 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2629 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2632 # Otherwise set the alternate message types
2634 # a comment starts before $max_line_length
2635 } elsif ($line =~ /($;[\s$;]*)$/ &&
2636 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2637 $msg_type = "LONG_LINE_COMMENT"
2639 # a quoted string starts before $max_line_length
2640 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
2641 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2642 $msg_type = "LONG_LINE_STRING"
2645 if ($msg_type ne "" &&
2646 (show_type("LONG_LINE") || show_type($msg_type))) {
2648 "line over $max_line_length characters\n" . $herecurr);
2652 # check for adding lines without a newline.
2653 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2654 WARN("MISSING_EOF_NEWLINE",
2655 "adding a line without newline at end of file\n" . $herecurr);
2658 # Blackfin: use hi/lo macros
2659 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2660 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2661 my $herevet = "$here\n" . cat_vet($line) . "\n";
2663 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
2665 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2666 my $herevet = "$here\n" . cat_vet($line) . "\n";
2668 "use the HI() macro, not (... >> 16)\n" . $herevet);
2672 # check we are in a valid source file C or perl if not then ignore this hunk
2673 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
2675 # at the beginning of a line any tabs must come first and anything
2676 # more than 8 must use tabs.
2677 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2678 $rawline =~ /^\+\s* \s*/) {
2679 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2681 if (ERROR("CODE_INDENT",
2682 "code indent should use tabs where possible\n" . $herevet) &&
2684 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2688 # check for space before tabs.
2689 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2690 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2691 if (WARN("SPACE_BEFORE_TAB",
2692 "please, no space before tabs\n" . $herevet) &&
2694 while ($fixed[$fixlinenr] =~
2695 s/(^\+.*) {8,8}\t/$1\t\t/) {}
2696 while ($fixed[$fixlinenr] =~
2697 s/(^\+.*) +\t/$1\t/) {}
2701 # check for && or || at the start of a line
2702 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2703 CHK("LOGICAL_CONTINUATIONS",
2704 "Logical continuations should be on the previous line\n" . $hereprev);
2707 # check multi-line statement indentation matches previous line
2708 if ($^V && $^V ge 5.10.0 &&
2709 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2710 $prevline =~ /^\+(\t*)(.*)$/;
2714 my $pos = pos_last_openparen($rest);
2716 $line =~ /^(\+| )([ \t]*)/;
2719 my $goodtabindent = $oldindent .
2722 my $goodspaceindent = $oldindent . " " x $pos;
2724 if ($newindent ne $goodtabindent &&
2725 $newindent ne $goodspaceindent) {
2727 if (CHK("PARENTHESIS_ALIGNMENT",
2728 "Alignment should match open parenthesis\n" . $hereprev) &&
2729 $fix && $line =~ /^\+/) {
2730 $fixed[$fixlinenr] =~
2731 s/^\+[ \t]*/\+$goodtabindent/;
2737 # check for space after cast like "(int) foo" or "(struct foo) bar"
2738 # avoid checking a few false positives:
2739 # "sizeof(<type>)" or "__alignof__(<type>)"
2740 # function pointer declarations like "(*foo)(int) = bar;"
2741 # structure definitions like "(struct foo) { 0 };"
2742 # multiline macros that define functions
2743 # known attributes or the __attribute__ keyword
2744 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
2745 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
2747 "No space is necessary after a cast\n" . $herecurr) &&
2749 $fixed[$fixlinenr] =~
2750 s/(\(\s*$Type\s*\))[ \t]+/$1/;
2754 # Block comment styles
2755 # Networking with an initial /*
2756 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2757 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
2758 $rawline =~ /^\+[ \t]*\*/ &&
2760 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2761 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2764 # Block comments use * on subsequent lines
2765 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
2766 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
2767 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
2768 $rawline =~ /^\+/ && #line is new
2769 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2770 WARN("BLOCK_COMMENT_STYLE",
2771 "Block comments use * on subsequent lines\n" . $hereprev);
2774 # Block comments use */ on trailing lines
2775 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2776 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2777 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2778 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
2779 WARN("BLOCK_COMMENT_STYLE",
2780 "Block comments use a trailing */ on a separate line\n" . $herecurr);
2783 # check for missing blank lines after struct/union declarations
2784 # with exceptions for various attributes and macros
2785 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2787 !($line =~ /^\+\s*$/ ||
2788 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2789 $line =~ /^\+\s*MODULE_/i ||
2790 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2791 $line =~ /^\+[a-z_]*init/ ||
2792 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2793 $line =~ /^\+\s*DECLARE/ ||
2794 $line =~ /^\+\s*__setup/)) {
2795 if (CHK("LINE_SPACING",
2796 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
2798 fix_insert_line($fixlinenr, "\+");
2802 # check for multiple consecutive blank lines
2803 if ($prevline =~ /^[\+ ]\s*$/ &&
2804 $line =~ /^\+\s*$/ &&
2805 $last_blank_line != ($linenr - 1)) {
2806 if (CHK("LINE_SPACING",
2807 "Please don't use multiple blank lines\n" . $hereprev) &&
2809 fix_delete_line($fixlinenr, $rawline);
2812 $last_blank_line = $linenr;
2815 # check for missing blank lines after declarations
2816 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2817 # actual declarations
2818 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2819 # function pointer declarations
2820 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2821 # foo bar; where foo is some local typedef or #define
2822 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2823 # known declaration macros
2824 $prevline =~ /^\+\s+$declaration_macros/) &&
2825 # for "else if" which can look like "$Ident $Ident"
2826 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2827 # other possible extensions of declaration lines
2828 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2829 # not starting a section or a macro "\" extended line
2830 $prevline =~ /(?:\{\s*|\\)$/) &&
2831 # looks like a declaration
2832 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2833 # function pointer declarations
2834 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2835 # foo bar; where foo is some local typedef or #define
2836 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2837 # known declaration macros
2838 $sline =~ /^\+\s+$declaration_macros/ ||
2839 # start of struct or union or enum
2840 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
2841 # start or end of block or continuation of declaration
2842 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
2843 # bitfield continuation
2844 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
2845 # other possible extensions of declaration lines
2846 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
2847 # indentation of previous and current line are the same
2848 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
2849 if (WARN("LINE_SPACING",
2850 "Missing a blank line after declarations\n" . $hereprev) &&
2852 fix_insert_line($fixlinenr, "\+");
2856 # check for spaces at the beginning of a line.
2858 # 1) within comments
2859 # 2) indented preprocessor commands
2861 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
2862 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2863 if (WARN("LEADING_SPACE",
2864 "please, no spaces at the start of a line\n" . $herevet) &&
2866 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2870 # check we are in a valid C source file if not then ignore this hunk
2871 next if ($realfile !~ /\.(h|c)$/);
2873 # check indentation of any line with a bare else
2874 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
2875 # if the previous line is a break or return and is indented 1 tab more...
2876 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
2877 my $tabs = length($1) + 1;
2878 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
2879 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
2880 defined $lines[$linenr] &&
2881 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
2882 WARN("UNNECESSARY_ELSE",
2883 "else is not generally useful after a break or return\n" . $hereprev);
2887 # check indentation of a line with a break;
2888 # if the previous line is a goto or return and is indented the same # of tabs
2889 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
2891 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
2892 WARN("UNNECESSARY_BREAK",
2893 "break is not useful after a goto or return\n" . $hereprev);
2897 # discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2898 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2899 WARN("CONFIG_EXPERIMENTAL",
2900 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2903 # check for RCS/CVS revision markers
2904 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
2906 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
2909 # Blackfin: don't use __builtin_bfin_[cs]sync
2910 if ($line =~ /__builtin_bfin_csync/) {
2911 my $herevet = "$here\n" . cat_vet($line) . "\n";
2913 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
2915 if ($line =~ /__builtin_bfin_ssync/) {
2916 my $herevet = "$here\n" . cat_vet($line) . "\n";
2918 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
2921 # check for old HOTPLUG __dev<foo> section markings
2922 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2923 WARN("HOTPLUG_SECTION",
2924 "Using $1 is unnecessary\n" . $herecurr);
2927 # Check for potential 'bare' types
2928 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2930 #print "LINE<$line>\n";
2931 if ($linenr >= $suppress_statement &&
2932 $realcnt && $sline =~ /.\s*\S/) {
2933 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2934 ctx_statement_block($linenr, $realcnt, 0);
2935 $stat =~ s/\n./\n /g;
2936 $cond =~ s/\n./\n /g;
2938 #print "linenr<$linenr> <$stat>\n";
2939 # If this statement has no statement boundaries within
2940 # it there is no point in retrying a statement scan
2941 # until we hit end of it.
2942 my $frag = $stat; $frag =~ s/;+\s*$//;
2943 if ($frag !~ /(?:{|;)/) {
2944 #print "skip<$line_nr_next>\n";
2945 $suppress_statement = $line_nr_next;
2948 # Find the real next line.
2949 $realline_next = $line_nr_next;
2950 if (defined $realline_next &&
2951 (!defined $lines[$realline_next - 1] ||
2952 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2959 # Ignore goto labels.
2960 if ($s =~ /$Ident:\*$/s) {
2962 # Ignore functions being called
2963 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
2965 } elsif ($s =~ /^.\s*else\b/s) {
2967 # declarations always start with types
2968 } 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) {
2971 possible($type, "A:" . $s);
2973 # definitions in global scope can only start with types
2974 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
2975 possible($1, "B:" . $s);
2978 # any (foo ... *) is a pointer cast, and foo is a type
2979 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
2980 possible($1, "C:" . $s);
2983 # Check for any sort of function declaration.
2984 # int foo(something bar, other baz);
2985 # void (*store_gdt)(x86_descr_ptr *);
2986 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
2987 my ($name_len) = length($1);
2990 substr($ctx, 0, $name_len + 1, '');
2991 $ctx =~ s/\)[^\)]*$//;
2993 for my $arg (split(/\s*,\s*/, $ctx)) {
2994 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
2996 possible($1, "D:" . $s);
3004 # Checks which may be anchored in the context.
3007 # Check for switch () and associated case and default
3008 # statements should be at the same indent.
3009 if ($line=~/\bswitch\s*\(.*\)/) {
3012 my @ctx = ctx_block_outer($linenr, $realcnt);
3014 for my $ctx (@ctx) {
3015 my ($clen, $cindent) = line_stats($ctx);
3016 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3017 $indent != $cindent) {
3018 $err .= "$sep$ctx\n";
3025 ERROR("SWITCH_CASE_INDENT_LEVEL",
3026 "switch and case should be at the same indent\n$hereline$err");
3030 # if/while/etc brace do not go on next line, unless defining a do while loop,
3031 # or if that brace on the next line is for something else
3032 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3033 my $pre_ctx = "$1$2";
3035 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
3037 if ($line =~ /^\+\t{6,}/) {
3038 WARN("DEEP_INDENTATION",
3039 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3042 my $ctx_cnt = $realcnt - $#ctx - 1;
3043 my $ctx = join("\n", @ctx);
3045 my $ctx_ln = $linenr;
3046 my $ctx_skip = $realcnt;
3048 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3049 defined $lines[$ctx_ln - 1] &&
3050 $lines[$ctx_ln - 1] =~ /^-/)) {
3051 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3052 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
3056 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3057 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3059 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
3061 "that open brace { should be on the previous line\n" .
3062 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3064 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3065 $ctx =~ /\)\s*\;\s*$/ &&
3066 defined $lines[$ctx_ln - 1])
3068 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3069 if ($nindent > $indent) {
3070 WARN("TRAILING_SEMICOLON",
3071 "trailing semicolon indicates no statements, indent implies otherwise\n" .
3072 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3077 # Check relative indent for conditionals and blocks.
3078 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3079 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3080 ctx_statement_block($linenr, $realcnt, 0)
3081 if (!defined $stat);
3082 my ($s, $c) = ($stat, $cond);
3084 substr($s, 0, length($c), '');
3086 # remove inline comments
3090 # Find out how long the conditional actually is.
3091 my @newlines = ($c =~ /\n/gs);
3092 my $cond_lines = 1 + $#newlines;
3094 # Make sure we remove the line prefixes as we have
3095 # none on the first line, and are going to readd them
3098 while ($s =~ /\n\s+\\\n/) {
3099 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3102 # We want to check the first line inside the block
3103 # starting at the end of the conditional, so remove:
3104 # 1) any blank line termination
3105 # 2) any opening brace { on end of the line
3107 my $continuation = 0;
3109 $s =~ s/^.*\bdo\b//;
3111 if ($s =~ s/^\s*\\//) {
3114 if ($s =~ s/^\s*?\n//) {
3119 # Also ignore a loop construct at the end of a
3120 # preprocessor statement.
3121 if (($prevline =~ /^.\s*#\s*define\s/ ||
3122 $prevline =~ /\\\s*$/) && $continuation == 0) {
3128 while ($cond_ptr != $cond_lines) {
3129 $cond_ptr = $cond_lines;
3131 # If we see an #else/#elif then the code
3133 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3138 # 1) blank lines, they should be at 0,
3139 # 2) preprocessor lines, and
3141 if ($continuation ||
3143 $s =~ /^\s*#\s*?/ ||
3144 $s =~ /^\s*$Ident\s*:/) {
3145 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
3146 if ($s =~ s/^.*?\n//) {
3152 my (undef, $sindent) = line_stats("+" . $s);
3153 my $stat_real = raw_line($linenr, $cond_lines);
3155 # Check if either of these lines are modified, else
3156 # this is not this patch's fault.
3157 if (!defined($stat_real) ||
3158 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3161 if (defined($stat_real) && $cond_lines > 1) {
3162 $stat_real = "[...]\n$stat_real";
3165 #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";
3167 if ($check && $s ne '' &&
3168 (($sindent % 8) != 0 ||
3169 ($sindent < $indent) ||
3170 ($sindent > $indent + 8))) {
3171 WARN("SUSPECT_CODE_INDENT",
3172 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3176 # Track the 'values' across context and added lines.
3177 my $opline = $line; $opline =~ s/^./ /;
3178 my ($curr_values, $curr_vars) =
3179 annotate_values($opline . "\n", $prev_values);
3180 $curr_values = $prev_values . $curr_values;
3182 my $outline = $opline; $outline =~ s/\t/ /g;
3183 print "$linenr > .$outline\n";
3184 print "$linenr > $curr_values\n";
3185 print "$linenr > $curr_vars\n";
3187 $prev_values = substr($curr_values, -1);
3189 #ignore lines not being added
3190 next if ($line =~ /^[^\+]/);
3192 # TEST: allow direct testing of the type matcher.
3194 if ($line =~ /^.\s*$Declare\s*$/) {
3196 "TEST: is type\n" . $herecurr);
3197 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
3198 ERROR("TEST_NOT_TYPE",
3199 "TEST: is not type ($1 is)\n". $herecurr);
3203 # TEST: allow direct testing of the attribute matcher.
3205 if ($line =~ /^.\s*$Modifier\s*$/) {
3207 "TEST: is attr\n" . $herecurr);
3208 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
3209 ERROR("TEST_NOT_ATTR",
3210 "TEST: is not attr ($1 is)\n". $herecurr);
3215 # check for initialisation to aggregates open brace on the next line
3216 if ($line =~ /^.\s*{/ &&
3217 $prevline =~ /(?:^|[^=])=\s*$/) {
3218 if (ERROR("OPEN_BRACE",
3219 "that open brace { should be on the previous line\n" . $hereprev) &&
3220 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3221 fix_delete_line($fixlinenr - 1, $prevrawline);
3222 fix_delete_line($fixlinenr, $rawline);
3223 my $fixedline = $prevrawline;
3224 $fixedline =~ s/\s*=\s*$/ = {/;
3225 fix_insert_line($fixlinenr, $fixedline);
3227 $fixedline =~ s/^(.\s*){\s*/$1/;
3228 fix_insert_line($fixlinenr, $fixedline);
3233 # Checks which are anchored on the added line.
3236 # check for malformed paths in #include statements (uses RAW line)
3237 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
3239 if ($path =~ m{//}) {
3240 ERROR("MALFORMED_INCLUDE",
3241 "malformed #include filename\n" . $herecurr);
3243 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3244 ERROR("UAPI_INCLUDE",
3245 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
3249 # no C99 // comments
3250 if ($line =~ m{//}) {
3251 if (ERROR("C99_COMMENTS",
3252 "do not use C99 // comments\n" . $herecurr) &&
3254 my $line = $fixed[$fixlinenr];
3255 if ($line =~ /\/\/(.*)$/) {
3256 my $comment = trim($1);
3257 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
3261 # Remove C99 comments.
3263 $opline =~ s@//.*@@;
3265 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3266 # the whole statement.
3267 #print "APW <$lines[$realline_next - 1]>\n";
3268 if (defined $realline_next &&
3269 exists $lines[$realline_next - 1] &&
3270 !defined $suppress_export{$realline_next} &&
3271 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3272 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3273 # Handle definitions which produce identifiers with
3276 # EXPORT_SYMBOL(something_foo);
3278 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
3279 $name =~ /^${Ident}_$2/) {
3280 #print "FOO C name<$name>\n";
3281 $suppress_export{$realline_next} = 1;
3283 } elsif ($stat !~ /(?:
3285 ^.DEFINE_$Ident\(\Q$name\E\)|
3286 ^.DECLARE_$Ident\(\Q$name\E\)|
3287 ^.LIST_HEAD\(\Q$name\E\)|
3288 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3289 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
3291 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3292 $suppress_export{$realline_next} = 2;
3294 $suppress_export{$realline_next} = 1;
3297 if (!defined $suppress_export{$linenr} &&
3298 $prevline =~ /^.\s*$/ &&
3299 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3300 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3301 #print "FOO B <$lines[$linenr - 1]>\n";
3302 $suppress_export{$linenr} = 2;
3304 if (defined $suppress_export{$linenr} &&
3305 $suppress_export{$linenr} == 2) {
3306 WARN("EXPORT_SYMBOL",
3307 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
3310 # check for global initialisers.
3311 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*(?:0|NULL|false)\s*;/) {
3312 if (ERROR("GLOBAL_INITIALISERS",
3313 "do not initialise globals to 0 or NULL\n" .
3316 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*(0|NULL|false)\s*;/$1;/;
3319 # check for static initialisers.
3320 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
3321 if (ERROR("INITIALISED_STATIC",
3322 "do not initialise statics to 0 or NULL\n" .
3325 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
3329 # check for misordered declarations of char/short/int/long with signed/unsigned
3330 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3332 WARN("MISORDERED_TYPE",
3333 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3336 # check for static const char * arrays.
3337 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
3338 WARN("STATIC_CONST_CHAR_ARRAY",
3339 "static const char * array should probably be static const char * const\n" .
3343 # check for static char foo[] = "bar" declarations.
3344 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
3345 WARN("STATIC_CONST_CHAR_ARRAY",
3346 "static char array declaration should probably be static const char\n" .
3350 # check for const <foo> const where <foo> is not a pointer or array type
3351 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3353 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3355 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3356 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3358 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3362 # check for non-global char *foo[] = {"bar", ...} declarations.
3363 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3364 WARN("STATIC_CONST_CHAR_ARRAY",
3365 "char * array declaration might be better as static const\n" .
3369 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3370 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3372 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3374 if (WARN("ARRAY_SIZE",
3375 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3377 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3382 # check for function declarations without arguments like "int foo()"
3383 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3384 if (ERROR("FUNCTION_WITHOUT_ARGS",
3385 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3387 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
3391 # check for uses of DEFINE_PCI_DEVICE_TABLE
3392 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
3393 if (WARN("DEFINE_PCI_DEVICE_TABLE",
3394 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
3396 $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
3400 # check for new typedefs, only function parameters and sparse annotations
3402 if ($line =~ /\btypedef\s/ &&
3403 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
3404 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
3405 $line !~ /\b$typeTypedefs\b/ &&
3406 $line !~ /\b__bitwise(?:__|)\b/) {
3407 WARN("NEW_TYPEDEFS",
3408 "do not add new typedefs\n" . $herecurr);
3411 # * goes on variable not on type
3413 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3415 my ($ident, $from, $to) = ($1, $2, $2);
3417 # Should start with a space.
3418 $to =~ s/^(\S)/ $1/;
3419 # Should not end with a space.
3421 # '*'s should not have spaces between.
3422 while ($to =~ s/\*\s+\*/\*\*/) {
3425 ## print "1: from<$from> to<$to> ident<$ident>\n";
3427 if (ERROR("POINTER_LOCATION",
3428 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3430 my $sub_from = $ident;
3431 my $sub_to = $ident;
3432 $sub_to =~ s/\Q$from\E/$to/;
3433 $fixed[$fixlinenr] =~
3434 s@\Q$sub_from\E@$sub_to@;
3438 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3440 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
3442 # Should start with a space.
3443 $to =~ s/^(\S)/ $1/;
3444 # Should not end with a space.
3446 # '*'s should not have spaces between.
3447 while ($to =~ s/\*\s+\*/\*\*/) {
3449 # Modifiers should have spaces.
3450 $to =~ s/(\b$Modifier$)/$1 /;
3452 ## print "2: from<$from> to<$to> ident<$ident>\n";
3453 if ($from ne $to && $ident !~ /^$Modifier$/) {
3454 if (ERROR("POINTER_LOCATION",
3455 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3458 my $sub_from = $match;
3459 my $sub_to = $match;
3460 $sub_to =~ s/\Q$from\E/$to/;
3461 $fixed[$fixlinenr] =~
3462 s@\Q$sub_from\E@$sub_to@;
3467 # avoid BUG() or BUG_ON()
3468 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
3469 my $msg_type = \&WARN;
3470 $msg_type = \&CHK if ($file);
3471 &{$msg_type}("AVOID_BUG",
3472 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3475 # avoid LINUX_VERSION_CODE
3476 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
3477 WARN("LINUX_VERSION_CODE",
3478 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3481 # check for uses of printk_ratelimit
3482 if ($line =~ /\bprintk_ratelimit\s*\(/) {
3483 WARN("PRINTK_RATELIMITED",
3484 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
3487 # printk should use KERN_* levels. Note that follow on printk's on the
3488 # same line do not need a level, so we use the current block context
3489 # to try and find and validate the current printk. In summary the current
3490 # printk includes all preceding printk's which have no newline on the end.
3491 # we assume the first bad printk is the one to report.
3492 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
3494 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3495 #print "CHECK<$lines[$ln - 1]\n";
3496 # we have a preceding printk if it ends
3497 # with "\n" ignore it, else it is to blame
3498 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3499 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3506 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3507 "printk() should include KERN_ facility level\n" . $herecurr);
3511 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3513 my $level = lc($orig);
3514 $level = "warn" if ($level eq "warning");
3515 my $level2 = $level;
3516 $level2 = "dbg" if ($level eq "debug");
3517 WARN("PREFER_PR_LEVEL",
3518 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
3521 if ($line =~ /\bpr_warning\s*\(/) {
3522 if (WARN("PREFER_PR_LEVEL",
3523 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3525 $fixed[$fixlinenr] =~
3526 s/\bpr_warning\b/pr_warn/;
3530 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3532 my $level = lc($orig);
3533 $level = "warn" if ($level eq "warning");
3534 $level = "dbg" if ($level eq "debug");
3535 WARN("PREFER_DEV_LEVEL",
3536 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3539 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
3540 # number of false positives, but assembly files are not checked, so at
3541 # least the arch entry code will not trigger this warning.
3542 if ($line =~ /\bENOSYS\b/) {
3544 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3547 # function brace can't be on same line, except for #defines of do while,
3548 # or if closed on same line
3549 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
3550 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
3551 if (ERROR("OPEN_BRACE",
3552 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3554 fix_delete_line($fixlinenr, $rawline);
3555 my $fixed_line = $rawline;
3556 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3559 fix_insert_line($fixlinenr, ltrim($line1));
3560 fix_insert_line($fixlinenr, "\+{");
3561 if ($line2 !~ /^\s*$/) {
3562 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3567 # open braces for enum, union and struct go on the same line.
3568 if ($line =~ /^.\s*{/ &&
3569 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
3570 if (ERROR("OPEN_BRACE",
3571 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3572 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3573 fix_delete_line($fixlinenr - 1, $prevrawline);
3574 fix_delete_line($fixlinenr, $rawline);
3575 my $fixedline = rtrim($prevrawline) . " {";
3576 fix_insert_line($fixlinenr, $fixedline);
3577 $fixedline = $rawline;
3578 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3579 if ($fixedline !~ /^\+\s*$/) {
3580 fix_insert_line($fixlinenr, $fixedline);
3585 # missing space after union, struct or enum definition
3586 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3588 "missing space after $1 definition\n" . $herecurr) &&
3590 $fixed[$fixlinenr] =~
3591 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3595 # Function pointer declarations
3596 # check spacing between type, funcptr, and args
3597 # canonical declaration is "type (*funcptr)(args...)"
3598 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
3600 my $pre_pointer_space = $2;
3601 my $post_pointer_space = $3;
3603 my $post_funcname_space = $5;
3604 my $pre_args_space = $6;
3606 # the $Declare variable will capture all spaces after the type
3607 # so check it for a missing trailing missing space but pointer return types
3608 # don't need a space so don't warn for those.
3609 my $post_declare_space = "";
3610 if ($declare =~ /(\s+)$/) {
3611 $post_declare_space = $1;
3612 $declare = rtrim($declare);
3614 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
3616 "missing space after return type\n" . $herecurr);
3617 $post_declare_space = " ";
3620 # unnecessary space "type (*funcptr)(args...)"
3621 # This test is not currently implemented because these declarations are
3623 # int foo(int bar, ...)
3624 # and this is form shouldn't/doesn't generate a checkpatch warning.
3626 # elsif ($declare =~ /\s{2,}$/) {
3628 # "Multiple spaces after return type\n" . $herecurr);
3631 # unnecessary space "type ( *funcptr)(args...)"
3632 if (defined $pre_pointer_space &&
3633 $pre_pointer_space =~ /^\s/) {
3635 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3638 # unnecessary space "type (* funcptr)(args...)"
3639 if (defined $post_pointer_space &&
3640 $post_pointer_space =~ /^\s/) {
3642 "Unnecessary space before function pointer name\n" . $herecurr);
3645 # unnecessary space "type (*funcptr )(args...)"
3646 if (defined $post_funcname_space &&
3647 $post_funcname_space =~ /^\s/) {
3649 "Unnecessary space after function pointer name\n" . $herecurr);
3652 # unnecessary space "type (*funcptr) (args...)"
3653 if (defined $pre_args_space &&
3654 $pre_args_space =~ /^\s/) {
3656 "Unnecessary space before function pointer arguments\n" . $herecurr);
3659 if (show_type("SPACING") && $fix) {
3660 $fixed[$fixlinenr] =~
3661 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3665 # check for spacing round square brackets; allowed:
3666 # 1. with a type on the left -- int [] a;
3667 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3668 # 3. inside a curly brace -- = { [0...10] = 5 }
3669 while ($line =~ /(.*?\s)\[/g) {
3670 my ($where, $prefix) = ($-[1], $1);
3671 if ($prefix !~ /$Type\s+$/ &&
3672 ($where != 0 || $prefix !~ /^.\s+$/) &&
3673 $prefix !~ /[{,]\s+$/) {
3674 if (ERROR("BRACKET_SPACE",
3675 "space prohibited before open square bracket '['\n" . $herecurr) &&
3677 $fixed[$fixlinenr] =~
3678 s/^(\+.*?)\s+\[/$1\[/;
3683 # check for spaces between functions and their parentheses.
3684 while ($line =~ /($Ident)\s+\(/g) {
3686 my $ctx_before = substr($line, 0, $-[1]);
3687 my $ctx = "$ctx_before$name";
3689 # Ignore those directives where spaces _are_ permitted.
3691 if|for|while|switch|return|case|
3692 volatile|__volatile__|
3693 __attribute__|format|__extension__|
3696 # cpp #define statements have non-optional spaces, ie
3697 # if there is a space between the name and the open
3698 # parenthesis it is simply not a parameter group.
3699 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
3701 # cpp #elif statement condition may start with a (
3702 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
3704 # If this whole things ends with a type its most
3705 # likely a typedef for a function.
3706 } elsif ($ctx =~ /$Type$/) {
3710 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3712 $fixed[$fixlinenr] =~
3713 s/\b$name\s+\(/$name\(/;
3718 # Check operator spacing.
3719 if (!($line=~/\#\s*include/)) {
3720 my $fixed_line = "";
3724 <<=|>>=|<=|>=|==|!=|
3725 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3726 =>|->|<<|>>|<|>|=|!|~|
3727 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
3730 my @elements = split(/($ops|;)/, $opline);
3732 ## print("element count: <" . $#elements . ">\n");
3733 ## foreach my $el (@elements) {
3734 ## print("el: <$el>\n");
3737 my @fix_elements = ();
3740 foreach my $el (@elements) {
3741 push(@fix_elements, substr($rawline, $off, length($el)));
3742 $off += length($el);
3747 my $blank = copy_spacing($opline);
3748 my $last_after = -1;
3750 for (my $n = 0; $n < $#elements; $n += 2) {
3752 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3754 ## print("n: <$n> good: <$good>\n");
3756 $off += length($elements[$n]);
3758 # Pick up the preceding and succeeding characters.
3759 my $ca = substr($opline, 0, $off);
3761 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3762 $cc = substr($opline, $off + length($elements[$n + 1]));
3764 my $cb = "$ca$;$cc";
3767 $a = 'V' if ($elements[$n] ne '');
3768 $a = 'W' if ($elements[$n] =~ /\s$/);
3769 $a = 'C' if ($elements[$n] =~ /$;$/);
3770 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3771 $a = 'O' if ($elements[$n] eq '');
3772 $a = 'E' if ($ca =~ /^\s*$/);
3774 my $op = $elements[$n + 1];
3777 if (defined $elements[$n + 2]) {
3778 $c = 'V' if ($elements[$n + 2] ne '');
3779 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
3780 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
3781 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3782 $c = 'O' if ($elements[$n + 2] eq '');
3783 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
3788 my $ctx = "${a}x${c}";
3790 my $at = "(ctx:$ctx)";
3792 my $ptr = substr($blank, 0, $off) . "^";
3793 my $hereptr = "$hereline$ptr\n";
3795 # Pull out the value of this operator.
3796 my $op_type = substr($curr_values, $off + 1, 1);
3798 # Get the full operator variant.
3799 my $opv = $op . substr($curr_vars, $off, 1);
3801 # Ignore operators passed as parameters.
3802 if ($op_type ne 'V' &&
3803 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
3806 # } elsif ($op =~ /^$;+$/) {
3808 # ; should have either the end of line or a space or \ after it
3809 } elsif ($op eq ';') {
3810 if ($ctx !~ /.x[WEBC]/ &&
3811 $cc !~ /^\\/ && $cc !~ /^;/) {
3812 if (ERROR("SPACING",
3813 "space required after that '$op' $at\n" . $hereptr)) {
3814 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3820 } elsif ($op eq '//') {
3822 # : when part of a bitfield
3823 } elsif ($opv eq ':B') {
3824 # skip the bitfield test for now
3828 } elsif ($op eq '->') {
3829 if ($ctx =~ /Wx.|.xW/) {
3830 if (ERROR("SPACING",
3831 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
3832 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3833 if (defined $fix_elements[$n + 2]) {
3834 $fix_elements[$n + 2] =~ s/^\s+//;
3840 # , must not have a space before and must have a space on the right.
3841 } elsif ($op eq ',') {
3842 my $rtrim_before = 0;
3843 my $space_after = 0;
3844 if ($ctx =~ /Wx./) {
3845 if (ERROR("SPACING",
3846 "space prohibited before that '$op' $at\n" . $hereptr)) {
3851 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
3852 if (ERROR("SPACING",
3853 "space required after that '$op' $at\n" . $hereptr)) {
3859 if ($rtrim_before || $space_after) {
3860 if ($rtrim_before) {
3861 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3863 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3870 # '*' as part of a type definition -- reported already.
3871 } elsif ($opv eq '*_') {
3872 #warn "'*' is part of type\n";
3874 # unary operators should have a space before and
3875 # none after. May be left adjacent to another
3876 # unary operator, or a cast
3877 } elsif ($op eq '!' || $op eq '~' ||
3878 $opv eq '*U' || $opv eq '-U' ||
3879 $opv eq '&U' || $opv eq '&&U') {
3880 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
3881 if (ERROR("SPACING",
3882 "space required before that '$op' $at\n" . $hereptr)) {
3883 if ($n != $last_after + 2) {
3884 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3889 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
3890 # A unary '*' may be const
3892 } elsif ($ctx =~ /.xW/) {
3893 if (ERROR("SPACING",
3894 "space prohibited after that '$op' $at\n" . $hereptr)) {
3895 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
3896 if (defined $fix_elements[$n + 2]) {
3897 $fix_elements[$n + 2] =~ s/^\s+//;
3903 # unary ++ and unary -- are allowed no space on one side.
3904 } elsif ($op eq '++' or $op eq '--') {
3905 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
3906 if (ERROR("SPACING",
3907 "space required one side of that '$op' $at\n" . $hereptr)) {
3908 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3912 if ($ctx =~ /Wx[BE]/ ||
3913 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
3914 if (ERROR("SPACING",
3915 "space prohibited before that '$op' $at\n" . $hereptr)) {
3916 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3920 if ($ctx =~ /ExW/) {
3921 if (ERROR("SPACING",
3922 "space prohibited after that '$op' $at\n" . $hereptr)) {
3923 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3924 if (defined $fix_elements[$n + 2]) {
3925 $fix_elements[$n + 2] =~ s/^\s+//;
3931 # << and >> may either have or not have spaces both sides
3932 } elsif ($op eq '<<' or $op eq '>>' or
3933 $op eq '&' or $op eq '^' or $op eq '|' or
3934 $op eq '+' or $op eq '-' or
3935 $op eq '*' or $op eq '/' or
3939 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
3941 "spaces preferred around that '$op' $at\n" . $hereptr)) {
3942 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3943 $fix_elements[$n + 2] =~ s/^\s+//;
3946 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
3948 "space preferred before that '$op' $at\n" . $hereptr)) {
3949 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
3953 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
3954 if (ERROR("SPACING",
3955 "need consistent spacing around '$op' $at\n" . $hereptr)) {
3956 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3957 if (defined $fix_elements[$n + 2]) {
3958 $fix_elements[$n + 2] =~ s/^\s+//;
3964 # A colon needs no spaces before when it is
3965 # terminating a case value or a label.
3966 } elsif ($opv eq ':C' || $opv eq ':L') {
3967 if ($ctx =~ /Wx./) {
3968 if (ERROR("SPACING",
3969 "space prohibited before that '$op' $at\n" . $hereptr)) {
3970 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3975 # All the others need spaces both sides.
3976 } elsif ($ctx !~ /[EWC]x[CWE]/) {
3979 # Ignore email addresses <foo@bar>
3981 $cc =~ /^\S+\@\S+>/) ||
3983 $ca =~ /<\S+\@\S+$/))
3988 # for asm volatile statements
3989 # ignore a colon with another
3990 # colon immediately before or after
3992 ($ca =~ /:$/ || $cc =~ /^:/)) {
3996 # messages are ERROR, but ?: are CHK
3998 my $msg_type = \&ERROR;
3999 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4001 if (&{$msg_type}("SPACING",
4002 "spaces required around that '$op' $at\n" . $hereptr)) {
4003 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4004 if (defined $fix_elements[$n + 2]) {
4005 $fix_elements[$n + 2] =~ s/^\s+//;
4011 $off += length($elements[$n + 1]);
4013 ## print("n: <$n> GOOD: <$good>\n");
4015 $fixed_line = $fixed_line . $good;
4018 if (($#elements % 2) == 0) {
4019 $fixed_line = $fixed_line . $fix_elements[$#elements];
4022 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4023 $fixed[$fixlinenr] = $fixed_line;
4029 # check for whitespace before a non-naked semicolon
4030 if ($line =~ /^\+.*\S\s+;\s*$/) {
4032 "space prohibited before semicolon\n" . $herecurr) &&
4034 1 while $fixed[$fixlinenr] =~
4035 s/^(\+.*\S)\s+;/$1;/;
4039 # check for multiple assignments
4040 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
4041 CHK("MULTIPLE_ASSIGNMENTS",
4042 "multiple assignments should be avoided\n" . $herecurr);
4045 ## # check for multiple declarations, allowing for a function declaration
4047 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4048 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4050 ## # Remove any bracketed sections to ensure we do not
4051 ## # falsly report the parameters of functions.
4053 ## while ($ln =~ s/\([^\(\)]*\)//g) {
4055 ## if ($ln =~ /,/) {
4056 ## WARN("MULTIPLE_DECLARATION",
4057 ## "declaring multiple variables together should be avoided\n" . $herecurr);
4061 #need space before brace following if, while, etc
4062 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
4064 if (ERROR("SPACING",
4065 "space required before the open brace '{'\n" . $herecurr) &&
4067 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
4071 ## # check for blank lines before declarations
4072 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4073 ## $prevrawline =~ /^.\s*$/) {
4075 ## "No blank lines before declarations\n" . $hereprev);
4079 # closing brace should have a space following it when it has anything
4081 if ($line =~ /}(?!(?:,|;|\)))\S/) {
4082 if (ERROR("SPACING",
4083 "space required after that close brace '}'\n" . $herecurr) &&
4085 $fixed[$fixlinenr] =~
4086 s/}((?!(?:,|;|\)))\S)/} $1/;
4090 # check spacing on square brackets
4091 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
4092 if (ERROR("SPACING",
4093 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4095 $fixed[$fixlinenr] =~
4099 if ($line =~ /\s\]/) {
4100 if (ERROR("SPACING",
4101 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4103 $fixed[$fixlinenr] =~
4108 # check spacing on parentheses
4109 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4110 $line !~ /for\s*\(\s+;/) {
4111 if (ERROR("SPACING",
4112 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4114 $fixed[$fixlinenr] =~
4118 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
4119 $line !~ /for\s*\(.*;\s+\)/ &&
4120 $line !~ /:\s+\)/) {
4121 if (ERROR("SPACING",
4122 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4124 $fixed[$fixlinenr] =~
4129 # check unnecessary parentheses around addressof/dereference single $Lvals
4130 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4132 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
4134 if (CHK("UNNECESSARY_PARENTHESES",
4135 "Unnecessary parentheses around $var\n" . $herecurr) &&
4137 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4141 # check for unnecessary parentheses around function pointer uses
4142 # ie: (foo->bar)(); should be foo->bar();
4143 # but not "if (foo->bar) (" to avoid some false positives
4144 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4146 if (CHK("UNNECESSARY_PARENTHESES",
4147 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4149 my $var2 = deparenthesize($var);
4151 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4155 #goto labels aren't indented, allow a single space however
4156 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
4157 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
4158 if (WARN("INDENTED_LABEL",
4159 "labels should not be indented\n" . $herecurr) &&
4161 $fixed[$fixlinenr] =~
4166 # return is not a function
4167 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
4169 if ($^V && $^V ge 5.10.0 &&
4170 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4172 $value = deparenthesize($value);
4173 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4174 ERROR("RETURN_PARENTHESES",
4175 "return is not a function, parentheses are not required\n" . $herecurr);
4177 } elsif ($spacing !~ /\s+/) {
4179 "space required before the open parenthesis '('\n" . $herecurr);
4183 # unnecessary return in a void function
4184 # at end-of-function, with the previous line a single leading tab, then return;
4185 # and the line before that not a goto label target like "out:"
4186 if ($sline =~ /^[ \+]}\s*$/ &&
4187 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4189 $lines[$linenr - 3] =~ /^[ +]/ &&
4190 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
4192 "void function return statements are not generally useful\n" . $hereprev);
4195 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4196 if ($^V && $^V ge 5.10.0 &&
4197 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4198 my $openparens = $1;
4199 my $count = $openparens =~ tr@\(@\(@;
4201 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4202 my $comp = $4; #Not $1 because of $LvalOrFunc
4203 $msg = " - maybe == should be = ?" if ($comp eq "==");
4204 WARN("UNNECESSARY_PARENTHESES",
4205 "Unnecessary parentheses$msg\n" . $herecurr);
4209 # Return of what appears to be an errno should normally be negative
4210 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
4212 if ($name ne 'EOF' && $name ne 'ERROR') {
4213 WARN("USE_NEGATIVE_ERRNO",
4214 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
4218 # Need a space before open parenthesis after if, while etc
4219 if ($line =~ /\b(if|while|for|switch)\(/) {
4220 if (ERROR("SPACING",
4221 "space required before the open parenthesis '('\n" . $herecurr) &&
4223 $fixed[$fixlinenr] =~
4224 s/\b(if|while|for|switch)\(/$1 \(/;
4228 # Check for illegal assignment in if conditional -- and check for trailing
4229 # statements after the conditional.
4230 if ($line =~ /do\s*(?!{)/) {
4231 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4232 ctx_statement_block($linenr, $realcnt, 0)
4233 if (!defined $stat);
4234 my ($stat_next) = ctx_statement_block($line_nr_next,
4235 $remain_next, $off_next);
4236 $stat_next =~ s/\n./\n /g;
4237 ##print "stat<$stat> stat_next<$stat_next>\n";
4239 if ($stat_next =~ /^\s*while\b/) {
4240 # If the statement carries leading newlines,
4241 # then count those as offsets.
4243 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4245 statement_rawlines($whitespace) - 1;
4247 $suppress_whiletrailers{$line_nr_next +
4251 if (!defined $suppress_whiletrailers{$linenr} &&
4252 defined($stat) && defined($cond) &&
4253 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
4254 my ($s, $c) = ($stat, $cond);
4256 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
4257 ERROR("ASSIGN_IN_IF",
4258 "do not use assignment in if condition\n" . $herecurr);
4261 # Find out what is on the end of the line after the
4263 substr($s, 0, length($c), '');
4265 $s =~ s/$;//g; # Remove any comments
4266 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4267 $c !~ /}\s*while\s*/)
4269 # Find out how long the conditional actually is.
4270 my @newlines = ($c =~ /\n/gs);
4271 my $cond_lines = 1 + $#newlines;
4274 $stat_real = raw_line($linenr, $cond_lines)
4275 . "\n" if ($cond_lines);
4276 if (defined($stat_real) && $cond_lines > 1) {
4277 $stat_real = "[...]\n$stat_real";
4280 ERROR("TRAILING_STATEMENTS",
4281 "trailing statements should be on next line\n" . $herecurr . $stat_real);
4285 # Check for bitwise tests written as boolean
4297 WARN("HEXADECIMAL_BOOLEAN_TEST",
4298 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
4301 # if and else should not have general statements after it
4302 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4304 $s =~ s/$;//g; # Remove any comments
4305 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
4306 ERROR("TRAILING_STATEMENTS",
4307 "trailing statements should be on next line\n" . $herecurr);
4310 # if should not continue a brace
4311 if ($line =~ /}\s*if\b/) {
4312 ERROR("TRAILING_STATEMENTS",
4313 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
4316 # case and default should not have general statements after them
4317 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4319 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
4323 ERROR("TRAILING_STATEMENTS",
4324 "trailing statements should be on next line\n" . $herecurr);
4327 # Check for }<nl>else {, these must be at the same
4328 # indent level to be relevant to each other.
4329 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4330 $previndent == $indent) {
4331 if (ERROR("ELSE_AFTER_BRACE",
4332 "else should follow close brace '}'\n" . $hereprev) &&
4333 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4334 fix_delete_line($fixlinenr - 1, $prevrawline);
4335 fix_delete_line($fixlinenr, $rawline);
4336 my $fixedline = $prevrawline;
4337 $fixedline =~ s/}\s*$//;
4338 if ($fixedline !~ /^\+\s*$/) {
4339 fix_insert_line($fixlinenr, $fixedline);
4341 $fixedline = $rawline;
4342 $fixedline =~ s/^(.\s*)else/$1} else/;
4343 fix_insert_line($fixlinenr, $fixedline);
4347 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4348 $previndent == $indent) {
4349 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4351 # Find out what is on the end of the line after the
4353 substr($s, 0, length($c), '');
4356 if ($s =~ /^\s*;/) {
4357 if (ERROR("WHILE_AFTER_BRACE",
4358 "while should follow close brace '}'\n" . $hereprev) &&
4359 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4360 fix_delete_line($fixlinenr - 1, $prevrawline);
4361 fix_delete_line($fixlinenr, $rawline);
4362 my $fixedline = $prevrawline;
4363 my $trailing = $rawline;
4364 $trailing =~ s/^\+//;
4365 $trailing = trim($trailing);
4366 $fixedline =~ s/}\s*$/} $trailing/;
4367 fix_insert_line($fixlinenr, $fixedline);
4372 #Specific variable tests
4373 while ($line =~ m{($Constant|$Lval)}g) {
4376 #gcc binary extension
4377 if ($var =~ /^$Binary$/) {
4378 if (WARN("GCC_BINARY_CONSTANT",
4379 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4381 my $hexval = sprintf("0x%x", oct($var));
4382 $fixed[$fixlinenr] =~
4383 s/\b$var\b/$hexval/;
4388 if ($var !~ /^$Constant$/ &&
4389 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
4390 #Ignore Page<foo> variants
4391 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
4392 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4393 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4394 #Ignore some three character SI units explicitly, like MiB and KHz
4395 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
4396 while ($var =~ m{($Ident)}g) {
4398 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
4400 seed_camelcase_includes();
4401 if (!$file && !$camelcase_file_seeded) {
4402 seed_camelcase_file($realfile);
4403 $camelcase_file_seeded = 1;
4406 if (!defined $camelcase{$word}) {
4407 $camelcase{$word} = 1;
4409 "Avoid CamelCase: <$word>\n" . $herecurr);
4415 #no spaces allowed after \ in define
4416 if ($line =~ /\#\s*define.*\\\s+$/) {
4417 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4418 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4420 $fixed[$fixlinenr] =~ s/\s+$//;
4424 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4425 # itself <asm/foo.h> (uses RAW line)
4426 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
4428 my $checkfile = "include/linux/$file";
4429 if (-f "$root/$checkfile" &&
4430 $realfile ne $checkfile &&
4431 $1 !~ /$allowed_asm_includes/)
4433 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4434 if ($asminclude > 0) {
4435 if ($realfile =~ m{^arch/}) {
4436 CHK("ARCH_INCLUDE_LINUX",
4437 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4439 WARN("INCLUDE_LINUX",
4440 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4446 # multi-statement macros should be enclosed in a do while loop, grab the
4447 # first statement and ensure its the whole macro if its not enclosed
4448 # in a known good container
4449 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4450 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
4453 my ($off, $dstat, $dcond, $rest);
4455 my $has_flow_statement = 0;
4456 my $has_arg_concat = 0;
4457 ($dstat, $dcond, $ln, $cnt, $off) =
4458 ctx_statement_block($linenr, $realcnt, 0);
4460 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4461 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4463 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
4464 $has_arg_concat = 1 if ($ctx =~ /\#\#/);
4466 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
4468 $dstat =~ s/\\\n.//g;
4469 $dstat =~ s/^\s*//s;
4470 $dstat =~ s/\s*$//s;
4472 # Flatten any parentheses and braces
4473 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4474 $dstat =~ s/\{[^\{\}]*\}/1/ ||
4475 $dstat =~ s/\[[^\[\]]*\]/1/)
4479 # Flatten any obvious string concatentation.
4480 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4481 $dstat =~ s/$Ident\s*($String)/$1/)
4485 my $exceptions = qr{
4497 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4499 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4500 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
4501 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4502 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
4503 $dstat !~ /$exceptions/ &&
4504 $dstat !~ /^\.$Ident\s*=/ && # .foo =
4505 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
4506 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
4507 $dstat !~ /^for\s*$Constant$/ && # for (...)
4508 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4509 $dstat !~ /^do\s*{/ && # do {...
4510 $dstat !~ /^\({/ && # ({...
4511 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
4514 my $herectx = $here . "\n";
4515 my $cnt = statement_rawlines($ctx);
4517 for (my $n = 0; $n < $cnt; $n++) {
4518 $herectx .= raw_line($linenr, $n) . "\n";
4521 if ($dstat =~ /;/) {
4522 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4523 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4525 ERROR("COMPLEX_MACRO",
4526 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
4530 # check for macros with flow control, but without ## concatenation
4531 # ## concatenation is commonly a macro that defines a function so ignore those
4532 if ($has_flow_statement && !$has_arg_concat) {
4533 my $herectx = $here . "\n";
4534 my $cnt = statement_rawlines($ctx);
4536 for (my $n = 0; $n < $cnt; $n++) {
4537 $herectx .= raw_line($linenr, $n) . "\n";
4539 WARN("MACRO_WITH_FLOW_CONTROL",
4540 "Macros with flow control statements should be avoided\n" . "$herectx");
4543 # check for line continuations outside of #defines, preprocessor #, and asm
4546 if ($prevline !~ /^..*\\$/ &&
4547 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4548 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
4549 $line =~ /^\+.*\\$/) {
4550 WARN("LINE_CONTINUATIONS",
4551 "Avoid unnecessary line continuations\n" . $herecurr);
4555 # do {} while (0) macro tests:
4556 # single-statement macros do not need to be enclosed in do while (0) loop,
4557 # macro should not end with a semicolon
4558 if ($^V && $^V ge 5.10.0 &&
4559 $realfile !~ m@/vmlinux.lds.h$@ &&
4560 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4563 my ($off, $dstat, $dcond, $rest);
4565 ($dstat, $dcond, $ln, $cnt, $off) =
4566 ctx_statement_block($linenr, $realcnt, 0);
4569 $dstat =~ s/\\\n.//g;
4572 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4577 my $cnt = statement_rawlines($ctx);
4578 my $herectx = $here . "\n";
4580 for (my $n = 0; $n < $cnt; $n++) {
4581 $herectx .= raw_line($linenr, $n) . "\n";
4584 if (($stmts =~ tr/;/;/) == 1 &&
4585 $stmts !~ /^\s*(if|while|for|switch)\b/) {
4586 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4587 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4589 if (defined $semis && $semis ne "") {
4590 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4591 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4593 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4595 my $cnt = statement_rawlines($ctx);
4596 my $herectx = $here . "\n";
4598 for (my $n = 0; $n < $cnt; $n++) {
4599 $herectx .= raw_line($linenr, $n) . "\n";
4602 WARN("TRAILING_SEMICOLON",
4603 "macros should not use a trailing semicolon\n" . "$herectx");
4607 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4608 # all assignments may have only one of the following with an assignment:
4611 # VMLINUX_SYMBOL(...)
4612 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
4613 WARN("MISSING_VMLINUX_SYMBOL",
4614 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
4617 # check for redundant bracing round if etc
4618 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4619 my ($level, $endln, @chunks) =
4620 ctx_statement_full($linenr, $realcnt, 1);
4621 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
4622 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4623 if ($#chunks > 0 && $level == 0) {
4627 my $herectx = $here . "\n";
4628 my $ln = $linenr - 1;
4629 for my $chunk (@chunks) {
4630 my ($cond, $block) = @{$chunk};
4632 # If the condition carries leading newlines, then count those as offsets.
4633 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4634 my $offset = statement_rawlines($whitespace) - 1;
4636 $allowed[$allow] = 0;
4637 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4639 # We have looked at and allowed this specific line.
4640 $suppress_ifbraces{$ln + $offset} = 1;
4642 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
4643 $ln += statement_rawlines($block) - 1;
4645 substr($block, 0, length($cond), '');
4647 $seen++ if ($block =~ /^\s*{/);
4649 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
4650 if (statement_lines($cond) > 1) {
4651 #print "APW: ALLOWED: cond<$cond>\n";
4652 $allowed[$allow] = 1;
4654 if ($block =~/\b(?:if|for|while)\b/) {
4655 #print "APW: ALLOWED: block<$block>\n";
4656 $allowed[$allow] = 1;
4658 if (statement_block_size($block) > 1) {
4659 #print "APW: ALLOWED: lines block<$block>\n";
4660 $allowed[$allow] = 1;
4665 my $sum_allowed = 0;
4666 foreach (@allowed) {
4669 if ($sum_allowed == 0) {
4671 "braces {} are not necessary for any arm of this statement\n" . $herectx);
4672 } elsif ($sum_allowed != $allow &&
4675 "braces {} should be used on all arms of this statement\n" . $herectx);
4680 if (!defined $suppress_ifbraces{$linenr - 1} &&
4681 $line =~ /\b(if|while|for|else)\b/) {
4684 # Check the pre-context.
4685 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
4686 #print "APW: ALLOWED: pre<$1>\n";
4690 my ($level, $endln, @chunks) =
4691 ctx_statement_full($linenr, $realcnt, $-[0]);
4693 # Check the condition.
4694 my ($cond, $block) = @{$chunks[0]};
4695 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
4696 if (defined $cond) {
4697 substr($block, 0, length($cond), '');
4699 if (statement_lines($cond) > 1) {
4700 #print "APW: ALLOWED: cond<$cond>\n";
4703 if ($block =~/\b(?:if|for|while)\b/) {
4704 #print "APW: ALLOWED: block<$block>\n";
4707 if (statement_block_size($block) > 1) {
4708 #print "APW: ALLOWED: lines block<$block>\n";
4711 # Check the post-context.
4712 if (defined $chunks[1]) {
4713 my ($cond, $block) = @{$chunks[1]};
4714 if (defined $cond) {
4715 substr($block, 0, length($cond), '');
4717 if ($block =~ /^\s*\{/) {
4718 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4722 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
4723 my $herectx = $here . "\n";
4724 my $cnt = statement_rawlines($block);
4726 for (my $n = 0; $n < $cnt; $n++) {
4727 $herectx .= raw_line($linenr, $n) . "\n";
4731 "braces {} are not necessary for single statement blocks\n" . $herectx);
4735 # check for unnecessary blank lines around braces
4736 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
4738 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
4739 $fix && $prevrawline =~ /^\+/) {
4740 fix_delete_line($fixlinenr - 1, $prevrawline);
4743 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
4745 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
4747 fix_delete_line($fixlinenr, $rawline);
4751 # no volatiles please
4752 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
4753 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
4755 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
4758 # Check for user-visible strings broken across lines, which breaks the ability
4759 # to grep for the string. Make exceptions when the previous string ends in a
4760 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
4761 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
4762 if ($line =~ /^\+\s*$String/ &&
4763 $prevline =~ /"\s*$/ &&
4764 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
4765 if (WARN("SPLIT_STRING",
4766 "quoted string split across lines\n" . $hereprev) &&
4768 $prevrawline =~ /^\+.*"\s*$/ &&
4769 $last_coalesced_string_linenr != $linenr - 1) {
4770 my $extracted_string = get_quoted_string($line, $rawline);
4771 my $comma_close = "";
4772 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
4776 fix_delete_line($fixlinenr - 1, $prevrawline);
4777 fix_delete_line($fixlinenr, $rawline);
4778 my $fixedline = $prevrawline;
4779 $fixedline =~ s/"\s*$//;
4780 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
4781 fix_insert_line($fixlinenr - 1, $fixedline);
4782 $fixedline = $rawline;
4783 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
4784 if ($fixedline !~ /\+\s*$/) {
4785 fix_insert_line($fixlinenr, $fixedline);
4787 $last_coalesced_string_linenr = $linenr;
4791 # check for missing a space in a string concatenation
4792 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
4793 WARN('MISSING_SPACE',
4794 "break quoted strings at a space character\n" . $hereprev);
4797 # check for spaces before a quoted newline
4798 if ($rawline =~ /^.*\".*\s\\n/) {
4799 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
4800 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
4802 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
4807 # concatenated string without spaces between elements
4808 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
4809 CHK("CONCATENATED_STRING",
4810 "Concatenated strings should use spaces between elements\n" . $herecurr);
4813 # uncoalesced string fragments
4814 if ($line =~ /$String\s*"/) {
4815 WARN("STRING_FRAGMENTS",
4816 "Consecutive strings are generally better as a single string\n" . $herecurr);
4819 # check for %L{u,d,i} and 0x%[udi] in strings
4821 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4822 $string = substr($rawline, $-[1], $+[1] - $-[1]);
4823 $string =~ s/%%/__/g;
4824 if ($string =~ /(?<!%)%[\*\d\.\$]*L[udi]/) {
4826 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
4829 if ($string =~ /0x%[\*\d\.\$\Llzth]*[udi]/) {
4830 ERROR("PRINTF_0xDECIMAL",
4831 "Prefixing 0x with decimal output is defective\n" . $herecurr);
4835 # check for line continuations in quoted strings with odd counts of "
4836 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
4837 WARN("LINE_CONTINUATIONS",
4838 "Avoid line continuations in quoted strings\n" . $herecurr);
4842 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
4843 CHK("REDUNDANT_CODE",
4844 "if this code is redundant consider removing it\n" .
4848 # check for needless "if (<foo>) fn(<foo>)" uses
4849 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
4850 my $tested = quotemeta($1);
4851 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
4852 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
4854 if (WARN('NEEDLESS_IF',
4855 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
4858 my $leading_tabs = "";
4859 my $new_leading_tabs = "";
4860 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
4865 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
4866 $new_leading_tabs = $1;
4867 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
4874 fix_delete_line($fixlinenr - 1, $prevrawline);
4875 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
4881 # check for unnecessary "Out of Memory" messages
4882 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
4883 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
4884 (defined $1 || defined $3) &&
4887 my $testline = $lines[$linenr - 3];
4889 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
4890 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
4892 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
4894 "Possible unnecessary 'out of memory' message\n" . $hereprev);
4898 # check for logging functions with KERN_<LEVEL>
4899 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
4900 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
4902 if (WARN("UNNECESSARY_KERN_LEVEL",
4903 "Possible unnecessary $level\n" . $herecurr) &&
4905 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
4909 # check for mask then right shift without a parentheses
4910 if ($^V && $^V ge 5.10.0 &&
4911 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
4912 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
4913 WARN("MASK_THEN_SHIFT",
4914 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
4917 # check for pointer comparisons to NULL
4918 if ($^V && $^V ge 5.10.0) {
4919 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
4922 $equal = "" if ($4 eq "!=");
4923 if (CHK("COMPARISON_TO_NULL",
4924 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
4926 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
4931 # check for bad placement of section $InitAttribute (e.g.: __initdata)
4932 if ($line =~ /(\b$InitAttribute\b)/) {
4934 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
4937 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
4938 ERROR("MISPLACED_INIT",
4939 "$attr should be placed after $var\n" . $herecurr)) ||
4940 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
4941 WARN("MISPLACED_INIT",
4942 "$attr should be placed after $var\n" . $herecurr))) &&
4944 $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;
4949 # check for $InitAttributeData (ie: __initdata) with const
4950 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
4952 $attr =~ /($InitAttributePrefix)(.*)/;
4953 my $attr_prefix = $1;
4955 if (ERROR("INIT_ATTRIBUTE",
4956 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
4958 $fixed[$fixlinenr] =~
4959 s/$InitAttributeData/${attr_prefix}initconst/;
4963 # check for $InitAttributeConst (ie: __initconst) without const
4964 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
4966 if (ERROR("INIT_ATTRIBUTE",
4967 "Use of $attr requires a separate use of const\n" . $herecurr) &&
4969 my $lead = $fixed[$fixlinenr] =~
4970 /(^\+\s*(?:static\s+))/;
4972 $lead = "$lead " if ($lead !~ /^\+$/);
4973 $lead = "${lead}const ";
4974 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
4978 # check for __read_mostly with const non-pointer (should just be const)
4979 if ($line =~ /\b__read_mostly\b/ &&
4980 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
4981 if (ERROR("CONST_READ_MOSTLY",
4982 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
4984 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
4988 # don't use __constant_<foo> functions outside of include/uapi/
4989 if ($realfile !~ m@^include/uapi/@ &&
4990 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
4991 my $constant_func = $1;
4992 my $func = $constant_func;
4993 $func =~ s/^__constant_//;
4994 if (WARN("CONSTANT_CONVERSION",
4995 "$constant_func should be $func\n" . $herecurr) &&
4997 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
5001 # prefer usleep_range over udelay
5002 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
5004 # ignore udelay's < 10, however
5005 if (! ($delay < 10) ) {
5007 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5009 if ($delay > 2000) {
5011 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
5015 # warn about unexpectedly long msleep's
5016 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5019 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5023 # check for comparisons of jiffies
5024 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5025 WARN("JIFFIES_COMPARISON",
5026 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5029 # check for comparisons of get_jiffies_64()
5030 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5031 WARN("JIFFIES_COMPARISON",
5032 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5035 # warn about #ifdefs in C files
5036 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5037 # print "#ifdef in C files should be avoided\n";
5038 # print "$herecurr";
5042 # warn about spacing in #ifdefs
5043 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
5044 if (ERROR("SPACING",
5045 "exactly one space required after that #$1\n" . $herecurr) &&
5047 $fixed[$fixlinenr] =~
5048 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5053 # check for spinlock_t definitions without a comment.
5054 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5055 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
5057 if (!ctx_has_comment($first_line, $linenr)) {
5058 CHK("UNCOMMENTED_DEFINITION",
5059 "$1 definition without comment\n" . $herecurr);
5062 # check for memory barriers without a comment.
5063 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
5064 if (!ctx_has_comment($first_line, $linenr)) {
5065 WARN("MEMORY_BARRIER",
5066 "memory barrier without comment\n" . $herecurr);
5070 # check for waitqueue_active without a comment.
5071 if ($line =~ /\bwaitqueue_active\s*\(/) {
5072 if (!ctx_has_comment($first_line, $linenr)) {
5073 WARN("WAITQUEUE_ACTIVE",
5074 "waitqueue_active without comment\n" . $herecurr);
5078 # Check for expedited grace periods that interrupt non-idle non-nohz
5079 # online CPUs. These expedited can therefore degrade real-time response
5080 # if used carelessly, and should be avoided where not absolutely
5081 # needed. It is always OK to use synchronize_rcu_expedited() and
5082 # synchronize_sched_expedited() at boot time (before real-time applications
5083 # start) and in error situations where real-time response is compromised in
5084 # any case. Note that synchronize_srcu_expedited() does -not- interrupt
5085 # other CPUs, so don't warn on uses of synchronize_srcu_expedited().
5086 # Of course, nothing comes for free, and srcu_read_lock() and
5087 # srcu_read_unlock() do contain full memory barriers in payment for
5088 # synchronize_srcu_expedited() non-interruption properties.
5089 if ($line =~ /\b(synchronize_rcu_expedited|synchronize_sched_expedited)\(/) {
5090 WARN("EXPEDITED_RCU_GRACE_PERIOD",
5091 "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr);
5095 # check of hardware specific defines
5096 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5098 "architecture specific defines should be avoided\n" . $herecurr);
5101 # Check that the storage class is at the beginning of a declaration
5102 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
5103 WARN("STORAGE_CLASS",
5104 "storage class should be at the beginning of the declaration\n" . $herecurr)
5107 # check the location of the inline attribute, that it is between
5108 # storage class and type.
5109 if ($line =~ /\b$Type\s+$Inline\b/ ||
5110 $line =~ /\b$Inline\s+$Storage\b/) {
5111 ERROR("INLINE_LOCATION",
5112 "inline keyword should sit between storage class and type\n" . $herecurr);
5115 # Check for __inline__ and __inline, prefer inline
5116 if ($realfile !~ m@\binclude/uapi/@ &&
5117 $line =~ /\b(__inline__|__inline)\b/) {
5119 "plain inline is preferred over $1\n" . $herecurr) &&
5121 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
5126 # Check for __attribute__ packed, prefer __packed
5127 if ($realfile !~ m@\binclude/uapi/@ &&
5128 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
5129 WARN("PREFER_PACKED",
5130 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
5133 # Check for __attribute__ aligned, prefer __aligned
5134 if ($realfile !~ m@\binclude/uapi/@ &&
5135 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
5136 WARN("PREFER_ALIGNED",
5137 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
5140 # Check for __attribute__ format(printf, prefer __printf
5141 if ($realfile !~ m@\binclude/uapi/@ &&
5142 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
5143 if (WARN("PREFER_PRINTF",
5144 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5146 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5151 # Check for __attribute__ format(scanf, prefer __scanf
5152 if ($realfile !~ m@\binclude/uapi/@ &&
5153 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
5154 if (WARN("PREFER_SCANF",
5155 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5157 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5161 # Check for __attribute__ weak, or __weak declarations (may have link issues)
5162 if ($^V && $^V ge 5.10.0 &&
5163 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5164 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5165 $line =~ /\b__weak\b/)) {
5166 ERROR("WEAK_DECLARATION",
5167 "Using weak declarations can have unintended link defects\n" . $herecurr);
5170 # check for c99 types like uint8_t used outside of uapi/
5171 if ($realfile !~ m@\binclude/uapi/@ &&
5172 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5174 if ($type =~ /\b($typeC99Typedefs)\b/) {
5176 my $kernel_type = 'u';
5177 $kernel_type = 's' if ($type =~ /^_*[si]/);
5180 if (CHK("PREFER_KERNEL_TYPES",
5181 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5183 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5188 # check for sizeof(&)
5189 if ($line =~ /\bsizeof\s*\(\s*\&/) {
5190 WARN("SIZEOF_ADDRESS",
5191 "sizeof(& should be avoided\n" . $herecurr);
5194 # check for sizeof without parenthesis
5195 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
5196 if (WARN("SIZEOF_PARENTHESIS",
5197 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5199 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5203 # check for struct spinlock declarations
5204 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5205 WARN("USE_SPINLOCK_T",
5206 "struct spinlock should be spinlock_t\n" . $herecurr);
5209 # check for seq_printf uses that could be seq_puts
5210 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
5211 my $fmt = get_quoted_string($line, $rawline);
5214 if (WARN("PREFER_SEQ_PUTS",
5215 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5217 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
5222 # Check for misused memsets
5223 if ($^V && $^V ge 5.10.0 &&
5225 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
5231 if ($ms_size =~ /^(0x|)0$/i) {
5233 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
5234 } elsif ($ms_size =~ /^(0x|)1$/i) {
5236 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5240 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5241 if ($^V && $^V ge 5.10.0 &&
5243 $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5244 if (WARN("PREFER_ETHER_ADDR_COPY",
5245 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5247 $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5251 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5252 if ($^V && $^V ge 5.10.0 &&
5254 $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5255 WARN("PREFER_ETHER_ADDR_EQUAL",
5256 "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5259 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5260 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5261 if ($^V && $^V ge 5.10.0 &&
5263 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5267 if ($ms_val =~ /^(?:0x|)0+$/i) {
5268 if (WARN("PREFER_ETH_ZERO_ADDR",
5269 "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5271 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5273 } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5274 if (WARN("PREFER_ETH_BROADCAST_ADDR",
5275 "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5277 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5282 # typecasts on min/max could be min_t/max_t
5283 if ($^V && $^V ge 5.10.0 &&
5285 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
5286 if (defined $2 || defined $7) {
5288 my $cast1 = deparenthesize($2);
5290 my $cast2 = deparenthesize($7);
5294 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
5295 $cast = "$cast1 or $cast2";
5296 } elsif ($cast1 ne "") {
5302 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
5306 # check usleep_range arguments
5307 if ($^V && $^V ge 5.10.0 &&
5309 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5313 WARN("USLEEP_RANGE",
5314 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5315 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5317 WARN("USLEEP_RANGE",
5318 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5322 # check for naked sscanf
5323 if ($^V && $^V ge 5.10.0 &&
5325 $line =~ /\bsscanf\b/ &&
5326 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5327 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5328 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5329 my $lc = $stat =~ tr@\n@@;
5330 $lc = $lc + $linenr;
5331 my $stat_real = raw_line($linenr, 0);
5332 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5333 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5335 WARN("NAKED_SSCANF",
5336 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5339 # check for simple sscanf that should be kstrto<foo>
5340 if ($^V && $^V ge 5.10.0 &&
5342 $line =~ /\bsscanf\b/) {
5343 my $lc = $stat =~ tr@\n@@;
5344 $lc = $lc + $linenr;
5345 my $stat_real = raw_line($linenr, 0);
5346 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5347 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5349 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5351 my $count = $format =~ tr@%@%@;
5353 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5354 WARN("SSCANF_TO_KSTRTO",
5355 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5360 # check for new externs in .h files.
5361 if ($realfile =~ /\.h$/ &&
5362 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
5363 if (CHK("AVOID_EXTERNS",
5364 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
5366 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
5370 # check for new externs in .c files.
5371 if ($realfile =~ /\.c$/ && defined $stat &&
5372 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
5374 my $function_name = $1;
5375 my $paren_space = $2;
5378 if (defined $cond) {
5379 substr($s, 0, length($cond), '');
5381 if ($s =~ /^\s*;/ &&
5382 $function_name ne 'uninitialized_var')
5384 WARN("AVOID_EXTERNS",
5385 "externs should be avoided in .c files\n" . $herecurr);
5388 if ($paren_space =~ /\n/) {
5389 WARN("FUNCTION_ARGUMENTS",
5390 "arguments for function declarations should follow identifier\n" . $herecurr);
5393 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5394 $stat =~ /^.\s*extern\s+/)
5396 WARN("AVOID_EXTERNS",
5397 "externs should be avoided in .c files\n" . $herecurr);
5400 # checks for new __setup's
5401 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5404 if (!grep(/$name/, @setup_docs)) {
5405 CHK("UNDOCUMENTED_SETUP",
5406 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
5410 # check for pointless casting of kmalloc return
5411 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
5412 WARN("UNNECESSARY_CASTS",
5413 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
5417 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5418 if ($^V && $^V ge 5.10.0 &&
5419 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5420 CHK("ALLOC_SIZEOF_STRUCT",
5421 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
5424 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5425 if ($^V && $^V ge 5.10.0 &&
5426 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
5430 my $newfunc = "kmalloc_array";
5431 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
5434 if ($a1 =~ /^sizeof\s*\S/) {
5438 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
5439 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
5440 if (WARN("ALLOC_WITH_MULTIPLY",
5441 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
5443 $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;
5449 # check for krealloc arg reuse
5450 if ($^V && $^V ge 5.10.0 &&
5451 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
5452 WARN("KREALLOC_ARG_REUSE",
5453 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
5456 # check for alloc argument mismatch
5457 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
5458 WARN("ALLOC_ARRAY_ARGS",
5459 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
5462 # check for multiple semicolons
5463 if ($line =~ /;\s*;\s*$/) {
5464 if (WARN("ONE_SEMICOLON",
5465 "Statements terminations use 1 semicolon\n" . $herecurr) &&
5467 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
5471 # check for #defines like: 1 << <digit> that could be BIT(digit)
5472 if ($line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
5474 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
5475 if (CHK("BIT_MACRO",
5476 "Prefer using the BIT$ull macro\n" . $herecurr) &&
5478 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
5482 # check for case / default statements not preceded by break/fallthrough/switch
5483 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
5485 my $has_statement = 0;
5487 my $prevline = $linenr;
5488 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
5490 my $rline = $rawlines[$prevline - 1];
5491 my $fline = $lines[$prevline - 1];
5492 last if ($fline =~ /^\@\@/);
5493 next if ($fline =~ /^\-/);
5494 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
5495 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
5496 next if ($fline =~ /^.[\s$;]*$/);
5499 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
5501 if (!$has_break && $has_statement) {
5502 WARN("MISSING_BREAK",
5503 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
5507 # check for switch/default statements without a break;
5508 if ($^V && $^V ge 5.10.0 &&
5510 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
5512 my $herectx = $here . "\n";
5513 my $cnt = statement_rawlines($stat);
5514 for (my $n = 0; $n < $cnt; $n++) {
5515 $herectx .= raw_line($linenr, $n) . "\n";
5517 WARN("DEFAULT_NO_BREAK",
5518 "switch default: should use break\n" . $herectx);
5521 # check for gcc specific __FUNCTION__
5522 if ($line =~ /\b__FUNCTION__\b/) {
5523 if (WARN("USE_FUNC",
5524 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
5526 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
5530 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
5531 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
5533 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
5536 # check for use of yield()
5537 if ($line =~ /\byield\s*\(\s*\)/) {
5539 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
5542 # check for comparisons against true and false
5543 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
5551 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
5553 my $type = lc($otype);
5554 if ($type =~ /^(?:true|false)$/) {
5555 if (("$test" eq "==" && "$type" eq "true") ||
5556 ("$test" eq "!=" && "$type" eq "false")) {
5560 CHK("BOOL_COMPARISON",
5561 "Using comparison to $otype is error prone\n" . $herecurr);
5563 ## maybe suggesting a correct construct would better
5564 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5569 # check for semaphores initialized locked
5570 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
5571 WARN("CONSIDER_COMPLETION",
5572 "consider using a completion\n" . $herecurr);
5575 # recommend kstrto* over simple_strto* and strict_strto*
5576 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
5577 WARN("CONSIDER_KSTRTO",
5578 "$1 is obsolete, use k$3 instead\n" . $herecurr);
5581 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
5582 if ($line =~ /^.\s*__initcall\s*\(/) {
5583 WARN("USE_DEVICE_INITCALL",
5584 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
5587 # check for various structs that are normally const (ops, kgdb, device_tree)
5588 my $const_structs = qr{
5590 address_space_operations|
5592 block_device_operations|
5597 file_lock_operations|
5607 lock_manager_operations|
5614 pipe_buf_operations|
5615 platform_hibernation_ops|
5616 platform_suspend_ops|
5621 soc_pcmcia_socket_ops|
5628 if ($line !~ /\bconst\b/ &&
5629 $line =~ /\bstruct\s+($const_structs)\b/) {
5630 WARN("CONST_STRUCT",
5631 "struct $1 should normally be const\n" .
5635 # use of NR_CPUS is usually wrong
5636 # ignore definitions of NR_CPUS and usage to define arrays as likely right
5637 if ($line =~ /\bNR_CPUS\b/ &&
5638 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
5639 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
5640 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
5641 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
5642 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
5645 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
5648 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
5649 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
5650 ERROR("DEFINE_ARCH_HAS",
5651 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
5654 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
5655 if ($^V && $^V ge 5.10.0 &&
5656 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
5657 WARN("LIKELY_MISUSE",
5658 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
5661 # whine mightly about in_atomic
5662 if ($line =~ /\bin_atomic\s*\(/) {
5663 if ($realfile =~ m@^drivers/@) {
5665 "do not use in_atomic in drivers\n" . $herecurr);
5666 } elsif ($realfile !~ m@^kernel/@) {
5668 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
5672 # check for lockdep_set_novalidate_class
5673 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
5674 $line =~ /__lockdep_no_validate__\s*\)/ ) {
5675 if ($realfile !~ m@^kernel/lockdep@ &&
5676 $realfile !~ m@^include/linux/lockdep@ &&
5677 $realfile !~ m@^drivers/base/core@) {
5679 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
5683 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
5684 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
5685 WARN("EXPORTED_WORLD_WRITABLE",
5686 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5689 # Mode permission misuses where it seems decimal should be octal
5690 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5691 if ($^V && $^V ge 5.10.0 &&
5692 $line =~ /$mode_perms_search/) {
5693 foreach my $entry (@mode_permission_funcs) {
5694 my $func = $entry->[0];
5695 my $arg_pos = $entry->[1];
5700 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
5702 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
5703 if ($line =~ /$test/) {
5705 $val = $6 if ($skip_args ne "");
5707 if ($val !~ /^0$/ &&
5708 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
5709 length($val) ne 4)) {
5710 ERROR("NON_OCTAL_PERMISSIONS",
5711 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
5712 } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) {
5713 ERROR("EXPORTED_WORLD_WRITABLE",
5714 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5720 # validate content of MODULE_LICENSE against list from include/linux/module.h
5721 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
5722 my $extracted_string = get_quoted_string($line, $rawline);
5723 my $valid_licenses = qr{
5726 GPL\ and\ additional\ rights|
5732 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
5733 WARN("MODULE_LICENSE",
5734 "unknown module license " . $extracted_string . "\n" . $herecurr);
5739 # If we have no input at all, then there is nothing to report on
5740 # so just keep quiet.
5741 if ($#rawlines == -1) {
5745 # In mailback mode only produce a report in the negative, for
5746 # things that appear to be patches.
5747 if ($mailback && ($clean == 1 || !$is_patch)) {
5751 # This is not a patch, and we are are in 'no-patch' mode so
5753 if (!$chk_patch && !$is_patch) {
5757 if (!$is_patch && $file !~ /cover-letter\.patch$/) {
5758 ERROR("NOT_UNIFIED_DIFF",
5759 "Does not appear to be a unified-diff format patch\n");
5761 if ($is_patch && $filename ne '-' && $chk_signoff && $signoff == 0) {
5762 ERROR("MISSING_SIGN_OFF",
5763 "Missing Signed-off-by: line(s)\n");
5766 print report_dump();
5767 if ($summary && !($clean == 1 && $quiet == 1)) {
5768 print "$filename " if ($summary_file);
5769 print "total: $cnt_error errors, $cnt_warn warnings, " .
5770 (($check)? "$cnt_chk checks, " : "") .
5771 "$cnt_lines lines checked\n";
5775 # If there were whitespace errors which cleanpatch can fix
5776 # then suggest that.
5777 if ($rpt_cleaners) {
5781 NOTE: Whitespace errors detected.
5782 You may wish to use scripts/cleanpatch or scripts/cleanfile
5787 if ($clean == 0 && $fix &&
5788 ("@rawlines" ne "@fixed" ||
5789 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
5790 my $newfile = $filename;
5791 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
5795 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
5797 open($f, '>', $newfile)
5798 or die "$P: Can't open $newfile for write\n";
5799 foreach my $fixed_line (@fixed) {
5802 if ($linecount > 3) {
5803 $fixed_line =~ s/^\+//;
5804 print $f $fixed_line . "\n";
5807 print $f $fixed_line . "\n";
5815 Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
5817 Do _NOT_ trust the results written to this file.
5818 Do _NOT_ submit these changes without inspecting them for correctness.
5820 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
5821 No warranties, expressed or implied...
5829 print "$vname has no obvious style problems and is ready for submission.\n";
5831 print "$vname has style problems, please review.\n";