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