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