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