checkpatch: consolidate if (foo) bar(foo) checks and add debugfs_remove
[linux-2.6-block.git] / scripts / checkpatch.pl
CommitLineData
0a920b5b 1#!/usr/bin/perl -w
dbf004d7 2# (c) 2001, Dave Jones. (the file handling bit)
00df344f 3# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
2a5a2c25 4# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
015830be 5# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
0a920b5b
AW
6# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
9
10my $P = $0;
00df344f 11$P =~ s@.*/@@g;
0a920b5b 12
000d1cc1 13my $V = '0.32';
0a920b5b
AW
14
15use Getopt::Long qw(:config no_auto_abbrev);
16
17my $quiet = 0;
18my $tree = 1;
19my $chk_signoff = 1;
20my $chk_patch = 1;
773647a0 21my $tst_only;
6c72ffaa 22my $emacs = 0;
8905a67c 23my $terse = 0;
6c72ffaa
AW
24my $file = 0;
25my $check = 0;
8905a67c
AW
26my $summary = 1;
27my $mailback = 0;
13214adf 28my $summary_file = 0;
000d1cc1 29my $show_types = 0;
6c72ffaa 30my $root;
c2fdda0d 31my %debug;
000d1cc1
JP
32my %ignore_type = ();
33my @ignore = ();
77f5b10a 34my $help = 0;
000d1cc1 35my $configuration_file = ".checkpatch.conf";
77f5b10a
HE
36
37sub help {
38 my ($exitcode) = @_;
39
40 print << "EOM";
41Usage: $P [OPTION]... [FILE]...
42Version: $V
43
44Options:
45 -q, --quiet quiet
46 --no-tree run without a kernel tree
47 --no-signoff do not check for 'Signed-off-by' line
48 --patch treat FILE as patchfile (default)
49 --emacs emacs compile window format
50 --terse one line per report
51 -f, --file treat FILE as regular source file
52 --subjective, --strict enable more subjective tests
000d1cc1
JP
53 --ignore TYPE(,TYPE2...) ignore various comma separated message types
54 --show-types show the message "types" in the output
77f5b10a
HE
55 --root=PATH PATH to the kernel tree root
56 --no-summary suppress the per-file summary
57 --mailback only produce a report in case of warnings/errors
58 --summary-file include the filename in summary
59 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
60 'values', 'possible', 'type', and 'attr' (default
61 is all off)
62 --test-only=WORD report only warnings/errors containing WORD
63 literally
64 -h, --help, --version display this help and exit
65
66When FILE is - read standard input.
67EOM
68
69 exit($exitcode);
70}
71
000d1cc1
JP
72my $conf = which_conf($configuration_file);
73if (-f $conf) {
74 my @conf_args;
75 open(my $conffile, '<', "$conf")
76 or warn "$P: Can't find a readable $configuration_file file $!\n";
77
78 while (<$conffile>) {
79 my $line = $_;
80
81 $line =~ s/\s*\n?$//g;
82 $line =~ s/^\s*//g;
83 $line =~ s/\s+/ /g;
84
85 next if ($line =~ m/^\s*#/);
86 next if ($line =~ m/^\s*$/);
87
88 my @words = split(" ", $line);
89 foreach my $word (@words) {
90 last if ($word =~ m/^#/);
91 push (@conf_args, $word);
92 }
93 }
94 close($conffile);
95 unshift(@ARGV, @conf_args) if @conf_args;
96}
97
0a920b5b 98GetOptions(
6c72ffaa 99 'q|quiet+' => \$quiet,
0a920b5b
AW
100 'tree!' => \$tree,
101 'signoff!' => \$chk_signoff,
102 'patch!' => \$chk_patch,
6c72ffaa 103 'emacs!' => \$emacs,
8905a67c 104 'terse!' => \$terse,
77f5b10a 105 'f|file!' => \$file,
6c72ffaa
AW
106 'subjective!' => \$check,
107 'strict!' => \$check,
000d1cc1
JP
108 'ignore=s' => \@ignore,
109 'show-types!' => \$show_types,
6c72ffaa 110 'root=s' => \$root,
8905a67c
AW
111 'summary!' => \$summary,
112 'mailback!' => \$mailback,
13214adf
AW
113 'summary-file!' => \$summary_file,
114
c2fdda0d 115 'debug=s' => \%debug,
773647a0 116 'test-only=s' => \$tst_only,
77f5b10a
HE
117 'h|help' => \$help,
118 'version' => \$help
119) or help(1);
120
121help(0) if ($help);
0a920b5b
AW
122
123my $exit = 0;
124
125if ($#ARGV < 0) {
77f5b10a 126 print "$P: no input files\n";
0a920b5b
AW
127 exit(1);
128}
129
000d1cc1
JP
130@ignore = split(/,/, join(',',@ignore));
131foreach my $word (@ignore) {
132 $word =~ s/\s*\n?$//g;
133 $word =~ s/^\s*//g;
134 $word =~ s/\s+/ /g;
135 $word =~ tr/[a-z]/[A-Z]/;
136
137 next if ($word =~ m/^\s*#/);
138 next if ($word =~ m/^\s*$/);
139
140 $ignore_type{$word}++;
141}
142
c2fdda0d
AW
143my $dbg_values = 0;
144my $dbg_possible = 0;
7429c690 145my $dbg_type = 0;
a1ef277e 146my $dbg_attr = 0;
c2fdda0d 147for my $key (keys %debug) {
21caa13c
AW
148 ## no critic
149 eval "\${dbg_$key} = '$debug{$key}';";
150 die "$@" if ($@);
c2fdda0d
AW
151}
152
d2c0a235
AW
153my $rpt_cleaners = 0;
154
8905a67c
AW
155if ($terse) {
156 $emacs = 1;
157 $quiet++;
158}
159
6c72ffaa
AW
160if ($tree) {
161 if (defined $root) {
162 if (!top_of_kernel_tree($root)) {
163 die "$P: $root: --root does not point at a valid tree\n";
164 }
165 } else {
166 if (top_of_kernel_tree('.')) {
167 $root = '.';
168 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
169 top_of_kernel_tree($1)) {
170 $root = $1;
171 }
172 }
173
174 if (!defined $root) {
175 print "Must be run from the top-level dir. of a kernel tree\n";
176 exit(2);
177 }
0a920b5b
AW
178}
179
6c72ffaa
AW
180my $emitted_corrupt = 0;
181
2ceb532b
AW
182our $Ident = qr{
183 [A-Za-z_][A-Za-z\d_]*
184 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
185 }x;
6c72ffaa
AW
186our $Storage = qr{extern|static|asmlinkage};
187our $Sparse = qr{
188 __user|
189 __kernel|
190 __force|
191 __iomem|
192 __must_check|
193 __init_refok|
417495ed 194 __kprobes|
165e72a6
SE
195 __ref|
196 __rcu
6c72ffaa 197 }x;
52131292
WS
198
199# Notes to $Attribute:
200# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
6c72ffaa
AW
201our $Attribute = qr{
202 const|
03f1df7d
JP
203 __percpu|
204 __nocast|
205 __safe|
206 __bitwise__|
207 __packed__|
208 __packed2__|
209 __naked|
210 __maybe_unused|
211 __always_unused|
212 __noreturn|
213 __used|
214 __cold|
215 __noclone|
216 __deprecated|
6c72ffaa
AW
217 __read_mostly|
218 __kprobes|
52131292 219 __(?:mem|cpu|dev|)(?:initdata|initconst|init\b)|
24e1d81a
AW
220 ____cacheline_aligned|
221 ____cacheline_aligned_in_smp|
5fe3af11
AW
222 ____cacheline_internodealigned_in_smp|
223 __weak
6c72ffaa 224 }x;
c45dcabd 225our $Modifier;
6c72ffaa 226our $Inline = qr{inline|__always_inline|noinline};
6c72ffaa
AW
227our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
228our $Lval = qr{$Ident(?:$Member)*};
229
d7c76ba7 230our $Constant = qr{(?i:(?:[0-9]+|0x[0-9a-f]+)[ul]*)};
6c72ffaa 231our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
86f9d059 232our $Compare = qr{<=|>=|==|!=|<|>};
6c72ffaa
AW
233our $Operators = qr{
234 <=|>=|==|!=|
235 =>|->|<<|>>|<|>|!|~|
c2fdda0d 236 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
6c72ffaa
AW
237 }x;
238
8905a67c
AW
239our $NonptrType;
240our $Type;
241our $Declare;
242
15662b3e
JP
243our $NON_ASCII_UTF8 = qr{
244 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
171ae1a4
AW
245 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
246 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
247 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
248 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
249 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
250 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
251}x;
252
15662b3e
JP
253our $UTF8 = qr{
254 [\x09\x0A\x0D\x20-\x7E] # ASCII
255 | $NON_ASCII_UTF8
256}x;
257
8ed22cad 258our $typeTypedefs = qr{(?x:
fb9e9096 259 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
8ed22cad
AW
260 atomic_t
261)};
262
691e669b 263our $logFunctions = qr{(?x:
6e60c02e
JP
264 printk(?:_ratelimited|_once|)|
265 [a-z0-9]+_(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
266 WARN(?:_RATELIMIT|_ONCE|)|
b0531722
JP
267 panic|
268 MODULE_[A-Z_]+
691e669b
JP
269)};
270
20112475
JP
271our $signature_tags = qr{(?xi:
272 Signed-off-by:|
273 Acked-by:|
274 Tested-by:|
275 Reviewed-by:|
276 Reported-by:|
277 To:|
278 Cc:
279)};
280
8905a67c
AW
281our @typeList = (
282 qr{void},
c45dcabd
AW
283 qr{(?:unsigned\s+)?char},
284 qr{(?:unsigned\s+)?short},
285 qr{(?:unsigned\s+)?int},
286 qr{(?:unsigned\s+)?long},
287 qr{(?:unsigned\s+)?long\s+int},
288 qr{(?:unsigned\s+)?long\s+long},
289 qr{(?:unsigned\s+)?long\s+long\s+int},
8905a67c
AW
290 qr{unsigned},
291 qr{float},
292 qr{double},
293 qr{bool},
8905a67c
AW
294 qr{struct\s+$Ident},
295 qr{union\s+$Ident},
296 qr{enum\s+$Ident},
297 qr{${Ident}_t},
298 qr{${Ident}_handler},
299 qr{${Ident}_handler_fn},
300);
c45dcabd
AW
301our @modifierList = (
302 qr{fastcall},
303);
8905a67c 304
7840a94c
WS
305our $allowed_asm_includes = qr{(?x:
306 irq|
307 memory
308)};
309# memory.h: ARM has a custom one
310
8905a67c 311sub build_types {
d2172eb5
AW
312 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
313 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
c8cb2ca3 314 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
8905a67c 315 $NonptrType = qr{
d2172eb5 316 (?:$Modifier\s+|const\s+)*
cf655043 317 (?:
6b48db24 318 (?:typeof|__typeof__)\s*\([^\)]*\)|
8ed22cad 319 (?:$typeTypedefs\b)|
c45dcabd 320 (?:${all}\b)
cf655043 321 )
c8cb2ca3 322 (?:\s+$Modifier|\s+const)*
8905a67c
AW
323 }x;
324 $Type = qr{
c45dcabd 325 $NonptrType
b337d8b8 326 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*|\[\])+|(?:\s*\[\s*\])+)?
c8cb2ca3 327 (?:\s+$Inline|\s+$Modifier)*
8905a67c
AW
328 }x;
329 $Declare = qr{(?:$Storage\s+)?$Type};
330}
331build_types();
6c72ffaa 332
7d2367af
JP
333
334our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
d1fe9c09
JP
335
336# Using $balanced_parens, $LvalOrFunc, or $FuncArg
337# requires at least perl version v5.10.0
338# Any use must be runtime checked with $^V
339
340our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
341our $LvalOrFunc = qr{($Lval)\s*($balanced_parens{0,1})\s*};
d7c76ba7 342our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
7d2367af
JP
343
344sub deparenthesize {
345 my ($string) = @_;
346 return "" if (!defined($string));
347 $string =~ s@^\s*\(\s*@@g;
348 $string =~ s@\s*\)\s*$@@g;
349 $string =~ s@\s+@ @g;
350 return $string;
351}
352
6c72ffaa
AW
353$chk_signoff = 0 if ($file);
354
00df344f 355my @rawlines = ();
c2fdda0d
AW
356my @lines = ();
357my $vname;
6c72ffaa 358for my $filename (@ARGV) {
21caa13c 359 my $FILE;
6c72ffaa 360 if ($file) {
21caa13c 361 open($FILE, '-|', "diff -u /dev/null $filename") ||
6c72ffaa 362 die "$P: $filename: diff failed - $!\n";
21caa13c
AW
363 } elsif ($filename eq '-') {
364 open($FILE, '<&STDIN');
6c72ffaa 365 } else {
21caa13c 366 open($FILE, '<', "$filename") ||
6c72ffaa 367 die "$P: $filename: open failed - $!\n";
0a920b5b 368 }
c2fdda0d
AW
369 if ($filename eq '-') {
370 $vname = 'Your patch';
371 } else {
372 $vname = $filename;
373 }
21caa13c 374 while (<$FILE>) {
6c72ffaa
AW
375 chomp;
376 push(@rawlines, $_);
377 }
21caa13c 378 close($FILE);
c2fdda0d 379 if (!process($filename)) {
6c72ffaa
AW
380 $exit = 1;
381 }
382 @rawlines = ();
13214adf 383 @lines = ();
0a920b5b
AW
384}
385
386exit($exit);
387
388sub top_of_kernel_tree {
6c72ffaa
AW
389 my ($root) = @_;
390
391 my @tree_check = (
392 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
393 "README", "Documentation", "arch", "include", "drivers",
394 "fs", "init", "ipc", "kernel", "lib", "scripts",
395 );
396
397 foreach my $check (@tree_check) {
398 if (! -e $root . '/' . $check) {
399 return 0;
400 }
0a920b5b 401 }
6c72ffaa 402 return 1;
8f26b837 403}
0a920b5b 404
20112475
JP
405sub parse_email {
406 my ($formatted_email) = @_;
407
408 my $name = "";
409 my $address = "";
410 my $comment = "";
411
412 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
413 $name = $1;
414 $address = $2;
415 $comment = $3 if defined $3;
416 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
417 $address = $1;
418 $comment = $2 if defined $2;
419 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
420 $address = $1;
421 $comment = $2 if defined $2;
422 $formatted_email =~ s/$address.*$//;
423 $name = $formatted_email;
424 $name =~ s/^\s+|\s+$//g;
425 $name =~ s/^\"|\"$//g;
426 # If there's a name left after stripping spaces and
427 # leading quotes, and the address doesn't have both
428 # leading and trailing angle brackets, the address
429 # is invalid. ie:
430 # "joe smith joe@smith.com" bad
431 # "joe smith <joe@smith.com" bad
432 if ($name ne "" && $address !~ /^<[^>]+>$/) {
433 $name = "";
434 $address = "";
435 $comment = "";
436 }
437 }
438
439 $name =~ s/^\s+|\s+$//g;
440 $name =~ s/^\"|\"$//g;
441 $address =~ s/^\s+|\s+$//g;
442 $address =~ s/^\<|\>$//g;
443
444 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
445 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
446 $name = "\"$name\"";
447 }
448
449 return ($name, $address, $comment);
450}
451
452sub format_email {
453 my ($name, $address) = @_;
454
455 my $formatted_email;
456
457 $name =~ s/^\s+|\s+$//g;
458 $name =~ s/^\"|\"$//g;
459 $address =~ s/^\s+|\s+$//g;
460
461 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
462 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
463 $name = "\"$name\"";
464 }
465
466 if ("$name" eq "") {
467 $formatted_email = "$address";
468 } else {
469 $formatted_email = "$name <$address>";
470 }
471
472 return $formatted_email;
473}
474
000d1cc1
JP
475sub which_conf {
476 my ($conf) = @_;
477
478 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
479 if (-e "$path/$conf") {
480 return "$path/$conf";
481 }
482 }
483
484 return "";
485}
486
0a920b5b
AW
487sub expand_tabs {
488 my ($str) = @_;
489
490 my $res = '';
491 my $n = 0;
492 for my $c (split(//, $str)) {
493 if ($c eq "\t") {
494 $res .= ' ';
495 $n++;
496 for (; ($n % 8) != 0; $n++) {
497 $res .= ' ';
498 }
499 next;
500 }
501 $res .= $c;
502 $n++;
503 }
504
505 return $res;
506}
6c72ffaa 507sub copy_spacing {
773647a0 508 (my $res = shift) =~ tr/\t/ /c;
6c72ffaa
AW
509 return $res;
510}
0a920b5b 511
4a0df2ef
AW
512sub line_stats {
513 my ($line) = @_;
514
515 # Drop the diff line leader and expand tabs
516 $line =~ s/^.//;
517 $line = expand_tabs($line);
518
519 # Pick the indent from the front of the line.
520 my ($white) = ($line =~ /^(\s*)/);
521
522 return (length($line), length($white));
523}
524
773647a0
AW
525my $sanitise_quote = '';
526
527sub sanitise_line_reset {
528 my ($in_comment) = @_;
529
530 if ($in_comment) {
531 $sanitise_quote = '*/';
532 } else {
533 $sanitise_quote = '';
534 }
535}
00df344f
AW
536sub sanitise_line {
537 my ($line) = @_;
538
539 my $res = '';
540 my $l = '';
541
c2fdda0d 542 my $qlen = 0;
773647a0
AW
543 my $off = 0;
544 my $c;
00df344f 545
773647a0
AW
546 # Always copy over the diff marker.
547 $res = substr($line, 0, 1);
548
549 for ($off = 1; $off < length($line); $off++) {
550 $c = substr($line, $off, 1);
551
552 # Comments we are wacking completly including the begin
553 # and end, all to $;.
554 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
555 $sanitise_quote = '*/';
556
557 substr($res, $off, 2, "$;$;");
558 $off++;
559 next;
00df344f 560 }
81bc0e02 561 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
773647a0
AW
562 $sanitise_quote = '';
563 substr($res, $off, 2, "$;$;");
564 $off++;
565 next;
c2fdda0d 566 }
113f04a8
DW
567 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
568 $sanitise_quote = '//';
569
570 substr($res, $off, 2, $sanitise_quote);
571 $off++;
572 next;
573 }
773647a0
AW
574
575 # A \ in a string means ignore the next character.
576 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
577 $c eq "\\") {
578 substr($res, $off, 2, 'XX');
579 $off++;
580 next;
00df344f 581 }
773647a0
AW
582 # Regular quotes.
583 if ($c eq "'" || $c eq '"') {
584 if ($sanitise_quote eq '') {
585 $sanitise_quote = $c;
00df344f 586
773647a0
AW
587 substr($res, $off, 1, $c);
588 next;
589 } elsif ($sanitise_quote eq $c) {
590 $sanitise_quote = '';
591 }
592 }
00df344f 593
fae17dae 594 #print "c<$c> SQ<$sanitise_quote>\n";
773647a0
AW
595 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
596 substr($res, $off, 1, $;);
113f04a8
DW
597 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
598 substr($res, $off, 1, $;);
773647a0
AW
599 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
600 substr($res, $off, 1, 'X');
601 } else {
602 substr($res, $off, 1, $c);
603 }
c2fdda0d
AW
604 }
605
113f04a8
DW
606 if ($sanitise_quote eq '//') {
607 $sanitise_quote = '';
608 }
609
c2fdda0d 610 # The pathname on a #include may be surrounded by '<' and '>'.
c45dcabd 611 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
c2fdda0d
AW
612 my $clean = 'X' x length($1);
613 $res =~ s@\<.*\>@<$clean>@;
614
615 # The whole of a #error is a string.
c45dcabd 616 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
c2fdda0d 617 my $clean = 'X' x length($1);
c45dcabd 618 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
c2fdda0d
AW
619 }
620
00df344f
AW
621 return $res;
622}
623
8905a67c
AW
624sub ctx_statement_block {
625 my ($linenr, $remain, $off) = @_;
626 my $line = $linenr - 1;
627 my $blk = '';
628 my $soff = $off;
629 my $coff = $off - 1;
773647a0 630 my $coff_set = 0;
8905a67c 631
13214adf
AW
632 my $loff = 0;
633
8905a67c
AW
634 my $type = '';
635 my $level = 0;
a2750645 636 my @stack = ();
cf655043 637 my $p;
8905a67c
AW
638 my $c;
639 my $len = 0;
13214adf
AW
640
641 my $remainder;
8905a67c 642 while (1) {
a2750645
AW
643 @stack = (['', 0]) if ($#stack == -1);
644
773647a0 645 #warn "CSB: blk<$blk> remain<$remain>\n";
8905a67c
AW
646 # If we are about to drop off the end, pull in more
647 # context.
648 if ($off >= $len) {
649 for (; $remain > 0; $line++) {
dea33496 650 last if (!defined $lines[$line]);
c2fdda0d 651 next if ($lines[$line] =~ /^-/);
8905a67c 652 $remain--;
13214adf 653 $loff = $len;
c2fdda0d 654 $blk .= $lines[$line] . "\n";
8905a67c
AW
655 $len = length($blk);
656 $line++;
657 last;
658 }
659 # Bail if there is no further context.
660 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
13214adf 661 if ($off >= $len) {
8905a67c
AW
662 last;
663 }
f74bd194
AW
664 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
665 $level++;
666 $type = '#';
667 }
8905a67c 668 }
cf655043 669 $p = $c;
8905a67c 670 $c = substr($blk, $off, 1);
13214adf 671 $remainder = substr($blk, $off);
8905a67c 672
773647a0 673 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
4635f4fb
AW
674
675 # Handle nested #if/#else.
676 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
677 push(@stack, [ $type, $level ]);
678 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
679 ($type, $level) = @{$stack[$#stack - 1]};
680 } elsif ($remainder =~ /^#\s*endif\b/) {
681 ($type, $level) = @{pop(@stack)};
682 }
683
8905a67c
AW
684 # Statement ends at the ';' or a close '}' at the
685 # outermost level.
686 if ($level == 0 && $c eq ';') {
687 last;
688 }
689
13214adf 690 # An else is really a conditional as long as its not else if
773647a0
AW
691 if ($level == 0 && $coff_set == 0 &&
692 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
693 $remainder =~ /^(else)(?:\s|{)/ &&
694 $remainder !~ /^else\s+if\b/) {
695 $coff = $off + length($1) - 1;
696 $coff_set = 1;
697 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
698 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
13214adf
AW
699 }
700
8905a67c
AW
701 if (($type eq '' || $type eq '(') && $c eq '(') {
702 $level++;
703 $type = '(';
704 }
705 if ($type eq '(' && $c eq ')') {
706 $level--;
707 $type = ($level != 0)? '(' : '';
708
709 if ($level == 0 && $coff < $soff) {
710 $coff = $off;
773647a0
AW
711 $coff_set = 1;
712 #warn "CSB: mark coff<$coff>\n";
8905a67c
AW
713 }
714 }
715 if (($type eq '' || $type eq '{') && $c eq '{') {
716 $level++;
717 $type = '{';
718 }
719 if ($type eq '{' && $c eq '}') {
720 $level--;
721 $type = ($level != 0)? '{' : '';
722
723 if ($level == 0) {
b998e001
PP
724 if (substr($blk, $off + 1, 1) eq ';') {
725 $off++;
726 }
8905a67c
AW
727 last;
728 }
729 }
f74bd194
AW
730 # Preprocessor commands end at the newline unless escaped.
731 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
732 $level--;
733 $type = '';
734 $off++;
735 last;
736 }
8905a67c
AW
737 $off++;
738 }
a3bb97a7 739 # We are truly at the end, so shuffle to the next line.
13214adf 740 if ($off == $len) {
a3bb97a7 741 $loff = $len + 1;
13214adf
AW
742 $line++;
743 $remain--;
744 }
8905a67c
AW
745
746 my $statement = substr($blk, $soff, $off - $soff + 1);
747 my $condition = substr($blk, $soff, $coff - $soff + 1);
748
749 #warn "STATEMENT<$statement>\n";
750 #warn "CONDITION<$condition>\n";
751
773647a0 752 #print "coff<$coff> soff<$off> loff<$loff>\n";
13214adf
AW
753
754 return ($statement, $condition,
755 $line, $remain + 1, $off - $loff + 1, $level);
756}
757
cf655043
AW
758sub statement_lines {
759 my ($stmt) = @_;
760
761 # Strip the diff line prefixes and rip blank lines at start and end.
762 $stmt =~ s/(^|\n)./$1/g;
763 $stmt =~ s/^\s*//;
764 $stmt =~ s/\s*$//;
765
766 my @stmt_lines = ($stmt =~ /\n/g);
767
768 return $#stmt_lines + 2;
769}
770
771sub statement_rawlines {
772 my ($stmt) = @_;
773
774 my @stmt_lines = ($stmt =~ /\n/g);
775
776 return $#stmt_lines + 2;
777}
778
779sub statement_block_size {
780 my ($stmt) = @_;
781
782 $stmt =~ s/(^|\n)./$1/g;
783 $stmt =~ s/^\s*{//;
784 $stmt =~ s/}\s*$//;
785 $stmt =~ s/^\s*//;
786 $stmt =~ s/\s*$//;
787
788 my @stmt_lines = ($stmt =~ /\n/g);
789 my @stmt_statements = ($stmt =~ /;/g);
790
791 my $stmt_lines = $#stmt_lines + 2;
792 my $stmt_statements = $#stmt_statements + 1;
793
794 if ($stmt_lines > $stmt_statements) {
795 return $stmt_lines;
796 } else {
797 return $stmt_statements;
798 }
799}
800
13214adf
AW
801sub ctx_statement_full {
802 my ($linenr, $remain, $off) = @_;
803 my ($statement, $condition, $level);
804
805 my (@chunks);
806
cf655043 807 # Grab the first conditional/block pair.
13214adf
AW
808 ($statement, $condition, $linenr, $remain, $off, $level) =
809 ctx_statement_block($linenr, $remain, $off);
773647a0 810 #print "F: c<$condition> s<$statement> remain<$remain>\n";
cf655043
AW
811 push(@chunks, [ $condition, $statement ]);
812 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
813 return ($level, $linenr, @chunks);
814 }
815
816 # Pull in the following conditional/block pairs and see if they
817 # could continue the statement.
13214adf 818 for (;;) {
13214adf
AW
819 ($statement, $condition, $linenr, $remain, $off, $level) =
820 ctx_statement_block($linenr, $remain, $off);
cf655043 821 #print "C: c<$condition> s<$statement> remain<$remain>\n";
773647a0 822 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
cf655043
AW
823 #print "C: push\n";
824 push(@chunks, [ $condition, $statement ]);
13214adf
AW
825 }
826
827 return ($level, $linenr, @chunks);
8905a67c
AW
828}
829
4a0df2ef 830sub ctx_block_get {
f0a594c1 831 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
4a0df2ef
AW
832 my $line;
833 my $start = $linenr - 1;
4a0df2ef
AW
834 my $blk = '';
835 my @o;
836 my @c;
837 my @res = ();
838
f0a594c1 839 my $level = 0;
4635f4fb 840 my @stack = ($level);
00df344f
AW
841 for ($line = $start; $remain > 0; $line++) {
842 next if ($rawlines[$line] =~ /^-/);
843 $remain--;
844
845 $blk .= $rawlines[$line];
4635f4fb
AW
846
847 # Handle nested #if/#else.
01464f30 848 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
4635f4fb 849 push(@stack, $level);
01464f30 850 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
4635f4fb 851 $level = $stack[$#stack - 1];
01464f30 852 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
4635f4fb
AW
853 $level = pop(@stack);
854 }
855
01464f30 856 foreach my $c (split(//, $lines[$line])) {
f0a594c1
AW
857 ##print "C<$c>L<$level><$open$close>O<$off>\n";
858 if ($off > 0) {
859 $off--;
860 next;
861 }
4a0df2ef 862
f0a594c1
AW
863 if ($c eq $close && $level > 0) {
864 $level--;
865 last if ($level == 0);
866 } elsif ($c eq $open) {
867 $level++;
868 }
869 }
4a0df2ef 870
f0a594c1 871 if (!$outer || $level <= 1) {
00df344f 872 push(@res, $rawlines[$line]);
4a0df2ef
AW
873 }
874
f0a594c1 875 last if ($level == 0);
4a0df2ef
AW
876 }
877
f0a594c1 878 return ($level, @res);
4a0df2ef
AW
879}
880sub ctx_block_outer {
881 my ($linenr, $remain) = @_;
882
f0a594c1
AW
883 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
884 return @r;
4a0df2ef
AW
885}
886sub ctx_block {
887 my ($linenr, $remain) = @_;
888
f0a594c1
AW
889 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
890 return @r;
653d4876
AW
891}
892sub ctx_statement {
f0a594c1
AW
893 my ($linenr, $remain, $off) = @_;
894
895 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
896 return @r;
897}
898sub ctx_block_level {
653d4876
AW
899 my ($linenr, $remain) = @_;
900
f0a594c1 901 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
4a0df2ef 902}
9c0ca6f9
AW
903sub ctx_statement_level {
904 my ($linenr, $remain, $off) = @_;
905
906 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
907}
4a0df2ef
AW
908
909sub ctx_locate_comment {
910 my ($first_line, $end_line) = @_;
911
912 # Catch a comment on the end of the line itself.
beae6332 913 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
4a0df2ef
AW
914 return $current_comment if (defined $current_comment);
915
916 # Look through the context and try and figure out if there is a
917 # comment.
918 my $in_comment = 0;
919 $current_comment = '';
920 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
00df344f
AW
921 my $line = $rawlines[$linenr - 1];
922 #warn " $line\n";
4a0df2ef
AW
923 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
924 $in_comment = 1;
925 }
926 if ($line =~ m@/\*@) {
927 $in_comment = 1;
928 }
929 if (!$in_comment && $current_comment ne '') {
930 $current_comment = '';
931 }
932 $current_comment .= $line . "\n" if ($in_comment);
933 if ($line =~ m@\*/@) {
934 $in_comment = 0;
935 }
936 }
937
938 chomp($current_comment);
939 return($current_comment);
940}
941sub ctx_has_comment {
942 my ($first_line, $end_line) = @_;
943 my $cmt = ctx_locate_comment($first_line, $end_line);
944
00df344f 945 ##print "LINE: $rawlines[$end_line - 1 ]\n";
4a0df2ef
AW
946 ##print "CMMT: $cmt\n";
947
948 return ($cmt ne '');
949}
950
4d001e4d
AW
951sub raw_line {
952 my ($linenr, $cnt) = @_;
953
954 my $offset = $linenr - 1;
955 $cnt++;
956
957 my $line;
958 while ($cnt) {
959 $line = $rawlines[$offset++];
960 next if (defined($line) && $line =~ /^-/);
961 $cnt--;
962 }
963
964 return $line;
965}
966
6c72ffaa
AW
967sub cat_vet {
968 my ($vet) = @_;
969 my ($res, $coded);
9c0ca6f9 970
6c72ffaa
AW
971 $res = '';
972 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
973 $res .= $1;
974 if ($2 ne '') {
975 $coded = sprintf("^%c", unpack('C', $2) + 64);
976 $res .= $coded;
9c0ca6f9
AW
977 }
978 }
6c72ffaa 979 $res =~ s/$/\$/;
9c0ca6f9 980
6c72ffaa 981 return $res;
9c0ca6f9
AW
982}
983
c2fdda0d 984my $av_preprocessor = 0;
cf655043 985my $av_pending;
c2fdda0d 986my @av_paren_type;
1f65f947 987my $av_pend_colon;
c2fdda0d
AW
988
989sub annotate_reset {
990 $av_preprocessor = 0;
cf655043
AW
991 $av_pending = '_';
992 @av_paren_type = ('E');
1f65f947 993 $av_pend_colon = 'O';
c2fdda0d
AW
994}
995
6c72ffaa
AW
996sub annotate_values {
997 my ($stream, $type) = @_;
0a920b5b 998
6c72ffaa 999 my $res;
1f65f947 1000 my $var = '_' x length($stream);
6c72ffaa
AW
1001 my $cur = $stream;
1002
c2fdda0d 1003 print "$stream\n" if ($dbg_values > 1);
6c72ffaa 1004
6c72ffaa 1005 while (length($cur)) {
773647a0 1006 @av_paren_type = ('E') if ($#av_paren_type < 0);
cf655043 1007 print " <" . join('', @av_paren_type) .
171ae1a4 1008 "> <$type> <$av_pending>" if ($dbg_values > 1);
6c72ffaa 1009 if ($cur =~ /^(\s+)/o) {
c2fdda0d
AW
1010 print "WS($1)\n" if ($dbg_values > 1);
1011 if ($1 =~ /\n/ && $av_preprocessor) {
cf655043 1012 $type = pop(@av_paren_type);
c2fdda0d 1013 $av_preprocessor = 0;
6c72ffaa
AW
1014 }
1015
c023e473 1016 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
9446ef56
AW
1017 print "CAST($1)\n" if ($dbg_values > 1);
1018 push(@av_paren_type, $type);
addcdcea 1019 $type = 'c';
9446ef56 1020
e91b6e26 1021 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
c2fdda0d 1022 print "DECLARE($1)\n" if ($dbg_values > 1);
6c72ffaa
AW
1023 $type = 'T';
1024
389a2fe5
AW
1025 } elsif ($cur =~ /^($Modifier)\s*/) {
1026 print "MODIFIER($1)\n" if ($dbg_values > 1);
1027 $type = 'T';
1028
c45dcabd 1029 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
171ae1a4 1030 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
c2fdda0d 1031 $av_preprocessor = 1;
171ae1a4
AW
1032 push(@av_paren_type, $type);
1033 if ($2 ne '') {
1034 $av_pending = 'N';
1035 }
1036 $type = 'E';
1037
c45dcabd 1038 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
171ae1a4
AW
1039 print "UNDEF($1)\n" if ($dbg_values > 1);
1040 $av_preprocessor = 1;
1041 push(@av_paren_type, $type);
6c72ffaa 1042
c45dcabd 1043 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
cf655043 1044 print "PRE_START($1)\n" if ($dbg_values > 1);
c2fdda0d 1045 $av_preprocessor = 1;
cf655043
AW
1046
1047 push(@av_paren_type, $type);
1048 push(@av_paren_type, $type);
171ae1a4 1049 $type = 'E';
cf655043 1050
c45dcabd 1051 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
cf655043
AW
1052 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1053 $av_preprocessor = 1;
1054
1055 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1056
171ae1a4 1057 $type = 'E';
cf655043 1058
c45dcabd 1059 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
cf655043
AW
1060 print "PRE_END($1)\n" if ($dbg_values > 1);
1061
1062 $av_preprocessor = 1;
1063
1064 # Assume all arms of the conditional end as this
1065 # one does, and continue as if the #endif was not here.
1066 pop(@av_paren_type);
1067 push(@av_paren_type, $type);
171ae1a4 1068 $type = 'E';
6c72ffaa
AW
1069
1070 } elsif ($cur =~ /^(\\\n)/o) {
c2fdda0d 1071 print "PRECONT($1)\n" if ($dbg_values > 1);
6c72ffaa 1072
171ae1a4
AW
1073 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1074 print "ATTR($1)\n" if ($dbg_values > 1);
1075 $av_pending = $type;
1076 $type = 'N';
1077
6c72ffaa 1078 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
c2fdda0d 1079 print "SIZEOF($1)\n" if ($dbg_values > 1);
6c72ffaa 1080 if (defined $2) {
cf655043 1081 $av_pending = 'V';
6c72ffaa
AW
1082 }
1083 $type = 'N';
1084
14b111c1 1085 } elsif ($cur =~ /^(if|while|for)\b/o) {
c2fdda0d 1086 print "COND($1)\n" if ($dbg_values > 1);
14b111c1 1087 $av_pending = 'E';
6c72ffaa
AW
1088 $type = 'N';
1089
1f65f947
AW
1090 } elsif ($cur =~/^(case)/o) {
1091 print "CASE($1)\n" if ($dbg_values > 1);
1092 $av_pend_colon = 'C';
1093 $type = 'N';
1094
14b111c1 1095 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
c2fdda0d 1096 print "KEYWORD($1)\n" if ($dbg_values > 1);
6c72ffaa
AW
1097 $type = 'N';
1098
1099 } elsif ($cur =~ /^(\()/o) {
c2fdda0d 1100 print "PAREN('$1')\n" if ($dbg_values > 1);
cf655043
AW
1101 push(@av_paren_type, $av_pending);
1102 $av_pending = '_';
6c72ffaa
AW
1103 $type = 'N';
1104
1105 } elsif ($cur =~ /^(\))/o) {
cf655043
AW
1106 my $new_type = pop(@av_paren_type);
1107 if ($new_type ne '_') {
1108 $type = $new_type;
c2fdda0d
AW
1109 print "PAREN('$1') -> $type\n"
1110 if ($dbg_values > 1);
6c72ffaa 1111 } else {
c2fdda0d 1112 print "PAREN('$1')\n" if ($dbg_values > 1);
6c72ffaa
AW
1113 }
1114
c8cb2ca3 1115 } elsif ($cur =~ /^($Ident)\s*\(/o) {
c2fdda0d 1116 print "FUNC($1)\n" if ($dbg_values > 1);
c8cb2ca3 1117 $type = 'V';
cf655043 1118 $av_pending = 'V';
6c72ffaa 1119
8e761b04
AW
1120 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1121 if (defined $2 && $type eq 'C' || $type eq 'T') {
1f65f947 1122 $av_pend_colon = 'B';
8e761b04
AW
1123 } elsif ($type eq 'E') {
1124 $av_pend_colon = 'L';
1f65f947
AW
1125 }
1126 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1127 $type = 'V';
1128
6c72ffaa 1129 } elsif ($cur =~ /^($Ident|$Constant)/o) {
c2fdda0d 1130 print "IDENT($1)\n" if ($dbg_values > 1);
6c72ffaa
AW
1131 $type = 'V';
1132
1133 } elsif ($cur =~ /^($Assignment)/o) {
c2fdda0d 1134 print "ASSIGN($1)\n" if ($dbg_values > 1);
6c72ffaa
AW
1135 $type = 'N';
1136
cf655043 1137 } elsif ($cur =~/^(;|{|})/) {
c2fdda0d 1138 print "END($1)\n" if ($dbg_values > 1);
13214adf 1139 $type = 'E';
1f65f947
AW
1140 $av_pend_colon = 'O';
1141
8e761b04
AW
1142 } elsif ($cur =~/^(,)/) {
1143 print "COMMA($1)\n" if ($dbg_values > 1);
1144 $type = 'C';
1145
1f65f947
AW
1146 } elsif ($cur =~ /^(\?)/o) {
1147 print "QUESTION($1)\n" if ($dbg_values > 1);
1148 $type = 'N';
1149
1150 } elsif ($cur =~ /^(:)/o) {
1151 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1152
1153 substr($var, length($res), 1, $av_pend_colon);
1154 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1155 $type = 'E';
1156 } else {
1157 $type = 'N';
1158 }
1159 $av_pend_colon = 'O';
13214adf 1160
8e761b04 1161 } elsif ($cur =~ /^(\[)/o) {
13214adf 1162 print "CLOSE($1)\n" if ($dbg_values > 1);
6c72ffaa
AW
1163 $type = 'N';
1164
0d413866 1165 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
74048ed8
AW
1166 my $variant;
1167
1168 print "OPV($1)\n" if ($dbg_values > 1);
1169 if ($type eq 'V') {
1170 $variant = 'B';
1171 } else {
1172 $variant = 'U';
1173 }
1174
1175 substr($var, length($res), 1, $variant);
1176 $type = 'N';
1177
6c72ffaa 1178 } elsif ($cur =~ /^($Operators)/o) {
c2fdda0d 1179 print "OP($1)\n" if ($dbg_values > 1);
6c72ffaa
AW
1180 if ($1 ne '++' && $1 ne '--') {
1181 $type = 'N';
1182 }
1183
1184 } elsif ($cur =~ /(^.)/o) {
c2fdda0d 1185 print "C($1)\n" if ($dbg_values > 1);
6c72ffaa
AW
1186 }
1187 if (defined $1) {
1188 $cur = substr($cur, length($1));
1189 $res .= $type x length($1);
1190 }
9c0ca6f9 1191 }
0a920b5b 1192
1f65f947 1193 return ($res, $var);
0a920b5b
AW
1194}
1195
8905a67c 1196sub possible {
13214adf 1197 my ($possible, $line) = @_;
9a974fdb 1198 my $notPermitted = qr{(?:
0776e594
AW
1199 ^(?:
1200 $Modifier|
1201 $Storage|
1202 $Type|
9a974fdb
AW
1203 DEFINE_\S+
1204 )$|
1205 ^(?:
0776e594
AW
1206 goto|
1207 return|
1208 case|
1209 else|
1210 asm|__asm__|
89a88353
AW
1211 do|
1212 \#|
1213 \#\#|
9a974fdb 1214 )(?:\s|$)|
0776e594 1215 ^(?:typedef|struct|enum)\b
9a974fdb
AW
1216 )}x;
1217 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1218 if ($possible !~ $notPermitted) {
c45dcabd
AW
1219 # Check for modifiers.
1220 $possible =~ s/\s*$Storage\s*//g;
1221 $possible =~ s/\s*$Sparse\s*//g;
1222 if ($possible =~ /^\s*$/) {
1223
1224 } elsif ($possible =~ /\s/) {
1225 $possible =~ s/\s*$Type\s*//g;
d2506586 1226 for my $modifier (split(' ', $possible)) {
9a974fdb
AW
1227 if ($modifier !~ $notPermitted) {
1228 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1229 push(@modifierList, $modifier);
1230 }
d2506586 1231 }
c45dcabd
AW
1232
1233 } else {
1234 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1235 push(@typeList, $possible);
1236 }
8905a67c 1237 build_types();
0776e594
AW
1238 } else {
1239 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
8905a67c
AW
1240 }
1241}
1242
6c72ffaa
AW
1243my $prefix = '';
1244
000d1cc1
JP
1245sub show_type {
1246 return !defined $ignore_type{$_[0]};
1247}
1248
f0a594c1 1249sub report {
000d1cc1
JP
1250 if (!show_type($_[1]) ||
1251 (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) {
773647a0
AW
1252 return 0;
1253 }
000d1cc1
JP
1254 my $line;
1255 if ($show_types) {
1256 $line = "$prefix$_[0]:$_[1]: $_[2]\n";
1257 } else {
1258 $line = "$prefix$_[0]: $_[2]\n";
1259 }
8905a67c
AW
1260 $line = (split('\n', $line))[0] . "\n" if ($terse);
1261
13214adf 1262 push(our @report, $line);
773647a0
AW
1263
1264 return 1;
f0a594c1
AW
1265}
1266sub report_dump {
13214adf 1267 our @report;
f0a594c1 1268}
000d1cc1 1269
de7d4f0e 1270sub ERROR {
000d1cc1 1271 if (report("ERROR", $_[0], $_[1])) {
773647a0
AW
1272 our $clean = 0;
1273 our $cnt_error++;
1274 }
de7d4f0e
AW
1275}
1276sub WARN {
000d1cc1 1277 if (report("WARNING", $_[0], $_[1])) {
773647a0
AW
1278 our $clean = 0;
1279 our $cnt_warn++;
1280 }
de7d4f0e
AW
1281}
1282sub CHK {
000d1cc1 1283 if ($check && report("CHECK", $_[0], $_[1])) {
6c72ffaa
AW
1284 our $clean = 0;
1285 our $cnt_chk++;
1286 }
de7d4f0e
AW
1287}
1288
6ecd9674
AW
1289sub check_absolute_file {
1290 my ($absolute, $herecurr) = @_;
1291 my $file = $absolute;
1292
1293 ##print "absolute<$absolute>\n";
1294
1295 # See if any suffix of this path is a path within the tree.
1296 while ($file =~ s@^[^/]*/@@) {
1297 if (-f "$root/$file") {
1298 ##print "file<$file>\n";
1299 last;
1300 }
1301 }
1302 if (! -f _) {
1303 return 0;
1304 }
1305
1306 # It is, so see if the prefix is acceptable.
1307 my $prefix = $absolute;
1308 substr($prefix, -length($file)) = '';
1309
1310 ##print "prefix<$prefix>\n";
1311 if ($prefix ne ".../") {
000d1cc1
JP
1312 WARN("USE_RELATIVE_PATH",
1313 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
6ecd9674
AW
1314 }
1315}
1316
d1fe9c09
JP
1317sub pos_last_openparen {
1318 my ($line) = @_;
1319
1320 my $pos = 0;
1321
1322 my $opens = $line =~ tr/\(/\(/;
1323 my $closes = $line =~ tr/\)/\)/;
1324
1325 my $last_openparen = 0;
1326
1327 if (($opens == 0) || ($closes >= $opens)) {
1328 return -1;
1329 }
1330
1331 my $len = length($line);
1332
1333 for ($pos = 0; $pos < $len; $pos++) {
1334 my $string = substr($line, $pos);
1335 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1336 $pos += length($1) - 1;
1337 } elsif (substr($line, $pos, 1) eq '(') {
1338 $last_openparen = $pos;
1339 } elsif (index($string, '(') == -1) {
1340 last;
1341 }
1342 }
1343
1344 return $last_openparen + 1;
1345}
1346
0a920b5b
AW
1347sub process {
1348 my $filename = shift;
0a920b5b
AW
1349
1350 my $linenr=0;
1351 my $prevline="";
c2fdda0d 1352 my $prevrawline="";
0a920b5b 1353 my $stashline="";
c2fdda0d 1354 my $stashrawline="";
0a920b5b 1355
4a0df2ef 1356 my $length;
0a920b5b
AW
1357 my $indent;
1358 my $previndent=0;
1359 my $stashindent=0;
1360
de7d4f0e 1361 our $clean = 1;
0a920b5b
AW
1362 my $signoff = 0;
1363 my $is_patch = 0;
1364
15662b3e
JP
1365 my $in_header_lines = 1;
1366 my $in_commit_log = 0; #Scanning lines before patch
1367
fa64205d
PS
1368 my $non_utf8_charset = 0;
1369
13214adf 1370 our @report = ();
6c72ffaa
AW
1371 our $cnt_lines = 0;
1372 our $cnt_error = 0;
1373 our $cnt_warn = 0;
1374 our $cnt_chk = 0;
1375
0a920b5b
AW
1376 # Trace the real file/line as we go.
1377 my $realfile = '';
1378 my $realline = 0;
1379 my $realcnt = 0;
1380 my $here = '';
1381 my $in_comment = 0;
c2fdda0d 1382 my $comment_edge = 0;
0a920b5b 1383 my $first_line = 0;
1e855726 1384 my $p1_prefix = '';
0a920b5b 1385
13214adf
AW
1386 my $prev_values = 'E';
1387
1388 # suppression flags
773647a0 1389 my %suppress_ifbraces;
170d3a22 1390 my %suppress_whiletrailers;
2b474a1a 1391 my %suppress_export;
3e469cdc 1392 my $suppress_statement = 0;
653d4876 1393
c2fdda0d 1394 # Pre-scan the patch sanitizing the lines.
de7d4f0e 1395 # Pre-scan the patch looking for any __setup documentation.
c2fdda0d 1396 #
de7d4f0e
AW
1397 my @setup_docs = ();
1398 my $setup_docs = 0;
773647a0
AW
1399
1400 sanitise_line_reset();
c2fdda0d
AW
1401 my $line;
1402 foreach my $rawline (@rawlines) {
773647a0
AW
1403 $linenr++;
1404 $line = $rawline;
c2fdda0d 1405
773647a0 1406 if ($rawline=~/^\+\+\+\s+(\S+)/) {
de7d4f0e
AW
1407 $setup_docs = 0;
1408 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1409 $setup_docs = 1;
1410 }
773647a0
AW
1411 #next;
1412 }
1413 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1414 $realline=$1-1;
1415 if (defined $2) {
1416 $realcnt=$3+1;
1417 } else {
1418 $realcnt=1+1;
1419 }
c45dcabd 1420 $in_comment = 0;
773647a0
AW
1421
1422 # Guestimate if this is a continuing comment. Run
1423 # the context looking for a comment "edge". If this
1424 # edge is a close comment then we must be in a comment
1425 # at context start.
1426 my $edge;
01fa9147
AW
1427 my $cnt = $realcnt;
1428 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1429 next if (defined $rawlines[$ln - 1] &&
1430 $rawlines[$ln - 1] =~ /^-/);
1431 $cnt--;
1432 #print "RAW<$rawlines[$ln - 1]>\n";
721c1cb6 1433 last if (!defined $rawlines[$ln - 1]);
fae17dae
AW
1434 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1435 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1436 ($edge) = $1;
1437 last;
1438 }
773647a0
AW
1439 }
1440 if (defined $edge && $edge eq '*/') {
1441 $in_comment = 1;
1442 }
1443
1444 # Guestimate if this is a continuing comment. If this
1445 # is the start of a diff block and this line starts
1446 # ' *' then it is very likely a comment.
1447 if (!defined $edge &&
83242e0c 1448 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
773647a0
AW
1449 {
1450 $in_comment = 1;
1451 }
1452
1453 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1454 sanitise_line_reset($in_comment);
1455
171ae1a4 1456 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
773647a0 1457 # Standardise the strings and chars within the input to
171ae1a4 1458 # simplify matching -- only bother with positive lines.
773647a0 1459 $line = sanitise_line($rawline);
de7d4f0e 1460 }
773647a0
AW
1461 push(@lines, $line);
1462
1463 if ($realcnt > 1) {
1464 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1465 } else {
1466 $realcnt = 0;
1467 }
1468
1469 #print "==>$rawline\n";
1470 #print "-->$line\n";
de7d4f0e
AW
1471
1472 if ($setup_docs && $line =~ /^\+/) {
1473 push(@setup_docs, $line);
1474 }
1475 }
1476
6c72ffaa
AW
1477 $prefix = '';
1478
773647a0
AW
1479 $realcnt = 0;
1480 $linenr = 0;
0a920b5b
AW
1481 foreach my $line (@lines) {
1482 $linenr++;
1483
c2fdda0d 1484 my $rawline = $rawlines[$linenr - 1];
6c72ffaa 1485
0a920b5b 1486#extract the line range in the file after the patch is applied
6c72ffaa 1487 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
0a920b5b 1488 $is_patch = 1;
4a0df2ef 1489 $first_line = $linenr + 1;
0a920b5b
AW
1490 $realline=$1-1;
1491 if (defined $2) {
1492 $realcnt=$3+1;
1493 } else {
1494 $realcnt=1+1;
1495 }
c2fdda0d 1496 annotate_reset();
13214adf
AW
1497 $prev_values = 'E';
1498
773647a0 1499 %suppress_ifbraces = ();
170d3a22 1500 %suppress_whiletrailers = ();
2b474a1a 1501 %suppress_export = ();
3e469cdc 1502 $suppress_statement = 0;
0a920b5b 1503 next;
0a920b5b 1504
4a0df2ef
AW
1505# track the line number as we move through the hunk, note that
1506# new versions of GNU diff omit the leading space on completely
1507# blank context lines so we need to count that too.
773647a0 1508 } elsif ($line =~ /^( |\+|$)/) {
0a920b5b 1509 $realline++;
d8aaf121 1510 $realcnt-- if ($realcnt != 0);
0a920b5b 1511
4a0df2ef 1512 # Measure the line length and indent.
c2fdda0d 1513 ($length, $indent) = line_stats($rawline);
0a920b5b
AW
1514
1515 # Track the previous line.
1516 ($prevline, $stashline) = ($stashline, $line);
1517 ($previndent, $stashindent) = ($stashindent, $indent);
c2fdda0d
AW
1518 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1519
773647a0 1520 #warn "line<$line>\n";
6c72ffaa 1521
d8aaf121
AW
1522 } elsif ($realcnt == 1) {
1523 $realcnt--;
0a920b5b
AW
1524 }
1525
cc77cdca
AW
1526 my $hunk_line = ($realcnt != 0);
1527
0a920b5b 1528#make up the handle for any error we report on this line
773647a0
AW
1529 $prefix = "$filename:$realline: " if ($emacs && $file);
1530 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1531
6c72ffaa
AW
1532 $here = "#$linenr: " if (!$file);
1533 $here = "#$realline: " if ($file);
773647a0
AW
1534
1535 # extract the filename as it passes
3bf9a009
RV
1536 if ($line =~ /^diff --git.*?(\S+)$/) {
1537 $realfile = $1;
1538 $realfile =~ s@^([^/]*)/@@;
270c49a0 1539 $in_commit_log = 0;
3bf9a009 1540 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
773647a0 1541 $realfile = $1;
1e855726 1542 $realfile =~ s@^([^/]*)/@@;
270c49a0 1543 $in_commit_log = 0;
1e855726
WS
1544
1545 $p1_prefix = $1;
e2f7aa4b
AW
1546 if (!$file && $tree && $p1_prefix ne '' &&
1547 -e "$root/$p1_prefix") {
000d1cc1
JP
1548 WARN("PATCH_PREFIX",
1549 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1e855726 1550 }
773647a0 1551
c1ab3326 1552 if ($realfile =~ m@^include/asm/@) {
000d1cc1
JP
1553 ERROR("MODIFIED_INCLUDE_ASM",
1554 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
773647a0
AW
1555 }
1556 next;
1557 }
1558
389834b6 1559 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
0a920b5b 1560
c2fdda0d
AW
1561 my $hereline = "$here\n$rawline\n";
1562 my $herecurr = "$here\n$rawline\n";
1563 my $hereprev = "$here\n$prevrawline\n$rawline\n";
0a920b5b 1564
6c72ffaa
AW
1565 $cnt_lines++ if ($realcnt != 0);
1566
3bf9a009
RV
1567# Check for incorrect file permissions
1568 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1569 my $permhere = $here . "FILE: $realfile\n";
1570 if ($realfile =~ /(Makefile|Kconfig|\.c|\.h|\.S|\.tmpl)$/) {
000d1cc1
JP
1571 ERROR("EXECUTE_PERMISSIONS",
1572 "do not set execute permissions for source files\n" . $permhere);
3bf9a009
RV
1573 }
1574 }
1575
20112475 1576# Check the patch for a signoff:
d8aaf121 1577 if ($line =~ /^\s*signed-off-by:/i) {
4a0df2ef 1578 $signoff++;
15662b3e 1579 $in_commit_log = 0;
20112475
JP
1580 }
1581
1582# Check signature styles
270c49a0 1583 if (!$in_header_lines &&
ce0338df 1584 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
20112475
JP
1585 my $space_before = $1;
1586 my $sign_off = $2;
1587 my $space_after = $3;
1588 my $email = $4;
1589 my $ucfirst_sign_off = ucfirst(lc($sign_off));
1590
ce0338df
JP
1591 if ($sign_off !~ /$signature_tags/) {
1592 WARN("BAD_SIGN_OFF",
1593 "Non-standard signature: $sign_off\n" . $herecurr);
1594 }
20112475 1595 if (defined $space_before && $space_before ne "") {
000d1cc1
JP
1596 WARN("BAD_SIGN_OFF",
1597 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr);
20112475
JP
1598 }
1599 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
000d1cc1
JP
1600 WARN("BAD_SIGN_OFF",
1601 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr);
20112475
JP
1602 }
1603 if (!defined $space_after || $space_after ne " ") {
000d1cc1
JP
1604 WARN("BAD_SIGN_OFF",
1605 "Use a single space after $ucfirst_sign_off\n" . $herecurr);
0a920b5b 1606 }
20112475
JP
1607
1608 my ($email_name, $email_address, $comment) = parse_email($email);
1609 my $suggested_email = format_email(($email_name, $email_address));
1610 if ($suggested_email eq "") {
000d1cc1
JP
1611 ERROR("BAD_SIGN_OFF",
1612 "Unrecognized email address: '$email'\n" . $herecurr);
20112475
JP
1613 } else {
1614 my $dequoted = $suggested_email;
1615 $dequoted =~ s/^"//;
1616 $dequoted =~ s/" </ </;
1617 # Don't force email to have quotes
1618 # Allow just an angle bracketed address
1619 if ("$dequoted$comment" ne $email &&
1620 "<$email_address>$comment" ne $email &&
1621 "$suggested_email$comment" ne $email) {
000d1cc1
JP
1622 WARN("BAD_SIGN_OFF",
1623 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
20112475 1624 }
0a920b5b
AW
1625 }
1626 }
1627
00df344f 1628# Check for wrappage within a valid hunk of the file
8905a67c 1629 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
000d1cc1
JP
1630 ERROR("CORRUPTED_PATCH",
1631 "patch seems to be corrupt (line wrapped?)\n" .
6c72ffaa 1632 $herecurr) if (!$emitted_corrupt++);
de7d4f0e
AW
1633 }
1634
6ecd9674
AW
1635# Check for absolute kernel paths.
1636 if ($tree) {
1637 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1638 my $file = $1;
1639
1640 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1641 check_absolute_file($1, $herecurr)) {
1642 #
1643 } else {
1644 check_absolute_file($file, $herecurr);
1645 }
1646 }
1647 }
1648
de7d4f0e
AW
1649# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1650 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
171ae1a4
AW
1651 $rawline !~ m/^$UTF8*$/) {
1652 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1653
1654 my $blank = copy_spacing($rawline);
1655 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1656 my $hereptr = "$hereline$ptr\n";
1657
34d99219
JP
1658 CHK("INVALID_UTF8",
1659 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
00df344f
AW
1660 }
1661
15662b3e
JP
1662# Check if it's the start of a commit log
1663# (not a header line and we haven't seen the patch filename)
1664 if ($in_header_lines && $realfile =~ /^$/ &&
270c49a0 1665 $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
15662b3e
JP
1666 $in_header_lines = 0;
1667 $in_commit_log = 1;
1668 }
1669
fa64205d
PS
1670# Check if there is UTF-8 in a commit log when a mail header has explicitly
1671# declined it, i.e defined some charset where it is missing.
1672 if ($in_header_lines &&
1673 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
1674 $1 !~ /utf-8/i) {
1675 $non_utf8_charset = 1;
1676 }
1677
1678 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
15662b3e 1679 $rawline =~ /$NON_ASCII_UTF8/) {
fa64205d 1680 WARN("UTF8_BEFORE_PATCH",
15662b3e
JP
1681 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
1682 }
1683
30670854
AW
1684# ignore non-hunk lines and lines being removed
1685 next if (!$hunk_line || $line =~ /^-/);
0a920b5b 1686
0a920b5b 1687#trailing whitespace
9c0ca6f9 1688 if ($line =~ /^\+.*\015/) {
c2fdda0d 1689 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
000d1cc1
JP
1690 ERROR("DOS_LINE_ENDINGS",
1691 "DOS line endings\n" . $herevet);
9c0ca6f9 1692
c2fdda0d
AW
1693 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1694 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
000d1cc1
JP
1695 ERROR("TRAILING_WHITESPACE",
1696 "trailing whitespace\n" . $herevet);
d2c0a235 1697 $rpt_cleaners = 1;
0a920b5b 1698 }
5368df20 1699
3354957a 1700# check for Kconfig help text having a real description
9fe287d7
AW
1701# Only applies when adding the entry originally, after that we do not have
1702# sufficient context to determine whether it is indeed long enough.
3354957a 1703 if ($realfile =~ /Kconfig/ &&
a1385803 1704 $line =~ /.\s*config\s+/) {
3354957a 1705 my $length = 0;
9fe287d7
AW
1706 my $cnt = $realcnt;
1707 my $ln = $linenr + 1;
1708 my $f;
a1385803 1709 my $is_start = 0;
9fe287d7 1710 my $is_end = 0;
a1385803 1711 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
9fe287d7
AW
1712 $f = $lines[$ln - 1];
1713 $cnt-- if ($lines[$ln - 1] !~ /^-/);
1714 $is_end = $lines[$ln - 1] =~ /^\+/;
9fe287d7
AW
1715
1716 next if ($f =~ /^-/);
a1385803
AW
1717
1718 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
1719 $is_start = 1;
1720 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
1721 $length = -1;
1722 }
1723
9fe287d7 1724 $f =~ s/^.//;
3354957a
AK
1725 $f =~ s/#.*//;
1726 $f =~ s/^\s+//;
1727 next if ($f =~ /^$/);
9fe287d7
AW
1728 if ($f =~ /^\s*config\s/) {
1729 $is_end = 1;
1730 last;
1731 }
3354957a
AK
1732 $length++;
1733 }
000d1cc1 1734 WARN("CONFIG_DESCRIPTION",
a1385803
AW
1735 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
1736 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
3354957a
AK
1737 }
1738
1ba8dfd1
KC
1739# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
1740 if ($realfile =~ /Kconfig/ &&
1741 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
1742 WARN("CONFIG_EXPERIMENTAL",
1743 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
1744 }
1745
c68e5878
AL
1746 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
1747 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
1748 my $flag = $1;
1749 my $replacement = {
1750 'EXTRA_AFLAGS' => 'asflags-y',
1751 'EXTRA_CFLAGS' => 'ccflags-y',
1752 'EXTRA_CPPFLAGS' => 'cppflags-y',
1753 'EXTRA_LDFLAGS' => 'ldflags-y',
1754 };
1755
1756 WARN("DEPRECATED_VARIABLE",
1757 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
1758 }
1759
5368df20
AW
1760# check we are in a valid source file if not then ignore this hunk
1761 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1762
0a920b5b 1763#80 column limit
c45dcabd 1764 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
f4c014c0 1765 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
0fccc622 1766 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
8bbea968 1767 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
f4c014c0 1768 $length > 80)
c45dcabd 1769 {
000d1cc1
JP
1770 WARN("LONG_LINE",
1771 "line over 80 characters\n" . $herecurr);
0a920b5b
AW
1772 }
1773
ca56dc09
JT
1774# Check for user-visible strings broken across lines, which breaks the ability
1775# to grep for the string. Limited to strings used as parameters (those
1776# following an open parenthesis), which almost completely eliminates false
1777# positives, as well as warning only once per parameter rather than once per
1778# line of the string. Make an exception when the previous string ends in a
1779# newline (multiple lines in one string constant) or \n\t (common in inline
1780# assembly to indent the instruction on the following line).
1781 if ($line =~ /^\+\s*"/ &&
1782 $prevline =~ /"\s*$/ &&
1783 $prevline =~ /\(/ &&
1784 $prevrawline !~ /\\n(?:\\t)*"\s*$/) {
1785 WARN("SPLIT_STRING",
1786 "quoted string split across lines\n" . $hereprev);
1787 }
1788
5e79d96e
JP
1789# check for spaces before a quoted newline
1790 if ($rawline =~ /^.*\".*\s\\n/) {
000d1cc1
JP
1791 WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
1792 "unnecessary whitespace before a quoted newline\n" . $herecurr);
5e79d96e
JP
1793 }
1794
8905a67c
AW
1795# check for adding lines without a newline.
1796 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
000d1cc1
JP
1797 WARN("MISSING_EOF_NEWLINE",
1798 "adding a line without newline at end of file\n" . $herecurr);
8905a67c
AW
1799 }
1800
42e41c54
MF
1801# Blackfin: use hi/lo macros
1802 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
1803 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
1804 my $herevet = "$here\n" . cat_vet($line) . "\n";
000d1cc1
JP
1805 ERROR("LO_MACRO",
1806 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
42e41c54
MF
1807 }
1808 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
1809 my $herevet = "$here\n" . cat_vet($line) . "\n";
000d1cc1
JP
1810 ERROR("HI_MACRO",
1811 "use the HI() macro, not (... >> 16)\n" . $herevet);
42e41c54
MF
1812 }
1813 }
1814
b9ea10d6
AW
1815# check we are in a valid source file C or perl if not then ignore this hunk
1816 next if ($realfile !~ /\.(h|c|pl)$/);
0a920b5b
AW
1817
1818# at the beginning of a line any tabs must come first and anything
1819# more than 8 must use tabs.
c2fdda0d
AW
1820 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1821 $rawline =~ /^\+\s* \s*/) {
1822 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
000d1cc1
JP
1823 ERROR("CODE_INDENT",
1824 "code indent should use tabs where possible\n" . $herevet);
d2c0a235 1825 $rpt_cleaners = 1;
0a920b5b
AW
1826 }
1827
08e44365
AP
1828# check for space before tabs.
1829 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
1830 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
000d1cc1
JP
1831 WARN("SPACE_BEFORE_TAB",
1832 "please, no space before tabs\n" . $herevet);
08e44365
AP
1833 }
1834
d1fe9c09
JP
1835# check for && or || at the start of a line
1836 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
1837 CHK("LOGICAL_CONTINUATIONS",
1838 "Logical continuations should be on the previous line\n" . $hereprev);
1839 }
1840
1841# check multi-line statement indentation matches previous line
1842 if ($^V && $^V ge 5.10.0 &&
1843 $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) {
1844 $prevline =~ /^\+(\t*)(.*)$/;
1845 my $oldindent = $1;
1846 my $rest = $2;
1847
1848 my $pos = pos_last_openparen($rest);
1849 if ($pos >= 0) {
b34a26f3
JP
1850 $line =~ /^(\+| )([ \t]*)/;
1851 my $newindent = $2;
d1fe9c09
JP
1852
1853 my $goodtabindent = $oldindent .
1854 "\t" x ($pos / 8) .
1855 " " x ($pos % 8);
1856 my $goodspaceindent = $oldindent . " " x $pos;
1857
1858 if ($newindent ne $goodtabindent &&
1859 $newindent ne $goodspaceindent) {
1860 CHK("PARENTHESIS_ALIGNMENT",
1861 "Alignment should match open parenthesis\n" . $hereprev);
1862 }
1863 }
1864 }
1865
aad4f614
JP
1866 if ($line =~ /^\+.*\*[ \t]*\)[ \t]+/) {
1867 CHK("SPACING",
1868 "No space is necessary after a cast\n" . $hereprev);
1869 }
1870
05880600
JP
1871 if ($realfile =~ m@^(drivers/net/|net/)@ &&
1872 $rawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
1873 $prevrawline =~ /^\+[ \t]*$/) {
1874 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
1875 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
1876 }
1877
1878 if ($realfile =~ m@^(drivers/net/|net/)@ &&
c24f9f19
JP
1879 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
1880 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
1881 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
1882 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
05880600
JP
1883 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
1884 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
1885 }
1886
5f7ddae6 1887# check for spaces at the beginning of a line.
6b4c5beb
AW
1888# Exceptions:
1889# 1) within comments
1890# 2) indented preprocessor commands
1891# 3) hanging labels
1892 if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/) {
5f7ddae6 1893 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
000d1cc1
JP
1894 WARN("LEADING_SPACE",
1895 "please, no spaces at the start of a line\n" . $herevet);
5f7ddae6
RR
1896 }
1897
b9ea10d6
AW
1898# check we are in a valid C source file if not then ignore this hunk
1899 next if ($realfile !~ /\.(h|c)$/);
1900
1ba8dfd1
KC
1901# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
1902 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
1903 WARN("CONFIG_EXPERIMENTAL",
1904 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
1905 }
1906
c2fdda0d 1907# check for RCS/CVS revision markers
cf655043 1908 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
000d1cc1
JP
1909 WARN("CVS_KEYWORD",
1910 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
c2fdda0d 1911 }
22f2a2ef 1912
42e41c54
MF
1913# Blackfin: don't use __builtin_bfin_[cs]sync
1914 if ($line =~ /__builtin_bfin_csync/) {
1915 my $herevet = "$here\n" . cat_vet($line) . "\n";
000d1cc1
JP
1916 ERROR("CSYNC",
1917 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
42e41c54
MF
1918 }
1919 if ($line =~ /__builtin_bfin_ssync/) {
1920 my $herevet = "$here\n" . cat_vet($line) . "\n";
000d1cc1
JP
1921 ERROR("SSYNC",
1922 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
42e41c54
MF
1923 }
1924
9c0ca6f9 1925# Check for potential 'bare' types
2b474a1a
AW
1926 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
1927 $realline_next);
3e469cdc
AW
1928#print "LINE<$line>\n";
1929 if ($linenr >= $suppress_statement &&
1930 $realcnt && $line =~ /.\s*\S/) {
170d3a22 1931 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
f5fe35dd 1932 ctx_statement_block($linenr, $realcnt, 0);
171ae1a4
AW
1933 $stat =~ s/\n./\n /g;
1934 $cond =~ s/\n./\n /g;
1935
3e469cdc
AW
1936#print "linenr<$linenr> <$stat>\n";
1937 # If this statement has no statement boundaries within
1938 # it there is no point in retrying a statement scan
1939 # until we hit end of it.
1940 my $frag = $stat; $frag =~ s/;+\s*$//;
1941 if ($frag !~ /(?:{|;)/) {
1942#print "skip<$line_nr_next>\n";
1943 $suppress_statement = $line_nr_next;
1944 }
f74bd194 1945
2b474a1a
AW
1946 # Find the real next line.
1947 $realline_next = $line_nr_next;
1948 if (defined $realline_next &&
1949 (!defined $lines[$realline_next - 1] ||
1950 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
1951 $realline_next++;
1952 }
1953
171ae1a4
AW
1954 my $s = $stat;
1955 $s =~ s/{.*$//s;
cf655043 1956
c2fdda0d 1957 # Ignore goto labels.
171ae1a4 1958 if ($s =~ /$Ident:\*$/s) {
c2fdda0d
AW
1959
1960 # Ignore functions being called
171ae1a4 1961 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
c2fdda0d 1962
463f2864
AW
1963 } elsif ($s =~ /^.\s*else\b/s) {
1964
c45dcabd 1965 # declarations always start with types
d2506586 1966 } 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
1967 my $type = $1;
1968 $type =~ s/\s+/ /g;
1969 possible($type, "A:" . $s);
1970
8905a67c 1971 # definitions in global scope can only start with types
a6a84062 1972 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
c45dcabd 1973 possible($1, "B:" . $s);
c2fdda0d 1974 }
8905a67c
AW
1975
1976 # any (foo ... *) is a pointer cast, and foo is a type
65863862 1977 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
c45dcabd 1978 possible($1, "C:" . $s);
8905a67c
AW
1979 }
1980
1981 # Check for any sort of function declaration.
1982 # int foo(something bar, other baz);
1983 # void (*store_gdt)(x86_descr_ptr *);
171ae1a4 1984 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
8905a67c 1985 my ($name_len) = length($1);
8905a67c 1986
cf655043 1987 my $ctx = $s;
773647a0 1988 substr($ctx, 0, $name_len + 1, '');
8905a67c 1989 $ctx =~ s/\)[^\)]*$//;
cf655043 1990
8905a67c 1991 for my $arg (split(/\s*,\s*/, $ctx)) {
c45dcabd 1992 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
8905a67c 1993
c45dcabd 1994 possible($1, "D:" . $s);
8905a67c
AW
1995 }
1996 }
9c0ca6f9 1997 }
8905a67c 1998
9c0ca6f9
AW
1999 }
2000
653d4876
AW
2001#
2002# Checks which may be anchored in the context.
2003#
00df344f 2004
653d4876
AW
2005# Check for switch () and associated case and default
2006# statements should be at the same indent.
00df344f
AW
2007 if ($line=~/\bswitch\s*\(.*\)/) {
2008 my $err = '';
2009 my $sep = '';
2010 my @ctx = ctx_block_outer($linenr, $realcnt);
2011 shift(@ctx);
2012 for my $ctx (@ctx) {
2013 my ($clen, $cindent) = line_stats($ctx);
2014 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2015 $indent != $cindent) {
2016 $err .= "$sep$ctx\n";
2017 $sep = '';
2018 } else {
2019 $sep = "[...]\n";
2020 }
2021 }
2022 if ($err ne '') {
000d1cc1
JP
2023 ERROR("SWITCH_CASE_INDENT_LEVEL",
2024 "switch and case should be at the same indent\n$hereline$err");
de7d4f0e
AW
2025 }
2026 }
2027
2028# if/while/etc brace do not go on next line, unless defining a do while loop,
2029# or if that brace on the next line is for something else
c45dcabd 2030 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
773647a0
AW
2031 my $pre_ctx = "$1$2";
2032
9c0ca6f9 2033 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
8eef05dd
JP
2034
2035 if ($line =~ /^\+\t{6,}/) {
2036 WARN("DEEP_INDENTATION",
2037 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2038 }
2039
de7d4f0e
AW
2040 my $ctx_cnt = $realcnt - $#ctx - 1;
2041 my $ctx = join("\n", @ctx);
2042
548596d5
AW
2043 my $ctx_ln = $linenr;
2044 my $ctx_skip = $realcnt;
773647a0 2045
548596d5
AW
2046 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2047 defined $lines[$ctx_ln - 1] &&
2048 $lines[$ctx_ln - 1] =~ /^-/)) {
2049 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2050 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
de7d4f0e 2051 $ctx_ln++;
de7d4f0e 2052 }
548596d5 2053
53210168
AW
2054 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2055 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
de7d4f0e 2056
773647a0 2057 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
000d1cc1
JP
2058 ERROR("OPEN_BRACE",
2059 "that open brace { should be on the previous line\n" .
01464f30 2060 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
00df344f 2061 }
773647a0
AW
2062 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2063 $ctx =~ /\)\s*\;\s*$/ &&
2064 defined $lines[$ctx_ln - 1])
2065 {
9c0ca6f9
AW
2066 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2067 if ($nindent > $indent) {
000d1cc1
JP
2068 WARN("TRAILING_SEMICOLON",
2069 "trailing semicolon indicates no statements, indent implies otherwise\n" .
01464f30 2070 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
9c0ca6f9
AW
2071 }
2072 }
00df344f
AW
2073 }
2074
4d001e4d
AW
2075# Check relative indent for conditionals and blocks.
2076 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3e469cdc
AW
2077 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2078 ctx_statement_block($linenr, $realcnt, 0)
2079 if (!defined $stat);
4d001e4d
AW
2080 my ($s, $c) = ($stat, $cond);
2081
2082 substr($s, 0, length($c), '');
2083
2084 # Make sure we remove the line prefixes as we have
2085 # none on the first line, and are going to readd them
2086 # where necessary.
2087 $s =~ s/\n./\n/gs;
2088
2089 # Find out how long the conditional actually is.
6f779c18
AW
2090 my @newlines = ($c =~ /\n/gs);
2091 my $cond_lines = 1 + $#newlines;
4d001e4d
AW
2092
2093 # We want to check the first line inside the block
2094 # starting at the end of the conditional, so remove:
2095 # 1) any blank line termination
2096 # 2) any opening brace { on end of the line
2097 # 3) any do (...) {
2098 my $continuation = 0;
2099 my $check = 0;
2100 $s =~ s/^.*\bdo\b//;
2101 $s =~ s/^\s*{//;
2102 if ($s =~ s/^\s*\\//) {
2103 $continuation = 1;
2104 }
9bd49efe 2105 if ($s =~ s/^\s*?\n//) {
4d001e4d
AW
2106 $check = 1;
2107 $cond_lines++;
2108 }
2109
2110 # Also ignore a loop construct at the end of a
2111 # preprocessor statement.
2112 if (($prevline =~ /^.\s*#\s*define\s/ ||
2113 $prevline =~ /\\\s*$/) && $continuation == 0) {
2114 $check = 0;
2115 }
2116
9bd49efe 2117 my $cond_ptr = -1;
740504c6 2118 $continuation = 0;
9bd49efe
AW
2119 while ($cond_ptr != $cond_lines) {
2120 $cond_ptr = $cond_lines;
2121
f16fa28f
AW
2122 # If we see an #else/#elif then the code
2123 # is not linear.
2124 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2125 $check = 0;
2126 }
2127
9bd49efe
AW
2128 # Ignore:
2129 # 1) blank lines, they should be at 0,
2130 # 2) preprocessor lines, and
2131 # 3) labels.
740504c6
AW
2132 if ($continuation ||
2133 $s =~ /^\s*?\n/ ||
9bd49efe
AW
2134 $s =~ /^\s*#\s*?/ ||
2135 $s =~ /^\s*$Ident\s*:/) {
740504c6 2136 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
30dad6eb
AW
2137 if ($s =~ s/^.*?\n//) {
2138 $cond_lines++;
2139 }
9bd49efe 2140 }
4d001e4d
AW
2141 }
2142
2143 my (undef, $sindent) = line_stats("+" . $s);
2144 my $stat_real = raw_line($linenr, $cond_lines);
2145
2146 # Check if either of these lines are modified, else
2147 # this is not this patch's fault.
2148 if (!defined($stat_real) ||
2149 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2150 $check = 0;
2151 }
2152 if (defined($stat_real) && $cond_lines > 1) {
2153 $stat_real = "[...]\n$stat_real";
2154 }
2155
9bd49efe 2156 #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
2157
2158 if ($check && (($sindent % 8) != 0 ||
2159 ($sindent <= $indent && $s ne ''))) {
000d1cc1
JP
2160 WARN("SUSPECT_CODE_INDENT",
2161 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
4d001e4d
AW
2162 }
2163 }
2164
6c72ffaa
AW
2165 # Track the 'values' across context and added lines.
2166 my $opline = $line; $opline =~ s/^./ /;
1f65f947
AW
2167 my ($curr_values, $curr_vars) =
2168 annotate_values($opline . "\n", $prev_values);
6c72ffaa 2169 $curr_values = $prev_values . $curr_values;
c2fdda0d
AW
2170 if ($dbg_values) {
2171 my $outline = $opline; $outline =~ s/\t/ /g;
cf655043
AW
2172 print "$linenr > .$outline\n";
2173 print "$linenr > $curr_values\n";
1f65f947 2174 print "$linenr > $curr_vars\n";
c2fdda0d 2175 }
6c72ffaa
AW
2176 $prev_values = substr($curr_values, -1);
2177
00df344f
AW
2178#ignore lines not being added
2179 if ($line=~/^[^\+]/) {next;}
2180
653d4876 2181# TEST: allow direct testing of the type matcher.
7429c690
AW
2182 if ($dbg_type) {
2183 if ($line =~ /^.\s*$Declare\s*$/) {
000d1cc1
JP
2184 ERROR("TEST_TYPE",
2185 "TEST: is type\n" . $herecurr);
7429c690 2186 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
000d1cc1
JP
2187 ERROR("TEST_NOT_TYPE",
2188 "TEST: is not type ($1 is)\n". $herecurr);
7429c690 2189 }
653d4876
AW
2190 next;
2191 }
a1ef277e
AW
2192# TEST: allow direct testing of the attribute matcher.
2193 if ($dbg_attr) {
9360b0e5 2194 if ($line =~ /^.\s*$Modifier\s*$/) {
000d1cc1
JP
2195 ERROR("TEST_ATTR",
2196 "TEST: is attr\n" . $herecurr);
9360b0e5 2197 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
000d1cc1
JP
2198 ERROR("TEST_NOT_ATTR",
2199 "TEST: is not attr ($1 is)\n". $herecurr);
a1ef277e
AW
2200 }
2201 next;
2202 }
653d4876 2203
f0a594c1 2204# check for initialisation to aggregates open brace on the next line
99423c20
AW
2205 if ($line =~ /^.\s*{/ &&
2206 $prevline =~ /(?:^|[^=])=\s*$/) {
000d1cc1
JP
2207 ERROR("OPEN_BRACE",
2208 "that open brace { should be on the previous line\n" . $hereprev);
f0a594c1
AW
2209 }
2210
653d4876
AW
2211#
2212# Checks which are anchored on the added line.
2213#
2214
2215# check for malformed paths in #include statements (uses RAW line)
c45dcabd 2216 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
653d4876
AW
2217 my $path = $1;
2218 if ($path =~ m{//}) {
000d1cc1
JP
2219 ERROR("MALFORMED_INCLUDE",
2220 "malformed #include filename\n" .
de7d4f0e 2221 $herecurr);
653d4876 2222 }
653d4876 2223 }
00df344f 2224
0a920b5b 2225# no C99 // comments
00df344f 2226 if ($line =~ m{//}) {
000d1cc1
JP
2227 ERROR("C99_COMMENTS",
2228 "do not use C99 // comments\n" . $herecurr);
0a920b5b 2229 }
00df344f 2230 # Remove C99 comments.
0a920b5b 2231 $line =~ s@//.*@@;
6c72ffaa 2232 $opline =~ s@//.*@@;
0a920b5b 2233
2b474a1a
AW
2234# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2235# the whole statement.
2236#print "APW <$lines[$realline_next - 1]>\n";
2237 if (defined $realline_next &&
2238 exists $lines[$realline_next - 1] &&
2239 !defined $suppress_export{$realline_next} &&
2240 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2241 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3cbf62df
AW
2242 # Handle definitions which produce identifiers with
2243 # a prefix:
2244 # XXX(foo);
2245 # EXPORT_SYMBOL(something_foo);
653d4876 2246 my $name = $1;
87a53877 2247 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
3cbf62df
AW
2248 $name =~ /^${Ident}_$2/) {
2249#print "FOO C name<$name>\n";
2250 $suppress_export{$realline_next} = 1;
2251
2252 } elsif ($stat !~ /(?:
2b474a1a 2253 \n.}\s*$|
48012058
AW
2254 ^.DEFINE_$Ident\(\Q$name\E\)|
2255 ^.DECLARE_$Ident\(\Q$name\E\)|
2256 ^.LIST_HEAD\(\Q$name\E\)|
2b474a1a
AW
2257 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2258 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
48012058 2259 )/x) {
2b474a1a
AW
2260#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2261 $suppress_export{$realline_next} = 2;
2262 } else {
2263 $suppress_export{$realline_next} = 1;
0a920b5b
AW
2264 }
2265 }
2b474a1a
AW
2266 if (!defined $suppress_export{$linenr} &&
2267 $prevline =~ /^.\s*$/ &&
2268 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2269 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2270#print "FOO B <$lines[$linenr - 1]>\n";
2271 $suppress_export{$linenr} = 2;
2272 }
2273 if (defined $suppress_export{$linenr} &&
2274 $suppress_export{$linenr} == 2) {
000d1cc1
JP
2275 WARN("EXPORT_SYMBOL",
2276 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
2b474a1a 2277 }
0a920b5b 2278
5150bda4 2279# check for global initialisers.
c45dcabd 2280 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
000d1cc1
JP
2281 ERROR("GLOBAL_INITIALISERS",
2282 "do not initialise globals to 0 or NULL\n" .
f0a594c1
AW
2283 $herecurr);
2284 }
653d4876 2285# check for static initialisers.
2d1bafd7 2286 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
000d1cc1
JP
2287 ERROR("INITIALISED_STATIC",
2288 "do not initialise statics to 0 or NULL\n" .
de7d4f0e 2289 $herecurr);
0a920b5b
AW
2290 }
2291
cb710eca
JP
2292# check for static const char * arrays.
2293 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
000d1cc1
JP
2294 WARN("STATIC_CONST_CHAR_ARRAY",
2295 "static const char * array should probably be static const char * const\n" .
cb710eca
JP
2296 $herecurr);
2297 }
2298
2299# check for static char foo[] = "bar" declarations.
2300 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
000d1cc1
JP
2301 WARN("STATIC_CONST_CHAR_ARRAY",
2302 "static char array declaration should probably be static const char\n" .
cb710eca
JP
2303 $herecurr);
2304 }
2305
93ed0e2d
JP
2306# check for declarations of struct pci_device_id
2307 if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) {
000d1cc1
JP
2308 WARN("DEFINE_PCI_DEVICE_TABLE",
2309 "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr);
93ed0e2d
JP
2310 }
2311
653d4876
AW
2312# check for new typedefs, only function parameters and sparse annotations
2313# make sense.
2314 if ($line =~ /\btypedef\s/ &&
8054576d 2315 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
c45dcabd 2316 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
8ed22cad 2317 $line !~ /\b$typeTypedefs\b/ &&
653d4876 2318 $line !~ /\b__bitwise(?:__|)\b/) {
000d1cc1
JP
2319 WARN("NEW_TYPEDEFS",
2320 "do not add new typedefs\n" . $herecurr);
0a920b5b
AW
2321 }
2322
2323# * goes on variable not on type
65863862 2324 # (char*[ const])
bfcb2cc7
AW
2325 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2326 #print "AA<$1>\n";
2327 my ($from, $to) = ($2, $2);
65863862
AW
2328
2329 # Should start with a space.
2330 $to =~ s/^(\S)/ $1/;
2331 # Should not end with a space.
2332 $to =~ s/\s+$//;
2333 # '*'s should not have spaces between.
f9a0b3d1 2334 while ($to =~ s/\*\s+\*/\*\*/) {
65863862 2335 }
d8aaf121 2336
65863862
AW
2337 #print "from<$from> to<$to>\n";
2338 if ($from ne $to) {
000d1cc1
JP
2339 ERROR("POINTER_LOCATION",
2340 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr);
65863862 2341 }
bfcb2cc7
AW
2342 }
2343 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2344 #print "BB<$1>\n";
2345 my ($from, $to, $ident) = ($2, $2, $3);
65863862
AW
2346
2347 # Should start with a space.
2348 $to =~ s/^(\S)/ $1/;
2349 # Should not end with a space.
2350 $to =~ s/\s+$//;
2351 # '*'s should not have spaces between.
f9a0b3d1 2352 while ($to =~ s/\*\s+\*/\*\*/) {
65863862
AW
2353 }
2354 # Modifiers should have spaces.
2355 $to =~ s/(\b$Modifier$)/$1 /;
d8aaf121 2356
667026e7
AW
2357 #print "from<$from> to<$to> ident<$ident>\n";
2358 if ($from ne $to && $ident !~ /^$Modifier$/) {
000d1cc1
JP
2359 ERROR("POINTER_LOCATION",
2360 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr);
65863862 2361 }
0a920b5b
AW
2362 }
2363
2364# # no BUG() or BUG_ON()
2365# if ($line =~ /\b(BUG|BUG_ON)\b/) {
2366# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2367# print "$herecurr";
2368# $clean = 0;
2369# }
2370
8905a67c 2371 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
000d1cc1
JP
2372 WARN("LINUX_VERSION_CODE",
2373 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
8905a67c
AW
2374 }
2375
17441227
JP
2376# check for uses of printk_ratelimit
2377 if ($line =~ /\bprintk_ratelimit\s*\(/) {
000d1cc1
JP
2378 WARN("PRINTK_RATELIMITED",
2379"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
17441227
JP
2380 }
2381
00df344f
AW
2382# printk should use KERN_* levels. Note that follow on printk's on the
2383# same line do not need a level, so we use the current block context
2384# to try and find and validate the current printk. In summary the current
25985edc 2385# printk includes all preceding printk's which have no newline on the end.
00df344f 2386# we assume the first bad printk is the one to report.
f0a594c1 2387 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
00df344f
AW
2388 my $ok = 0;
2389 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2390 #print "CHECK<$lines[$ln - 1]\n";
25985edc 2391 # we have a preceding printk if it ends
00df344f
AW
2392 # with "\n" ignore it, else it is to blame
2393 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2394 if ($rawlines[$ln - 1] !~ m{\\n"}) {
2395 $ok = 1;
2396 }
2397 last;
2398 }
2399 }
2400 if ($ok == 0) {
000d1cc1
JP
2401 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2402 "printk() should include KERN_ facility level\n" . $herecurr);
00df344f 2403 }
0a920b5b
AW
2404 }
2405
243f3803
JP
2406 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
2407 my $orig = $1;
2408 my $level = lc($orig);
2409 $level = "warn" if ($level eq "warning");
8f26b837
JP
2410 my $level2 = $level;
2411 $level2 = "dbg" if ($level eq "debug");
243f3803 2412 WARN("PREFER_PR_LEVEL",
8f26b837 2413 "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
243f3803
JP
2414 }
2415
2416 if ($line =~ /\bpr_warning\s*\(/) {
2417 WARN("PREFER_PR_LEVEL",
2418 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr);
2419 }
2420
653d4876
AW
2421# function brace can't be on same line, except for #defines of do while,
2422# or if closed on same line
c45dcabd
AW
2423 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2424 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
000d1cc1
JP
2425 ERROR("OPEN_BRACE",
2426 "open brace '{' following function declarations go on the next line\n" . $herecurr);
0a920b5b 2427 }
653d4876 2428
8905a67c
AW
2429# open braces for enum, union and struct go on the same line.
2430 if ($line =~ /^.\s*{/ &&
2431 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
000d1cc1
JP
2432 ERROR("OPEN_BRACE",
2433 "open brace '{' following $1 go on the same line\n" . $hereprev);
8905a67c
AW
2434 }
2435
0c73b4eb
AW
2436# missing space after union, struct or enum definition
2437 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) {
000d1cc1
JP
2438 WARN("SPACING",
2439 "missing space after $1 definition\n" . $herecurr);
0c73b4eb
AW
2440 }
2441
8d31cfce
AW
2442# check for spacing round square brackets; allowed:
2443# 1. with a type on the left -- int [] a;
fe2a7dbc
AW
2444# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2445# 3. inside a curly brace -- = { [0...10] = 5 }
8d31cfce
AW
2446 while ($line =~ /(.*?\s)\[/g) {
2447 my ($where, $prefix) = ($-[1], $1);
2448 if ($prefix !~ /$Type\s+$/ &&
fe2a7dbc 2449 ($where != 0 || $prefix !~ /^.\s+$/) &&
daebc534 2450 $prefix !~ /[{,]\s+$/) {
000d1cc1
JP
2451 ERROR("BRACKET_SPACE",
2452 "space prohibited before open square bracket '['\n" . $herecurr);
8d31cfce
AW
2453 }
2454 }
2455
f0a594c1 2456# check for spaces between functions and their parentheses.
6c72ffaa 2457 while ($line =~ /($Ident)\s+\(/g) {
c2fdda0d 2458 my $name = $1;
773647a0
AW
2459 my $ctx_before = substr($line, 0, $-[1]);
2460 my $ctx = "$ctx_before$name";
c2fdda0d
AW
2461
2462 # Ignore those directives where spaces _are_ permitted.
773647a0
AW
2463 if ($name =~ /^(?:
2464 if|for|while|switch|return|case|
2465 volatile|__volatile__|
2466 __attribute__|format|__extension__|
2467 asm|__asm__)$/x)
2468 {
c2fdda0d
AW
2469
2470 # cpp #define statements have non-optional spaces, ie
2471 # if there is a space between the name and the open
2472 # parenthesis it is simply not a parameter group.
c45dcabd 2473 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
773647a0
AW
2474
2475 # cpp #elif statement condition may start with a (
c45dcabd 2476 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
c2fdda0d
AW
2477
2478 # If this whole things ends with a type its most
2479 # likely a typedef for a function.
773647a0 2480 } elsif ($ctx =~ /$Type$/) {
c2fdda0d
AW
2481
2482 } else {
000d1cc1
JP
2483 WARN("SPACING",
2484 "space prohibited between function name and open parenthesis '('\n" . $herecurr);
6c72ffaa 2485 }
f0a594c1 2486 }
9a4cad4e
EN
2487
2488# check for whitespace before a non-naked semicolon
2489 if ($line =~ /^\+.*\S\s+;/) {
2490 CHK("SPACING",
2491 "space prohibited before semicolon\n" . $herecurr);
2492 }
2493
653d4876 2494# Check operator spacing.
0a920b5b 2495 if (!($line=~/\#\s*include/)) {
9c0ca6f9
AW
2496 my $ops = qr{
2497 <<=|>>=|<=|>=|==|!=|
2498 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
2499 =>|->|<<|>>|<|>|=|!|~|
1f65f947
AW
2500 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
2501 \?|:
9c0ca6f9 2502 }x;
cf655043 2503 my @elements = split(/($ops|;)/, $opline);
00df344f 2504 my $off = 0;
6c72ffaa
AW
2505
2506 my $blank = copy_spacing($opline);
2507
0a920b5b 2508 for (my $n = 0; $n < $#elements; $n += 2) {
4a0df2ef
AW
2509 $off += length($elements[$n]);
2510
25985edc 2511 # Pick up the preceding and succeeding characters.
773647a0
AW
2512 my $ca = substr($opline, 0, $off);
2513 my $cc = '';
2514 if (length($opline) >= ($off + length($elements[$n + 1]))) {
2515 $cc = substr($opline, $off + length($elements[$n + 1]));
2516 }
2517 my $cb = "$ca$;$cc";
2518
4a0df2ef
AW
2519 my $a = '';
2520 $a = 'V' if ($elements[$n] ne '');
2521 $a = 'W' if ($elements[$n] =~ /\s$/);
cf655043 2522 $a = 'C' if ($elements[$n] =~ /$;$/);
4a0df2ef
AW
2523 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
2524 $a = 'O' if ($elements[$n] eq '');
773647a0 2525 $a = 'E' if ($ca =~ /^\s*$/);
4a0df2ef 2526
0a920b5b 2527 my $op = $elements[$n + 1];
4a0df2ef
AW
2528
2529 my $c = '';
0a920b5b 2530 if (defined $elements[$n + 2]) {
4a0df2ef
AW
2531 $c = 'V' if ($elements[$n + 2] ne '');
2532 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
cf655043 2533 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
4a0df2ef
AW
2534 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
2535 $c = 'O' if ($elements[$n + 2] eq '');
8b1b3378 2536 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
4a0df2ef
AW
2537 } else {
2538 $c = 'E';
0a920b5b
AW
2539 }
2540
4a0df2ef
AW
2541 my $ctx = "${a}x${c}";
2542
2543 my $at = "(ctx:$ctx)";
2544
6c72ffaa 2545 my $ptr = substr($blank, 0, $off) . "^";
de7d4f0e 2546 my $hereptr = "$hereline$ptr\n";
0a920b5b 2547
74048ed8 2548 # Pull out the value of this operator.
6c72ffaa 2549 my $op_type = substr($curr_values, $off + 1, 1);
0a920b5b 2550
1f65f947
AW
2551 # Get the full operator variant.
2552 my $opv = $op . substr($curr_vars, $off, 1);
2553
13214adf
AW
2554 # Ignore operators passed as parameters.
2555 if ($op_type ne 'V' &&
2556 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
2557
cf655043
AW
2558# # Ignore comments
2559# } elsif ($op =~ /^$;+$/) {
13214adf 2560
d8aaf121 2561 # ; should have either the end of line or a space or \ after it
13214adf 2562 } elsif ($op eq ';') {
cf655043
AW
2563 if ($ctx !~ /.x[WEBC]/ &&
2564 $cc !~ /^\\/ && $cc !~ /^;/) {
000d1cc1
JP
2565 ERROR("SPACING",
2566 "space required after that '$op' $at\n" . $hereptr);
d8aaf121
AW
2567 }
2568
2569 # // is a comment
2570 } elsif ($op eq '//') {
0a920b5b 2571
1f65f947
AW
2572 # No spaces for:
2573 # ->
2574 # : when part of a bitfield
2575 } elsif ($op eq '->' || $opv eq ':B') {
4a0df2ef 2576 if ($ctx =~ /Wx.|.xW/) {
000d1cc1
JP
2577 ERROR("SPACING",
2578 "spaces prohibited around that '$op' $at\n" . $hereptr);
0a920b5b
AW
2579 }
2580
2581 # , must have a space on the right.
2582 } elsif ($op eq ',') {
cf655043 2583 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
000d1cc1
JP
2584 ERROR("SPACING",
2585 "space required after that '$op' $at\n" . $hereptr);
0a920b5b
AW
2586 }
2587
9c0ca6f9 2588 # '*' as part of a type definition -- reported already.
74048ed8 2589 } elsif ($opv eq '*_') {
9c0ca6f9
AW
2590 #warn "'*' is part of type\n";
2591
2592 # unary operators should have a space before and
2593 # none after. May be left adjacent to another
2594 # unary operator, or a cast
2595 } elsif ($op eq '!' || $op eq '~' ||
74048ed8 2596 $opv eq '*U' || $opv eq '-U' ||
0d413866 2597 $opv eq '&U' || $opv eq '&&U') {
cf655043 2598 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
000d1cc1
JP
2599 ERROR("SPACING",
2600 "space required before that '$op' $at\n" . $hereptr);
0a920b5b 2601 }
a3340b35 2602 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
171ae1a4
AW
2603 # A unary '*' may be const
2604
2605 } elsif ($ctx =~ /.xW/) {
000d1cc1
JP
2606 ERROR("SPACING",
2607 "space prohibited after that '$op' $at\n" . $hereptr);
0a920b5b
AW
2608 }
2609
2610 # unary ++ and unary -- are allowed no space on one side.
2611 } elsif ($op eq '++' or $op eq '--') {
773647a0 2612 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
000d1cc1
JP
2613 ERROR("SPACING",
2614 "space required one side of that '$op' $at\n" . $hereptr);
773647a0
AW
2615 }
2616 if ($ctx =~ /Wx[BE]/ ||
2617 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
000d1cc1
JP
2618 ERROR("SPACING",
2619 "space prohibited before that '$op' $at\n" . $hereptr);
0a920b5b 2620 }
773647a0 2621 if ($ctx =~ /ExW/) {
000d1cc1
JP
2622 ERROR("SPACING",
2623 "space prohibited after that '$op' $at\n" . $hereptr);
653d4876 2624 }
0a920b5b 2625
773647a0 2626
0a920b5b 2627 # << and >> may either have or not have spaces both sides
9c0ca6f9
AW
2628 } elsif ($op eq '<<' or $op eq '>>' or
2629 $op eq '&' or $op eq '^' or $op eq '|' or
2630 $op eq '+' or $op eq '-' or
c2fdda0d
AW
2631 $op eq '*' or $op eq '/' or
2632 $op eq '%')
0a920b5b 2633 {
773647a0 2634 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
000d1cc1
JP
2635 ERROR("SPACING",
2636 "need consistent spacing around '$op' $at\n" .
de7d4f0e 2637 $hereptr);
0a920b5b
AW
2638 }
2639
1f65f947
AW
2640 # A colon needs no spaces before when it is
2641 # terminating a case value or a label.
2642 } elsif ($opv eq ':C' || $opv eq ':L') {
2643 if ($ctx =~ /Wx./) {
000d1cc1
JP
2644 ERROR("SPACING",
2645 "space prohibited before that '$op' $at\n" . $hereptr);
1f65f947
AW
2646 }
2647
0a920b5b 2648 # All the others need spaces both sides.
cf655043 2649 } elsif ($ctx !~ /[EWC]x[CWE]/) {
1f65f947
AW
2650 my $ok = 0;
2651
22f2a2ef 2652 # Ignore email addresses <foo@bar>
1f65f947
AW
2653 if (($op eq '<' &&
2654 $cc =~ /^\S+\@\S+>/) ||
2655 ($op eq '>' &&
2656 $ca =~ /<\S+\@\S+$/))
2657 {
2658 $ok = 1;
2659 }
2660
2661 # Ignore ?:
2662 if (($opv eq ':O' && $ca =~ /\?$/) ||
2663 ($op eq '?' && $cc =~ /^:/)) {
2664 $ok = 1;
2665 }
2666
2667 if ($ok == 0) {
000d1cc1
JP
2668 ERROR("SPACING",
2669 "spaces required around that '$op' $at\n" . $hereptr);
22f2a2ef 2670 }
0a920b5b 2671 }
4a0df2ef 2672 $off += length($elements[$n + 1]);
0a920b5b
AW
2673 }
2674 }
2675
f0a594c1
AW
2676# check for multiple assignments
2677 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
000d1cc1
JP
2678 CHK("MULTIPLE_ASSIGNMENTS",
2679 "multiple assignments should be avoided\n" . $herecurr);
f0a594c1
AW
2680 }
2681
22f2a2ef
AW
2682## # check for multiple declarations, allowing for a function declaration
2683## # continuation.
2684## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
2685## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
2686##
2687## # Remove any bracketed sections to ensure we do not
2688## # falsly report the parameters of functions.
2689## my $ln = $line;
2690## while ($ln =~ s/\([^\(\)]*\)//g) {
2691## }
2692## if ($ln =~ /,/) {
000d1cc1
JP
2693## WARN("MULTIPLE_DECLARATION",
2694## "declaring multiple variables together should be avoided\n" . $herecurr);
22f2a2ef
AW
2695## }
2696## }
f0a594c1 2697
0a920b5b 2698#need space before brace following if, while, etc
22f2a2ef
AW
2699 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
2700 $line =~ /do{/) {
000d1cc1
JP
2701 ERROR("SPACING",
2702 "space required before the open brace '{'\n" . $herecurr);
de7d4f0e
AW
2703 }
2704
2705# closing brace should have a space following it when it has anything
2706# on the line
2707 if ($line =~ /}(?!(?:,|;|\)))\S/) {
000d1cc1
JP
2708 ERROR("SPACING",
2709 "space required after that close brace '}'\n" . $herecurr);
0a920b5b
AW
2710 }
2711
22f2a2ef
AW
2712# check spacing on square brackets
2713 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
000d1cc1
JP
2714 ERROR("SPACING",
2715 "space prohibited after that open square bracket '['\n" . $herecurr);
22f2a2ef
AW
2716 }
2717 if ($line =~ /\s\]/) {
000d1cc1
JP
2718 ERROR("SPACING",
2719 "space prohibited before that close square bracket ']'\n" . $herecurr);
22f2a2ef
AW
2720 }
2721
c45dcabd 2722# check spacing on parentheses
9c0ca6f9
AW
2723 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
2724 $line !~ /for\s*\(\s+;/) {
000d1cc1
JP
2725 ERROR("SPACING",
2726 "space prohibited after that open parenthesis '('\n" . $herecurr);
22f2a2ef 2727 }
13214adf 2728 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
c45dcabd
AW
2729 $line !~ /for\s*\(.*;\s+\)/ &&
2730 $line !~ /:\s+\)/) {
000d1cc1
JP
2731 ERROR("SPACING",
2732 "space prohibited before that close parenthesis ')'\n" . $herecurr);
22f2a2ef
AW
2733 }
2734
0a920b5b 2735#goto labels aren't indented, allow a single space however
4a0df2ef 2736 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
0a920b5b 2737 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
000d1cc1
JP
2738 WARN("INDENTED_LABEL",
2739 "labels should not be indented\n" . $herecurr);
0a920b5b
AW
2740 }
2741
c45dcabd
AW
2742# Return is not a function.
2743 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2744 my $spacing = $1;
2745 my $value = $2;
2746
86f9d059 2747 # Flatten any parentheses
fb2d2c1b
AW
2748 $value =~ s/\(/ \(/g;
2749 $value =~ s/\)/\) /g;
e01886ad 2750 while ($value =~ s/\[[^\[\]]*\]/1/ ||
63f17f89
AW
2751 $value !~ /(?:$Ident|-?$Constant)\s*
2752 $Compare\s*
2753 (?:$Ident|-?$Constant)/x &&
2754 $value =~ s/\([^\(\)]*\)/1/) {
c45dcabd 2755 }
fb2d2c1b
AW
2756#print "value<$value>\n";
2757 if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
000d1cc1
JP
2758 ERROR("RETURN_PARENTHESES",
2759 "return is not a function, parentheses are not required\n" . $herecurr);
c45dcabd
AW
2760
2761 } elsif ($spacing !~ /\s+/) {
000d1cc1
JP
2762 ERROR("SPACING",
2763 "space required before the open parenthesis '('\n" . $herecurr);
c45dcabd
AW
2764 }
2765 }
53a3c448
AW
2766# Return of what appears to be an errno should normally be -'ve
2767 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
2768 my $name = $1;
2769 if ($name ne 'EOF' && $name ne 'ERROR') {
000d1cc1
JP
2770 WARN("USE_NEGATIVE_ERRNO",
2771 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
53a3c448
AW
2772 }
2773 }
c45dcabd 2774
0a920b5b 2775# Need a space before open parenthesis after if, while etc
4a0df2ef 2776 if ($line=~/\b(if|while|for|switch)\(/) {
000d1cc1 2777 ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr);
0a920b5b
AW
2778 }
2779
f5fe35dd
AW
2780# Check for illegal assignment in if conditional -- and check for trailing
2781# statements after the conditional.
170d3a22 2782 if ($line =~ /do\s*(?!{)/) {
3e469cdc
AW
2783 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2784 ctx_statement_block($linenr, $realcnt, 0)
2785 if (!defined $stat);
170d3a22
AW
2786 my ($stat_next) = ctx_statement_block($line_nr_next,
2787 $remain_next, $off_next);
2788 $stat_next =~ s/\n./\n /g;
2789 ##print "stat<$stat> stat_next<$stat_next>\n";
2790
2791 if ($stat_next =~ /^\s*while\b/) {
2792 # If the statement carries leading newlines,
2793 # then count those as offsets.
2794 my ($whitespace) =
2795 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2796 my $offset =
2797 statement_rawlines($whitespace) - 1;
2798
2799 $suppress_whiletrailers{$line_nr_next +
2800 $offset} = 1;
2801 }
2802 }
2803 if (!defined $suppress_whiletrailers{$linenr} &&
2804 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
171ae1a4 2805 my ($s, $c) = ($stat, $cond);
8905a67c 2806
b53c8e10 2807 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
000d1cc1
JP
2808 ERROR("ASSIGN_IN_IF",
2809 "do not use assignment in if condition\n" . $herecurr);
8905a67c
AW
2810 }
2811
2812 # Find out what is on the end of the line after the
2813 # conditional.
773647a0 2814 substr($s, 0, length($c), '');
8905a67c 2815 $s =~ s/\n.*//g;
13214adf 2816 $s =~ s/$;//g; # Remove any comments
53210168
AW
2817 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2818 $c !~ /}\s*while\s*/)
773647a0 2819 {
bb44ad39
AW
2820 # Find out how long the conditional actually is.
2821 my @newlines = ($c =~ /\n/gs);
2822 my $cond_lines = 1 + $#newlines;
42bdf74c 2823 my $stat_real = '';
bb44ad39 2824
42bdf74c
HS
2825 $stat_real = raw_line($linenr, $cond_lines)
2826 . "\n" if ($cond_lines);
bb44ad39
AW
2827 if (defined($stat_real) && $cond_lines > 1) {
2828 $stat_real = "[...]\n$stat_real";
2829 }
2830
000d1cc1
JP
2831 ERROR("TRAILING_STATEMENTS",
2832 "trailing statements should be on next line\n" . $herecurr . $stat_real);
8905a67c
AW
2833 }
2834 }
2835
13214adf
AW
2836# Check for bitwise tests written as boolean
2837 if ($line =~ /
2838 (?:
2839 (?:\[|\(|\&\&|\|\|)
2840 \s*0[xX][0-9]+\s*
2841 (?:\&\&|\|\|)
2842 |
2843 (?:\&\&|\|\|)
2844 \s*0[xX][0-9]+\s*
2845 (?:\&\&|\|\||\)|\])
2846 )/x)
2847 {
000d1cc1
JP
2848 WARN("HEXADECIMAL_BOOLEAN_TEST",
2849 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
13214adf
AW
2850 }
2851
8905a67c 2852# if and else should not have general statements after it
13214adf
AW
2853 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2854 my $s = $1;
2855 $s =~ s/$;//g; # Remove any comments
2856 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
000d1cc1
JP
2857 ERROR("TRAILING_STATEMENTS",
2858 "trailing statements should be on next line\n" . $herecurr);
13214adf 2859 }
0a920b5b 2860 }
39667782
AW
2861# if should not continue a brace
2862 if ($line =~ /}\s*if\b/) {
000d1cc1
JP
2863 ERROR("TRAILING_STATEMENTS",
2864 "trailing statements should be on next line\n" .
39667782
AW
2865 $herecurr);
2866 }
a1080bf8
AW
2867# case and default should not have general statements after them
2868 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2869 $line !~ /\G(?:
3fef12d6 2870 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
a1080bf8
AW
2871 \s*return\s+
2872 )/xg)
2873 {
000d1cc1
JP
2874 ERROR("TRAILING_STATEMENTS",
2875 "trailing statements should be on next line\n" . $herecurr);
a1080bf8 2876 }
0a920b5b
AW
2877
2878 # Check for }<nl>else {, these must be at the same
2879 # indent level to be relevant to each other.
2880 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2881 $previndent == $indent) {
000d1cc1
JP
2882 ERROR("ELSE_AFTER_BRACE",
2883 "else should follow close brace '}'\n" . $hereprev);
0a920b5b
AW
2884 }
2885
c2fdda0d
AW
2886 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2887 $previndent == $indent) {
2888 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2889
2890 # Find out what is on the end of the line after the
2891 # conditional.
773647a0 2892 substr($s, 0, length($c), '');
c2fdda0d
AW
2893 $s =~ s/\n.*//g;
2894
2895 if ($s =~ /^\s*;/) {
000d1cc1
JP
2896 ERROR("WHILE_AFTER_BRACE",
2897 "while should follow close brace '}'\n" . $hereprev);
c2fdda0d
AW
2898 }
2899 }
2900
0a920b5b
AW
2901#studly caps, commented out until figure out how to distinguish between use of existing and adding new
2902# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2903# print "No studly caps, use _\n";
2904# print "$herecurr";
2905# $clean = 0;
2906# }
2907
2908#no spaces allowed after \ in define
c45dcabd 2909 if ($line=~/\#\s*define.*\\\s$/) {
000d1cc1
JP
2910 WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
2911 "Whitepspace after \\ makes next lines useless\n" . $herecurr);
0a920b5b
AW
2912 }
2913
653d4876 2914#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
c45dcabd 2915 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
e09dec48
AW
2916 my $file = "$1.h";
2917 my $checkfile = "include/linux/$file";
2918 if (-f "$root/$checkfile" &&
2919 $realfile ne $checkfile &&
7840a94c 2920 $1 !~ /$allowed_asm_includes/)
c45dcabd 2921 {
e09dec48 2922 if ($realfile =~ m{^arch/}) {
000d1cc1
JP
2923 CHK("ARCH_INCLUDE_LINUX",
2924 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
e09dec48 2925 } else {
000d1cc1
JP
2926 WARN("INCLUDE_LINUX",
2927 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
e09dec48 2928 }
0a920b5b
AW
2929 }
2930 }
2931
653d4876
AW
2932# multi-statement macros should be enclosed in a do while loop, grab the
2933# first statement and ensure its the whole macro if its not enclosed
cf655043 2934# in a known good container
b8f96a31
AW
2935 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2936 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
d8aaf121
AW
2937 my $ln = $linenr;
2938 my $cnt = $realcnt;
c45dcabd
AW
2939 my ($off, $dstat, $dcond, $rest);
2940 my $ctx = '';
c45dcabd 2941 ($dstat, $dcond, $ln, $cnt, $off) =
f74bd194
AW
2942 ctx_statement_block($linenr, $realcnt, 0);
2943 $ctx = $dstat;
c45dcabd 2944 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
a3bb97a7 2945 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
c45dcabd 2946
f74bd194 2947 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
292f1a9b 2948 $dstat =~ s/$;//g;
c45dcabd
AW
2949 $dstat =~ s/\\\n.//g;
2950 $dstat =~ s/^\s*//s;
2951 $dstat =~ s/\s*$//s;
de7d4f0e 2952
c45dcabd 2953 # Flatten any parentheses and braces
bf30d6ed
AW
2954 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2955 $dstat =~ s/\{[^\{\}]*\}/1/ ||
c81769fd 2956 $dstat =~ s/\[[^\[\]]*\]/1/)
bf30d6ed 2957 {
de7d4f0e 2958 }
d8aaf121 2959
e45bab8e
AW
2960 # Flatten any obvious string concatentation.
2961 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
2962 $dstat =~ s/$Ident\s*("X*")/$1/)
2963 {
2964 }
2965
c45dcabd
AW
2966 my $exceptions = qr{
2967 $Declare|
2968 module_param_named|
a0a0a7a9 2969 MODULE_PARM_DESC|
c45dcabd
AW
2970 DECLARE_PER_CPU|
2971 DEFINE_PER_CPU|
383099fd 2972 __typeof__\(|
22fd2d3e
SS
2973 union|
2974 struct|
ea71a0a0
AW
2975 \.$Ident\s*=\s*|
2976 ^\"|\"$
c45dcabd 2977 }x;
5eaa20b9 2978 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
f74bd194
AW
2979 if ($dstat ne '' &&
2980 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
2981 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
fd1b57ac 2982 $dstat !~ /^[!~-]?(?:$Ident|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo
b9df76ac 2983 $dstat !~ /^'X'$/ && # character constants
f74bd194
AW
2984 $dstat !~ /$exceptions/ &&
2985 $dstat !~ /^\.$Ident\s*=/ && # .foo =
72f115f9 2986 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
f74bd194
AW
2987 $dstat !~ /^for\s*$Constant$/ && # for (...)
2988 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
2989 $dstat !~ /^do\s*{/ && # do {...
2990 $dstat !~ /^\({/) # ({...
2991 {
2992 $ctx =~ s/\n*$//;
2993 my $herectx = $here . "\n";
2994 my $cnt = statement_rawlines($ctx);
2995
2996 for (my $n = 0; $n < $cnt; $n++) {
2997 $herectx .= raw_line($linenr, $n) . "\n";
c45dcabd
AW
2998 }
2999
f74bd194
AW
3000 if ($dstat =~ /;/) {
3001 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
3002 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
3003 } else {
000d1cc1 3004 ERROR("COMPLEX_MACRO",
f74bd194 3005 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
d8aaf121 3006 }
653d4876 3007 }
5023d347
JP
3008
3009# check for line continuations outside of #defines
3010
3011 } else {
3012 if ($prevline !~ /^..*\\$/ &&
3013 $line =~ /^\+.*\\$/) {
3014 WARN("LINE_CONTINUATIONS",
3015 "Avoid unnecessary line continuations\n" . $herecurr);
3016 }
0a920b5b
AW
3017 }
3018
b13edf7f
JP
3019# do {} while (0) macro tests:
3020# single-statement macros do not need to be enclosed in do while (0) loop,
3021# macro should not end with a semicolon
3022 if ($^V && $^V ge 5.10.0 &&
3023 $realfile !~ m@/vmlinux.lds.h$@ &&
3024 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
3025 my $ln = $linenr;
3026 my $cnt = $realcnt;
3027 my ($off, $dstat, $dcond, $rest);
3028 my $ctx = '';
3029 ($dstat, $dcond, $ln, $cnt, $off) =
3030 ctx_statement_block($linenr, $realcnt, 0);
3031 $ctx = $dstat;
3032
3033 $dstat =~ s/\\\n.//g;
3034
3035 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
3036 my $stmts = $2;
3037 my $semis = $3;
3038
3039 $ctx =~ s/\n*$//;
3040 my $cnt = statement_rawlines($ctx);
3041 my $herectx = $here . "\n";
3042
3043 for (my $n = 0; $n < $cnt; $n++) {
3044 $herectx .= raw_line($linenr, $n) . "\n";
3045 }
3046
ac8e97f8
JP
3047 if (($stmts =~ tr/;/;/) == 1 &&
3048 $stmts !~ /^\s*(if|while|for|switch)\b/) {
b13edf7f
JP
3049 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
3050 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
3051 }
3052 if (defined $semis && $semis ne "") {
3053 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
3054 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
3055 }
3056 }
3057 }
3058
080ba929
MF
3059# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3060# all assignments may have only one of the following with an assignment:
3061# .
3062# ALIGN(...)
3063# VMLINUX_SYMBOL(...)
3064 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
000d1cc1
JP
3065 WARN("MISSING_VMLINUX_SYMBOL",
3066 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
080ba929
MF
3067 }
3068
f0a594c1 3069# check for redundant bracing round if etc
13214adf
AW
3070 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
3071 my ($level, $endln, @chunks) =
cf655043 3072 ctx_statement_full($linenr, $realcnt, 1);
13214adf 3073 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
cf655043
AW
3074 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3075 if ($#chunks > 0 && $level == 0) {
aad4f614
JP
3076 my @allowed = ();
3077 my $allow = 0;
13214adf 3078 my $seen = 0;
773647a0 3079 my $herectx = $here . "\n";
cf655043 3080 my $ln = $linenr - 1;
13214adf
AW
3081 for my $chunk (@chunks) {
3082 my ($cond, $block) = @{$chunk};
3083
773647a0
AW
3084 # If the condition carries leading newlines, then count those as offsets.
3085 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
3086 my $offset = statement_rawlines($whitespace) - 1;
3087
aad4f614 3088 $allowed[$allow] = 0;
773647a0
AW
3089 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3090
3091 # We have looked at and allowed this specific line.
3092 $suppress_ifbraces{$ln + $offset} = 1;
3093
3094 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
cf655043
AW
3095 $ln += statement_rawlines($block) - 1;
3096
773647a0 3097 substr($block, 0, length($cond), '');
13214adf
AW
3098
3099 $seen++ if ($block =~ /^\s*{/);
3100
aad4f614 3101 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
cf655043
AW
3102 if (statement_lines($cond) > 1) {
3103 #print "APW: ALLOWED: cond<$cond>\n";
aad4f614 3104 $allowed[$allow] = 1;
13214adf
AW
3105 }
3106 if ($block =~/\b(?:if|for|while)\b/) {
cf655043 3107 #print "APW: ALLOWED: block<$block>\n";
aad4f614 3108 $allowed[$allow] = 1;
13214adf 3109 }
cf655043
AW
3110 if (statement_block_size($block) > 1) {
3111 #print "APW: ALLOWED: lines block<$block>\n";
aad4f614 3112 $allowed[$allow] = 1;
13214adf 3113 }
aad4f614 3114 $allow++;
13214adf 3115 }
aad4f614
JP
3116 if ($seen) {
3117 my $sum_allowed = 0;
3118 foreach (@allowed) {
3119 $sum_allowed += $_;
3120 }
3121 if ($sum_allowed == 0) {
3122 WARN("BRACES",
3123 "braces {} are not necessary for any arm of this statement\n" . $herectx);
3124 } elsif ($sum_allowed != $allow &&
3125 $seen != $allow) {
3126 CHK("BRACES",
3127 "braces {} should be used on all arms of this statement\n" . $herectx);
3128 }
13214adf
AW
3129 }
3130 }
3131 }
773647a0 3132 if (!defined $suppress_ifbraces{$linenr - 1} &&
13214adf 3133 $line =~ /\b(if|while|for|else)\b/) {
cf655043
AW
3134 my $allowed = 0;
3135
3136 # Check the pre-context.
3137 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
3138 #print "APW: ALLOWED: pre<$1>\n";
3139 $allowed = 1;
3140 }
773647a0
AW
3141
3142 my ($level, $endln, @chunks) =
3143 ctx_statement_full($linenr, $realcnt, $-[0]);
3144
cf655043
AW
3145 # Check the condition.
3146 my ($cond, $block) = @{$chunks[0]};
773647a0 3147 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
cf655043 3148 if (defined $cond) {
773647a0 3149 substr($block, 0, length($cond), '');
cf655043
AW
3150 }
3151 if (statement_lines($cond) > 1) {
3152 #print "APW: ALLOWED: cond<$cond>\n";
3153 $allowed = 1;
3154 }
3155 if ($block =~/\b(?:if|for|while)\b/) {
3156 #print "APW: ALLOWED: block<$block>\n";
3157 $allowed = 1;
3158 }
3159 if (statement_block_size($block) > 1) {
3160 #print "APW: ALLOWED: lines block<$block>\n";
3161 $allowed = 1;
3162 }
3163 # Check the post-context.
3164 if (defined $chunks[1]) {
3165 my ($cond, $block) = @{$chunks[1]};
3166 if (defined $cond) {
773647a0 3167 substr($block, 0, length($cond), '');
cf655043
AW
3168 }
3169 if ($block =~ /^\s*\{/) {
3170 #print "APW: ALLOWED: chunk-1 block<$block>\n";
3171 $allowed = 1;
3172 }
3173 }
3174 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
69932487 3175 my $herectx = $here . "\n";
f055663c 3176 my $cnt = statement_rawlines($block);
cf655043 3177
f055663c 3178 for (my $n = 0; $n < $cnt; $n++) {
69932487 3179 $herectx .= raw_line($linenr, $n) . "\n";
f0a594c1 3180 }
cf655043 3181
000d1cc1
JP
3182 WARN("BRACES",
3183 "braces {} are not necessary for single statement blocks\n" . $herectx);
f0a594c1
AW
3184 }
3185 }
3186
4a0df2ef 3187# no volatiles please
6c72ffaa
AW
3188 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
3189 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
000d1cc1
JP
3190 WARN("VOLATILE",
3191 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
4a0df2ef
AW
3192 }
3193
00df344f 3194# warn about #if 0
c45dcabd 3195 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
000d1cc1
JP
3196 CHK("REDUNDANT_CODE",
3197 "if this code is redundant consider removing it\n" .
de7d4f0e 3198 $herecurr);
4a0df2ef
AW
3199 }
3200
03df4b51
AW
3201# check for needless "if (<foo>) fn(<foo>)" uses
3202 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
3203 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
3204 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
3205 WARN('NEEDLESS_IF',
3206 "$1(NULL) is safe this check is probably not required\n" . $hereprev);
4c432a8f
GKH
3207 }
3208 }
f0a594c1 3209
1a15a250
PP
3210# prefer usleep_range over udelay
3211 if ($line =~ /\budelay\s*\(\s*(\w+)\s*\)/) {
3212 # ignore udelay's < 10, however
3213 if (! (($1 =~ /(\d+)/) && ($1 < 10)) ) {
000d1cc1
JP
3214 CHK("USLEEP_RANGE",
3215 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
1a15a250
PP
3216 }
3217 }
3218
09ef8725
PP
3219# warn about unexpectedly long msleep's
3220 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
3221 if ($1 < 20) {
000d1cc1
JP
3222 WARN("MSLEEP",
3223 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
09ef8725
PP
3224 }
3225 }
3226
00df344f 3227# warn about #ifdefs in C files
c45dcabd 3228# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
00df344f
AW
3229# print "#ifdef in C files should be avoided\n";
3230# print "$herecurr";
3231# $clean = 0;
3232# }
3233
22f2a2ef 3234# warn about spacing in #ifdefs
c45dcabd 3235 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
000d1cc1
JP
3236 ERROR("SPACING",
3237 "exactly one space required after that #$1\n" . $herecurr);
22f2a2ef
AW
3238 }
3239
4a0df2ef 3240# check for spinlock_t definitions without a comment.
171ae1a4
AW
3241 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
3242 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
4a0df2ef
AW
3243 my $which = $1;
3244 if (!ctx_has_comment($first_line, $linenr)) {
000d1cc1
JP
3245 CHK("UNCOMMENTED_DEFINITION",
3246 "$1 definition without comment\n" . $herecurr);
4a0df2ef
AW
3247 }
3248 }
3249# check for memory barriers without a comment.
3250 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
3251 if (!ctx_has_comment($first_line, $linenr)) {
000d1cc1
JP
3252 CHK("MEMORY_BARRIER",
3253 "memory barrier without comment\n" . $herecurr);
4a0df2ef
AW
3254 }
3255 }
3256# check of hardware specific defines
c45dcabd 3257 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
000d1cc1
JP
3258 CHK("ARCH_DEFINES",
3259 "architecture specific defines should be avoided\n" . $herecurr);
0a920b5b 3260 }
653d4876 3261
d4977c78
TK
3262# Check that the storage class is at the beginning of a declaration
3263 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
000d1cc1
JP
3264 WARN("STORAGE_CLASS",
3265 "storage class should be at the beginning of the declaration\n" . $herecurr)
d4977c78
TK
3266 }
3267
de7d4f0e
AW
3268# check the location of the inline attribute, that it is between
3269# storage class and type.
9c0ca6f9
AW
3270 if ($line =~ /\b$Type\s+$Inline\b/ ||
3271 $line =~ /\b$Inline\s+$Storage\b/) {
000d1cc1
JP
3272 ERROR("INLINE_LOCATION",
3273 "inline keyword should sit between storage class and type\n" . $herecurr);
de7d4f0e
AW
3274 }
3275
8905a67c
AW
3276# Check for __inline__ and __inline, prefer inline
3277 if ($line =~ /\b(__inline__|__inline)\b/) {
000d1cc1
JP
3278 WARN("INLINE",
3279 "plain inline is preferred over $1\n" . $herecurr);
8905a67c
AW
3280 }
3281
3d130fd0
JP
3282# Check for __attribute__ packed, prefer __packed
3283 if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
000d1cc1
JP
3284 WARN("PREFER_PACKED",
3285 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
3d130fd0
JP
3286 }
3287
39b7e287
JP
3288# Check for __attribute__ aligned, prefer __aligned
3289 if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
000d1cc1
JP
3290 WARN("PREFER_ALIGNED",
3291 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
39b7e287
JP
3292 }
3293
5f14d3bd
JP
3294# Check for __attribute__ format(printf, prefer __printf
3295 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
3296 WARN("PREFER_PRINTF",
3297 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr);
3298 }
3299
6061d949
JP
3300# Check for __attribute__ format(scanf, prefer __scanf
3301 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
3302 WARN("PREFER_SCANF",
3303 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr);
3304 }
3305
8f53a9b8
JP
3306# check for sizeof(&)
3307 if ($line =~ /\bsizeof\s*\(\s*\&/) {
000d1cc1
JP
3308 WARN("SIZEOF_ADDRESS",
3309 "sizeof(& should be avoided\n" . $herecurr);
8f53a9b8
JP
3310 }
3311
66c80b60
JP
3312# check for sizeof without parenthesis
3313 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
3314 WARN("SIZEOF_PARENTHESIS",
3315 "sizeof $1 should be sizeof($1)\n" . $herecurr);
3316 }
3317
428e2fdc
JP
3318# check for line continuations in quoted strings with odd counts of "
3319 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
000d1cc1
JP
3320 WARN("LINE_CONTINUATIONS",
3321 "Avoid line continuations in quoted strings\n" . $herecurr);
428e2fdc
JP
3322 }
3323
554e165c 3324# Check for misused memsets
d1fe9c09
JP
3325 if ($^V && $^V ge 5.10.0 &&
3326 defined $stat &&
d7c76ba7
JP
3327 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
3328
3329 my $ms_addr = $2;
d1fe9c09
JP
3330 my $ms_val = $7;
3331 my $ms_size = $12;
554e165c 3332
554e165c
AW
3333 if ($ms_size =~ /^(0x|)0$/i) {
3334 ERROR("MEMSET",
d7c76ba7 3335 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
554e165c
AW
3336 } elsif ($ms_size =~ /^(0x|)1$/i) {
3337 WARN("MEMSET",
d7c76ba7
JP
3338 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
3339 }
3340 }
3341
3342# typecasts on min/max could be min_t/max_t
d1fe9c09
JP
3343 if ($^V && $^V ge 5.10.0 &&
3344 defined $stat &&
d7c76ba7 3345 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
d1fe9c09 3346 if (defined $2 || defined $7) {
d7c76ba7
JP
3347 my $call = $1;
3348 my $cast1 = deparenthesize($2);
3349 my $arg1 = $3;
d1fe9c09
JP
3350 my $cast2 = deparenthesize($7);
3351 my $arg2 = $8;
d7c76ba7
JP
3352 my $cast;
3353
d1fe9c09 3354 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
d7c76ba7
JP
3355 $cast = "$cast1 or $cast2";
3356 } elsif ($cast1 ne "") {
3357 $cast = $cast1;
3358 } else {
3359 $cast = $cast2;
3360 }
3361 WARN("MINMAX",
3362 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
554e165c
AW
3363 }
3364 }
3365
4a273195
JP
3366# check usleep_range arguments
3367 if ($^V && $^V ge 5.10.0 &&
3368 defined $stat &&
3369 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
3370 my $min = $1;
3371 my $max = $7;
3372 if ($min eq $max) {
3373 WARN("USLEEP_RANGE",
3374 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
3375 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
3376 $min > $max) {
3377 WARN("USLEEP_RANGE",
3378 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
3379 }
3380 }
3381
de7d4f0e 3382# check for new externs in .c files.
171ae1a4 3383 if ($realfile =~ /\.c$/ && defined $stat &&
c45dcabd 3384 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
171ae1a4 3385 {
c45dcabd
AW
3386 my $function_name = $1;
3387 my $paren_space = $2;
171ae1a4
AW
3388
3389 my $s = $stat;
3390 if (defined $cond) {
3391 substr($s, 0, length($cond), '');
3392 }
c45dcabd
AW
3393 if ($s =~ /^\s*;/ &&
3394 $function_name ne 'uninitialized_var')
3395 {
000d1cc1
JP
3396 WARN("AVOID_EXTERNS",
3397 "externs should be avoided in .c files\n" . $herecurr);
171ae1a4
AW
3398 }
3399
3400 if ($paren_space =~ /\n/) {
000d1cc1
JP
3401 WARN("FUNCTION_ARGUMENTS",
3402 "arguments for function declarations should follow identifier\n" . $herecurr);
171ae1a4 3403 }
9c9ba34e
AW
3404
3405 } elsif ($realfile =~ /\.c$/ && defined $stat &&
3406 $stat =~ /^.\s*extern\s+/)
3407 {
000d1cc1
JP
3408 WARN("AVOID_EXTERNS",
3409 "externs should be avoided in .c files\n" . $herecurr);
de7d4f0e
AW
3410 }
3411
3412# checks for new __setup's
3413 if ($rawline =~ /\b__setup\("([^"]*)"/) {
3414 my $name = $1;
3415
3416 if (!grep(/$name/, @setup_docs)) {
000d1cc1
JP
3417 CHK("UNDOCUMENTED_SETUP",
3418 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
de7d4f0e 3419 }
653d4876 3420 }
9c0ca6f9
AW
3421
3422# check for pointless casting of kmalloc return
caf2a54f 3423 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
000d1cc1
JP
3424 WARN("UNNECESSARY_CASTS",
3425 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
9c0ca6f9 3426 }
13214adf 3427
caf2a54f
JP
3428# check for multiple semicolons
3429 if ($line =~ /;\s*;\s*$/) {
000d1cc1
JP
3430 WARN("ONE_SEMICOLON",
3431 "Statements terminations use 1 semicolon\n" . $herecurr);
caf2a54f
JP
3432 }
3433
13214adf
AW
3434# check for gcc specific __FUNCTION__
3435 if ($line =~ /__FUNCTION__/) {
000d1cc1
JP
3436 WARN("USE_FUNC",
3437 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
13214adf 3438 }
773647a0 3439
2c92488a
JP
3440# check for use of yield()
3441 if ($line =~ /\byield\s*\(\s*\)/) {
3442 WARN("YIELD",
3443 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
3444 }
3445
4882720b
TG
3446# check for semaphores initialized locked
3447 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
000d1cc1
JP
3448 WARN("CONSIDER_COMPLETION",
3449 "consider using a completion\n" . $herecurr);
773647a0 3450 }
6712d858 3451
67d0a075
JP
3452# recommend kstrto* over simple_strto* and strict_strto*
3453 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
000d1cc1 3454 WARN("CONSIDER_KSTRTO",
67d0a075 3455 "$1 is obsolete, use k$3 instead\n" . $herecurr);
773647a0 3456 }
6712d858 3457
f3db6639
ME
3458# check for __initcall(), use device_initcall() explicitly please
3459 if ($line =~ /^.\s*__initcall\s*\(/) {
000d1cc1
JP
3460 WARN("USE_DEVICE_INITCALL",
3461 "please use device_initcall() instead of __initcall()\n" . $herecurr);
f3db6639 3462 }
6712d858 3463
79404849
ER
3464# check for various ops structs, ensure they are const.
3465 my $struct_ops = qr{acpi_dock_ops|
3466 address_space_operations|
3467 backlight_ops|
3468 block_device_operations|
3469 dentry_operations|
3470 dev_pm_ops|
3471 dma_map_ops|
3472 extent_io_ops|
3473 file_lock_operations|
3474 file_operations|
3475 hv_ops|
3476 ide_dma_ops|
3477 intel_dvo_dev_ops|
3478 item_operations|
3479 iwl_ops|
3480 kgdb_arch|
3481 kgdb_io|
3482 kset_uevent_ops|
3483 lock_manager_operations|
3484 microcode_ops|
3485 mtrr_ops|
3486 neigh_ops|
3487 nlmsvc_binding|
3488 pci_raw_ops|
3489 pipe_buf_operations|
3490 platform_hibernation_ops|
3491 platform_suspend_ops|
3492 proto_ops|
3493 rpc_pipe_ops|
3494 seq_operations|
3495 snd_ac97_build_ops|
3496 soc_pcmcia_socket_ops|
3497 stacktrace_ops|
3498 sysfs_ops|
3499 tty_operations|
3500 usb_mon_operations|
3501 wd_ops}x;
6903ffb2 3502 if ($line !~ /\bconst\b/ &&
79404849 3503 $line =~ /\bstruct\s+($struct_ops)\b/) {
000d1cc1
JP
3504 WARN("CONST_STRUCT",
3505 "struct $1 should normally be const\n" .
6903ffb2 3506 $herecurr);
2b6db5cb 3507 }
773647a0
AW
3508
3509# use of NR_CPUS is usually wrong
3510# ignore definitions of NR_CPUS and usage to define arrays as likely right
3511 if ($line =~ /\bNR_CPUS\b/ &&
c45dcabd
AW
3512 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
3513 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
171ae1a4
AW
3514 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
3515 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
3516 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
773647a0 3517 {
000d1cc1
JP
3518 WARN("NR_CPUS",
3519 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
773647a0 3520 }
9c9ba34e
AW
3521
3522# check for %L{u,d,i} in strings
3523 my $string;
3524 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
3525 $string = substr($rawline, $-[1], $+[1] - $-[1]);
2a1bc5d5 3526 $string =~ s/%%/__/g;
9c9ba34e 3527 if ($string =~ /(?<!%)%L[udi]/) {
000d1cc1
JP
3528 WARN("PRINTF_L",
3529 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
9c9ba34e
AW
3530 last;
3531 }
3532 }
691d77b6
AW
3533
3534# whine mightly about in_atomic
3535 if ($line =~ /\bin_atomic\s*\(/) {
3536 if ($realfile =~ m@^drivers/@) {
000d1cc1
JP
3537 ERROR("IN_ATOMIC",
3538 "do not use in_atomic in drivers\n" . $herecurr);
f4a87736 3539 } elsif ($realfile !~ m@^kernel/@) {
000d1cc1
JP
3540 WARN("IN_ATOMIC",
3541 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
691d77b6
AW
3542 }
3543 }
1704f47b
PZ
3544
3545# check for lockdep_set_novalidate_class
3546 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
3547 $line =~ /__lockdep_no_validate__\s*\)/ ) {
3548 if ($realfile !~ m@^kernel/lockdep@ &&
3549 $realfile !~ m@^include/linux/lockdep@ &&
3550 $realfile !~ m@^drivers/base/core@) {
000d1cc1
JP
3551 ERROR("LOCKDEP",
3552 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
1704f47b
PZ
3553 }
3554 }
88f8831c
DJ
3555
3556 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
3557 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
000d1cc1
JP
3558 WARN("EXPORTED_WORLD_WRITABLE",
3559 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
88f8831c 3560 }
13214adf
AW
3561 }
3562
3563 # If we have no input at all, then there is nothing to report on
3564 # so just keep quiet.
3565 if ($#rawlines == -1) {
3566 exit(0);
0a920b5b
AW
3567 }
3568
8905a67c
AW
3569 # In mailback mode only produce a report in the negative, for
3570 # things that appear to be patches.
3571 if ($mailback && ($clean == 1 || !$is_patch)) {
3572 exit(0);
3573 }
3574
3575 # This is not a patch, and we are are in 'no-patch' mode so
3576 # just keep quiet.
3577 if (!$chk_patch && !$is_patch) {
3578 exit(0);
3579 }
3580
3581 if (!$is_patch) {
000d1cc1
JP
3582 ERROR("NOT_UNIFIED_DIFF",
3583 "Does not appear to be a unified-diff format patch\n");
0a920b5b
AW
3584 }
3585 if ($is_patch && $chk_signoff && $signoff == 0) {
000d1cc1
JP
3586 ERROR("MISSING_SIGN_OFF",
3587 "Missing Signed-off-by: line(s)\n");
0a920b5b
AW
3588 }
3589
8905a67c 3590 print report_dump();
13214adf
AW
3591 if ($summary && !($clean == 1 && $quiet == 1)) {
3592 print "$filename " if ($summary_file);
8905a67c
AW
3593 print "total: $cnt_error errors, $cnt_warn warnings, " .
3594 (($check)? "$cnt_chk checks, " : "") .
3595 "$cnt_lines lines checked\n";
3596 print "\n" if ($quiet == 0);
f0a594c1 3597 }
8905a67c 3598
d2c0a235 3599 if ($quiet == 0) {
d1fe9c09
JP
3600
3601 if ($^V lt 5.10.0) {
3602 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
3603 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
3604 }
3605
d2c0a235
AW
3606 # If there were whitespace errors which cleanpatch can fix
3607 # then suggest that.
3608 if ($rpt_cleaners) {
3609 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
3610 print " scripts/cleanfile\n\n";
b0781216 3611 $rpt_cleaners = 0;
d2c0a235
AW
3612 }
3613 }
3614
11232688 3615 if ($quiet == 0 && keys %ignore_type) {
000d1cc1
JP
3616 print "NOTE: Ignored message types:";
3617 foreach my $ignore (sort keys %ignore_type) {
3618 print " $ignore";
3619 }
11232688 3620 print "\n\n";
000d1cc1
JP
3621 }
3622
0a920b5b 3623 if ($clean == 1 && $quiet == 0) {
c2fdda0d 3624 print "$vname has no obvious style problems and is ready for submission.\n"
0a920b5b
AW
3625 }
3626 if ($clean == 0 && $quiet == 0) {
000d1cc1
JP
3627 print << "EOM";
3628$vname has style problems, please review.
3629
3630If any of these errors are false positives, please report
3631them to the maintainer, see CHECKPATCH in MAINTAINERS.
3632EOM
0a920b5b 3633 }
13214adf 3634
0a920b5b
AW
3635 return $clean;
3636}