blob: 16d035ec5b2f3152df1da3d7536ba342e8fa6e66 [file] [log] [blame]
Pierre-Louis Bossartf7beb512018-01-22 08:32:31 -06001#!/usr/bin/env perl
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
7
8use strict;
9use warnings;
10use POSIX;
11use File::Basename;
12use Cwd 'abs_path';
13use Term::ANSIColor qw(:constants);
14
15my $P = $0;
16my $D = dirname(abs_path($P));
17
18my $V = '0.32';
19
20use Getopt::Long qw(:config no_auto_abbrev);
21
22my $quiet = 0;
23my $tree = 1;
24my $chk_signoff = 1;
25my $chk_patch = 1;
26my $tst_only;
27my $emacs = 0;
28my $terse = 0;
29my $showfile = 0;
30my $file = 0;
31my $git = 0;
32my %git_commits = ();
33my $check = 0;
34my $check_orig = 0;
35my $summary = 1;
36my $mailback = 0;
37my $summary_file = 0;
38my $show_types = 0;
39my $list_types = 0;
40my $fix = 0;
41my $fix_inplace = 0;
42my $root;
43my %debug;
44my %camelcase = ();
45my %use_type = ();
46my @use = ();
47my %ignore_type = ();
48my @ignore = ();
49my $help = 0;
50my $configuration_file = ".checkpatch.conf";
51my $max_line_length = 80;
52my $ignore_perl_version = 0;
53my $minimum_perl_version = 5.10.0;
54my $min_conf_desc_length = 4;
55my $spelling_file = "$D/spelling.txt";
56my $codespell = 0;
57my $codespellfile = "/usr/share/codespell/dictionary.txt";
58my $conststructsfile = "$D/const_structs.checkpatch";
59my $typedefsfile = "";
60my $color = "auto";
61my $allow_c99_comments = 1;
62
63sub help {
64 my ($exitcode) = @_;
65
66 print << "EOM";
67Usage: $P [OPTION]... [FILE]...
68Version: $V
69
70Options:
71 -q, --quiet quiet
72 --no-tree run without a kernel tree
73 --no-signoff do not check for 'Signed-off-by' line
74 --patch treat FILE as patchfile (default)
75 --emacs emacs compile window format
76 --terse one line per report
77 --showfile emit diffed file position, not input file position
78 -g, --git treat FILE as a single commit or git revision range
79 single git commit with:
80 <rev>
81 <rev>^
82 <rev>~n
83 multiple git commits with:
84 <rev1>..<rev2>
85 <rev1>...<rev2>
86 <rev>-<count>
87 git merges are ignored
88 -f, --file treat FILE as regular source file
89 --subjective, --strict enable more subjective tests
90 --list-types list the possible message types
91 --types TYPE(,TYPE2...) show only these comma separated message types
92 --ignore TYPE(,TYPE2...) ignore various comma separated message types
93 --show-types show the specific message type in the output
94 --max-line-length=n set the maximum line length, if exceeded, warn
95 --min-conf-desc-length=n set the min description length, if shorter, warn
96 --root=PATH PATH to the kernel tree root
97 --no-summary suppress the per-file summary
98 --mailback only produce a report in case of warnings/errors
99 --summary-file include the filename in summary
100 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
101 'values', 'possible', 'type', and 'attr' (default
102 is all off)
103 --test-only=WORD report only warnings/errors containing WORD
104 literally
105 --fix EXPERIMENTAL - may create horrible results
106 If correctable single-line errors exist, create
107 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
108 with potential errors corrected to the preferred
109 checkpatch style
110 --fix-inplace EXPERIMENTAL - may create horrible results
111 Is the same as --fix, but overwrites the input
112 file. It's your fault if there's no backup or git
113 --ignore-perl-version override checking of perl version. expect
114 runtime errors.
115 --codespell Use the codespell dictionary for spelling/typos
116 (default:/usr/share/codespell/dictionary.txt)
117 --codespellfile Use this codespell dictionary
118 --typedefsfile Read additional types from this file
119 --color[=WHEN] Use colors 'always', 'never', or only when output
120 is a terminal ('auto'). Default is 'auto'.
121 -h, --help, --version display this help and exit
122
123When FILE is - read standard input.
124EOM
125
126 exit($exitcode);
127}
128
129sub uniq {
130 my %seen;
131 return grep { !$seen{$_}++ } @_;
132}
133
134sub list_types {
135 my ($exitcode) = @_;
136
137 my $count = 0;
138
139 local $/ = undef;
140
141 open(my $script, '<', abs_path($P)) or
142 die "$P: Can't read '$P' $!\n";
143
144 my $text = <$script>;
145 close($script);
146
147 my @types = ();
148 # Also catch when type or level is passed through a variable
149 for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
150 push (@types, $_);
151 }
152 @types = sort(uniq(@types));
153 print("#\tMessage type\n\n");
154 foreach my $type (@types) {
155 print(++$count . "\t" . $type . "\n");
156 }
157
158 exit($exitcode);
159}
160
161my $conf = which_conf($configuration_file);
162if (-f $conf) {
163 my @conf_args;
164 open(my $conffile, '<', "$conf")
165 or warn "$P: Can't find a readable $configuration_file file $!\n";
166
167 while (<$conffile>) {
168 my $line = $_;
169
170 $line =~ s/\s*\n?$//g;
171 $line =~ s/^\s*//g;
172 $line =~ s/\s+/ /g;
173
174 next if ($line =~ m/^\s*#/);
175 next if ($line =~ m/^\s*$/);
176
177 my @words = split(" ", $line);
178 foreach my $word (@words) {
179 last if ($word =~ m/^#/);
180 push (@conf_args, $word);
181 }
182 }
183 close($conffile);
184 unshift(@ARGV, @conf_args) if @conf_args;
185}
186
187# Perl's Getopt::Long allows options to take optional arguments after a space.
188# Prevent --color by itself from consuming other arguments
189foreach (@ARGV) {
190 if ($_ eq "--color" || $_ eq "-color") {
191 $_ = "--color=$color";
192 }
193}
194
195GetOptions(
196 'q|quiet+' => \$quiet,
197 'tree!' => \$tree,
198 'signoff!' => \$chk_signoff,
199 'patch!' => \$chk_patch,
200 'emacs!' => \$emacs,
201 'terse!' => \$terse,
202 'showfile!' => \$showfile,
203 'f|file!' => \$file,
204 'g|git!' => \$git,
205 'subjective!' => \$check,
206 'strict!' => \$check,
207 'ignore=s' => \@ignore,
208 'types=s' => \@use,
209 'show-types!' => \$show_types,
210 'list-types!' => \$list_types,
211 'max-line-length=i' => \$max_line_length,
212 'min-conf-desc-length=i' => \$min_conf_desc_length,
213 'root=s' => \$root,
214 'summary!' => \$summary,
215 'mailback!' => \$mailback,
216 'summary-file!' => \$summary_file,
217 'fix!' => \$fix,
218 'fix-inplace!' => \$fix_inplace,
219 'ignore-perl-version!' => \$ignore_perl_version,
220 'debug=s' => \%debug,
221 'test-only=s' => \$tst_only,
222 'codespell!' => \$codespell,
223 'codespellfile=s' => \$codespellfile,
224 'typedefsfile=s' => \$typedefsfile,
225 'color=s' => \$color,
226 'no-color' => \$color, #keep old behaviors of -nocolor
227 'nocolor' => \$color, #keep old behaviors of -nocolor
228 'h|help' => \$help,
229 'version' => \$help
230) or help(1);
231
232help(0) if ($help);
233
234list_types(0) if ($list_types);
235
236$fix = 1 if ($fix_inplace);
237$check_orig = $check;
238
239my $exit = 0;
240
241if ($^V && $^V lt $minimum_perl_version) {
242 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
243 if (!$ignore_perl_version) {
244 exit(1);
245 }
246}
247
248#if no filenames are given, push '-' to read patch from stdin
249if ($#ARGV < 0) {
250 push(@ARGV, '-');
251}
252
253if ($color =~ /^[01]$/) {
254 $color = !$color;
255} elsif ($color =~ /^always$/i) {
256 $color = 1;
257} elsif ($color =~ /^never$/i) {
258 $color = 0;
259} elsif ($color =~ /^auto$/i) {
260 $color = (-t STDOUT);
261} else {
262 die "Invalid color mode: $color\n";
263}
264
265sub hash_save_array_words {
266 my ($hashRef, $arrayRef) = @_;
267
268 my @array = split(/,/, join(',', @$arrayRef));
269 foreach my $word (@array) {
270 $word =~ s/\s*\n?$//g;
271 $word =~ s/^\s*//g;
272 $word =~ s/\s+/ /g;
273 $word =~ tr/[a-z]/[A-Z]/;
274
275 next if ($word =~ m/^\s*#/);
276 next if ($word =~ m/^\s*$/);
277
278 $hashRef->{$word}++;
279 }
280}
281
282sub hash_show_words {
283 my ($hashRef, $prefix) = @_;
284
285 if (keys %$hashRef) {
286 print "\nNOTE: $prefix message types:";
287 foreach my $word (sort keys %$hashRef) {
288 print " $word";
289 }
290 print "\n";
291 }
292}
293
294hash_save_array_words(\%ignore_type, \@ignore);
295hash_save_array_words(\%use_type, \@use);
296
297my $dbg_values = 0;
298my $dbg_possible = 0;
299my $dbg_type = 0;
300my $dbg_attr = 0;
301for my $key (keys %debug) {
302 ## no critic
303 eval "\${dbg_$key} = '$debug{$key}';";
304 die "$@" if ($@);
305}
306
307my $rpt_cleaners = 0;
308
309if ($terse) {
310 $emacs = 1;
311 $quiet++;
312}
313
314if ($tree) {
315 if (defined $root) {
316 if (!top_of_kernel_tree($root)) {
317 die "$P: $root: --root does not point at a valid tree\n";
318 }
319 } else {
320 if (top_of_kernel_tree('.')) {
321 $root = '.';
322 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
323 top_of_kernel_tree($1)) {
324 $root = $1;
325 }
326 }
327
328 if (!defined $root) {
329 print "Must be run from the top-level dir. of a kernel tree\n";
330 exit(2);
331 }
332}
333
334my $emitted_corrupt = 0;
335
336our $Ident = qr{
337 [A-Za-z_][A-Za-z\d_]*
338 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
339 }x;
340our $Storage = qr{extern|static|asmlinkage};
341our $Sparse = qr{
342 __user|
343 __kernel|
344 __force|
345 __iomem|
346 __must_check|
347 __init_refok|
348 __kprobes|
349 __ref|
350 __rcu|
351 __private
352 }x;
353our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
354our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
355our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
356our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
357our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
358
359# Notes to $Attribute:
360# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
361our $Attribute = qr{
362 const|
363 __percpu|
364 __nocast|
365 __safe|
366 __bitwise|
367 __packed__|
368 __packed2__|
369 __naked|
370 __maybe_unused|
371 __always_unused|
372 __noreturn|
373 __used|
374 __cold|
375 __pure|
376 __noclone|
377 __deprecated|
378 __read_mostly|
379 __kprobes|
380 $InitAttribute|
381 ____cacheline_aligned|
382 ____cacheline_aligned_in_smp|
383 ____cacheline_internodealigned_in_smp|
384 __weak
385 }x;
386our $Modifier;
387our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
388our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
389our $Lval = qr{$Ident(?:$Member)*};
390
391our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
392our $Binary = qr{(?i)0b[01]+$Int_type?};
393our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
394our $Int = qr{[0-9]+$Int_type?};
395our $Octal = qr{0[0-7]+$Int_type?};
396our $String = qr{"[X\t]*"};
397our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
398our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
399our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
400our $Float = qr{$Float_hex|$Float_dec|$Float_int};
401our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
402our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
403our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
404our $Arithmetic = qr{\+|-|\*|\/|%};
405our $Operators = qr{
406 <=|>=|==|!=|
407 =>|->|<<|>>|<|>|!|~|
408 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
409 }x;
410
411our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
412
413our $BasicType;
414our $NonptrType;
415our $NonptrTypeMisordered;
416our $NonptrTypeWithAttr;
417our $Type;
418our $TypeMisordered;
419our $Declare;
420our $DeclareMisordered;
421
422our $NON_ASCII_UTF8 = qr{
423 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
424 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
425 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
426 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
427 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
428 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
429 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
430}x;
431
432our $UTF8 = qr{
433 [\x09\x0A\x0D\x20-\x7E] # ASCII
434 | $NON_ASCII_UTF8
435}x;
436
437our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
438our $typeOtherOSTypedefs = qr{(?x:
439 u_(?:char|short|int|long) | # bsd
440 u(?:nchar|short|int|long) # sysv
441)};
442our $typeKernelTypedefs = qr{(?x:
443 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
444 atomic_t
445)};
446our $typeTypedefs = qr{(?x:
447 $typeC99Typedefs\b|
448 $typeOtherOSTypedefs\b|
449 $typeKernelTypedefs\b
450)};
451
452our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
453
454our $logFunctions = qr{(?x:
455 printk(?:_ratelimited|_once|_deferred_once|_deferred|)|
456 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
457 TP_printk|
458 WARN(?:_RATELIMIT|_ONCE|)|
459 panic|
460 MODULE_[A-Z_]+|
461 seq_vprintf|seq_printf|seq_puts
462)};
463
464our $signature_tags = qr{(?xi:
465 Signed-off-by:|
466 Acked-by:|
467 Tested-by:|
468 Reviewed-by:|
469 Reported-by:|
470 Suggested-by:|
471 To:|
472 Cc:
473)};
474
475our @typeListMisordered = (
476 qr{char\s+(?:un)?signed},
477 qr{int\s+(?:(?:un)?signed\s+)?short\s},
478 qr{int\s+short(?:\s+(?:un)?signed)},
479 qr{short\s+int(?:\s+(?:un)?signed)},
480 qr{(?:un)?signed\s+int\s+short},
481 qr{short\s+(?:un)?signed},
482 qr{long\s+int\s+(?:un)?signed},
483 qr{int\s+long\s+(?:un)?signed},
484 qr{long\s+(?:un)?signed\s+int},
485 qr{int\s+(?:un)?signed\s+long},
486 qr{int\s+(?:un)?signed},
487 qr{int\s+long\s+long\s+(?:un)?signed},
488 qr{long\s+long\s+int\s+(?:un)?signed},
489 qr{long\s+long\s+(?:un)?signed\s+int},
490 qr{long\s+long\s+(?:un)?signed},
491 qr{long\s+(?:un)?signed},
492);
493
494our @typeList = (
495 qr{void},
496 qr{(?:(?:un)?signed\s+)?char},
497 qr{(?:(?:un)?signed\s+)?short\s+int},
498 qr{(?:(?:un)?signed\s+)?short},
499 qr{(?:(?:un)?signed\s+)?int},
500 qr{(?:(?:un)?signed\s+)?long\s+int},
501 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
502 qr{(?:(?:un)?signed\s+)?long\s+long},
503 qr{(?:(?:un)?signed\s+)?long},
504 qr{(?:un)?signed},
505 qr{float},
506 qr{double},
507 qr{bool},
508 qr{struct\s+$Ident},
509 qr{union\s+$Ident},
510 qr{enum\s+$Ident},
511 qr{${Ident}_t},
512 qr{${Ident}_handler},
513 qr{${Ident}_handler_fn},
514 @typeListMisordered,
515);
516
517our $C90_int_types = qr{(?x:
518 long\s+long\s+int\s+(?:un)?signed|
519 long\s+long\s+(?:un)?signed\s+int|
520 long\s+long\s+(?:un)?signed|
521 (?:(?:un)?signed\s+)?long\s+long\s+int|
522 (?:(?:un)?signed\s+)?long\s+long|
523 int\s+long\s+long\s+(?:un)?signed|
524 int\s+(?:(?:un)?signed\s+)?long\s+long|
525
526 long\s+int\s+(?:un)?signed|
527 long\s+(?:un)?signed\s+int|
528 long\s+(?:un)?signed|
529 (?:(?:un)?signed\s+)?long\s+int|
530 (?:(?:un)?signed\s+)?long|
531 int\s+long\s+(?:un)?signed|
532 int\s+(?:(?:un)?signed\s+)?long|
533
534 int\s+(?:un)?signed|
535 (?:(?:un)?signed\s+)?int
536)};
537
538our @typeListFile = ();
539our @typeListWithAttr = (
540 @typeList,
541 qr{struct\s+$InitAttribute\s+$Ident},
542 qr{union\s+$InitAttribute\s+$Ident},
543);
544
545our @modifierList = (
546 qr{fastcall},
547);
548our @modifierListFile = ();
549
550our @mode_permission_funcs = (
551 ["module_param", 3],
552 ["module_param_(?:array|named|string)", 4],
553 ["module_param_array_named", 5],
554 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
555 ["proc_create(?:_data|)", 2],
556 ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2],
557 ["IIO_DEV_ATTR_[A-Z_]+", 1],
558 ["SENSOR_(?:DEVICE_|)ATTR_2", 2],
559 ["SENSOR_TEMPLATE(?:_2|)", 3],
560 ["__ATTR", 2],
561);
562
563#Create a search pattern for all these functions to speed up a loop below
564our $mode_perms_search = "";
565foreach my $entry (@mode_permission_funcs) {
566 $mode_perms_search .= '|' if ($mode_perms_search ne "");
567 $mode_perms_search .= $entry->[0];
568}
569
570our $mode_perms_world_writable = qr{
571 S_IWUGO |
572 S_IWOTH |
573 S_IRWXUGO |
574 S_IALLUGO |
575 0[0-7][0-7][2367]
576}x;
577
578our %mode_permission_string_types = (
579 "S_IRWXU" => 0700,
580 "S_IRUSR" => 0400,
581 "S_IWUSR" => 0200,
582 "S_IXUSR" => 0100,
583 "S_IRWXG" => 0070,
584 "S_IRGRP" => 0040,
585 "S_IWGRP" => 0020,
586 "S_IXGRP" => 0010,
587 "S_IRWXO" => 0007,
588 "S_IROTH" => 0004,
589 "S_IWOTH" => 0002,
590 "S_IXOTH" => 0001,
591 "S_IRWXUGO" => 0777,
592 "S_IRUGO" => 0444,
593 "S_IWUGO" => 0222,
594 "S_IXUGO" => 0111,
595);
596
597#Create a search pattern for all these strings to speed up a loop below
598our $mode_perms_string_search = "";
599foreach my $entry (keys %mode_permission_string_types) {
600 $mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
601 $mode_perms_string_search .= $entry;
602}
603
604our $allowed_asm_includes = qr{(?x:
605 irq|
606 memory|
607 time|
608 reboot
609)};
610# memory.h: ARM has a custom one
611
612# Load common spelling mistakes and build regular expression list.
613my $misspellings;
614my %spelling_fix;
615
616if (open(my $spelling, '<', $spelling_file)) {
617 while (<$spelling>) {
618 my $line = $_;
619
620 $line =~ s/\s*\n?$//g;
621 $line =~ s/^\s*//g;
622
623 next if ($line =~ m/^\s*#/);
624 next if ($line =~ m/^\s*$/);
625
626 my ($suspect, $fix) = split(/\|\|/, $line);
627
628 $spelling_fix{$suspect} = $fix;
629 }
630 close($spelling);
631} else {
632 warn "No typos will be found - file '$spelling_file': $!\n";
633}
634
635if ($codespell) {
636 if (open(my $spelling, '<', $codespellfile)) {
637 while (<$spelling>) {
638 my $line = $_;
639
640 $line =~ s/\s*\n?$//g;
641 $line =~ s/^\s*//g;
642
643 next if ($line =~ m/^\s*#/);
644 next if ($line =~ m/^\s*$/);
645 next if ($line =~ m/, disabled/i);
646
647 $line =~ s/,.*$//;
648
649 my ($suspect, $fix) = split(/->/, $line);
650
651 $spelling_fix{$suspect} = $fix;
652 }
653 close($spelling);
654 } else {
655 warn "No codespell typos will be found - file '$codespellfile': $!\n";
656 }
657}
658
659$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
660
661sub read_words {
662 my ($wordsRef, $file) = @_;
663
664 if (open(my $words, '<', $file)) {
665 while (<$words>) {
666 my $line = $_;
667
668 $line =~ s/\s*\n?$//g;
669 $line =~ s/^\s*//g;
670
671 next if ($line =~ m/^\s*#/);
672 next if ($line =~ m/^\s*$/);
673 if ($line =~ /\s/) {
674 print("$file: '$line' invalid - ignored\n");
675 next;
676 }
677
678 $$wordsRef .= '|' if ($$wordsRef ne "");
679 $$wordsRef .= $line;
680 }
681 close($file);
682 return 1;
683 }
684
685 return 0;
686}
687
688my $const_structs = "";
689read_words(\$const_structs, $conststructsfile)
690 or warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
691
692my $typeOtherTypedefs = "";
693if (length($typedefsfile)) {
694 read_words(\$typeOtherTypedefs, $typedefsfile)
695 or warn "No additional types will be considered - file '$typedefsfile': $!\n";
696}
697$typeTypedefs .= '|' . $typeOtherTypedefs if ($typeOtherTypedefs ne "");
698
699sub build_types {
700 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
701 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
702 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
703 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
704 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
705 $BasicType = qr{
706 (?:$typeTypedefs\b)|
707 (?:${all}\b)
708 }x;
709 $NonptrType = qr{
710 (?:$Modifier\s+|const\s+)*
711 (?:
712 (?:typeof|__typeof__)\s*\([^\)]*\)|
713 (?:$typeTypedefs\b)|
714 (?:${all}\b)
715 )
716 (?:\s+$Modifier|\s+const)*
717 }x;
718 $NonptrTypeMisordered = qr{
719 (?:$Modifier\s+|const\s+)*
720 (?:
721 (?:${Misordered}\b)
722 )
723 (?:\s+$Modifier|\s+const)*
724 }x;
725 $NonptrTypeWithAttr = qr{
726 (?:$Modifier\s+|const\s+)*
727 (?:
728 (?:typeof|__typeof__)\s*\([^\)]*\)|
729 (?:$typeTypedefs\b)|
730 (?:${allWithAttr}\b)
731 )
732 (?:\s+$Modifier|\s+const)*
733 }x;
734 $Type = qr{
735 $NonptrType
736 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
737 (?:\s+$Inline|\s+$Modifier)*
738 }x;
739 $TypeMisordered = qr{
740 $NonptrTypeMisordered
741 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
742 (?:\s+$Inline|\s+$Modifier)*
743 }x;
744 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
745 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
746}
747build_types();
748
749our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
750
751# Using $balanced_parens, $LvalOrFunc, or $FuncArg
752# requires at least perl version v5.10.0
753# Any use must be runtime checked with $^V
754
755our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
756our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
757our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
758
759our $declaration_macros = qr{(?x:
760 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
761 (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(|
762 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
763)};
764
765sub deparenthesize {
766 my ($string) = @_;
767 return "" if (!defined($string));
768
769 while ($string =~ /^\s*\(.*\)\s*$/) {
770 $string =~ s@^\s*\(\s*@@;
771 $string =~ s@\s*\)\s*$@@;
772 }
773
774 $string =~ s@\s+@ @g;
775
776 return $string;
777}
778
779sub seed_camelcase_file {
780 my ($file) = @_;
781
782 return if (!(-f $file));
783
784 local $/;
785
786 open(my $include_file, '<', "$file")
787 or warn "$P: Can't read '$file' $!\n";
788 my $text = <$include_file>;
789 close($include_file);
790
791 my @lines = split('\n', $text);
792
793 foreach my $line (@lines) {
794 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
795 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
796 $camelcase{$1} = 1;
797 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
798 $camelcase{$1} = 1;
799 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
800 $camelcase{$1} = 1;
801 }
802 }
803}
804
805sub is_maintained_obsolete {
806 my ($filename) = @_;
807
808 return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl"));
809
810 my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
811
812 return $status =~ /obsolete/i;
813}
814
815my $camelcase_seeded = 0;
816sub seed_camelcase_includes {
817 return if ($camelcase_seeded);
818
819 my $files;
820 my $camelcase_cache = "";
821 my @include_files = ();
822
823 $camelcase_seeded = 1;
824
825 if (-e ".git") {
826 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
827 chomp $git_last_include_commit;
828 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
829 } else {
830 my $last_mod_date = 0;
831 $files = `find $root/include -name "*.h"`;
832 @include_files = split('\n', $files);
833 foreach my $file (@include_files) {
834 my $date = POSIX::strftime("%Y%m%d%H%M",
835 localtime((stat $file)[9]));
836 $last_mod_date = $date if ($last_mod_date < $date);
837 }
838 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
839 }
840
841 if ($camelcase_cache ne "" && -f $camelcase_cache) {
842 open(my $camelcase_file, '<', "$camelcase_cache")
843 or warn "$P: Can't read '$camelcase_cache' $!\n";
844 while (<$camelcase_file>) {
845 chomp;
846 $camelcase{$_} = 1;
847 }
848 close($camelcase_file);
849
850 return;
851 }
852
853 if (-e ".git") {
854 $files = `git ls-files "include/*.h"`;
855 @include_files = split('\n', $files);
856 }
857
858 foreach my $file (@include_files) {
859 seed_camelcase_file($file);
860 }
861
862 if ($camelcase_cache ne "") {
863 unlink glob ".checkpatch-camelcase.*";
864 open(my $camelcase_file, '>', "$camelcase_cache")
865 or warn "$P: Can't write '$camelcase_cache' $!\n";
866 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
867 print $camelcase_file ("$_\n");
868 }
869 close($camelcase_file);
870 }
871}
872
873sub git_commit_info {
874 my ($commit, $id, $desc) = @_;
875
876 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
877
878 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
879 $output =~ s/^\s*//gm;
880 my @lines = split("\n", $output);
881
882 return ($id, $desc) if ($#lines < 0);
883
884 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
885# Maybe one day convert this block of bash into something that returns
886# all matching commit ids, but it's very slow...
887#
888# echo "checking commits $1..."
889# git rev-list --remotes | grep -i "^$1" |
890# while read line ; do
891# git log --format='%H %s' -1 $line |
892# echo "commit $(cut -c 1-12,41-)"
893# done
894 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
895 $id = undef;
896 } else {
897 $id = substr($lines[0], 0, 12);
898 $desc = substr($lines[0], 41);
899 }
900
901 return ($id, $desc);
902}
903
904$chk_signoff = 0 if ($file);
905
906my @rawlines = ();
907my @lines = ();
908my @fixed = ();
909my @fixed_inserted = ();
910my @fixed_deleted = ();
911my $fixlinenr = -1;
912
913# If input is git commits, extract all commits from the commit expressions.
914# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
915die "$P: No git repository found\n" if ($git && !-e ".git");
916
917if ($git) {
918 my @commits = ();
919 foreach my $commit_expr (@ARGV) {
920 my $git_range;
921 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
922 $git_range = "-$2 $1";
923 } elsif ($commit_expr =~ m/\.\./) {
924 $git_range = "$commit_expr";
925 } else {
926 $git_range = "-1 $commit_expr";
927 }
928 my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
929 foreach my $line (split(/\n/, $lines)) {
930 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
931 next if (!defined($1) || !defined($2));
932 my $sha1 = $1;
933 my $subject = $2;
934 unshift(@commits, $sha1);
935 $git_commits{$sha1} = $subject;
936 }
937 }
938 die "$P: no git commits after extraction!\n" if (@commits == 0);
939 @ARGV = @commits;
940}
941
942my $vname;
943for my $filename (@ARGV) {
944 my $FILE;
945 if ($git) {
946 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
947 die "$P: $filename: git format-patch failed - $!\n";
948 } elsif ($file) {
949 open($FILE, '-|', "diff -u /dev/null $filename") ||
950 die "$P: $filename: diff failed - $!\n";
951 } elsif ($filename eq '-') {
952 open($FILE, '<&STDIN');
953 } else {
954 open($FILE, '<', "$filename") ||
955 die "$P: $filename: open failed - $!\n";
956 }
957 if ($filename eq '-') {
958 $vname = 'Your patch';
959 } elsif ($git) {
960 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
961 } else {
962 $vname = $filename;
963 }
964 while (<$FILE>) {
965 chomp;
966 push(@rawlines, $_);
967 }
968 close($FILE);
969
970 if ($#ARGV > 0 && $quiet == 0) {
971 print '-' x length($vname) . "\n";
972 print "$vname\n";
973 print '-' x length($vname) . "\n";
974 }
975
976 if (!process($filename)) {
977 $exit = 1;
978 }
979 @rawlines = ();
980 @lines = ();
981 @fixed = ();
982 @fixed_inserted = ();
983 @fixed_deleted = ();
984 $fixlinenr = -1;
985 @modifierListFile = ();
986 @typeListFile = ();
987 build_types();
988}
989
990if (!$quiet) {
991 hash_show_words(\%use_type, "Used");
992 hash_show_words(\%ignore_type, "Ignored");
993
994 if ($^V lt 5.10.0) {
995 print << "EOM"
996
997NOTE: perl $^V is not modern enough to detect all possible issues.
998 An upgrade to at least perl v5.10.0 is suggested.
999EOM
1000 }
1001 if ($exit) {
1002 print << "EOM"
1003
1004NOTE: If any of the errors are false positives, please report
1005 them to the maintainer, see CHECKPATCH in MAINTAINERS.
1006EOM
1007 }
1008}
1009
1010exit($exit);
1011
1012sub top_of_kernel_tree {
1013 my ($root) = @_;
1014
1015 my @tree_check = (
1016 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
1017 "README", "Documentation", "arch", "include", "drivers",
1018 "fs", "init", "ipc", "kernel", "lib", "scripts",
1019 );
1020
1021 foreach my $check (@tree_check) {
1022 if (! -e $root . '/' . $check) {
1023 return 0;
1024 }
1025 }
1026 return 1;
1027}
1028
1029sub parse_email {
1030 my ($formatted_email) = @_;
1031
1032 my $name = "";
1033 my $address = "";
1034 my $comment = "";
1035
1036 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
1037 $name = $1;
1038 $address = $2;
1039 $comment = $3 if defined $3;
1040 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
1041 $address = $1;
1042 $comment = $2 if defined $2;
1043 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
1044 $address = $1;
1045 $comment = $2 if defined $2;
1046 $formatted_email =~ s/$address.*$//;
1047 $name = $formatted_email;
1048 $name = trim($name);
1049 $name =~ s/^\"|\"$//g;
1050 # If there's a name left after stripping spaces and
1051 # leading quotes, and the address doesn't have both
1052 # leading and trailing angle brackets, the address
1053 # is invalid. ie:
1054 # "joe smith joe@smith.com" bad
1055 # "joe smith <joe@smith.com" bad
1056 if ($name ne "" && $address !~ /^<[^>]+>$/) {
1057 $name = "";
1058 $address = "";
1059 $comment = "";
1060 }
1061 }
1062
1063 $name = trim($name);
1064 $name =~ s/^\"|\"$//g;
1065 $address = trim($address);
1066 $address =~ s/^\<|\>$//g;
1067
1068 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1069 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1070 $name = "\"$name\"";
1071 }
1072
1073 return ($name, $address, $comment);
1074}
1075
1076sub format_email {
1077 my ($name, $address) = @_;
1078
1079 my $formatted_email;
1080
1081 $name = trim($name);
1082 $name =~ s/^\"|\"$//g;
1083 $address = trim($address);
1084
1085 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1086 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1087 $name = "\"$name\"";
1088 }
1089
1090 if ("$name" eq "") {
1091 $formatted_email = "$address";
1092 } else {
1093 $formatted_email = "$name <$address>";
1094 }
1095
1096 return $formatted_email;
1097}
1098
1099sub which {
1100 my ($bin) = @_;
1101
1102 foreach my $path (split(/:/, $ENV{PATH})) {
1103 if (-e "$path/$bin") {
1104 return "$path/$bin";
1105 }
1106 }
1107
1108 return "";
1109}
1110
1111sub which_conf {
1112 my ($conf) = @_;
1113
1114 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1115 if (-e "$path/$conf") {
1116 return "$path/$conf";
1117 }
1118 }
1119
1120 return "";
1121}
1122
1123sub expand_tabs {
1124 my ($str) = @_;
1125
1126 my $res = '';
1127 my $n = 0;
1128 for my $c (split(//, $str)) {
1129 if ($c eq "\t") {
1130 $res .= ' ';
1131 $n++;
1132 for (; ($n % 8) != 0; $n++) {
1133 $res .= ' ';
1134 }
1135 next;
1136 }
1137 $res .= $c;
1138 $n++;
1139 }
1140
1141 return $res;
1142}
1143sub copy_spacing {
1144 (my $res = shift) =~ tr/\t/ /c;
1145 return $res;
1146}
1147
1148sub line_stats {
1149 my ($line) = @_;
1150
1151 # Drop the diff line leader and expand tabs
1152 $line =~ s/^.//;
1153 $line = expand_tabs($line);
1154
1155 # Pick the indent from the front of the line.
1156 my ($white) = ($line =~ /^(\s*)/);
1157
1158 return (length($line), length($white));
1159}
1160
1161my $sanitise_quote = '';
1162
1163sub sanitise_line_reset {
1164 my ($in_comment) = @_;
1165
1166 if ($in_comment) {
1167 $sanitise_quote = '*/';
1168 } else {
1169 $sanitise_quote = '';
1170 }
1171}
1172sub sanitise_line {
1173 my ($line) = @_;
1174
1175 my $res = '';
1176 my $l = '';
1177
1178 my $qlen = 0;
1179 my $off = 0;
1180 my $c;
1181
1182 # Always copy over the diff marker.
1183 $res = substr($line, 0, 1);
1184
1185 for ($off = 1; $off < length($line); $off++) {
1186 $c = substr($line, $off, 1);
1187
1188 # Comments we are wacking completly including the begin
1189 # and end, all to $;.
1190 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1191 $sanitise_quote = '*/';
1192
1193 substr($res, $off, 2, "$;$;");
1194 $off++;
1195 next;
1196 }
1197 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
1198 $sanitise_quote = '';
1199 substr($res, $off, 2, "$;$;");
1200 $off++;
1201 next;
1202 }
1203 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1204 $sanitise_quote = '//';
1205
1206 substr($res, $off, 2, $sanitise_quote);
1207 $off++;
1208 next;
1209 }
1210
1211 # A \ in a string means ignore the next character.
1212 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1213 $c eq "\\") {
1214 substr($res, $off, 2, 'XX');
1215 $off++;
1216 next;
1217 }
1218 # Regular quotes.
1219 if ($c eq "'" || $c eq '"') {
1220 if ($sanitise_quote eq '') {
1221 $sanitise_quote = $c;
1222
1223 substr($res, $off, 1, $c);
1224 next;
1225 } elsif ($sanitise_quote eq $c) {
1226 $sanitise_quote = '';
1227 }
1228 }
1229
1230 #print "c<$c> SQ<$sanitise_quote>\n";
1231 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1232 substr($res, $off, 1, $;);
1233 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1234 substr($res, $off, 1, $;);
1235 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1236 substr($res, $off, 1, 'X');
1237 } else {
1238 substr($res, $off, 1, $c);
1239 }
1240 }
1241
1242 if ($sanitise_quote eq '//') {
1243 $sanitise_quote = '';
1244 }
1245
1246 # The pathname on a #include may be surrounded by '<' and '>'.
1247 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
1248 my $clean = 'X' x length($1);
1249 $res =~ s@\<.*\>@<$clean>@;
1250
1251 # The whole of a #error is a string.
1252 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
1253 my $clean = 'X' x length($1);
1254 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
1255 }
1256
1257 if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1258 my $match = $1;
1259 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1260 }
1261
1262 return $res;
1263}
1264
1265sub get_quoted_string {
1266 my ($line, $rawline) = @_;
1267
1268 return "" if ($line !~ m/($String)/g);
1269 return substr($rawline, $-[0], $+[0] - $-[0]);
1270}
1271
1272sub ctx_statement_block {
1273 my ($linenr, $remain, $off) = @_;
1274 my $line = $linenr - 1;
1275 my $blk = '';
1276 my $soff = $off;
1277 my $coff = $off - 1;
1278 my $coff_set = 0;
1279
1280 my $loff = 0;
1281
1282 my $type = '';
1283 my $level = 0;
1284 my @stack = ();
1285 my $p;
1286 my $c;
1287 my $len = 0;
1288
1289 my $remainder;
1290 while (1) {
1291 @stack = (['', 0]) if ($#stack == -1);
1292
1293 #warn "CSB: blk<$blk> remain<$remain>\n";
1294 # If we are about to drop off the end, pull in more
1295 # context.
1296 if ($off >= $len) {
1297 for (; $remain > 0; $line++) {
1298 last if (!defined $lines[$line]);
1299 next if ($lines[$line] =~ /^-/);
1300 $remain--;
1301 $loff = $len;
1302 $blk .= $lines[$line] . "\n";
1303 $len = length($blk);
1304 $line++;
1305 last;
1306 }
1307 # Bail if there is no further context.
1308 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1309 if ($off >= $len) {
1310 last;
1311 }
1312 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1313 $level++;
1314 $type = '#';
1315 }
1316 }
1317 $p = $c;
1318 $c = substr($blk, $off, 1);
1319 $remainder = substr($blk, $off);
1320
1321 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1322
1323 # Handle nested #if/#else.
1324 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1325 push(@stack, [ $type, $level ]);
1326 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1327 ($type, $level) = @{$stack[$#stack - 1]};
1328 } elsif ($remainder =~ /^#\s*endif\b/) {
1329 ($type, $level) = @{pop(@stack)};
1330 }
1331
1332 # Statement ends at the ';' or a close '}' at the
1333 # outermost level.
1334 if ($level == 0 && $c eq ';') {
1335 last;
1336 }
1337
1338 # An else is really a conditional as long as its not else if
1339 if ($level == 0 && $coff_set == 0 &&
1340 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1341 $remainder =~ /^(else)(?:\s|{)/ &&
1342 $remainder !~ /^else\s+if\b/) {
1343 $coff = $off + length($1) - 1;
1344 $coff_set = 1;
1345 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1346 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1347 }
1348
1349 if (($type eq '' || $type eq '(') && $c eq '(') {
1350 $level++;
1351 $type = '(';
1352 }
1353 if ($type eq '(' && $c eq ')') {
1354 $level--;
1355 $type = ($level != 0)? '(' : '';
1356
1357 if ($level == 0 && $coff < $soff) {
1358 $coff = $off;
1359 $coff_set = 1;
1360 #warn "CSB: mark coff<$coff>\n";
1361 }
1362 }
1363 if (($type eq '' || $type eq '{') && $c eq '{') {
1364 $level++;
1365 $type = '{';
1366 }
1367 if ($type eq '{' && $c eq '}') {
1368 $level--;
1369 $type = ($level != 0)? '{' : '';
1370
1371 if ($level == 0) {
1372 if (substr($blk, $off + 1, 1) eq ';') {
1373 $off++;
1374 }
1375 last;
1376 }
1377 }
1378 # Preprocessor commands end at the newline unless escaped.
1379 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1380 $level--;
1381 $type = '';
1382 $off++;
1383 last;
1384 }
1385 $off++;
1386 }
1387 # We are truly at the end, so shuffle to the next line.
1388 if ($off == $len) {
1389 $loff = $len + 1;
1390 $line++;
1391 $remain--;
1392 }
1393
1394 my $statement = substr($blk, $soff, $off - $soff + 1);
1395 my $condition = substr($blk, $soff, $coff - $soff + 1);
1396
1397 #warn "STATEMENT<$statement>\n";
1398 #warn "CONDITION<$condition>\n";
1399
1400 #print "coff<$coff> soff<$off> loff<$loff>\n";
1401
1402 return ($statement, $condition,
1403 $line, $remain + 1, $off - $loff + 1, $level);
1404}
1405
1406sub statement_lines {
1407 my ($stmt) = @_;
1408
1409 # Strip the diff line prefixes and rip blank lines at start and end.
1410 $stmt =~ s/(^|\n)./$1/g;
1411 $stmt =~ s/^\s*//;
1412 $stmt =~ s/\s*$//;
1413
1414 my @stmt_lines = ($stmt =~ /\n/g);
1415
1416 return $#stmt_lines + 2;
1417}
1418
1419sub statement_rawlines {
1420 my ($stmt) = @_;
1421
1422 my @stmt_lines = ($stmt =~ /\n/g);
1423
1424 return $#stmt_lines + 2;
1425}
1426
1427sub statement_block_size {
1428 my ($stmt) = @_;
1429
1430 $stmt =~ s/(^|\n)./$1/g;
1431 $stmt =~ s/^\s*{//;
1432 $stmt =~ s/}\s*$//;
1433 $stmt =~ s/^\s*//;
1434 $stmt =~ s/\s*$//;
1435
1436 my @stmt_lines = ($stmt =~ /\n/g);
1437 my @stmt_statements = ($stmt =~ /;/g);
1438
1439 my $stmt_lines = $#stmt_lines + 2;
1440 my $stmt_statements = $#stmt_statements + 1;
1441
1442 if ($stmt_lines > $stmt_statements) {
1443 return $stmt_lines;
1444 } else {
1445 return $stmt_statements;
1446 }
1447}
1448
1449sub ctx_statement_full {
1450 my ($linenr, $remain, $off) = @_;
1451 my ($statement, $condition, $level);
1452
1453 my (@chunks);
1454
1455 # Grab the first conditional/block pair.
1456 ($statement, $condition, $linenr, $remain, $off, $level) =
1457 ctx_statement_block($linenr, $remain, $off);
1458 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1459 push(@chunks, [ $condition, $statement ]);
1460 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1461 return ($level, $linenr, @chunks);
1462 }
1463
1464 # Pull in the following conditional/block pairs and see if they
1465 # could continue the statement.
1466 for (;;) {
1467 ($statement, $condition, $linenr, $remain, $off, $level) =
1468 ctx_statement_block($linenr, $remain, $off);
1469 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1470 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1471 #print "C: push\n";
1472 push(@chunks, [ $condition, $statement ]);
1473 }
1474
1475 return ($level, $linenr, @chunks);
1476}
1477
1478sub ctx_block_get {
1479 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1480 my $line;
1481 my $start = $linenr - 1;
1482 my $blk = '';
1483 my @o;
1484 my @c;
1485 my @res = ();
1486
1487 my $level = 0;
1488 my @stack = ($level);
1489 for ($line = $start; $remain > 0; $line++) {
1490 next if ($rawlines[$line] =~ /^-/);
1491 $remain--;
1492
1493 $blk .= $rawlines[$line];
1494
1495 # Handle nested #if/#else.
1496 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1497 push(@stack, $level);
1498 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1499 $level = $stack[$#stack - 1];
1500 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1501 $level = pop(@stack);
1502 }
1503
1504 foreach my $c (split(//, $lines[$line])) {
1505 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1506 if ($off > 0) {
1507 $off--;
1508 next;
1509 }
1510
1511 if ($c eq $close && $level > 0) {
1512 $level--;
1513 last if ($level == 0);
1514 } elsif ($c eq $open) {
1515 $level++;
1516 }
1517 }
1518
1519 if (!$outer || $level <= 1) {
1520 push(@res, $rawlines[$line]);
1521 }
1522
1523 last if ($level == 0);
1524 }
1525
1526 return ($level, @res);
1527}
1528sub ctx_block_outer {
1529 my ($linenr, $remain) = @_;
1530
1531 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1532 return @r;
1533}
1534sub ctx_block {
1535 my ($linenr, $remain) = @_;
1536
1537 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1538 return @r;
1539}
1540sub ctx_statement {
1541 my ($linenr, $remain, $off) = @_;
1542
1543 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1544 return @r;
1545}
1546sub ctx_block_level {
1547 my ($linenr, $remain) = @_;
1548
1549 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1550}
1551sub ctx_statement_level {
1552 my ($linenr, $remain, $off) = @_;
1553
1554 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1555}
1556
1557sub ctx_locate_comment {
1558 my ($first_line, $end_line) = @_;
1559
1560 # Catch a comment on the end of the line itself.
1561 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1562 return $current_comment if (defined $current_comment);
1563
1564 # Look through the context and try and figure out if there is a
1565 # comment.
1566 my $in_comment = 0;
1567 $current_comment = '';
1568 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1569 my $line = $rawlines[$linenr - 1];
1570 #warn " $line\n";
1571 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1572 $in_comment = 1;
1573 }
1574 if ($line =~ m@/\*@) {
1575 $in_comment = 1;
1576 }
1577 if (!$in_comment && $current_comment ne '') {
1578 $current_comment = '';
1579 }
1580 $current_comment .= $line . "\n" if ($in_comment);
1581 if ($line =~ m@\*/@) {
1582 $in_comment = 0;
1583 }
1584 }
1585
1586 chomp($current_comment);
1587 return($current_comment);
1588}
1589sub ctx_has_comment {
1590 my ($first_line, $end_line) = @_;
1591 my $cmt = ctx_locate_comment($first_line, $end_line);
1592
1593 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1594 ##print "CMMT: $cmt\n";
1595
1596 return ($cmt ne '');
1597}
1598
1599sub raw_line {
1600 my ($linenr, $cnt) = @_;
1601
1602 my $offset = $linenr - 1;
1603 $cnt++;
1604
1605 my $line;
1606 while ($cnt) {
1607 $line = $rawlines[$offset++];
1608 next if (defined($line) && $line =~ /^-/);
1609 $cnt--;
1610 }
1611
1612 return $line;
1613}
1614
1615sub cat_vet {
1616 my ($vet) = @_;
1617 my ($res, $coded);
1618
1619 $res = '';
1620 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1621 $res .= $1;
1622 if ($2 ne '') {
1623 $coded = sprintf("^%c", unpack('C', $2) + 64);
1624 $res .= $coded;
1625 }
1626 }
1627 $res =~ s/$/\$/;
1628
1629 return $res;
1630}
1631
1632my $av_preprocessor = 0;
1633my $av_pending;
1634my @av_paren_type;
1635my $av_pend_colon;
1636
1637sub annotate_reset {
1638 $av_preprocessor = 0;
1639 $av_pending = '_';
1640 @av_paren_type = ('E');
1641 $av_pend_colon = 'O';
1642}
1643
1644sub annotate_values {
1645 my ($stream, $type) = @_;
1646
1647 my $res;
1648 my $var = '_' x length($stream);
1649 my $cur = $stream;
1650
1651 print "$stream\n" if ($dbg_values > 1);
1652
1653 while (length($cur)) {
1654 @av_paren_type = ('E') if ($#av_paren_type < 0);
1655 print " <" . join('', @av_paren_type) .
1656 "> <$type> <$av_pending>" if ($dbg_values > 1);
1657 if ($cur =~ /^(\s+)/o) {
1658 print "WS($1)\n" if ($dbg_values > 1);
1659 if ($1 =~ /\n/ && $av_preprocessor) {
1660 $type = pop(@av_paren_type);
1661 $av_preprocessor = 0;
1662 }
1663
1664 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1665 print "CAST($1)\n" if ($dbg_values > 1);
1666 push(@av_paren_type, $type);
1667 $type = 'c';
1668
1669 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1670 print "DECLARE($1)\n" if ($dbg_values > 1);
1671 $type = 'T';
1672
1673 } elsif ($cur =~ /^($Modifier)\s*/) {
1674 print "MODIFIER($1)\n" if ($dbg_values > 1);
1675 $type = 'T';
1676
1677 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1678 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1679 $av_preprocessor = 1;
1680 push(@av_paren_type, $type);
1681 if ($2 ne '') {
1682 $av_pending = 'N';
1683 }
1684 $type = 'E';
1685
1686 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1687 print "UNDEF($1)\n" if ($dbg_values > 1);
1688 $av_preprocessor = 1;
1689 push(@av_paren_type, $type);
1690
1691 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1692 print "PRE_START($1)\n" if ($dbg_values > 1);
1693 $av_preprocessor = 1;
1694
1695 push(@av_paren_type, $type);
1696 push(@av_paren_type, $type);
1697 $type = 'E';
1698
1699 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1700 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1701 $av_preprocessor = 1;
1702
1703 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1704
1705 $type = 'E';
1706
1707 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1708 print "PRE_END($1)\n" if ($dbg_values > 1);
1709
1710 $av_preprocessor = 1;
1711
1712 # Assume all arms of the conditional end as this
1713 # one does, and continue as if the #endif was not here.
1714 pop(@av_paren_type);
1715 push(@av_paren_type, $type);
1716 $type = 'E';
1717
1718 } elsif ($cur =~ /^(\\\n)/o) {
1719 print "PRECONT($1)\n" if ($dbg_values > 1);
1720
1721 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1722 print "ATTR($1)\n" if ($dbg_values > 1);
1723 $av_pending = $type;
1724 $type = 'N';
1725
1726 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1727 print "SIZEOF($1)\n" if ($dbg_values > 1);
1728 if (defined $2) {
1729 $av_pending = 'V';
1730 }
1731 $type = 'N';
1732
1733 } elsif ($cur =~ /^(if|while|for)\b/o) {
1734 print "COND($1)\n" if ($dbg_values > 1);
1735 $av_pending = 'E';
1736 $type = 'N';
1737
1738 } elsif ($cur =~/^(case)/o) {
1739 print "CASE($1)\n" if ($dbg_values > 1);
1740 $av_pend_colon = 'C';
1741 $type = 'N';
1742
1743 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1744 print "KEYWORD($1)\n" if ($dbg_values > 1);
1745 $type = 'N';
1746
1747 } elsif ($cur =~ /^(\()/o) {
1748 print "PAREN('$1')\n" if ($dbg_values > 1);
1749 push(@av_paren_type, $av_pending);
1750 $av_pending = '_';
1751 $type = 'N';
1752
1753 } elsif ($cur =~ /^(\))/o) {
1754 my $new_type = pop(@av_paren_type);
1755 if ($new_type ne '_') {
1756 $type = $new_type;
1757 print "PAREN('$1') -> $type\n"
1758 if ($dbg_values > 1);
1759 } else {
1760 print "PAREN('$1')\n" if ($dbg_values > 1);
1761 }
1762
1763 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1764 print "FUNC($1)\n" if ($dbg_values > 1);
1765 $type = 'V';
1766 $av_pending = 'V';
1767
1768 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1769 if (defined $2 && $type eq 'C' || $type eq 'T') {
1770 $av_pend_colon = 'B';
1771 } elsif ($type eq 'E') {
1772 $av_pend_colon = 'L';
1773 }
1774 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1775 $type = 'V';
1776
1777 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1778 print "IDENT($1)\n" if ($dbg_values > 1);
1779 $type = 'V';
1780
1781 } elsif ($cur =~ /^($Assignment)/o) {
1782 print "ASSIGN($1)\n" if ($dbg_values > 1);
1783 $type = 'N';
1784
1785 } elsif ($cur =~/^(;|{|})/) {
1786 print "END($1)\n" if ($dbg_values > 1);
1787 $type = 'E';
1788 $av_pend_colon = 'O';
1789
1790 } elsif ($cur =~/^(,)/) {
1791 print "COMMA($1)\n" if ($dbg_values > 1);
1792 $type = 'C';
1793
1794 } elsif ($cur =~ /^(\?)/o) {
1795 print "QUESTION($1)\n" if ($dbg_values > 1);
1796 $type = 'N';
1797
1798 } elsif ($cur =~ /^(:)/o) {
1799 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1800
1801 substr($var, length($res), 1, $av_pend_colon);
1802 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1803 $type = 'E';
1804 } else {
1805 $type = 'N';
1806 }
1807 $av_pend_colon = 'O';
1808
1809 } elsif ($cur =~ /^(\[)/o) {
1810 print "CLOSE($1)\n" if ($dbg_values > 1);
1811 $type = 'N';
1812
1813 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1814 my $variant;
1815
1816 print "OPV($1)\n" if ($dbg_values > 1);
1817 if ($type eq 'V') {
1818 $variant = 'B';
1819 } else {
1820 $variant = 'U';
1821 }
1822
1823 substr($var, length($res), 1, $variant);
1824 $type = 'N';
1825
1826 } elsif ($cur =~ /^($Operators)/o) {
1827 print "OP($1)\n" if ($dbg_values > 1);
1828 if ($1 ne '++' && $1 ne '--') {
1829 $type = 'N';
1830 }
1831
1832 } elsif ($cur =~ /(^.)/o) {
1833 print "C($1)\n" if ($dbg_values > 1);
1834 }
1835 if (defined $1) {
1836 $cur = substr($cur, length($1));
1837 $res .= $type x length($1);
1838 }
1839 }
1840
1841 return ($res, $var);
1842}
1843
1844sub possible {
1845 my ($possible, $line) = @_;
1846 my $notPermitted = qr{(?:
1847 ^(?:
1848 $Modifier|
1849 $Storage|
1850 $Type|
1851 DEFINE_\S+
1852 )$|
1853 ^(?:
1854 goto|
1855 return|
1856 case|
1857 else|
1858 asm|__asm__|
1859 do|
1860 \#|
1861 \#\#|
1862 )(?:\s|$)|
1863 ^(?:typedef|struct|enum)\b
1864 )}x;
1865 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1866 if ($possible !~ $notPermitted) {
1867 # Check for modifiers.
1868 $possible =~ s/\s*$Storage\s*//g;
1869 $possible =~ s/\s*$Sparse\s*//g;
1870 if ($possible =~ /^\s*$/) {
1871
1872 } elsif ($possible =~ /\s/) {
1873 $possible =~ s/\s*$Type\s*//g;
1874 for my $modifier (split(' ', $possible)) {
1875 if ($modifier !~ $notPermitted) {
1876 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1877 push(@modifierListFile, $modifier);
1878 }
1879 }
1880
1881 } else {
1882 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1883 push(@typeListFile, $possible);
1884 }
1885 build_types();
1886 } else {
1887 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1888 }
1889}
1890
1891my $prefix = '';
1892
1893sub show_type {
1894 my ($type) = @_;
1895
1896 $type =~ tr/[a-z]/[A-Z]/;
1897
1898 return defined $use_type{$type} if (scalar keys %use_type > 0);
1899
1900 return !defined $ignore_type{$type};
1901}
1902
1903sub report {
1904 my ($level, $type, $msg) = @_;
1905
1906 if (!show_type($type) ||
1907 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
1908 return 0;
1909 }
1910 my $output = '';
1911 if ($color) {
1912 if ($level eq 'ERROR') {
1913 $output .= RED;
1914 } elsif ($level eq 'WARNING') {
1915 $output .= YELLOW;
1916 } else {
1917 $output .= GREEN;
1918 }
1919 }
1920 $output .= $prefix . $level . ':';
1921 if ($show_types) {
1922 $output .= BLUE if ($color);
1923 $output .= "$type:";
1924 }
1925 $output .= RESET if ($color);
1926 $output .= ' ' . $msg . "\n";
1927
1928 if ($showfile) {
1929 my @lines = split("\n", $output, -1);
1930 splice(@lines, 1, 1);
1931 $output = join("\n", @lines);
1932 }
1933 $output = (split('\n', $output))[0] . "\n" if ($terse);
1934
1935 push(our @report, $output);
1936
1937 return 1;
1938}
1939
1940sub report_dump {
1941 our @report;
1942}
1943
1944sub fixup_current_range {
1945 my ($lineRef, $offset, $length) = @_;
1946
1947 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1948 my $o = $1;
1949 my $l = $2;
1950 my $no = $o + $offset;
1951 my $nl = $l + $length;
1952 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1953 }
1954}
1955
1956sub fix_inserted_deleted_lines {
1957 my ($linesRef, $insertedRef, $deletedRef) = @_;
1958
1959 my $range_last_linenr = 0;
1960 my $delta_offset = 0;
1961
1962 my $old_linenr = 0;
1963 my $new_linenr = 0;
1964
1965 my $next_insert = 0;
1966 my $next_delete = 0;
1967
1968 my @lines = ();
1969
1970 my $inserted = @{$insertedRef}[$next_insert++];
1971 my $deleted = @{$deletedRef}[$next_delete++];
1972
1973 foreach my $old_line (@{$linesRef}) {
1974 my $save_line = 1;
1975 my $line = $old_line; #don't modify the array
1976 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
1977 $delta_offset = 0;
1978 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1979 $range_last_linenr = $new_linenr;
1980 fixup_current_range(\$line, $delta_offset, 0);
1981 }
1982
1983 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1984 $deleted = @{$deletedRef}[$next_delete++];
1985 $save_line = 0;
1986 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1987 }
1988
1989 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1990 push(@lines, ${$inserted}{'LINE'});
1991 $inserted = @{$insertedRef}[$next_insert++];
1992 $new_linenr++;
1993 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1994 }
1995
1996 if ($save_line) {
1997 push(@lines, $line);
1998 $new_linenr++;
1999 }
2000
2001 $old_linenr++;
2002 }
2003
2004 return @lines;
2005}
2006
2007sub fix_insert_line {
2008 my ($linenr, $line) = @_;
2009
2010 my $inserted = {
2011 LINENR => $linenr,
2012 LINE => $line,
2013 };
2014 push(@fixed_inserted, $inserted);
2015}
2016
2017sub fix_delete_line {
2018 my ($linenr, $line) = @_;
2019
2020 my $deleted = {
2021 LINENR => $linenr,
2022 LINE => $line,
2023 };
2024
2025 push(@fixed_deleted, $deleted);
2026}
2027
2028sub ERROR {
2029 my ($type, $msg) = @_;
2030
2031 if (report("ERROR", $type, $msg)) {
2032 our $clean = 0;
2033 our $cnt_error++;
2034 return 1;
2035 }
2036 return 0;
2037}
2038sub WARN {
2039 my ($type, $msg) = @_;
2040
2041 if (report("WARNING", $type, $msg)) {
2042 our $clean = 0;
2043 our $cnt_warn++;
2044 return 1;
2045 }
2046 return 0;
2047}
2048sub CHK {
2049 my ($type, $msg) = @_;
2050
2051 if ($check && report("CHECK", $type, $msg)) {
2052 our $clean = 0;
2053 our $cnt_chk++;
2054 return 1;
2055 }
2056 return 0;
2057}
2058
2059sub check_absolute_file {
2060 my ($absolute, $herecurr) = @_;
2061 my $file = $absolute;
2062
2063 ##print "absolute<$absolute>\n";
2064
2065 # See if any suffix of this path is a path within the tree.
2066 while ($file =~ s@^[^/]*/@@) {
2067 if (-f "$root/$file") {
2068 ##print "file<$file>\n";
2069 last;
2070 }
2071 }
2072 if (! -f _) {
2073 return 0;
2074 }
2075
2076 # It is, so see if the prefix is acceptable.
2077 my $prefix = $absolute;
2078 substr($prefix, -length($file)) = '';
2079
2080 ##print "prefix<$prefix>\n";
2081 if ($prefix ne ".../") {
2082 WARN("USE_RELATIVE_PATH",
2083 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
2084 }
2085}
2086
2087sub trim {
2088 my ($string) = @_;
2089
2090 $string =~ s/^\s+|\s+$//g;
2091
2092 return $string;
2093}
2094
2095sub ltrim {
2096 my ($string) = @_;
2097
2098 $string =~ s/^\s+//;
2099
2100 return $string;
2101}
2102
2103sub rtrim {
2104 my ($string) = @_;
2105
2106 $string =~ s/\s+$//;
2107
2108 return $string;
2109}
2110
2111sub string_find_replace {
2112 my ($string, $find, $replace) = @_;
2113
2114 $string =~ s/$find/$replace/g;
2115
2116 return $string;
2117}
2118
2119sub tabify {
2120 my ($leading) = @_;
2121
2122 my $source_indent = 8;
2123 my $max_spaces_before_tab = $source_indent - 1;
2124 my $spaces_to_tab = " " x $source_indent;
2125
2126 #convert leading spaces to tabs
2127 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2128 #Remove spaces before a tab
2129 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2130
2131 return "$leading";
2132}
2133
2134sub pos_last_openparen {
2135 my ($line) = @_;
2136
2137 my $pos = 0;
2138
2139 my $opens = $line =~ tr/\(/\(/;
2140 my $closes = $line =~ tr/\)/\)/;
2141
2142 my $last_openparen = 0;
2143
2144 if (($opens == 0) || ($closes >= $opens)) {
2145 return -1;
2146 }
2147
2148 my $len = length($line);
2149
2150 for ($pos = 0; $pos < $len; $pos++) {
2151 my $string = substr($line, $pos);
2152 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2153 $pos += length($1) - 1;
2154 } elsif (substr($line, $pos, 1) eq '(') {
2155 $last_openparen = $pos;
2156 } elsif (index($string, '(') == -1) {
2157 last;
2158 }
2159 }
2160
2161 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
2162}
2163
2164sub process {
2165 my $filename = shift;
2166
2167 my $linenr=0;
2168 my $prevline="";
2169 my $prevrawline="";
2170 my $stashline="";
2171 my $stashrawline="";
2172
2173 my $length;
2174 my $indent;
2175 my $previndent=0;
2176 my $stashindent=0;
2177
2178 our $clean = 1;
2179 my $signoff = 0;
2180 my $is_patch = 0;
2181 my $in_header_lines = $file ? 0 : 1;
2182 my $in_commit_log = 0; #Scanning lines before patch
2183 my $has_commit_log = 0; #Encountered lines before patch
2184 my $commit_log_possible_stack_dump = 0;
2185 my $commit_log_long_line = 0;
2186 my $commit_log_has_diff = 0;
2187 my $reported_maintainer_file = 0;
2188 my $non_utf8_charset = 0;
2189
2190 my $last_blank_line = 0;
2191 my $last_coalesced_string_linenr = -1;
2192
2193 our @report = ();
2194 our $cnt_lines = 0;
2195 our $cnt_error = 0;
2196 our $cnt_warn = 0;
2197 our $cnt_chk = 0;
2198
2199 # Trace the real file/line as we go.
2200 my $realfile = '';
2201 my $realline = 0;
2202 my $realcnt = 0;
2203 my $here = '';
2204 my $context_function; #undef'd unless there's a known function
2205 my $in_comment = 0;
2206 my $comment_edge = 0;
2207 my $first_line = 0;
2208 my $p1_prefix = '';
2209
2210 my $prev_values = 'E';
2211
2212 # suppression flags
2213 my %suppress_ifbraces;
2214 my %suppress_whiletrailers;
2215 my %suppress_export;
2216 my $suppress_statement = 0;
2217
2218 my %signatures = ();
2219
2220 # Pre-scan the patch sanitizing the lines.
2221 # Pre-scan the patch looking for any __setup documentation.
2222 #
2223 my @setup_docs = ();
2224 my $setup_docs = 0;
2225
2226 my $camelcase_file_seeded = 0;
2227
2228 sanitise_line_reset();
2229 my $line;
2230 foreach my $rawline (@rawlines) {
2231 $linenr++;
2232 $line = $rawline;
2233
2234 push(@fixed, $rawline) if ($fix);
2235
2236 if ($rawline=~/^\+\+\+\s+(\S+)/) {
2237 $setup_docs = 0;
2238 if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) {
2239 $setup_docs = 1;
2240 }
2241 #next;
2242 }
2243 if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2244 $realline=$1-1;
2245 if (defined $2) {
2246 $realcnt=$3+1;
2247 } else {
2248 $realcnt=1+1;
2249 }
2250 $in_comment = 0;
2251
2252 # Guestimate if this is a continuing comment. Run
2253 # the context looking for a comment "edge". If this
2254 # edge is a close comment then we must be in a comment
2255 # at context start.
2256 my $edge;
2257 my $cnt = $realcnt;
2258 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2259 next if (defined $rawlines[$ln - 1] &&
2260 $rawlines[$ln - 1] =~ /^-/);
2261 $cnt--;
2262 #print "RAW<$rawlines[$ln - 1]>\n";
2263 last if (!defined $rawlines[$ln - 1]);
2264 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2265 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2266 ($edge) = $1;
2267 last;
2268 }
2269 }
2270 if (defined $edge && $edge eq '*/') {
2271 $in_comment = 1;
2272 }
2273
2274 # Guestimate if this is a continuing comment. If this
2275 # is the start of a diff block and this line starts
2276 # ' *' then it is very likely a comment.
2277 if (!defined $edge &&
2278 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
2279 {
2280 $in_comment = 1;
2281 }
2282
2283 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2284 sanitise_line_reset($in_comment);
2285
2286 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
2287 # Standardise the strings and chars within the input to
2288 # simplify matching -- only bother with positive lines.
2289 $line = sanitise_line($rawline);
2290 }
2291 push(@lines, $line);
2292
2293 if ($realcnt > 1) {
2294 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2295 } else {
2296 $realcnt = 0;
2297 }
2298
2299 #print "==>$rawline\n";
2300 #print "-->$line\n";
2301
2302 if ($setup_docs && $line =~ /^\+/) {
2303 push(@setup_docs, $line);
2304 }
2305 }
2306
2307 $prefix = '';
2308
2309 $realcnt = 0;
2310 $linenr = 0;
2311 $fixlinenr = -1;
2312 foreach my $line (@lines) {
2313 $linenr++;
2314 $fixlinenr++;
2315 my $sline = $line; #copy of $line
2316 $sline =~ s/$;/ /g; #with comments as spaces
2317
2318 my $rawline = $rawlines[$linenr - 1];
2319
2320#extract the line range in the file after the patch is applied
2321 if (!$in_commit_log &&
2322 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2323 my $context = $4;
2324 $is_patch = 1;
2325 $first_line = $linenr + 1;
2326 $realline=$1-1;
2327 if (defined $2) {
2328 $realcnt=$3+1;
2329 } else {
2330 $realcnt=1+1;
2331 }
2332 annotate_reset();
2333 $prev_values = 'E';
2334
2335 %suppress_ifbraces = ();
2336 %suppress_whiletrailers = ();
2337 %suppress_export = ();
2338 $suppress_statement = 0;
2339 if ($context =~ /\b(\w+)\s*\(/) {
2340 $context_function = $1;
2341 } else {
2342 undef $context_function;
2343 }
2344 next;
2345
2346# track the line number as we move through the hunk, note that
2347# new versions of GNU diff omit the leading space on completely
2348# blank context lines so we need to count that too.
2349 } elsif ($line =~ /^( |\+|$)/) {
2350 $realline++;
2351 $realcnt-- if ($realcnt != 0);
2352
2353 # Measure the line length and indent.
2354 ($length, $indent) = line_stats($rawline);
2355
2356 # Track the previous line.
2357 ($prevline, $stashline) = ($stashline, $line);
2358 ($previndent, $stashindent) = ($stashindent, $indent);
2359 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2360
2361 #warn "line<$line>\n";
2362
2363 } elsif ($realcnt == 1) {
2364 $realcnt--;
2365 }
2366
2367 my $hunk_line = ($realcnt != 0);
2368
2369 $here = "#$linenr: " if (!$file);
2370 $here = "#$realline: " if ($file);
2371
2372 my $found_file = 0;
2373 # extract the filename as it passes
2374 if ($line =~ /^diff --git.*?(\S+)$/) {
2375 $realfile = $1;
2376 $realfile =~ s@^([^/]*)/@@ if (!$file);
2377 $in_commit_log = 0;
2378 $found_file = 1;
2379 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2380 $realfile = $1;
2381 $realfile =~ s@^([^/]*)/@@ if (!$file);
2382 $in_commit_log = 0;
2383
2384 $p1_prefix = $1;
2385 if (!$file && $tree && $p1_prefix ne '' &&
2386 -e "$root/$p1_prefix") {
2387 WARN("PATCH_PREFIX",
2388 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
2389 }
2390
2391 if ($realfile =~ m@^include/asm/@) {
2392 ERROR("MODIFIED_INCLUDE_ASM",
2393 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2394 }
2395 $found_file = 1;
2396 }
2397
2398#make up the handle for any error we report on this line
2399 if ($showfile) {
2400 $prefix = "$realfile:$realline: "
2401 } elsif ($emacs) {
2402 if ($file) {
2403 $prefix = "$filename:$realline: ";
2404 } else {
2405 $prefix = "$filename:$linenr: ";
2406 }
2407 }
2408
2409 if ($found_file) {
2410 if (is_maintained_obsolete($realfile)) {
2411 WARN("OBSOLETE",
2412 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2413 }
2414 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
2415 $check = 1;
2416 } else {
2417 $check = $check_orig;
2418 }
2419 next;
2420 }
2421
2422 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
2423
2424 my $hereline = "$here\n$rawline\n";
2425 my $herecurr = "$here\n$rawline\n";
2426 my $hereprev = "$here\n$prevrawline\n$rawline\n";
2427
2428 $cnt_lines++ if ($realcnt != 0);
2429
2430# Check if the commit log has what seems like a diff which can confuse patch
2431 if ($in_commit_log && !$commit_log_has_diff &&
2432 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2433 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2434 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2435 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2436 ERROR("DIFF_IN_COMMIT_MSG",
2437 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2438 $commit_log_has_diff = 1;
2439 }
2440
2441# Check for incorrect file permissions
2442 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2443 my $permhere = $here . "FILE: $realfile\n";
2444 if ($realfile !~ m@scripts/@ &&
2445 $realfile !~ /\.(py|pl|awk|sh)$/) {
2446 ERROR("EXECUTE_PERMISSIONS",
2447 "do not set execute permissions for source files\n" . $permhere);
2448 }
2449 }
2450
2451# Check the patch for a signoff:
2452 if ($line =~ /^\s*signed-off-by:/i) {
2453 $signoff++;
2454 $in_commit_log = 0;
2455 }
2456
2457# Check if MAINTAINERS is being updated. If so, there's probably no need to
2458# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2459 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2460 $reported_maintainer_file = 1;
2461 }
2462
2463# Check signature styles
2464 if (!$in_header_lines &&
2465 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
2466 my $space_before = $1;
2467 my $sign_off = $2;
2468 my $space_after = $3;
2469 my $email = $4;
2470 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2471
2472 if ($sign_off !~ /$signature_tags/) {
2473 WARN("BAD_SIGN_OFF",
2474 "Non-standard signature: $sign_off\n" . $herecurr);
2475 }
2476 if (defined $space_before && $space_before ne "") {
2477 if (WARN("BAD_SIGN_OFF",
2478 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2479 $fix) {
2480 $fixed[$fixlinenr] =
2481 "$ucfirst_sign_off $email";
2482 }
2483 }
2484 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
2485 if (WARN("BAD_SIGN_OFF",
2486 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2487 $fix) {
2488 $fixed[$fixlinenr] =
2489 "$ucfirst_sign_off $email";
2490 }
2491
2492 }
2493 if (!defined $space_after || $space_after ne " ") {
2494 if (WARN("BAD_SIGN_OFF",
2495 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2496 $fix) {
2497 $fixed[$fixlinenr] =
2498 "$ucfirst_sign_off $email";
2499 }
2500 }
2501
2502 my ($email_name, $email_address, $comment) = parse_email($email);
2503 my $suggested_email = format_email(($email_name, $email_address));
2504 if ($suggested_email eq "") {
2505 ERROR("BAD_SIGN_OFF",
2506 "Unrecognized email address: '$email'\n" . $herecurr);
2507 } else {
2508 my $dequoted = $suggested_email;
2509 $dequoted =~ s/^"//;
2510 $dequoted =~ s/" </ </;
2511 # Don't force email to have quotes
2512 # Allow just an angle bracketed address
2513 if ("$dequoted$comment" ne $email &&
2514 "<$email_address>$comment" ne $email &&
2515 "$suggested_email$comment" ne $email) {
2516 WARN("BAD_SIGN_OFF",
2517 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
2518 }
2519 }
2520
2521# Check for duplicate signatures
2522 my $sig_nospace = $line;
2523 $sig_nospace =~ s/\s//g;
2524 $sig_nospace = lc($sig_nospace);
2525 if (defined $signatures{$sig_nospace}) {
2526 WARN("BAD_SIGN_OFF",
2527 "Duplicate signature\n" . $herecurr);
2528 } else {
2529 $signatures{$sig_nospace} = 1;
2530 }
2531 }
2532
2533# Check email subject for common tools that don't need to be mentioned
2534 if ($in_header_lines &&
2535 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2536 WARN("EMAIL_SUBJECT",
2537 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2538 }
2539
2540# Check for old stable address
2541 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2542 ERROR("STABLE_ADDRESS",
2543 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2544 }
2545
2546# Check for unwanted Gerrit info
2547 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2548 ERROR("GERRIT_CHANGE_ID",
2549 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2550 }
2551
2552# Check if the commit log is in a possible stack dump
2553 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2554 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2555 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2556 # timestamp
2557 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2558 # stack dump address
2559 $commit_log_possible_stack_dump = 1;
2560 }
2561
2562# Check for line lengths > 75 in commit log, warn once
2563 if ($in_commit_log && !$commit_log_long_line &&
2564 length($line) > 75 &&
2565 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2566 # file delta changes
2567 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2568 # filename then :
2569 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2570 # A Fixes: or Link: line
2571 $commit_log_possible_stack_dump)) {
2572 WARN("COMMIT_LOG_LONG_LINE",
2573 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2574 $commit_log_long_line = 1;
2575 }
2576
2577# Reset possible stack dump if a blank line is found
2578 if ($in_commit_log && $commit_log_possible_stack_dump &&
2579 $line =~ /^\s*$/) {
2580 $commit_log_possible_stack_dump = 0;
2581 }
2582
2583# Check for git id commit length and improperly formed commit descriptions
2584 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2585 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
2586 $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
2587 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
2588 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
2589 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2590 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
2591 my $init_char = "c";
2592 my $orig_commit = "";
2593 my $short = 1;
2594 my $long = 0;
2595 my $case = 1;
2596 my $space = 1;
2597 my $hasdesc = 0;
2598 my $hasparens = 0;
2599 my $id = '0123456789ab';
2600 my $orig_desc = "commit description";
2601 my $description = "";
2602
2603 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2604 $init_char = $1;
2605 $orig_commit = lc($2);
2606 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2607 $orig_commit = lc($1);
2608 }
2609
2610 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2611 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2612 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2613 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2614 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2615 $orig_desc = $1;
2616 $hasparens = 1;
2617 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2618 defined $rawlines[$linenr] &&
2619 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2620 $orig_desc = $1;
2621 $hasparens = 1;
2622 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2623 defined $rawlines[$linenr] &&
2624 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2625 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2626 $orig_desc = $1;
2627 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2628 $orig_desc .= " " . $1;
2629 $hasparens = 1;
2630 }
2631
2632 ($id, $description) = git_commit_info($orig_commit,
2633 $id, $orig_desc);
2634
2635 if (defined($id) &&
2636 ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
2637 ERROR("GIT_COMMIT_ID",
2638 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2639 }
2640 }
2641
Pierre-Louis Bossartf7beb512018-01-22 08:32:31 -06002642# Check for wrappage within a valid hunk of the file
2643 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
2644 ERROR("CORRUPTED_PATCH",
2645 "patch seems to be corrupt (line wrapped?)\n" .
2646 $herecurr) if (!$emitted_corrupt++);
2647 }
2648
2649# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2650 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
2651 $rawline !~ m/^$UTF8*$/) {
2652 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2653
2654 my $blank = copy_spacing($rawline);
2655 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2656 my $hereptr = "$hereline$ptr\n";
2657
2658 CHK("INVALID_UTF8",
2659 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
2660 }
2661
2662# Check if it's the start of a commit log
2663# (not a header line and we haven't seen the patch filename)
2664 if ($in_header_lines && $realfile =~ /^$/ &&
2665 !($rawline =~ /^\s+(?:\S|$)/ ||
2666 $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
2667 $in_header_lines = 0;
2668 $in_commit_log = 1;
2669 $has_commit_log = 1;
2670 }
2671
2672# Check if there is UTF-8 in a commit log when a mail header has explicitly
2673# declined it, i.e defined some charset where it is missing.
2674 if ($in_header_lines &&
2675 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2676 $1 !~ /utf-8/i) {
2677 $non_utf8_charset = 1;
2678 }
2679
2680 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
2681 $rawline =~ /$NON_ASCII_UTF8/) {
2682 WARN("UTF8_BEFORE_PATCH",
2683 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2684 }
2685
2686# Check for absolute kernel paths in commit message
2687 if ($tree && $in_commit_log) {
2688 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2689 my $file = $1;
2690
2691 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2692 check_absolute_file($1, $herecurr)) {
2693 #
2694 } else {
2695 check_absolute_file($file, $herecurr);
2696 }
2697 }
2698 }
2699
2700# Check for various typo / spelling mistakes
2701 if (defined($misspellings) &&
2702 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
2703 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
2704 my $typo = $1;
2705 my $typo_fix = $spelling_fix{lc($typo)};
2706 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2707 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2708 my $msg_level = \&WARN;
2709 $msg_level = \&CHK if ($file);
2710 if (&{$msg_level}("TYPO_SPELLING",
2711 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2712 $fix) {
2713 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2714 }
2715 }
2716 }
2717
2718# ignore non-hunk lines and lines being removed
2719 next if (!$hunk_line || $line =~ /^-/);
2720
2721#trailing whitespace
2722 if ($line =~ /^\+.*\015/) {
2723 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2724 if (ERROR("DOS_LINE_ENDINGS",
2725 "DOS line endings\n" . $herevet) &&
2726 $fix) {
2727 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
2728 }
2729 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2730 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2731 if (ERROR("TRAILING_WHITESPACE",
2732 "trailing whitespace\n" . $herevet) &&
2733 $fix) {
2734 $fixed[$fixlinenr] =~ s/\s+$//;
2735 }
2736
2737 $rpt_cleaners = 1;
2738 }
2739
2740# Check for FSF mailing addresses.
2741 if ($rawline =~ /\bwrite to the Free/i ||
2742 $rawline =~ /\b675\s+Mass\s+Ave/i ||
2743 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2744 $rawline =~ /\b51\s+Franklin\s+St/i) {
2745 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2746 my $msg_level = \&ERROR;
2747 $msg_level = \&CHK if ($file);
2748 &{$msg_level}("FSF_MAILING_ADDRESS",
2749 "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)
2750 }
2751
2752# check for Kconfig help text having a real description
2753# Only applies when adding the entry originally, after that we do not have
2754# sufficient context to determine whether it is indeed long enough.
2755 if ($realfile =~ /Kconfig/ &&
2756 $line =~ /^\+\s*config\s+/) {
2757 my $length = 0;
2758 my $cnt = $realcnt;
2759 my $ln = $linenr + 1;
2760 my $f;
2761 my $is_start = 0;
2762 my $is_end = 0;
2763 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
2764 $f = $lines[$ln - 1];
2765 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2766 $is_end = $lines[$ln - 1] =~ /^\+/;
2767
2768 next if ($f =~ /^-/);
2769 last if (!$file && $f =~ /^\@\@/);
2770
2771 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
2772 $is_start = 1;
2773 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
2774 $length = -1;
2775 }
2776
2777 $f =~ s/^.//;
2778 $f =~ s/#.*//;
2779 $f =~ s/^\s+//;
2780 next if ($f =~ /^$/);
2781 if ($f =~ /^\s*config\s/) {
2782 $is_end = 1;
2783 last;
2784 }
2785 $length++;
2786 }
2787 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2788 WARN("CONFIG_DESCRIPTION",
2789 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2790 }
2791 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2792 }
2793
2794# check for MAINTAINERS entries that don't have the right form
2795 if ($realfile =~ /^MAINTAINERS$/ &&
2796 $rawline =~ /^\+[A-Z]:/ &&
2797 $rawline !~ /^\+[A-Z]:\t\S/) {
2798 if (WARN("MAINTAINERS_STYLE",
2799 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
2800 $fix) {
2801 $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
2802 }
2803 }
2804
2805# discourage the use of boolean for type definition attributes of Kconfig options
2806 if ($realfile =~ /Kconfig/ &&
2807 $line =~ /^\+\s*\bboolean\b/) {
2808 WARN("CONFIG_TYPE_BOOLEAN",
2809 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2810 }
2811
2812 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2813 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2814 my $flag = $1;
2815 my $replacement = {
2816 'EXTRA_AFLAGS' => 'asflags-y',
2817 'EXTRA_CFLAGS' => 'ccflags-y',
2818 'EXTRA_CPPFLAGS' => 'cppflags-y',
2819 'EXTRA_LDFLAGS' => 'ldflags-y',
2820 };
2821
2822 WARN("DEPRECATED_VARIABLE",
2823 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2824 }
2825
2826# check for DT compatible documentation
2827 if (defined $root &&
2828 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2829 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2830
2831 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2832
2833 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2834 my $vp_file = $dt_path . "vendor-prefixes.txt";
2835
2836 foreach my $compat (@compats) {
2837 my $compat2 = $compat;
2838 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2839 my $compat3 = $compat;
2840 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2841 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
2842 if ( $? >> 8 ) {
2843 WARN("UNDOCUMENTED_DT_STRING",
2844 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2845 }
2846
2847 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2848 my $vendor = $1;
2849 `grep -Eq "^$vendor\\b" $vp_file`;
2850 if ( $? >> 8 ) {
2851 WARN("UNDOCUMENTED_DT_STRING",
2852 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2853 }
2854 }
2855 }
2856
2857# check we are in a valid source file if not then ignore this hunk
2858 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
2859
2860# line length limit (with some exclusions)
2861#
2862# There are a few types of lines that may extend beyond $max_line_length:
2863# logging functions like pr_info that end in a string
2864# lines with a single string
2865# #defines that are a single string
2866#
2867# There are 3 different line length message types:
2868# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
2869# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2870# LONG_LINE all other lines longer than $max_line_length
2871#
2872# if LONG_LINE is ignored, the other 2 types are also ignored
2873#
2874
2875 if ($line =~ /^\+/ && $length > $max_line_length) {
2876 my $msg_type = "LONG_LINE";
2877
2878 # Check the allowed long line types first
2879
2880 # logging functions that end in a string that starts
2881 # before $max_line_length
2882 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2883 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2884 $msg_type = "";
2885
2886 # lines with only strings (w/ possible termination)
2887 # #defines with only strings
2888 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2889 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2890 $msg_type = "";
2891
2892 # More special cases
2893 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
2894 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
2895 $msg_type = "";
2896
2897 # Otherwise set the alternate message types
2898
2899 # a comment starts before $max_line_length
2900 } elsif ($line =~ /($;[\s$;]*)$/ &&
2901 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2902 $msg_type = "LONG_LINE_COMMENT"
2903
2904 # a quoted string starts before $max_line_length
2905 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
2906 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2907 $msg_type = "LONG_LINE_STRING"
2908 }
2909
2910 if ($msg_type ne "" &&
2911 (show_type("LONG_LINE") || show_type($msg_type))) {
2912 WARN($msg_type,
2913 "line over $max_line_length characters\n" . $herecurr);
2914 }
2915 }
2916
2917# check for adding lines without a newline.
2918 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2919 WARN("MISSING_EOF_NEWLINE",
2920 "adding a line without newline at end of file\n" . $herecurr);
2921 }
2922
2923# Blackfin: use hi/lo macros
2924 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2925 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2926 my $herevet = "$here\n" . cat_vet($line) . "\n";
2927 ERROR("LO_MACRO",
2928 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
2929 }
2930 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2931 my $herevet = "$here\n" . cat_vet($line) . "\n";
2932 ERROR("HI_MACRO",
2933 "use the HI() macro, not (... >> 16)\n" . $herevet);
2934 }
2935 }
2936
2937# check we are in a valid source file C or perl if not then ignore this hunk
2938 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
2939
2940# at the beginning of a line any tabs must come first and anything
2941# more than 8 must use tabs.
2942 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2943 $rawline =~ /^\+\s* \s*/) {
2944 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2945 $rpt_cleaners = 1;
2946 if (ERROR("CODE_INDENT",
2947 "code indent should use tabs where possible\n" . $herevet) &&
2948 $fix) {
2949 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2950 }
2951 }
2952
2953# check for space before tabs.
2954 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2955 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2956 if (WARN("SPACE_BEFORE_TAB",
2957 "please, no space before tabs\n" . $herevet) &&
2958 $fix) {
2959 while ($fixed[$fixlinenr] =~
2960 s/(^\+.*) {8,8}\t/$1\t\t/) {}
2961 while ($fixed[$fixlinenr] =~
2962 s/(^\+.*) +\t/$1\t/) {}
2963 }
2964 }
2965
2966# check for && or || at the start of a line
2967 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2968 CHK("LOGICAL_CONTINUATIONS",
2969 "Logical continuations should be on the previous line\n" . $hereprev);
2970 }
2971
2972# check indentation starts on a tab stop
2973 if ($^V && $^V ge 5.10.0 &&
2974 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$))/) {
2975 my $indent = length($1);
2976 if ($indent % 8) {
2977 if (WARN("TABSTOP",
2978 "Statements should start on a tabstop\n" . $herecurr) &&
2979 $fix) {
2980 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
2981 }
2982 }
2983 }
2984
2985# check multi-line statement indentation matches previous line
2986 if ($^V && $^V ge 5.10.0 &&
2987 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2988 $prevline =~ /^\+(\t*)(.*)$/;
2989 my $oldindent = $1;
2990 my $rest = $2;
2991
2992 my $pos = pos_last_openparen($rest);
2993 if ($pos >= 0) {
2994 $line =~ /^(\+| )([ \t]*)/;
2995 my $newindent = $2;
2996
2997 my $goodtabindent = $oldindent .
2998 "\t" x ($pos / 8) .
2999 " " x ($pos % 8);
3000 my $goodspaceindent = $oldindent . " " x $pos;
3001
3002 if ($newindent ne $goodtabindent &&
3003 $newindent ne $goodspaceindent) {
3004
3005 if (CHK("PARENTHESIS_ALIGNMENT",
3006 "Alignment should match open parenthesis\n" . $hereprev) &&
3007 $fix && $line =~ /^\+/) {
3008 $fixed[$fixlinenr] =~
3009 s/^\+[ \t]*/\+$goodtabindent/;
3010 }
3011 }
3012 }
3013 }
3014
3015# check for space after cast like "(int) foo" or "(struct foo) bar"
3016# avoid checking a few false positives:
3017# "sizeof(<type>)" or "__alignof__(<type>)"
3018# function pointer declarations like "(*foo)(int) = bar;"
3019# structure definitions like "(struct foo) { 0 };"
3020# multiline macros that define functions
3021# known attributes or the __attribute__ keyword
3022 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
3023 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
3024 if (CHK("SPACING",
3025 "No space is necessary after a cast\n" . $herecurr) &&
3026 $fix) {
3027 $fixed[$fixlinenr] =~
3028 s/(\(\s*$Type\s*\))[ \t]+/$1/;
3029 }
3030 }
3031
3032# Block comment styles
3033# Networking with an initial /*
3034 if ($realfile =~ m@^(drivers/net/|net/)@ &&
3035 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
3036 $rawline =~ /^\+[ \t]*\*/ &&
3037 $realline > 2) {
3038 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
3039 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3040 }
3041
3042# Block comments use * on subsequent lines
3043 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3044 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
3045 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
3046 $rawline =~ /^\+/ && #line is new
3047 $rawline !~ /^\+[ \t]*\*/) { #no leading *
3048 WARN("BLOCK_COMMENT_STYLE",
3049 "Block comments use * on subsequent lines\n" . $hereprev);
3050 }
3051
3052# Block comments use */ on trailing lines
3053 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
3054 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3055 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3056 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
3057 WARN("BLOCK_COMMENT_STYLE",
3058 "Block comments use a trailing */ on a separate line\n" . $herecurr);
3059 }
3060
3061# Block comment * alignment
3062 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3063 $line =~ /^\+[ \t]*$;/ && #leading comment
3064 $rawline =~ /^\+[ \t]*\*/ && #leading *
3065 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
3066 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
3067 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3068 my $oldindent;
3069 $prevrawline =~ m@^\+([ \t]*/?)\*@;
3070 if (defined($1)) {
3071 $oldindent = expand_tabs($1);
3072 } else {
3073 $prevrawline =~ m@^\+(.*/?)\*@;
3074 $oldindent = expand_tabs($1);
3075 }
3076 $rawline =~ m@^\+([ \t]*)\*@;
3077 my $newindent = $1;
3078 $newindent = expand_tabs($newindent);
3079 if (length($oldindent) ne length($newindent)) {
3080 WARN("BLOCK_COMMENT_STYLE",
3081 "Block comments should align the * on each line\n" . $hereprev);
3082 }
3083 }
3084
3085# check for missing blank lines after struct/union declarations
3086# with exceptions for various attributes and macros
3087 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3088 $line =~ /^\+/ &&
3089 !($line =~ /^\+\s*$/ ||
3090 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3091 $line =~ /^\+\s*MODULE_/i ||
3092 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3093 $line =~ /^\+[a-z_]*init/ ||
3094 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3095 $line =~ /^\+\s*DECLARE/ ||
3096 $line =~ /^\+\s*builtin_[\w_]*driver/ ||
3097 $line =~ /^\+\s*__setup/)) {
3098 if (CHK("LINE_SPACING",
3099 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3100 $fix) {
3101 fix_insert_line($fixlinenr, "\+");
3102 }
3103 }
3104
3105# check for multiple consecutive blank lines
3106 if ($prevline =~ /^[\+ ]\s*$/ &&
3107 $line =~ /^\+\s*$/ &&
3108 $last_blank_line != ($linenr - 1)) {
3109 if (CHK("LINE_SPACING",
3110 "Please don't use multiple blank lines\n" . $hereprev) &&
3111 $fix) {
3112 fix_delete_line($fixlinenr, $rawline);
3113 }
3114
3115 $last_blank_line = $linenr;
3116 }
3117
3118# check for missing blank lines after declarations
3119 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3120 # actual declarations
3121 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
3122 # function pointer declarations
3123 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3124 # foo bar; where foo is some local typedef or #define
3125 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3126 # known declaration macros
3127 $prevline =~ /^\+\s+$declaration_macros/) &&
3128 # for "else if" which can look like "$Ident $Ident"
3129 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3130 # other possible extensions of declaration lines
3131 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3132 # not starting a section or a macro "\" extended line
3133 $prevline =~ /(?:\{\s*|\\)$/) &&
3134 # looks like a declaration
3135 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
3136 # function pointer declarations
3137 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3138 # foo bar; where foo is some local typedef or #define
3139 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3140 # known declaration macros
3141 $sline =~ /^\+\s+$declaration_macros/ ||
3142 # start of struct or union or enum
3143 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
3144 # start or end of block or continuation of declaration
3145 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3146 # bitfield continuation
3147 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3148 # other possible extensions of declaration lines
3149 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3150 # indentation of previous and current line are the same
3151 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
3152 if (WARN("LINE_SPACING",
3153 "Missing a blank line after declarations\n" . $hereprev) &&
3154 $fix) {
3155 fix_insert_line($fixlinenr, "\+");
3156 }
3157 }
3158
3159# check for spaces at the beginning of a line.
3160# Exceptions:
3161# 1) within comments
3162# 2) indented preprocessor commands
3163# 3) hanging labels
3164 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
3165 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3166 if (WARN("LEADING_SPACE",
3167 "please, no spaces at the start of a line\n" . $herevet) &&
3168 $fix) {
3169 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3170 }
3171 }
3172
3173# check we are in a valid C source file if not then ignore this hunk
3174 next if ($realfile !~ /\.(h|c)$/);
3175
3176# check for unusual line ending [ or (
3177 if ($line =~ /^\+.*([\[\(])\s*$/) {
3178 CHK("OPEN_ENDED_LINE",
3179 "Lines should not end with a '$1'\n" . $herecurr);
3180 }
3181
3182# check if this appears to be the start function declaration, save the name
3183 if ($sline =~ /^\+\{\s*$/ &&
3184 $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
3185 $context_function = $1;
3186 }
3187
3188# check if this appears to be the end of function declaration
3189 if ($sline =~ /^\+\}\s*$/) {
3190 undef $context_function;
3191 }
3192
3193# check indentation of any line with a bare else
3194# (but not if it is a multiple line "if (foo) return bar; else return baz;")
3195# if the previous line is a break or return and is indented 1 tab more...
3196 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3197 my $tabs = length($1) + 1;
3198 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3199 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3200 defined $lines[$linenr] &&
3201 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
3202 WARN("UNNECESSARY_ELSE",
3203 "else is not generally useful after a break or return\n" . $hereprev);
3204 }
3205 }
3206
3207# check indentation of a line with a break;
3208# if the previous line is a goto or return and is indented the same # of tabs
3209 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3210 my $tabs = $1;
3211 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3212 WARN("UNNECESSARY_BREAK",
3213 "break is not useful after a goto or return\n" . $hereprev);
3214 }
3215 }
3216
3217# check for RCS/CVS revision markers
3218 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
3219 WARN("CVS_KEYWORD",
3220 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
3221 }
3222
3223# Blackfin: don't use __builtin_bfin_[cs]sync
3224 if ($line =~ /__builtin_bfin_csync/) {
3225 my $herevet = "$here\n" . cat_vet($line) . "\n";
3226 ERROR("CSYNC",
3227 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
3228 }
3229 if ($line =~ /__builtin_bfin_ssync/) {
3230 my $herevet = "$here\n" . cat_vet($line) . "\n";
3231 ERROR("SSYNC",
3232 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
3233 }
3234
3235# check for old HOTPLUG __dev<foo> section markings
3236 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3237 WARN("HOTPLUG_SECTION",
3238 "Using $1 is unnecessary\n" . $herecurr);
3239 }
3240
3241# Check for potential 'bare' types
3242 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3243 $realline_next);
3244#print "LINE<$line>\n";
3245 if ($linenr > $suppress_statement &&
3246 $realcnt && $sline =~ /.\s*\S/) {
3247 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3248 ctx_statement_block($linenr, $realcnt, 0);
3249 $stat =~ s/\n./\n /g;
3250 $cond =~ s/\n./\n /g;
3251
3252#print "linenr<$linenr> <$stat>\n";
3253 # If this statement has no statement boundaries within
3254 # it there is no point in retrying a statement scan
3255 # until we hit end of it.
3256 my $frag = $stat; $frag =~ s/;+\s*$//;
3257 if ($frag !~ /(?:{|;)/) {
3258#print "skip<$line_nr_next>\n";
3259 $suppress_statement = $line_nr_next;
3260 }
3261
3262 # Find the real next line.
3263 $realline_next = $line_nr_next;
3264 if (defined $realline_next &&
3265 (!defined $lines[$realline_next - 1] ||
3266 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3267 $realline_next++;
3268 }
3269
3270 my $s = $stat;
3271 $s =~ s/{.*$//s;
3272
3273 # Ignore goto labels.
3274 if ($s =~ /$Ident:\*$/s) {
3275
3276 # Ignore functions being called
3277 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
3278
3279 } elsif ($s =~ /^.\s*else\b/s) {
3280
3281 # declarations always start with types
3282 } 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) {
3283 my $type = $1;
3284 $type =~ s/\s+/ /g;
3285 possible($type, "A:" . $s);
3286
3287 # definitions in global scope can only start with types
3288 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
3289 possible($1, "B:" . $s);
3290 }
3291
3292 # any (foo ... *) is a pointer cast, and foo is a type
3293 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
3294 possible($1, "C:" . $s);
3295 }
3296
3297 # Check for any sort of function declaration.
3298 # int foo(something bar, other baz);
3299 # void (*store_gdt)(x86_descr_ptr *);
3300 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3301 my ($name_len) = length($1);
3302
3303 my $ctx = $s;
3304 substr($ctx, 0, $name_len + 1, '');
3305 $ctx =~ s/\)[^\)]*$//;
3306
3307 for my $arg (split(/\s*,\s*/, $ctx)) {
3308 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3309
3310 possible($1, "D:" . $s);
3311 }
3312 }
3313 }
3314
3315 }
3316
3317#
3318# Checks which may be anchored in the context.
3319#
3320
3321# Check for switch () and associated case and default
3322# statements should be at the same indent.
3323 if ($line=~/\bswitch\s*\(.*\)/) {
3324 my $err = '';
3325 my $sep = '';
3326 my @ctx = ctx_block_outer($linenr, $realcnt);
3327 shift(@ctx);
3328 for my $ctx (@ctx) {
3329 my ($clen, $cindent) = line_stats($ctx);
3330 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3331 $indent != $cindent) {
3332 $err .= "$sep$ctx\n";
3333 $sep = '';
3334 } else {
3335 $sep = "[...]\n";
3336 }
3337 }
3338 if ($err ne '') {
3339 ERROR("SWITCH_CASE_INDENT_LEVEL",
3340 "switch and case should be at the same indent\n$hereline$err");
3341 }
3342 }
3343
3344# if/while/etc brace do not go on next line, unless defining a do while loop,
3345# or if that brace on the next line is for something else
3346 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3347 my $pre_ctx = "$1$2";
3348
3349 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
3350
3351 if ($line =~ /^\+\t{6,}/) {
3352 WARN("DEEP_INDENTATION",
3353 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3354 }
3355
3356 my $ctx_cnt = $realcnt - $#ctx - 1;
3357 my $ctx = join("\n", @ctx);
3358
3359 my $ctx_ln = $linenr;
3360 my $ctx_skip = $realcnt;
3361
3362 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3363 defined $lines[$ctx_ln - 1] &&
3364 $lines[$ctx_ln - 1] =~ /^-/)) {
3365 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3366 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
3367 $ctx_ln++;
3368 }
3369
3370 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3371 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3372
3373 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
3374 ERROR("OPEN_BRACE",
3375 "that open brace { should be on the previous line\n" .
3376 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3377 }
3378 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3379 $ctx =~ /\)\s*\;\s*$/ &&
3380 defined $lines[$ctx_ln - 1])
3381 {
3382 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3383 if ($nindent > $indent) {
3384 WARN("TRAILING_SEMICOLON",
3385 "trailing semicolon indicates no statements, indent implies otherwise\n" .
3386 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3387 }
3388 }
3389 }
3390
3391# Check relative indent for conditionals and blocks.
3392 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3393 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3394 ctx_statement_block($linenr, $realcnt, 0)
3395 if (!defined $stat);
3396 my ($s, $c) = ($stat, $cond);
3397
3398 substr($s, 0, length($c), '');
3399
3400 # remove inline comments
3401 $s =~ s/$;/ /g;
3402 $c =~ s/$;/ /g;
3403
3404 # Find out how long the conditional actually is.
3405 my @newlines = ($c =~ /\n/gs);
3406 my $cond_lines = 1 + $#newlines;
3407
3408 # Make sure we remove the line prefixes as we have
3409 # none on the first line, and are going to readd them
3410 # where necessary.
3411 $s =~ s/\n./\n/gs;
3412 while ($s =~ /\n\s+\\\n/) {
3413 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3414 }
3415
3416 # We want to check the first line inside the block
3417 # starting at the end of the conditional, so remove:
3418 # 1) any blank line termination
3419 # 2) any opening brace { on end of the line
3420 # 3) any do (...) {
3421 my $continuation = 0;
3422 my $check = 0;
3423 $s =~ s/^.*\bdo\b//;
3424 $s =~ s/^\s*{//;
3425 if ($s =~ s/^\s*\\//) {
3426 $continuation = 1;
3427 }
3428 if ($s =~ s/^\s*?\n//) {
3429 $check = 1;
3430 $cond_lines++;
3431 }
3432
3433 # Also ignore a loop construct at the end of a
3434 # preprocessor statement.
3435 if (($prevline =~ /^.\s*#\s*define\s/ ||
3436 $prevline =~ /\\\s*$/) && $continuation == 0) {
3437 $check = 0;
3438 }
3439
3440 my $cond_ptr = -1;
3441 $continuation = 0;
3442 while ($cond_ptr != $cond_lines) {
3443 $cond_ptr = $cond_lines;
3444
3445 # If we see an #else/#elif then the code
3446 # is not linear.
3447 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3448 $check = 0;
3449 }
3450
3451 # Ignore:
3452 # 1) blank lines, they should be at 0,
3453 # 2) preprocessor lines, and
3454 # 3) labels.
3455 if ($continuation ||
3456 $s =~ /^\s*?\n/ ||
3457 $s =~ /^\s*#\s*?/ ||
3458 $s =~ /^\s*$Ident\s*:/) {
3459 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
3460 if ($s =~ s/^.*?\n//) {
3461 $cond_lines++;
3462 }
3463 }
3464 }
3465
3466 my (undef, $sindent) = line_stats("+" . $s);
3467 my $stat_real = raw_line($linenr, $cond_lines);
3468
3469 # Check if either of these lines are modified, else
3470 # this is not this patch's fault.
3471 if (!defined($stat_real) ||
3472 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3473 $check = 0;
3474 }
3475 if (defined($stat_real) && $cond_lines > 1) {
3476 $stat_real = "[...]\n$stat_real";
3477 }
3478
3479 #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";
3480
3481 if ($check && $s ne '' &&
3482 (($sindent % 8) != 0 ||
3483 ($sindent < $indent) ||
3484 ($sindent == $indent &&
3485 ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
3486 ($sindent > $indent + 8))) {
3487 WARN("SUSPECT_CODE_INDENT",
3488 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3489 }
3490 }
3491
3492 # Track the 'values' across context and added lines.
3493 my $opline = $line; $opline =~ s/^./ /;
3494 my ($curr_values, $curr_vars) =
3495 annotate_values($opline . "\n", $prev_values);
3496 $curr_values = $prev_values . $curr_values;
3497 if ($dbg_values) {
3498 my $outline = $opline; $outline =~ s/\t/ /g;
3499 print "$linenr > .$outline\n";
3500 print "$linenr > $curr_values\n";
3501 print "$linenr > $curr_vars\n";
3502 }
3503 $prev_values = substr($curr_values, -1);
3504
3505#ignore lines not being added
3506 next if ($line =~ /^[^\+]/);
3507
3508# check for dereferences that span multiple lines
3509 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
3510 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
3511 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
3512 my $ref = $1;
3513 $line =~ /^.\s*($Lval)/;
3514 $ref .= $1;
3515 $ref =~ s/\s//g;
3516 WARN("MULTILINE_DEREFERENCE",
3517 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
3518 }
3519
3520# check for declarations of signed or unsigned without int
3521 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3522 my $type = $1;
3523 my $var = $2;
3524 $var = "" if (!defined $var);
3525 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
3526 my $sign = $1;
3527 my $pointer = $2;
3528
3529 $pointer = "" if (!defined $pointer);
3530
3531 if (WARN("UNSPECIFIED_INT",
3532 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3533 $fix) {
3534 my $decl = trim($sign) . " int ";
3535 my $comp_pointer = $pointer;
3536 $comp_pointer =~ s/\s//g;
3537 $decl .= $comp_pointer;
3538 $decl = rtrim($decl) if ($var eq "");
3539 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
3540 }
3541 }
3542 }
3543
3544# TEST: allow direct testing of the type matcher.
3545 if ($dbg_type) {
3546 if ($line =~ /^.\s*$Declare\s*$/) {
3547 ERROR("TEST_TYPE",
3548 "TEST: is type\n" . $herecurr);
3549 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
3550 ERROR("TEST_NOT_TYPE",
3551 "TEST: is not type ($1 is)\n". $herecurr);
3552 }
3553 next;
3554 }
3555# TEST: allow direct testing of the attribute matcher.
3556 if ($dbg_attr) {
3557 if ($line =~ /^.\s*$Modifier\s*$/) {
3558 ERROR("TEST_ATTR",
3559 "TEST: is attr\n" . $herecurr);
3560 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
3561 ERROR("TEST_NOT_ATTR",
3562 "TEST: is not attr ($1 is)\n". $herecurr);
3563 }
3564 next;
3565 }
3566
3567# check for initialisation to aggregates open brace on the next line
3568 if ($line =~ /^.\s*{/ &&
3569 $prevline =~ /(?:^|[^=])=\s*$/) {
3570 if (ERROR("OPEN_BRACE",
3571 "that open brace { should be on the previous line\n" . $hereprev) &&
3572 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3573 fix_delete_line($fixlinenr - 1, $prevrawline);
3574 fix_delete_line($fixlinenr, $rawline);
3575 my $fixedline = $prevrawline;
3576 $fixedline =~ s/\s*=\s*$/ = {/;
3577 fix_insert_line($fixlinenr, $fixedline);
3578 $fixedline = $line;
3579 $fixedline =~ s/^(.\s*)\{\s*/$1/;
3580 fix_insert_line($fixlinenr, $fixedline);
3581 }
3582 }
3583
3584#
3585# Checks which are anchored on the added line.
3586#
3587
3588# check for malformed paths in #include statements (uses RAW line)
3589 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
3590 my $path = $1;
3591 if ($path =~ m{//}) {
3592 ERROR("MALFORMED_INCLUDE",
3593 "malformed #include filename\n" . $herecurr);
3594 }
3595 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3596 ERROR("UAPI_INCLUDE",
3597 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
3598 }
3599 }
3600
3601# no C99 // comments
3602 if ($line =~ m{//}) {
3603 if (ERROR("C99_COMMENTS",
3604 "do not use C99 // comments\n" . $herecurr) &&
3605 $fix) {
3606 my $line = $fixed[$fixlinenr];
3607 if ($line =~ /\/\/(.*)$/) {
3608 my $comment = trim($1);
3609 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
3610 }
3611 }
3612 }
3613 # Remove C99 comments.
3614 $line =~ s@//.*@@;
3615 $opline =~ s@//.*@@;
3616
3617# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3618# the whole statement.
3619#print "APW <$lines[$realline_next - 1]>\n";
3620 if (defined $realline_next &&
3621 exists $lines[$realline_next - 1] &&
3622 !defined $suppress_export{$realline_next} &&
3623 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3624 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3625 # Handle definitions which produce identifiers with
3626 # a prefix:
3627 # XXX(foo);
3628 # EXPORT_SYMBOL(something_foo);
3629 my $name = $1;
3630 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
3631 $name =~ /^${Ident}_$2/) {
3632#print "FOO C name<$name>\n";
3633 $suppress_export{$realline_next} = 1;
3634
3635 } elsif ($stat !~ /(?:
3636 \n.}\s*$|
3637 ^.DEFINE_$Ident\(\Q$name\E\)|
3638 ^.DECLARE_$Ident\(\Q$name\E\)|
3639 ^.LIST_HEAD\(\Q$name\E\)|
3640 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3641 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
3642 )/x) {
3643#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3644 $suppress_export{$realline_next} = 2;
3645 } else {
3646 $suppress_export{$realline_next} = 1;
3647 }
3648 }
3649 if (!defined $suppress_export{$linenr} &&
3650 $prevline =~ /^.\s*$/ &&
3651 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3652 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3653#print "FOO B <$lines[$linenr - 1]>\n";
3654 $suppress_export{$linenr} = 2;
3655 }
3656 if (defined $suppress_export{$linenr} &&
3657 $suppress_export{$linenr} == 2) {
3658 WARN("EXPORT_SYMBOL",
3659 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
3660 }
3661
3662# check for global initialisers.
3663 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
3664 if (ERROR("GLOBAL_INITIALISERS",
3665 "do not initialise globals to $1\n" . $herecurr) &&
3666 $fix) {
3667 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
3668 }
3669 }
3670# check for static initialisers.
3671 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
3672 if (ERROR("INITIALISED_STATIC",
3673 "do not initialise statics to $1\n" .
3674 $herecurr) &&
3675 $fix) {
3676 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
3677 }
3678 }
3679
3680# check for misordered declarations of char/short/int/long with signed/unsigned
3681 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3682 my $tmp = trim($1);
3683 WARN("MISORDERED_TYPE",
3684 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3685 }
3686
3687# check for static const char * arrays.
3688 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
3689 WARN("STATIC_CONST_CHAR_ARRAY",
3690 "static const char * array should probably be static const char * const\n" .
3691 $herecurr);
3692 }
3693
3694# check for static char foo[] = "bar" declarations.
3695 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
3696 WARN("STATIC_CONST_CHAR_ARRAY",
3697 "static char array declaration should probably be static const char\n" .
3698 $herecurr);
3699 }
3700
3701# check for const <foo> const where <foo> is not a pointer or array type
3702 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3703 my $found = $1;
3704 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3705 WARN("CONST_CONST",
3706 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3707 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3708 WARN("CONST_CONST",
3709 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3710 }
3711 }
3712
3713# check for non-global char *foo[] = {"bar", ...} declarations.
3714 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3715 WARN("STATIC_CONST_CHAR_ARRAY",
3716 "char * array declaration might be better as static const\n" .
3717 $herecurr);
3718 }
3719
3720# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3721 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3722 my $array = $1;
3723 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3724 my $array_div = $1;
3725 if (WARN("ARRAY_SIZE",
3726 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3727 $fix) {
3728 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3729 }
3730 }
3731 }
3732
3733# check for function declarations without arguments like "int foo()"
3734 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3735 if (ERROR("FUNCTION_WITHOUT_ARGS",
3736 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3737 $fix) {
3738 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
3739 }
3740 }
3741
3742# check for new typedefs, only function parameters and sparse annotations
3743# make sense.
3744 if ($line =~ /\btypedef\s/ &&
3745 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
3746 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
3747 $line !~ /\b$typeTypedefs\b/ &&
3748 $line !~ /\b__bitwise\b/) {
3749 WARN("NEW_TYPEDEFS",
3750 "do not add new typedefs\n" . $herecurr);
3751 }
3752
3753# * goes on variable not on type
3754 # (char*[ const])
3755 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3756 #print "AA<$1>\n";
3757 my ($ident, $from, $to) = ($1, $2, $2);
3758
3759 # Should start with a space.
3760 $to =~ s/^(\S)/ $1/;
3761 # Should not end with a space.
3762 $to =~ s/\s+$//;
3763 # '*'s should not have spaces between.
3764 while ($to =~ s/\*\s+\*/\*\*/) {
3765 }
3766
3767## print "1: from<$from> to<$to> ident<$ident>\n";
3768 if ($from ne $to) {
3769 if (ERROR("POINTER_LOCATION",
3770 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3771 $fix) {
3772 my $sub_from = $ident;
3773 my $sub_to = $ident;
3774 $sub_to =~ s/\Q$from\E/$to/;
3775 $fixed[$fixlinenr] =~
3776 s@\Q$sub_from\E@$sub_to@;
3777 }
3778 }
3779 }
3780 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3781 #print "BB<$1>\n";
3782 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
3783
3784 # Should start with a space.
3785 $to =~ s/^(\S)/ $1/;
3786 # Should not end with a space.
3787 $to =~ s/\s+$//;
3788 # '*'s should not have spaces between.
3789 while ($to =~ s/\*\s+\*/\*\*/) {
3790 }
3791 # Modifiers should have spaces.
3792 $to =~ s/(\b$Modifier$)/$1 /;
3793
3794## print "2: from<$from> to<$to> ident<$ident>\n";
3795 if ($from ne $to && $ident !~ /^$Modifier$/) {
3796 if (ERROR("POINTER_LOCATION",
3797 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3798 $fix) {
3799
3800 my $sub_from = $match;
3801 my $sub_to = $match;
3802 $sub_to =~ s/\Q$from\E/$to/;
3803 $fixed[$fixlinenr] =~
3804 s@\Q$sub_from\E@$sub_to@;
3805 }
3806 }
3807 }
3808
3809# avoid BUG() or BUG_ON()
3810 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
3811 my $msg_level = \&WARN;
3812 $msg_level = \&CHK if ($file);
3813 &{$msg_level}("AVOID_BUG",
3814 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3815 }
3816
3817# avoid LINUX_VERSION_CODE
3818 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
3819 WARN("LINUX_VERSION_CODE",
3820 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3821 }
3822
3823# check for uses of printk_ratelimit
3824 if ($line =~ /\bprintk_ratelimit\s*\(/) {
3825 WARN("PRINTK_RATELIMITED",
3826 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
3827 }
3828
3829# printk should use KERN_* levels
3830 if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
3831 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3832 "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
3833 }
3834
3835 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3836 my $orig = $1;
3837 my $level = lc($orig);
3838 $level = "warn" if ($level eq "warning");
3839 my $level2 = $level;
3840 $level2 = "dbg" if ($level eq "debug");
3841 WARN("PREFER_PR_LEVEL",
3842 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
3843 }
3844
3845 if ($line =~ /\bpr_warning\s*\(/) {
3846 if (WARN("PREFER_PR_LEVEL",
3847 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3848 $fix) {
3849 $fixed[$fixlinenr] =~
3850 s/\bpr_warning\b/pr_warn/;
3851 }
3852 }
3853
3854 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3855 my $orig = $1;
3856 my $level = lc($orig);
3857 $level = "warn" if ($level eq "warning");
3858 $level = "dbg" if ($level eq "debug");
3859 WARN("PREFER_DEV_LEVEL",
3860 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3861 }
3862
3863# ENOSYS means "bad syscall nr" and nothing else. This will have a small
3864# number of false positives, but assembly files are not checked, so at
3865# least the arch entry code will not trigger this warning.
3866 if ($line =~ /\bENOSYS\b/) {
3867 WARN("ENOSYS",
3868 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3869 }
3870
3871# function brace can't be on same line, except for #defines of do while,
3872# or if closed on same line
3873 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
3874 !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) {
3875 if (ERROR("OPEN_BRACE",
3876 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3877 $fix) {
3878 fix_delete_line($fixlinenr, $rawline);
3879 my $fixed_line = $rawline;
3880 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3881 my $line1 = $1;
3882 my $line2 = $2;
3883 fix_insert_line($fixlinenr, ltrim($line1));
3884 fix_insert_line($fixlinenr, "\+{");
3885 if ($line2 !~ /^\s*$/) {
3886 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3887 }
3888 }
3889 }
3890
3891# open braces for enum, union and struct go on the same line.
3892 if ($line =~ /^.\s*{/ &&
3893 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
3894 if (ERROR("OPEN_BRACE",
3895 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3896 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3897 fix_delete_line($fixlinenr - 1, $prevrawline);
3898 fix_delete_line($fixlinenr, $rawline);
3899 my $fixedline = rtrim($prevrawline) . " {";
3900 fix_insert_line($fixlinenr, $fixedline);
3901 $fixedline = $rawline;
3902 $fixedline =~ s/^(.\s*)\{\s*/$1\t/;
3903 if ($fixedline !~ /^\+\s*$/) {
3904 fix_insert_line($fixlinenr, $fixedline);
3905 }
3906 }
3907 }
3908
3909# missing space after union, struct or enum definition
3910 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3911 if (WARN("SPACING",
3912 "missing space after $1 definition\n" . $herecurr) &&
3913 $fix) {
3914 $fixed[$fixlinenr] =~
3915 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3916 }
3917 }
3918
3919# Function pointer declarations
3920# check spacing between type, funcptr, and args
3921# canonical declaration is "type (*funcptr)(args...)"
3922 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
3923 my $declare = $1;
3924 my $pre_pointer_space = $2;
3925 my $post_pointer_space = $3;
3926 my $funcname = $4;
3927 my $post_funcname_space = $5;
3928 my $pre_args_space = $6;
3929
3930# the $Declare variable will capture all spaces after the type
3931# so check it for a missing trailing missing space but pointer return types
3932# don't need a space so don't warn for those.
3933 my $post_declare_space = "";
3934 if ($declare =~ /(\s+)$/) {
3935 $post_declare_space = $1;
3936 $declare = rtrim($declare);
3937 }
3938 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
3939 WARN("SPACING",
3940 "missing space after return type\n" . $herecurr);
3941 $post_declare_space = " ";
3942 }
3943
3944# unnecessary space "type (*funcptr)(args...)"
3945# This test is not currently implemented because these declarations are
3946# equivalent to
3947# int foo(int bar, ...)
3948# and this is form shouldn't/doesn't generate a checkpatch warning.
3949#
3950# elsif ($declare =~ /\s{2,}$/) {
3951# WARN("SPACING",
3952# "Multiple spaces after return type\n" . $herecurr);
3953# }
3954
3955# unnecessary space "type ( *funcptr)(args...)"
3956 if (defined $pre_pointer_space &&
3957 $pre_pointer_space =~ /^\s/) {
3958 WARN("SPACING",
3959 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3960 }
3961
3962# unnecessary space "type (* funcptr)(args...)"
3963 if (defined $post_pointer_space &&
3964 $post_pointer_space =~ /^\s/) {
3965 WARN("SPACING",
3966 "Unnecessary space before function pointer name\n" . $herecurr);
3967 }
3968
3969# unnecessary space "type (*funcptr )(args...)"
3970 if (defined $post_funcname_space &&
3971 $post_funcname_space =~ /^\s/) {
3972 WARN("SPACING",
3973 "Unnecessary space after function pointer name\n" . $herecurr);
3974 }
3975
3976# unnecessary space "type (*funcptr) (args...)"
3977 if (defined $pre_args_space &&
3978 $pre_args_space =~ /^\s/) {
3979 WARN("SPACING",
3980 "Unnecessary space before function pointer arguments\n" . $herecurr);
3981 }
3982
3983 if (show_type("SPACING") && $fix) {
3984 $fixed[$fixlinenr] =~
3985 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3986 }
3987 }
3988
3989# check for spacing round square brackets; allowed:
3990# 1. with a type on the left -- int [] a;
3991# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3992# 3. inside a curly brace -- = { [0...10] = 5 }
3993 while ($line =~ /(.*?\s)\[/g) {
3994 my ($where, $prefix) = ($-[1], $1);
3995 if ($prefix !~ /$Type\s+$/ &&
3996 ($where != 0 || $prefix !~ /^.\s+$/) &&
3997 $prefix !~ /[{,]\s+$/) {
3998 if (ERROR("BRACKET_SPACE",
3999 "space prohibited before open square bracket '['\n" . $herecurr) &&
4000 $fix) {
4001 $fixed[$fixlinenr] =~
4002 s/^(\+.*?)\s+\[/$1\[/;
4003 }
4004 }
4005 }
4006
4007# check for spaces between functions and their parentheses.
4008 while ($line =~ /($Ident)\s+\(/g) {
4009 my $name = $1;
4010 my $ctx_before = substr($line, 0, $-[1]);
4011 my $ctx = "$ctx_before$name";
4012
4013 # Ignore those directives where spaces _are_ permitted.
4014 if ($name =~ /^(?:
4015 if|for|while|switch|return|case|
4016 volatile|__volatile__|
4017 __attribute__|format|__extension__|
4018 asm|__asm__)$/x)
4019 {
4020 # cpp #define statements have non-optional spaces, ie
4021 # if there is a space between the name and the open
4022 # parenthesis it is simply not a parameter group.
4023 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
4024
4025 # cpp #elif statement condition may start with a (
4026 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
4027
4028 # If this whole things ends with a type its most
4029 # likely a typedef for a function.
4030 } elsif ($ctx =~ /$Type$/) {
4031
4032 } else {
4033 if (WARN("SPACING",
4034 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
4035 $fix) {
4036 $fixed[$fixlinenr] =~
4037 s/\b$name\s+\(/$name\(/;
4038 }
4039 }
4040 }
4041
4042# Check operator spacing.
4043 if (!($line=~/\#\s*include/)) {
4044 my $fixed_line = "";
4045 my $line_fixed = 0;
4046
4047 my $ops = qr{
4048 <<=|>>=|<=|>=|==|!=|
4049 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4050 =>|->|<<|>>|<|>|=|!|~|
4051 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
4052 \?:|\?|:
4053 }x;
4054 my @elements = split(/($ops|;)/, $opline);
4055
4056## print("element count: <" . $#elements . ">\n");
4057## foreach my $el (@elements) {
4058## print("el: <$el>\n");
4059## }
4060
4061 my @fix_elements = ();
4062 my $off = 0;
4063
4064 foreach my $el (@elements) {
4065 push(@fix_elements, substr($rawline, $off, length($el)));
4066 $off += length($el);
4067 }
4068
4069 $off = 0;
4070
4071 my $blank = copy_spacing($opline);
4072 my $last_after = -1;
4073
4074 for (my $n = 0; $n < $#elements; $n += 2) {
4075
4076 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4077
4078## print("n: <$n> good: <$good>\n");
4079
4080 $off += length($elements[$n]);
4081
4082 # Pick up the preceding and succeeding characters.
4083 my $ca = substr($opline, 0, $off);
4084 my $cc = '';
4085 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4086 $cc = substr($opline, $off + length($elements[$n + 1]));
4087 }
4088 my $cb = "$ca$;$cc";
4089
4090 my $a = '';
4091 $a = 'V' if ($elements[$n] ne '');
4092 $a = 'W' if ($elements[$n] =~ /\s$/);
4093 $a = 'C' if ($elements[$n] =~ /$;$/);
4094 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4095 $a = 'O' if ($elements[$n] eq '');
4096 $a = 'E' if ($ca =~ /^\s*$/);
4097
4098 my $op = $elements[$n + 1];
4099
4100 my $c = '';
4101 if (defined $elements[$n + 2]) {
4102 $c = 'V' if ($elements[$n + 2] ne '');
4103 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
4104 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
4105 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4106 $c = 'O' if ($elements[$n + 2] eq '');
4107 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
4108 } else {
4109 $c = 'E';
4110 }
4111
4112 my $ctx = "${a}x${c}";
4113
4114 my $at = "(ctx:$ctx)";
4115
4116 my $ptr = substr($blank, 0, $off) . "^";
4117 my $hereptr = "$hereline$ptr\n";
4118
4119 # Pull out the value of this operator.
4120 my $op_type = substr($curr_values, $off + 1, 1);
4121
4122 # Get the full operator variant.
4123 my $opv = $op . substr($curr_vars, $off, 1);
4124
4125 # Ignore operators passed as parameters.
4126 if ($op_type ne 'V' &&
4127 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
4128
4129# # Ignore comments
4130# } elsif ($op =~ /^$;+$/) {
4131
4132 # ; should have either the end of line or a space or \ after it
4133 } elsif ($op eq ';') {
4134 if ($ctx !~ /.x[WEBC]/ &&
4135 $cc !~ /^\\/ && $cc !~ /^;/) {
4136 if (ERROR("SPACING",
4137 "space required after that '$op' $at\n" . $hereptr)) {
4138 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
4139 $line_fixed = 1;
4140 }
4141 }
4142
4143 # // is a comment
4144 } elsif ($op eq '//') {
4145
4146 # : when part of a bitfield
4147 } elsif ($opv eq ':B') {
4148 # skip the bitfield test for now
4149
4150 # No spaces for:
4151 # ->
4152 } elsif ($op eq '->') {
4153 if ($ctx =~ /Wx.|.xW/) {
4154 if (ERROR("SPACING",
4155 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
4156 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4157 if (defined $fix_elements[$n + 2]) {
4158 $fix_elements[$n + 2] =~ s/^\s+//;
4159 }
4160 $line_fixed = 1;
4161 }
4162 }
4163
4164 # , must not have a space before and must have a space on the right.
4165 } elsif ($op eq ',') {
4166 my $rtrim_before = 0;
4167 my $space_after = 0;
4168 if ($ctx =~ /Wx./) {
4169 if (ERROR("SPACING",
4170 "space prohibited before that '$op' $at\n" . $hereptr)) {
4171 $line_fixed = 1;
4172 $rtrim_before = 1;
4173 }
4174 }
4175 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
4176 if (ERROR("SPACING",
4177 "space required after that '$op' $at\n" . $hereptr)) {
4178 $line_fixed = 1;
4179 $last_after = $n;
4180 $space_after = 1;
4181 }
4182 }
4183 if ($rtrim_before || $space_after) {
4184 if ($rtrim_before) {
4185 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4186 } else {
4187 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4188 }
4189 if ($space_after) {
4190 $good .= " ";
4191 }
4192 }
4193
4194 # '*' as part of a type definition -- reported already.
4195 } elsif ($opv eq '*_') {
4196 #warn "'*' is part of type\n";
4197
4198 # unary operators should have a space before and
4199 # none after. May be left adjacent to another
4200 # unary operator, or a cast
4201 } elsif ($op eq '!' || $op eq '~' ||
4202 $opv eq '*U' || $opv eq '-U' ||
4203 $opv eq '&U' || $opv eq '&&U') {
4204 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
4205 if (ERROR("SPACING",
4206 "space required before that '$op' $at\n" . $hereptr)) {
4207 if ($n != $last_after + 2) {
4208 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4209 $line_fixed = 1;
4210 }
4211 }
4212 }
4213 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
4214 # A unary '*' may be const
4215
4216 } elsif ($ctx =~ /.xW/) {
4217 if (ERROR("SPACING",
4218 "space prohibited after that '$op' $at\n" . $hereptr)) {
4219 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
4220 if (defined $fix_elements[$n + 2]) {
4221 $fix_elements[$n + 2] =~ s/^\s+//;
4222 }
4223 $line_fixed = 1;
4224 }
4225 }
4226
4227 # unary ++ and unary -- are allowed no space on one side.
4228 } elsif ($op eq '++' or $op eq '--') {
4229 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
4230 if (ERROR("SPACING",
4231 "space required one side of that '$op' $at\n" . $hereptr)) {
4232 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
4233 $line_fixed = 1;
4234 }
4235 }
4236 if ($ctx =~ /Wx[BE]/ ||
4237 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
4238 if (ERROR("SPACING",
4239 "space prohibited before that '$op' $at\n" . $hereptr)) {
4240 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4241 $line_fixed = 1;
4242 }
4243 }
4244 if ($ctx =~ /ExW/) {
4245 if (ERROR("SPACING",
4246 "space prohibited after that '$op' $at\n" . $hereptr)) {
4247 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4248 if (defined $fix_elements[$n + 2]) {
4249 $fix_elements[$n + 2] =~ s/^\s+//;
4250 }
4251 $line_fixed = 1;
4252 }
4253 }
4254
4255 # << and >> may either have or not have spaces both sides
4256 } elsif ($op eq '<<' or $op eq '>>' or
4257 $op eq '&' or $op eq '^' or $op eq '|' or
4258 $op eq '+' or $op eq '-' or
4259 $op eq '*' or $op eq '/' or
4260 $op eq '%')
4261 {
4262 if ($check) {
4263 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4264 if (CHK("SPACING",
4265 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4266 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4267 $fix_elements[$n + 2] =~ s/^\s+//;
4268 $line_fixed = 1;
4269 }
4270 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4271 if (CHK("SPACING",
4272 "space preferred before that '$op' $at\n" . $hereptr)) {
4273 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4274 $line_fixed = 1;
4275 }
4276 }
4277 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
4278 if (ERROR("SPACING",
4279 "need consistent spacing around '$op' $at\n" . $hereptr)) {
4280 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4281 if (defined $fix_elements[$n + 2]) {
4282 $fix_elements[$n + 2] =~ s/^\s+//;
4283 }
4284 $line_fixed = 1;
4285 }
4286 }
4287
4288 # A colon needs no spaces before when it is
4289 # terminating a case value or a label.
4290 } elsif ($opv eq ':C' || $opv eq ':L') {
4291 if ($ctx =~ /Wx./) {
4292 if (ERROR("SPACING",
4293 "space prohibited before that '$op' $at\n" . $hereptr)) {
4294 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4295 $line_fixed = 1;
4296 }
4297 }
4298
4299 # All the others need spaces both sides.
4300 } elsif ($ctx !~ /[EWC]x[CWE]/) {
4301 my $ok = 0;
4302
4303 # Ignore email addresses <foo@bar>
4304 if (($op eq '<' &&
4305 $cc =~ /^\S+\@\S+>/) ||
4306 ($op eq '>' &&
4307 $ca =~ /<\S+\@\S+$/))
4308 {
4309 $ok = 1;
4310 }
4311
4312 # for asm volatile statements
4313 # ignore a colon with another
4314 # colon immediately before or after
4315 if (($op eq ':') &&
4316 ($ca =~ /:$/ || $cc =~ /^:/)) {
4317 $ok = 1;
4318 }
4319
4320 # messages are ERROR, but ?: are CHK
4321 if ($ok == 0) {
4322 my $msg_level = \&ERROR;
4323 $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4324
4325 if (&{$msg_level}("SPACING",
4326 "spaces required around that '$op' $at\n" . $hereptr)) {
4327 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4328 if (defined $fix_elements[$n + 2]) {
4329 $fix_elements[$n + 2] =~ s/^\s+//;
4330 }
4331 $line_fixed = 1;
4332 }
4333 }
4334 }
4335 $off += length($elements[$n + 1]);
4336
4337## print("n: <$n> GOOD: <$good>\n");
4338
4339 $fixed_line = $fixed_line . $good;
4340 }
4341
4342 if (($#elements % 2) == 0) {
4343 $fixed_line = $fixed_line . $fix_elements[$#elements];
4344 }
4345
4346 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4347 $fixed[$fixlinenr] = $fixed_line;
4348 }
4349
4350
4351 }
4352
4353# check for whitespace before a non-naked semicolon
4354 if ($line =~ /^\+.*\S\s+;\s*$/) {
4355 if (WARN("SPACING",
4356 "space prohibited before semicolon\n" . $herecurr) &&
4357 $fix) {
4358 1 while $fixed[$fixlinenr] =~
4359 s/^(\+.*\S)\s+;/$1;/;
4360 }
4361 }
4362
4363# check for multiple assignments
4364 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
4365 CHK("MULTIPLE_ASSIGNMENTS",
4366 "multiple assignments should be avoided\n" . $herecurr);
4367 }
4368
4369## # check for multiple declarations, allowing for a function declaration
4370## # continuation.
4371## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4372## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4373##
4374## # Remove any bracketed sections to ensure we do not
4375## # falsly report the parameters of functions.
4376## my $ln = $line;
4377## while ($ln =~ s/\([^\(\)]*\)//g) {
4378## }
4379## if ($ln =~ /,/) {
4380## WARN("MULTIPLE_DECLARATION",
4381## "declaring multiple variables together should be avoided\n" . $herecurr);
4382## }
4383## }
4384
4385#need space before brace following if, while, etc
4386 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
4387 $line =~ /do\{/) {
4388 if (ERROR("SPACING",
4389 "space required before the open brace '{'\n" . $herecurr) &&
4390 $fix) {
4391 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\)))\{/$1 {/;
4392 }
4393 }
4394
4395## # check for blank lines before declarations
4396## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4397## $prevrawline =~ /^.\s*$/) {
4398## WARN("SPACING",
4399## "No blank lines before declarations\n" . $hereprev);
4400## }
4401##
4402
4403# closing brace should have a space following it when it has anything
4404# on the line
4405 if ($line =~ /}(?!(?:,|;|\)))\S/) {
4406 if (ERROR("SPACING",
4407 "space required after that close brace '}'\n" . $herecurr) &&
4408 $fix) {
4409 $fixed[$fixlinenr] =~
4410 s/}((?!(?:,|;|\)))\S)/} $1/;
4411 }
4412 }
4413
4414# check spacing on square brackets
4415 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
4416 if (ERROR("SPACING",
4417 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4418 $fix) {
4419 $fixed[$fixlinenr] =~
4420 s/\[\s+/\[/;
4421 }
4422 }
4423 if ($line =~ /\s\]/) {
4424 if (ERROR("SPACING",
4425 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4426 $fix) {
4427 $fixed[$fixlinenr] =~
4428 s/\s+\]/\]/;
4429 }
4430 }
4431
4432# check spacing on parentheses
4433 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4434 $line !~ /for\s*\(\s+;/) {
4435 if (ERROR("SPACING",
4436 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4437 $fix) {
4438 $fixed[$fixlinenr] =~
4439 s/\(\s+/\(/;
4440 }
4441 }
4442 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
4443 $line !~ /for\s*\(.*;\s+\)/ &&
4444 $line !~ /:\s+\)/) {
4445 if (ERROR("SPACING",
4446 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4447 $fix) {
4448 $fixed[$fixlinenr] =~
4449 s/\s+\)/\)/;
4450 }
4451 }
4452
4453# check unnecessary parentheses around addressof/dereference single $Lvals
4454# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4455
4456 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
4457 my $var = $1;
4458 if (CHK("UNNECESSARY_PARENTHESES",
4459 "Unnecessary parentheses around $var\n" . $herecurr) &&
4460 $fix) {
4461 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4462 }
4463 }
4464
4465# check for unnecessary parentheses around function pointer uses
4466# ie: (foo->bar)(); should be foo->bar();
4467# but not "if (foo->bar) (" to avoid some false positives
4468 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4469 my $var = $2;
4470 if (CHK("UNNECESSARY_PARENTHESES",
4471 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4472 $fix) {
4473 my $var2 = deparenthesize($var);
4474 $var2 =~ s/\s//g;
4475 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4476 }
4477 }
4478
4479# check for unnecessary parentheses around comparisons in if uses
4480 if ($^V && $^V ge 5.10.0 && defined($stat) &&
4481 $stat =~ /(^.\s*if\s*($balanced_parens))/) {
4482 my $if_stat = $1;
4483 my $test = substr($2, 1, -1);
4484 my $herectx;
4485 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4486 my $match = $1;
4487 # avoid parentheses around potential macro args
4488 next if ($match =~ /^\s*\w+\s*$/);
4489 if (!defined($herectx)) {
4490 $herectx = $here . "\n";
4491 my $cnt = statement_rawlines($if_stat);
4492 for (my $n = 0; $n < $cnt; $n++) {
4493 my $rl = raw_line($linenr, $n);
4494 $herectx .= $rl . "\n";
4495 last if $rl =~ /^[ \+].*\{/;
4496 }
4497 }
4498 CHK("UNNECESSARY_PARENTHESES",
4499 "Unnecessary parentheses around '$match'\n" . $herectx);
4500 }
4501 }
4502
4503#goto labels aren't indented, allow a single space however
4504 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
4505 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
4506 if (WARN("INDENTED_LABEL",
4507 "labels should not be indented\n" . $herecurr) &&
4508 $fix) {
4509 $fixed[$fixlinenr] =~
4510 s/^(.)\s+/$1/;
4511 }
4512 }
4513
4514# return is not a function
4515 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
4516 my $spacing = $1;
4517 if ($^V && $^V ge 5.10.0 &&
4518 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4519 my $value = $1;
4520 $value = deparenthesize($value);
4521 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4522 ERROR("RETURN_PARENTHESES",
4523 "return is not a function, parentheses are not required\n" . $herecurr);
4524 }
4525 } elsif ($spacing !~ /\s+/) {
4526 ERROR("SPACING",
4527 "space required before the open parenthesis '('\n" . $herecurr);
4528 }
4529 }
4530
4531# unnecessary return in a void function
4532# at end-of-function, with the previous line a single leading tab, then return;
4533# and the line before that not a goto label target like "out:"
4534 if ($sline =~ /^[ \+]}\s*$/ &&
4535 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4536 $linenr >= 3 &&
4537 $lines[$linenr - 3] =~ /^[ +]/ &&
4538 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
4539 WARN("RETURN_VOID",
4540 "void function return statements are not generally useful\n" . $hereprev);
4541 }
4542
4543# if statements using unnecessary parentheses - ie: if ((foo == bar))
4544 if ($^V && $^V ge 5.10.0 &&
4545 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4546 my $openparens = $1;
4547 my $count = $openparens =~ tr@\(@\(@;
4548 my $msg = "";
4549 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4550 my $comp = $4; #Not $1 because of $LvalOrFunc
4551 $msg = " - maybe == should be = ?" if ($comp eq "==");
4552 WARN("UNNECESSARY_PARENTHESES",
4553 "Unnecessary parentheses$msg\n" . $herecurr);
4554 }
4555 }
4556
4557# comparisons with a constant or upper case identifier on the left
4558# avoid cases like "foo + BAR < baz"
4559# only fix matches surrounded by parentheses to avoid incorrect
4560# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4561 if ($^V && $^V ge 5.10.0 &&
4562 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4563 my $lead = $1;
4564 my $const = $2;
4565 my $comp = $3;
4566 my $to = $4;
4567 my $newcomp = $comp;
4568 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
4569 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4570 WARN("CONSTANT_COMPARISON",
4571 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4572 $fix) {
4573 if ($comp eq "<") {
4574 $newcomp = ">";
4575 } elsif ($comp eq "<=") {
4576 $newcomp = ">=";
4577 } elsif ($comp eq ">") {
4578 $newcomp = "<";
4579 } elsif ($comp eq ">=") {
4580 $newcomp = "<=";
4581 }
4582 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4583 }
4584 }
4585
4586# Return of what appears to be an errno should normally be negative
4587 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
4588 my $name = $1;
4589 if ($name ne 'EOF' && $name ne 'ERROR') {
4590 WARN("USE_NEGATIVE_ERRNO",
4591 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
4592 }
4593 }
4594
4595# Need a space before open parenthesis after if, while etc
4596 if ($line =~ /\b(if|while|for|switch)\(/) {
4597 if (ERROR("SPACING",
4598 "space required before the open parenthesis '('\n" . $herecurr) &&
4599 $fix) {
4600 $fixed[$fixlinenr] =~
4601 s/\b(if|while|for|switch)\(/$1 \(/;
4602 }
4603 }
4604
4605# Check for illegal assignment in if conditional -- and check for trailing
4606# statements after the conditional.
4607 if ($line =~ /do\s*(?!{)/) {
4608 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4609 ctx_statement_block($linenr, $realcnt, 0)
4610 if (!defined $stat);
4611 my ($stat_next) = ctx_statement_block($line_nr_next,
4612 $remain_next, $off_next);
4613 $stat_next =~ s/\n./\n /g;
4614 ##print "stat<$stat> stat_next<$stat_next>\n";
4615
4616 if ($stat_next =~ /^\s*while\b/) {
4617 # If the statement carries leading newlines,
4618 # then count those as offsets.
4619 my ($whitespace) =
4620 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4621 my $offset =
4622 statement_rawlines($whitespace) - 1;
4623
4624 $suppress_whiletrailers{$line_nr_next +
4625 $offset} = 1;
4626 }
4627 }
4628 if (!defined $suppress_whiletrailers{$linenr} &&
4629 defined($stat) && defined($cond) &&
4630 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
4631 my ($s, $c) = ($stat, $cond);
4632
4633 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
4634 ERROR("ASSIGN_IN_IF",
4635 "do not use assignment in if condition\n" . $herecurr);
4636 }
4637
4638 # Find out what is on the end of the line after the
4639 # conditional.
4640 substr($s, 0, length($c), '');
4641 $s =~ s/\n.*//g;
4642 $s =~ s/$;//g; # Remove any comments
4643 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4644 $c !~ /}\s*while\s*/)
4645 {
4646 # Find out how long the conditional actually is.
4647 my @newlines = ($c =~ /\n/gs);
4648 my $cond_lines = 1 + $#newlines;
4649 my $stat_real = '';
4650
4651 $stat_real = raw_line($linenr, $cond_lines)
4652 . "\n" if ($cond_lines);
4653 if (defined($stat_real) && $cond_lines > 1) {
4654 $stat_real = "[...]\n$stat_real";
4655 }
4656
4657 ERROR("TRAILING_STATEMENTS",
4658 "trailing statements should be on next line\n" . $herecurr . $stat_real);
4659 }
4660 }
4661
4662# Check for bitwise tests written as boolean
4663 if ($line =~ /
4664 (?:
4665 (?:\[|\(|\&\&|\|\|)
4666 \s*0[xX][0-9]+\s*
4667 (?:\&\&|\|\|)
4668 |
4669 (?:\&\&|\|\|)
4670 \s*0[xX][0-9]+\s*
4671 (?:\&\&|\|\||\)|\])
4672 )/x)
4673 {
4674 WARN("HEXADECIMAL_BOOLEAN_TEST",
4675 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
4676 }
4677
4678# if and else should not have general statements after it
4679 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4680 my $s = $1;
4681 $s =~ s/$;//g; # Remove any comments
4682 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
4683 ERROR("TRAILING_STATEMENTS",
4684 "trailing statements should be on next line\n" . $herecurr);
4685 }
4686 }
4687# if should not continue a brace
4688 if ($line =~ /}\s*if\b/) {
4689 ERROR("TRAILING_STATEMENTS",
4690 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
4691 $herecurr);
4692 }
4693# case and default should not have general statements after them
4694 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4695 $line !~ /\G(?:
4696 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
4697 \s*return\s+
4698 )/xg)
4699 {
4700 ERROR("TRAILING_STATEMENTS",
4701 "trailing statements should be on next line\n" . $herecurr);
4702 }
4703
4704 # Check for }<nl>else {, these must be at the same
4705 # indent level to be relevant to each other.
4706 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4707 $previndent == $indent) {
4708 if (ERROR("ELSE_AFTER_BRACE",
4709 "else should follow close brace '}'\n" . $hereprev) &&
4710 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4711 fix_delete_line($fixlinenr - 1, $prevrawline);
4712 fix_delete_line($fixlinenr, $rawline);
4713 my $fixedline = $prevrawline;
4714 $fixedline =~ s/}\s*$//;
4715 if ($fixedline !~ /^\+\s*$/) {
4716 fix_insert_line($fixlinenr, $fixedline);
4717 }
4718 $fixedline = $rawline;
4719 $fixedline =~ s/^(.\s*)else/$1} else/;
4720 fix_insert_line($fixlinenr, $fixedline);
4721 }
4722 }
4723
4724 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4725 $previndent == $indent) {
4726 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4727
4728 # Find out what is on the end of the line after the
4729 # conditional.
4730 substr($s, 0, length($c), '');
4731 $s =~ s/\n.*//g;
4732
4733 if ($s =~ /^\s*;/) {
4734 if (ERROR("WHILE_AFTER_BRACE",
4735 "while should follow close brace '}'\n" . $hereprev) &&
4736 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4737 fix_delete_line($fixlinenr - 1, $prevrawline);
4738 fix_delete_line($fixlinenr, $rawline);
4739 my $fixedline = $prevrawline;
4740 my $trailing = $rawline;
4741 $trailing =~ s/^\+//;
4742 $trailing = trim($trailing);
4743 $fixedline =~ s/}\s*$/} $trailing/;
4744 fix_insert_line($fixlinenr, $fixedline);
4745 }
4746 }
4747 }
4748
4749#Specific variable tests
4750 while ($line =~ m{($Constant|$Lval)}g) {
4751 my $var = $1;
4752
4753#gcc binary extension
4754 if ($var =~ /^$Binary$/) {
4755 if (WARN("GCC_BINARY_CONSTANT",
4756 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4757 $fix) {
4758 my $hexval = sprintf("0x%x", oct($var));
4759 $fixed[$fixlinenr] =~
4760 s/\b$var\b/$hexval/;
4761 }
4762 }
4763
4764#CamelCase
4765 if ($var !~ /^$Constant$/ &&
4766 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
4767#Ignore Page<foo> variants
4768 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
4769#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4770 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4771#Ignore some three character SI units explicitly, like MiB and KHz
4772 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
4773 while ($var =~ m{($Ident)}g) {
4774 my $word = $1;
4775 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
4776 if ($check) {
4777 seed_camelcase_includes();
4778 if (!$file && !$camelcase_file_seeded) {
4779 seed_camelcase_file($realfile);
4780 $camelcase_file_seeded = 1;
4781 }
4782 }
4783 if (!defined $camelcase{$word}) {
4784 $camelcase{$word} = 1;
4785 CHK("CAMELCASE",
4786 "Avoid CamelCase: <$word>\n" . $herecurr);
4787 }
4788 }
4789 }
4790 }
4791
4792#no spaces allowed after \ in define
4793 if ($line =~ /\#\s*define.*\\\s+$/) {
4794 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4795 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4796 $fix) {
4797 $fixed[$fixlinenr] =~ s/\s+$//;
4798 }
4799 }
4800
4801# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4802# itself <asm/foo.h> (uses RAW line)
4803 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
4804 my $file = "$1.h";
4805 my $checkfile = "include/linux/$file";
4806 if (-f "$root/$checkfile" &&
4807 $realfile ne $checkfile &&
4808 $1 !~ /$allowed_asm_includes/)
4809 {
4810 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4811 if ($asminclude > 0) {
4812 if ($realfile =~ m{^arch/}) {
4813 CHK("ARCH_INCLUDE_LINUX",
4814 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4815 } else {
4816 WARN("INCLUDE_LINUX",
4817 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4818 }
4819 }
4820 }
4821 }
4822
4823# multi-statement macros should be enclosed in a do while loop, grab the
4824# first statement and ensure its the whole macro if its not enclosed
4825# in a known good container
4826 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4827 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
4828 my $ln = $linenr;
4829 my $cnt = $realcnt;
4830 my ($off, $dstat, $dcond, $rest);
4831 my $ctx = '';
4832 my $has_flow_statement = 0;
4833 my $has_arg_concat = 0;
4834 ($dstat, $dcond, $ln, $cnt, $off) =
4835 ctx_statement_block($linenr, $realcnt, 0);
4836 $ctx = $dstat;
4837 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4838 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4839
4840 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
4841 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
4842
4843 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
4844 my $define_args = $1;
4845 my $define_stmt = $dstat;
4846 my @def_args = ();
4847
4848 if (defined $define_args && $define_args ne "") {
4849 $define_args = substr($define_args, 1, length($define_args) - 2);
4850 $define_args =~ s/\s*//g;
4851 @def_args = split(",", $define_args);
4852 }
4853
4854 $dstat =~ s/$;//g;
4855 $dstat =~ s/\\\n.//g;
4856 $dstat =~ s/^\s*//s;
4857 $dstat =~ s/\s*$//s;
4858
4859 # Flatten any parentheses and braces
4860 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4861 $dstat =~ s/\{[^\{\}]*\}/1/ ||
4862 $dstat =~ s/.\[[^\[\]]*\]/1/)
4863 {
4864 }
4865
4866 # Flatten any obvious string concatentation.
4867 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4868 $dstat =~ s/$Ident\s*($String)/$1/)
4869 {
4870 }
4871
4872 # Make asm volatile uses seem like a generic function
4873 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
4874
4875 my $exceptions = qr{
4876 $Declare|
4877 module_param_named|
4878 MODULE_PARM_DESC|
4879 DECLARE_PER_CPU|
4880 DEFINE_PER_CPU|
4881 __typeof__\(|
4882 union|
4883 struct|
4884 \.$Ident\s*=\s*|
4885 ^\"|\"$|
4886 ^\[
4887 }x;
4888 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4889
4890 $ctx =~ s/\n*$//;
4891 my $herectx = $here . "\n";
4892 my $stmt_cnt = statement_rawlines($ctx);
4893
4894 for (my $n = 0; $n < $stmt_cnt; $n++) {
4895 $herectx .= raw_line($linenr, $n) . "\n";
4896 }
4897
4898 if ($dstat ne '' &&
4899 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4900 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
4901 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4902 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
4903 $dstat !~ /$exceptions/ &&
4904 $dstat !~ /^\.$Ident\s*=/ && # .foo =
4905 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
4906 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
4907 $dstat !~ /^for\s*$Constant$/ && # for (...)
4908 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4909 $dstat !~ /^do\s*{/ && # do {...
4910 $dstat !~ /^\(\{/ && # ({...
4911 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
4912 {
4913 if ($dstat =~ /^\s*if\b/) {
4914 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4915 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
4916 } elsif ($dstat =~ /;/) {
4917 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4918 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4919 } else {
4920 ERROR("COMPLEX_MACRO",
4921 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
4922 }
4923
4924 }
4925
4926 # Make $define_stmt single line, comment-free, etc
4927 my @stmt_array = split('\n', $define_stmt);
4928 my $first = 1;
4929 $define_stmt = "";
4930 foreach my $l (@stmt_array) {
4931 $l =~ s/\\$//;
4932 if ($first) {
4933 $define_stmt = $l;
4934 $first = 0;
4935 } elsif ($l =~ /^[\+ ]/) {
4936 $define_stmt .= substr($l, 1);
4937 }
4938 }
4939 $define_stmt =~ s/$;//g;
4940 $define_stmt =~ s/\s+/ /g;
4941 $define_stmt = trim($define_stmt);
4942
4943# check if any macro arguments are reused (ignore '...' and 'type')
4944 foreach my $arg (@def_args) {
4945 next if ($arg =~ /\.\.\./);
4946 next if ($arg =~ /^type$/i);
4947 my $tmp_stmt = $define_stmt;
4948 $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
4949 $tmp_stmt =~ s/\#+\s*$arg\b//g;
4950 $tmp_stmt =~ s/\b$arg\s*\#\#//g;
4951 my $use_cnt = $tmp_stmt =~ s/\b$arg\b//g;
4952 if ($use_cnt > 1) {
4953 CHK("MACRO_ARG_REUSE",
4954 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
4955 }
4956# check if any macro arguments may have other precedence issues
4957 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
4958 ((defined($1) && $1 ne ',') ||
4959 (defined($2) && $2 ne ','))) {
4960 CHK("MACRO_ARG_PRECEDENCE",
4961 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
4962 }
4963 }
4964
4965# check for macros with flow control, but without ## concatenation
4966# ## concatenation is commonly a macro that defines a function so ignore those
4967 if ($has_flow_statement && !$has_arg_concat) {
4968 my $herectx = $here . "\n";
4969 my $cnt = statement_rawlines($ctx);
4970
4971 for (my $n = 0; $n < $cnt; $n++) {
4972 $herectx .= raw_line($linenr, $n) . "\n";
4973 }
4974 WARN("MACRO_WITH_FLOW_CONTROL",
4975 "Macros with flow control statements should be avoided\n" . "$herectx");
4976 }
4977
4978# check for line continuations outside of #defines, preprocessor #, and asm
4979
4980 } else {
4981 if ($prevline !~ /^..*\\$/ &&
4982 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4983 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
4984 $line =~ /^\+.*\\$/) {
4985 WARN("LINE_CONTINUATIONS",
4986 "Avoid unnecessary line continuations\n" . $herecurr);
4987 }
4988 }
4989
4990# do {} while (0) macro tests:
4991# single-statement macros do not need to be enclosed in do while (0) loop,
4992# macro should not end with a semicolon
4993 if ($^V && $^V ge 5.10.0 &&
4994 $realfile !~ m@/vmlinux.lds.h$@ &&
4995 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4996 my $ln = $linenr;
4997 my $cnt = $realcnt;
4998 my ($off, $dstat, $dcond, $rest);
4999 my $ctx = '';
5000 ($dstat, $dcond, $ln, $cnt, $off) =
5001 ctx_statement_block($linenr, $realcnt, 0);
5002 $ctx = $dstat;
5003
5004 $dstat =~ s/\\\n.//g;
5005 $dstat =~ s/$;/ /g;
5006
5007 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5008 my $stmts = $2;
5009 my $semis = $3;
5010
5011 $ctx =~ s/\n*$//;
5012 my $cnt = statement_rawlines($ctx);
5013 my $herectx = $here . "\n";
5014
5015 for (my $n = 0; $n < $cnt; $n++) {
5016 $herectx .= raw_line($linenr, $n) . "\n";
5017 }
5018
5019 if (($stmts =~ tr/;/;/) == 1 &&
5020 $stmts !~ /^\s*(if|while|for|switch)\b/) {
5021 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
5022 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
5023 }
5024 if (defined $semis && $semis ne "") {
5025 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
5026 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
5027 }
5028 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
5029 $ctx =~ s/\n*$//;
5030 my $cnt = statement_rawlines($ctx);
5031 my $herectx = $here . "\n";
5032
5033 for (my $n = 0; $n < $cnt; $n++) {
5034 $herectx .= raw_line($linenr, $n) . "\n";
5035 }
5036
5037 WARN("TRAILING_SEMICOLON",
5038 "macros should not use a trailing semicolon\n" . "$herectx");
5039 }
5040 }
5041
5042# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
5043# all assignments may have only one of the following with an assignment:
5044# .
5045# ALIGN(...)
5046# VMLINUX_SYMBOL(...)
5047 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
5048 WARN("MISSING_VMLINUX_SYMBOL",
5049 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
5050 }
5051
5052# check for redundant bracing round if etc
5053 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
5054 my ($level, $endln, @chunks) =
5055 ctx_statement_full($linenr, $realcnt, 1);
5056 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
5057 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5058 if ($#chunks > 0 && $level == 0) {
5059 my @allowed = ();
5060 my $allow = 0;
5061 my $seen = 0;
5062 my $herectx = $here . "\n";
5063 my $ln = $linenr - 1;
5064 for my $chunk (@chunks) {
5065 my ($cond, $block) = @{$chunk};
5066
5067 # If the condition carries leading newlines, then count those as offsets.
5068 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5069 my $offset = statement_rawlines($whitespace) - 1;
5070
5071 $allowed[$allow] = 0;
5072 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5073
5074 # We have looked at and allowed this specific line.
5075 $suppress_ifbraces{$ln + $offset} = 1;
5076
5077 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
5078 $ln += statement_rawlines($block) - 1;
5079
5080 substr($block, 0, length($cond), '');
5081
5082 $seen++ if ($block =~ /^\s*{/);
5083
5084 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5085 if (statement_lines($cond) > 1) {
5086 #print "APW: ALLOWED: cond<$cond>\n";
5087 $allowed[$allow] = 1;
5088 }
5089 if ($block =~/\b(?:if|for|while)\b/) {
5090 #print "APW: ALLOWED: block<$block>\n";
5091 $allowed[$allow] = 1;
5092 }
5093 if (statement_block_size($block) > 1) {
5094 #print "APW: ALLOWED: lines block<$block>\n";
5095 $allowed[$allow] = 1;
5096 }
5097 $allow++;
5098 }
5099 if ($seen) {
5100 my $sum_allowed = 0;
5101 foreach (@allowed) {
5102 $sum_allowed += $_;
5103 }
5104 if ($sum_allowed == 0) {
5105 WARN("BRACES",
5106 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5107 } elsif ($sum_allowed != $allow &&
5108 $seen != $allow) {
5109 CHK("BRACES",
5110 "braces {} should be used on all arms of this statement\n" . $herectx);
5111 }
5112 }
5113 }
5114 }
5115 if (!defined $suppress_ifbraces{$linenr - 1} &&
5116 $line =~ /\b(if|while|for|else)\b/) {
5117 my $allowed = 0;
5118
5119 # Check the pre-context.
5120 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5121 #print "APW: ALLOWED: pre<$1>\n";
5122 $allowed = 1;
5123 }
5124
5125 my ($level, $endln, @chunks) =
5126 ctx_statement_full($linenr, $realcnt, $-[0]);
5127
5128 # Check the condition.
5129 my ($cond, $block) = @{$chunks[0]};
5130 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5131 if (defined $cond) {
5132 substr($block, 0, length($cond), '');
5133 }
5134 if (statement_lines($cond) > 1) {
5135 #print "APW: ALLOWED: cond<$cond>\n";
5136 $allowed = 1;
5137 }
5138 if ($block =~/\b(?:if|for|while)\b/) {
5139 #print "APW: ALLOWED: block<$block>\n";
5140 $allowed = 1;
5141 }
5142 if (statement_block_size($block) > 1) {
5143 #print "APW: ALLOWED: lines block<$block>\n";
5144 $allowed = 1;
5145 }
5146 # Check the post-context.
5147 if (defined $chunks[1]) {
5148 my ($cond, $block) = @{$chunks[1]};
5149 if (defined $cond) {
5150 substr($block, 0, length($cond), '');
5151 }
5152 if ($block =~ /^\s*\{/) {
5153 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5154 $allowed = 1;
5155 }
5156 }
5157 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
5158 my $herectx = $here . "\n";
5159 my $cnt = statement_rawlines($block);
5160
5161 for (my $n = 0; $n < $cnt; $n++) {
5162 $herectx .= raw_line($linenr, $n) . "\n";
5163 }
5164
5165 WARN("BRACES",
5166 "braces {} are not necessary for single statement blocks\n" . $herectx);
5167 }
5168 }
5169
5170# check for single line unbalanced braces
5171 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
5172 $sline =~ /^.\s*else\s*\{\s*$/) {
5173 CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
5174 }
5175
5176# check for unnecessary blank lines around braces
5177 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
5178 if (CHK("BRACES",
5179 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5180 $fix && $prevrawline =~ /^\+/) {
5181 fix_delete_line($fixlinenr - 1, $prevrawline);
5182 }
5183 }
5184 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
5185 if (CHK("BRACES",
5186 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5187 $fix) {
5188 fix_delete_line($fixlinenr, $rawline);
5189 }
5190 }
5191
5192# no volatiles please
5193 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5194 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
5195 WARN("VOLATILE",
5196 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
5197 }
5198
5199# Check for user-visible strings broken across lines, which breaks the ability
5200# to grep for the string. Make exceptions when the previous string ends in a
5201# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5202# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
5203 if ($line =~ /^\+\s*$String/ &&
5204 $prevline =~ /"\s*$/ &&
5205 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5206 if (WARN("SPLIT_STRING",
5207 "quoted string split across lines\n" . $hereprev) &&
5208 $fix &&
5209 $prevrawline =~ /^\+.*"\s*$/ &&
5210 $last_coalesced_string_linenr != $linenr - 1) {
5211 my $extracted_string = get_quoted_string($line, $rawline);
5212 my $comma_close = "";
5213 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5214 $comma_close = $1;
5215 }
5216
5217 fix_delete_line($fixlinenr - 1, $prevrawline);
5218 fix_delete_line($fixlinenr, $rawline);
5219 my $fixedline = $prevrawline;
5220 $fixedline =~ s/"\s*$//;
5221 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5222 fix_insert_line($fixlinenr - 1, $fixedline);
5223 $fixedline = $rawline;
5224 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5225 if ($fixedline !~ /\+\s*$/) {
5226 fix_insert_line($fixlinenr, $fixedline);
5227 }
5228 $last_coalesced_string_linenr = $linenr;
5229 }
5230 }
5231
5232# check for missing a space in a string concatenation
5233 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5234 WARN('MISSING_SPACE',
5235 "break quoted strings at a space character\n" . $hereprev);
5236 }
5237
5238# check for an embedded function name in a string when the function is known
5239# This does not work very well for -f --file checking as it depends on patch
5240# context providing the function name or a single line form for in-file
5241# function declarations
5242 if ($line =~ /^\+.*$String/ &&
5243 defined($context_function) &&
5244 get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
5245 length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
5246 WARN("EMBEDDED_FUNCTION_NAME",
5247 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
5248 }
5249
5250# check for spaces before a quoted newline
5251 if ($rawline =~ /^.*\".*\s\\n/) {
5252 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5253 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5254 $fix) {
5255 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5256 }
5257
5258 }
5259
5260# concatenated string without spaces between elements
5261 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
5262 CHK("CONCATENATED_STRING",
5263 "Concatenated strings should use spaces between elements\n" . $herecurr);
5264 }
5265
5266# uncoalesced string fragments
5267 if ($line =~ /$String\s*"/) {
5268 WARN("STRING_FRAGMENTS",
5269 "Consecutive strings are generally better as a single string\n" . $herecurr);
5270 }
5271
5272# check for non-standard and hex prefixed decimal printf formats
5273 my $show_L = 1; #don't show the same defect twice
5274 my $show_Z = 1;
5275 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
5276 my $string = substr($rawline, $-[1], $+[1] - $-[1]);
5277 $string =~ s/%%/__/g;
5278 # check for %L
5279 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
5280 WARN("PRINTF_L",
5281 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
5282 $show_L = 0;
5283 }
5284 # check for %Z
5285 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
5286 WARN("PRINTF_Z",
5287 "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
5288 $show_Z = 0;
5289 }
5290 # check for 0x<decimal>
5291 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
5292 ERROR("PRINTF_0XDECIMAL",
5293 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5294 }
5295 }
5296
5297# check for line continuations in quoted strings with odd counts of "
5298 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
5299 WARN("LINE_CONTINUATIONS",
5300 "Avoid line continuations in quoted strings\n" . $herecurr);
5301 }
5302
5303# warn about #if 0
5304 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
5305 CHK("REDUNDANT_CODE",
5306 "if this code is redundant consider removing it\n" .
5307 $herecurr);
5308 }
5309
5310# check for needless "if (<foo>) fn(<foo>)" uses
5311 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
5312 my $tested = quotemeta($1);
5313 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5314 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5315 my $func = $1;
5316 if (WARN('NEEDLESS_IF',
5317 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5318 $fix) {
5319 my $do_fix = 1;
5320 my $leading_tabs = "";
5321 my $new_leading_tabs = "";
5322 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5323 $leading_tabs = $1;
5324 } else {
5325 $do_fix = 0;
5326 }
5327 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5328 $new_leading_tabs = $1;
5329 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5330 $do_fix = 0;
5331 }
5332 } else {
5333 $do_fix = 0;
5334 }
5335 if ($do_fix) {
5336 fix_delete_line($fixlinenr - 1, $prevrawline);
5337 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5338 }
5339 }
5340 }
5341 }
5342
5343# check for unnecessary "Out of Memory" messages
5344 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5345 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5346 (defined $1 || defined $3) &&
5347 $linenr > 3) {
5348 my $testval = $2;
5349 my $testline = $lines[$linenr - 3];
5350
5351 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5352# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5353
5354 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|kmemdup|(?:dev_)?alloc_skb)/) {
5355 WARN("OOM_MESSAGE",
5356 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5357 }
5358 }
5359
5360# check for logging functions with KERN_<LEVEL>
5361 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
5362 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5363 my $level = $1;
5364 if (WARN("UNNECESSARY_KERN_LEVEL",
5365 "Possible unnecessary $level\n" . $herecurr) &&
5366 $fix) {
5367 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5368 }
5369 }
5370
5371# check for logging continuations
5372 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
5373 WARN("LOGGING_CONTINUATION",
5374 "Avoid logging continuation uses where feasible\n" . $herecurr);
5375 }
5376
5377# check for mask then right shift without a parentheses
5378 if ($^V && $^V ge 5.10.0 &&
5379 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5380 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5381 WARN("MASK_THEN_SHIFT",
5382 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5383 }
5384
5385# check for pointer comparisons to NULL
5386 if ($^V && $^V ge 5.10.0) {
5387 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5388 my $val = $1;
5389 my $equal = "!";
5390 $equal = "" if ($4 eq "!=");
5391 if (CHK("COMPARISON_TO_NULL",
5392 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5393 $fix) {
5394 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5395 }
5396 }
5397 }
5398
5399# check for bad placement of section $InitAttribute (e.g.: __initdata)
5400 if ($line =~ /(\b$InitAttribute\b)/) {
5401 my $attr = $1;
5402 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5403 my $ptr = $1;
5404 my $var = $2;
5405 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5406 ERROR("MISPLACED_INIT",
5407 "$attr should be placed after $var\n" . $herecurr)) ||
5408 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5409 WARN("MISPLACED_INIT",
5410 "$attr should be placed after $var\n" . $herecurr))) &&
5411 $fix) {
5412 $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;
5413 }
5414 }
5415 }
5416
5417# check for $InitAttributeData (ie: __initdata) with const
5418 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5419 my $attr = $1;
5420 $attr =~ /($InitAttributePrefix)(.*)/;
5421 my $attr_prefix = $1;
5422 my $attr_type = $2;
5423 if (ERROR("INIT_ATTRIBUTE",
5424 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5425 $fix) {
5426 $fixed[$fixlinenr] =~
5427 s/$InitAttributeData/${attr_prefix}initconst/;
5428 }
5429 }
5430
5431# check for $InitAttributeConst (ie: __initconst) without const
5432 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5433 my $attr = $1;
5434 if (ERROR("INIT_ATTRIBUTE",
5435 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5436 $fix) {
5437 my $lead = $fixed[$fixlinenr] =~
5438 /(^\+\s*(?:static\s+))/;
5439 $lead = rtrim($1);
5440 $lead = "$lead " if ($lead !~ /^\+$/);
5441 $lead = "${lead}const ";
5442 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
5443 }
5444 }
5445
5446# check for __read_mostly with const non-pointer (should just be const)
5447 if ($line =~ /\b__read_mostly\b/ &&
5448 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5449 if (ERROR("CONST_READ_MOSTLY",
5450 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5451 $fix) {
5452 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5453 }
5454 }
5455
5456# don't use __constant_<foo> functions outside of include/uapi/
5457 if ($realfile !~ m@^include/uapi/@ &&
5458 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5459 my $constant_func = $1;
5460 my $func = $constant_func;
5461 $func =~ s/^__constant_//;
5462 if (WARN("CONSTANT_CONVERSION",
5463 "$constant_func should be $func\n" . $herecurr) &&
5464 $fix) {
5465 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
5466 }
5467 }
5468
5469# prefer usleep_range over udelay
5470 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
5471 my $delay = $1;
5472 # ignore udelay's < 10, however
5473 if (! ($delay < 10) ) {
5474 CHK("USLEEP_RANGE",
5475 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5476 }
5477 if ($delay > 2000) {
5478 WARN("LONG_UDELAY",
5479 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
5480 }
5481 }
5482
5483# warn about unexpectedly long msleep's
5484 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5485 if ($1 < 20) {
5486 WARN("MSLEEP",
5487 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5488 }
5489 }
5490
5491# check for comparisons of jiffies
5492 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5493 WARN("JIFFIES_COMPARISON",
5494 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5495 }
5496
5497# check for comparisons of get_jiffies_64()
5498 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5499 WARN("JIFFIES_COMPARISON",
5500 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5501 }
5502
5503# warn about #ifdefs in C files
5504# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5505# print "#ifdef in C files should be avoided\n";
5506# print "$herecurr";
5507# $clean = 0;
5508# }
5509
5510# warn about spacing in #ifdefs
5511 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
5512 if (ERROR("SPACING",
5513 "exactly one space required after that #$1\n" . $herecurr) &&
5514 $fix) {
5515 $fixed[$fixlinenr] =~
5516 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5517 }
5518
5519 }
5520
5521# check for spinlock_t definitions without a comment.
5522 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5523 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
5524 my $which = $1;
5525 if (!ctx_has_comment($first_line, $linenr)) {
5526 CHK("UNCOMMENTED_DEFINITION",
5527 "$1 definition without comment\n" . $herecurr);
5528 }
5529 }
5530# check for memory barriers without a comment.
5531
5532 my $barriers = qr{
5533 mb|
5534 rmb|
5535 wmb|
5536 read_barrier_depends
5537 }x;
5538 my $barrier_stems = qr{
5539 mb__before_atomic|
5540 mb__after_atomic|
5541 store_release|
5542 load_acquire|
5543 store_mb|
5544 (?:$barriers)
5545 }x;
5546 my $all_barriers = qr{
5547 (?:$barriers)|
5548 smp_(?:$barrier_stems)|
5549 virt_(?:$barrier_stems)
5550 }x;
5551
5552 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
5553 if (!ctx_has_comment($first_line, $linenr)) {
5554 WARN("MEMORY_BARRIER",
5555 "memory barrier without comment\n" . $herecurr);
5556 }
5557 }
5558
5559 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5560
5561 if ($realfile !~ m@^include/asm-generic/@ &&
5562 $realfile !~ m@/barrier\.h$@ &&
5563 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5564 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5565 WARN("MEMORY_BARRIER",
5566 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5567 }
5568
5569# check for waitqueue_active without a comment.
5570 if ($line =~ /\bwaitqueue_active\s*\(/) {
5571 if (!ctx_has_comment($first_line, $linenr)) {
5572 WARN("WAITQUEUE_ACTIVE",
5573 "waitqueue_active without comment\n" . $herecurr);
5574 }
5575 }
5576
5577# check of hardware specific defines
5578 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5579 CHK("ARCH_DEFINES",
5580 "architecture specific defines should be avoided\n" . $herecurr);
5581 }
5582
5583# check that the storage class is not after a type
5584 if ($line =~ /\b($Type)\s+($Storage)\b/) {
5585 WARN("STORAGE_CLASS",
5586 "storage class '$2' should be located before type '$1'\n" . $herecurr);
5587 }
5588# Check that the storage class is at the beginning of a declaration
5589 if ($line =~ /\b$Storage\b/ &&
5590 $line !~ /^.\s*$Storage/ &&
5591 $line =~ /^.\s*(.+?)\$Storage\s/ &&
5592 $1 !~ /[\,\)]\s*$/) {
5593 WARN("STORAGE_CLASS",
5594 "storage class should be at the beginning of the declaration\n" . $herecurr);
5595 }
5596
5597# check the location of the inline attribute, that it is between
5598# storage class and type.
5599 if ($line =~ /\b$Type\s+$Inline\b/ ||
5600 $line =~ /\b$Inline\s+$Storage\b/) {
5601 ERROR("INLINE_LOCATION",
5602 "inline keyword should sit between storage class and type\n" . $herecurr);
5603 }
5604
5605# Check for __inline__ and __inline, prefer inline
5606 if ($realfile !~ m@\binclude/uapi/@ &&
5607 $line =~ /\b(__inline__|__inline)\b/) {
5608 if (WARN("INLINE",
5609 "plain inline is preferred over $1\n" . $herecurr) &&
5610 $fix) {
5611 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
5612
5613 }
5614 }
5615
5616# Check for __attribute__ packed, prefer __packed
5617 if ($realfile !~ m@\binclude/uapi/@ &&
5618 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
5619 WARN("PREFER_PACKED",
5620 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
5621 }
5622
5623# Check for __attribute__ aligned, prefer __aligned
5624 if ($realfile !~ m@\binclude/uapi/@ &&
5625 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
5626 WARN("PREFER_ALIGNED",
5627 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
5628 }
5629
5630# Check for __attribute__ format(printf, prefer __printf
5631 if ($realfile !~ m@\binclude/uapi/@ &&
5632 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
5633 if (WARN("PREFER_PRINTF",
5634 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5635 $fix) {
5636 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5637
5638 }
5639 }
5640
5641# Check for __attribute__ format(scanf, prefer __scanf
5642 if ($realfile !~ m@\binclude/uapi/@ &&
5643 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
5644 if (WARN("PREFER_SCANF",
5645 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5646 $fix) {
5647 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5648 }
5649 }
5650
5651# Check for __attribute__ weak, or __weak declarations (may have link issues)
5652 if ($^V && $^V ge 5.10.0 &&
5653 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5654 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5655 $line =~ /\b__weak\b/)) {
5656 ERROR("WEAK_DECLARATION",
5657 "Using weak declarations can have unintended link defects\n" . $herecurr);
5658 }
5659
Pierre-Louis Bossartf7beb512018-01-22 08:32:31 -06005660# check for cast of C90 native int or longer types constants
5661 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5662 my $cast = $1;
5663 my $const = $2;
5664 if (WARN("TYPECAST_INT_CONSTANT",
5665 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5666 $fix) {
5667 my $suffix = "";
5668 my $newconst = $const;
5669 $newconst =~ s/${Int_type}$//;
5670 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5671 if ($cast =~ /\blong\s+long\b/) {
5672 $suffix .= 'LL';
5673 } elsif ($cast =~ /\blong\b/) {
5674 $suffix .= 'L';
5675 }
5676 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5677 }
5678 }
5679
5680# check for sizeof(&)
5681 if ($line =~ /\bsizeof\s*\(\s*\&/) {
5682 WARN("SIZEOF_ADDRESS",
5683 "sizeof(& should be avoided\n" . $herecurr);
5684 }
5685
5686# check for sizeof without parenthesis
5687 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
5688 if (WARN("SIZEOF_PARENTHESIS",
5689 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5690 $fix) {
5691 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5692 }
5693 }
5694
5695# check for struct spinlock declarations
5696 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5697 WARN("USE_SPINLOCK_T",
5698 "struct spinlock should be spinlock_t\n" . $herecurr);
5699 }
5700
5701# check for seq_printf uses that could be seq_puts
5702 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
5703 my $fmt = get_quoted_string($line, $rawline);
5704 $fmt =~ s/%%//g;
5705 if ($fmt !~ /%/) {
5706 if (WARN("PREFER_SEQ_PUTS",
5707 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5708 $fix) {
5709 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
5710 }
5711 }
5712 }
5713
5714 # check for vsprintf extension %p<foo> misuses
5715 if ($^V && $^V ge 5.10.0 &&
5716 defined $stat &&
5717 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
5718 $1 !~ /^_*volatile_*$/) {
5719 my $bad_extension = "";
5720 my $lc = $stat =~ tr@\n@@;
5721 $lc = $lc + $linenr;
5722 for (my $count = $linenr; $count <= $lc; $count++) {
5723 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
5724 $fmt =~ s/%%//g;
5725 if ($fmt =~ /(\%[\*\d\.]*p(?![\WFfSsBKRraEhMmIiUDdgVCbGNOx]).)/) {
5726 $bad_extension = $1;
5727 last;
5728 }
5729 }
5730 if ($bad_extension ne "") {
5731 my $stat_real = raw_line($linenr, 0);
5732 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5733 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5734 }
5735 WARN("VSPRINTF_POINTER_EXTENSION",
5736 "Invalid vsprintf pointer extension '$bad_extension'\n" . "$here\n$stat_real\n");
5737 }
5738 }
5739
5740# Check for misused memsets
5741 if ($^V && $^V ge 5.10.0 &&
5742 defined $stat &&
5743 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
5744
5745 my $ms_addr = $2;
5746 my $ms_val = $7;
5747 my $ms_size = $12;
5748
5749 if ($ms_size =~ /^(0x|)0$/i) {
5750 ERROR("MEMSET",
5751 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
5752 } elsif ($ms_size =~ /^(0x|)1$/i) {
5753 WARN("MEMSET",
5754 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5755 }
5756 }
5757
5758# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5759# if ($^V && $^V ge 5.10.0 &&
5760# defined $stat &&
5761# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5762# if (WARN("PREFER_ETHER_ADDR_COPY",
5763# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5764# $fix) {
5765# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5766# }
5767# }
5768
5769# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5770# if ($^V && $^V ge 5.10.0 &&
5771# defined $stat &&
5772# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5773# WARN("PREFER_ETHER_ADDR_EQUAL",
5774# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5775# }
5776
5777# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5778# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5779# if ($^V && $^V ge 5.10.0 &&
5780# defined $stat &&
5781# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5782#
5783# my $ms_val = $7;
5784#
5785# if ($ms_val =~ /^(?:0x|)0+$/i) {
5786# if (WARN("PREFER_ETH_ZERO_ADDR",
5787# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5788# $fix) {
5789# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5790# }
5791# } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5792# if (WARN("PREFER_ETH_BROADCAST_ADDR",
5793# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5794# $fix) {
5795# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5796# }
5797# }
5798# }
5799
5800# typecasts on min/max could be min_t/max_t
5801 if ($^V && $^V ge 5.10.0 &&
5802 defined $stat &&
5803 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
5804 if (defined $2 || defined $7) {
5805 my $call = $1;
5806 my $cast1 = deparenthesize($2);
5807 my $arg1 = $3;
5808 my $cast2 = deparenthesize($7);
5809 my $arg2 = $8;
5810 my $cast;
5811
5812 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
5813 $cast = "$cast1 or $cast2";
5814 } elsif ($cast1 ne "") {
5815 $cast = $cast1;
5816 } else {
5817 $cast = $cast2;
5818 }
5819 WARN("MINMAX",
5820 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
5821 }
5822 }
5823
5824# check usleep_range arguments
5825 if ($^V && $^V ge 5.10.0 &&
5826 defined $stat &&
5827 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5828 my $min = $1;
5829 my $max = $7;
5830 if ($min eq $max) {
5831 WARN("USLEEP_RANGE",
5832 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5833 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5834 $min > $max) {
5835 WARN("USLEEP_RANGE",
5836 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5837 }
5838 }
5839
5840# check for naked sscanf
5841 if ($^V && $^V ge 5.10.0 &&
5842 defined $stat &&
5843 $line =~ /\bsscanf\b/ &&
5844 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5845 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5846 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5847 my $lc = $stat =~ tr@\n@@;
5848 $lc = $lc + $linenr;
5849 my $stat_real = raw_line($linenr, 0);
5850 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5851 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5852 }
5853 WARN("NAKED_SSCANF",
5854 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5855 }
5856
5857# check for simple sscanf that should be kstrto<foo>
5858 if ($^V && $^V ge 5.10.0 &&
5859 defined $stat &&
5860 $line =~ /\bsscanf\b/) {
5861 my $lc = $stat =~ tr@\n@@;
5862 $lc = $lc + $linenr;
5863 my $stat_real = raw_line($linenr, 0);
5864 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5865 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5866 }
5867 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5868 my $format = $6;
5869 my $count = $format =~ tr@%@%@;
5870 if ($count == 1 &&
5871 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5872 WARN("SSCANF_TO_KSTRTO",
5873 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5874 }
5875 }
5876 }
5877
5878# check for new externs in .h files.
5879 if ($realfile =~ /\.h$/ &&
5880 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
5881 if (CHK("AVOID_EXTERNS",
5882 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
5883 $fix) {
5884 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
5885 }
5886 }
5887
5888# check for new externs in .c files.
5889 if ($realfile =~ /\.c$/ && defined $stat &&
5890 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
5891 {
5892 my $function_name = $1;
5893 my $paren_space = $2;
5894
5895 my $s = $stat;
5896 if (defined $cond) {
5897 substr($s, 0, length($cond), '');
5898 }
5899 if ($s =~ /^\s*;/ &&
5900 $function_name ne 'uninitialized_var')
5901 {
5902 WARN("AVOID_EXTERNS",
5903 "externs should be avoided in .c files\n" . $herecurr);
5904 }
5905
5906 if ($paren_space =~ /\n/) {
5907 WARN("FUNCTION_ARGUMENTS",
5908 "arguments for function declarations should follow identifier\n" . $herecurr);
5909 }
5910
5911 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5912 $stat =~ /^.\s*extern\s+/)
5913 {
5914 WARN("AVOID_EXTERNS",
5915 "externs should be avoided in .c files\n" . $herecurr);
5916 }
5917
5918# check for function declarations that have arguments without identifier names
5919 if (defined $stat &&
5920 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
5921 $1 ne "void") {
5922 my $args = trim($1);
5923 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
5924 my $arg = trim($1);
5925 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
5926 WARN("FUNCTION_ARGUMENTS",
5927 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
5928 }
5929 }
5930 }
5931
5932# check for function definitions
5933 if ($^V && $^V ge 5.10.0 &&
5934 defined $stat &&
5935 $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
5936 $context_function = $1;
5937
5938# check for multiline function definition with misplaced open brace
5939 my $ok = 0;
5940 my $cnt = statement_rawlines($stat);
5941 my $herectx = $here . "\n";
5942 for (my $n = 0; $n < $cnt; $n++) {
5943 my $rl = raw_line($linenr, $n);
5944 $herectx .= $rl . "\n";
5945 $ok = 1 if ($rl =~ /^[ \+]\{/);
5946 $ok = 1 if ($rl =~ /\{/ && $n == 0);
5947 last if $rl =~ /^[ \+].*\{/;
5948 }
5949 if (!$ok) {
5950 ERROR("OPEN_BRACE",
5951 "open brace '{' following function definitions go on the next line\n" . $herectx);
5952 }
5953 }
5954
5955# checks for new __setup's
5956 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5957 my $name = $1;
5958
5959 if (!grep(/$name/, @setup_docs)) {
5960 CHK("UNDOCUMENTED_SETUP",
5961 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
5962 }
5963 }
5964
5965# check for pointless casting of kmalloc return
5966 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
5967 WARN("UNNECESSARY_CASTS",
5968 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
5969 }
5970
5971# alloc style
5972# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5973 if ($^V && $^V ge 5.10.0 &&
5974 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5975 CHK("ALLOC_SIZEOF_STRUCT",
5976 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
5977 }
5978
5979# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5980 if ($^V && $^V ge 5.10.0 &&
5981 defined $stat &&
5982 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
5983 my $oldfunc = $3;
5984 my $a1 = $4;
5985 my $a2 = $10;
5986 my $newfunc = "kmalloc_array";
5987 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
5988 my $r1 = $a1;
5989 my $r2 = $a2;
5990 if ($a1 =~ /^sizeof\s*\S/) {
5991 $r1 = $a2;
5992 $r2 = $a1;
5993 }
5994 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
5995 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
5996 my $ctx = '';
5997 my $herectx = $here . "\n";
5998 my $cnt = statement_rawlines($stat);
5999 for (my $n = 0; $n < $cnt; $n++) {
6000 $herectx .= raw_line($linenr, $n) . "\n";
6001 }
6002 if (WARN("ALLOC_WITH_MULTIPLY",
6003 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
6004 $cnt == 1 &&
6005 $fix) {
6006 $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;
6007 }
6008 }
6009 }
6010
6011# check for krealloc arg reuse
6012 if ($^V && $^V ge 5.10.0 &&
6013 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
6014 WARN("KREALLOC_ARG_REUSE",
6015 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
6016 }
6017
6018# check for alloc argument mismatch
6019 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
6020 WARN("ALLOC_ARRAY_ARGS",
6021 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
6022 }
6023
6024# check for multiple semicolons
6025 if ($line =~ /;\s*;\s*$/) {
6026 if (WARN("ONE_SEMICOLON",
6027 "Statements terminations use 1 semicolon\n" . $herecurr) &&
6028 $fix) {
6029 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
6030 }
6031 }
6032
6033# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6034 if ($realfile !~ m@^include/uapi/@ &&
6035 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
6036 my $ull = "";
6037 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
6038 if (CHK("BIT_MACRO",
6039 "Prefer using the BIT$ull macro\n" . $herecurr) &&
6040 $fix) {
6041 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
6042 }
6043 }
6044
6045# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6046 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6047 my $config = $1;
6048 if (WARN("PREFER_IS_ENABLED",
6049 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
6050 $fix) {
6051 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
6052 }
6053 }
6054
6055# check for case / default statements not preceded by break/fallthrough/switch
6056 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
6057 my $has_break = 0;
6058 my $has_statement = 0;
6059 my $count = 0;
6060 my $prevline = $linenr;
6061 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
6062 $prevline--;
6063 my $rline = $rawlines[$prevline - 1];
6064 my $fline = $lines[$prevline - 1];
6065 last if ($fline =~ /^\@\@/);
6066 next if ($fline =~ /^\-/);
6067 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
6068 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
6069 next if ($fline =~ /^.[\s$;]*$/);
6070 $has_statement = 1;
6071 $count++;
6072 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/);
6073 }
6074 if (!$has_break && $has_statement) {
6075 WARN("MISSING_BREAK",
6076 "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr);
6077 }
6078 }
6079
6080# check for switch/default statements without a break;
6081 if ($^V && $^V ge 5.10.0 &&
6082 defined $stat &&
6083 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
6084 my $ctx = '';
6085 my $herectx = $here . "\n";
6086 my $cnt = statement_rawlines($stat);
6087 for (my $n = 0; $n < $cnt; $n++) {
6088 $herectx .= raw_line($linenr, $n) . "\n";
6089 }
6090 WARN("DEFAULT_NO_BREAK",
6091 "switch default: should use break\n" . $herectx);
6092 }
6093
6094# check for gcc specific __FUNCTION__
6095 if ($line =~ /\b__FUNCTION__\b/) {
6096 if (WARN("USE_FUNC",
6097 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
6098 $fix) {
6099 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
6100 }
6101 }
6102
6103# check for uses of __DATE__, __TIME__, __TIMESTAMP__
6104 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
6105 ERROR("DATE_TIME",
6106 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
6107 }
6108
6109# check for use of yield()
6110 if ($line =~ /\byield\s*\(\s*\)/) {
6111 WARN("YIELD",
6112 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
6113 }
6114
6115# check for comparisons against true and false
6116 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6117 my $lead = $1;
6118 my $arg = $2;
6119 my $test = $3;
6120 my $otype = $4;
6121 my $trail = $5;
6122 my $op = "!";
6123
6124 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6125
6126 my $type = lc($otype);
6127 if ($type =~ /^(?:true|false)$/) {
6128 if (("$test" eq "==" && "$type" eq "true") ||
6129 ("$test" eq "!=" && "$type" eq "false")) {
6130 $op = "";
6131 }
6132
6133 CHK("BOOL_COMPARISON",
6134 "Using comparison to $otype is error prone\n" . $herecurr);
6135
6136## maybe suggesting a correct construct would better
6137## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6138
6139 }
6140 }
6141
6142# check for semaphores initialized locked
6143 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
6144 WARN("CONSIDER_COMPLETION",
6145 "consider using a completion\n" . $herecurr);
6146 }
6147
6148# recommend kstrto* over simple_strto* and strict_strto*
6149 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
6150 WARN("CONSIDER_KSTRTO",
6151 "$1 is obsolete, use k$3 instead\n" . $herecurr);
6152 }
6153
6154# check for __initcall(), use device_initcall() explicitly or more appropriate function please
6155 if ($line =~ /^.\s*__initcall\s*\(/) {
6156 WARN("USE_DEVICE_INITCALL",
6157 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
6158 }
6159
6160# check for various structs that are normally const (ops, kgdb, device_tree)
6161# and avoid what seem like struct definitions 'struct foo {'
6162 if ($line !~ /\bconst\b/ &&
6163 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
6164 WARN("CONST_STRUCT",
6165 "struct $1 should normally be const\n" . $herecurr);
6166 }
6167
6168# use of NR_CPUS is usually wrong
6169# ignore definitions of NR_CPUS and usage to define arrays as likely right
6170 if ($line =~ /\bNR_CPUS\b/ &&
6171 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6172 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
6173 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6174 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6175 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
6176 {
6177 WARN("NR_CPUS",
6178 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
6179 }
6180
6181# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6182 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6183 ERROR("DEFINE_ARCH_HAS",
6184 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6185 }
6186
6187# likely/unlikely comparisons similar to "(likely(foo) > 0)"
6188 if ($^V && $^V ge 5.10.0 &&
6189 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6190 WARN("LIKELY_MISUSE",
6191 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6192 }
6193
6194# whine mightly about in_atomic
6195 if ($line =~ /\bin_atomic\s*\(/) {
6196 if ($realfile =~ m@^drivers/@) {
6197 ERROR("IN_ATOMIC",
6198 "do not use in_atomic in drivers\n" . $herecurr);
6199 } elsif ($realfile !~ m@^kernel/@) {
6200 WARN("IN_ATOMIC",
6201 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
6202 }
6203 }
6204
6205# check for mutex_trylock_recursive usage
6206 if ($line =~ /mutex_trylock_recursive/) {
6207 ERROR("LOCKING",
6208 "recursive locking is bad, do not use this ever.\n" . $herecurr);
6209 }
6210
6211# check for lockdep_set_novalidate_class
6212 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6213 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6214 if ($realfile !~ m@^kernel/lockdep@ &&
6215 $realfile !~ m@^include/linux/lockdep@ &&
6216 $realfile !~ m@^drivers/base/core@) {
6217 ERROR("LOCKDEP",
6218 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
6219 }
6220 }
6221
6222 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6223 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
6224 WARN("EXPORTED_WORLD_WRITABLE",
6225 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6226 }
6227
6228# Mode permission misuses where it seems decimal should be octal
6229# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6230 if ($^V && $^V ge 5.10.0 &&
6231 defined $stat &&
6232 $line =~ /$mode_perms_search/) {
6233 foreach my $entry (@mode_permission_funcs) {
6234 my $func = $entry->[0];
6235 my $arg_pos = $entry->[1];
6236
6237 my $lc = $stat =~ tr@\n@@;
6238 $lc = $lc + $linenr;
6239 my $stat_real = raw_line($linenr, 0);
6240 for (my $count = $linenr + 1; $count <= $lc; $count++) {
6241 $stat_real = $stat_real . "\n" . raw_line($count, 0);
6242 }
6243
6244 my $skip_args = "";
6245 if ($arg_pos > 1) {
6246 $arg_pos--;
6247 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6248 }
6249 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
6250 if ($stat =~ /$test/) {
6251 my $val = $1;
6252 $val = $6 if ($skip_args ne "");
6253 if (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6254 ($val =~ /^$Octal$/ && length($val) ne 4)) {
6255 ERROR("NON_OCTAL_PERMISSIONS",
6256 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
6257 }
6258 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
6259 ERROR("EXPORTED_WORLD_WRITABLE",
6260 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
6261 }
6262 }
6263 }
6264 }
6265
6266# check for uses of S_<PERMS> that could be octal for readability
6267 if ($line =~ /\b$mode_perms_string_search\b/) {
6268 my $val = "";
6269 my $oval = "";
6270 my $to = 0;
6271 my $curpos = 0;
6272 my $lastpos = 0;
6273 while ($line =~ /\b(($mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
6274 $curpos = pos($line);
6275 my $match = $2;
6276 my $omatch = $1;
6277 last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
6278 $lastpos = $curpos;
6279 $to |= $mode_permission_string_types{$match};
6280 $val .= '\s*\|\s*' if ($val ne "");
6281 $val .= $match;
6282 $oval .= $omatch;
6283 }
6284 $oval =~ s/^\s*\|\s*//;
6285 $oval =~ s/\s*\|\s*$//;
6286 my $octal = sprintf("%04o", $to);
6287 if (WARN("SYMBOLIC_PERMS",
6288 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6289 $fix) {
6290 $fixed[$fixlinenr] =~ s/$val/$octal/;
6291 }
6292 }
6293
6294# validate content of MODULE_LICENSE against list from include/linux/module.h
6295 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6296 my $extracted_string = get_quoted_string($line, $rawline);
6297 my $valid_licenses = qr{
6298 GPL|
6299 GPL\ v2|
6300 GPL\ and\ additional\ rights|
6301 Dual\ BSD/GPL|
6302 Dual\ MIT/GPL|
6303 Dual\ MPL/GPL|
6304 Proprietary
6305 }x;
6306 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6307 WARN("MODULE_LICENSE",
6308 "unknown module license " . $extracted_string . "\n" . $herecurr);
6309 }
6310 }
6311 }
6312
6313 # If we have no input at all, then there is nothing to report on
6314 # so just keep quiet.
6315 if ($#rawlines == -1) {
6316 exit(0);
6317 }
6318
6319 # In mailback mode only produce a report in the negative, for
6320 # things that appear to be patches.
6321 if ($mailback && ($clean == 1 || !$is_patch)) {
6322 exit(0);
6323 }
6324
6325 # This is not a patch, and we are are in 'no-patch' mode so
6326 # just keep quiet.
6327 if (!$chk_patch && !$is_patch) {
6328 exit(0);
6329 }
6330
6331 if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
6332 ERROR("NOT_UNIFIED_DIFF",
6333 "Does not appear to be a unified-diff format patch\n");
6334 }
6335 if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) {
6336 ERROR("MISSING_SIGN_OFF",
6337 "Missing Signed-off-by: line(s)\n");
6338 }
6339
6340 print report_dump();
6341 if ($summary && !($clean == 1 && $quiet == 1)) {
6342 print "$filename " if ($summary_file);
6343 print "total: $cnt_error errors, $cnt_warn warnings, " .
6344 (($check)? "$cnt_chk checks, " : "") .
6345 "$cnt_lines lines checked\n";
6346 }
6347
6348 if ($quiet == 0) {
6349 # If there were any defects found and not already fixing them
6350 if (!$clean and !$fix) {
6351 print << "EOM"
6352
6353NOTE: For some of the reported defects, checkpatch may be able to
6354 mechanically convert to the typical style using --fix or --fix-inplace.
6355EOM
6356 }
6357 # If there were whitespace errors which cleanpatch can fix
6358 # then suggest that.
6359 if ($rpt_cleaners) {
6360 $rpt_cleaners = 0;
6361 print << "EOM"
6362
6363NOTE: Whitespace errors detected.
6364 You may wish to use scripts/cleanpatch or scripts/cleanfile
6365EOM
6366 }
6367 }
6368
6369 if ($clean == 0 && $fix &&
6370 ("@rawlines" ne "@fixed" ||
6371 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
6372 my $newfile = $filename;
6373 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
6374 my $linecount = 0;
6375 my $f;
6376
6377 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6378
6379 open($f, '>', $newfile)
6380 or die "$P: Can't open $newfile for write\n";
6381 foreach my $fixed_line (@fixed) {
6382 $linecount++;
6383 if ($file) {
6384 if ($linecount > 3) {
6385 $fixed_line =~ s/^\+//;
6386 print $f $fixed_line . "\n";
6387 }
6388 } else {
6389 print $f $fixed_line . "\n";
6390 }
6391 }
6392 close($f);
6393
6394 if (!$quiet) {
6395 print << "EOM";
6396
6397Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6398
6399Do _NOT_ trust the results written to this file.
6400Do _NOT_ submit these changes without inspecting them for correctness.
6401
6402This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6403No warranties, expressed or implied...
6404EOM
6405 }
6406 }
6407
6408 if ($quiet == 0) {
6409 print "\n";
6410 if ($clean == 1) {
6411 print "$vname has no obvious style problems and is ready for submission.\n";
6412 } else {
6413 print "$vname has style problems, please review.\n";
6414 }
6415 }
6416 return $clean;
6417}