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