checkpatch: suppress errors triggered by short patch
[linux-2.6/mini2440.git] / scripts / checkpatch.pl
blob5382f7287397d3aabd832a4f7f615216ce3d495e
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 last if (!defined $lines[$line]);
412 next if ($lines[$line] =~ /^-/);
413 $remain--;
414 $loff = $len;
415 $blk .= $lines[$line] . "\n";
416 $len = length($blk);
417 $line++;
418 last;
420 # Bail if there is no further context.
421 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
422 if ($off >= $len) {
423 last;
426 $p = $c;
427 $c = substr($blk, $off, 1);
428 $remainder = substr($blk, $off);
430 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
431 # Statement ends at the ';' or a close '}' at the
432 # outermost level.
433 if ($level == 0 && $c eq ';') {
434 last;
437 # An else is really a conditional as long as its not else if
438 if ($level == 0 && $coff_set == 0 &&
439 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
440 $remainder =~ /^(else)(?:\s|{)/ &&
441 $remainder !~ /^else\s+if\b/) {
442 $coff = $off + length($1) - 1;
443 $coff_set = 1;
444 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
445 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
448 if (($type eq '' || $type eq '(') && $c eq '(') {
449 $level++;
450 $type = '(';
452 if ($type eq '(' && $c eq ')') {
453 $level--;
454 $type = ($level != 0)? '(' : '';
456 if ($level == 0 && $coff < $soff) {
457 $coff = $off;
458 $coff_set = 1;
459 #warn "CSB: mark coff<$coff>\n";
462 if (($type eq '' || $type eq '{') && $c eq '{') {
463 $level++;
464 $type = '{';
466 if ($type eq '{' && $c eq '}') {
467 $level--;
468 $type = ($level != 0)? '{' : '';
470 if ($level == 0) {
471 last;
474 $off++;
476 # We are truly at the end, so shuffle to the next line.
477 if ($off == $len) {
478 $loff = $len + 1;
479 $line++;
480 $remain--;
483 my $statement = substr($blk, $soff, $off - $soff + 1);
484 my $condition = substr($blk, $soff, $coff - $soff + 1);
486 #warn "STATEMENT<$statement>\n";
487 #warn "CONDITION<$condition>\n";
489 #print "coff<$coff> soff<$off> loff<$loff>\n";
491 return ($statement, $condition,
492 $line, $remain + 1, $off - $loff + 1, $level);
495 sub statement_lines {
496 my ($stmt) = @_;
498 # Strip the diff line prefixes and rip blank lines at start and end.
499 $stmt =~ s/(^|\n)./$1/g;
500 $stmt =~ s/^\s*//;
501 $stmt =~ s/\s*$//;
503 my @stmt_lines = ($stmt =~ /\n/g);
505 return $#stmt_lines + 2;
508 sub statement_rawlines {
509 my ($stmt) = @_;
511 my @stmt_lines = ($stmt =~ /\n/g);
513 return $#stmt_lines + 2;
516 sub statement_block_size {
517 my ($stmt) = @_;
519 $stmt =~ s/(^|\n)./$1/g;
520 $stmt =~ s/^\s*{//;
521 $stmt =~ s/}\s*$//;
522 $stmt =~ s/^\s*//;
523 $stmt =~ s/\s*$//;
525 my @stmt_lines = ($stmt =~ /\n/g);
526 my @stmt_statements = ($stmt =~ /;/g);
528 my $stmt_lines = $#stmt_lines + 2;
529 my $stmt_statements = $#stmt_statements + 1;
531 if ($stmt_lines > $stmt_statements) {
532 return $stmt_lines;
533 } else {
534 return $stmt_statements;
538 sub ctx_statement_full {
539 my ($linenr, $remain, $off) = @_;
540 my ($statement, $condition, $level);
542 my (@chunks);
544 # Grab the first conditional/block pair.
545 ($statement, $condition, $linenr, $remain, $off, $level) =
546 ctx_statement_block($linenr, $remain, $off);
547 #print "F: c<$condition> s<$statement> remain<$remain>\n";
548 push(@chunks, [ $condition, $statement ]);
549 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
550 return ($level, $linenr, @chunks);
553 # Pull in the following conditional/block pairs and see if they
554 # could continue the statement.
555 for (;;) {
556 ($statement, $condition, $linenr, $remain, $off, $level) =
557 ctx_statement_block($linenr, $remain, $off);
558 #print "C: c<$condition> s<$statement> remain<$remain>\n";
559 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
560 #print "C: push\n";
561 push(@chunks, [ $condition, $statement ]);
564 return ($level, $linenr, @chunks);
567 sub ctx_block_get {
568 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
569 my $line;
570 my $start = $linenr - 1;
571 my $blk = '';
572 my @o;
573 my @c;
574 my @res = ();
576 my $level = 0;
577 for ($line = $start; $remain > 0; $line++) {
578 next if ($rawlines[$line] =~ /^-/);
579 $remain--;
581 $blk .= $rawlines[$line];
582 foreach my $c (split(//, $rawlines[$line])) {
583 ##print "C<$c>L<$level><$open$close>O<$off>\n";
584 if ($off > 0) {
585 $off--;
586 next;
589 if ($c eq $close && $level > 0) {
590 $level--;
591 last if ($level == 0);
592 } elsif ($c eq $open) {
593 $level++;
597 if (!$outer || $level <= 1) {
598 push(@res, $rawlines[$line]);
601 last if ($level == 0);
604 return ($level, @res);
606 sub ctx_block_outer {
607 my ($linenr, $remain) = @_;
609 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
610 return @r;
612 sub ctx_block {
613 my ($linenr, $remain) = @_;
615 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
616 return @r;
618 sub ctx_statement {
619 my ($linenr, $remain, $off) = @_;
621 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
622 return @r;
624 sub ctx_block_level {
625 my ($linenr, $remain) = @_;
627 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
629 sub ctx_statement_level {
630 my ($linenr, $remain, $off) = @_;
632 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
635 sub ctx_locate_comment {
636 my ($first_line, $end_line) = @_;
638 # Catch a comment on the end of the line itself.
639 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
640 return $current_comment if (defined $current_comment);
642 # Look through the context and try and figure out if there is a
643 # comment.
644 my $in_comment = 0;
645 $current_comment = '';
646 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
647 my $line = $rawlines[$linenr - 1];
648 #warn " $line\n";
649 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
650 $in_comment = 1;
652 if ($line =~ m@/\*@) {
653 $in_comment = 1;
655 if (!$in_comment && $current_comment ne '') {
656 $current_comment = '';
658 $current_comment .= $line . "\n" if ($in_comment);
659 if ($line =~ m@\*/@) {
660 $in_comment = 0;
664 chomp($current_comment);
665 return($current_comment);
667 sub ctx_has_comment {
668 my ($first_line, $end_line) = @_;
669 my $cmt = ctx_locate_comment($first_line, $end_line);
671 ##print "LINE: $rawlines[$end_line - 1 ]\n";
672 ##print "CMMT: $cmt\n";
674 return ($cmt ne '');
677 sub raw_line {
678 my ($linenr, $cnt) = @_;
680 my $offset = $linenr - 1;
681 $cnt++;
683 my $line;
684 while ($cnt) {
685 $line = $rawlines[$offset++];
686 next if (defined($line) && $line =~ /^-/);
687 $cnt--;
690 return $line;
693 sub cat_vet {
694 my ($vet) = @_;
695 my ($res, $coded);
697 $res = '';
698 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
699 $res .= $1;
700 if ($2 ne '') {
701 $coded = sprintf("^%c", unpack('C', $2) + 64);
702 $res .= $coded;
705 $res =~ s/$/\$/;
707 return $res;
710 my $av_preprocessor = 0;
711 my $av_pending;
712 my @av_paren_type;
713 my $av_pend_colon;
715 sub annotate_reset {
716 $av_preprocessor = 0;
717 $av_pending = '_';
718 @av_paren_type = ('E');
719 $av_pend_colon = 'O';
722 sub annotate_values {
723 my ($stream, $type) = @_;
725 my $res;
726 my $var = '_' x length($stream);
727 my $cur = $stream;
729 print "$stream\n" if ($dbg_values > 1);
731 while (length($cur)) {
732 @av_paren_type = ('E') if ($#av_paren_type < 0);
733 print " <" . join('', @av_paren_type) .
734 "> <$type> <$av_pending>" if ($dbg_values > 1);
735 if ($cur =~ /^(\s+)/o) {
736 print "WS($1)\n" if ($dbg_values > 1);
737 if ($1 =~ /\n/ && $av_preprocessor) {
738 $type = pop(@av_paren_type);
739 $av_preprocessor = 0;
742 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\()/) {
743 print "DECLARE($1)\n" if ($dbg_values > 1);
744 $type = 'T';
746 } elsif ($cur =~ /^($Modifier)\s*/) {
747 print "MODIFIER($1)\n" if ($dbg_values > 1);
748 $type = 'T';
750 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
751 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
752 $av_preprocessor = 1;
753 push(@av_paren_type, $type);
754 if ($2 ne '') {
755 $av_pending = 'N';
757 $type = 'E';
759 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
760 print "UNDEF($1)\n" if ($dbg_values > 1);
761 $av_preprocessor = 1;
762 push(@av_paren_type, $type);
764 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
765 print "PRE_START($1)\n" if ($dbg_values > 1);
766 $av_preprocessor = 1;
768 push(@av_paren_type, $type);
769 push(@av_paren_type, $type);
770 $type = 'E';
772 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
773 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
774 $av_preprocessor = 1;
776 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
778 $type = 'E';
780 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
781 print "PRE_END($1)\n" if ($dbg_values > 1);
783 $av_preprocessor = 1;
785 # Assume all arms of the conditional end as this
786 # one does, and continue as if the #endif was not here.
787 pop(@av_paren_type);
788 push(@av_paren_type, $type);
789 $type = 'E';
791 } elsif ($cur =~ /^(\\\n)/o) {
792 print "PRECONT($1)\n" if ($dbg_values > 1);
794 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
795 print "ATTR($1)\n" if ($dbg_values > 1);
796 $av_pending = $type;
797 $type = 'N';
799 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
800 print "SIZEOF($1)\n" if ($dbg_values > 1);
801 if (defined $2) {
802 $av_pending = 'V';
804 $type = 'N';
806 } elsif ($cur =~ /^(if|while|for)\b/o) {
807 print "COND($1)\n" if ($dbg_values > 1);
808 $av_pending = 'E';
809 $type = 'N';
811 } elsif ($cur =~/^(case)/o) {
812 print "CASE($1)\n" if ($dbg_values > 1);
813 $av_pend_colon = 'C';
814 $type = 'N';
816 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
817 print "KEYWORD($1)\n" if ($dbg_values > 1);
818 $type = 'N';
820 } elsif ($cur =~ /^(\()/o) {
821 print "PAREN('$1')\n" if ($dbg_values > 1);
822 push(@av_paren_type, $av_pending);
823 $av_pending = '_';
824 $type = 'N';
826 } elsif ($cur =~ /^(\))/o) {
827 my $new_type = pop(@av_paren_type);
828 if ($new_type ne '_') {
829 $type = $new_type;
830 print "PAREN('$1') -> $type\n"
831 if ($dbg_values > 1);
832 } else {
833 print "PAREN('$1')\n" if ($dbg_values > 1);
836 } elsif ($cur =~ /^($Ident)\s*\(/o) {
837 print "FUNC($1)\n" if ($dbg_values > 1);
838 $type = 'V';
839 $av_pending = 'V';
841 } elsif ($cur =~ /^($Ident\s*):/) {
842 if ($type eq 'E') {
843 $av_pend_colon = 'L';
844 } elsif ($type eq 'T') {
845 $av_pend_colon = 'B';
847 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
848 $type = 'V';
850 } elsif ($cur =~ /^($Ident|$Constant)/o) {
851 print "IDENT($1)\n" if ($dbg_values > 1);
852 $type = 'V';
854 } elsif ($cur =~ /^($Assignment)/o) {
855 print "ASSIGN($1)\n" if ($dbg_values > 1);
856 $type = 'N';
858 } elsif ($cur =~/^(;|{|})/) {
859 print "END($1)\n" if ($dbg_values > 1);
860 $type = 'E';
861 $av_pend_colon = 'O';
863 } elsif ($cur =~ /^(\?)/o) {
864 print "QUESTION($1)\n" if ($dbg_values > 1);
865 $type = 'N';
867 } elsif ($cur =~ /^(:)/o) {
868 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
870 substr($var, length($res), 1, $av_pend_colon);
871 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
872 $type = 'E';
873 } else {
874 $type = 'N';
876 $av_pend_colon = 'O';
878 } elsif ($cur =~ /^(;|\[)/o) {
879 print "CLOSE($1)\n" if ($dbg_values > 1);
880 $type = 'N';
882 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
883 my $variant;
885 print "OPV($1)\n" if ($dbg_values > 1);
886 if ($type eq 'V') {
887 $variant = 'B';
888 } else {
889 $variant = 'U';
892 substr($var, length($res), 1, $variant);
893 $type = 'N';
895 } elsif ($cur =~ /^($Operators)/o) {
896 print "OP($1)\n" if ($dbg_values > 1);
897 if ($1 ne '++' && $1 ne '--') {
898 $type = 'N';
901 } elsif ($cur =~ /(^.)/o) {
902 print "C($1)\n" if ($dbg_values > 1);
904 if (defined $1) {
905 $cur = substr($cur, length($1));
906 $res .= $type x length($1);
910 return ($res, $var);
913 sub possible {
914 my ($possible, $line) = @_;
916 print "CHECK<$possible> ($line)\n" if ($dbg_possible > 1);
917 if ($possible !~ /^(?:$Modifier|$Storage|$Type|DEFINE_\S+)$/ &&
918 $possible ne 'goto' && $possible ne 'return' &&
919 $possible ne 'case' && $possible ne 'else' &&
920 $possible ne 'asm' && $possible ne '__asm__' &&
921 $possible !~ /^(typedef|struct|enum)\b/) {
922 # Check for modifiers.
923 $possible =~ s/\s*$Storage\s*//g;
924 $possible =~ s/\s*$Sparse\s*//g;
925 if ($possible =~ /^\s*$/) {
927 } elsif ($possible =~ /\s/) {
928 $possible =~ s/\s*$Type\s*//g;
929 for my $modifier (split(' ', $possible)) {
930 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
931 push(@modifierList, $modifier);
934 } else {
935 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
936 push(@typeList, $possible);
938 build_types();
942 my $prefix = '';
944 sub report {
945 if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
946 return 0;
948 my $line = $prefix . $_[0];
950 $line = (split('\n', $line))[0] . "\n" if ($terse);
952 push(our @report, $line);
954 return 1;
956 sub report_dump {
957 our @report;
959 sub ERROR {
960 if (report("ERROR: $_[0]\n")) {
961 our $clean = 0;
962 our $cnt_error++;
965 sub WARN {
966 if (report("WARNING: $_[0]\n")) {
967 our $clean = 0;
968 our $cnt_warn++;
971 sub CHK {
972 if ($check && report("CHECK: $_[0]\n")) {
973 our $clean = 0;
974 our $cnt_chk++;
978 sub check_absolute_file {
979 my ($absolute, $herecurr) = @_;
980 my $file = $absolute;
982 ##print "absolute<$absolute>\n";
984 # See if any suffix of this path is a path within the tree.
985 while ($file =~ s@^[^/]*/@@) {
986 if (-f "$root/$file") {
987 ##print "file<$file>\n";
988 last;
991 if (! -f _) {
992 return 0;
995 # It is, so see if the prefix is acceptable.
996 my $prefix = $absolute;
997 substr($prefix, -length($file)) = '';
999 ##print "prefix<$prefix>\n";
1000 if ($prefix ne ".../") {
1001 WARN("use relative pathname instead of absolute in changelog text\n" . $herecurr);
1005 sub process {
1006 my $filename = shift;
1008 my $linenr=0;
1009 my $prevline="";
1010 my $prevrawline="";
1011 my $stashline="";
1012 my $stashrawline="";
1014 my $length;
1015 my $indent;
1016 my $previndent=0;
1017 my $stashindent=0;
1019 our $clean = 1;
1020 my $signoff = 0;
1021 my $is_patch = 0;
1023 our @report = ();
1024 our $cnt_lines = 0;
1025 our $cnt_error = 0;
1026 our $cnt_warn = 0;
1027 our $cnt_chk = 0;
1029 # Trace the real file/line as we go.
1030 my $realfile = '';
1031 my $realline = 0;
1032 my $realcnt = 0;
1033 my $here = '';
1034 my $in_comment = 0;
1035 my $comment_edge = 0;
1036 my $first_line = 0;
1038 my $prev_values = 'E';
1040 # suppression flags
1041 my %suppress_ifbraces;
1043 # Pre-scan the patch sanitizing the lines.
1044 # Pre-scan the patch looking for any __setup documentation.
1046 my @setup_docs = ();
1047 my $setup_docs = 0;
1049 sanitise_line_reset();
1050 my $line;
1051 foreach my $rawline (@rawlines) {
1052 $linenr++;
1053 $line = $rawline;
1055 if ($rawline=~/^\+\+\+\s+(\S+)/) {
1056 $setup_docs = 0;
1057 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1058 $setup_docs = 1;
1060 #next;
1062 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1063 $realline=$1-1;
1064 if (defined $2) {
1065 $realcnt=$3+1;
1066 } else {
1067 $realcnt=1+1;
1069 $in_comment = 0;
1071 # Guestimate if this is a continuing comment. Run
1072 # the context looking for a comment "edge". If this
1073 # edge is a close comment then we must be in a comment
1074 # at context start.
1075 my $edge;
1076 my $cnt = $realcnt;
1077 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1078 next if (defined $rawlines[$ln - 1] &&
1079 $rawlines[$ln - 1] =~ /^-/);
1080 $cnt--;
1081 #print "RAW<$rawlines[$ln - 1]>\n";
1082 ($edge) = (defined $rawlines[$ln - 1] &&
1083 $rawlines[$ln - 1] =~ m@(/\*|\*/)@);
1084 last if (defined $edge);
1086 if (defined $edge && $edge eq '*/') {
1087 $in_comment = 1;
1090 # Guestimate if this is a continuing comment. If this
1091 # is the start of a diff block and this line starts
1092 # ' *' then it is very likely a comment.
1093 if (!defined $edge &&
1094 $rawlines[$linenr] =~ m@^.\s* \*(?:\s|$)@)
1096 $in_comment = 1;
1099 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1100 sanitise_line_reset($in_comment);
1102 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1103 # Standardise the strings and chars within the input to
1104 # simplify matching -- only bother with positive lines.
1105 $line = sanitise_line($rawline);
1107 push(@lines, $line);
1109 if ($realcnt > 1) {
1110 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1111 } else {
1112 $realcnt = 0;
1115 #print "==>$rawline\n";
1116 #print "-->$line\n";
1118 if ($setup_docs && $line =~ /^\+/) {
1119 push(@setup_docs, $line);
1123 $prefix = '';
1125 $realcnt = 0;
1126 $linenr = 0;
1127 foreach my $line (@lines) {
1128 $linenr++;
1130 my $rawline = $rawlines[$linenr - 1];
1132 #extract the line range in the file after the patch is applied
1133 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1134 $is_patch = 1;
1135 $first_line = $linenr + 1;
1136 $realline=$1-1;
1137 if (defined $2) {
1138 $realcnt=$3+1;
1139 } else {
1140 $realcnt=1+1;
1142 annotate_reset();
1143 $prev_values = 'E';
1145 %suppress_ifbraces = ();
1146 next;
1148 # track the line number as we move through the hunk, note that
1149 # new versions of GNU diff omit the leading space on completely
1150 # blank context lines so we need to count that too.
1151 } elsif ($line =~ /^( |\+|$)/) {
1152 $realline++;
1153 $realcnt-- if ($realcnt != 0);
1155 # Measure the line length and indent.
1156 ($length, $indent) = line_stats($rawline);
1158 # Track the previous line.
1159 ($prevline, $stashline) = ($stashline, $line);
1160 ($previndent, $stashindent) = ($stashindent, $indent);
1161 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1163 #warn "line<$line>\n";
1165 } elsif ($realcnt == 1) {
1166 $realcnt--;
1169 #make up the handle for any error we report on this line
1170 $prefix = "$filename:$realline: " if ($emacs && $file);
1171 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1173 $here = "#$linenr: " if (!$file);
1174 $here = "#$realline: " if ($file);
1176 # extract the filename as it passes
1177 if ($line=~/^\+\+\+\s+(\S+)/) {
1178 $realfile = $1;
1179 $realfile =~ s@^[^/]*/@@;
1181 if ($realfile =~ m@^include/asm/@) {
1182 ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1184 next;
1187 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
1189 my $hereline = "$here\n$rawline\n";
1190 my $herecurr = "$here\n$rawline\n";
1191 my $hereprev = "$here\n$prevrawline\n$rawline\n";
1193 $cnt_lines++ if ($realcnt != 0);
1195 #check the patch for a signoff:
1196 if ($line =~ /^\s*signed-off-by:/i) {
1197 # This is a signoff, if ugly, so do not double report.
1198 $signoff++;
1199 if (!($line =~ /^\s*Signed-off-by:/)) {
1200 WARN("Signed-off-by: is the preferred form\n" .
1201 $herecurr);
1203 if ($line =~ /^\s*signed-off-by:\S/i) {
1204 WARN("space required after Signed-off-by:\n" .
1205 $herecurr);
1209 # Check for wrappage within a valid hunk of the file
1210 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1211 ERROR("patch seems to be corrupt (line wrapped?)\n" .
1212 $herecurr) if (!$emitted_corrupt++);
1215 # Check for absolute kernel paths.
1216 if ($tree) {
1217 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1218 my $file = $1;
1220 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1221 check_absolute_file($1, $herecurr)) {
1223 } else {
1224 check_absolute_file($file, $herecurr);
1229 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1230 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1231 $rawline !~ m/^$UTF8*$/) {
1232 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1234 my $blank = copy_spacing($rawline);
1235 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1236 my $hereptr = "$hereline$ptr\n";
1238 ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1241 #ignore lines being removed
1242 if ($line=~/^-/) {next;}
1244 # check we are in a valid source file if not then ignore this hunk
1245 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1247 #trailing whitespace
1248 if ($line =~ /^\+.*\015/) {
1249 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1250 ERROR("DOS line endings\n" . $herevet);
1252 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1253 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1254 ERROR("trailing whitespace\n" . $herevet);
1256 #80 column limit
1257 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
1258 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1259 $line !~ /^\+\s*printk\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ &&
1260 $length > 80)
1262 WARN("line over 80 characters\n" . $herecurr);
1265 # check for adding lines without a newline.
1266 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1267 WARN("adding a line without newline at end of file\n" . $herecurr);
1270 # check we are in a valid source file C or perl if not then ignore this hunk
1271 next if ($realfile !~ /\.(h|c|pl)$/);
1273 # at the beginning of a line any tabs must come first and anything
1274 # more than 8 must use tabs.
1275 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1276 $rawline =~ /^\+\s* \s*/) {
1277 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1278 ERROR("code indent should use tabs where possible\n" . $herevet);
1281 # check we are in a valid C source file if not then ignore this hunk
1282 next if ($realfile !~ /\.(h|c)$/);
1284 # check for RCS/CVS revision markers
1285 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
1286 WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1289 # Check for potential 'bare' types
1290 my ($stat, $cond, $line_nr_next, $remain_next);
1291 if ($realcnt && $line =~ /.\s*\S/) {
1292 ($stat, $cond, $line_nr_next, $remain_next) =
1293 ctx_statement_block($linenr, $realcnt, 0);
1294 $stat =~ s/\n./\n /g;
1295 $cond =~ s/\n./\n /g;
1297 my $s = $stat;
1298 $s =~ s/{.*$//s;
1300 # Ignore goto labels.
1301 if ($s =~ /$Ident:\*$/s) {
1303 # Ignore functions being called
1304 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
1306 # declarations always start with types
1307 } 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) {
1308 my $type = $1;
1309 $type =~ s/\s+/ /g;
1310 possible($type, "A:" . $s);
1312 # definitions in global scope can only start with types
1313 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b/s) {
1314 possible($1, "B:" . $s);
1317 # any (foo ... *) is a pointer cast, and foo is a type
1318 while ($s =~ /\(($Ident)(?:\s+$Sparse)*\s*\*+\s*\)/sg) {
1319 possible($1, "C:" . $s);
1322 # Check for any sort of function declaration.
1323 # int foo(something bar, other baz);
1324 # void (*store_gdt)(x86_descr_ptr *);
1325 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
1326 my ($name_len) = length($1);
1328 my $ctx = $s;
1329 substr($ctx, 0, $name_len + 1, '');
1330 $ctx =~ s/\)[^\)]*$//;
1332 for my $arg (split(/\s*,\s*/, $ctx)) {
1333 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
1335 possible($1, "D:" . $s);
1343 # Checks which may be anchored in the context.
1346 # Check for switch () and associated case and default
1347 # statements should be at the same indent.
1348 if ($line=~/\bswitch\s*\(.*\)/) {
1349 my $err = '';
1350 my $sep = '';
1351 my @ctx = ctx_block_outer($linenr, $realcnt);
1352 shift(@ctx);
1353 for my $ctx (@ctx) {
1354 my ($clen, $cindent) = line_stats($ctx);
1355 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1356 $indent != $cindent) {
1357 $err .= "$sep$ctx\n";
1358 $sep = '';
1359 } else {
1360 $sep = "[...]\n";
1363 if ($err ne '') {
1364 ERROR("switch and case should be at the same indent\n$hereline$err");
1368 # if/while/etc brace do not go on next line, unless defining a do while loop,
1369 # or if that brace on the next line is for something else
1370 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
1371 my $pre_ctx = "$1$2";
1373 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
1374 my $ctx_cnt = $realcnt - $#ctx - 1;
1375 my $ctx = join("\n", @ctx);
1377 my $ctx_ln = $linenr;
1378 my $ctx_skip = $realcnt;
1380 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1381 defined $lines[$ctx_ln - 1] &&
1382 $lines[$ctx_ln - 1] =~ /^-/)) {
1383 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1384 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
1385 $ctx_ln++;
1388 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1389 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
1391 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1392 ERROR("that open brace { should be on the previous line\n" .
1393 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1395 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1396 $ctx =~ /\)\s*\;\s*$/ &&
1397 defined $lines[$ctx_ln - 1])
1399 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1400 if ($nindent > $indent) {
1401 WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
1402 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1407 # Check relative indent for conditionals and blocks.
1408 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1409 my ($s, $c) = ($stat, $cond);
1411 substr($s, 0, length($c), '');
1413 # Make sure we remove the line prefixes as we have
1414 # none on the first line, and are going to readd them
1415 # where necessary.
1416 $s =~ s/\n./\n/gs;
1418 # Find out how long the conditional actually is.
1419 my $cond_lines = 0 + $c =~ /\n/gs;
1421 # We want to check the first line inside the block
1422 # starting at the end of the conditional, so remove:
1423 # 1) any blank line termination
1424 # 2) any opening brace { on end of the line
1425 # 3) any do (...) {
1426 my $continuation = 0;
1427 my $check = 0;
1428 $s =~ s/^.*\bdo\b//;
1429 $s =~ s/^\s*{//;
1430 if ($s =~ s/^\s*\\//) {
1431 $continuation = 1;
1433 if ($s =~ s/^\s*?\n//) {
1434 $check = 1;
1435 $cond_lines++;
1438 # Also ignore a loop construct at the end of a
1439 # preprocessor statement.
1440 if (($prevline =~ /^.\s*#\s*define\s/ ||
1441 $prevline =~ /\\\s*$/) && $continuation == 0) {
1442 $check = 0;
1445 my $cond_ptr = -1;
1446 while ($cond_ptr != $cond_lines) {
1447 $cond_ptr = $cond_lines;
1449 # Ignore:
1450 # 1) blank lines, they should be at 0,
1451 # 2) preprocessor lines, and
1452 # 3) labels.
1453 if ($s =~ /^\s*?\n/ ||
1454 $s =~ /^\s*#\s*?/ ||
1455 $s =~ /^\s*$Ident\s*:/) {
1456 $s =~ s/^.*?\n//;
1457 $cond_lines++;
1461 my (undef, $sindent) = line_stats("+" . $s);
1462 my $stat_real = raw_line($linenr, $cond_lines);
1464 # Check if either of these lines are modified, else
1465 # this is not this patch's fault.
1466 if (!defined($stat_real) ||
1467 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
1468 $check = 0;
1470 if (defined($stat_real) && $cond_lines > 1) {
1471 $stat_real = "[...]\n$stat_real";
1474 #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";
1476 if ($check && (($sindent % 8) != 0 ||
1477 ($sindent <= $indent && $s ne ''))) {
1478 WARN("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
1482 # Track the 'values' across context and added lines.
1483 my $opline = $line; $opline =~ s/^./ /;
1484 my ($curr_values, $curr_vars) =
1485 annotate_values($opline . "\n", $prev_values);
1486 $curr_values = $prev_values . $curr_values;
1487 if ($dbg_values) {
1488 my $outline = $opline; $outline =~ s/\t/ /g;
1489 print "$linenr > .$outline\n";
1490 print "$linenr > $curr_values\n";
1491 print "$linenr > $curr_vars\n";
1493 $prev_values = substr($curr_values, -1);
1495 #ignore lines not being added
1496 if ($line=~/^[^\+]/) {next;}
1498 # TEST: allow direct testing of the type matcher.
1499 if ($dbg_type) {
1500 if ($line =~ /^.\s*$Declare\s*$/) {
1501 ERROR("TEST: is type\n" . $herecurr);
1502 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
1503 ERROR("TEST: is not type ($1 is)\n". $herecurr);
1505 next;
1507 # TEST: allow direct testing of the attribute matcher.
1508 if ($dbg_attr) {
1509 if ($line =~ /^.\s*$Attribute\s*$/) {
1510 ERROR("TEST: is attr\n" . $herecurr);
1511 } elsif ($dbg_attr > 1 && $line =~ /^.+($Attribute)/) {
1512 ERROR("TEST: is not attr ($1 is)\n". $herecurr);
1514 next;
1517 # check for initialisation to aggregates open brace on the next line
1518 if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ &&
1519 $line =~ /^.\s*{/) {
1520 ERROR("that open brace { should be on the previous line\n" . $hereprev);
1524 # Checks which are anchored on the added line.
1527 # check for malformed paths in #include statements (uses RAW line)
1528 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
1529 my $path = $1;
1530 if ($path =~ m{//}) {
1531 ERROR("malformed #include filename\n" .
1532 $herecurr);
1536 # no C99 // comments
1537 if ($line =~ m{//}) {
1538 ERROR("do not use C99 // comments\n" . $herecurr);
1540 # Remove C99 comments.
1541 $line =~ s@//.*@@;
1542 $opline =~ s@//.*@@;
1544 #EXPORT_SYMBOL should immediately follow its function closing }.
1545 if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) ||
1546 ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1547 my $name = $1;
1548 if (($prevline !~ /^}/) &&
1549 ($prevline !~ /^\+}/) &&
1550 ($prevline !~ /^ }/) &&
1551 ($prevline !~ /^.DECLARE_$Ident\(\Q$name\E\)/) &&
1552 ($prevline !~ /^.LIST_HEAD\(\Q$name\E\)/) &&
1553 ($prevline !~ /^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(/) &&
1554 ($prevline !~ /\b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[)/)) {
1555 WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
1559 # check for external initialisers.
1560 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
1561 ERROR("do not initialise externals to 0 or NULL\n" .
1562 $herecurr);
1564 # check for static initialisers.
1565 if ($line =~ /\s*static\s.*=\s*(0|NULL|false)\s*;/) {
1566 ERROR("do not initialise statics to 0 or NULL\n" .
1567 $herecurr);
1570 # check for new typedefs, only function parameters and sparse annotations
1571 # make sense.
1572 if ($line =~ /\btypedef\s/ &&
1573 $line !~ /\btypedef\s+$Type\s+\(\s*\*?$Ident\s*\)\s*\(/ &&
1574 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
1575 $line !~ /\b__bitwise(?:__|)\b/) {
1576 WARN("do not add new typedefs\n" . $herecurr);
1579 # * goes on variable not on type
1580 if ($line =~ m{\($NonptrType(\*+)(?:\s+const)?\)}) {
1581 ERROR("\"(foo$1)\" should be \"(foo $1)\"\n" .
1582 $herecurr);
1584 } elsif ($line =~ m{\($NonptrType\s+(\*+)(?!\s+const)\s+\)}) {
1585 ERROR("\"(foo $1 )\" should be \"(foo $1)\"\n" .
1586 $herecurr);
1588 } elsif ($line =~ m{\b$NonptrType(\*+)(?:\s+(?:$Attribute|$Sparse))?\s+[A-Za-z\d_]+}) {
1589 ERROR("\"foo$1 bar\" should be \"foo $1bar\"\n" .
1590 $herecurr);
1592 } elsif ($line =~ m{\b$NonptrType\s+(\*+)(?!\s+(?:$Attribute|$Sparse))\s+[A-Za-z\d_]+}) {
1593 ERROR("\"foo $1 bar\" should be \"foo $1bar\"\n" .
1594 $herecurr);
1597 # # no BUG() or BUG_ON()
1598 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
1599 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
1600 # print "$herecurr";
1601 # $clean = 0;
1604 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
1605 WARN("LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
1608 # printk should use KERN_* levels. Note that follow on printk's on the
1609 # same line do not need a level, so we use the current block context
1610 # to try and find and validate the current printk. In summary the current
1611 # printk includes all preceeding printk's which have no newline on the end.
1612 # we assume the first bad printk is the one to report.
1613 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
1614 my $ok = 0;
1615 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
1616 #print "CHECK<$lines[$ln - 1]\n";
1617 # we have a preceeding printk if it ends
1618 # with "\n" ignore it, else it is to blame
1619 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
1620 if ($rawlines[$ln - 1] !~ m{\\n"}) {
1621 $ok = 1;
1623 last;
1626 if ($ok == 0) {
1627 WARN("printk() should include KERN_ facility level\n" . $herecurr);
1631 # function brace can't be on same line, except for #defines of do while,
1632 # or if closed on same line
1633 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
1634 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
1635 ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
1638 # open braces for enum, union and struct go on the same line.
1639 if ($line =~ /^.\s*{/ &&
1640 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1641 ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
1644 # check for spacing round square brackets; allowed:
1645 # 1. with a type on the left -- int [] a;
1646 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
1647 # 3. inside a curly brace -- = { [0...10] = 5 }
1648 while ($line =~ /(.*?\s)\[/g) {
1649 my ($where, $prefix) = ($-[1], $1);
1650 if ($prefix !~ /$Type\s+$/ &&
1651 ($where != 0 || $prefix !~ /^.\s+$/) &&
1652 $prefix !~ /{\s+$/) {
1653 ERROR("space prohibited before open square bracket '['\n" . $herecurr);
1657 # check for spaces between functions and their parentheses.
1658 while ($line =~ /($Ident)\s+\(/g) {
1659 my $name = $1;
1660 my $ctx_before = substr($line, 0, $-[1]);
1661 my $ctx = "$ctx_before$name";
1663 # Ignore those directives where spaces _are_ permitted.
1664 if ($name =~ /^(?:
1665 if|for|while|switch|return|case|
1666 volatile|__volatile__|
1667 __attribute__|format|__extension__|
1668 asm|__asm__)$/x)
1671 # cpp #define statements have non-optional spaces, ie
1672 # if there is a space between the name and the open
1673 # parenthesis it is simply not a parameter group.
1674 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
1676 # cpp #elif statement condition may start with a (
1677 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
1679 # If this whole things ends with a type its most
1680 # likely a typedef for a function.
1681 } elsif ($ctx =~ /$Type$/) {
1683 } else {
1684 WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
1687 # Check operator spacing.
1688 if (!($line=~/\#\s*include/)) {
1689 my $ops = qr{
1690 <<=|>>=|<=|>=|==|!=|
1691 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
1692 =>|->|<<|>>|<|>|=|!|~|
1693 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
1694 \?|:
1696 my @elements = split(/($ops|;)/, $opline);
1697 my $off = 0;
1699 my $blank = copy_spacing($opline);
1701 for (my $n = 0; $n < $#elements; $n += 2) {
1702 $off += length($elements[$n]);
1704 # Pick up the preceeding and succeeding characters.
1705 my $ca = substr($opline, 0, $off);
1706 my $cc = '';
1707 if (length($opline) >= ($off + length($elements[$n + 1]))) {
1708 $cc = substr($opline, $off + length($elements[$n + 1]));
1710 my $cb = "$ca$;$cc";
1712 my $a = '';
1713 $a = 'V' if ($elements[$n] ne '');
1714 $a = 'W' if ($elements[$n] =~ /\s$/);
1715 $a = 'C' if ($elements[$n] =~ /$;$/);
1716 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
1717 $a = 'O' if ($elements[$n] eq '');
1718 $a = 'E' if ($ca =~ /^\s*$/);
1720 my $op = $elements[$n + 1];
1722 my $c = '';
1723 if (defined $elements[$n + 2]) {
1724 $c = 'V' if ($elements[$n + 2] ne '');
1725 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
1726 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
1727 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
1728 $c = 'O' if ($elements[$n + 2] eq '');
1729 $c = 'E' if ($elements[$n + 2] =~ /\s*\\$/);
1730 } else {
1731 $c = 'E';
1734 my $ctx = "${a}x${c}";
1736 my $at = "(ctx:$ctx)";
1738 my $ptr = substr($blank, 0, $off) . "^";
1739 my $hereptr = "$hereline$ptr\n";
1741 # Pull out the value of this operator.
1742 my $op_type = substr($curr_values, $off + 1, 1);
1744 # Get the full operator variant.
1745 my $opv = $op . substr($curr_vars, $off, 1);
1747 # Ignore operators passed as parameters.
1748 if ($op_type ne 'V' &&
1749 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
1751 # # Ignore comments
1752 # } elsif ($op =~ /^$;+$/) {
1754 # ; should have either the end of line or a space or \ after it
1755 } elsif ($op eq ';') {
1756 if ($ctx !~ /.x[WEBC]/ &&
1757 $cc !~ /^\\/ && $cc !~ /^;/) {
1758 ERROR("space required after that '$op' $at\n" . $hereptr);
1761 # // is a comment
1762 } elsif ($op eq '//') {
1764 # No spaces for:
1765 # ->
1766 # : when part of a bitfield
1767 } elsif ($op eq '->' || $opv eq ':B') {
1768 if ($ctx =~ /Wx.|.xW/) {
1769 ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
1772 # , must have a space on the right.
1773 } elsif ($op eq ',') {
1774 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
1775 ERROR("space required after that '$op' $at\n" . $hereptr);
1778 # '*' as part of a type definition -- reported already.
1779 } elsif ($opv eq '*_') {
1780 #warn "'*' is part of type\n";
1782 # unary operators should have a space before and
1783 # none after. May be left adjacent to another
1784 # unary operator, or a cast
1785 } elsif ($op eq '!' || $op eq '~' ||
1786 $opv eq '*U' || $opv eq '-U' ||
1787 $opv eq '&U' || $opv eq '&&U') {
1788 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
1789 ERROR("space required before that '$op' $at\n" . $hereptr);
1791 if ($op eq '*' && $cc =~/\s*const\b/) {
1792 # A unary '*' may be const
1794 } elsif ($ctx =~ /.xW/) {
1795 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1798 # unary ++ and unary -- are allowed no space on one side.
1799 } elsif ($op eq '++' or $op eq '--') {
1800 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
1801 ERROR("space required one side of that '$op' $at\n" . $hereptr);
1803 if ($ctx =~ /Wx[BE]/ ||
1804 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
1805 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
1807 if ($ctx =~ /ExW/) {
1808 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1812 # << and >> may either have or not have spaces both sides
1813 } elsif ($op eq '<<' or $op eq '>>' or
1814 $op eq '&' or $op eq '^' or $op eq '|' or
1815 $op eq '+' or $op eq '-' or
1816 $op eq '*' or $op eq '/' or
1817 $op eq '%')
1819 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
1820 ERROR("need consistent spacing around '$op' $at\n" .
1821 $hereptr);
1824 # A colon needs no spaces before when it is
1825 # terminating a case value or a label.
1826 } elsif ($opv eq ':C' || $opv eq ':L') {
1827 if ($ctx =~ /Wx./) {
1828 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
1831 # All the others need spaces both sides.
1832 } elsif ($ctx !~ /[EWC]x[CWE]/) {
1833 my $ok = 0;
1835 # Ignore email addresses <foo@bar>
1836 if (($op eq '<' &&
1837 $cc =~ /^\S+\@\S+>/) ||
1838 ($op eq '>' &&
1839 $ca =~ /<\S+\@\S+$/))
1841 $ok = 1;
1844 # Ignore ?:
1845 if (($opv eq ':O' && $ca =~ /\?$/) ||
1846 ($op eq '?' && $cc =~ /^:/)) {
1847 $ok = 1;
1850 if ($ok == 0) {
1851 ERROR("spaces required around that '$op' $at\n" . $hereptr);
1854 $off += length($elements[$n + 1]);
1858 # check for multiple assignments
1859 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
1860 CHK("multiple assignments should be avoided\n" . $herecurr);
1863 ## # check for multiple declarations, allowing for a function declaration
1864 ## # continuation.
1865 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
1866 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
1868 ## # Remove any bracketed sections to ensure we do not
1869 ## # falsly report the parameters of functions.
1870 ## my $ln = $line;
1871 ## while ($ln =~ s/\([^\(\)]*\)//g) {
1872 ## }
1873 ## if ($ln =~ /,/) {
1874 ## WARN("declaring multiple variables together should be avoided\n" . $herecurr);
1875 ## }
1876 ## }
1878 #need space before brace following if, while, etc
1879 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
1880 $line =~ /do{/) {
1881 ERROR("space required before the open brace '{'\n" . $herecurr);
1884 # closing brace should have a space following it when it has anything
1885 # on the line
1886 if ($line =~ /}(?!(?:,|;|\)))\S/) {
1887 ERROR("space required after that close brace '}'\n" . $herecurr);
1890 # check spacing on square brackets
1891 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
1892 ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
1894 if ($line =~ /\s\]/) {
1895 ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
1898 # check spacing on parentheses
1899 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
1900 $line !~ /for\s*\(\s+;/) {
1901 ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
1903 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
1904 $line !~ /for\s*\(.*;\s+\)/ &&
1905 $line !~ /:\s+\)/) {
1906 ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
1909 #goto labels aren't indented, allow a single space however
1910 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
1911 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
1912 WARN("labels should not be indented\n" . $herecurr);
1915 # Return is not a function.
1916 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
1917 my $spacing = $1;
1918 my $value = $2;
1920 # Flatten any parentheses and braces
1921 $value =~ s/\)\(/\) \(/g;
1922 while ($value =~ s/\([^\(\)]*\)/1/) {
1925 if ($value =~ /^(?:$Ident|-?$Constant)$/) {
1926 ERROR("return is not a function, parentheses are not required\n" . $herecurr);
1928 } elsif ($spacing !~ /\s+/) {
1929 ERROR("space required before the open parenthesis '('\n" . $herecurr);
1933 # Need a space before open parenthesis after if, while etc
1934 if ($line=~/\b(if|while|for|switch)\(/) {
1935 ERROR("space required before the open parenthesis '('\n" . $herecurr);
1938 # Check for illegal assignment in if conditional -- and check for trailing
1939 # statements after the conditional.
1940 if ($line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
1941 my ($s, $c) = ($stat, $cond);
1943 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/) {
1944 ERROR("do not use assignment in if condition\n" . $herecurr);
1947 # Find out what is on the end of the line after the
1948 # conditional.
1949 substr($s, 0, length($c), '');
1950 $s =~ s/\n.*//g;
1951 $s =~ s/$;//g; # Remove any comments
1952 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
1953 $c !~ /}\s*while\s*/)
1955 ERROR("trailing statements should be on next line\n" . $herecurr);
1959 # Check for bitwise tests written as boolean
1960 if ($line =~ /
1962 (?:\[|\(|\&\&|\|\|)
1963 \s*0[xX][0-9]+\s*
1964 (?:\&\&|\|\|)
1966 (?:\&\&|\|\|)
1967 \s*0[xX][0-9]+\s*
1968 (?:\&\&|\|\||\)|\])
1969 )/x)
1971 WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
1974 # if and else should not have general statements after it
1975 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
1976 my $s = $1;
1977 $s =~ s/$;//g; # Remove any comments
1978 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
1979 ERROR("trailing statements should be on next line\n" . $herecurr);
1982 # case and default should not have general statements after them
1983 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
1984 $line !~ /\G(?:
1985 (?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
1986 \s*return\s+
1987 )/xg)
1989 ERROR("trailing statements should be on next line\n" . $herecurr);
1992 # Check for }<nl>else {, these must be at the same
1993 # indent level to be relevant to each other.
1994 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
1995 $previndent == $indent) {
1996 ERROR("else should follow close brace '}'\n" . $hereprev);
1999 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2000 $previndent == $indent) {
2001 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2003 # Find out what is on the end of the line after the
2004 # conditional.
2005 substr($s, 0, length($c), '');
2006 $s =~ s/\n.*//g;
2008 if ($s =~ /^\s*;/) {
2009 ERROR("while should follow close brace '}'\n" . $hereprev);
2013 #studly caps, commented out until figure out how to distinguish between use of existing and adding new
2014 # if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2015 # print "No studly caps, use _\n";
2016 # print "$herecurr";
2017 # $clean = 0;
2020 #no spaces allowed after \ in define
2021 if ($line=~/\#\s*define.*\\\s$/) {
2022 WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
2025 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
2026 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
2027 my $file = "$1.h";
2028 my $checkfile = "include/linux/$file";
2029 if (-f "$root/$checkfile" &&
2030 $realfile ne $checkfile &&
2031 $1 ne 'irq')
2033 if ($realfile =~ m{^arch/}) {
2034 CHK("Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2035 } else {
2036 WARN("Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2041 # multi-statement macros should be enclosed in a do while loop, grab the
2042 # first statement and ensure its the whole macro if its not enclosed
2043 # in a known good container
2044 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2045 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
2046 my $ln = $linenr;
2047 my $cnt = $realcnt;
2048 my ($off, $dstat, $dcond, $rest);
2049 my $ctx = '';
2051 my $args = defined($1);
2053 # Find the end of the macro and limit our statement
2054 # search to that.
2055 while ($cnt > 0 && defined $lines[$ln - 1] &&
2056 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
2058 $ctx .= $rawlines[$ln - 1] . "\n";
2059 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2060 $ln++;
2062 $ctx .= $rawlines[$ln - 1];
2064 ($dstat, $dcond, $ln, $cnt, $off) =
2065 ctx_statement_block($linenr, $ln - $linenr + 1, 0);
2066 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
2067 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
2069 # Extract the remainder of the define (if any) and
2070 # rip off surrounding spaces, and trailing \'s.
2071 $rest = '';
2072 while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
2073 #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
2074 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
2075 $rest .= substr($lines[$ln - 1], $off) . "\n";
2076 $cnt--;
2078 $ln++;
2079 $off = 0;
2081 $rest =~ s/\\\n.//g;
2082 $rest =~ s/^\s*//s;
2083 $rest =~ s/\s*$//s;
2085 # Clean up the original statement.
2086 if ($args) {
2087 substr($dstat, 0, length($dcond), '');
2088 } else {
2089 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
2091 $dstat =~ s/$;//g;
2092 $dstat =~ s/\\\n.//g;
2093 $dstat =~ s/^\s*//s;
2094 $dstat =~ s/\s*$//s;
2096 # Flatten any parentheses and braces
2097 while ($dstat =~ s/\([^\(\)]*\)/1/) {
2099 while ($dstat =~ s/\{[^\{\}]*\}/1/) {
2102 my $exceptions = qr{
2103 $Declare|
2104 module_param_named|
2105 MODULE_PARAM_DESC|
2106 DECLARE_PER_CPU|
2107 DEFINE_PER_CPU|
2108 __typeof__\(
2110 #print "REST<$rest>\n";
2111 if ($rest ne '') {
2112 if ($rest !~ /while\s*\(/ &&
2113 $dstat !~ /$exceptions/)
2115 ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
2118 } elsif ($ctx !~ /;/) {
2119 if ($dstat ne '' &&
2120 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2121 $dstat !~ /$exceptions/ &&
2122 $dstat =~ /$Operators/)
2124 ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
2129 # check for redundant bracing round if etc
2130 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2131 my ($level, $endln, @chunks) =
2132 ctx_statement_full($linenr, $realcnt, 1);
2133 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
2134 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2135 if ($#chunks > 0 && $level == 0) {
2136 my $allowed = 0;
2137 my $seen = 0;
2138 my $herectx = $here . "\n";
2139 my $ln = $linenr - 1;
2140 for my $chunk (@chunks) {
2141 my ($cond, $block) = @{$chunk};
2143 # If the condition carries leading newlines, then count those as offsets.
2144 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2145 my $offset = statement_rawlines($whitespace) - 1;
2147 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2149 # We have looked at and allowed this specific line.
2150 $suppress_ifbraces{$ln + $offset} = 1;
2152 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
2153 $ln += statement_rawlines($block) - 1;
2155 substr($block, 0, length($cond), '');
2157 $seen++ if ($block =~ /^\s*{/);
2159 #print "cond<$cond> block<$block> allowed<$allowed>\n";
2160 if (statement_lines($cond) > 1) {
2161 #print "APW: ALLOWED: cond<$cond>\n";
2162 $allowed = 1;
2164 if ($block =~/\b(?:if|for|while)\b/) {
2165 #print "APW: ALLOWED: block<$block>\n";
2166 $allowed = 1;
2168 if (statement_block_size($block) > 1) {
2169 #print "APW: ALLOWED: lines block<$block>\n";
2170 $allowed = 1;
2173 if ($seen && !$allowed) {
2174 WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
2178 if (!defined $suppress_ifbraces{$linenr - 1} &&
2179 $line =~ /\b(if|while|for|else)\b/) {
2180 my $allowed = 0;
2182 # Check the pre-context.
2183 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2184 #print "APW: ALLOWED: pre<$1>\n";
2185 $allowed = 1;
2188 my ($level, $endln, @chunks) =
2189 ctx_statement_full($linenr, $realcnt, $-[0]);
2191 # Check the condition.
2192 my ($cond, $block) = @{$chunks[0]};
2193 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
2194 if (defined $cond) {
2195 substr($block, 0, length($cond), '');
2197 if (statement_lines($cond) > 1) {
2198 #print "APW: ALLOWED: cond<$cond>\n";
2199 $allowed = 1;
2201 if ($block =~/\b(?:if|for|while)\b/) {
2202 #print "APW: ALLOWED: block<$block>\n";
2203 $allowed = 1;
2205 if (statement_block_size($block) > 1) {
2206 #print "APW: ALLOWED: lines block<$block>\n";
2207 $allowed = 1;
2209 # Check the post-context.
2210 if (defined $chunks[1]) {
2211 my ($cond, $block) = @{$chunks[1]};
2212 if (defined $cond) {
2213 substr($block, 0, length($cond), '');
2215 if ($block =~ /^\s*\{/) {
2216 #print "APW: ALLOWED: chunk-1 block<$block>\n";
2217 $allowed = 1;
2220 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
2221 my $herectx = $here . "\n";;
2222 my $cnt = statement_rawlines($block);
2224 for (my $n = 0; $n < $cnt; $n++) {
2225 $herectx .= raw_line($linenr, $n) . "\n";;
2228 WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
2232 # don't include deprecated include files (uses RAW line)
2233 for my $inc (@dep_includes) {
2234 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
2235 ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2239 # don't use deprecated functions
2240 for my $func (@dep_functions) {
2241 if ($line =~ /\b$func\b/) {
2242 ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2246 # no volatiles please
2247 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2248 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
2249 WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
2252 # SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
2253 if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
2254 ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
2257 # warn about #if 0
2258 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
2259 CHK("if this code is redundant consider removing it\n" .
2260 $herecurr);
2263 # check for needless kfree() checks
2264 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2265 my $expr = $1;
2266 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
2267 WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
2270 # check for needless usb_free_urb() checks
2271 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2272 my $expr = $1;
2273 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
2274 WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
2278 # warn about #ifdefs in C files
2279 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
2280 # print "#ifdef in C files should be avoided\n";
2281 # print "$herecurr";
2282 # $clean = 0;
2285 # warn about spacing in #ifdefs
2286 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
2287 ERROR("exactly one space required after that #$1\n" . $herecurr);
2290 # check for spinlock_t definitions without a comment.
2291 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
2292 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
2293 my $which = $1;
2294 if (!ctx_has_comment($first_line, $linenr)) {
2295 CHK("$1 definition without comment\n" . $herecurr);
2298 # check for memory barriers without a comment.
2299 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2300 if (!ctx_has_comment($first_line, $linenr)) {
2301 CHK("memory barrier without comment\n" . $herecurr);
2304 # check of hardware specific defines
2305 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
2306 CHK("architecture specific defines should be avoided\n" . $herecurr);
2309 # check the location of the inline attribute, that it is between
2310 # storage class and type.
2311 if ($line =~ /\b$Type\s+$Inline\b/ ||
2312 $line =~ /\b$Inline\s+$Storage\b/) {
2313 ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
2316 # Check for __inline__ and __inline, prefer inline
2317 if ($line =~ /\b(__inline__|__inline)\b/) {
2318 WARN("plain inline is preferred over $1\n" . $herecurr);
2321 # check for new externs in .c files.
2322 if ($realfile =~ /\.c$/ && defined $stat &&
2323 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
2325 my $function_name = $1;
2326 my $paren_space = $2;
2328 my $s = $stat;
2329 if (defined $cond) {
2330 substr($s, 0, length($cond), '');
2332 if ($s =~ /^\s*;/ &&
2333 $function_name ne 'uninitialized_var')
2335 WARN("externs should be avoided in .c files\n" . $herecurr);
2338 if ($paren_space =~ /\n/) {
2339 WARN("arguments for function declarations should follow identifier\n" . $herecurr);
2342 } elsif ($realfile =~ /\.c$/ && defined $stat &&
2343 $stat =~ /^.\s*extern\s+/)
2345 WARN("externs should be avoided in .c files\n" . $herecurr);
2348 # checks for new __setup's
2349 if ($rawline =~ /\b__setup\("([^"]*)"/) {
2350 my $name = $1;
2352 if (!grep(/$name/, @setup_docs)) {
2353 CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
2357 # check for pointless casting of kmalloc return
2358 if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
2359 WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
2362 # check for gcc specific __FUNCTION__
2363 if ($line =~ /__FUNCTION__/) {
2364 WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
2367 # check for semaphores used as mutexes
2368 if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
2369 WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
2371 # check for semaphores used as mutexes
2372 if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
2373 WARN("consider using a completion\n" . $herecurr);
2375 # recommend strict_strto* over simple_strto*
2376 if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2377 WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
2379 # check for __initcall(), use device_initcall() explicitly please
2380 if ($line =~ /^.\s*__initcall\s*\(/) {
2381 WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
2384 # use of NR_CPUS is usually wrong
2385 # ignore definitions of NR_CPUS and usage to define arrays as likely right
2386 if ($line =~ /\bNR_CPUS\b/ &&
2387 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
2388 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
2389 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
2390 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
2391 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
2393 WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
2396 # check for %L{u,d,i} in strings
2397 my $string;
2398 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2399 $string = substr($rawline, $-[1], $+[1] - $-[1]);
2400 $string =~ s/%%/__/g;
2401 if ($string =~ /(?<!%)%L[udi]/) {
2402 WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2403 last;
2408 # If we have no input at all, then there is nothing to report on
2409 # so just keep quiet.
2410 if ($#rawlines == -1) {
2411 exit(0);
2414 # In mailback mode only produce a report in the negative, for
2415 # things that appear to be patches.
2416 if ($mailback && ($clean == 1 || !$is_patch)) {
2417 exit(0);
2420 # This is not a patch, and we are are in 'no-patch' mode so
2421 # just keep quiet.
2422 if (!$chk_patch && !$is_patch) {
2423 exit(0);
2426 if (!$is_patch) {
2427 ERROR("Does not appear to be a unified-diff format patch\n");
2429 if ($is_patch && $chk_signoff && $signoff == 0) {
2430 ERROR("Missing Signed-off-by: line(s)\n");
2433 print report_dump();
2434 if ($summary && !($clean == 1 && $quiet == 1)) {
2435 print "$filename " if ($summary_file);
2436 print "total: $cnt_error errors, $cnt_warn warnings, " .
2437 (($check)? "$cnt_chk checks, " : "") .
2438 "$cnt_lines lines checked\n";
2439 print "\n" if ($quiet == 0);
2442 if ($clean == 1 && $quiet == 0) {
2443 print "$vname has no obvious style problems and is ready for submission.\n"
2445 if ($clean == 0 && $quiet == 0) {
2446 print "$vname has style problems, please review. If any of these errors\n";
2447 print "are false positives report them to the maintainer, see\n";
2448 print "CHECKPATCH in MAINTAINERS.\n";
2451 return $clean;