Revert "[media] v4l: vb2-memops: use vma slab when vma allocation"
[linux/fpc-iii.git] / scripts / checkpatch.pl
blobd12435992dea9d9910a007ec0bfd48e0230a26cd
1 #!/usr/bin/perl -w
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
8 use strict;
9 use POSIX;
10 use File::Basename;
11 use Cwd 'abs_path';
13 my $P = $0;
14 my $D = dirname(abs_path($P));
16 my $V = '0.32';
18 use Getopt::Long qw(:config no_auto_abbrev);
20 my $quiet = 0;
21 my $tree = 1;
22 my $chk_signoff = 1;
23 my $chk_patch = 1;
24 my $tst_only;
25 my $emacs = 0;
26 my $terse = 0;
27 my $file = 0;
28 my $check = 0;
29 my $check_orig = 0;
30 my $summary = 1;
31 my $mailback = 0;
32 my $summary_file = 0;
33 my $show_types = 0;
34 my $fix = 0;
35 my $fix_inplace = 0;
36 my $root;
37 my %debug;
38 my %camelcase = ();
39 my %use_type = ();
40 my @use = ();
41 my %ignore_type = ();
42 my @ignore = ();
43 my $help = 0;
44 my $configuration_file = ".checkpatch.conf";
45 my $max_line_length = 80;
46 my $ignore_perl_version = 0;
47 my $minimum_perl_version = 5.10.0;
48 my $min_conf_desc_length = 4;
49 my $spelling_file = "$D/spelling.txt";
51 sub help {
52 my ($exitcode) = @_;
54 print << "EOM";
55 Usage: $P [OPTION]... [FILE]...
56 Version: $V
58 Options:
59 -q, --quiet quiet
60 --no-tree run without a kernel tree
61 --no-signoff do not check for 'Signed-off-by' line
62 --patch treat FILE as patchfile (default)
63 --emacs emacs compile window format
64 --terse one line per report
65 -f, --file treat FILE as regular source file
66 --subjective, --strict enable more subjective tests
67 --types TYPE(,TYPE2...) show only these comma separated message types
68 --ignore TYPE(,TYPE2...) ignore various comma separated message types
69 --max-line-length=n set the maximum line length, if exceeded, warn
70 --min-conf-desc-length=n set the min description length, if shorter, warn
71 --show-types show the message "types" in the output
72 --root=PATH PATH to the kernel tree root
73 --no-summary suppress the per-file summary
74 --mailback only produce a report in case of warnings/errors
75 --summary-file include the filename in summary
76 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
77 'values', 'possible', 'type', and 'attr' (default
78 is all off)
79 --test-only=WORD report only warnings/errors containing WORD
80 literally
81 --fix EXPERIMENTAL - may create horrible results
82 If correctable single-line errors exist, create
83 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
84 with potential errors corrected to the preferred
85 checkpatch style
86 --fix-inplace EXPERIMENTAL - may create horrible results
87 Is the same as --fix, but overwrites the input
88 file. It's your fault if there's no backup or git
89 --ignore-perl-version override checking of perl version. expect
90 runtime errors.
91 -h, --help, --version display this help and exit
93 When FILE is - read standard input.
94 EOM
96 exit($exitcode);
99 my $conf = which_conf($configuration_file);
100 if (-f $conf) {
101 my @conf_args;
102 open(my $conffile, '<', "$conf")
103 or warn "$P: Can't find a readable $configuration_file file $!\n";
105 while (<$conffile>) {
106 my $line = $_;
108 $line =~ s/\s*\n?$//g;
109 $line =~ s/^\s*//g;
110 $line =~ s/\s+/ /g;
112 next if ($line =~ m/^\s*#/);
113 next if ($line =~ m/^\s*$/);
115 my @words = split(" ", $line);
116 foreach my $word (@words) {
117 last if ($word =~ m/^#/);
118 push (@conf_args, $word);
121 close($conffile);
122 unshift(@ARGV, @conf_args) if @conf_args;
125 GetOptions(
126 'q|quiet+' => \$quiet,
127 'tree!' => \$tree,
128 'signoff!' => \$chk_signoff,
129 'patch!' => \$chk_patch,
130 'emacs!' => \$emacs,
131 'terse!' => \$terse,
132 'f|file!' => \$file,
133 'subjective!' => \$check,
134 'strict!' => \$check,
135 'ignore=s' => \@ignore,
136 'types=s' => \@use,
137 'show-types!' => \$show_types,
138 'max-line-length=i' => \$max_line_length,
139 'min-conf-desc-length=i' => \$min_conf_desc_length,
140 'root=s' => \$root,
141 'summary!' => \$summary,
142 'mailback!' => \$mailback,
143 'summary-file!' => \$summary_file,
144 'fix!' => \$fix,
145 'fix-inplace!' => \$fix_inplace,
146 'ignore-perl-version!' => \$ignore_perl_version,
147 'debug=s' => \%debug,
148 'test-only=s' => \$tst_only,
149 'h|help' => \$help,
150 'version' => \$help
151 ) or help(1);
153 help(0) if ($help);
155 $fix = 1 if ($fix_inplace);
156 $check_orig = $check;
158 my $exit = 0;
160 if ($^V && $^V lt $minimum_perl_version) {
161 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
162 if (!$ignore_perl_version) {
163 exit(1);
167 if ($#ARGV < 0) {
168 print "$P: no input files\n";
169 exit(1);
172 sub hash_save_array_words {
173 my ($hashRef, $arrayRef) = @_;
175 my @array = split(/,/, join(',', @$arrayRef));
176 foreach my $word (@array) {
177 $word =~ s/\s*\n?$//g;
178 $word =~ s/^\s*//g;
179 $word =~ s/\s+/ /g;
180 $word =~ tr/[a-z]/[A-Z]/;
182 next if ($word =~ m/^\s*#/);
183 next if ($word =~ m/^\s*$/);
185 $hashRef->{$word}++;
189 sub hash_show_words {
190 my ($hashRef, $prefix) = @_;
192 if ($quiet == 0 && keys %$hashRef) {
193 print "NOTE: $prefix message types:";
194 foreach my $word (sort keys %$hashRef) {
195 print " $word";
197 print "\n\n";
201 hash_save_array_words(\%ignore_type, \@ignore);
202 hash_save_array_words(\%use_type, \@use);
204 my $dbg_values = 0;
205 my $dbg_possible = 0;
206 my $dbg_type = 0;
207 my $dbg_attr = 0;
208 for my $key (keys %debug) {
209 ## no critic
210 eval "\${dbg_$key} = '$debug{$key}';";
211 die "$@" if ($@);
214 my $rpt_cleaners = 0;
216 if ($terse) {
217 $emacs = 1;
218 $quiet++;
221 if ($tree) {
222 if (defined $root) {
223 if (!top_of_kernel_tree($root)) {
224 die "$P: $root: --root does not point at a valid tree\n";
226 } else {
227 if (top_of_kernel_tree('.')) {
228 $root = '.';
229 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
230 top_of_kernel_tree($1)) {
231 $root = $1;
235 if (!defined $root) {
236 print "Must be run from the top-level dir. of a kernel tree\n";
237 exit(2);
241 my $emitted_corrupt = 0;
243 our $Ident = qr{
244 [A-Za-z_][A-Za-z\d_]*
245 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
247 our $Storage = qr{extern|static|asmlinkage};
248 our $Sparse = qr{
249 __user|
250 __kernel|
251 __force|
252 __iomem|
253 __must_check|
254 __init_refok|
255 __kprobes|
256 __ref|
257 __rcu
259 our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
260 our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
261 our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
262 our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
263 our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
265 # Notes to $Attribute:
266 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
267 our $Attribute = qr{
268 const|
269 __percpu|
270 __nocast|
271 __safe|
272 __bitwise__|
273 __packed__|
274 __packed2__|
275 __naked|
276 __maybe_unused|
277 __always_unused|
278 __noreturn|
279 __used|
280 __cold|
281 __pure|
282 __noclone|
283 __deprecated|
284 __read_mostly|
285 __kprobes|
286 $InitAttribute|
287 ____cacheline_aligned|
288 ____cacheline_aligned_in_smp|
289 ____cacheline_internodealigned_in_smp|
290 __weak
292 our $Modifier;
293 our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
294 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
295 our $Lval = qr{$Ident(?:$Member)*};
297 our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
298 our $Binary = qr{(?i)0b[01]+$Int_type?};
299 our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
300 our $Int = qr{[0-9]+$Int_type?};
301 our $Octal = qr{0[0-7]+$Int_type?};
302 our $String = qr{"[X\t]*"};
303 our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
304 our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
305 our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
306 our $Float = qr{$Float_hex|$Float_dec|$Float_int};
307 our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
308 our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
309 our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
310 our $Arithmetic = qr{\+|-|\*|\/|%};
311 our $Operators = qr{
312 <=|>=|==|!=|
313 =>|->|<<|>>|<|>|!|~|
314 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
317 our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
319 our $NonptrType;
320 our $NonptrTypeMisordered;
321 our $NonptrTypeWithAttr;
322 our $Type;
323 our $TypeMisordered;
324 our $Declare;
325 our $DeclareMisordered;
327 our $NON_ASCII_UTF8 = qr{
328 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
329 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
330 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
331 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
332 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
333 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
334 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
337 our $UTF8 = qr{
338 [\x09\x0A\x0D\x20-\x7E] # ASCII
339 | $NON_ASCII_UTF8
342 our $typeOtherOSTypedefs = qr{(?x:
343 u_(?:char|short|int|long) | # bsd
344 u(?:nchar|short|int|long) # sysv
347 our $typeTypedefs = qr{(?x:
348 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
349 atomic_t
352 our $logFunctions = qr{(?x:
353 printk(?:_ratelimited|_once|)|
354 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
355 WARN(?:_RATELIMIT|_ONCE|)|
356 panic|
357 MODULE_[A-Z_]+|
358 seq_vprintf|seq_printf|seq_puts
361 our $signature_tags = qr{(?xi:
362 Signed-off-by:|
363 Acked-by:|
364 Tested-by:|
365 Reviewed-by:|
366 Reported-by:|
367 Suggested-by:|
368 To:|
372 our @typeListMisordered = (
373 qr{char\s+(?:un)?signed},
374 qr{int\s+(?:(?:un)?signed\s+)?short\s},
375 qr{int\s+short(?:\s+(?:un)?signed)},
376 qr{short\s+int(?:\s+(?:un)?signed)},
377 qr{(?:un)?signed\s+int\s+short},
378 qr{short\s+(?:un)?signed},
379 qr{long\s+int\s+(?:un)?signed},
380 qr{int\s+long\s+(?:un)?signed},
381 qr{long\s+(?:un)?signed\s+int},
382 qr{int\s+(?:un)?signed\s+long},
383 qr{int\s+(?:un)?signed},
384 qr{int\s+long\s+long\s+(?:un)?signed},
385 qr{long\s+long\s+int\s+(?:un)?signed},
386 qr{long\s+long\s+(?:un)?signed\s+int},
387 qr{long\s+long\s+(?:un)?signed},
388 qr{long\s+(?:un)?signed},
391 our @typeList = (
392 qr{void},
393 qr{(?:(?:un)?signed\s+)?char},
394 qr{(?:(?:un)?signed\s+)?short\s+int},
395 qr{(?:(?:un)?signed\s+)?short},
396 qr{(?:(?:un)?signed\s+)?int},
397 qr{(?:(?:un)?signed\s+)?long\s+int},
398 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
399 qr{(?:(?:un)?signed\s+)?long\s+long},
400 qr{(?:(?:un)?signed\s+)?long},
401 qr{(?:un)?signed},
402 qr{float},
403 qr{double},
404 qr{bool},
405 qr{struct\s+$Ident},
406 qr{union\s+$Ident},
407 qr{enum\s+$Ident},
408 qr{${Ident}_t},
409 qr{${Ident}_handler},
410 qr{${Ident}_handler_fn},
411 @typeListMisordered,
413 our @typeListWithAttr = (
414 @typeList,
415 qr{struct\s+$InitAttribute\s+$Ident},
416 qr{union\s+$InitAttribute\s+$Ident},
419 our @modifierList = (
420 qr{fastcall},
423 our @mode_permission_funcs = (
424 ["module_param", 3],
425 ["module_param_(?:array|named|string)", 4],
426 ["module_param_array_named", 5],
427 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
428 ["proc_create(?:_data|)", 2],
429 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
432 #Create a search pattern for all these functions to speed up a loop below
433 our $mode_perms_search = "";
434 foreach my $entry (@mode_permission_funcs) {
435 $mode_perms_search .= '|' if ($mode_perms_search ne "");
436 $mode_perms_search .= $entry->[0];
439 our $allowed_asm_includes = qr{(?x:
440 irq|
441 memory|
442 time|
443 reboot
445 # memory.h: ARM has a custom one
447 # Load common spelling mistakes and build regular expression list.
448 my $misspellings;
449 my %spelling_fix;
451 if (open(my $spelling, '<', $spelling_file)) {
452 my @spelling_list;
453 while (<$spelling>) {
454 my $line = $_;
456 $line =~ s/\s*\n?$//g;
457 $line =~ s/^\s*//g;
459 next if ($line =~ m/^\s*#/);
460 next if ($line =~ m/^\s*$/);
462 my ($suspect, $fix) = split(/\|\|/, $line);
464 push(@spelling_list, $suspect);
465 $spelling_fix{$suspect} = $fix;
467 close($spelling);
468 $misspellings = join("|", @spelling_list);
469 } else {
470 warn "No typos will be found - file '$spelling_file': $!\n";
473 sub build_types {
474 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
475 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
476 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
477 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
478 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
479 $NonptrType = qr{
480 (?:$Modifier\s+|const\s+)*
482 (?:typeof|__typeof__)\s*\([^\)]*\)|
483 (?:$typeOtherOSTypedefs\b)|
484 (?:$typeTypedefs\b)|
485 (?:${all}\b)
487 (?:\s+$Modifier|\s+const)*
489 $NonptrTypeMisordered = qr{
490 (?:$Modifier\s+|const\s+)*
492 (?:${Misordered}\b)
494 (?:\s+$Modifier|\s+const)*
496 $NonptrTypeWithAttr = qr{
497 (?:$Modifier\s+|const\s+)*
499 (?:typeof|__typeof__)\s*\([^\)]*\)|
500 (?:$typeTypedefs\b)|
501 (?:$typeOtherOSTypedefs\b)|
502 (?:${allWithAttr}\b)
504 (?:\s+$Modifier|\s+const)*
506 $Type = qr{
507 $NonptrType
508 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
509 (?:\s+$Inline|\s+$Modifier)*
511 $TypeMisordered = qr{
512 $NonptrTypeMisordered
513 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
514 (?:\s+$Inline|\s+$Modifier)*
516 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
517 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
519 build_types();
521 our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
523 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
524 # requires at least perl version v5.10.0
525 # Any use must be runtime checked with $^V
527 our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
528 our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
529 our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
531 our $declaration_macros = qr{(?x:
532 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,2}\s*\(|
533 (?:$Storage\s+)?LIST_HEAD\s*\(|
534 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
537 sub deparenthesize {
538 my ($string) = @_;
539 return "" if (!defined($string));
541 while ($string =~ /^\s*\(.*\)\s*$/) {
542 $string =~ s@^\s*\(\s*@@;
543 $string =~ s@\s*\)\s*$@@;
546 $string =~ s@\s+@ @g;
548 return $string;
551 sub seed_camelcase_file {
552 my ($file) = @_;
554 return if (!(-f $file));
556 local $/;
558 open(my $include_file, '<', "$file")
559 or warn "$P: Can't read '$file' $!\n";
560 my $text = <$include_file>;
561 close($include_file);
563 my @lines = split('\n', $text);
565 foreach my $line (@lines) {
566 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
567 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
568 $camelcase{$1} = 1;
569 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
570 $camelcase{$1} = 1;
571 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
572 $camelcase{$1} = 1;
577 my $camelcase_seeded = 0;
578 sub seed_camelcase_includes {
579 return if ($camelcase_seeded);
581 my $files;
582 my $camelcase_cache = "";
583 my @include_files = ();
585 $camelcase_seeded = 1;
587 if (-e ".git") {
588 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
589 chomp $git_last_include_commit;
590 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
591 } else {
592 my $last_mod_date = 0;
593 $files = `find $root/include -name "*.h"`;
594 @include_files = split('\n', $files);
595 foreach my $file (@include_files) {
596 my $date = POSIX::strftime("%Y%m%d%H%M",
597 localtime((stat $file)[9]));
598 $last_mod_date = $date if ($last_mod_date < $date);
600 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
603 if ($camelcase_cache ne "" && -f $camelcase_cache) {
604 open(my $camelcase_file, '<', "$camelcase_cache")
605 or warn "$P: Can't read '$camelcase_cache' $!\n";
606 while (<$camelcase_file>) {
607 chomp;
608 $camelcase{$_} = 1;
610 close($camelcase_file);
612 return;
615 if (-e ".git") {
616 $files = `git ls-files "include/*.h"`;
617 @include_files = split('\n', $files);
620 foreach my $file (@include_files) {
621 seed_camelcase_file($file);
624 if ($camelcase_cache ne "") {
625 unlink glob ".checkpatch-camelcase.*";
626 open(my $camelcase_file, '>', "$camelcase_cache")
627 or warn "$P: Can't write '$camelcase_cache' $!\n";
628 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
629 print $camelcase_file ("$_\n");
631 close($camelcase_file);
635 sub git_commit_info {
636 my ($commit, $id, $desc) = @_;
638 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
640 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
641 $output =~ s/^\s*//gm;
642 my @lines = split("\n", $output);
644 return ($id, $desc) if ($#lines < 0);
646 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
647 # Maybe one day convert this block of bash into something that returns
648 # all matching commit ids, but it's very slow...
650 # echo "checking commits $1..."
651 # git rev-list --remotes | grep -i "^$1" |
652 # while read line ; do
653 # git log --format='%H %s' -1 $line |
654 # echo "commit $(cut -c 1-12,41-)"
655 # done
656 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
657 } else {
658 $id = substr($lines[0], 0, 12);
659 $desc = substr($lines[0], 41);
662 return ($id, $desc);
665 $chk_signoff = 0 if ($file);
667 my @rawlines = ();
668 my @lines = ();
669 my @fixed = ();
670 my @fixed_inserted = ();
671 my @fixed_deleted = ();
672 my $fixlinenr = -1;
674 my $vname;
675 for my $filename (@ARGV) {
676 my $FILE;
677 if ($file) {
678 open($FILE, '-|', "diff -u /dev/null $filename") ||
679 die "$P: $filename: diff failed - $!\n";
680 } elsif ($filename eq '-') {
681 open($FILE, '<&STDIN');
682 } else {
683 open($FILE, '<', "$filename") ||
684 die "$P: $filename: open failed - $!\n";
686 if ($filename eq '-') {
687 $vname = 'Your patch';
688 } else {
689 $vname = $filename;
691 while (<$FILE>) {
692 chomp;
693 push(@rawlines, $_);
695 close($FILE);
696 if (!process($filename)) {
697 $exit = 1;
699 @rawlines = ();
700 @lines = ();
701 @fixed = ();
702 @fixed_inserted = ();
703 @fixed_deleted = ();
704 $fixlinenr = -1;
707 exit($exit);
709 sub top_of_kernel_tree {
710 my ($root) = @_;
712 my @tree_check = (
713 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
714 "README", "Documentation", "arch", "include", "drivers",
715 "fs", "init", "ipc", "kernel", "lib", "scripts",
718 foreach my $check (@tree_check) {
719 if (! -e $root . '/' . $check) {
720 return 0;
723 return 1;
726 sub parse_email {
727 my ($formatted_email) = @_;
729 my $name = "";
730 my $address = "";
731 my $comment = "";
733 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
734 $name = $1;
735 $address = $2;
736 $comment = $3 if defined $3;
737 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
738 $address = $1;
739 $comment = $2 if defined $2;
740 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
741 $address = $1;
742 $comment = $2 if defined $2;
743 $formatted_email =~ s/$address.*$//;
744 $name = $formatted_email;
745 $name = trim($name);
746 $name =~ s/^\"|\"$//g;
747 # If there's a name left after stripping spaces and
748 # leading quotes, and the address doesn't have both
749 # leading and trailing angle brackets, the address
750 # is invalid. ie:
751 # "joe smith joe@smith.com" bad
752 # "joe smith <joe@smith.com" bad
753 if ($name ne "" && $address !~ /^<[^>]+>$/) {
754 $name = "";
755 $address = "";
756 $comment = "";
760 $name = trim($name);
761 $name =~ s/^\"|\"$//g;
762 $address = trim($address);
763 $address =~ s/^\<|\>$//g;
765 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
766 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
767 $name = "\"$name\"";
770 return ($name, $address, $comment);
773 sub format_email {
774 my ($name, $address) = @_;
776 my $formatted_email;
778 $name = trim($name);
779 $name =~ s/^\"|\"$//g;
780 $address = trim($address);
782 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
783 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
784 $name = "\"$name\"";
787 if ("$name" eq "") {
788 $formatted_email = "$address";
789 } else {
790 $formatted_email = "$name <$address>";
793 return $formatted_email;
796 sub which {
797 my ($bin) = @_;
799 foreach my $path (split(/:/, $ENV{PATH})) {
800 if (-e "$path/$bin") {
801 return "$path/$bin";
805 return "";
808 sub which_conf {
809 my ($conf) = @_;
811 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
812 if (-e "$path/$conf") {
813 return "$path/$conf";
817 return "";
820 sub expand_tabs {
821 my ($str) = @_;
823 my $res = '';
824 my $n = 0;
825 for my $c (split(//, $str)) {
826 if ($c eq "\t") {
827 $res .= ' ';
828 $n++;
829 for (; ($n % 8) != 0; $n++) {
830 $res .= ' ';
832 next;
834 $res .= $c;
835 $n++;
838 return $res;
840 sub copy_spacing {
841 (my $res = shift) =~ tr/\t/ /c;
842 return $res;
845 sub line_stats {
846 my ($line) = @_;
848 # Drop the diff line leader and expand tabs
849 $line =~ s/^.//;
850 $line = expand_tabs($line);
852 # Pick the indent from the front of the line.
853 my ($white) = ($line =~ /^(\s*)/);
855 return (length($line), length($white));
858 my $sanitise_quote = '';
860 sub sanitise_line_reset {
861 my ($in_comment) = @_;
863 if ($in_comment) {
864 $sanitise_quote = '*/';
865 } else {
866 $sanitise_quote = '';
869 sub sanitise_line {
870 my ($line) = @_;
872 my $res = '';
873 my $l = '';
875 my $qlen = 0;
876 my $off = 0;
877 my $c;
879 # Always copy over the diff marker.
880 $res = substr($line, 0, 1);
882 for ($off = 1; $off < length($line); $off++) {
883 $c = substr($line, $off, 1);
885 # Comments we are wacking completly including the begin
886 # and end, all to $;.
887 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
888 $sanitise_quote = '*/';
890 substr($res, $off, 2, "$;$;");
891 $off++;
892 next;
894 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
895 $sanitise_quote = '';
896 substr($res, $off, 2, "$;$;");
897 $off++;
898 next;
900 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
901 $sanitise_quote = '//';
903 substr($res, $off, 2, $sanitise_quote);
904 $off++;
905 next;
908 # A \ in a string means ignore the next character.
909 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
910 $c eq "\\") {
911 substr($res, $off, 2, 'XX');
912 $off++;
913 next;
915 # Regular quotes.
916 if ($c eq "'" || $c eq '"') {
917 if ($sanitise_quote eq '') {
918 $sanitise_quote = $c;
920 substr($res, $off, 1, $c);
921 next;
922 } elsif ($sanitise_quote eq $c) {
923 $sanitise_quote = '';
927 #print "c<$c> SQ<$sanitise_quote>\n";
928 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
929 substr($res, $off, 1, $;);
930 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
931 substr($res, $off, 1, $;);
932 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
933 substr($res, $off, 1, 'X');
934 } else {
935 substr($res, $off, 1, $c);
939 if ($sanitise_quote eq '//') {
940 $sanitise_quote = '';
943 # The pathname on a #include may be surrounded by '<' and '>'.
944 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
945 my $clean = 'X' x length($1);
946 $res =~ s@\<.*\>@<$clean>@;
948 # The whole of a #error is a string.
949 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
950 my $clean = 'X' x length($1);
951 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
954 return $res;
957 sub get_quoted_string {
958 my ($line, $rawline) = @_;
960 return "" if ($line !~ m/(\"[X\t]+\")/g);
961 return substr($rawline, $-[0], $+[0] - $-[0]);
964 sub ctx_statement_block {
965 my ($linenr, $remain, $off) = @_;
966 my $line = $linenr - 1;
967 my $blk = '';
968 my $soff = $off;
969 my $coff = $off - 1;
970 my $coff_set = 0;
972 my $loff = 0;
974 my $type = '';
975 my $level = 0;
976 my @stack = ();
977 my $p;
978 my $c;
979 my $len = 0;
981 my $remainder;
982 while (1) {
983 @stack = (['', 0]) if ($#stack == -1);
985 #warn "CSB: blk<$blk> remain<$remain>\n";
986 # If we are about to drop off the end, pull in more
987 # context.
988 if ($off >= $len) {
989 for (; $remain > 0; $line++) {
990 last if (!defined $lines[$line]);
991 next if ($lines[$line] =~ /^-/);
992 $remain--;
993 $loff = $len;
994 $blk .= $lines[$line] . "\n";
995 $len = length($blk);
996 $line++;
997 last;
999 # Bail if there is no further context.
1000 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1001 if ($off >= $len) {
1002 last;
1004 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1005 $level++;
1006 $type = '#';
1009 $p = $c;
1010 $c = substr($blk, $off, 1);
1011 $remainder = substr($blk, $off);
1013 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1015 # Handle nested #if/#else.
1016 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1017 push(@stack, [ $type, $level ]);
1018 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1019 ($type, $level) = @{$stack[$#stack - 1]};
1020 } elsif ($remainder =~ /^#\s*endif\b/) {
1021 ($type, $level) = @{pop(@stack)};
1024 # Statement ends at the ';' or a close '}' at the
1025 # outermost level.
1026 if ($level == 0 && $c eq ';') {
1027 last;
1030 # An else is really a conditional as long as its not else if
1031 if ($level == 0 && $coff_set == 0 &&
1032 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1033 $remainder =~ /^(else)(?:\s|{)/ &&
1034 $remainder !~ /^else\s+if\b/) {
1035 $coff = $off + length($1) - 1;
1036 $coff_set = 1;
1037 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1038 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1041 if (($type eq '' || $type eq '(') && $c eq '(') {
1042 $level++;
1043 $type = '(';
1045 if ($type eq '(' && $c eq ')') {
1046 $level--;
1047 $type = ($level != 0)? '(' : '';
1049 if ($level == 0 && $coff < $soff) {
1050 $coff = $off;
1051 $coff_set = 1;
1052 #warn "CSB: mark coff<$coff>\n";
1055 if (($type eq '' || $type eq '{') && $c eq '{') {
1056 $level++;
1057 $type = '{';
1059 if ($type eq '{' && $c eq '}') {
1060 $level--;
1061 $type = ($level != 0)? '{' : '';
1063 if ($level == 0) {
1064 if (substr($blk, $off + 1, 1) eq ';') {
1065 $off++;
1067 last;
1070 # Preprocessor commands end at the newline unless escaped.
1071 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1072 $level--;
1073 $type = '';
1074 $off++;
1075 last;
1077 $off++;
1079 # We are truly at the end, so shuffle to the next line.
1080 if ($off == $len) {
1081 $loff = $len + 1;
1082 $line++;
1083 $remain--;
1086 my $statement = substr($blk, $soff, $off - $soff + 1);
1087 my $condition = substr($blk, $soff, $coff - $soff + 1);
1089 #warn "STATEMENT<$statement>\n";
1090 #warn "CONDITION<$condition>\n";
1092 #print "coff<$coff> soff<$off> loff<$loff>\n";
1094 return ($statement, $condition,
1095 $line, $remain + 1, $off - $loff + 1, $level);
1098 sub statement_lines {
1099 my ($stmt) = @_;
1101 # Strip the diff line prefixes and rip blank lines at start and end.
1102 $stmt =~ s/(^|\n)./$1/g;
1103 $stmt =~ s/^\s*//;
1104 $stmt =~ s/\s*$//;
1106 my @stmt_lines = ($stmt =~ /\n/g);
1108 return $#stmt_lines + 2;
1111 sub statement_rawlines {
1112 my ($stmt) = @_;
1114 my @stmt_lines = ($stmt =~ /\n/g);
1116 return $#stmt_lines + 2;
1119 sub statement_block_size {
1120 my ($stmt) = @_;
1122 $stmt =~ s/(^|\n)./$1/g;
1123 $stmt =~ s/^\s*{//;
1124 $stmt =~ s/}\s*$//;
1125 $stmt =~ s/^\s*//;
1126 $stmt =~ s/\s*$//;
1128 my @stmt_lines = ($stmt =~ /\n/g);
1129 my @stmt_statements = ($stmt =~ /;/g);
1131 my $stmt_lines = $#stmt_lines + 2;
1132 my $stmt_statements = $#stmt_statements + 1;
1134 if ($stmt_lines > $stmt_statements) {
1135 return $stmt_lines;
1136 } else {
1137 return $stmt_statements;
1141 sub ctx_statement_full {
1142 my ($linenr, $remain, $off) = @_;
1143 my ($statement, $condition, $level);
1145 my (@chunks);
1147 # Grab the first conditional/block pair.
1148 ($statement, $condition, $linenr, $remain, $off, $level) =
1149 ctx_statement_block($linenr, $remain, $off);
1150 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1151 push(@chunks, [ $condition, $statement ]);
1152 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1153 return ($level, $linenr, @chunks);
1156 # Pull in the following conditional/block pairs and see if they
1157 # could continue the statement.
1158 for (;;) {
1159 ($statement, $condition, $linenr, $remain, $off, $level) =
1160 ctx_statement_block($linenr, $remain, $off);
1161 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1162 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1163 #print "C: push\n";
1164 push(@chunks, [ $condition, $statement ]);
1167 return ($level, $linenr, @chunks);
1170 sub ctx_block_get {
1171 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1172 my $line;
1173 my $start = $linenr - 1;
1174 my $blk = '';
1175 my @o;
1176 my @c;
1177 my @res = ();
1179 my $level = 0;
1180 my @stack = ($level);
1181 for ($line = $start; $remain > 0; $line++) {
1182 next if ($rawlines[$line] =~ /^-/);
1183 $remain--;
1185 $blk .= $rawlines[$line];
1187 # Handle nested #if/#else.
1188 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1189 push(@stack, $level);
1190 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1191 $level = $stack[$#stack - 1];
1192 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1193 $level = pop(@stack);
1196 foreach my $c (split(//, $lines[$line])) {
1197 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1198 if ($off > 0) {
1199 $off--;
1200 next;
1203 if ($c eq $close && $level > 0) {
1204 $level--;
1205 last if ($level == 0);
1206 } elsif ($c eq $open) {
1207 $level++;
1211 if (!$outer || $level <= 1) {
1212 push(@res, $rawlines[$line]);
1215 last if ($level == 0);
1218 return ($level, @res);
1220 sub ctx_block_outer {
1221 my ($linenr, $remain) = @_;
1223 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1224 return @r;
1226 sub ctx_block {
1227 my ($linenr, $remain) = @_;
1229 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1230 return @r;
1232 sub ctx_statement {
1233 my ($linenr, $remain, $off) = @_;
1235 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1236 return @r;
1238 sub ctx_block_level {
1239 my ($linenr, $remain) = @_;
1241 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1243 sub ctx_statement_level {
1244 my ($linenr, $remain, $off) = @_;
1246 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1249 sub ctx_locate_comment {
1250 my ($first_line, $end_line) = @_;
1252 # Catch a comment on the end of the line itself.
1253 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1254 return $current_comment if (defined $current_comment);
1256 # Look through the context and try and figure out if there is a
1257 # comment.
1258 my $in_comment = 0;
1259 $current_comment = '';
1260 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1261 my $line = $rawlines[$linenr - 1];
1262 #warn " $line\n";
1263 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1264 $in_comment = 1;
1266 if ($line =~ m@/\*@) {
1267 $in_comment = 1;
1269 if (!$in_comment && $current_comment ne '') {
1270 $current_comment = '';
1272 $current_comment .= $line . "\n" if ($in_comment);
1273 if ($line =~ m@\*/@) {
1274 $in_comment = 0;
1278 chomp($current_comment);
1279 return($current_comment);
1281 sub ctx_has_comment {
1282 my ($first_line, $end_line) = @_;
1283 my $cmt = ctx_locate_comment($first_line, $end_line);
1285 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1286 ##print "CMMT: $cmt\n";
1288 return ($cmt ne '');
1291 sub raw_line {
1292 my ($linenr, $cnt) = @_;
1294 my $offset = $linenr - 1;
1295 $cnt++;
1297 my $line;
1298 while ($cnt) {
1299 $line = $rawlines[$offset++];
1300 next if (defined($line) && $line =~ /^-/);
1301 $cnt--;
1304 return $line;
1307 sub cat_vet {
1308 my ($vet) = @_;
1309 my ($res, $coded);
1311 $res = '';
1312 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1313 $res .= $1;
1314 if ($2 ne '') {
1315 $coded = sprintf("^%c", unpack('C', $2) + 64);
1316 $res .= $coded;
1319 $res =~ s/$/\$/;
1321 return $res;
1324 my $av_preprocessor = 0;
1325 my $av_pending;
1326 my @av_paren_type;
1327 my $av_pend_colon;
1329 sub annotate_reset {
1330 $av_preprocessor = 0;
1331 $av_pending = '_';
1332 @av_paren_type = ('E');
1333 $av_pend_colon = 'O';
1336 sub annotate_values {
1337 my ($stream, $type) = @_;
1339 my $res;
1340 my $var = '_' x length($stream);
1341 my $cur = $stream;
1343 print "$stream\n" if ($dbg_values > 1);
1345 while (length($cur)) {
1346 @av_paren_type = ('E') if ($#av_paren_type < 0);
1347 print " <" . join('', @av_paren_type) .
1348 "> <$type> <$av_pending>" if ($dbg_values > 1);
1349 if ($cur =~ /^(\s+)/o) {
1350 print "WS($1)\n" if ($dbg_values > 1);
1351 if ($1 =~ /\n/ && $av_preprocessor) {
1352 $type = pop(@av_paren_type);
1353 $av_preprocessor = 0;
1356 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1357 print "CAST($1)\n" if ($dbg_values > 1);
1358 push(@av_paren_type, $type);
1359 $type = 'c';
1361 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1362 print "DECLARE($1)\n" if ($dbg_values > 1);
1363 $type = 'T';
1365 } elsif ($cur =~ /^($Modifier)\s*/) {
1366 print "MODIFIER($1)\n" if ($dbg_values > 1);
1367 $type = 'T';
1369 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1370 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1371 $av_preprocessor = 1;
1372 push(@av_paren_type, $type);
1373 if ($2 ne '') {
1374 $av_pending = 'N';
1376 $type = 'E';
1378 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1379 print "UNDEF($1)\n" if ($dbg_values > 1);
1380 $av_preprocessor = 1;
1381 push(@av_paren_type, $type);
1383 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1384 print "PRE_START($1)\n" if ($dbg_values > 1);
1385 $av_preprocessor = 1;
1387 push(@av_paren_type, $type);
1388 push(@av_paren_type, $type);
1389 $type = 'E';
1391 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1392 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1393 $av_preprocessor = 1;
1395 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1397 $type = 'E';
1399 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1400 print "PRE_END($1)\n" if ($dbg_values > 1);
1402 $av_preprocessor = 1;
1404 # Assume all arms of the conditional end as this
1405 # one does, and continue as if the #endif was not here.
1406 pop(@av_paren_type);
1407 push(@av_paren_type, $type);
1408 $type = 'E';
1410 } elsif ($cur =~ /^(\\\n)/o) {
1411 print "PRECONT($1)\n" if ($dbg_values > 1);
1413 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1414 print "ATTR($1)\n" if ($dbg_values > 1);
1415 $av_pending = $type;
1416 $type = 'N';
1418 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1419 print "SIZEOF($1)\n" if ($dbg_values > 1);
1420 if (defined $2) {
1421 $av_pending = 'V';
1423 $type = 'N';
1425 } elsif ($cur =~ /^(if|while|for)\b/o) {
1426 print "COND($1)\n" if ($dbg_values > 1);
1427 $av_pending = 'E';
1428 $type = 'N';
1430 } elsif ($cur =~/^(case)/o) {
1431 print "CASE($1)\n" if ($dbg_values > 1);
1432 $av_pend_colon = 'C';
1433 $type = 'N';
1435 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1436 print "KEYWORD($1)\n" if ($dbg_values > 1);
1437 $type = 'N';
1439 } elsif ($cur =~ /^(\()/o) {
1440 print "PAREN('$1')\n" if ($dbg_values > 1);
1441 push(@av_paren_type, $av_pending);
1442 $av_pending = '_';
1443 $type = 'N';
1445 } elsif ($cur =~ /^(\))/o) {
1446 my $new_type = pop(@av_paren_type);
1447 if ($new_type ne '_') {
1448 $type = $new_type;
1449 print "PAREN('$1') -> $type\n"
1450 if ($dbg_values > 1);
1451 } else {
1452 print "PAREN('$1')\n" if ($dbg_values > 1);
1455 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1456 print "FUNC($1)\n" if ($dbg_values > 1);
1457 $type = 'V';
1458 $av_pending = 'V';
1460 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1461 if (defined $2 && $type eq 'C' || $type eq 'T') {
1462 $av_pend_colon = 'B';
1463 } elsif ($type eq 'E') {
1464 $av_pend_colon = 'L';
1466 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1467 $type = 'V';
1469 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1470 print "IDENT($1)\n" if ($dbg_values > 1);
1471 $type = 'V';
1473 } elsif ($cur =~ /^($Assignment)/o) {
1474 print "ASSIGN($1)\n" if ($dbg_values > 1);
1475 $type = 'N';
1477 } elsif ($cur =~/^(;|{|})/) {
1478 print "END($1)\n" if ($dbg_values > 1);
1479 $type = 'E';
1480 $av_pend_colon = 'O';
1482 } elsif ($cur =~/^(,)/) {
1483 print "COMMA($1)\n" if ($dbg_values > 1);
1484 $type = 'C';
1486 } elsif ($cur =~ /^(\?)/o) {
1487 print "QUESTION($1)\n" if ($dbg_values > 1);
1488 $type = 'N';
1490 } elsif ($cur =~ /^(:)/o) {
1491 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1493 substr($var, length($res), 1, $av_pend_colon);
1494 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1495 $type = 'E';
1496 } else {
1497 $type = 'N';
1499 $av_pend_colon = 'O';
1501 } elsif ($cur =~ /^(\[)/o) {
1502 print "CLOSE($1)\n" if ($dbg_values > 1);
1503 $type = 'N';
1505 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1506 my $variant;
1508 print "OPV($1)\n" if ($dbg_values > 1);
1509 if ($type eq 'V') {
1510 $variant = 'B';
1511 } else {
1512 $variant = 'U';
1515 substr($var, length($res), 1, $variant);
1516 $type = 'N';
1518 } elsif ($cur =~ /^($Operators)/o) {
1519 print "OP($1)\n" if ($dbg_values > 1);
1520 if ($1 ne '++' && $1 ne '--') {
1521 $type = 'N';
1524 } elsif ($cur =~ /(^.)/o) {
1525 print "C($1)\n" if ($dbg_values > 1);
1527 if (defined $1) {
1528 $cur = substr($cur, length($1));
1529 $res .= $type x length($1);
1533 return ($res, $var);
1536 sub possible {
1537 my ($possible, $line) = @_;
1538 my $notPermitted = qr{(?:
1539 ^(?:
1540 $Modifier|
1541 $Storage|
1542 $Type|
1543 DEFINE_\S+
1545 ^(?:
1546 goto|
1547 return|
1548 case|
1549 else|
1550 asm|__asm__|
1553 \#\#|
1554 )(?:\s|$)|
1555 ^(?:typedef|struct|enum)\b
1556 )}x;
1557 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1558 if ($possible !~ $notPermitted) {
1559 # Check for modifiers.
1560 $possible =~ s/\s*$Storage\s*//g;
1561 $possible =~ s/\s*$Sparse\s*//g;
1562 if ($possible =~ /^\s*$/) {
1564 } elsif ($possible =~ /\s/) {
1565 $possible =~ s/\s*$Type\s*//g;
1566 for my $modifier (split(' ', $possible)) {
1567 if ($modifier !~ $notPermitted) {
1568 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1569 push(@modifierList, $modifier);
1573 } else {
1574 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1575 push(@typeList, $possible);
1577 build_types();
1578 } else {
1579 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1583 my $prefix = '';
1585 sub show_type {
1586 my ($type) = @_;
1588 return defined $use_type{$type} if (scalar keys %use_type > 0);
1590 return !defined $ignore_type{$type};
1593 sub report {
1594 my ($level, $type, $msg) = @_;
1596 if (!show_type($type) ||
1597 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
1598 return 0;
1600 my $line;
1601 if ($show_types) {
1602 $line = "$prefix$level:$type: $msg\n";
1603 } else {
1604 $line = "$prefix$level: $msg\n";
1606 $line = (split('\n', $line))[0] . "\n" if ($terse);
1608 push(our @report, $line);
1610 return 1;
1613 sub report_dump {
1614 our @report;
1617 sub fixup_current_range {
1618 my ($lineRef, $offset, $length) = @_;
1620 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1621 my $o = $1;
1622 my $l = $2;
1623 my $no = $o + $offset;
1624 my $nl = $l + $length;
1625 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1629 sub fix_inserted_deleted_lines {
1630 my ($linesRef, $insertedRef, $deletedRef) = @_;
1632 my $range_last_linenr = 0;
1633 my $delta_offset = 0;
1635 my $old_linenr = 0;
1636 my $new_linenr = 0;
1638 my $next_insert = 0;
1639 my $next_delete = 0;
1641 my @lines = ();
1643 my $inserted = @{$insertedRef}[$next_insert++];
1644 my $deleted = @{$deletedRef}[$next_delete++];
1646 foreach my $old_line (@{$linesRef}) {
1647 my $save_line = 1;
1648 my $line = $old_line; #don't modify the array
1649 if ($line =~ /^(?:\+\+\+\|\-\-\-)\s+\S+/) { #new filename
1650 $delta_offset = 0;
1651 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1652 $range_last_linenr = $new_linenr;
1653 fixup_current_range(\$line, $delta_offset, 0);
1656 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1657 $deleted = @{$deletedRef}[$next_delete++];
1658 $save_line = 0;
1659 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1662 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1663 push(@lines, ${$inserted}{'LINE'});
1664 $inserted = @{$insertedRef}[$next_insert++];
1665 $new_linenr++;
1666 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1669 if ($save_line) {
1670 push(@lines, $line);
1671 $new_linenr++;
1674 $old_linenr++;
1677 return @lines;
1680 sub fix_insert_line {
1681 my ($linenr, $line) = @_;
1683 my $inserted = {
1684 LINENR => $linenr,
1685 LINE => $line,
1687 push(@fixed_inserted, $inserted);
1690 sub fix_delete_line {
1691 my ($linenr, $line) = @_;
1693 my $deleted = {
1694 LINENR => $linenr,
1695 LINE => $line,
1698 push(@fixed_deleted, $deleted);
1701 sub ERROR {
1702 my ($type, $msg) = @_;
1704 if (report("ERROR", $type, $msg)) {
1705 our $clean = 0;
1706 our $cnt_error++;
1707 return 1;
1709 return 0;
1711 sub WARN {
1712 my ($type, $msg) = @_;
1714 if (report("WARNING", $type, $msg)) {
1715 our $clean = 0;
1716 our $cnt_warn++;
1717 return 1;
1719 return 0;
1721 sub CHK {
1722 my ($type, $msg) = @_;
1724 if ($check && report("CHECK", $type, $msg)) {
1725 our $clean = 0;
1726 our $cnt_chk++;
1727 return 1;
1729 return 0;
1732 sub check_absolute_file {
1733 my ($absolute, $herecurr) = @_;
1734 my $file = $absolute;
1736 ##print "absolute<$absolute>\n";
1738 # See if any suffix of this path is a path within the tree.
1739 while ($file =~ s@^[^/]*/@@) {
1740 if (-f "$root/$file") {
1741 ##print "file<$file>\n";
1742 last;
1745 if (! -f _) {
1746 return 0;
1749 # It is, so see if the prefix is acceptable.
1750 my $prefix = $absolute;
1751 substr($prefix, -length($file)) = '';
1753 ##print "prefix<$prefix>\n";
1754 if ($prefix ne ".../") {
1755 WARN("USE_RELATIVE_PATH",
1756 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1760 sub trim {
1761 my ($string) = @_;
1763 $string =~ s/^\s+|\s+$//g;
1765 return $string;
1768 sub ltrim {
1769 my ($string) = @_;
1771 $string =~ s/^\s+//;
1773 return $string;
1776 sub rtrim {
1777 my ($string) = @_;
1779 $string =~ s/\s+$//;
1781 return $string;
1784 sub string_find_replace {
1785 my ($string, $find, $replace) = @_;
1787 $string =~ s/$find/$replace/g;
1789 return $string;
1792 sub tabify {
1793 my ($leading) = @_;
1795 my $source_indent = 8;
1796 my $max_spaces_before_tab = $source_indent - 1;
1797 my $spaces_to_tab = " " x $source_indent;
1799 #convert leading spaces to tabs
1800 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1801 #Remove spaces before a tab
1802 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1804 return "$leading";
1807 sub pos_last_openparen {
1808 my ($line) = @_;
1810 my $pos = 0;
1812 my $opens = $line =~ tr/\(/\(/;
1813 my $closes = $line =~ tr/\)/\)/;
1815 my $last_openparen = 0;
1817 if (($opens == 0) || ($closes >= $opens)) {
1818 return -1;
1821 my $len = length($line);
1823 for ($pos = 0; $pos < $len; $pos++) {
1824 my $string = substr($line, $pos);
1825 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1826 $pos += length($1) - 1;
1827 } elsif (substr($line, $pos, 1) eq '(') {
1828 $last_openparen = $pos;
1829 } elsif (index($string, '(') == -1) {
1830 last;
1834 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
1837 sub process {
1838 my $filename = shift;
1840 my $linenr=0;
1841 my $prevline="";
1842 my $prevrawline="";
1843 my $stashline="";
1844 my $stashrawline="";
1846 my $length;
1847 my $indent;
1848 my $previndent=0;
1849 my $stashindent=0;
1851 our $clean = 1;
1852 my $signoff = 0;
1853 my $is_patch = 0;
1855 my $in_header_lines = $file ? 0 : 1;
1856 my $in_commit_log = 0; #Scanning lines before patch
1857 my $reported_maintainer_file = 0;
1858 my $non_utf8_charset = 0;
1860 my $last_blank_line = 0;
1861 my $last_coalesced_string_linenr = -1;
1863 our @report = ();
1864 our $cnt_lines = 0;
1865 our $cnt_error = 0;
1866 our $cnt_warn = 0;
1867 our $cnt_chk = 0;
1869 # Trace the real file/line as we go.
1870 my $realfile = '';
1871 my $realline = 0;
1872 my $realcnt = 0;
1873 my $here = '';
1874 my $in_comment = 0;
1875 my $comment_edge = 0;
1876 my $first_line = 0;
1877 my $p1_prefix = '';
1879 my $prev_values = 'E';
1881 # suppression flags
1882 my %suppress_ifbraces;
1883 my %suppress_whiletrailers;
1884 my %suppress_export;
1885 my $suppress_statement = 0;
1887 my %signatures = ();
1889 # Pre-scan the patch sanitizing the lines.
1890 # Pre-scan the patch looking for any __setup documentation.
1892 my @setup_docs = ();
1893 my $setup_docs = 0;
1895 my $camelcase_file_seeded = 0;
1897 sanitise_line_reset();
1898 my $line;
1899 foreach my $rawline (@rawlines) {
1900 $linenr++;
1901 $line = $rawline;
1903 push(@fixed, $rawline) if ($fix);
1905 if ($rawline=~/^\+\+\+\s+(\S+)/) {
1906 $setup_docs = 0;
1907 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1908 $setup_docs = 1;
1910 #next;
1912 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1913 $realline=$1-1;
1914 if (defined $2) {
1915 $realcnt=$3+1;
1916 } else {
1917 $realcnt=1+1;
1919 $in_comment = 0;
1921 # Guestimate if this is a continuing comment. Run
1922 # the context looking for a comment "edge". If this
1923 # edge is a close comment then we must be in a comment
1924 # at context start.
1925 my $edge;
1926 my $cnt = $realcnt;
1927 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1928 next if (defined $rawlines[$ln - 1] &&
1929 $rawlines[$ln - 1] =~ /^-/);
1930 $cnt--;
1931 #print "RAW<$rawlines[$ln - 1]>\n";
1932 last if (!defined $rawlines[$ln - 1]);
1933 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1934 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1935 ($edge) = $1;
1936 last;
1939 if (defined $edge && $edge eq '*/') {
1940 $in_comment = 1;
1943 # Guestimate if this is a continuing comment. If this
1944 # is the start of a diff block and this line starts
1945 # ' *' then it is very likely a comment.
1946 if (!defined $edge &&
1947 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1949 $in_comment = 1;
1952 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1953 sanitise_line_reset($in_comment);
1955 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1956 # Standardise the strings and chars within the input to
1957 # simplify matching -- only bother with positive lines.
1958 $line = sanitise_line($rawline);
1960 push(@lines, $line);
1962 if ($realcnt > 1) {
1963 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1964 } else {
1965 $realcnt = 0;
1968 #print "==>$rawline\n";
1969 #print "-->$line\n";
1971 if ($setup_docs && $line =~ /^\+/) {
1972 push(@setup_docs, $line);
1976 $prefix = '';
1978 $realcnt = 0;
1979 $linenr = 0;
1980 $fixlinenr = -1;
1981 foreach my $line (@lines) {
1982 $linenr++;
1983 $fixlinenr++;
1984 my $sline = $line; #copy of $line
1985 $sline =~ s/$;/ /g; #with comments as spaces
1987 my $rawline = $rawlines[$linenr - 1];
1989 #extract the line range in the file after the patch is applied
1990 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1991 $is_patch = 1;
1992 $first_line = $linenr + 1;
1993 $realline=$1-1;
1994 if (defined $2) {
1995 $realcnt=$3+1;
1996 } else {
1997 $realcnt=1+1;
1999 annotate_reset();
2000 $prev_values = 'E';
2002 %suppress_ifbraces = ();
2003 %suppress_whiletrailers = ();
2004 %suppress_export = ();
2005 $suppress_statement = 0;
2006 next;
2008 # track the line number as we move through the hunk, note that
2009 # new versions of GNU diff omit the leading space on completely
2010 # blank context lines so we need to count that too.
2011 } elsif ($line =~ /^( |\+|$)/) {
2012 $realline++;
2013 $realcnt-- if ($realcnt != 0);
2015 # Measure the line length and indent.
2016 ($length, $indent) = line_stats($rawline);
2018 # Track the previous line.
2019 ($prevline, $stashline) = ($stashline, $line);
2020 ($previndent, $stashindent) = ($stashindent, $indent);
2021 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2023 #warn "line<$line>\n";
2025 } elsif ($realcnt == 1) {
2026 $realcnt--;
2029 my $hunk_line = ($realcnt != 0);
2031 #make up the handle for any error we report on this line
2032 $prefix = "$filename:$realline: " if ($emacs && $file);
2033 $prefix = "$filename:$linenr: " if ($emacs && !$file);
2035 $here = "#$linenr: " if (!$file);
2036 $here = "#$realline: " if ($file);
2038 my $found_file = 0;
2039 # extract the filename as it passes
2040 if ($line =~ /^diff --git.*?(\S+)$/) {
2041 $realfile = $1;
2042 $realfile =~ s@^([^/]*)/@@ if (!$file);
2043 $in_commit_log = 0;
2044 $found_file = 1;
2045 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2046 $realfile = $1;
2047 $realfile =~ s@^([^/]*)/@@ if (!$file);
2048 $in_commit_log = 0;
2050 $p1_prefix = $1;
2051 if (!$file && $tree && $p1_prefix ne '' &&
2052 -e "$root/$p1_prefix") {
2053 WARN("PATCH_PREFIX",
2054 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
2057 if ($realfile =~ m@^include/asm/@) {
2058 ERROR("MODIFIED_INCLUDE_ASM",
2059 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2061 $found_file = 1;
2064 if ($found_file) {
2065 if ($realfile =~ m@^(drivers/net/|net/)@) {
2066 $check = 1;
2067 } else {
2068 $check = $check_orig;
2070 next;
2073 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
2075 my $hereline = "$here\n$rawline\n";
2076 my $herecurr = "$here\n$rawline\n";
2077 my $hereprev = "$here\n$prevrawline\n$rawline\n";
2079 $cnt_lines++ if ($realcnt != 0);
2081 # Check for incorrect file permissions
2082 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2083 my $permhere = $here . "FILE: $realfile\n";
2084 if ($realfile !~ m@scripts/@ &&
2085 $realfile !~ /\.(py|pl|awk|sh)$/) {
2086 ERROR("EXECUTE_PERMISSIONS",
2087 "do not set execute permissions for source files\n" . $permhere);
2091 # Check the patch for a signoff:
2092 if ($line =~ /^\s*signed-off-by:/i) {
2093 $signoff++;
2094 $in_commit_log = 0;
2097 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2098 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2099 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2100 $reported_maintainer_file = 1;
2103 # Check signature styles
2104 if (!$in_header_lines &&
2105 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
2106 my $space_before = $1;
2107 my $sign_off = $2;
2108 my $space_after = $3;
2109 my $email = $4;
2110 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2112 if ($sign_off !~ /$signature_tags/) {
2113 WARN("BAD_SIGN_OFF",
2114 "Non-standard signature: $sign_off\n" . $herecurr);
2116 if (defined $space_before && $space_before ne "") {
2117 if (WARN("BAD_SIGN_OFF",
2118 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2119 $fix) {
2120 $fixed[$fixlinenr] =
2121 "$ucfirst_sign_off $email";
2124 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
2125 if (WARN("BAD_SIGN_OFF",
2126 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2127 $fix) {
2128 $fixed[$fixlinenr] =
2129 "$ucfirst_sign_off $email";
2133 if (!defined $space_after || $space_after ne " ") {
2134 if (WARN("BAD_SIGN_OFF",
2135 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2136 $fix) {
2137 $fixed[$fixlinenr] =
2138 "$ucfirst_sign_off $email";
2142 my ($email_name, $email_address, $comment) = parse_email($email);
2143 my $suggested_email = format_email(($email_name, $email_address));
2144 if ($suggested_email eq "") {
2145 ERROR("BAD_SIGN_OFF",
2146 "Unrecognized email address: '$email'\n" . $herecurr);
2147 } else {
2148 my $dequoted = $suggested_email;
2149 $dequoted =~ s/^"//;
2150 $dequoted =~ s/" </ </;
2151 # Don't force email to have quotes
2152 # Allow just an angle bracketed address
2153 if ("$dequoted$comment" ne $email &&
2154 "<$email_address>$comment" ne $email &&
2155 "$suggested_email$comment" ne $email) {
2156 WARN("BAD_SIGN_OFF",
2157 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
2161 # Check for duplicate signatures
2162 my $sig_nospace = $line;
2163 $sig_nospace =~ s/\s//g;
2164 $sig_nospace = lc($sig_nospace);
2165 if (defined $signatures{$sig_nospace}) {
2166 WARN("BAD_SIGN_OFF",
2167 "Duplicate signature\n" . $herecurr);
2168 } else {
2169 $signatures{$sig_nospace} = 1;
2173 # Check email subject for common tools that don't need to be mentioned
2174 if ($in_header_lines &&
2175 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2176 WARN("EMAIL_SUBJECT",
2177 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2180 # Check for old stable address
2181 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2182 ERROR("STABLE_ADDRESS",
2183 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2186 # Check for unwanted Gerrit info
2187 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2188 ERROR("GERRIT_CHANGE_ID",
2189 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2192 # Check for git id commit length and improperly formed commit descriptions
2193 if ($in_commit_log && $line =~ /\b(c)ommit\s+([0-9a-f]{5,})/i) {
2194 my $init_char = $1;
2195 my $orig_commit = lc($2);
2196 my $short = 1;
2197 my $long = 0;
2198 my $case = 1;
2199 my $space = 1;
2200 my $hasdesc = 0;
2201 my $hasparens = 0;
2202 my $id = '0123456789ab';
2203 my $orig_desc = "commit description";
2204 my $description = "";
2206 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2207 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2208 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2209 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2210 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2211 $orig_desc = $1;
2212 $hasparens = 1;
2213 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2214 defined $rawlines[$linenr] &&
2215 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2216 $orig_desc = $1;
2217 $hasparens = 1;
2218 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2219 defined $rawlines[$linenr] &&
2220 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2221 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2222 $orig_desc = $1;
2223 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2224 $orig_desc .= " " . $1;
2225 $hasparens = 1;
2228 ($id, $description) = git_commit_info($orig_commit,
2229 $id, $orig_desc);
2231 if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) {
2232 ERROR("GIT_COMMIT_ID",
2233 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2237 # Check for added, moved or deleted files
2238 if (!$reported_maintainer_file && !$in_commit_log &&
2239 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2240 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2241 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2242 (defined($1) || defined($2))))) {
2243 $reported_maintainer_file = 1;
2244 WARN("FILE_PATH_CHANGES",
2245 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2248 # Check for wrappage within a valid hunk of the file
2249 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
2250 ERROR("CORRUPTED_PATCH",
2251 "patch seems to be corrupt (line wrapped?)\n" .
2252 $herecurr) if (!$emitted_corrupt++);
2255 # Check for absolute kernel paths.
2256 if ($tree) {
2257 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2258 my $file = $1;
2260 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2261 check_absolute_file($1, $herecurr)) {
2263 } else {
2264 check_absolute_file($file, $herecurr);
2269 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2270 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
2271 $rawline !~ m/^$UTF8*$/) {
2272 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2274 my $blank = copy_spacing($rawline);
2275 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2276 my $hereptr = "$hereline$ptr\n";
2278 CHK("INVALID_UTF8",
2279 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
2282 # Check if it's the start of a commit log
2283 # (not a header line and we haven't seen the patch filename)
2284 if ($in_header_lines && $realfile =~ /^$/ &&
2285 !($rawline =~ /^\s+\S/ ||
2286 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
2287 $in_header_lines = 0;
2288 $in_commit_log = 1;
2291 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2292 # declined it, i.e defined some charset where it is missing.
2293 if ($in_header_lines &&
2294 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2295 $1 !~ /utf-8/i) {
2296 $non_utf8_charset = 1;
2299 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
2300 $rawline =~ /$NON_ASCII_UTF8/) {
2301 WARN("UTF8_BEFORE_PATCH",
2302 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2305 # Check for various typo / spelling mistakes
2306 if (defined($misspellings) && ($in_commit_log || $line =~ /^\+/)) {
2307 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:$|[^a-z@])/gi) {
2308 my $typo = $1;
2309 my $typo_fix = $spelling_fix{lc($typo)};
2310 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2311 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2312 my $msg_type = \&WARN;
2313 $msg_type = \&CHK if ($file);
2314 if (&{$msg_type}("TYPO_SPELLING",
2315 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2316 $fix) {
2317 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2322 # ignore non-hunk lines and lines being removed
2323 next if (!$hunk_line || $line =~ /^-/);
2325 #trailing whitespace
2326 if ($line =~ /^\+.*\015/) {
2327 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2328 if (ERROR("DOS_LINE_ENDINGS",
2329 "DOS line endings\n" . $herevet) &&
2330 $fix) {
2331 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
2333 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2334 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2335 if (ERROR("TRAILING_WHITESPACE",
2336 "trailing whitespace\n" . $herevet) &&
2337 $fix) {
2338 $fixed[$fixlinenr] =~ s/\s+$//;
2341 $rpt_cleaners = 1;
2344 # Check for FSF mailing addresses.
2345 if ($rawline =~ /\bwrite to the Free/i ||
2346 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2347 $rawline =~ /\b51\s+Franklin\s+St/i) {
2348 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2349 my $msg_type = \&ERROR;
2350 $msg_type = \&CHK if ($file);
2351 &{$msg_type}("FSF_MAILING_ADDRESS",
2352 "Do not include the paragraph about writing to the Free Software Foundation's mailing address from the sample GPL notice. The FSF has changed addresses in the past, and may do so again. Linux already includes a copy of the GPL.\n" . $herevet)
2355 # check for Kconfig help text having a real description
2356 # Only applies when adding the entry originally, after that we do not have
2357 # sufficient context to determine whether it is indeed long enough.
2358 if ($realfile =~ /Kconfig/ &&
2359 $line =~ /^\+\s*config\s+/) {
2360 my $length = 0;
2361 my $cnt = $realcnt;
2362 my $ln = $linenr + 1;
2363 my $f;
2364 my $is_start = 0;
2365 my $is_end = 0;
2366 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
2367 $f = $lines[$ln - 1];
2368 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2369 $is_end = $lines[$ln - 1] =~ /^\+/;
2371 next if ($f =~ /^-/);
2372 last if (!$file && $f =~ /^\@\@/);
2374 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
2375 $is_start = 1;
2376 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
2377 $length = -1;
2380 $f =~ s/^.//;
2381 $f =~ s/#.*//;
2382 $f =~ s/^\s+//;
2383 next if ($f =~ /^$/);
2384 if ($f =~ /^\s*config\s/) {
2385 $is_end = 1;
2386 last;
2388 $length++;
2390 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2391 WARN("CONFIG_DESCRIPTION",
2392 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2394 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2397 # discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2398 if ($realfile =~ /Kconfig/ &&
2399 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2400 WARN("CONFIG_EXPERIMENTAL",
2401 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2404 # discourage the use of boolean for type definition attributes of Kconfig options
2405 if ($realfile =~ /Kconfig/ &&
2406 $line =~ /^\+\s*\bboolean\b/) {
2407 WARN("CONFIG_TYPE_BOOLEAN",
2408 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2411 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2412 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2413 my $flag = $1;
2414 my $replacement = {
2415 'EXTRA_AFLAGS' => 'asflags-y',
2416 'EXTRA_CFLAGS' => 'ccflags-y',
2417 'EXTRA_CPPFLAGS' => 'cppflags-y',
2418 'EXTRA_LDFLAGS' => 'ldflags-y',
2421 WARN("DEPRECATED_VARIABLE",
2422 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2425 # check for DT compatible documentation
2426 if (defined $root &&
2427 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2428 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2430 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2432 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2433 my $vp_file = $dt_path . "vendor-prefixes.txt";
2435 foreach my $compat (@compats) {
2436 my $compat2 = $compat;
2437 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2438 my $compat3 = $compat;
2439 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2440 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
2441 if ( $? >> 8 ) {
2442 WARN("UNDOCUMENTED_DT_STRING",
2443 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2446 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2447 my $vendor = $1;
2448 `grep -Eq "^$vendor\\b" $vp_file`;
2449 if ( $? >> 8 ) {
2450 WARN("UNDOCUMENTED_DT_STRING",
2451 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2456 # check we are in a valid source file if not then ignore this hunk
2457 next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/);
2459 #line length limit
2460 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
2461 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
2462 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
2463 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
2464 $length > $max_line_length)
2466 WARN("LONG_LINE",
2467 "line over $max_line_length characters\n" . $herecurr);
2470 # check for adding lines without a newline.
2471 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2472 WARN("MISSING_EOF_NEWLINE",
2473 "adding a line without newline at end of file\n" . $herecurr);
2476 # Blackfin: use hi/lo macros
2477 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2478 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2479 my $herevet = "$here\n" . cat_vet($line) . "\n";
2480 ERROR("LO_MACRO",
2481 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
2483 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2484 my $herevet = "$here\n" . cat_vet($line) . "\n";
2485 ERROR("HI_MACRO",
2486 "use the HI() macro, not (... >> 16)\n" . $herevet);
2490 # check we are in a valid source file C or perl if not then ignore this hunk
2491 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
2493 # at the beginning of a line any tabs must come first and anything
2494 # more than 8 must use tabs.
2495 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2496 $rawline =~ /^\+\s* \s*/) {
2497 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2498 $rpt_cleaners = 1;
2499 if (ERROR("CODE_INDENT",
2500 "code indent should use tabs where possible\n" . $herevet) &&
2501 $fix) {
2502 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2506 # check for space before tabs.
2507 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2508 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2509 if (WARN("SPACE_BEFORE_TAB",
2510 "please, no space before tabs\n" . $herevet) &&
2511 $fix) {
2512 while ($fixed[$fixlinenr] =~
2513 s/(^\+.*) {8,8}\t/$1\t\t/) {}
2514 while ($fixed[$fixlinenr] =~
2515 s/(^\+.*) +\t/$1\t/) {}
2519 # check for && or || at the start of a line
2520 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2521 CHK("LOGICAL_CONTINUATIONS",
2522 "Logical continuations should be on the previous line\n" . $hereprev);
2525 # check multi-line statement indentation matches previous line
2526 if ($^V && $^V ge 5.10.0 &&
2527 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2528 $prevline =~ /^\+(\t*)(.*)$/;
2529 my $oldindent = $1;
2530 my $rest = $2;
2532 my $pos = pos_last_openparen($rest);
2533 if ($pos >= 0) {
2534 $line =~ /^(\+| )([ \t]*)/;
2535 my $newindent = $2;
2537 my $goodtabindent = $oldindent .
2538 "\t" x ($pos / 8) .
2539 " " x ($pos % 8);
2540 my $goodspaceindent = $oldindent . " " x $pos;
2542 if ($newindent ne $goodtabindent &&
2543 $newindent ne $goodspaceindent) {
2545 if (CHK("PARENTHESIS_ALIGNMENT",
2546 "Alignment should match open parenthesis\n" . $hereprev) &&
2547 $fix && $line =~ /^\+/) {
2548 $fixed[$fixlinenr] =~
2549 s/^\+[ \t]*/\+$goodtabindent/;
2555 if ($line =~ /^\+.*(\w+\s*)?\(\s*$Type\s*\)[ \t]+(?!$Assignment|$Arithmetic|[,;:\?\(\{\}\[\<\>]|&&|\|\||\\$)/ &&
2556 (!defined($1) || $1 !~ /sizeof\s*/)) {
2557 if (CHK("SPACING",
2558 "No space is necessary after a cast\n" . $herecurr) &&
2559 $fix) {
2560 $fixed[$fixlinenr] =~
2561 s/(\(\s*$Type\s*\))[ \t]+/$1/;
2565 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2566 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
2567 $rawline =~ /^\+[ \t]*\*/ &&
2568 $realline > 2) {
2569 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2570 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2573 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2574 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2575 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
2576 $rawline =~ /^\+/ && #line is new
2577 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2578 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2579 "networking block comments start with * on subsequent lines\n" . $hereprev);
2582 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2583 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2584 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2585 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2586 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
2587 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2588 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2591 # check for missing blank lines after struct/union declarations
2592 # with exceptions for various attributes and macros
2593 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2594 $line =~ /^\+/ &&
2595 !($line =~ /^\+\s*$/ ||
2596 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2597 $line =~ /^\+\s*MODULE_/i ||
2598 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2599 $line =~ /^\+[a-z_]*init/ ||
2600 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2601 $line =~ /^\+\s*DECLARE/ ||
2602 $line =~ /^\+\s*__setup/)) {
2603 if (CHK("LINE_SPACING",
2604 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
2605 $fix) {
2606 fix_insert_line($fixlinenr, "\+");
2610 # check for multiple consecutive blank lines
2611 if ($prevline =~ /^[\+ ]\s*$/ &&
2612 $line =~ /^\+\s*$/ &&
2613 $last_blank_line != ($linenr - 1)) {
2614 if (CHK("LINE_SPACING",
2615 "Please don't use multiple blank lines\n" . $hereprev) &&
2616 $fix) {
2617 fix_delete_line($fixlinenr, $rawline);
2620 $last_blank_line = $linenr;
2623 # check for missing blank lines after declarations
2624 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2625 # actual declarations
2626 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2627 # function pointer declarations
2628 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2629 # foo bar; where foo is some local typedef or #define
2630 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2631 # known declaration macros
2632 $prevline =~ /^\+\s+$declaration_macros/) &&
2633 # for "else if" which can look like "$Ident $Ident"
2634 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2635 # other possible extensions of declaration lines
2636 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2637 # not starting a section or a macro "\" extended line
2638 $prevline =~ /(?:\{\s*|\\)$/) &&
2639 # looks like a declaration
2640 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2641 # function pointer declarations
2642 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2643 # foo bar; where foo is some local typedef or #define
2644 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2645 # known declaration macros
2646 $sline =~ /^\+\s+$declaration_macros/ ||
2647 # start of struct or union or enum
2648 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
2649 # start or end of block or continuation of declaration
2650 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
2651 # bitfield continuation
2652 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
2653 # other possible extensions of declaration lines
2654 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
2655 # indentation of previous and current line are the same
2656 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
2657 if (WARN("LINE_SPACING",
2658 "Missing a blank line after declarations\n" . $hereprev) &&
2659 $fix) {
2660 fix_insert_line($fixlinenr, "\+");
2664 # check for spaces at the beginning of a line.
2665 # Exceptions:
2666 # 1) within comments
2667 # 2) indented preprocessor commands
2668 # 3) hanging labels
2669 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
2670 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2671 if (WARN("LEADING_SPACE",
2672 "please, no spaces at the start of a line\n" . $herevet) &&
2673 $fix) {
2674 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2678 # check we are in a valid C source file if not then ignore this hunk
2679 next if ($realfile !~ /\.(h|c)$/);
2681 # check indentation of any line with a bare else
2682 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
2683 # if the previous line is a break or return and is indented 1 tab more...
2684 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
2685 my $tabs = length($1) + 1;
2686 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
2687 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
2688 defined $lines[$linenr] &&
2689 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
2690 WARN("UNNECESSARY_ELSE",
2691 "else is not generally useful after a break or return\n" . $hereprev);
2695 # check indentation of a line with a break;
2696 # if the previous line is a goto or return and is indented the same # of tabs
2697 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
2698 my $tabs = $1;
2699 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
2700 WARN("UNNECESSARY_BREAK",
2701 "break is not useful after a goto or return\n" . $hereprev);
2705 # discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2706 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2707 WARN("CONFIG_EXPERIMENTAL",
2708 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2711 # check for RCS/CVS revision markers
2712 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
2713 WARN("CVS_KEYWORD",
2714 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
2717 # Blackfin: don't use __builtin_bfin_[cs]sync
2718 if ($line =~ /__builtin_bfin_csync/) {
2719 my $herevet = "$here\n" . cat_vet($line) . "\n";
2720 ERROR("CSYNC",
2721 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
2723 if ($line =~ /__builtin_bfin_ssync/) {
2724 my $herevet = "$here\n" . cat_vet($line) . "\n";
2725 ERROR("SSYNC",
2726 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
2729 # check for old HOTPLUG __dev<foo> section markings
2730 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2731 WARN("HOTPLUG_SECTION",
2732 "Using $1 is unnecessary\n" . $herecurr);
2735 # Check for potential 'bare' types
2736 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2737 $realline_next);
2738 #print "LINE<$line>\n";
2739 if ($linenr >= $suppress_statement &&
2740 $realcnt && $sline =~ /.\s*\S/) {
2741 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2742 ctx_statement_block($linenr, $realcnt, 0);
2743 $stat =~ s/\n./\n /g;
2744 $cond =~ s/\n./\n /g;
2746 #print "linenr<$linenr> <$stat>\n";
2747 # If this statement has no statement boundaries within
2748 # it there is no point in retrying a statement scan
2749 # until we hit end of it.
2750 my $frag = $stat; $frag =~ s/;+\s*$//;
2751 if ($frag !~ /(?:{|;)/) {
2752 #print "skip<$line_nr_next>\n";
2753 $suppress_statement = $line_nr_next;
2756 # Find the real next line.
2757 $realline_next = $line_nr_next;
2758 if (defined $realline_next &&
2759 (!defined $lines[$realline_next - 1] ||
2760 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2761 $realline_next++;
2764 my $s = $stat;
2765 $s =~ s/{.*$//s;
2767 # Ignore goto labels.
2768 if ($s =~ /$Ident:\*$/s) {
2770 # Ignore functions being called
2771 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
2773 } elsif ($s =~ /^.\s*else\b/s) {
2775 # declarations always start with types
2776 } 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) {
2777 my $type = $1;
2778 $type =~ s/\s+/ /g;
2779 possible($type, "A:" . $s);
2781 # definitions in global scope can only start with types
2782 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
2783 possible($1, "B:" . $s);
2786 # any (foo ... *) is a pointer cast, and foo is a type
2787 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
2788 possible($1, "C:" . $s);
2791 # Check for any sort of function declaration.
2792 # int foo(something bar, other baz);
2793 # void (*store_gdt)(x86_descr_ptr *);
2794 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
2795 my ($name_len) = length($1);
2797 my $ctx = $s;
2798 substr($ctx, 0, $name_len + 1, '');
2799 $ctx =~ s/\)[^\)]*$//;
2801 for my $arg (split(/\s*,\s*/, $ctx)) {
2802 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
2804 possible($1, "D:" . $s);
2812 # Checks which may be anchored in the context.
2815 # Check for switch () and associated case and default
2816 # statements should be at the same indent.
2817 if ($line=~/\bswitch\s*\(.*\)/) {
2818 my $err = '';
2819 my $sep = '';
2820 my @ctx = ctx_block_outer($linenr, $realcnt);
2821 shift(@ctx);
2822 for my $ctx (@ctx) {
2823 my ($clen, $cindent) = line_stats($ctx);
2824 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2825 $indent != $cindent) {
2826 $err .= "$sep$ctx\n";
2827 $sep = '';
2828 } else {
2829 $sep = "[...]\n";
2832 if ($err ne '') {
2833 ERROR("SWITCH_CASE_INDENT_LEVEL",
2834 "switch and case should be at the same indent\n$hereline$err");
2838 # if/while/etc brace do not go on next line, unless defining a do while loop,
2839 # or if that brace on the next line is for something else
2840 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
2841 my $pre_ctx = "$1$2";
2843 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
2845 if ($line =~ /^\+\t{6,}/) {
2846 WARN("DEEP_INDENTATION",
2847 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2850 my $ctx_cnt = $realcnt - $#ctx - 1;
2851 my $ctx = join("\n", @ctx);
2853 my $ctx_ln = $linenr;
2854 my $ctx_skip = $realcnt;
2856 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2857 defined $lines[$ctx_ln - 1] &&
2858 $lines[$ctx_ln - 1] =~ /^-/)) {
2859 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2860 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
2861 $ctx_ln++;
2864 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2865 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
2867 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
2868 ERROR("OPEN_BRACE",
2869 "that open brace { should be on the previous line\n" .
2870 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2872 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2873 $ctx =~ /\)\s*\;\s*$/ &&
2874 defined $lines[$ctx_ln - 1])
2876 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2877 if ($nindent > $indent) {
2878 WARN("TRAILING_SEMICOLON",
2879 "trailing semicolon indicates no statements, indent implies otherwise\n" .
2880 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2885 # Check relative indent for conditionals and blocks.
2886 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2887 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2888 ctx_statement_block($linenr, $realcnt, 0)
2889 if (!defined $stat);
2890 my ($s, $c) = ($stat, $cond);
2892 substr($s, 0, length($c), '');
2894 # Make sure we remove the line prefixes as we have
2895 # none on the first line, and are going to readd them
2896 # where necessary.
2897 $s =~ s/\n./\n/gs;
2899 # Find out how long the conditional actually is.
2900 my @newlines = ($c =~ /\n/gs);
2901 my $cond_lines = 1 + $#newlines;
2903 # We want to check the first line inside the block
2904 # starting at the end of the conditional, so remove:
2905 # 1) any blank line termination
2906 # 2) any opening brace { on end of the line
2907 # 3) any do (...) {
2908 my $continuation = 0;
2909 my $check = 0;
2910 $s =~ s/^.*\bdo\b//;
2911 $s =~ s/^\s*{//;
2912 if ($s =~ s/^\s*\\//) {
2913 $continuation = 1;
2915 if ($s =~ s/^\s*?\n//) {
2916 $check = 1;
2917 $cond_lines++;
2920 # Also ignore a loop construct at the end of a
2921 # preprocessor statement.
2922 if (($prevline =~ /^.\s*#\s*define\s/ ||
2923 $prevline =~ /\\\s*$/) && $continuation == 0) {
2924 $check = 0;
2927 my $cond_ptr = -1;
2928 $continuation = 0;
2929 while ($cond_ptr != $cond_lines) {
2930 $cond_ptr = $cond_lines;
2932 # If we see an #else/#elif then the code
2933 # is not linear.
2934 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2935 $check = 0;
2938 # Ignore:
2939 # 1) blank lines, they should be at 0,
2940 # 2) preprocessor lines, and
2941 # 3) labels.
2942 if ($continuation ||
2943 $s =~ /^\s*?\n/ ||
2944 $s =~ /^\s*#\s*?/ ||
2945 $s =~ /^\s*$Ident\s*:/) {
2946 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
2947 if ($s =~ s/^.*?\n//) {
2948 $cond_lines++;
2953 my (undef, $sindent) = line_stats("+" . $s);
2954 my $stat_real = raw_line($linenr, $cond_lines);
2956 # Check if either of these lines are modified, else
2957 # this is not this patch's fault.
2958 if (!defined($stat_real) ||
2959 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2960 $check = 0;
2962 if (defined($stat_real) && $cond_lines > 1) {
2963 $stat_real = "[...]\n$stat_real";
2966 #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";
2968 if ($check && (($sindent % 8) != 0 ||
2969 ($sindent <= $indent && $s ne ''))) {
2970 WARN("SUSPECT_CODE_INDENT",
2971 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
2975 # Track the 'values' across context and added lines.
2976 my $opline = $line; $opline =~ s/^./ /;
2977 my ($curr_values, $curr_vars) =
2978 annotate_values($opline . "\n", $prev_values);
2979 $curr_values = $prev_values . $curr_values;
2980 if ($dbg_values) {
2981 my $outline = $opline; $outline =~ s/\t/ /g;
2982 print "$linenr > .$outline\n";
2983 print "$linenr > $curr_values\n";
2984 print "$linenr > $curr_vars\n";
2986 $prev_values = substr($curr_values, -1);
2988 #ignore lines not being added
2989 next if ($line =~ /^[^\+]/);
2991 # TEST: allow direct testing of the type matcher.
2992 if ($dbg_type) {
2993 if ($line =~ /^.\s*$Declare\s*$/) {
2994 ERROR("TEST_TYPE",
2995 "TEST: is type\n" . $herecurr);
2996 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
2997 ERROR("TEST_NOT_TYPE",
2998 "TEST: is not type ($1 is)\n". $herecurr);
3000 next;
3002 # TEST: allow direct testing of the attribute matcher.
3003 if ($dbg_attr) {
3004 if ($line =~ /^.\s*$Modifier\s*$/) {
3005 ERROR("TEST_ATTR",
3006 "TEST: is attr\n" . $herecurr);
3007 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
3008 ERROR("TEST_NOT_ATTR",
3009 "TEST: is not attr ($1 is)\n". $herecurr);
3011 next;
3014 # check for initialisation to aggregates open brace on the next line
3015 if ($line =~ /^.\s*{/ &&
3016 $prevline =~ /(?:^|[^=])=\s*$/) {
3017 if (ERROR("OPEN_BRACE",
3018 "that open brace { should be on the previous line\n" . $hereprev) &&
3019 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3020 fix_delete_line($fixlinenr - 1, $prevrawline);
3021 fix_delete_line($fixlinenr, $rawline);
3022 my $fixedline = $prevrawline;
3023 $fixedline =~ s/\s*=\s*$/ = {/;
3024 fix_insert_line($fixlinenr, $fixedline);
3025 $fixedline = $line;
3026 $fixedline =~ s/^(.\s*){\s*/$1/;
3027 fix_insert_line($fixlinenr, $fixedline);
3032 # Checks which are anchored on the added line.
3035 # check for malformed paths in #include statements (uses RAW line)
3036 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
3037 my $path = $1;
3038 if ($path =~ m{//}) {
3039 ERROR("MALFORMED_INCLUDE",
3040 "malformed #include filename\n" . $herecurr);
3042 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3043 ERROR("UAPI_INCLUDE",
3044 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
3048 # no C99 // comments
3049 if ($line =~ m{//}) {
3050 if (ERROR("C99_COMMENTS",
3051 "do not use C99 // comments\n" . $herecurr) &&
3052 $fix) {
3053 my $line = $fixed[$fixlinenr];
3054 if ($line =~ /\/\/(.*)$/) {
3055 my $comment = trim($1);
3056 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
3060 # Remove C99 comments.
3061 $line =~ s@//.*@@;
3062 $opline =~ s@//.*@@;
3064 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3065 # the whole statement.
3066 #print "APW <$lines[$realline_next - 1]>\n";
3067 if (defined $realline_next &&
3068 exists $lines[$realline_next - 1] &&
3069 !defined $suppress_export{$realline_next} &&
3070 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3071 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3072 # Handle definitions which produce identifiers with
3073 # a prefix:
3074 # XXX(foo);
3075 # EXPORT_SYMBOL(something_foo);
3076 my $name = $1;
3077 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
3078 $name =~ /^${Ident}_$2/) {
3079 #print "FOO C name<$name>\n";
3080 $suppress_export{$realline_next} = 1;
3082 } elsif ($stat !~ /(?:
3083 \n.}\s*$|
3084 ^.DEFINE_$Ident\(\Q$name\E\)|
3085 ^.DECLARE_$Ident\(\Q$name\E\)|
3086 ^.LIST_HEAD\(\Q$name\E\)|
3087 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3088 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
3089 )/x) {
3090 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3091 $suppress_export{$realline_next} = 2;
3092 } else {
3093 $suppress_export{$realline_next} = 1;
3096 if (!defined $suppress_export{$linenr} &&
3097 $prevline =~ /^.\s*$/ &&
3098 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3099 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3100 #print "FOO B <$lines[$linenr - 1]>\n";
3101 $suppress_export{$linenr} = 2;
3103 if (defined $suppress_export{$linenr} &&
3104 $suppress_export{$linenr} == 2) {
3105 WARN("EXPORT_SYMBOL",
3106 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
3109 # check for global initialisers.
3110 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
3111 if (ERROR("GLOBAL_INITIALISERS",
3112 "do not initialise globals to 0 or NULL\n" .
3113 $herecurr) &&
3114 $fix) {
3115 $fixed[$fixlinenr] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
3118 # check for static initialisers.
3119 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
3120 if (ERROR("INITIALISED_STATIC",
3121 "do not initialise statics to 0 or NULL\n" .
3122 $herecurr) &&
3123 $fix) {
3124 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
3128 # check for misordered declarations of char/short/int/long with signed/unsigned
3129 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3130 my $tmp = trim($1);
3131 WARN("MISORDERED_TYPE",
3132 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3135 # check for static const char * arrays.
3136 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
3137 WARN("STATIC_CONST_CHAR_ARRAY",
3138 "static const char * array should probably be static const char * const\n" .
3139 $herecurr);
3142 # check for static char foo[] = "bar" declarations.
3143 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
3144 WARN("STATIC_CONST_CHAR_ARRAY",
3145 "static char array declaration should probably be static const char\n" .
3146 $herecurr);
3149 # check for non-global char *foo[] = {"bar", ...} declarations.
3150 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3151 WARN("STATIC_CONST_CHAR_ARRAY",
3152 "char * array declaration might be better as static const\n" .
3153 $herecurr);
3156 # check for function declarations without arguments like "int foo()"
3157 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3158 if (ERROR("FUNCTION_WITHOUT_ARGS",
3159 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3160 $fix) {
3161 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
3165 # check for uses of DEFINE_PCI_DEVICE_TABLE
3166 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
3167 if (WARN("DEFINE_PCI_DEVICE_TABLE",
3168 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
3169 $fix) {
3170 $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
3174 # check for new typedefs, only function parameters and sparse annotations
3175 # make sense.
3176 if ($line =~ /\btypedef\s/ &&
3177 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
3178 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
3179 $line !~ /\b$typeTypedefs\b/ &&
3180 $line !~ /\b$typeOtherOSTypedefs\b/ &&
3181 $line !~ /\b__bitwise(?:__|)\b/) {
3182 WARN("NEW_TYPEDEFS",
3183 "do not add new typedefs\n" . $herecurr);
3186 # * goes on variable not on type
3187 # (char*[ const])
3188 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3189 #print "AA<$1>\n";
3190 my ($ident, $from, $to) = ($1, $2, $2);
3192 # Should start with a space.
3193 $to =~ s/^(\S)/ $1/;
3194 # Should not end with a space.
3195 $to =~ s/\s+$//;
3196 # '*'s should not have spaces between.
3197 while ($to =~ s/\*\s+\*/\*\*/) {
3200 ## print "1: from<$from> to<$to> ident<$ident>\n";
3201 if ($from ne $to) {
3202 if (ERROR("POINTER_LOCATION",
3203 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3204 $fix) {
3205 my $sub_from = $ident;
3206 my $sub_to = $ident;
3207 $sub_to =~ s/\Q$from\E/$to/;
3208 $fixed[$fixlinenr] =~
3209 s@\Q$sub_from\E@$sub_to@;
3213 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3214 #print "BB<$1>\n";
3215 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
3217 # Should start with a space.
3218 $to =~ s/^(\S)/ $1/;
3219 # Should not end with a space.
3220 $to =~ s/\s+$//;
3221 # '*'s should not have spaces between.
3222 while ($to =~ s/\*\s+\*/\*\*/) {
3224 # Modifiers should have spaces.
3225 $to =~ s/(\b$Modifier$)/$1 /;
3227 ## print "2: from<$from> to<$to> ident<$ident>\n";
3228 if ($from ne $to && $ident !~ /^$Modifier$/) {
3229 if (ERROR("POINTER_LOCATION",
3230 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3231 $fix) {
3233 my $sub_from = $match;
3234 my $sub_to = $match;
3235 $sub_to =~ s/\Q$from\E/$to/;
3236 $fixed[$fixlinenr] =~
3237 s@\Q$sub_from\E@$sub_to@;
3242 # # no BUG() or BUG_ON()
3243 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
3244 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
3245 # print "$herecurr";
3246 # $clean = 0;
3249 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
3250 WARN("LINUX_VERSION_CODE",
3251 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3254 # check for uses of printk_ratelimit
3255 if ($line =~ /\bprintk_ratelimit\s*\(/) {
3256 WARN("PRINTK_RATELIMITED",
3257 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
3260 # printk should use KERN_* levels. Note that follow on printk's on the
3261 # same line do not need a level, so we use the current block context
3262 # to try and find and validate the current printk. In summary the current
3263 # printk includes all preceding printk's which have no newline on the end.
3264 # we assume the first bad printk is the one to report.
3265 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
3266 my $ok = 0;
3267 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3268 #print "CHECK<$lines[$ln - 1]\n";
3269 # we have a preceding printk if it ends
3270 # with "\n" ignore it, else it is to blame
3271 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3272 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3273 $ok = 1;
3275 last;
3278 if ($ok == 0) {
3279 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3280 "printk() should include KERN_ facility level\n" . $herecurr);
3284 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3285 my $orig = $1;
3286 my $level = lc($orig);
3287 $level = "warn" if ($level eq "warning");
3288 my $level2 = $level;
3289 $level2 = "dbg" if ($level eq "debug");
3290 WARN("PREFER_PR_LEVEL",
3291 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
3294 if ($line =~ /\bpr_warning\s*\(/) {
3295 if (WARN("PREFER_PR_LEVEL",
3296 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3297 $fix) {
3298 $fixed[$fixlinenr] =~
3299 s/\bpr_warning\b/pr_warn/;
3303 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3304 my $orig = $1;
3305 my $level = lc($orig);
3306 $level = "warn" if ($level eq "warning");
3307 $level = "dbg" if ($level eq "debug");
3308 WARN("PREFER_DEV_LEVEL",
3309 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3312 # function brace can't be on same line, except for #defines of do while,
3313 # or if closed on same line
3314 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
3315 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
3316 if (ERROR("OPEN_BRACE",
3317 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3318 $fix) {
3319 fix_delete_line($fixlinenr, $rawline);
3320 my $fixed_line = $rawline;
3321 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3322 my $line1 = $1;
3323 my $line2 = $2;
3324 fix_insert_line($fixlinenr, ltrim($line1));
3325 fix_insert_line($fixlinenr, "\+{");
3326 if ($line2 !~ /^\s*$/) {
3327 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3332 # open braces for enum, union and struct go on the same line.
3333 if ($line =~ /^.\s*{/ &&
3334 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
3335 if (ERROR("OPEN_BRACE",
3336 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3337 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3338 fix_delete_line($fixlinenr - 1, $prevrawline);
3339 fix_delete_line($fixlinenr, $rawline);
3340 my $fixedline = rtrim($prevrawline) . " {";
3341 fix_insert_line($fixlinenr, $fixedline);
3342 $fixedline = $rawline;
3343 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3344 if ($fixedline !~ /^\+\s*$/) {
3345 fix_insert_line($fixlinenr, $fixedline);
3350 # missing space after union, struct or enum definition
3351 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3352 if (WARN("SPACING",
3353 "missing space after $1 definition\n" . $herecurr) &&
3354 $fix) {
3355 $fixed[$fixlinenr] =~
3356 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3360 # Function pointer declarations
3361 # check spacing between type, funcptr, and args
3362 # canonical declaration is "type (*funcptr)(args...)"
3363 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
3364 my $declare = $1;
3365 my $pre_pointer_space = $2;
3366 my $post_pointer_space = $3;
3367 my $funcname = $4;
3368 my $post_funcname_space = $5;
3369 my $pre_args_space = $6;
3371 # the $Declare variable will capture all spaces after the type
3372 # so check it for a missing trailing missing space but pointer return types
3373 # don't need a space so don't warn for those.
3374 my $post_declare_space = "";
3375 if ($declare =~ /(\s+)$/) {
3376 $post_declare_space = $1;
3377 $declare = rtrim($declare);
3379 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
3380 WARN("SPACING",
3381 "missing space after return type\n" . $herecurr);
3382 $post_declare_space = " ";
3385 # unnecessary space "type (*funcptr)(args...)"
3386 # This test is not currently implemented because these declarations are
3387 # equivalent to
3388 # int foo(int bar, ...)
3389 # and this is form shouldn't/doesn't generate a checkpatch warning.
3391 # elsif ($declare =~ /\s{2,}$/) {
3392 # WARN("SPACING",
3393 # "Multiple spaces after return type\n" . $herecurr);
3396 # unnecessary space "type ( *funcptr)(args...)"
3397 if (defined $pre_pointer_space &&
3398 $pre_pointer_space =~ /^\s/) {
3399 WARN("SPACING",
3400 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3403 # unnecessary space "type (* funcptr)(args...)"
3404 if (defined $post_pointer_space &&
3405 $post_pointer_space =~ /^\s/) {
3406 WARN("SPACING",
3407 "Unnecessary space before function pointer name\n" . $herecurr);
3410 # unnecessary space "type (*funcptr )(args...)"
3411 if (defined $post_funcname_space &&
3412 $post_funcname_space =~ /^\s/) {
3413 WARN("SPACING",
3414 "Unnecessary space after function pointer name\n" . $herecurr);
3417 # unnecessary space "type (*funcptr) (args...)"
3418 if (defined $pre_args_space &&
3419 $pre_args_space =~ /^\s/) {
3420 WARN("SPACING",
3421 "Unnecessary space before function pointer arguments\n" . $herecurr);
3424 if (show_type("SPACING") && $fix) {
3425 $fixed[$fixlinenr] =~
3426 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3430 # check for spacing round square brackets; allowed:
3431 # 1. with a type on the left -- int [] a;
3432 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3433 # 3. inside a curly brace -- = { [0...10] = 5 }
3434 while ($line =~ /(.*?\s)\[/g) {
3435 my ($where, $prefix) = ($-[1], $1);
3436 if ($prefix !~ /$Type\s+$/ &&
3437 ($where != 0 || $prefix !~ /^.\s+$/) &&
3438 $prefix !~ /[{,]\s+$/) {
3439 if (ERROR("BRACKET_SPACE",
3440 "space prohibited before open square bracket '['\n" . $herecurr) &&
3441 $fix) {
3442 $fixed[$fixlinenr] =~
3443 s/^(\+.*?)\s+\[/$1\[/;
3448 # check for spaces between functions and their parentheses.
3449 while ($line =~ /($Ident)\s+\(/g) {
3450 my $name = $1;
3451 my $ctx_before = substr($line, 0, $-[1]);
3452 my $ctx = "$ctx_before$name";
3454 # Ignore those directives where spaces _are_ permitted.
3455 if ($name =~ /^(?:
3456 if|for|while|switch|return|case|
3457 volatile|__volatile__|
3458 __attribute__|format|__extension__|
3459 asm|__asm__)$/x)
3461 # cpp #define statements have non-optional spaces, ie
3462 # if there is a space between the name and the open
3463 # parenthesis it is simply not a parameter group.
3464 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
3466 # cpp #elif statement condition may start with a (
3467 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
3469 # If this whole things ends with a type its most
3470 # likely a typedef for a function.
3471 } elsif ($ctx =~ /$Type$/) {
3473 } else {
3474 if (WARN("SPACING",
3475 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3476 $fix) {
3477 $fixed[$fixlinenr] =~
3478 s/\b$name\s+\(/$name\(/;
3483 # Check operator spacing.
3484 if (!($line=~/\#\s*include/)) {
3485 my $fixed_line = "";
3486 my $line_fixed = 0;
3488 my $ops = qr{
3489 <<=|>>=|<=|>=|==|!=|
3490 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3491 =>|->|<<|>>|<|>|=|!|~|
3492 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
3493 \?:|\?|:
3495 my @elements = split(/($ops|;)/, $opline);
3497 ## print("element count: <" . $#elements . ">\n");
3498 ## foreach my $el (@elements) {
3499 ## print("el: <$el>\n");
3500 ## }
3502 my @fix_elements = ();
3503 my $off = 0;
3505 foreach my $el (@elements) {
3506 push(@fix_elements, substr($rawline, $off, length($el)));
3507 $off += length($el);
3510 $off = 0;
3512 my $blank = copy_spacing($opline);
3513 my $last_after = -1;
3515 for (my $n = 0; $n < $#elements; $n += 2) {
3517 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3519 ## print("n: <$n> good: <$good>\n");
3521 $off += length($elements[$n]);
3523 # Pick up the preceding and succeeding characters.
3524 my $ca = substr($opline, 0, $off);
3525 my $cc = '';
3526 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3527 $cc = substr($opline, $off + length($elements[$n + 1]));
3529 my $cb = "$ca$;$cc";
3531 my $a = '';
3532 $a = 'V' if ($elements[$n] ne '');
3533 $a = 'W' if ($elements[$n] =~ /\s$/);
3534 $a = 'C' if ($elements[$n] =~ /$;$/);
3535 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3536 $a = 'O' if ($elements[$n] eq '');
3537 $a = 'E' if ($ca =~ /^\s*$/);
3539 my $op = $elements[$n + 1];
3541 my $c = '';
3542 if (defined $elements[$n + 2]) {
3543 $c = 'V' if ($elements[$n + 2] ne '');
3544 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
3545 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
3546 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3547 $c = 'O' if ($elements[$n + 2] eq '');
3548 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
3549 } else {
3550 $c = 'E';
3553 my $ctx = "${a}x${c}";
3555 my $at = "(ctx:$ctx)";
3557 my $ptr = substr($blank, 0, $off) . "^";
3558 my $hereptr = "$hereline$ptr\n";
3560 # Pull out the value of this operator.
3561 my $op_type = substr($curr_values, $off + 1, 1);
3563 # Get the full operator variant.
3564 my $opv = $op . substr($curr_vars, $off, 1);
3566 # Ignore operators passed as parameters.
3567 if ($op_type ne 'V' &&
3568 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
3570 # # Ignore comments
3571 # } elsif ($op =~ /^$;+$/) {
3573 # ; should have either the end of line or a space or \ after it
3574 } elsif ($op eq ';') {
3575 if ($ctx !~ /.x[WEBC]/ &&
3576 $cc !~ /^\\/ && $cc !~ /^;/) {
3577 if (ERROR("SPACING",
3578 "space required after that '$op' $at\n" . $hereptr)) {
3579 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3580 $line_fixed = 1;
3584 # // is a comment
3585 } elsif ($op eq '//') {
3587 # : when part of a bitfield
3588 } elsif ($opv eq ':B') {
3589 # skip the bitfield test for now
3591 # No spaces for:
3592 # ->
3593 } elsif ($op eq '->') {
3594 if ($ctx =~ /Wx.|.xW/) {
3595 if (ERROR("SPACING",
3596 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
3597 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3598 if (defined $fix_elements[$n + 2]) {
3599 $fix_elements[$n + 2] =~ s/^\s+//;
3601 $line_fixed = 1;
3605 # , must not have a space before and must have a space on the right.
3606 } elsif ($op eq ',') {
3607 my $rtrim_before = 0;
3608 my $space_after = 0;
3609 if ($ctx =~ /Wx./) {
3610 if (ERROR("SPACING",
3611 "space prohibited before that '$op' $at\n" . $hereptr)) {
3612 $line_fixed = 1;
3613 $rtrim_before = 1;
3616 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
3617 if (ERROR("SPACING",
3618 "space required after that '$op' $at\n" . $hereptr)) {
3619 $line_fixed = 1;
3620 $last_after = $n;
3621 $space_after = 1;
3624 if ($rtrim_before || $space_after) {
3625 if ($rtrim_before) {
3626 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3627 } else {
3628 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3630 if ($space_after) {
3631 $good .= " ";
3635 # '*' as part of a type definition -- reported already.
3636 } elsif ($opv eq '*_') {
3637 #warn "'*' is part of type\n";
3639 # unary operators should have a space before and
3640 # none after. May be left adjacent to another
3641 # unary operator, or a cast
3642 } elsif ($op eq '!' || $op eq '~' ||
3643 $opv eq '*U' || $opv eq '-U' ||
3644 $opv eq '&U' || $opv eq '&&U') {
3645 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
3646 if (ERROR("SPACING",
3647 "space required before that '$op' $at\n" . $hereptr)) {
3648 if ($n != $last_after + 2) {
3649 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3650 $line_fixed = 1;
3654 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
3655 # A unary '*' may be const
3657 } elsif ($ctx =~ /.xW/) {
3658 if (ERROR("SPACING",
3659 "space prohibited after that '$op' $at\n" . $hereptr)) {
3660 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
3661 if (defined $fix_elements[$n + 2]) {
3662 $fix_elements[$n + 2] =~ s/^\s+//;
3664 $line_fixed = 1;
3668 # unary ++ and unary -- are allowed no space on one side.
3669 } elsif ($op eq '++' or $op eq '--') {
3670 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
3671 if (ERROR("SPACING",
3672 "space required one side of that '$op' $at\n" . $hereptr)) {
3673 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3674 $line_fixed = 1;
3677 if ($ctx =~ /Wx[BE]/ ||
3678 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
3679 if (ERROR("SPACING",
3680 "space prohibited before that '$op' $at\n" . $hereptr)) {
3681 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3682 $line_fixed = 1;
3685 if ($ctx =~ /ExW/) {
3686 if (ERROR("SPACING",
3687 "space prohibited after that '$op' $at\n" . $hereptr)) {
3688 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3689 if (defined $fix_elements[$n + 2]) {
3690 $fix_elements[$n + 2] =~ s/^\s+//;
3692 $line_fixed = 1;
3696 # << and >> may either have or not have spaces both sides
3697 } elsif ($op eq '<<' or $op eq '>>' or
3698 $op eq '&' or $op eq '^' or $op eq '|' or
3699 $op eq '+' or $op eq '-' or
3700 $op eq '*' or $op eq '/' or
3701 $op eq '%')
3703 if ($check) {
3704 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
3705 if (CHK("SPACING",
3706 "spaces preferred around that '$op' $at\n" . $hereptr)) {
3707 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3708 $fix_elements[$n + 2] =~ s/^\s+//;
3709 $line_fixed = 1;
3711 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
3712 if (CHK("SPACING",
3713 "space preferred before that '$op' $at\n" . $hereptr)) {
3714 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
3715 $line_fixed = 1;
3718 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
3719 if (ERROR("SPACING",
3720 "need consistent spacing around '$op' $at\n" . $hereptr)) {
3721 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3722 if (defined $fix_elements[$n + 2]) {
3723 $fix_elements[$n + 2] =~ s/^\s+//;
3725 $line_fixed = 1;
3729 # A colon needs no spaces before when it is
3730 # terminating a case value or a label.
3731 } elsif ($opv eq ':C' || $opv eq ':L') {
3732 if ($ctx =~ /Wx./) {
3733 if (ERROR("SPACING",
3734 "space prohibited before that '$op' $at\n" . $hereptr)) {
3735 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3736 $line_fixed = 1;
3740 # All the others need spaces both sides.
3741 } elsif ($ctx !~ /[EWC]x[CWE]/) {
3742 my $ok = 0;
3744 # Ignore email addresses <foo@bar>
3745 if (($op eq '<' &&
3746 $cc =~ /^\S+\@\S+>/) ||
3747 ($op eq '>' &&
3748 $ca =~ /<\S+\@\S+$/))
3750 $ok = 1;
3753 # messages are ERROR, but ?: are CHK
3754 if ($ok == 0) {
3755 my $msg_type = \&ERROR;
3756 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
3758 if (&{$msg_type}("SPACING",
3759 "spaces required around that '$op' $at\n" . $hereptr)) {
3760 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3761 if (defined $fix_elements[$n + 2]) {
3762 $fix_elements[$n + 2] =~ s/^\s+//;
3764 $line_fixed = 1;
3768 $off += length($elements[$n + 1]);
3770 ## print("n: <$n> GOOD: <$good>\n");
3772 $fixed_line = $fixed_line . $good;
3775 if (($#elements % 2) == 0) {
3776 $fixed_line = $fixed_line . $fix_elements[$#elements];
3779 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
3780 $fixed[$fixlinenr] = $fixed_line;
3786 # check for whitespace before a non-naked semicolon
3787 if ($line =~ /^\+.*\S\s+;\s*$/) {
3788 if (WARN("SPACING",
3789 "space prohibited before semicolon\n" . $herecurr) &&
3790 $fix) {
3791 1 while $fixed[$fixlinenr] =~
3792 s/^(\+.*\S)\s+;/$1;/;
3796 # check for multiple assignments
3797 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
3798 CHK("MULTIPLE_ASSIGNMENTS",
3799 "multiple assignments should be avoided\n" . $herecurr);
3802 ## # check for multiple declarations, allowing for a function declaration
3803 ## # continuation.
3804 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3805 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3807 ## # Remove any bracketed sections to ensure we do not
3808 ## # falsly report the parameters of functions.
3809 ## my $ln = $line;
3810 ## while ($ln =~ s/\([^\(\)]*\)//g) {
3811 ## }
3812 ## if ($ln =~ /,/) {
3813 ## WARN("MULTIPLE_DECLARATION",
3814 ## "declaring multiple variables together should be avoided\n" . $herecurr);
3815 ## }
3816 ## }
3818 #need space before brace following if, while, etc
3819 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3820 $line =~ /do{/) {
3821 if (ERROR("SPACING",
3822 "space required before the open brace '{'\n" . $herecurr) &&
3823 $fix) {
3824 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
3828 ## # check for blank lines before declarations
3829 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3830 ## $prevrawline =~ /^.\s*$/) {
3831 ## WARN("SPACING",
3832 ## "No blank lines before declarations\n" . $hereprev);
3833 ## }
3836 # closing brace should have a space following it when it has anything
3837 # on the line
3838 if ($line =~ /}(?!(?:,|;|\)))\S/) {
3839 if (ERROR("SPACING",
3840 "space required after that close brace '}'\n" . $herecurr) &&
3841 $fix) {
3842 $fixed[$fixlinenr] =~
3843 s/}((?!(?:,|;|\)))\S)/} $1/;
3847 # check spacing on square brackets
3848 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
3849 if (ERROR("SPACING",
3850 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3851 $fix) {
3852 $fixed[$fixlinenr] =~
3853 s/\[\s+/\[/;
3856 if ($line =~ /\s\]/) {
3857 if (ERROR("SPACING",
3858 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3859 $fix) {
3860 $fixed[$fixlinenr] =~
3861 s/\s+\]/\]/;
3865 # check spacing on parentheses
3866 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3867 $line !~ /for\s*\(\s+;/) {
3868 if (ERROR("SPACING",
3869 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3870 $fix) {
3871 $fixed[$fixlinenr] =~
3872 s/\(\s+/\(/;
3875 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
3876 $line !~ /for\s*\(.*;\s+\)/ &&
3877 $line !~ /:\s+\)/) {
3878 if (ERROR("SPACING",
3879 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3880 $fix) {
3881 $fixed[$fixlinenr] =~
3882 s/\s+\)/\)/;
3886 # check unnecessary parentheses around addressof/dereference single $Lvals
3887 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
3889 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
3890 my $var = $1;
3891 if (CHK("UNNECESSARY_PARENTHESES",
3892 "Unnecessary parentheses around $var\n" . $herecurr) &&
3893 $fix) {
3894 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
3898 # check for unnecessary parentheses around function pointer uses
3899 # ie: (foo->bar)(); should be foo->bar();
3900 # but not "if (foo->bar) (" to avoid some false positives
3901 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
3902 my $var = $2;
3903 if (CHK("UNNECESSARY_PARENTHESES",
3904 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
3905 $fix) {
3906 my $var2 = deparenthesize($var);
3907 $var2 =~ s/\s//g;
3908 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
3912 #goto labels aren't indented, allow a single space however
3913 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
3914 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
3915 if (WARN("INDENTED_LABEL",
3916 "labels should not be indented\n" . $herecurr) &&
3917 $fix) {
3918 $fixed[$fixlinenr] =~
3919 s/^(.)\s+/$1/;
3923 # return is not a function
3924 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
3925 my $spacing = $1;
3926 if ($^V && $^V ge 5.10.0 &&
3927 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
3928 my $value = $1;
3929 $value = deparenthesize($value);
3930 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
3931 ERROR("RETURN_PARENTHESES",
3932 "return is not a function, parentheses are not required\n" . $herecurr);
3934 } elsif ($spacing !~ /\s+/) {
3935 ERROR("SPACING",
3936 "space required before the open parenthesis '('\n" . $herecurr);
3940 # unnecessary return in a void function
3941 # at end-of-function, with the previous line a single leading tab, then return;
3942 # and the line before that not a goto label target like "out:"
3943 if ($sline =~ /^[ \+]}\s*$/ &&
3944 $prevline =~ /^\+\treturn\s*;\s*$/ &&
3945 $linenr >= 3 &&
3946 $lines[$linenr - 3] =~ /^[ +]/ &&
3947 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
3948 WARN("RETURN_VOID",
3949 "void function return statements are not generally useful\n" . $hereprev);
3952 # if statements using unnecessary parentheses - ie: if ((foo == bar))
3953 if ($^V && $^V ge 5.10.0 &&
3954 $line =~ /\bif\s*((?:\(\s*){2,})/) {
3955 my $openparens = $1;
3956 my $count = $openparens =~ tr@\(@\(@;
3957 my $msg = "";
3958 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3959 my $comp = $4; #Not $1 because of $LvalOrFunc
3960 $msg = " - maybe == should be = ?" if ($comp eq "==");
3961 WARN("UNNECESSARY_PARENTHESES",
3962 "Unnecessary parentheses$msg\n" . $herecurr);
3966 # Return of what appears to be an errno should normally be -'ve
3967 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
3968 my $name = $1;
3969 if ($name ne 'EOF' && $name ne 'ERROR') {
3970 WARN("USE_NEGATIVE_ERRNO",
3971 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
3975 # Need a space before open parenthesis after if, while etc
3976 if ($line =~ /\b(if|while|for|switch)\(/) {
3977 if (ERROR("SPACING",
3978 "space required before the open parenthesis '('\n" . $herecurr) &&
3979 $fix) {
3980 $fixed[$fixlinenr] =~
3981 s/\b(if|while|for|switch)\(/$1 \(/;
3985 # Check for illegal assignment in if conditional -- and check for trailing
3986 # statements after the conditional.
3987 if ($line =~ /do\s*(?!{)/) {
3988 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3989 ctx_statement_block($linenr, $realcnt, 0)
3990 if (!defined $stat);
3991 my ($stat_next) = ctx_statement_block($line_nr_next,
3992 $remain_next, $off_next);
3993 $stat_next =~ s/\n./\n /g;
3994 ##print "stat<$stat> stat_next<$stat_next>\n";
3996 if ($stat_next =~ /^\s*while\b/) {
3997 # If the statement carries leading newlines,
3998 # then count those as offsets.
3999 my ($whitespace) =
4000 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4001 my $offset =
4002 statement_rawlines($whitespace) - 1;
4004 $suppress_whiletrailers{$line_nr_next +
4005 $offset} = 1;
4008 if (!defined $suppress_whiletrailers{$linenr} &&
4009 defined($stat) && defined($cond) &&
4010 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
4011 my ($s, $c) = ($stat, $cond);
4013 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
4014 ERROR("ASSIGN_IN_IF",
4015 "do not use assignment in if condition\n" . $herecurr);
4018 # Find out what is on the end of the line after the
4019 # conditional.
4020 substr($s, 0, length($c), '');
4021 $s =~ s/\n.*//g;
4022 $s =~ s/$;//g; # Remove any comments
4023 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4024 $c !~ /}\s*while\s*/)
4026 # Find out how long the conditional actually is.
4027 my @newlines = ($c =~ /\n/gs);
4028 my $cond_lines = 1 + $#newlines;
4029 my $stat_real = '';
4031 $stat_real = raw_line($linenr, $cond_lines)
4032 . "\n" if ($cond_lines);
4033 if (defined($stat_real) && $cond_lines > 1) {
4034 $stat_real = "[...]\n$stat_real";
4037 ERROR("TRAILING_STATEMENTS",
4038 "trailing statements should be on next line\n" . $herecurr . $stat_real);
4042 # Check for bitwise tests written as boolean
4043 if ($line =~ /
4045 (?:\[|\(|\&\&|\|\|)
4046 \s*0[xX][0-9]+\s*
4047 (?:\&\&|\|\|)
4049 (?:\&\&|\|\|)
4050 \s*0[xX][0-9]+\s*
4051 (?:\&\&|\|\||\)|\])
4052 )/x)
4054 WARN("HEXADECIMAL_BOOLEAN_TEST",
4055 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
4058 # if and else should not have general statements after it
4059 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4060 my $s = $1;
4061 $s =~ s/$;//g; # Remove any comments
4062 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
4063 ERROR("TRAILING_STATEMENTS",
4064 "trailing statements should be on next line\n" . $herecurr);
4067 # if should not continue a brace
4068 if ($line =~ /}\s*if\b/) {
4069 ERROR("TRAILING_STATEMENTS",
4070 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
4071 $herecurr);
4073 # case and default should not have general statements after them
4074 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4075 $line !~ /\G(?:
4076 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
4077 \s*return\s+
4078 )/xg)
4080 ERROR("TRAILING_STATEMENTS",
4081 "trailing statements should be on next line\n" . $herecurr);
4084 # Check for }<nl>else {, these must be at the same
4085 # indent level to be relevant to each other.
4086 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4087 $previndent == $indent) {
4088 if (ERROR("ELSE_AFTER_BRACE",
4089 "else should follow close brace '}'\n" . $hereprev) &&
4090 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4091 fix_delete_line($fixlinenr - 1, $prevrawline);
4092 fix_delete_line($fixlinenr, $rawline);
4093 my $fixedline = $prevrawline;
4094 $fixedline =~ s/}\s*$//;
4095 if ($fixedline !~ /^\+\s*$/) {
4096 fix_insert_line($fixlinenr, $fixedline);
4098 $fixedline = $rawline;
4099 $fixedline =~ s/^(.\s*)else/$1} else/;
4100 fix_insert_line($fixlinenr, $fixedline);
4104 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4105 $previndent == $indent) {
4106 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4108 # Find out what is on the end of the line after the
4109 # conditional.
4110 substr($s, 0, length($c), '');
4111 $s =~ s/\n.*//g;
4113 if ($s =~ /^\s*;/) {
4114 if (ERROR("WHILE_AFTER_BRACE",
4115 "while should follow close brace '}'\n" . $hereprev) &&
4116 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4117 fix_delete_line($fixlinenr - 1, $prevrawline);
4118 fix_delete_line($fixlinenr, $rawline);
4119 my $fixedline = $prevrawline;
4120 my $trailing = $rawline;
4121 $trailing =~ s/^\+//;
4122 $trailing = trim($trailing);
4123 $fixedline =~ s/}\s*$/} $trailing/;
4124 fix_insert_line($fixlinenr, $fixedline);
4129 #Specific variable tests
4130 while ($line =~ m{($Constant|$Lval)}g) {
4131 my $var = $1;
4133 #gcc binary extension
4134 if ($var =~ /^$Binary$/) {
4135 if (WARN("GCC_BINARY_CONSTANT",
4136 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4137 $fix) {
4138 my $hexval = sprintf("0x%x", oct($var));
4139 $fixed[$fixlinenr] =~
4140 s/\b$var\b/$hexval/;
4144 #CamelCase
4145 if ($var !~ /^$Constant$/ &&
4146 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
4147 #Ignore Page<foo> variants
4148 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
4149 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4150 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4151 #Ignore some three character SI units explicitly, like MiB and KHz
4152 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
4153 while ($var =~ m{($Ident)}g) {
4154 my $word = $1;
4155 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
4156 if ($check) {
4157 seed_camelcase_includes();
4158 if (!$file && !$camelcase_file_seeded) {
4159 seed_camelcase_file($realfile);
4160 $camelcase_file_seeded = 1;
4163 if (!defined $camelcase{$word}) {
4164 $camelcase{$word} = 1;
4165 CHK("CAMELCASE",
4166 "Avoid CamelCase: <$word>\n" . $herecurr);
4172 #no spaces allowed after \ in define
4173 if ($line =~ /\#\s*define.*\\\s+$/) {
4174 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4175 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4176 $fix) {
4177 $fixed[$fixlinenr] =~ s/\s+$//;
4181 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
4182 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
4183 my $file = "$1.h";
4184 my $checkfile = "include/linux/$file";
4185 if (-f "$root/$checkfile" &&
4186 $realfile ne $checkfile &&
4187 $1 !~ /$allowed_asm_includes/)
4189 if ($realfile =~ m{^arch/}) {
4190 CHK("ARCH_INCLUDE_LINUX",
4191 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4192 } else {
4193 WARN("INCLUDE_LINUX",
4194 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4199 # multi-statement macros should be enclosed in a do while loop, grab the
4200 # first statement and ensure its the whole macro if its not enclosed
4201 # in a known good container
4202 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4203 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
4204 my $ln = $linenr;
4205 my $cnt = $realcnt;
4206 my ($off, $dstat, $dcond, $rest);
4207 my $ctx = '';
4208 my $has_flow_statement = 0;
4209 my $has_arg_concat = 0;
4210 ($dstat, $dcond, $ln, $cnt, $off) =
4211 ctx_statement_block($linenr, $realcnt, 0);
4212 $ctx = $dstat;
4213 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4214 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4216 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
4217 $has_arg_concat = 1 if ($ctx =~ /\#\#/);
4219 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
4220 $dstat =~ s/$;//g;
4221 $dstat =~ s/\\\n.//g;
4222 $dstat =~ s/^\s*//s;
4223 $dstat =~ s/\s*$//s;
4225 # Flatten any parentheses and braces
4226 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4227 $dstat =~ s/\{[^\{\}]*\}/1/ ||
4228 $dstat =~ s/\[[^\[\]]*\]/1/)
4232 # Flatten any obvious string concatentation.
4233 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
4234 $dstat =~ s/$Ident\s*("X*")/$1/)
4238 my $exceptions = qr{
4239 $Declare|
4240 module_param_named|
4241 MODULE_PARM_DESC|
4242 DECLARE_PER_CPU|
4243 DEFINE_PER_CPU|
4244 __typeof__\(|
4245 union|
4246 struct|
4247 \.$Ident\s*=\s*|
4248 ^\"|\"$
4250 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4251 if ($dstat ne '' &&
4252 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4253 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
4254 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4255 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
4256 $dstat !~ /$exceptions/ &&
4257 $dstat !~ /^\.$Ident\s*=/ && # .foo =
4258 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
4259 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
4260 $dstat !~ /^for\s*$Constant$/ && # for (...)
4261 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4262 $dstat !~ /^do\s*{/ && # do {...
4263 $dstat !~ /^\({/ && # ({...
4264 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
4266 $ctx =~ s/\n*$//;
4267 my $herectx = $here . "\n";
4268 my $cnt = statement_rawlines($ctx);
4270 for (my $n = 0; $n < $cnt; $n++) {
4271 $herectx .= raw_line($linenr, $n) . "\n";
4274 if ($dstat =~ /;/) {
4275 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4276 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4277 } else {
4278 ERROR("COMPLEX_MACRO",
4279 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
4283 # check for macros with flow control, but without ## concatenation
4284 # ## concatenation is commonly a macro that defines a function so ignore those
4285 if ($has_flow_statement && !$has_arg_concat) {
4286 my $herectx = $here . "\n";
4287 my $cnt = statement_rawlines($ctx);
4289 for (my $n = 0; $n < $cnt; $n++) {
4290 $herectx .= raw_line($linenr, $n) . "\n";
4292 WARN("MACRO_WITH_FLOW_CONTROL",
4293 "Macros with flow control statements should be avoided\n" . "$herectx");
4296 # check for line continuations outside of #defines, preprocessor #, and asm
4298 } else {
4299 if ($prevline !~ /^..*\\$/ &&
4300 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4301 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
4302 $line =~ /^\+.*\\$/) {
4303 WARN("LINE_CONTINUATIONS",
4304 "Avoid unnecessary line continuations\n" . $herecurr);
4308 # do {} while (0) macro tests:
4309 # single-statement macros do not need to be enclosed in do while (0) loop,
4310 # macro should not end with a semicolon
4311 if ($^V && $^V ge 5.10.0 &&
4312 $realfile !~ m@/vmlinux.lds.h$@ &&
4313 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4314 my $ln = $linenr;
4315 my $cnt = $realcnt;
4316 my ($off, $dstat, $dcond, $rest);
4317 my $ctx = '';
4318 ($dstat, $dcond, $ln, $cnt, $off) =
4319 ctx_statement_block($linenr, $realcnt, 0);
4320 $ctx = $dstat;
4322 $dstat =~ s/\\\n.//g;
4323 $dstat =~ s/$;/ /g;
4325 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4326 my $stmts = $2;
4327 my $semis = $3;
4329 $ctx =~ s/\n*$//;
4330 my $cnt = statement_rawlines($ctx);
4331 my $herectx = $here . "\n";
4333 for (my $n = 0; $n < $cnt; $n++) {
4334 $herectx .= raw_line($linenr, $n) . "\n";
4337 if (($stmts =~ tr/;/;/) == 1 &&
4338 $stmts !~ /^\s*(if|while|for|switch)\b/) {
4339 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4340 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4342 if (defined $semis && $semis ne "") {
4343 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4344 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4346 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4347 $ctx =~ s/\n*$//;
4348 my $cnt = statement_rawlines($ctx);
4349 my $herectx = $here . "\n";
4351 for (my $n = 0; $n < $cnt; $n++) {
4352 $herectx .= raw_line($linenr, $n) . "\n";
4355 WARN("TRAILING_SEMICOLON",
4356 "macros should not use a trailing semicolon\n" . "$herectx");
4360 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4361 # all assignments may have only one of the following with an assignment:
4363 # ALIGN(...)
4364 # VMLINUX_SYMBOL(...)
4365 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
4366 WARN("MISSING_VMLINUX_SYMBOL",
4367 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
4370 # check for redundant bracing round if etc
4371 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4372 my ($level, $endln, @chunks) =
4373 ctx_statement_full($linenr, $realcnt, 1);
4374 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
4375 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4376 if ($#chunks > 0 && $level == 0) {
4377 my @allowed = ();
4378 my $allow = 0;
4379 my $seen = 0;
4380 my $herectx = $here . "\n";
4381 my $ln = $linenr - 1;
4382 for my $chunk (@chunks) {
4383 my ($cond, $block) = @{$chunk};
4385 # If the condition carries leading newlines, then count those as offsets.
4386 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4387 my $offset = statement_rawlines($whitespace) - 1;
4389 $allowed[$allow] = 0;
4390 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4392 # We have looked at and allowed this specific line.
4393 $suppress_ifbraces{$ln + $offset} = 1;
4395 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
4396 $ln += statement_rawlines($block) - 1;
4398 substr($block, 0, length($cond), '');
4400 $seen++ if ($block =~ /^\s*{/);
4402 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
4403 if (statement_lines($cond) > 1) {
4404 #print "APW: ALLOWED: cond<$cond>\n";
4405 $allowed[$allow] = 1;
4407 if ($block =~/\b(?:if|for|while)\b/) {
4408 #print "APW: ALLOWED: block<$block>\n";
4409 $allowed[$allow] = 1;
4411 if (statement_block_size($block) > 1) {
4412 #print "APW: ALLOWED: lines block<$block>\n";
4413 $allowed[$allow] = 1;
4415 $allow++;
4417 if ($seen) {
4418 my $sum_allowed = 0;
4419 foreach (@allowed) {
4420 $sum_allowed += $_;
4422 if ($sum_allowed == 0) {
4423 WARN("BRACES",
4424 "braces {} are not necessary for any arm of this statement\n" . $herectx);
4425 } elsif ($sum_allowed != $allow &&
4426 $seen != $allow) {
4427 CHK("BRACES",
4428 "braces {} should be used on all arms of this statement\n" . $herectx);
4433 if (!defined $suppress_ifbraces{$linenr - 1} &&
4434 $line =~ /\b(if|while|for|else)\b/) {
4435 my $allowed = 0;
4437 # Check the pre-context.
4438 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
4439 #print "APW: ALLOWED: pre<$1>\n";
4440 $allowed = 1;
4443 my ($level, $endln, @chunks) =
4444 ctx_statement_full($linenr, $realcnt, $-[0]);
4446 # Check the condition.
4447 my ($cond, $block) = @{$chunks[0]};
4448 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
4449 if (defined $cond) {
4450 substr($block, 0, length($cond), '');
4452 if (statement_lines($cond) > 1) {
4453 #print "APW: ALLOWED: cond<$cond>\n";
4454 $allowed = 1;
4456 if ($block =~/\b(?:if|for|while)\b/) {
4457 #print "APW: ALLOWED: block<$block>\n";
4458 $allowed = 1;
4460 if (statement_block_size($block) > 1) {
4461 #print "APW: ALLOWED: lines block<$block>\n";
4462 $allowed = 1;
4464 # Check the post-context.
4465 if (defined $chunks[1]) {
4466 my ($cond, $block) = @{$chunks[1]};
4467 if (defined $cond) {
4468 substr($block, 0, length($cond), '');
4470 if ($block =~ /^\s*\{/) {
4471 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4472 $allowed = 1;
4475 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
4476 my $herectx = $here . "\n";
4477 my $cnt = statement_rawlines($block);
4479 for (my $n = 0; $n < $cnt; $n++) {
4480 $herectx .= raw_line($linenr, $n) . "\n";
4483 WARN("BRACES",
4484 "braces {} are not necessary for single statement blocks\n" . $herectx);
4488 # check for unnecessary blank lines around braces
4489 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
4490 if (CHK("BRACES",
4491 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
4492 $fix && $prevrawline =~ /^\+/) {
4493 fix_delete_line($fixlinenr - 1, $prevrawline);
4496 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
4497 if (CHK("BRACES",
4498 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
4499 $fix) {
4500 fix_delete_line($fixlinenr, $rawline);
4504 # no volatiles please
4505 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
4506 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
4507 WARN("VOLATILE",
4508 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
4511 # Check for user-visible strings broken across lines, which breaks the ability
4512 # to grep for the string. Make exceptions when the previous string ends in a
4513 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
4514 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
4515 if ($line =~ /^\+\s*"[X\t]*"/ &&
4516 $prevline =~ /"\s*$/ &&
4517 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
4518 if (WARN("SPLIT_STRING",
4519 "quoted string split across lines\n" . $hereprev) &&
4520 $fix &&
4521 $prevrawline =~ /^\+.*"\s*$/ &&
4522 $last_coalesced_string_linenr != $linenr - 1) {
4523 my $extracted_string = get_quoted_string($line, $rawline);
4524 my $comma_close = "";
4525 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
4526 $comma_close = $1;
4529 fix_delete_line($fixlinenr - 1, $prevrawline);
4530 fix_delete_line($fixlinenr, $rawline);
4531 my $fixedline = $prevrawline;
4532 $fixedline =~ s/"\s*$//;
4533 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
4534 fix_insert_line($fixlinenr - 1, $fixedline);
4535 $fixedline = $rawline;
4536 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
4537 if ($fixedline !~ /\+\s*$/) {
4538 fix_insert_line($fixlinenr, $fixedline);
4540 $last_coalesced_string_linenr = $linenr;
4544 # check for missing a space in a string concatenation
4545 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
4546 WARN('MISSING_SPACE',
4547 "break quoted strings at a space character\n" . $hereprev);
4550 # check for spaces before a quoted newline
4551 if ($rawline =~ /^.*\".*\s\\n/) {
4552 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
4553 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
4554 $fix) {
4555 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
4560 # concatenated string without spaces between elements
4561 if ($line =~ /"X+"[A-Z_]+/ || $line =~ /[A-Z_]+"X+"/) {
4562 CHK("CONCATENATED_STRING",
4563 "Concatenated strings should use spaces between elements\n" . $herecurr);
4566 # uncoalesced string fragments
4567 if ($line =~ /"X*"\s*"/) {
4568 WARN("STRING_FRAGMENTS",
4569 "Consecutive strings are generally better as a single string\n" . $herecurr);
4572 # check for %L{u,d,i} in strings
4573 my $string;
4574 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4575 $string = substr($rawline, $-[1], $+[1] - $-[1]);
4576 $string =~ s/%%/__/g;
4577 if ($string =~ /(?<!%)%L[udi]/) {
4578 WARN("PRINTF_L",
4579 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
4580 last;
4584 # check for line continuations in quoted strings with odd counts of "
4585 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
4586 WARN("LINE_CONTINUATIONS",
4587 "Avoid line continuations in quoted strings\n" . $herecurr);
4590 # warn about #if 0
4591 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
4592 CHK("REDUNDANT_CODE",
4593 "if this code is redundant consider removing it\n" .
4594 $herecurr);
4597 # check for needless "if (<foo>) fn(<foo>)" uses
4598 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
4599 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
4600 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
4601 WARN('NEEDLESS_IF',
4602 "$1(NULL) is safe and this check is probably not required\n" . $hereprev);
4606 # check for unnecessary "Out of Memory" messages
4607 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
4608 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
4609 (defined $1 || defined $3) &&
4610 $linenr > 3) {
4611 my $testval = $2;
4612 my $testline = $lines[$linenr - 3];
4614 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
4615 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
4617 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
4618 WARN("OOM_MESSAGE",
4619 "Possible unnecessary 'out of memory' message\n" . $hereprev);
4623 # check for logging functions with KERN_<LEVEL>
4624 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
4625 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
4626 my $level = $1;
4627 if (WARN("UNNECESSARY_KERN_LEVEL",
4628 "Possible unnecessary $level\n" . $herecurr) &&
4629 $fix) {
4630 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
4634 # check for mask then right shift without a parentheses
4635 if ($^V && $^V ge 5.10.0 &&
4636 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
4637 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
4638 WARN("MASK_THEN_SHIFT",
4639 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
4642 # check for pointer comparisons to NULL
4643 if ($^V && $^V ge 5.10.0) {
4644 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
4645 my $val = $1;
4646 my $equal = "!";
4647 $equal = "" if ($4 eq "!=");
4648 if (CHK("COMPARISON_TO_NULL",
4649 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
4650 $fix) {
4651 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
4656 # check for bad placement of section $InitAttribute (e.g.: __initdata)
4657 if ($line =~ /(\b$InitAttribute\b)/) {
4658 my $attr = $1;
4659 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
4660 my $ptr = $1;
4661 my $var = $2;
4662 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
4663 ERROR("MISPLACED_INIT",
4664 "$attr should be placed after $var\n" . $herecurr)) ||
4665 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
4666 WARN("MISPLACED_INIT",
4667 "$attr should be placed after $var\n" . $herecurr))) &&
4668 $fix) {
4669 $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;
4674 # check for $InitAttributeData (ie: __initdata) with const
4675 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
4676 my $attr = $1;
4677 $attr =~ /($InitAttributePrefix)(.*)/;
4678 my $attr_prefix = $1;
4679 my $attr_type = $2;
4680 if (ERROR("INIT_ATTRIBUTE",
4681 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
4682 $fix) {
4683 $fixed[$fixlinenr] =~
4684 s/$InitAttributeData/${attr_prefix}initconst/;
4688 # check for $InitAttributeConst (ie: __initconst) without const
4689 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
4690 my $attr = $1;
4691 if (ERROR("INIT_ATTRIBUTE",
4692 "Use of $attr requires a separate use of const\n" . $herecurr) &&
4693 $fix) {
4694 my $lead = $fixed[$fixlinenr] =~
4695 /(^\+\s*(?:static\s+))/;
4696 $lead = rtrim($1);
4697 $lead = "$lead " if ($lead !~ /^\+$/);
4698 $lead = "${lead}const ";
4699 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
4703 # don't use __constant_<foo> functions outside of include/uapi/
4704 if ($realfile !~ m@^include/uapi/@ &&
4705 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
4706 my $constant_func = $1;
4707 my $func = $constant_func;
4708 $func =~ s/^__constant_//;
4709 if (WARN("CONSTANT_CONVERSION",
4710 "$constant_func should be $func\n" . $herecurr) &&
4711 $fix) {
4712 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
4716 # prefer usleep_range over udelay
4717 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
4718 my $delay = $1;
4719 # ignore udelay's < 10, however
4720 if (! ($delay < 10) ) {
4721 CHK("USLEEP_RANGE",
4722 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4724 if ($delay > 2000) {
4725 WARN("LONG_UDELAY",
4726 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
4730 # warn about unexpectedly long msleep's
4731 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
4732 if ($1 < 20) {
4733 WARN("MSLEEP",
4734 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4738 # check for comparisons of jiffies
4739 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
4740 WARN("JIFFIES_COMPARISON",
4741 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4744 # check for comparisons of get_jiffies_64()
4745 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
4746 WARN("JIFFIES_COMPARISON",
4747 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4750 # warn about #ifdefs in C files
4751 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
4752 # print "#ifdef in C files should be avoided\n";
4753 # print "$herecurr";
4754 # $clean = 0;
4757 # warn about spacing in #ifdefs
4758 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
4759 if (ERROR("SPACING",
4760 "exactly one space required after that #$1\n" . $herecurr) &&
4761 $fix) {
4762 $fixed[$fixlinenr] =~
4763 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
4768 # check for spinlock_t definitions without a comment.
4769 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
4770 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
4771 my $which = $1;
4772 if (!ctx_has_comment($first_line, $linenr)) {
4773 CHK("UNCOMMENTED_DEFINITION",
4774 "$1 definition without comment\n" . $herecurr);
4777 # check for memory barriers without a comment.
4778 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4779 if (!ctx_has_comment($first_line, $linenr)) {
4780 WARN("MEMORY_BARRIER",
4781 "memory barrier without comment\n" . $herecurr);
4784 # check of hardware specific defines
4785 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
4786 CHK("ARCH_DEFINES",
4787 "architecture specific defines should be avoided\n" . $herecurr);
4790 # Check that the storage class is at the beginning of a declaration
4791 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
4792 WARN("STORAGE_CLASS",
4793 "storage class should be at the beginning of the declaration\n" . $herecurr)
4796 # check the location of the inline attribute, that it is between
4797 # storage class and type.
4798 if ($line =~ /\b$Type\s+$Inline\b/ ||
4799 $line =~ /\b$Inline\s+$Storage\b/) {
4800 ERROR("INLINE_LOCATION",
4801 "inline keyword should sit between storage class and type\n" . $herecurr);
4804 # Check for __inline__ and __inline, prefer inline
4805 if ($realfile !~ m@\binclude/uapi/@ &&
4806 $line =~ /\b(__inline__|__inline)\b/) {
4807 if (WARN("INLINE",
4808 "plain inline is preferred over $1\n" . $herecurr) &&
4809 $fix) {
4810 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
4815 # Check for __attribute__ packed, prefer __packed
4816 if ($realfile !~ m@\binclude/uapi/@ &&
4817 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
4818 WARN("PREFER_PACKED",
4819 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
4822 # Check for __attribute__ aligned, prefer __aligned
4823 if ($realfile !~ m@\binclude/uapi/@ &&
4824 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
4825 WARN("PREFER_ALIGNED",
4826 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
4829 # Check for __attribute__ format(printf, prefer __printf
4830 if ($realfile !~ m@\binclude/uapi/@ &&
4831 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
4832 if (WARN("PREFER_PRINTF",
4833 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4834 $fix) {
4835 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
4840 # Check for __attribute__ format(scanf, prefer __scanf
4841 if ($realfile !~ m@\binclude/uapi/@ &&
4842 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
4843 if (WARN("PREFER_SCANF",
4844 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4845 $fix) {
4846 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
4850 # Check for __attribute__ weak, or __weak declarations (may have link issues)
4851 if ($^V && $^V ge 5.10.0 &&
4852 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
4853 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
4854 $line =~ /\b__weak\b/)) {
4855 ERROR("WEAK_DECLARATION",
4856 "Using weak declarations can have unintended link defects\n" . $herecurr);
4859 # check for sizeof(&)
4860 if ($line =~ /\bsizeof\s*\(\s*\&/) {
4861 WARN("SIZEOF_ADDRESS",
4862 "sizeof(& should be avoided\n" . $herecurr);
4865 # check for sizeof without parenthesis
4866 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
4867 if (WARN("SIZEOF_PARENTHESIS",
4868 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
4869 $fix) {
4870 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
4874 # check for struct spinlock declarations
4875 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
4876 WARN("USE_SPINLOCK_T",
4877 "struct spinlock should be spinlock_t\n" . $herecurr);
4880 # check for seq_printf uses that could be seq_puts
4881 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
4882 my $fmt = get_quoted_string($line, $rawline);
4883 $fmt =~ s/%%//g;
4884 if ($fmt !~ /%/) {
4885 if (WARN("PREFER_SEQ_PUTS",
4886 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
4887 $fix) {
4888 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
4893 # Check for misused memsets
4894 if ($^V && $^V ge 5.10.0 &&
4895 defined $stat &&
4896 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
4898 my $ms_addr = $2;
4899 my $ms_val = $7;
4900 my $ms_size = $12;
4902 if ($ms_size =~ /^(0x|)0$/i) {
4903 ERROR("MEMSET",
4904 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
4905 } elsif ($ms_size =~ /^(0x|)1$/i) {
4906 WARN("MEMSET",
4907 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
4911 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
4912 if ($^V && $^V ge 5.10.0 &&
4913 $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) {
4914 if (WARN("PREFER_ETHER_ADDR_COPY",
4915 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
4916 $fix) {
4917 $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
4921 # typecasts on min/max could be min_t/max_t
4922 if ($^V && $^V ge 5.10.0 &&
4923 defined $stat &&
4924 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
4925 if (defined $2 || defined $7) {
4926 my $call = $1;
4927 my $cast1 = deparenthesize($2);
4928 my $arg1 = $3;
4929 my $cast2 = deparenthesize($7);
4930 my $arg2 = $8;
4931 my $cast;
4933 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
4934 $cast = "$cast1 or $cast2";
4935 } elsif ($cast1 ne "") {
4936 $cast = $cast1;
4937 } else {
4938 $cast = $cast2;
4940 WARN("MINMAX",
4941 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
4945 # check usleep_range arguments
4946 if ($^V && $^V ge 5.10.0 &&
4947 defined $stat &&
4948 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
4949 my $min = $1;
4950 my $max = $7;
4951 if ($min eq $max) {
4952 WARN("USLEEP_RANGE",
4953 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4954 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
4955 $min > $max) {
4956 WARN("USLEEP_RANGE",
4957 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4961 # check for naked sscanf
4962 if ($^V && $^V ge 5.10.0 &&
4963 defined $stat &&
4964 $line =~ /\bsscanf\b/ &&
4965 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
4966 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
4967 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
4968 my $lc = $stat =~ tr@\n@@;
4969 $lc = $lc + $linenr;
4970 my $stat_real = raw_line($linenr, 0);
4971 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4972 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4974 WARN("NAKED_SSCANF",
4975 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
4978 # check for simple sscanf that should be kstrto<foo>
4979 if ($^V && $^V ge 5.10.0 &&
4980 defined $stat &&
4981 $line =~ /\bsscanf\b/) {
4982 my $lc = $stat =~ tr@\n@@;
4983 $lc = $lc + $linenr;
4984 my $stat_real = raw_line($linenr, 0);
4985 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4986 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4988 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
4989 my $format = $6;
4990 my $count = $format =~ tr@%@%@;
4991 if ($count == 1 &&
4992 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
4993 WARN("SSCANF_TO_KSTRTO",
4994 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
4999 # check for new externs in .h files.
5000 if ($realfile =~ /\.h$/ &&
5001 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
5002 if (CHK("AVOID_EXTERNS",
5003 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
5004 $fix) {
5005 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
5009 # check for new externs in .c files.
5010 if ($realfile =~ /\.c$/ && defined $stat &&
5011 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
5013 my $function_name = $1;
5014 my $paren_space = $2;
5016 my $s = $stat;
5017 if (defined $cond) {
5018 substr($s, 0, length($cond), '');
5020 if ($s =~ /^\s*;/ &&
5021 $function_name ne 'uninitialized_var')
5023 WARN("AVOID_EXTERNS",
5024 "externs should be avoided in .c files\n" . $herecurr);
5027 if ($paren_space =~ /\n/) {
5028 WARN("FUNCTION_ARGUMENTS",
5029 "arguments for function declarations should follow identifier\n" . $herecurr);
5032 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5033 $stat =~ /^.\s*extern\s+/)
5035 WARN("AVOID_EXTERNS",
5036 "externs should be avoided in .c files\n" . $herecurr);
5039 # checks for new __setup's
5040 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5041 my $name = $1;
5043 if (!grep(/$name/, @setup_docs)) {
5044 CHK("UNDOCUMENTED_SETUP",
5045 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
5049 # check for pointless casting of kmalloc return
5050 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
5051 WARN("UNNECESSARY_CASTS",
5052 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
5055 # alloc style
5056 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5057 if ($^V && $^V ge 5.10.0 &&
5058 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5059 CHK("ALLOC_SIZEOF_STRUCT",
5060 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
5063 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5064 if ($^V && $^V ge 5.10.0 &&
5065 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
5066 my $oldfunc = $3;
5067 my $a1 = $4;
5068 my $a2 = $10;
5069 my $newfunc = "kmalloc_array";
5070 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
5071 my $r1 = $a1;
5072 my $r2 = $a2;
5073 if ($a1 =~ /^sizeof\s*\S/) {
5074 $r1 = $a2;
5075 $r2 = $a1;
5077 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
5078 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
5079 if (WARN("ALLOC_WITH_MULTIPLY",
5080 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
5081 $fix) {
5082 $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;
5088 # check for krealloc arg reuse
5089 if ($^V && $^V ge 5.10.0 &&
5090 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
5091 WARN("KREALLOC_ARG_REUSE",
5092 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
5095 # check for alloc argument mismatch
5096 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
5097 WARN("ALLOC_ARRAY_ARGS",
5098 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
5101 # check for multiple semicolons
5102 if ($line =~ /;\s*;\s*$/) {
5103 if (WARN("ONE_SEMICOLON",
5104 "Statements terminations use 1 semicolon\n" . $herecurr) &&
5105 $fix) {
5106 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
5110 # check for #defines like: 1 << <digit> that could be BIT(digit)
5111 if ($line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
5112 my $ull = "";
5113 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
5114 if (CHK("BIT_MACRO",
5115 "Prefer using the BIT$ull macro\n" . $herecurr) &&
5116 $fix) {
5117 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
5121 # check for case / default statements not preceded by break/fallthrough/switch
5122 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
5123 my $has_break = 0;
5124 my $has_statement = 0;
5125 my $count = 0;
5126 my $prevline = $linenr;
5127 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
5128 $prevline--;
5129 my $rline = $rawlines[$prevline - 1];
5130 my $fline = $lines[$prevline - 1];
5131 last if ($fline =~ /^\@\@/);
5132 next if ($fline =~ /^\-/);
5133 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
5134 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
5135 next if ($fline =~ /^.[\s$;]*$/);
5136 $has_statement = 1;
5137 $count++;
5138 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
5140 if (!$has_break && $has_statement) {
5141 WARN("MISSING_BREAK",
5142 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
5146 # check for switch/default statements without a break;
5147 if ($^V && $^V ge 5.10.0 &&
5148 defined $stat &&
5149 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
5150 my $ctx = '';
5151 my $herectx = $here . "\n";
5152 my $cnt = statement_rawlines($stat);
5153 for (my $n = 0; $n < $cnt; $n++) {
5154 $herectx .= raw_line($linenr, $n) . "\n";
5156 WARN("DEFAULT_NO_BREAK",
5157 "switch default: should use break\n" . $herectx);
5160 # check for gcc specific __FUNCTION__
5161 if ($line =~ /\b__FUNCTION__\b/) {
5162 if (WARN("USE_FUNC",
5163 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
5164 $fix) {
5165 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
5169 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
5170 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
5171 ERROR("DATE_TIME",
5172 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
5175 # check for use of yield()
5176 if ($line =~ /\byield\s*\(\s*\)/) {
5177 WARN("YIELD",
5178 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
5181 # check for comparisons against true and false
5182 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
5183 my $lead = $1;
5184 my $arg = $2;
5185 my $test = $3;
5186 my $otype = $4;
5187 my $trail = $5;
5188 my $op = "!";
5190 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
5192 my $type = lc($otype);
5193 if ($type =~ /^(?:true|false)$/) {
5194 if (("$test" eq "==" && "$type" eq "true") ||
5195 ("$test" eq "!=" && "$type" eq "false")) {
5196 $op = "";
5199 CHK("BOOL_COMPARISON",
5200 "Using comparison to $otype is error prone\n" . $herecurr);
5202 ## maybe suggesting a correct construct would better
5203 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5208 # check for semaphores initialized locked
5209 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
5210 WARN("CONSIDER_COMPLETION",
5211 "consider using a completion\n" . $herecurr);
5214 # recommend kstrto* over simple_strto* and strict_strto*
5215 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
5216 WARN("CONSIDER_KSTRTO",
5217 "$1 is obsolete, use k$3 instead\n" . $herecurr);
5220 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
5221 if ($line =~ /^.\s*__initcall\s*\(/) {
5222 WARN("USE_DEVICE_INITCALL",
5223 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
5226 # check for various structs that are normally const (ops, kgdb, device_tree)
5227 my $const_structs = qr{
5228 acpi_dock_ops|
5229 address_space_operations|
5230 backlight_ops|
5231 block_device_operations|
5232 dentry_operations|
5233 dev_pm_ops|
5234 dma_map_ops|
5235 extent_io_ops|
5236 file_lock_operations|
5237 file_operations|
5238 hv_ops|
5239 ide_dma_ops|
5240 intel_dvo_dev_ops|
5241 item_operations|
5242 iwl_ops|
5243 kgdb_arch|
5244 kgdb_io|
5245 kset_uevent_ops|
5246 lock_manager_operations|
5247 microcode_ops|
5248 mtrr_ops|
5249 neigh_ops|
5250 nlmsvc_binding|
5251 of_device_id|
5252 pci_raw_ops|
5253 pipe_buf_operations|
5254 platform_hibernation_ops|
5255 platform_suspend_ops|
5256 proto_ops|
5257 rpc_pipe_ops|
5258 seq_operations|
5259 snd_ac97_build_ops|
5260 soc_pcmcia_socket_ops|
5261 stacktrace_ops|
5262 sysfs_ops|
5263 tty_operations|
5264 usb_mon_operations|
5265 wd_ops}x;
5266 if ($line !~ /\bconst\b/ &&
5267 $line =~ /\bstruct\s+($const_structs)\b/) {
5268 WARN("CONST_STRUCT",
5269 "struct $1 should normally be const\n" .
5270 $herecurr);
5273 # use of NR_CPUS is usually wrong
5274 # ignore definitions of NR_CPUS and usage to define arrays as likely right
5275 if ($line =~ /\bNR_CPUS\b/ &&
5276 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
5277 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
5278 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
5279 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
5280 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
5282 WARN("NR_CPUS",
5283 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
5286 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
5287 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
5288 ERROR("DEFINE_ARCH_HAS",
5289 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
5292 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
5293 if ($^V && $^V ge 5.10.0 &&
5294 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
5295 WARN("LIKELY_MISUSE",
5296 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
5299 # whine mightly about in_atomic
5300 if ($line =~ /\bin_atomic\s*\(/) {
5301 if ($realfile =~ m@^drivers/@) {
5302 ERROR("IN_ATOMIC",
5303 "do not use in_atomic in drivers\n" . $herecurr);
5304 } elsif ($realfile !~ m@^kernel/@) {
5305 WARN("IN_ATOMIC",
5306 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
5310 # check for lockdep_set_novalidate_class
5311 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
5312 $line =~ /__lockdep_no_validate__\s*\)/ ) {
5313 if ($realfile !~ m@^kernel/lockdep@ &&
5314 $realfile !~ m@^include/linux/lockdep@ &&
5315 $realfile !~ m@^drivers/base/core@) {
5316 ERROR("LOCKDEP",
5317 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
5321 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
5322 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
5323 WARN("EXPORTED_WORLD_WRITABLE",
5324 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5327 # Mode permission misuses where it seems decimal should be octal
5328 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5329 if ($^V && $^V ge 5.10.0 &&
5330 $line =~ /$mode_perms_search/) {
5331 foreach my $entry (@mode_permission_funcs) {
5332 my $func = $entry->[0];
5333 my $arg_pos = $entry->[1];
5335 my $skip_args = "";
5336 if ($arg_pos > 1) {
5337 $arg_pos--;
5338 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
5340 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
5341 if ($line =~ /$test/) {
5342 my $val = $1;
5343 $val = $6 if ($skip_args ne "");
5345 if ($val !~ /^0$/ &&
5346 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
5347 length($val) ne 4)) {
5348 ERROR("NON_OCTAL_PERMISSIONS",
5349 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
5350 } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) {
5351 ERROR("EXPORTED_WORLD_WRITABLE",
5352 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5359 # If we have no input at all, then there is nothing to report on
5360 # so just keep quiet.
5361 if ($#rawlines == -1) {
5362 exit(0);
5365 # In mailback mode only produce a report in the negative, for
5366 # things that appear to be patches.
5367 if ($mailback && ($clean == 1 || !$is_patch)) {
5368 exit(0);
5371 # This is not a patch, and we are are in 'no-patch' mode so
5372 # just keep quiet.
5373 if (!$chk_patch && !$is_patch) {
5374 exit(0);
5377 if (!$is_patch) {
5378 ERROR("NOT_UNIFIED_DIFF",
5379 "Does not appear to be a unified-diff format patch\n");
5381 if ($is_patch && $chk_signoff && $signoff == 0) {
5382 ERROR("MISSING_SIGN_OFF",
5383 "Missing Signed-off-by: line(s)\n");
5386 print report_dump();
5387 if ($summary && !($clean == 1 && $quiet == 1)) {
5388 print "$filename " if ($summary_file);
5389 print "total: $cnt_error errors, $cnt_warn warnings, " .
5390 (($check)? "$cnt_chk checks, " : "") .
5391 "$cnt_lines lines checked\n";
5392 print "\n" if ($quiet == 0);
5395 if ($quiet == 0) {
5397 if ($^V lt 5.10.0) {
5398 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
5399 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
5402 # If there were whitespace errors which cleanpatch can fix
5403 # then suggest that.
5404 if ($rpt_cleaners) {
5405 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
5406 print " scripts/cleanfile\n\n";
5407 $rpt_cleaners = 0;
5411 hash_show_words(\%use_type, "Used");
5412 hash_show_words(\%ignore_type, "Ignored");
5414 if ($clean == 0 && $fix &&
5415 ("@rawlines" ne "@fixed" ||
5416 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
5417 my $newfile = $filename;
5418 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
5419 my $linecount = 0;
5420 my $f;
5422 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
5424 open($f, '>', $newfile)
5425 or die "$P: Can't open $newfile for write\n";
5426 foreach my $fixed_line (@fixed) {
5427 $linecount++;
5428 if ($file) {
5429 if ($linecount > 3) {
5430 $fixed_line =~ s/^\+//;
5431 print $f $fixed_line . "\n";
5433 } else {
5434 print $f $fixed_line . "\n";
5437 close($f);
5439 if (!$quiet) {
5440 print << "EOM";
5441 Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
5443 Do _NOT_ trust the results written to this file.
5444 Do _NOT_ submit these changes without inspecting them for correctness.
5446 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
5447 No warranties, expressed or implied...
5453 if ($clean == 1 && $quiet == 0) {
5454 print "$vname has no obvious style problems and is ready for submission.\n"
5456 if ($clean == 0 && $quiet == 0) {
5457 print << "EOM";
5458 $vname has style problems, please review.
5460 If any of these errors are false positives, please report
5461 them to the maintainer, see CHECKPATCH in MAINTAINERS.
5465 return $clean;