checkpatch: case/default checks should only check changed lines
[linux-2.6/mini2440.git] / scripts / checkpatch.pl
blob457f87460d6e579e02c0e7fadbb71b5210000d52
1 #!/usr/bin/perl -w
2 # (c) 2001, Dave Jones. <davej@codemonkey.org.uk> (the file handling bit)
3 # (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
4 # (c) 2007, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite, etc)
5 # Licensed under the terms of the GNU GPL License version 2
7 use strict;
9 my $P = $0;
10 $P =~ s@.*/@@g;
12 my $V = '0.22';
14 use Getopt::Long qw(:config no_auto_abbrev);
16 my $quiet = 0;
17 my $tree = 1;
18 my $chk_signoff = 1;
19 my $chk_patch = 1;
20 my $tst_only;
21 my $emacs = 0;
22 my $terse = 0;
23 my $file = 0;
24 my $check = 0;
25 my $summary = 1;
26 my $mailback = 0;
27 my $summary_file = 0;
28 my $root;
29 my %debug;
30 GetOptions(
31 'q|quiet+' => \$quiet,
32 'tree!' => \$tree,
33 'signoff!' => \$chk_signoff,
34 'patch!' => \$chk_patch,
35 'emacs!' => \$emacs,
36 'terse!' => \$terse,
37 'file!' => \$file,
38 'subjective!' => \$check,
39 'strict!' => \$check,
40 'root=s' => \$root,
41 'summary!' => \$summary,
42 'mailback!' => \$mailback,
43 'summary-file!' => \$summary_file,
45 'debug=s' => \%debug,
46 'test-only=s' => \$tst_only,
47 ) or exit;
49 my $exit = 0;
51 if ($#ARGV < 0) {
52 print "usage: $P [options] patchfile\n";
53 print "version: $V\n";
54 print "options: -q => quiet\n";
55 print " --no-tree => run without a kernel tree\n";
56 print " --terse => one line per report\n";
57 print " --emacs => emacs compile window format\n";
58 print " --file => check a source file\n";
59 print " --strict => enable more subjective tests\n";
60 print " --root => path to the kernel tree root\n";
61 print " --no-summary => suppress the per-file summary\n";
62 print " --summary-file => include the filename in summary\n";
63 exit(1);
66 my $dbg_values = 0;
67 my $dbg_possible = 0;
68 my $dbg_type = 0;
69 my $dbg_attr = 0;
70 for my $key (keys %debug) {
71 eval "\${dbg_$key} = '$debug{$key}';"
74 if ($terse) {
75 $emacs = 1;
76 $quiet++;
79 if ($tree) {
80 if (defined $root) {
81 if (!top_of_kernel_tree($root)) {
82 die "$P: $root: --root does not point at a valid tree\n";
84 } else {
85 if (top_of_kernel_tree('.')) {
86 $root = '.';
87 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
88 top_of_kernel_tree($1)) {
89 $root = $1;
93 if (!defined $root) {
94 print "Must be run from the top-level dir. of a kernel tree\n";
95 exit(2);
99 my $emitted_corrupt = 0;
101 our $Ident = qr{[A-Za-z_][A-Za-z\d_]*};
102 our $Storage = qr{extern|static|asmlinkage};
103 our $Sparse = qr{
104 __user|
105 __kernel|
106 __force|
107 __iomem|
108 __must_check|
109 __init_refok|
110 __kprobes
112 our $Attribute = qr{
113 const|
114 __read_mostly|
115 __kprobes|
116 __(?:mem|cpu|dev|)(?:initdata|init)|
117 ____cacheline_aligned|
118 ____cacheline_aligned_in_smp|
119 ____cacheline_internodealigned_in_smp
121 our $Modifier;
122 our $Inline = qr{inline|__always_inline|noinline};
123 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
124 our $Lval = qr{$Ident(?:$Member)*};
126 our $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
127 our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
128 our $Operators = qr{
129 <=|>=|==|!=|
130 =>|->|<<|>>|<|>|!|~|
131 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
134 our $NonptrType;
135 our $Type;
136 our $Declare;
138 our $UTF8 = qr {
139 [\x09\x0A\x0D\x20-\x7E] # ASCII
140 | [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
141 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
142 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
143 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
144 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
145 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
146 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
149 our @typeList = (
150 qr{void},
151 qr{(?:unsigned\s+)?char},
152 qr{(?:unsigned\s+)?short},
153 qr{(?:unsigned\s+)?int},
154 qr{(?:unsigned\s+)?long},
155 qr{(?:unsigned\s+)?long\s+int},
156 qr{(?:unsigned\s+)?long\s+long},
157 qr{(?:unsigned\s+)?long\s+long\s+int},
158 qr{unsigned},
159 qr{float},
160 qr{double},
161 qr{bool},
162 qr{(?:__)?(?:u|s|be|le)(?:8|16|32|64)},
163 qr{struct\s+$Ident},
164 qr{union\s+$Ident},
165 qr{enum\s+$Ident},
166 qr{${Ident}_t},
167 qr{${Ident}_handler},
168 qr{${Ident}_handler_fn},
170 our @modifierList = (
171 qr{fastcall},
174 sub build_types {
175 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
176 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
177 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
178 $NonptrType = qr{
179 (?:$Modifier\s+|const\s+)*
181 (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
182 (?:${all}\b)
184 (?:\s+$Modifier|\s+const)*
186 $Type = qr{
187 $NonptrType
188 (?:\s*\*+\s*const|\s*\*+|(?:\s*\[\s*\])+)?
189 (?:\s+$Inline|\s+$Modifier)*
191 $Declare = qr{(?:$Storage\s+)?$Type};
193 build_types();
195 $chk_signoff = 0 if ($file);
197 my @dep_includes = ();
198 my @dep_functions = ();
199 my $removal = "Documentation/feature-removal-schedule.txt";
200 if ($tree && -f "$root/$removal") {
201 open(REMOVE, "<$root/$removal") ||
202 die "$P: $removal: open failed - $!\n";
203 while (<REMOVE>) {
204 if (/^Check:\s+(.*\S)/) {
205 for my $entry (split(/[, ]+/, $1)) {
206 if ($entry =~ m@include/(.*)@) {
207 push(@dep_includes, $1);
209 } elsif ($entry !~ m@/@) {
210 push(@dep_functions, $entry);
217 my @rawlines = ();
218 my @lines = ();
219 my $vname;
220 for my $filename (@ARGV) {
221 if ($file) {
222 open(FILE, "diff -u /dev/null $filename|") ||
223 die "$P: $filename: diff failed - $!\n";
224 } else {
225 open(FILE, "<$filename") ||
226 die "$P: $filename: open failed - $!\n";
228 if ($filename eq '-') {
229 $vname = 'Your patch';
230 } else {
231 $vname = $filename;
233 while (<FILE>) {
234 chomp;
235 push(@rawlines, $_);
237 close(FILE);
238 if (!process($filename)) {
239 $exit = 1;
241 @rawlines = ();
242 @lines = ();
245 exit($exit);
247 sub top_of_kernel_tree {
248 my ($root) = @_;
250 my @tree_check = (
251 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
252 "README", "Documentation", "arch", "include", "drivers",
253 "fs", "init", "ipc", "kernel", "lib", "scripts",
256 foreach my $check (@tree_check) {
257 if (! -e $root . '/' . $check) {
258 return 0;
261 return 1;
264 sub expand_tabs {
265 my ($str) = @_;
267 my $res = '';
268 my $n = 0;
269 for my $c (split(//, $str)) {
270 if ($c eq "\t") {
271 $res .= ' ';
272 $n++;
273 for (; ($n % 8) != 0; $n++) {
274 $res .= ' ';
276 next;
278 $res .= $c;
279 $n++;
282 return $res;
284 sub copy_spacing {
285 (my $res = shift) =~ tr/\t/ /c;
286 return $res;
289 sub line_stats {
290 my ($line) = @_;
292 # Drop the diff line leader and expand tabs
293 $line =~ s/^.//;
294 $line = expand_tabs($line);
296 # Pick the indent from the front of the line.
297 my ($white) = ($line =~ /^(\s*)/);
299 return (length($line), length($white));
302 my $sanitise_quote = '';
304 sub sanitise_line_reset {
305 my ($in_comment) = @_;
307 if ($in_comment) {
308 $sanitise_quote = '*/';
309 } else {
310 $sanitise_quote = '';
313 sub sanitise_line {
314 my ($line) = @_;
316 my $res = '';
317 my $l = '';
319 my $qlen = 0;
320 my $off = 0;
321 my $c;
323 # Always copy over the diff marker.
324 $res = substr($line, 0, 1);
326 for ($off = 1; $off < length($line); $off++) {
327 $c = substr($line, $off, 1);
329 # Comments we are wacking completly including the begin
330 # and end, all to $;.
331 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
332 $sanitise_quote = '*/';
334 substr($res, $off, 2, "$;$;");
335 $off++;
336 next;
338 if (substr($line, $off, 2) eq '*/') {
339 $sanitise_quote = '';
340 substr($res, $off, 2, "$;$;");
341 $off++;
342 next;
345 # A \ in a string means ignore the next character.
346 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
347 $c eq "\\") {
348 substr($res, $off, 2, 'XX');
349 $off++;
350 next;
352 # Regular quotes.
353 if ($c eq "'" || $c eq '"') {
354 if ($sanitise_quote eq '') {
355 $sanitise_quote = $c;
357 substr($res, $off, 1, $c);
358 next;
359 } elsif ($sanitise_quote eq $c) {
360 $sanitise_quote = '';
364 #print "SQ:$sanitise_quote\n";
365 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
366 substr($res, $off, 1, $;);
367 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
368 substr($res, $off, 1, 'X');
369 } else {
370 substr($res, $off, 1, $c);
374 # The pathname on a #include may be surrounded by '<' and '>'.
375 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
376 my $clean = 'X' x length($1);
377 $res =~ s@\<.*\>@<$clean>@;
379 # The whole of a #error is a string.
380 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
381 my $clean = 'X' x length($1);
382 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
385 return $res;
388 sub ctx_statement_block {
389 my ($linenr, $remain, $off) = @_;
390 my $line = $linenr - 1;
391 my $blk = '';
392 my $soff = $off;
393 my $coff = $off - 1;
394 my $coff_set = 0;
396 my $loff = 0;
398 my $type = '';
399 my $level = 0;
400 my $p;
401 my $c;
402 my $len = 0;
404 my $remainder;
405 while (1) {
406 #warn "CSB: blk<$blk> remain<$remain>\n";
407 # If we are about to drop off the end, pull in more
408 # context.
409 if ($off >= $len) {
410 for (; $remain > 0; $line++) {
411 next if ($lines[$line] =~ /^-/);
412 $remain--;
413 $loff = $len;
414 $blk .= $lines[$line] . "\n";
415 $len = length($blk);
416 $line++;
417 last;
419 # Bail if there is no further context.
420 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
421 if ($off >= $len) {
422 last;
425 $p = $c;
426 $c = substr($blk, $off, 1);
427 $remainder = substr($blk, $off);
429 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
430 # Statement ends at the ';' or a close '}' at the
431 # outermost level.
432 if ($level == 0 && $c eq ';') {
433 last;
436 # An else is really a conditional as long as its not else if
437 if ($level == 0 && $coff_set == 0 &&
438 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
439 $remainder =~ /^(else)(?:\s|{)/ &&
440 $remainder !~ /^else\s+if\b/) {
441 $coff = $off + length($1) - 1;
442 $coff_set = 1;
443 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
444 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
447 if (($type eq '' || $type eq '(') && $c eq '(') {
448 $level++;
449 $type = '(';
451 if ($type eq '(' && $c eq ')') {
452 $level--;
453 $type = ($level != 0)? '(' : '';
455 if ($level == 0 && $coff < $soff) {
456 $coff = $off;
457 $coff_set = 1;
458 #warn "CSB: mark coff<$coff>\n";
461 if (($type eq '' || $type eq '{') && $c eq '{') {
462 $level++;
463 $type = '{';
465 if ($type eq '{' && $c eq '}') {
466 $level--;
467 $type = ($level != 0)? '{' : '';
469 if ($level == 0) {
470 last;
473 $off++;
475 # We are truly at the end, so shuffle to the next line.
476 if ($off == $len) {
477 $loff = $len + 1;
478 $line++;
479 $remain--;
482 my $statement = substr($blk, $soff, $off - $soff + 1);
483 my $condition = substr($blk, $soff, $coff - $soff + 1);
485 #warn "STATEMENT<$statement>\n";
486 #warn "CONDITION<$condition>\n";
488 #print "coff<$coff> soff<$off> loff<$loff>\n";
490 return ($statement, $condition,
491 $line, $remain + 1, $off - $loff + 1, $level);
494 sub statement_lines {
495 my ($stmt) = @_;
497 # Strip the diff line prefixes and rip blank lines at start and end.
498 $stmt =~ s/(^|\n)./$1/g;
499 $stmt =~ s/^\s*//;
500 $stmt =~ s/\s*$//;
502 my @stmt_lines = ($stmt =~ /\n/g);
504 return $#stmt_lines + 2;
507 sub statement_rawlines {
508 my ($stmt) = @_;
510 my @stmt_lines = ($stmt =~ /\n/g);
512 return $#stmt_lines + 2;
515 sub statement_block_size {
516 my ($stmt) = @_;
518 $stmt =~ s/(^|\n)./$1/g;
519 $stmt =~ s/^\s*{//;
520 $stmt =~ s/}\s*$//;
521 $stmt =~ s/^\s*//;
522 $stmt =~ s/\s*$//;
524 my @stmt_lines = ($stmt =~ /\n/g);
525 my @stmt_statements = ($stmt =~ /;/g);
527 my $stmt_lines = $#stmt_lines + 2;
528 my $stmt_statements = $#stmt_statements + 1;
530 if ($stmt_lines > $stmt_statements) {
531 return $stmt_lines;
532 } else {
533 return $stmt_statements;
537 sub ctx_statement_full {
538 my ($linenr, $remain, $off) = @_;
539 my ($statement, $condition, $level);
541 my (@chunks);
543 # Grab the first conditional/block pair.
544 ($statement, $condition, $linenr, $remain, $off, $level) =
545 ctx_statement_block($linenr, $remain, $off);
546 #print "F: c<$condition> s<$statement> remain<$remain>\n";
547 push(@chunks, [ $condition, $statement ]);
548 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
549 return ($level, $linenr, @chunks);
552 # Pull in the following conditional/block pairs and see if they
553 # could continue the statement.
554 for (;;) {
555 ($statement, $condition, $linenr, $remain, $off, $level) =
556 ctx_statement_block($linenr, $remain, $off);
557 #print "C: c<$condition> s<$statement> remain<$remain>\n";
558 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
559 #print "C: push\n";
560 push(@chunks, [ $condition, $statement ]);
563 return ($level, $linenr, @chunks);
566 sub ctx_block_get {
567 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
568 my $line;
569 my $start = $linenr - 1;
570 my $blk = '';
571 my @o;
572 my @c;
573 my @res = ();
575 my $level = 0;
576 for ($line = $start; $remain > 0; $line++) {
577 next if ($rawlines[$line] =~ /^-/);
578 $remain--;
580 $blk .= $rawlines[$line];
581 foreach my $c (split(//, $rawlines[$line])) {
582 ##print "C<$c>L<$level><$open$close>O<$off>\n";
583 if ($off > 0) {
584 $off--;
585 next;
588 if ($c eq $close && $level > 0) {
589 $level--;
590 last if ($level == 0);
591 } elsif ($c eq $open) {
592 $level++;
596 if (!$outer || $level <= 1) {
597 push(@res, $rawlines[$line]);
600 last if ($level == 0);
603 return ($level, @res);
605 sub ctx_block_outer {
606 my ($linenr, $remain) = @_;
608 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
609 return @r;
611 sub ctx_block {
612 my ($linenr, $remain) = @_;
614 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
615 return @r;
617 sub ctx_statement {
618 my ($linenr, $remain, $off) = @_;
620 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
621 return @r;
623 sub ctx_block_level {
624 my ($linenr, $remain) = @_;
626 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
628 sub ctx_statement_level {
629 my ($linenr, $remain, $off) = @_;
631 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
634 sub ctx_locate_comment {
635 my ($first_line, $end_line) = @_;
637 # Catch a comment on the end of the line itself.
638 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
639 return $current_comment if (defined $current_comment);
641 # Look through the context and try and figure out if there is a
642 # comment.
643 my $in_comment = 0;
644 $current_comment = '';
645 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
646 my $line = $rawlines[$linenr - 1];
647 #warn " $line\n";
648 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
649 $in_comment = 1;
651 if ($line =~ m@/\*@) {
652 $in_comment = 1;
654 if (!$in_comment && $current_comment ne '') {
655 $current_comment = '';
657 $current_comment .= $line . "\n" if ($in_comment);
658 if ($line =~ m@\*/@) {
659 $in_comment = 0;
663 chomp($current_comment);
664 return($current_comment);
666 sub ctx_has_comment {
667 my ($first_line, $end_line) = @_;
668 my $cmt = ctx_locate_comment($first_line, $end_line);
670 ##print "LINE: $rawlines[$end_line - 1 ]\n";
671 ##print "CMMT: $cmt\n";
673 return ($cmt ne '');
676 sub raw_line {
677 my ($linenr, $cnt) = @_;
679 my $offset = $linenr - 1;
680 $cnt++;
682 my $line;
683 while ($cnt) {
684 $line = $rawlines[$offset++];
685 next if (defined($line) && $line =~ /^-/);
686 $cnt--;
689 return $line;
692 sub cat_vet {
693 my ($vet) = @_;
694 my ($res, $coded);
696 $res = '';
697 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
698 $res .= $1;
699 if ($2 ne '') {
700 $coded = sprintf("^%c", unpack('C', $2) + 64);
701 $res .= $coded;
704 $res =~ s/$/\$/;
706 return $res;
709 my $av_preprocessor = 0;
710 my $av_pending;
711 my @av_paren_type;
712 my $av_pend_colon;
714 sub annotate_reset {
715 $av_preprocessor = 0;
716 $av_pending = '_';
717 @av_paren_type = ('E');
718 $av_pend_colon = 'O';
721 sub annotate_values {
722 my ($stream, $type) = @_;
724 my $res;
725 my $var = '_' x length($stream);
726 my $cur = $stream;
728 print "$stream\n" if ($dbg_values > 1);
730 while (length($cur)) {
731 @av_paren_type = ('E') if ($#av_paren_type < 0);
732 print " <" . join('', @av_paren_type) .
733 "> <$type> <$av_pending>" if ($dbg_values > 1);
734 if ($cur =~ /^(\s+)/o) {
735 print "WS($1)\n" if ($dbg_values > 1);
736 if ($1 =~ /\n/ && $av_preprocessor) {
737 $type = pop(@av_paren_type);
738 $av_preprocessor = 0;
741 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\()/) {
742 print "DECLARE($1)\n" if ($dbg_values > 1);
743 $type = 'T';
745 } elsif ($cur =~ /^($Modifier)\s*/) {
746 print "MODIFIER($1)\n" if ($dbg_values > 1);
747 $type = 'T';
749 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
750 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
751 $av_preprocessor = 1;
752 push(@av_paren_type, $type);
753 if ($2 ne '') {
754 $av_pending = 'N';
756 $type = 'E';
758 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
759 print "UNDEF($1)\n" if ($dbg_values > 1);
760 $av_preprocessor = 1;
761 push(@av_paren_type, $type);
763 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
764 print "PRE_START($1)\n" if ($dbg_values > 1);
765 $av_preprocessor = 1;
767 push(@av_paren_type, $type);
768 push(@av_paren_type, $type);
769 $type = 'E';
771 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
772 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
773 $av_preprocessor = 1;
775 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
777 $type = 'E';
779 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
780 print "PRE_END($1)\n" if ($dbg_values > 1);
782 $av_preprocessor = 1;
784 # Assume all arms of the conditional end as this
785 # one does, and continue as if the #endif was not here.
786 pop(@av_paren_type);
787 push(@av_paren_type, $type);
788 $type = 'E';
790 } elsif ($cur =~ /^(\\\n)/o) {
791 print "PRECONT($1)\n" if ($dbg_values > 1);
793 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
794 print "ATTR($1)\n" if ($dbg_values > 1);
795 $av_pending = $type;
796 $type = 'N';
798 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
799 print "SIZEOF($1)\n" if ($dbg_values > 1);
800 if (defined $2) {
801 $av_pending = 'V';
803 $type = 'N';
805 } elsif ($cur =~ /^(if|while|for)\b/o) {
806 print "COND($1)\n" if ($dbg_values > 1);
807 $av_pending = 'E';
808 $type = 'N';
810 } elsif ($cur =~/^(case)/o) {
811 print "CASE($1)\n" if ($dbg_values > 1);
812 $av_pend_colon = 'C';
813 $type = 'N';
815 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
816 print "KEYWORD($1)\n" if ($dbg_values > 1);
817 $type = 'N';
819 } elsif ($cur =~ /^(\()/o) {
820 print "PAREN('$1')\n" if ($dbg_values > 1);
821 push(@av_paren_type, $av_pending);
822 $av_pending = '_';
823 $type = 'N';
825 } elsif ($cur =~ /^(\))/o) {
826 my $new_type = pop(@av_paren_type);
827 if ($new_type ne '_') {
828 $type = $new_type;
829 print "PAREN('$1') -> $type\n"
830 if ($dbg_values > 1);
831 } else {
832 print "PAREN('$1')\n" if ($dbg_values > 1);
835 } elsif ($cur =~ /^($Ident)\s*\(/o) {
836 print "FUNC($1)\n" if ($dbg_values > 1);
837 $type = 'V';
838 $av_pending = 'V';
840 } elsif ($cur =~ /^($Ident\s*):/) {
841 if ($type eq 'E') {
842 $av_pend_colon = 'L';
843 } elsif ($type eq 'T') {
844 $av_pend_colon = 'B';
846 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
847 $type = 'V';
849 } elsif ($cur =~ /^($Ident|$Constant)/o) {
850 print "IDENT($1)\n" if ($dbg_values > 1);
851 $type = 'V';
853 } elsif ($cur =~ /^($Assignment)/o) {
854 print "ASSIGN($1)\n" if ($dbg_values > 1);
855 $type = 'N';
857 } elsif ($cur =~/^(;|{|})/) {
858 print "END($1)\n" if ($dbg_values > 1);
859 $type = 'E';
860 $av_pend_colon = 'O';
862 } elsif ($cur =~ /^(\?)/o) {
863 print "QUESTION($1)\n" if ($dbg_values > 1);
864 $type = 'N';
866 } elsif ($cur =~ /^(:)/o) {
867 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
869 substr($var, length($res), 1, $av_pend_colon);
870 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
871 $type = 'E';
872 } else {
873 $type = 'N';
875 $av_pend_colon = 'O';
877 } elsif ($cur =~ /^(;|\[)/o) {
878 print "CLOSE($1)\n" if ($dbg_values > 1);
879 $type = 'N';
881 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
882 my $variant;
884 print "OPV($1)\n" if ($dbg_values > 1);
885 if ($type eq 'V') {
886 $variant = 'B';
887 } else {
888 $variant = 'U';
891 substr($var, length($res), 1, $variant);
892 $type = 'N';
894 } elsif ($cur =~ /^($Operators)/o) {
895 print "OP($1)\n" if ($dbg_values > 1);
896 if ($1 ne '++' && $1 ne '--') {
897 $type = 'N';
900 } elsif ($cur =~ /(^.)/o) {
901 print "C($1)\n" if ($dbg_values > 1);
903 if (defined $1) {
904 $cur = substr($cur, length($1));
905 $res .= $type x length($1);
909 return ($res, $var);
912 sub possible {
913 my ($possible, $line) = @_;
915 print "CHECK<$possible> ($line)\n" if ($dbg_possible > 1);
916 if ($possible !~ /^(?:$Modifier|$Storage|$Type|DEFINE_\S+)$/ &&
917 $possible ne 'goto' && $possible ne 'return' &&
918 $possible ne 'case' && $possible ne 'else' &&
919 $possible ne 'asm' && $possible ne '__asm__' &&
920 $possible !~ /^(typedef|struct|enum)\b/) {
921 # Check for modifiers.
922 $possible =~ s/\s*$Storage\s*//g;
923 $possible =~ s/\s*$Sparse\s*//g;
924 if ($possible =~ /^\s*$/) {
926 } elsif ($possible =~ /\s/) {
927 $possible =~ s/\s*$Type\s*//g;
928 for my $modifier (split(' ', $possible)) {
929 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
930 push(@modifierList, $modifier);
933 } else {
934 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
935 push(@typeList, $possible);
937 build_types();
941 my $prefix = '';
943 sub report {
944 if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
945 return 0;
947 my $line = $prefix . $_[0];
949 $line = (split('\n', $line))[0] . "\n" if ($terse);
951 push(our @report, $line);
953 return 1;
955 sub report_dump {
956 our @report;
958 sub ERROR {
959 if (report("ERROR: $_[0]\n")) {
960 our $clean = 0;
961 our $cnt_error++;
964 sub WARN {
965 if (report("WARNING: $_[0]\n")) {
966 our $clean = 0;
967 our $cnt_warn++;
970 sub CHK {
971 if ($check && report("CHECK: $_[0]\n")) {
972 our $clean = 0;
973 our $cnt_chk++;
977 sub check_absolute_file {
978 my ($absolute, $herecurr) = @_;
979 my $file = $absolute;
981 ##print "absolute<$absolute>\n";
983 # See if any suffix of this path is a path within the tree.
984 while ($file =~ s@^[^/]*/@@) {
985 if (-f "$root/$file") {
986 ##print "file<$file>\n";
987 last;
990 if (! -f _) {
991 return 0;
994 # It is, so see if the prefix is acceptable.
995 my $prefix = $absolute;
996 substr($prefix, -length($file)) = '';
998 ##print "prefix<$prefix>\n";
999 if ($prefix ne ".../") {
1000 WARN("use relative pathname instead of absolute in changelog text\n" . $herecurr);
1004 sub process {
1005 my $filename = shift;
1007 my $linenr=0;
1008 my $prevline="";
1009 my $prevrawline="";
1010 my $stashline="";
1011 my $stashrawline="";
1013 my $length;
1014 my $indent;
1015 my $previndent=0;
1016 my $stashindent=0;
1018 our $clean = 1;
1019 my $signoff = 0;
1020 my $is_patch = 0;
1022 our @report = ();
1023 our $cnt_lines = 0;
1024 our $cnt_error = 0;
1025 our $cnt_warn = 0;
1026 our $cnt_chk = 0;
1028 # Trace the real file/line as we go.
1029 my $realfile = '';
1030 my $realline = 0;
1031 my $realcnt = 0;
1032 my $here = '';
1033 my $in_comment = 0;
1034 my $comment_edge = 0;
1035 my $first_line = 0;
1037 my $prev_values = 'E';
1039 # suppression flags
1040 my %suppress_ifbraces;
1042 # Pre-scan the patch sanitizing the lines.
1043 # Pre-scan the patch looking for any __setup documentation.
1045 my @setup_docs = ();
1046 my $setup_docs = 0;
1048 sanitise_line_reset();
1049 my $line;
1050 foreach my $rawline (@rawlines) {
1051 $linenr++;
1052 $line = $rawline;
1054 if ($rawline=~/^\+\+\+\s+(\S+)/) {
1055 $setup_docs = 0;
1056 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1057 $setup_docs = 1;
1059 #next;
1061 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1062 $realline=$1-1;
1063 if (defined $2) {
1064 $realcnt=$3+1;
1065 } else {
1066 $realcnt=1+1;
1068 $in_comment = 0;
1070 # Guestimate if this is a continuing comment. Run
1071 # the context looking for a comment "edge". If this
1072 # edge is a close comment then we must be in a comment
1073 # at context start.
1074 my $edge;
1075 my $cnt = $realcnt;
1076 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1077 next if (defined $rawlines[$ln - 1] &&
1078 $rawlines[$ln - 1] =~ /^-/);
1079 $cnt--;
1080 #print "RAW<$rawlines[$ln - 1]>\n";
1081 ($edge) = (defined $rawlines[$ln - 1] &&
1082 $rawlines[$ln - 1] =~ m@(/\*|\*/)@);
1083 last if (defined $edge);
1085 if (defined $edge && $edge eq '*/') {
1086 $in_comment = 1;
1089 # Guestimate if this is a continuing comment. If this
1090 # is the start of a diff block and this line starts
1091 # ' *' then it is very likely a comment.
1092 if (!defined $edge &&
1093 $rawlines[$linenr] =~ m@^.\s* \*(?:\s|$)@)
1095 $in_comment = 1;
1098 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1099 sanitise_line_reset($in_comment);
1101 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1102 # Standardise the strings and chars within the input to
1103 # simplify matching -- only bother with positive lines.
1104 $line = sanitise_line($rawline);
1106 push(@lines, $line);
1108 if ($realcnt > 1) {
1109 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1110 } else {
1111 $realcnt = 0;
1114 #print "==>$rawline\n";
1115 #print "-->$line\n";
1117 if ($setup_docs && $line =~ /^\+/) {
1118 push(@setup_docs, $line);
1122 $prefix = '';
1124 $realcnt = 0;
1125 $linenr = 0;
1126 foreach my $line (@lines) {
1127 $linenr++;
1129 my $rawline = $rawlines[$linenr - 1];
1131 #extract the line range in the file after the patch is applied
1132 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1133 $is_patch = 1;
1134 $first_line = $linenr + 1;
1135 $realline=$1-1;
1136 if (defined $2) {
1137 $realcnt=$3+1;
1138 } else {
1139 $realcnt=1+1;
1141 annotate_reset();
1142 $prev_values = 'E';
1144 %suppress_ifbraces = ();
1145 next;
1147 # track the line number as we move through the hunk, note that
1148 # new versions of GNU diff omit the leading space on completely
1149 # blank context lines so we need to count that too.
1150 } elsif ($line =~ /^( |\+|$)/) {
1151 $realline++;
1152 $realcnt-- if ($realcnt != 0);
1154 # Measure the line length and indent.
1155 ($length, $indent) = line_stats($rawline);
1157 # Track the previous line.
1158 ($prevline, $stashline) = ($stashline, $line);
1159 ($previndent, $stashindent) = ($stashindent, $indent);
1160 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1162 #warn "line<$line>\n";
1164 } elsif ($realcnt == 1) {
1165 $realcnt--;
1168 #make up the handle for any error we report on this line
1169 $prefix = "$filename:$realline: " if ($emacs && $file);
1170 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1172 $here = "#$linenr: " if (!$file);
1173 $here = "#$realline: " if ($file);
1175 # extract the filename as it passes
1176 if ($line=~/^\+\+\+\s+(\S+)/) {
1177 $realfile = $1;
1178 $realfile =~ s@^[^/]*/@@;
1180 if ($realfile =~ m@^include/asm/@) {
1181 ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1183 next;
1186 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
1188 my $hereline = "$here\n$rawline\n";
1189 my $herecurr = "$here\n$rawline\n";
1190 my $hereprev = "$here\n$prevrawline\n$rawline\n";
1192 $cnt_lines++ if ($realcnt != 0);
1194 #check the patch for a signoff:
1195 if ($line =~ /^\s*signed-off-by:/i) {
1196 # This is a signoff, if ugly, so do not double report.
1197 $signoff++;
1198 if (!($line =~ /^\s*Signed-off-by:/)) {
1199 WARN("Signed-off-by: is the preferred form\n" .
1200 $herecurr);
1202 if ($line =~ /^\s*signed-off-by:\S/i) {
1203 WARN("space required after Signed-off-by:\n" .
1204 $herecurr);
1208 # Check for wrappage within a valid hunk of the file
1209 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1210 ERROR("patch seems to be corrupt (line wrapped?)\n" .
1211 $herecurr) if (!$emitted_corrupt++);
1214 # Check for absolute kernel paths.
1215 if ($tree) {
1216 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1217 my $file = $1;
1219 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1220 check_absolute_file($1, $herecurr)) {
1222 } else {
1223 check_absolute_file($file, $herecurr);
1228 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1229 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1230 $rawline !~ m/^$UTF8*$/) {
1231 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1233 my $blank = copy_spacing($rawline);
1234 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1235 my $hereptr = "$hereline$ptr\n";
1237 ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1240 #ignore lines being removed
1241 if ($line=~/^-/) {next;}
1243 # check we are in a valid source file if not then ignore this hunk
1244 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1246 #trailing whitespace
1247 if ($line =~ /^\+.*\015/) {
1248 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1249 ERROR("DOS line endings\n" . $herevet);
1251 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1252 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1253 ERROR("trailing whitespace\n" . $herevet);
1255 #80 column limit
1256 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
1257 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1258 $line !~ /^\+\s*printk\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ &&
1259 $length > 80)
1261 WARN("line over 80 characters\n" . $herecurr);
1264 # check for adding lines without a newline.
1265 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1266 WARN("adding a line without newline at end of file\n" . $herecurr);
1269 # check we are in a valid source file C or perl if not then ignore this hunk
1270 next if ($realfile !~ /\.(h|c|pl)$/);
1272 # at the beginning of a line any tabs must come first and anything
1273 # more than 8 must use tabs.
1274 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1275 $rawline =~ /^\+\s* \s*/) {
1276 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1277 ERROR("code indent should use tabs where possible\n" . $herevet);
1280 # check we are in a valid C source file if not then ignore this hunk
1281 next if ($realfile !~ /\.(h|c)$/);
1283 # check for RCS/CVS revision markers
1284 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
1285 WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1288 # Check for potential 'bare' types
1289 my ($stat, $cond, $line_nr_next, $remain_next);
1290 if ($realcnt && $line =~ /.\s*\S/) {
1291 ($stat, $cond, $line_nr_next, $remain_next) =
1292 ctx_statement_block($linenr, $realcnt, 0);
1293 $stat =~ s/\n./\n /g;
1294 $cond =~ s/\n./\n /g;
1296 my $s = $stat;
1297 $s =~ s/{.*$//s;
1299 # Ignore goto labels.
1300 if ($s =~ /$Ident:\*$/s) {
1302 # Ignore functions being called
1303 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
1305 # declarations always start with types
1306 } 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) {
1307 my $type = $1;
1308 $type =~ s/\s+/ /g;
1309 possible($type, "A:" . $s);
1311 # definitions in global scope can only start with types
1312 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b/s) {
1313 possible($1, "B:" . $s);
1316 # any (foo ... *) is a pointer cast, and foo is a type
1317 while ($s =~ /\(($Ident)(?:\s+$Sparse)*\s*\*+\s*\)/sg) {
1318 possible($1, "C:" . $s);
1321 # Check for any sort of function declaration.
1322 # int foo(something bar, other baz);
1323 # void (*store_gdt)(x86_descr_ptr *);
1324 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
1325 my ($name_len) = length($1);
1327 my $ctx = $s;
1328 substr($ctx, 0, $name_len + 1, '');
1329 $ctx =~ s/\)[^\)]*$//;
1331 for my $arg (split(/\s*,\s*/, $ctx)) {
1332 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
1334 possible($1, "D:" . $s);
1342 # Checks which may be anchored in the context.
1345 # Check for switch () and associated case and default
1346 # statements should be at the same indent.
1347 if ($line=~/\bswitch\s*\(.*\)/) {
1348 my $err = '';
1349 my $sep = '';
1350 my @ctx = ctx_block_outer($linenr, $realcnt);
1351 shift(@ctx);
1352 for my $ctx (@ctx) {
1353 my ($clen, $cindent) = line_stats($ctx);
1354 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1355 $indent != $cindent) {
1356 $err .= "$sep$ctx\n";
1357 $sep = '';
1358 } else {
1359 $sep = "[...]\n";
1362 if ($err ne '') {
1363 ERROR("switch and case should be at the same indent\n$hereline$err");
1367 # if/while/etc brace do not go on next line, unless defining a do while loop,
1368 # or if that brace on the next line is for something else
1369 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
1370 my $pre_ctx = "$1$2";
1372 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
1373 my $ctx_cnt = $realcnt - $#ctx - 1;
1374 my $ctx = join("\n", @ctx);
1376 my $ctx_ln = $linenr;
1377 my $ctx_skip = $realcnt;
1379 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1380 defined $lines[$ctx_ln - 1] &&
1381 $lines[$ctx_ln - 1] =~ /^-/)) {
1382 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1383 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
1384 $ctx_ln++;
1387 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1388 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
1390 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1391 ERROR("that open brace { should be on the previous line\n" .
1392 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1394 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1395 $ctx =~ /\)\s*\;\s*$/ &&
1396 defined $lines[$ctx_ln - 1])
1398 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1399 if ($nindent > $indent) {
1400 WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
1401 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1406 # Check relative indent for conditionals and blocks.
1407 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1408 my ($s, $c) = ($stat, $cond);
1410 substr($s, 0, length($c), '');
1412 # Make sure we remove the line prefixes as we have
1413 # none on the first line, and are going to readd them
1414 # where necessary.
1415 $s =~ s/\n./\n/gs;
1417 # Find out how long the conditional actually is.
1418 my $cond_lines = 0 + $c =~ /\n/gs;
1420 # We want to check the first line inside the block
1421 # starting at the end of the conditional, so remove:
1422 # 1) any blank line termination
1423 # 2) any opening brace { on end of the line
1424 # 3) any do (...) {
1425 my $continuation = 0;
1426 my $check = 0;
1427 $s =~ s/^.*\bdo\b//;
1428 $s =~ s/^\s*{//;
1429 if ($s =~ s/^\s*\\//) {
1430 $continuation = 1;
1432 if ($s =~ s/^\s*?\n//) {
1433 $check = 1;
1434 $cond_lines++;
1437 # Also ignore a loop construct at the end of a
1438 # preprocessor statement.
1439 if (($prevline =~ /^.\s*#\s*define\s/ ||
1440 $prevline =~ /\\\s*$/) && $continuation == 0) {
1441 $check = 0;
1444 my $cond_ptr = -1;
1445 while ($cond_ptr != $cond_lines) {
1446 $cond_ptr = $cond_lines;
1448 # Ignore:
1449 # 1) blank lines, they should be at 0,
1450 # 2) preprocessor lines, and
1451 # 3) labels.
1452 if ($s =~ /^\s*?\n/ ||
1453 $s =~ /^\s*#\s*?/ ||
1454 $s =~ /^\s*$Ident\s*:/) {
1455 $s =~ s/^.*?\n//;
1456 $cond_lines++;
1460 my (undef, $sindent) = line_stats("+" . $s);
1461 my $stat_real = raw_line($linenr, $cond_lines);
1463 # Check if either of these lines are modified, else
1464 # this is not this patch's fault.
1465 if (!defined($stat_real) ||
1466 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
1467 $check = 0;
1469 if (defined($stat_real) && $cond_lines > 1) {
1470 $stat_real = "[...]\n$stat_real";
1473 #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";
1475 if ($check && (($sindent % 8) != 0 ||
1476 ($sindent <= $indent && $s ne ''))) {
1477 WARN("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
1481 # Track the 'values' across context and added lines.
1482 my $opline = $line; $opline =~ s/^./ /;
1483 my ($curr_values, $curr_vars) =
1484 annotate_values($opline . "\n", $prev_values);
1485 $curr_values = $prev_values . $curr_values;
1486 if ($dbg_values) {
1487 my $outline = $opline; $outline =~ s/\t/ /g;
1488 print "$linenr > .$outline\n";
1489 print "$linenr > $curr_values\n";
1490 print "$linenr > $curr_vars\n";
1492 $prev_values = substr($curr_values, -1);
1494 #ignore lines not being added
1495 if ($line=~/^[^\+]/) {next;}
1497 # TEST: allow direct testing of the type matcher.
1498 if ($dbg_type) {
1499 if ($line =~ /^.\s*$Declare\s*$/) {
1500 ERROR("TEST: is type\n" . $herecurr);
1501 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
1502 ERROR("TEST: is not type ($1 is)\n". $herecurr);
1504 next;
1506 # TEST: allow direct testing of the attribute matcher.
1507 if ($dbg_attr) {
1508 if ($line =~ /^.\s*$Attribute\s*$/) {
1509 ERROR("TEST: is attr\n" . $herecurr);
1510 } elsif ($dbg_attr > 1 && $line =~ /^.+($Attribute)/) {
1511 ERROR("TEST: is not attr ($1 is)\n". $herecurr);
1513 next;
1516 # check for initialisation to aggregates open brace on the next line
1517 if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ &&
1518 $line =~ /^.\s*{/) {
1519 ERROR("that open brace { should be on the previous line\n" . $hereprev);
1523 # Checks which are anchored on the added line.
1526 # check for malformed paths in #include statements (uses RAW line)
1527 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
1528 my $path = $1;
1529 if ($path =~ m{//}) {
1530 ERROR("malformed #include filename\n" .
1531 $herecurr);
1535 # no C99 // comments
1536 if ($line =~ m{//}) {
1537 ERROR("do not use C99 // comments\n" . $herecurr);
1539 # Remove C99 comments.
1540 $line =~ s@//.*@@;
1541 $opline =~ s@//.*@@;
1543 #EXPORT_SYMBOL should immediately follow its function closing }.
1544 if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) ||
1545 ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1546 my $name = $1;
1547 if (($prevline !~ /^}/) &&
1548 ($prevline !~ /^\+}/) &&
1549 ($prevline !~ /^ }/) &&
1550 ($prevline !~ /^.DECLARE_$Ident\(\Q$name\E\)/) &&
1551 ($prevline !~ /^.LIST_HEAD\(\Q$name\E\)/) &&
1552 ($prevline !~ /^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(/) &&
1553 ($prevline !~ /\b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[)/)) {
1554 WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
1558 # check for external initialisers.
1559 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
1560 ERROR("do not initialise externals to 0 or NULL\n" .
1561 $herecurr);
1563 # check for static initialisers.
1564 if ($line =~ /\s*static\s.*=\s*(0|NULL|false)\s*;/) {
1565 ERROR("do not initialise statics to 0 or NULL\n" .
1566 $herecurr);
1569 # check for new typedefs, only function parameters and sparse annotations
1570 # make sense.
1571 if ($line =~ /\btypedef\s/ &&
1572 $line !~ /\btypedef\s+$Type\s+\(\s*\*?$Ident\s*\)\s*\(/ &&
1573 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
1574 $line !~ /\b__bitwise(?:__|)\b/) {
1575 WARN("do not add new typedefs\n" . $herecurr);
1578 # * goes on variable not on type
1579 if ($line =~ m{\($NonptrType(\*+)(?:\s+const)?\)}) {
1580 ERROR("\"(foo$1)\" should be \"(foo $1)\"\n" .
1581 $herecurr);
1583 } elsif ($line =~ m{\($NonptrType\s+(\*+)(?!\s+const)\s+\)}) {
1584 ERROR("\"(foo $1 )\" should be \"(foo $1)\"\n" .
1585 $herecurr);
1587 } elsif ($line =~ m{\b$NonptrType(\*+)(?:\s+(?:$Attribute|$Sparse))?\s+[A-Za-z\d_]+}) {
1588 ERROR("\"foo$1 bar\" should be \"foo $1bar\"\n" .
1589 $herecurr);
1591 } elsif ($line =~ m{\b$NonptrType\s+(\*+)(?!\s+(?:$Attribute|$Sparse))\s+[A-Za-z\d_]+}) {
1592 ERROR("\"foo $1 bar\" should be \"foo $1bar\"\n" .
1593 $herecurr);
1596 # # no BUG() or BUG_ON()
1597 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
1598 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
1599 # print "$herecurr";
1600 # $clean = 0;
1603 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
1604 WARN("LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
1607 # printk should use KERN_* levels. Note that follow on printk's on the
1608 # same line do not need a level, so we use the current block context
1609 # to try and find and validate the current printk. In summary the current
1610 # printk includes all preceeding printk's which have no newline on the end.
1611 # we assume the first bad printk is the one to report.
1612 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
1613 my $ok = 0;
1614 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
1615 #print "CHECK<$lines[$ln - 1]\n";
1616 # we have a preceeding printk if it ends
1617 # with "\n" ignore it, else it is to blame
1618 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
1619 if ($rawlines[$ln - 1] !~ m{\\n"}) {
1620 $ok = 1;
1622 last;
1625 if ($ok == 0) {
1626 WARN("printk() should include KERN_ facility level\n" . $herecurr);
1630 # function brace can't be on same line, except for #defines of do while,
1631 # or if closed on same line
1632 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
1633 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
1634 ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
1637 # open braces for enum, union and struct go on the same line.
1638 if ($line =~ /^.\s*{/ &&
1639 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1640 ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
1643 # check for spacing round square brackets; allowed:
1644 # 1. with a type on the left -- int [] a;
1645 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
1646 # 3. inside a curly brace -- = { [0...10] = 5 }
1647 while ($line =~ /(.*?\s)\[/g) {
1648 my ($where, $prefix) = ($-[1], $1);
1649 if ($prefix !~ /$Type\s+$/ &&
1650 ($where != 0 || $prefix !~ /^.\s+$/) &&
1651 $prefix !~ /{\s+$/) {
1652 ERROR("space prohibited before open square bracket '['\n" . $herecurr);
1656 # check for spaces between functions and their parentheses.
1657 while ($line =~ /($Ident)\s+\(/g) {
1658 my $name = $1;
1659 my $ctx_before = substr($line, 0, $-[1]);
1660 my $ctx = "$ctx_before$name";
1662 # Ignore those directives where spaces _are_ permitted.
1663 if ($name =~ /^(?:
1664 if|for|while|switch|return|case|
1665 volatile|__volatile__|
1666 __attribute__|format|__extension__|
1667 asm|__asm__)$/x)
1670 # cpp #define statements have non-optional spaces, ie
1671 # if there is a space between the name and the open
1672 # parenthesis it is simply not a parameter group.
1673 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
1675 # cpp #elif statement condition may start with a (
1676 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
1678 # If this whole things ends with a type its most
1679 # likely a typedef for a function.
1680 } elsif ($ctx =~ /$Type$/) {
1682 } else {
1683 WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
1686 # Check operator spacing.
1687 if (!($line=~/\#\s*include/)) {
1688 my $ops = qr{
1689 <<=|>>=|<=|>=|==|!=|
1690 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
1691 =>|->|<<|>>|<|>|=|!|~|
1692 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
1693 \?|:
1695 my @elements = split(/($ops|;)/, $opline);
1696 my $off = 0;
1698 my $blank = copy_spacing($opline);
1700 for (my $n = 0; $n < $#elements; $n += 2) {
1701 $off += length($elements[$n]);
1703 # Pick up the preceeding and succeeding characters.
1704 my $ca = substr($opline, 0, $off);
1705 my $cc = '';
1706 if (length($opline) >= ($off + length($elements[$n + 1]))) {
1707 $cc = substr($opline, $off + length($elements[$n + 1]));
1709 my $cb = "$ca$;$cc";
1711 my $a = '';
1712 $a = 'V' if ($elements[$n] ne '');
1713 $a = 'W' if ($elements[$n] =~ /\s$/);
1714 $a = 'C' if ($elements[$n] =~ /$;$/);
1715 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
1716 $a = 'O' if ($elements[$n] eq '');
1717 $a = 'E' if ($ca =~ /^\s*$/);
1719 my $op = $elements[$n + 1];
1721 my $c = '';
1722 if (defined $elements[$n + 2]) {
1723 $c = 'V' if ($elements[$n + 2] ne '');
1724 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
1725 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
1726 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
1727 $c = 'O' if ($elements[$n + 2] eq '');
1728 $c = 'E' if ($elements[$n + 2] =~ /\s*\\$/);
1729 } else {
1730 $c = 'E';
1733 my $ctx = "${a}x${c}";
1735 my $at = "(ctx:$ctx)";
1737 my $ptr = substr($blank, 0, $off) . "^";
1738 my $hereptr = "$hereline$ptr\n";
1740 # Pull out the value of this operator.
1741 my $op_type = substr($curr_values, $off + 1, 1);
1743 # Get the full operator variant.
1744 my $opv = $op . substr($curr_vars, $off, 1);
1746 # Ignore operators passed as parameters.
1747 if ($op_type ne 'V' &&
1748 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
1750 # # Ignore comments
1751 # } elsif ($op =~ /^$;+$/) {
1753 # ; should have either the end of line or a space or \ after it
1754 } elsif ($op eq ';') {
1755 if ($ctx !~ /.x[WEBC]/ &&
1756 $cc !~ /^\\/ && $cc !~ /^;/) {
1757 ERROR("space required after that '$op' $at\n" . $hereptr);
1760 # // is a comment
1761 } elsif ($op eq '//') {
1763 # No spaces for:
1764 # ->
1765 # : when part of a bitfield
1766 } elsif ($op eq '->' || $opv eq ':B') {
1767 if ($ctx =~ /Wx.|.xW/) {
1768 ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
1771 # , must have a space on the right.
1772 } elsif ($op eq ',') {
1773 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
1774 ERROR("space required after that '$op' $at\n" . $hereptr);
1777 # '*' as part of a type definition -- reported already.
1778 } elsif ($opv eq '*_') {
1779 #warn "'*' is part of type\n";
1781 # unary operators should have a space before and
1782 # none after. May be left adjacent to another
1783 # unary operator, or a cast
1784 } elsif ($op eq '!' || $op eq '~' ||
1785 $opv eq '*U' || $opv eq '-U' ||
1786 $opv eq '&U' || $opv eq '&&U') {
1787 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
1788 ERROR("space required before that '$op' $at\n" . $hereptr);
1790 if ($op eq '*' && $cc =~/\s*const\b/) {
1791 # A unary '*' may be const
1793 } elsif ($ctx =~ /.xW/) {
1794 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1797 # unary ++ and unary -- are allowed no space on one side.
1798 } elsif ($op eq '++' or $op eq '--') {
1799 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
1800 ERROR("space required one side of that '$op' $at\n" . $hereptr);
1802 if ($ctx =~ /Wx[BE]/ ||
1803 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
1804 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
1806 if ($ctx =~ /ExW/) {
1807 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1811 # << and >> may either have or not have spaces both sides
1812 } elsif ($op eq '<<' or $op eq '>>' or
1813 $op eq '&' or $op eq '^' or $op eq '|' or
1814 $op eq '+' or $op eq '-' or
1815 $op eq '*' or $op eq '/' or
1816 $op eq '%')
1818 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
1819 ERROR("need consistent spacing around '$op' $at\n" .
1820 $hereptr);
1823 # A colon needs no spaces before when it is
1824 # terminating a case value or a label.
1825 } elsif ($opv eq ':C' || $opv eq ':L') {
1826 if ($ctx =~ /Wx./) {
1827 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
1830 # All the others need spaces both sides.
1831 } elsif ($ctx !~ /[EWC]x[CWE]/) {
1832 my $ok = 0;
1834 # Ignore email addresses <foo@bar>
1835 if (($op eq '<' &&
1836 $cc =~ /^\S+\@\S+>/) ||
1837 ($op eq '>' &&
1838 $ca =~ /<\S+\@\S+$/))
1840 $ok = 1;
1843 # Ignore ?:
1844 if (($opv eq ':O' && $ca =~ /\?$/) ||
1845 ($op eq '?' && $cc =~ /^:/)) {
1846 $ok = 1;
1849 if ($ok == 0) {
1850 ERROR("spaces required around that '$op' $at\n" . $hereptr);
1853 $off += length($elements[$n + 1]);
1857 # check for multiple assignments
1858 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
1859 CHK("multiple assignments should be avoided\n" . $herecurr);
1862 ## # check for multiple declarations, allowing for a function declaration
1863 ## # continuation.
1864 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
1865 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
1867 ## # Remove any bracketed sections to ensure we do not
1868 ## # falsly report the parameters of functions.
1869 ## my $ln = $line;
1870 ## while ($ln =~ s/\([^\(\)]*\)//g) {
1871 ## }
1872 ## if ($ln =~ /,/) {
1873 ## WARN("declaring multiple variables together should be avoided\n" . $herecurr);
1874 ## }
1875 ## }
1877 #need space before brace following if, while, etc
1878 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
1879 $line =~ /do{/) {
1880 ERROR("space required before the open brace '{'\n" . $herecurr);
1883 # closing brace should have a space following it when it has anything
1884 # on the line
1885 if ($line =~ /}(?!(?:,|;|\)))\S/) {
1886 ERROR("space required after that close brace '}'\n" . $herecurr);
1889 # check spacing on square brackets
1890 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
1891 ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
1893 if ($line =~ /\s\]/) {
1894 ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
1897 # check spacing on parentheses
1898 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
1899 $line !~ /for\s*\(\s+;/) {
1900 ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
1902 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
1903 $line !~ /for\s*\(.*;\s+\)/ &&
1904 $line !~ /:\s+\)/) {
1905 ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
1908 #goto labels aren't indented, allow a single space however
1909 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
1910 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
1911 WARN("labels should not be indented\n" . $herecurr);
1914 # Return is not a function.
1915 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
1916 my $spacing = $1;
1917 my $value = $2;
1919 # Flatten any parentheses and braces
1920 $value =~ s/\)\(/\) \(/g;
1921 while ($value =~ s/\([^\(\)]*\)/1/) {
1924 if ($value =~ /^(?:$Ident|-?$Constant)$/) {
1925 ERROR("return is not a function, parentheses are not required\n" . $herecurr);
1927 } elsif ($spacing !~ /\s+/) {
1928 ERROR("space required before the open parenthesis '('\n" . $herecurr);
1932 # Need a space before open parenthesis after if, while etc
1933 if ($line=~/\b(if|while|for|switch)\(/) {
1934 ERROR("space required before the open parenthesis '('\n" . $herecurr);
1937 # Check for illegal assignment in if conditional -- and check for trailing
1938 # statements after the conditional.
1939 if ($line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
1940 my ($s, $c) = ($stat, $cond);
1942 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/) {
1943 ERROR("do not use assignment in if condition\n" . $herecurr);
1946 # Find out what is on the end of the line after the
1947 # conditional.
1948 substr($s, 0, length($c), '');
1949 $s =~ s/\n.*//g;
1950 $s =~ s/$;//g; # Remove any comments
1951 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
1952 $c !~ /}\s*while\s*/)
1954 ERROR("trailing statements should be on next line\n" . $herecurr);
1958 # Check for bitwise tests written as boolean
1959 if ($line =~ /
1961 (?:\[|\(|\&\&|\|\|)
1962 \s*0[xX][0-9]+\s*
1963 (?:\&\&|\|\|)
1965 (?:\&\&|\|\|)
1966 \s*0[xX][0-9]+\s*
1967 (?:\&\&|\|\||\)|\])
1968 )/x)
1970 WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
1973 # if and else should not have general statements after it
1974 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
1975 my $s = $1;
1976 $s =~ s/$;//g; # Remove any comments
1977 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
1978 ERROR("trailing statements should be on next line\n" . $herecurr);
1981 # case and default should not have general statements after them
1982 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
1983 $line !~ /\G(?:
1984 (?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
1985 \s*return\s+
1986 )/xg)
1988 ERROR("trailing statements should be on next line\n" . $herecurr);
1991 # Check for }<nl>else {, these must be at the same
1992 # indent level to be relevant to each other.
1993 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
1994 $previndent == $indent) {
1995 ERROR("else should follow close brace '}'\n" . $hereprev);
1998 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
1999 $previndent == $indent) {
2000 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2002 # Find out what is on the end of the line after the
2003 # conditional.
2004 substr($s, 0, length($c), '');
2005 $s =~ s/\n.*//g;
2007 if ($s =~ /^\s*;/) {
2008 ERROR("while should follow close brace '}'\n" . $hereprev);
2012 #studly caps, commented out until figure out how to distinguish between use of existing and adding new
2013 # if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2014 # print "No studly caps, use _\n";
2015 # print "$herecurr";
2016 # $clean = 0;
2019 #no spaces allowed after \ in define
2020 if ($line=~/\#\s*define.*\\\s$/) {
2021 WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
2024 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
2025 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
2026 my $file = "$1.h";
2027 my $checkfile = "include/linux/$file";
2028 if (-f "$root/$checkfile" &&
2029 $realfile ne $checkfile &&
2030 $1 ne 'irq')
2032 if ($realfile =~ m{^arch/}) {
2033 CHK("Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2034 } else {
2035 WARN("Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2040 # multi-statement macros should be enclosed in a do while loop, grab the
2041 # first statement and ensure its the whole macro if its not enclosed
2042 # in a known good container
2043 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2044 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
2045 my $ln = $linenr;
2046 my $cnt = $realcnt;
2047 my ($off, $dstat, $dcond, $rest);
2048 my $ctx = '';
2050 my $args = defined($1);
2052 # Find the end of the macro and limit our statement
2053 # search to that.
2054 while ($cnt > 0 && defined $lines[$ln - 1] &&
2055 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
2057 $ctx .= $rawlines[$ln - 1] . "\n";
2058 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2059 $ln++;
2061 $ctx .= $rawlines[$ln - 1];
2063 ($dstat, $dcond, $ln, $cnt, $off) =
2064 ctx_statement_block($linenr, $ln - $linenr + 1, 0);
2065 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
2066 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
2068 # Extract the remainder of the define (if any) and
2069 # rip off surrounding spaces, and trailing \'s.
2070 $rest = '';
2071 while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
2072 #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
2073 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
2074 $rest .= substr($lines[$ln - 1], $off) . "\n";
2075 $cnt--;
2077 $ln++;
2078 $off = 0;
2080 $rest =~ s/\\\n.//g;
2081 $rest =~ s/^\s*//s;
2082 $rest =~ s/\s*$//s;
2084 # Clean up the original statement.
2085 if ($args) {
2086 substr($dstat, 0, length($dcond), '');
2087 } else {
2088 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
2090 $dstat =~ s/$;//g;
2091 $dstat =~ s/\\\n.//g;
2092 $dstat =~ s/^\s*//s;
2093 $dstat =~ s/\s*$//s;
2095 # Flatten any parentheses and braces
2096 while ($dstat =~ s/\([^\(\)]*\)/1/) {
2098 while ($dstat =~ s/\{[^\{\}]*\}/1/) {
2101 my $exceptions = qr{
2102 $Declare|
2103 module_param_named|
2104 MODULE_PARAM_DESC|
2105 DECLARE_PER_CPU|
2106 DEFINE_PER_CPU|
2107 __typeof__\(
2109 #print "REST<$rest>\n";
2110 if ($rest ne '') {
2111 if ($rest !~ /while\s*\(/ &&
2112 $dstat !~ /$exceptions/)
2114 ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
2117 } elsif ($ctx !~ /;/) {
2118 if ($dstat ne '' &&
2119 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2120 $dstat !~ /$exceptions/ &&
2121 $dstat =~ /$Operators/)
2123 ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
2128 # check for redundant bracing round if etc
2129 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2130 my ($level, $endln, @chunks) =
2131 ctx_statement_full($linenr, $realcnt, 1);
2132 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
2133 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2134 if ($#chunks > 0 && $level == 0) {
2135 my $allowed = 0;
2136 my $seen = 0;
2137 my $herectx = $here . "\n";
2138 my $ln = $linenr - 1;
2139 for my $chunk (@chunks) {
2140 my ($cond, $block) = @{$chunk};
2142 # If the condition carries leading newlines, then count those as offsets.
2143 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2144 my $offset = statement_rawlines($whitespace) - 1;
2146 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2148 # We have looked at and allowed this specific line.
2149 $suppress_ifbraces{$ln + $offset} = 1;
2151 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
2152 $ln += statement_rawlines($block) - 1;
2154 substr($block, 0, length($cond), '');
2156 $seen++ if ($block =~ /^\s*{/);
2158 #print "cond<$cond> block<$block> allowed<$allowed>\n";
2159 if (statement_lines($cond) > 1) {
2160 #print "APW: ALLOWED: cond<$cond>\n";
2161 $allowed = 1;
2163 if ($block =~/\b(?:if|for|while)\b/) {
2164 #print "APW: ALLOWED: block<$block>\n";
2165 $allowed = 1;
2167 if (statement_block_size($block) > 1) {
2168 #print "APW: ALLOWED: lines block<$block>\n";
2169 $allowed = 1;
2172 if ($seen && !$allowed) {
2173 WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
2177 if (!defined $suppress_ifbraces{$linenr - 1} &&
2178 $line =~ /\b(if|while|for|else)\b/) {
2179 my $allowed = 0;
2181 # Check the pre-context.
2182 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2183 #print "APW: ALLOWED: pre<$1>\n";
2184 $allowed = 1;
2187 my ($level, $endln, @chunks) =
2188 ctx_statement_full($linenr, $realcnt, $-[0]);
2190 # Check the condition.
2191 my ($cond, $block) = @{$chunks[0]};
2192 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
2193 if (defined $cond) {
2194 substr($block, 0, length($cond), '');
2196 if (statement_lines($cond) > 1) {
2197 #print "APW: ALLOWED: cond<$cond>\n";
2198 $allowed = 1;
2200 if ($block =~/\b(?:if|for|while)\b/) {
2201 #print "APW: ALLOWED: block<$block>\n";
2202 $allowed = 1;
2204 if (statement_block_size($block) > 1) {
2205 #print "APW: ALLOWED: lines block<$block>\n";
2206 $allowed = 1;
2208 # Check the post-context.
2209 if (defined $chunks[1]) {
2210 my ($cond, $block) = @{$chunks[1]};
2211 if (defined $cond) {
2212 substr($block, 0, length($cond), '');
2214 if ($block =~ /^\s*\{/) {
2215 #print "APW: ALLOWED: chunk-1 block<$block>\n";
2216 $allowed = 1;
2219 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
2220 my $herectx = $here . "\n";;
2221 my $cnt = statement_rawlines($block);
2223 for (my $n = 0; $n < $cnt; $n++) {
2224 $herectx .= raw_line($linenr, $n) . "\n";;
2227 WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
2231 # don't include deprecated include files (uses RAW line)
2232 for my $inc (@dep_includes) {
2233 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
2234 ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2238 # don't use deprecated functions
2239 for my $func (@dep_functions) {
2240 if ($line =~ /\b$func\b/) {
2241 ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2245 # no volatiles please
2246 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2247 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
2248 WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
2251 # SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
2252 if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
2253 ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
2256 # warn about #if 0
2257 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
2258 CHK("if this code is redundant consider removing it\n" .
2259 $herecurr);
2262 # check for needless kfree() checks
2263 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2264 my $expr = $1;
2265 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
2266 WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
2269 # check for needless usb_free_urb() checks
2270 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2271 my $expr = $1;
2272 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
2273 WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
2277 # warn about #ifdefs in C files
2278 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
2279 # print "#ifdef in C files should be avoided\n";
2280 # print "$herecurr";
2281 # $clean = 0;
2284 # warn about spacing in #ifdefs
2285 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
2286 ERROR("exactly one space required after that #$1\n" . $herecurr);
2289 # check for spinlock_t definitions without a comment.
2290 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
2291 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
2292 my $which = $1;
2293 if (!ctx_has_comment($first_line, $linenr)) {
2294 CHK("$1 definition without comment\n" . $herecurr);
2297 # check for memory barriers without a comment.
2298 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2299 if (!ctx_has_comment($first_line, $linenr)) {
2300 CHK("memory barrier without comment\n" . $herecurr);
2303 # check of hardware specific defines
2304 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
2305 CHK("architecture specific defines should be avoided\n" . $herecurr);
2308 # check the location of the inline attribute, that it is between
2309 # storage class and type.
2310 if ($line =~ /\b$Type\s+$Inline\b/ ||
2311 $line =~ /\b$Inline\s+$Storage\b/) {
2312 ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
2315 # Check for __inline__ and __inline, prefer inline
2316 if ($line =~ /\b(__inline__|__inline)\b/) {
2317 WARN("plain inline is preferred over $1\n" . $herecurr);
2320 # check for new externs in .c files.
2321 if ($realfile =~ /\.c$/ && defined $stat &&
2322 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
2324 my $function_name = $1;
2325 my $paren_space = $2;
2327 my $s = $stat;
2328 if (defined $cond) {
2329 substr($s, 0, length($cond), '');
2331 if ($s =~ /^\s*;/ &&
2332 $function_name ne 'uninitialized_var')
2334 WARN("externs should be avoided in .c files\n" . $herecurr);
2337 if ($paren_space =~ /\n/) {
2338 WARN("arguments for function declarations should follow identifier\n" . $herecurr);
2341 } elsif ($realfile =~ /\.c$/ && defined $stat &&
2342 $stat =~ /^.\s*extern\s+/)
2344 WARN("externs should be avoided in .c files\n" . $herecurr);
2347 # checks for new __setup's
2348 if ($rawline =~ /\b__setup\("([^"]*)"/) {
2349 my $name = $1;
2351 if (!grep(/$name/, @setup_docs)) {
2352 CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
2356 # check for pointless casting of kmalloc return
2357 if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
2358 WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
2361 # check for gcc specific __FUNCTION__
2362 if ($line =~ /__FUNCTION__/) {
2363 WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
2366 # check for semaphores used as mutexes
2367 if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
2368 WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
2370 # check for semaphores used as mutexes
2371 if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
2372 WARN("consider using a completion\n" . $herecurr);
2374 # recommend strict_strto* over simple_strto*
2375 if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2376 WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
2378 # check for __initcall(), use device_initcall() explicitly please
2379 if ($line =~ /^.\s*__initcall\s*\(/) {
2380 WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
2383 # use of NR_CPUS is usually wrong
2384 # ignore definitions of NR_CPUS and usage to define arrays as likely right
2385 if ($line =~ /\bNR_CPUS\b/ &&
2386 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
2387 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
2388 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
2389 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
2390 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
2392 WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
2395 # check for %L{u,d,i} in strings
2396 my $string;
2397 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2398 $string = substr($rawline, $-[1], $+[1] - $-[1]);
2399 $string =~ s/%%/__/g;
2400 if ($string =~ /(?<!%)%L[udi]/) {
2401 WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2402 last;
2407 # If we have no input at all, then there is nothing to report on
2408 # so just keep quiet.
2409 if ($#rawlines == -1) {
2410 exit(0);
2413 # In mailback mode only produce a report in the negative, for
2414 # things that appear to be patches.
2415 if ($mailback && ($clean == 1 || !$is_patch)) {
2416 exit(0);
2419 # This is not a patch, and we are are in 'no-patch' mode so
2420 # just keep quiet.
2421 if (!$chk_patch && !$is_patch) {
2422 exit(0);
2425 if (!$is_patch) {
2426 ERROR("Does not appear to be a unified-diff format patch\n");
2428 if ($is_patch && $chk_signoff && $signoff == 0) {
2429 ERROR("Missing Signed-off-by: line(s)\n");
2432 print report_dump();
2433 if ($summary && !($clean == 1 && $quiet == 1)) {
2434 print "$filename " if ($summary_file);
2435 print "total: $cnt_error errors, $cnt_warn warnings, " .
2436 (($check)? "$cnt_chk checks, " : "") .
2437 "$cnt_lines lines checked\n";
2438 print "\n" if ($quiet == 0);
2441 if ($clean == 1 && $quiet == 0) {
2442 print "$vname has no obvious style problems and is ready for submission.\n"
2444 if ($clean == 0 && $quiet == 0) {
2445 print "$vname has style problems, please review. If any of these errors\n";
2446 print "are false positives report them to the maintainer, see\n";
2447 print "CHECKPATCH in MAINTAINERS.\n";
2450 return $clean;