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