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