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