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