checkpatch: __weak is an official attribute
[linux-2.6/mini2440.git] / scripts / checkpatch.pl
blobc79abb41793dfc5ef377d560776450769545be47
1 #!/usr/bin/perl -w
2 # (c) 2001, Dave Jones. <davej@redhat.com> (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.24';
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|
120 __weak
122 our $Modifier;
123 our $Inline = qr{inline|__always_inline|noinline};
124 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
125 our $Lval = qr{$Ident(?:$Member)*};
127 our $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
128 our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
129 our $Operators = qr{
130 <=|>=|==|!=|
131 =>|->|<<|>>|<|>|!|~|
132 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
135 our $NonptrType;
136 our $Type;
137 our $Declare;
139 our $UTF8 = qr {
140 [\x09\x0A\x0D\x20-\x7E] # ASCII
141 | [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
142 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
143 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
144 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
145 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
146 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
147 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
150 our $typeTypedefs = qr{(?x:
151 (?:__)?(?:u|s|be|le)(?:\d|\d\d)|
152 atomic_t
155 our @typeList = (
156 qr{void},
157 qr{(?:unsigned\s+)?char},
158 qr{(?:unsigned\s+)?short},
159 qr{(?:unsigned\s+)?int},
160 qr{(?:unsigned\s+)?long},
161 qr{(?:unsigned\s+)?long\s+int},
162 qr{(?:unsigned\s+)?long\s+long},
163 qr{(?:unsigned\s+)?long\s+long\s+int},
164 qr{unsigned},
165 qr{float},
166 qr{double},
167 qr{bool},
168 qr{struct\s+$Ident},
169 qr{union\s+$Ident},
170 qr{enum\s+$Ident},
171 qr{${Ident}_t},
172 qr{${Ident}_handler},
173 qr{${Ident}_handler_fn},
175 our @modifierList = (
176 qr{fastcall},
179 sub build_types {
180 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
181 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
182 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
183 $NonptrType = qr{
184 (?:$Modifier\s+|const\s+)*
186 (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
187 (?:$typeTypedefs\b)|
188 (?:${all}\b)
190 (?:\s+$Modifier|\s+const)*
192 $Type = qr{
193 $NonptrType
194 (?:\s*\*+\s*const|\s*\*+|(?:\s*\[\s*\])+)?
195 (?:\s+$Inline|\s+$Modifier)*
197 $Declare = qr{(?:$Storage\s+)?$Type};
199 build_types();
201 $chk_signoff = 0 if ($file);
203 my @dep_includes = ();
204 my @dep_functions = ();
205 my $removal = "Documentation/feature-removal-schedule.txt";
206 if ($tree && -f "$root/$removal") {
207 open(REMOVE, "<$root/$removal") ||
208 die "$P: $removal: open failed - $!\n";
209 while (<REMOVE>) {
210 if (/^Check:\s+(.*\S)/) {
211 for my $entry (split(/[, ]+/, $1)) {
212 if ($entry =~ m@include/(.*)@) {
213 push(@dep_includes, $1);
215 } elsif ($entry !~ m@/@) {
216 push(@dep_functions, $entry);
223 my @rawlines = ();
224 my @lines = ();
225 my $vname;
226 for my $filename (@ARGV) {
227 if ($file) {
228 open(FILE, "diff -u /dev/null $filename|") ||
229 die "$P: $filename: diff failed - $!\n";
230 } else {
231 open(FILE, "<$filename") ||
232 die "$P: $filename: open failed - $!\n";
234 if ($filename eq '-') {
235 $vname = 'Your patch';
236 } else {
237 $vname = $filename;
239 while (<FILE>) {
240 chomp;
241 push(@rawlines, $_);
243 close(FILE);
244 if (!process($filename)) {
245 $exit = 1;
247 @rawlines = ();
248 @lines = ();
251 exit($exit);
253 sub top_of_kernel_tree {
254 my ($root) = @_;
256 my @tree_check = (
257 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
258 "README", "Documentation", "arch", "include", "drivers",
259 "fs", "init", "ipc", "kernel", "lib", "scripts",
262 foreach my $check (@tree_check) {
263 if (! -e $root . '/' . $check) {
264 return 0;
267 return 1;
270 sub expand_tabs {
271 my ($str) = @_;
273 my $res = '';
274 my $n = 0;
275 for my $c (split(//, $str)) {
276 if ($c eq "\t") {
277 $res .= ' ';
278 $n++;
279 for (; ($n % 8) != 0; $n++) {
280 $res .= ' ';
282 next;
284 $res .= $c;
285 $n++;
288 return $res;
290 sub copy_spacing {
291 (my $res = shift) =~ tr/\t/ /c;
292 return $res;
295 sub line_stats {
296 my ($line) = @_;
298 # Drop the diff line leader and expand tabs
299 $line =~ s/^.//;
300 $line = expand_tabs($line);
302 # Pick the indent from the front of the line.
303 my ($white) = ($line =~ /^(\s*)/);
305 return (length($line), length($white));
308 my $sanitise_quote = '';
310 sub sanitise_line_reset {
311 my ($in_comment) = @_;
313 if ($in_comment) {
314 $sanitise_quote = '*/';
315 } else {
316 $sanitise_quote = '';
319 sub sanitise_line {
320 my ($line) = @_;
322 my $res = '';
323 my $l = '';
325 my $qlen = 0;
326 my $off = 0;
327 my $c;
329 # Always copy over the diff marker.
330 $res = substr($line, 0, 1);
332 for ($off = 1; $off < length($line); $off++) {
333 $c = substr($line, $off, 1);
335 # Comments we are wacking completly including the begin
336 # and end, all to $;.
337 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
338 $sanitise_quote = '*/';
340 substr($res, $off, 2, "$;$;");
341 $off++;
342 next;
344 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
345 $sanitise_quote = '';
346 substr($res, $off, 2, "$;$;");
347 $off++;
348 next;
351 # A \ in a string means ignore the next character.
352 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
353 $c eq "\\") {
354 substr($res, $off, 2, 'XX');
355 $off++;
356 next;
358 # Regular quotes.
359 if ($c eq "'" || $c eq '"') {
360 if ($sanitise_quote eq '') {
361 $sanitise_quote = $c;
363 substr($res, $off, 1, $c);
364 next;
365 } elsif ($sanitise_quote eq $c) {
366 $sanitise_quote = '';
370 #print "SQ:$sanitise_quote\n";
371 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
372 substr($res, $off, 1, $;);
373 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
374 substr($res, $off, 1, 'X');
375 } else {
376 substr($res, $off, 1, $c);
380 # The pathname on a #include may be surrounded by '<' and '>'.
381 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
382 my $clean = 'X' x length($1);
383 $res =~ s@\<.*\>@<$clean>@;
385 # The whole of a #error is a string.
386 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
387 my $clean = 'X' x length($1);
388 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
391 return $res;
394 sub ctx_statement_block {
395 my ($linenr, $remain, $off) = @_;
396 my $line = $linenr - 1;
397 my $blk = '';
398 my $soff = $off;
399 my $coff = $off - 1;
400 my $coff_set = 0;
402 my $loff = 0;
404 my $type = '';
405 my $level = 0;
406 my $p;
407 my $c;
408 my $len = 0;
410 my $remainder;
411 while (1) {
412 #warn "CSB: blk<$blk> remain<$remain>\n";
413 # If we are about to drop off the end, pull in more
414 # context.
415 if ($off >= $len) {
416 for (; $remain > 0; $line++) {
417 last if (!defined $lines[$line]);
418 next if ($lines[$line] =~ /^-/);
419 $remain--;
420 $loff = $len;
421 $blk .= $lines[$line] . "\n";
422 $len = length($blk);
423 $line++;
424 last;
426 # Bail if there is no further context.
427 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
428 if ($off >= $len) {
429 last;
432 $p = $c;
433 $c = substr($blk, $off, 1);
434 $remainder = substr($blk, $off);
436 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
437 # Statement ends at the ';' or a close '}' at the
438 # outermost level.
439 if ($level == 0 && $c eq ';') {
440 last;
443 # An else is really a conditional as long as its not else if
444 if ($level == 0 && $coff_set == 0 &&
445 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
446 $remainder =~ /^(else)(?:\s|{)/ &&
447 $remainder !~ /^else\s+if\b/) {
448 $coff = $off + length($1) - 1;
449 $coff_set = 1;
450 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
451 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
454 if (($type eq '' || $type eq '(') && $c eq '(') {
455 $level++;
456 $type = '(';
458 if ($type eq '(' && $c eq ')') {
459 $level--;
460 $type = ($level != 0)? '(' : '';
462 if ($level == 0 && $coff < $soff) {
463 $coff = $off;
464 $coff_set = 1;
465 #warn "CSB: mark coff<$coff>\n";
468 if (($type eq '' || $type eq '{') && $c eq '{') {
469 $level++;
470 $type = '{';
472 if ($type eq '{' && $c eq '}') {
473 $level--;
474 $type = ($level != 0)? '{' : '';
476 if ($level == 0) {
477 last;
480 $off++;
482 # We are truly at the end, so shuffle to the next line.
483 if ($off == $len) {
484 $loff = $len + 1;
485 $line++;
486 $remain--;
489 my $statement = substr($blk, $soff, $off - $soff + 1);
490 my $condition = substr($blk, $soff, $coff - $soff + 1);
492 #warn "STATEMENT<$statement>\n";
493 #warn "CONDITION<$condition>\n";
495 #print "coff<$coff> soff<$off> loff<$loff>\n";
497 return ($statement, $condition,
498 $line, $remain + 1, $off - $loff + 1, $level);
501 sub statement_lines {
502 my ($stmt) = @_;
504 # Strip the diff line prefixes and rip blank lines at start and end.
505 $stmt =~ s/(^|\n)./$1/g;
506 $stmt =~ s/^\s*//;
507 $stmt =~ s/\s*$//;
509 my @stmt_lines = ($stmt =~ /\n/g);
511 return $#stmt_lines + 2;
514 sub statement_rawlines {
515 my ($stmt) = @_;
517 my @stmt_lines = ($stmt =~ /\n/g);
519 return $#stmt_lines + 2;
522 sub statement_block_size {
523 my ($stmt) = @_;
525 $stmt =~ s/(^|\n)./$1/g;
526 $stmt =~ s/^\s*{//;
527 $stmt =~ s/}\s*$//;
528 $stmt =~ s/^\s*//;
529 $stmt =~ s/\s*$//;
531 my @stmt_lines = ($stmt =~ /\n/g);
532 my @stmt_statements = ($stmt =~ /;/g);
534 my $stmt_lines = $#stmt_lines + 2;
535 my $stmt_statements = $#stmt_statements + 1;
537 if ($stmt_lines > $stmt_statements) {
538 return $stmt_lines;
539 } else {
540 return $stmt_statements;
544 sub ctx_statement_full {
545 my ($linenr, $remain, $off) = @_;
546 my ($statement, $condition, $level);
548 my (@chunks);
550 # Grab the first conditional/block pair.
551 ($statement, $condition, $linenr, $remain, $off, $level) =
552 ctx_statement_block($linenr, $remain, $off);
553 #print "F: c<$condition> s<$statement> remain<$remain>\n";
554 push(@chunks, [ $condition, $statement ]);
555 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
556 return ($level, $linenr, @chunks);
559 # Pull in the following conditional/block pairs and see if they
560 # could continue the statement.
561 for (;;) {
562 ($statement, $condition, $linenr, $remain, $off, $level) =
563 ctx_statement_block($linenr, $remain, $off);
564 #print "C: c<$condition> s<$statement> remain<$remain>\n";
565 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
566 #print "C: push\n";
567 push(@chunks, [ $condition, $statement ]);
570 return ($level, $linenr, @chunks);
573 sub ctx_block_get {
574 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
575 my $line;
576 my $start = $linenr - 1;
577 my $blk = '';
578 my @o;
579 my @c;
580 my @res = ();
582 my $level = 0;
583 for ($line = $start; $remain > 0; $line++) {
584 next if ($rawlines[$line] =~ /^-/);
585 $remain--;
587 $blk .= $rawlines[$line];
588 foreach my $c (split(//, $rawlines[$line])) {
589 ##print "C<$c>L<$level><$open$close>O<$off>\n";
590 if ($off > 0) {
591 $off--;
592 next;
595 if ($c eq $close && $level > 0) {
596 $level--;
597 last if ($level == 0);
598 } elsif ($c eq $open) {
599 $level++;
603 if (!$outer || $level <= 1) {
604 push(@res, $rawlines[$line]);
607 last if ($level == 0);
610 return ($level, @res);
612 sub ctx_block_outer {
613 my ($linenr, $remain) = @_;
615 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
616 return @r;
618 sub ctx_block {
619 my ($linenr, $remain) = @_;
621 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
622 return @r;
624 sub ctx_statement {
625 my ($linenr, $remain, $off) = @_;
627 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
628 return @r;
630 sub ctx_block_level {
631 my ($linenr, $remain) = @_;
633 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
635 sub ctx_statement_level {
636 my ($linenr, $remain, $off) = @_;
638 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
641 sub ctx_locate_comment {
642 my ($first_line, $end_line) = @_;
644 # Catch a comment on the end of the line itself.
645 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
646 return $current_comment if (defined $current_comment);
648 # Look through the context and try and figure out if there is a
649 # comment.
650 my $in_comment = 0;
651 $current_comment = '';
652 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
653 my $line = $rawlines[$linenr - 1];
654 #warn " $line\n";
655 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
656 $in_comment = 1;
658 if ($line =~ m@/\*@) {
659 $in_comment = 1;
661 if (!$in_comment && $current_comment ne '') {
662 $current_comment = '';
664 $current_comment .= $line . "\n" if ($in_comment);
665 if ($line =~ m@\*/@) {
666 $in_comment = 0;
670 chomp($current_comment);
671 return($current_comment);
673 sub ctx_has_comment {
674 my ($first_line, $end_line) = @_;
675 my $cmt = ctx_locate_comment($first_line, $end_line);
677 ##print "LINE: $rawlines[$end_line - 1 ]\n";
678 ##print "CMMT: $cmt\n";
680 return ($cmt ne '');
683 sub raw_line {
684 my ($linenr, $cnt) = @_;
686 my $offset = $linenr - 1;
687 $cnt++;
689 my $line;
690 while ($cnt) {
691 $line = $rawlines[$offset++];
692 next if (defined($line) && $line =~ /^-/);
693 $cnt--;
696 return $line;
699 sub cat_vet {
700 my ($vet) = @_;
701 my ($res, $coded);
703 $res = '';
704 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
705 $res .= $1;
706 if ($2 ne '') {
707 $coded = sprintf("^%c", unpack('C', $2) + 64);
708 $res .= $coded;
711 $res =~ s/$/\$/;
713 return $res;
716 my $av_preprocessor = 0;
717 my $av_pending;
718 my @av_paren_type;
719 my $av_pend_colon;
721 sub annotate_reset {
722 $av_preprocessor = 0;
723 $av_pending = '_';
724 @av_paren_type = ('E');
725 $av_pend_colon = 'O';
728 sub annotate_values {
729 my ($stream, $type) = @_;
731 my $res;
732 my $var = '_' x length($stream);
733 my $cur = $stream;
735 print "$stream\n" if ($dbg_values > 1);
737 while (length($cur)) {
738 @av_paren_type = ('E') if ($#av_paren_type < 0);
739 print " <" . join('', @av_paren_type) .
740 "> <$type> <$av_pending>" if ($dbg_values > 1);
741 if ($cur =~ /^(\s+)/o) {
742 print "WS($1)\n" if ($dbg_values > 1);
743 if ($1 =~ /\n/ && $av_preprocessor) {
744 $type = pop(@av_paren_type);
745 $av_preprocessor = 0;
748 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\()/) {
749 print "DECLARE($1)\n" if ($dbg_values > 1);
750 $type = 'T';
752 } elsif ($cur =~ /^($Modifier)\s*/) {
753 print "MODIFIER($1)\n" if ($dbg_values > 1);
754 $type = 'T';
756 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
757 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
758 $av_preprocessor = 1;
759 push(@av_paren_type, $type);
760 if ($2 ne '') {
761 $av_pending = 'N';
763 $type = 'E';
765 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
766 print "UNDEF($1)\n" if ($dbg_values > 1);
767 $av_preprocessor = 1;
768 push(@av_paren_type, $type);
770 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
771 print "PRE_START($1)\n" if ($dbg_values > 1);
772 $av_preprocessor = 1;
774 push(@av_paren_type, $type);
775 push(@av_paren_type, $type);
776 $type = 'E';
778 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
779 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
780 $av_preprocessor = 1;
782 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
784 $type = 'E';
786 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
787 print "PRE_END($1)\n" if ($dbg_values > 1);
789 $av_preprocessor = 1;
791 # Assume all arms of the conditional end as this
792 # one does, and continue as if the #endif was not here.
793 pop(@av_paren_type);
794 push(@av_paren_type, $type);
795 $type = 'E';
797 } elsif ($cur =~ /^(\\\n)/o) {
798 print "PRECONT($1)\n" if ($dbg_values > 1);
800 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
801 print "ATTR($1)\n" if ($dbg_values > 1);
802 $av_pending = $type;
803 $type = 'N';
805 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
806 print "SIZEOF($1)\n" if ($dbg_values > 1);
807 if (defined $2) {
808 $av_pending = 'V';
810 $type = 'N';
812 } elsif ($cur =~ /^(if|while|for)\b/o) {
813 print "COND($1)\n" if ($dbg_values > 1);
814 $av_pending = 'E';
815 $type = 'N';
817 } elsif ($cur =~/^(case)/o) {
818 print "CASE($1)\n" if ($dbg_values > 1);
819 $av_pend_colon = 'C';
820 $type = 'N';
822 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
823 print "KEYWORD($1)\n" if ($dbg_values > 1);
824 $type = 'N';
826 } elsif ($cur =~ /^(\()/o) {
827 print "PAREN('$1')\n" if ($dbg_values > 1);
828 push(@av_paren_type, $av_pending);
829 $av_pending = '_';
830 $type = 'N';
832 } elsif ($cur =~ /^(\))/o) {
833 my $new_type = pop(@av_paren_type);
834 if ($new_type ne '_') {
835 $type = $new_type;
836 print "PAREN('$1') -> $type\n"
837 if ($dbg_values > 1);
838 } else {
839 print "PAREN('$1')\n" if ($dbg_values > 1);
842 } elsif ($cur =~ /^($Ident)\s*\(/o) {
843 print "FUNC($1)\n" if ($dbg_values > 1);
844 $type = 'V';
845 $av_pending = 'V';
847 } elsif ($cur =~ /^($Ident\s*):/) {
848 if ($type eq 'E') {
849 $av_pend_colon = 'L';
850 } elsif ($type eq 'T') {
851 $av_pend_colon = 'B';
853 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
854 $type = 'V';
856 } elsif ($cur =~ /^($Ident|$Constant)/o) {
857 print "IDENT($1)\n" if ($dbg_values > 1);
858 $type = 'V';
860 } elsif ($cur =~ /^($Assignment)/o) {
861 print "ASSIGN($1)\n" if ($dbg_values > 1);
862 $type = 'N';
864 } elsif ($cur =~/^(;|{|})/) {
865 print "END($1)\n" if ($dbg_values > 1);
866 $type = 'E';
867 $av_pend_colon = 'O';
869 } elsif ($cur =~ /^(\?)/o) {
870 print "QUESTION($1)\n" if ($dbg_values > 1);
871 $type = 'N';
873 } elsif ($cur =~ /^(:)/o) {
874 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
876 substr($var, length($res), 1, $av_pend_colon);
877 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
878 $type = 'E';
879 } else {
880 $type = 'N';
882 $av_pend_colon = 'O';
884 } elsif ($cur =~ /^(;|\[)/o) {
885 print "CLOSE($1)\n" if ($dbg_values > 1);
886 $type = 'N';
888 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
889 my $variant;
891 print "OPV($1)\n" if ($dbg_values > 1);
892 if ($type eq 'V') {
893 $variant = 'B';
894 } else {
895 $variant = 'U';
898 substr($var, length($res), 1, $variant);
899 $type = 'N';
901 } elsif ($cur =~ /^($Operators)/o) {
902 print "OP($1)\n" if ($dbg_values > 1);
903 if ($1 ne '++' && $1 ne '--') {
904 $type = 'N';
907 } elsif ($cur =~ /(^.)/o) {
908 print "C($1)\n" if ($dbg_values > 1);
910 if (defined $1) {
911 $cur = substr($cur, length($1));
912 $res .= $type x length($1);
916 return ($res, $var);
919 sub possible {
920 my ($possible, $line) = @_;
922 print "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
923 if ($possible !~ /(?:
924 ^(?:
925 $Modifier|
926 $Storage|
927 $Type|
928 DEFINE_\S+|
929 goto|
930 return|
931 case|
932 else|
933 asm|__asm__|
936 ^(?:typedef|struct|enum)\b
937 )/x) {
938 # Check for modifiers.
939 $possible =~ s/\s*$Storage\s*//g;
940 $possible =~ s/\s*$Sparse\s*//g;
941 if ($possible =~ /^\s*$/) {
943 } elsif ($possible =~ /\s/) {
944 $possible =~ s/\s*$Type\s*//g;
945 for my $modifier (split(' ', $possible)) {
946 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
947 push(@modifierList, $modifier);
950 } else {
951 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
952 push(@typeList, $possible);
954 build_types();
955 } else {
956 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
960 my $prefix = '';
962 sub report {
963 if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
964 return 0;
966 my $line = $prefix . $_[0];
968 $line = (split('\n', $line))[0] . "\n" if ($terse);
970 push(our @report, $line);
972 return 1;
974 sub report_dump {
975 our @report;
977 sub ERROR {
978 if (report("ERROR: $_[0]\n")) {
979 our $clean = 0;
980 our $cnt_error++;
983 sub WARN {
984 if (report("WARNING: $_[0]\n")) {
985 our $clean = 0;
986 our $cnt_warn++;
989 sub CHK {
990 if ($check && report("CHECK: $_[0]\n")) {
991 our $clean = 0;
992 our $cnt_chk++;
996 sub check_absolute_file {
997 my ($absolute, $herecurr) = @_;
998 my $file = $absolute;
1000 ##print "absolute<$absolute>\n";
1002 # See if any suffix of this path is a path within the tree.
1003 while ($file =~ s@^[^/]*/@@) {
1004 if (-f "$root/$file") {
1005 ##print "file<$file>\n";
1006 last;
1009 if (! -f _) {
1010 return 0;
1013 # It is, so see if the prefix is acceptable.
1014 my $prefix = $absolute;
1015 substr($prefix, -length($file)) = '';
1017 ##print "prefix<$prefix>\n";
1018 if ($prefix ne ".../") {
1019 WARN("use relative pathname instead of absolute in changelog text\n" . $herecurr);
1023 sub process {
1024 my $filename = shift;
1026 my $linenr=0;
1027 my $prevline="";
1028 my $prevrawline="";
1029 my $stashline="";
1030 my $stashrawline="";
1032 my $length;
1033 my $indent;
1034 my $previndent=0;
1035 my $stashindent=0;
1037 our $clean = 1;
1038 my $signoff = 0;
1039 my $is_patch = 0;
1041 our @report = ();
1042 our $cnt_lines = 0;
1043 our $cnt_error = 0;
1044 our $cnt_warn = 0;
1045 our $cnt_chk = 0;
1047 # Trace the real file/line as we go.
1048 my $realfile = '';
1049 my $realline = 0;
1050 my $realcnt = 0;
1051 my $here = '';
1052 my $in_comment = 0;
1053 my $comment_edge = 0;
1054 my $first_line = 0;
1056 my $prev_values = 'E';
1058 # suppression flags
1059 my %suppress_ifbraces;
1060 my %suppress_whiletrailers;
1062 # Pre-scan the patch sanitizing the lines.
1063 # Pre-scan the patch looking for any __setup documentation.
1065 my @setup_docs = ();
1066 my $setup_docs = 0;
1068 sanitise_line_reset();
1069 my $line;
1070 foreach my $rawline (@rawlines) {
1071 $linenr++;
1072 $line = $rawline;
1074 if ($rawline=~/^\+\+\+\s+(\S+)/) {
1075 $setup_docs = 0;
1076 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1077 $setup_docs = 1;
1079 #next;
1081 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1082 $realline=$1-1;
1083 if (defined $2) {
1084 $realcnt=$3+1;
1085 } else {
1086 $realcnt=1+1;
1088 $in_comment = 0;
1090 # Guestimate if this is a continuing comment. Run
1091 # the context looking for a comment "edge". If this
1092 # edge is a close comment then we must be in a comment
1093 # at context start.
1094 my $edge;
1095 my $cnt = $realcnt;
1096 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1097 next if (defined $rawlines[$ln - 1] &&
1098 $rawlines[$ln - 1] =~ /^-/);
1099 $cnt--;
1100 #print "RAW<$rawlines[$ln - 1]>\n";
1101 last if (!defined $rawlines[$ln - 1]);
1102 ($edge) = ($rawlines[$ln - 1] =~ m@(/\*|\*/)@);
1103 last if (defined $edge);
1105 if (defined $edge && $edge eq '*/') {
1106 $in_comment = 1;
1109 # Guestimate if this is a continuing comment. If this
1110 # is the start of a diff block and this line starts
1111 # ' *' then it is very likely a comment.
1112 if (!defined $edge &&
1113 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1115 $in_comment = 1;
1118 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1119 sanitise_line_reset($in_comment);
1121 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1122 # Standardise the strings and chars within the input to
1123 # simplify matching -- only bother with positive lines.
1124 $line = sanitise_line($rawline);
1126 push(@lines, $line);
1128 if ($realcnt > 1) {
1129 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1130 } else {
1131 $realcnt = 0;
1134 #print "==>$rawline\n";
1135 #print "-->$line\n";
1137 if ($setup_docs && $line =~ /^\+/) {
1138 push(@setup_docs, $line);
1142 $prefix = '';
1144 $realcnt = 0;
1145 $linenr = 0;
1146 foreach my $line (@lines) {
1147 $linenr++;
1149 my $rawline = $rawlines[$linenr - 1];
1150 my $hunk_line = ($realcnt != 0);
1152 #extract the line range in the file after the patch is applied
1153 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1154 $is_patch = 1;
1155 $first_line = $linenr + 1;
1156 $realline=$1-1;
1157 if (defined $2) {
1158 $realcnt=$3+1;
1159 } else {
1160 $realcnt=1+1;
1162 annotate_reset();
1163 $prev_values = 'E';
1165 %suppress_ifbraces = ();
1166 %suppress_whiletrailers = ();
1167 next;
1169 # track the line number as we move through the hunk, note that
1170 # new versions of GNU diff omit the leading space on completely
1171 # blank context lines so we need to count that too.
1172 } elsif ($line =~ /^( |\+|$)/) {
1173 $realline++;
1174 $realcnt-- if ($realcnt != 0);
1176 # Measure the line length and indent.
1177 ($length, $indent) = line_stats($rawline);
1179 # Track the previous line.
1180 ($prevline, $stashline) = ($stashline, $line);
1181 ($previndent, $stashindent) = ($stashindent, $indent);
1182 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1184 #warn "line<$line>\n";
1186 } elsif ($realcnt == 1) {
1187 $realcnt--;
1190 #make up the handle for any error we report on this line
1191 $prefix = "$filename:$realline: " if ($emacs && $file);
1192 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1194 $here = "#$linenr: " if (!$file);
1195 $here = "#$realline: " if ($file);
1197 # extract the filename as it passes
1198 if ($line=~/^\+\+\+\s+(\S+)/) {
1199 $realfile = $1;
1200 $realfile =~ s@^[^/]*/@@;
1202 if ($realfile =~ m@^include/asm/@) {
1203 ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1205 next;
1208 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
1210 my $hereline = "$here\n$rawline\n";
1211 my $herecurr = "$here\n$rawline\n";
1212 my $hereprev = "$here\n$prevrawline\n$rawline\n";
1214 $cnt_lines++ if ($realcnt != 0);
1216 #check the patch for a signoff:
1217 if ($line =~ /^\s*signed-off-by:/i) {
1218 # This is a signoff, if ugly, so do not double report.
1219 $signoff++;
1220 if (!($line =~ /^\s*Signed-off-by:/)) {
1221 WARN("Signed-off-by: is the preferred form\n" .
1222 $herecurr);
1224 if ($line =~ /^\s*signed-off-by:\S/i) {
1225 WARN("space required after Signed-off-by:\n" .
1226 $herecurr);
1230 # Check for wrappage within a valid hunk of the file
1231 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1232 ERROR("patch seems to be corrupt (line wrapped?)\n" .
1233 $herecurr) if (!$emitted_corrupt++);
1236 # Check for absolute kernel paths.
1237 if ($tree) {
1238 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1239 my $file = $1;
1241 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1242 check_absolute_file($1, $herecurr)) {
1244 } else {
1245 check_absolute_file($file, $herecurr);
1250 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1251 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1252 $rawline !~ m/^$UTF8*$/) {
1253 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1255 my $blank = copy_spacing($rawline);
1256 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1257 my $hereptr = "$hereline$ptr\n";
1259 ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1262 # ignore non-hunk lines and lines being removed
1263 next if (!$hunk_line || $line =~ /^-/);
1265 #trailing whitespace
1266 if ($line =~ /^\+.*\015/) {
1267 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1268 ERROR("DOS line endings\n" . $herevet);
1270 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1271 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1272 ERROR("trailing whitespace\n" . $herevet);
1275 # check we are in a valid source file if not then ignore this hunk
1276 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1278 #80 column limit
1279 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
1280 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1281 $line !~ /^\+\s*printk\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ &&
1282 $length > 80)
1284 WARN("line over 80 characters\n" . $herecurr);
1287 # check for adding lines without a newline.
1288 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1289 WARN("adding a line without newline at end of file\n" . $herecurr);
1292 # check we are in a valid source file C or perl if not then ignore this hunk
1293 next if ($realfile !~ /\.(h|c|pl)$/);
1295 # at the beginning of a line any tabs must come first and anything
1296 # more than 8 must use tabs.
1297 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1298 $rawline =~ /^\+\s* \s*/) {
1299 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1300 ERROR("code indent should use tabs where possible\n" . $herevet);
1303 # check we are in a valid C source file if not then ignore this hunk
1304 next if ($realfile !~ /\.(h|c)$/);
1306 # check for RCS/CVS revision markers
1307 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
1308 WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1311 # Check for potential 'bare' types
1312 my ($stat, $cond, $line_nr_next, $remain_next, $off_next);
1313 if ($realcnt && $line =~ /.\s*\S/) {
1314 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
1315 ctx_statement_block($linenr, $realcnt, 0);
1316 $stat =~ s/\n./\n /g;
1317 $cond =~ s/\n./\n /g;
1319 my $s = $stat;
1320 $s =~ s/{.*$//s;
1322 # Ignore goto labels.
1323 if ($s =~ /$Ident:\*$/s) {
1325 # Ignore functions being called
1326 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
1328 # declarations always start with types
1329 } 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) {
1330 my $type = $1;
1331 $type =~ s/\s+/ /g;
1332 possible($type, "A:" . $s);
1334 # definitions in global scope can only start with types
1335 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
1336 possible($1, "B:" . $s);
1339 # any (foo ... *) is a pointer cast, and foo is a type
1340 while ($s =~ /\(($Ident)(?:\s+$Sparse)*\s*\*+\s*\)/sg) {
1341 possible($1, "C:" . $s);
1344 # Check for any sort of function declaration.
1345 # int foo(something bar, other baz);
1346 # void (*store_gdt)(x86_descr_ptr *);
1347 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
1348 my ($name_len) = length($1);
1350 my $ctx = $s;
1351 substr($ctx, 0, $name_len + 1, '');
1352 $ctx =~ s/\)[^\)]*$//;
1354 for my $arg (split(/\s*,\s*/, $ctx)) {
1355 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
1357 possible($1, "D:" . $s);
1365 # Checks which may be anchored in the context.
1368 # Check for switch () and associated case and default
1369 # statements should be at the same indent.
1370 if ($line=~/\bswitch\s*\(.*\)/) {
1371 my $err = '';
1372 my $sep = '';
1373 my @ctx = ctx_block_outer($linenr, $realcnt);
1374 shift(@ctx);
1375 for my $ctx (@ctx) {
1376 my ($clen, $cindent) = line_stats($ctx);
1377 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1378 $indent != $cindent) {
1379 $err .= "$sep$ctx\n";
1380 $sep = '';
1381 } else {
1382 $sep = "[...]\n";
1385 if ($err ne '') {
1386 ERROR("switch and case should be at the same indent\n$hereline$err");
1390 # if/while/etc brace do not go on next line, unless defining a do while loop,
1391 # or if that brace on the next line is for something else
1392 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
1393 my $pre_ctx = "$1$2";
1395 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
1396 my $ctx_cnt = $realcnt - $#ctx - 1;
1397 my $ctx = join("\n", @ctx);
1399 my $ctx_ln = $linenr;
1400 my $ctx_skip = $realcnt;
1402 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1403 defined $lines[$ctx_ln - 1] &&
1404 $lines[$ctx_ln - 1] =~ /^-/)) {
1405 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1406 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
1407 $ctx_ln++;
1410 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1411 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
1413 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1414 ERROR("that open brace { should be on the previous line\n" .
1415 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1417 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1418 $ctx =~ /\)\s*\;\s*$/ &&
1419 defined $lines[$ctx_ln - 1])
1421 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1422 if ($nindent > $indent) {
1423 WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
1424 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1429 # Check relative indent for conditionals and blocks.
1430 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1431 my ($s, $c) = ($stat, $cond);
1433 substr($s, 0, length($c), '');
1435 # Make sure we remove the line prefixes as we have
1436 # none on the first line, and are going to readd them
1437 # where necessary.
1438 $s =~ s/\n./\n/gs;
1440 # Find out how long the conditional actually is.
1441 my @newlines = ($c =~ /\n/gs);
1442 my $cond_lines = 1 + $#newlines;
1444 # We want to check the first line inside the block
1445 # starting at the end of the conditional, so remove:
1446 # 1) any blank line termination
1447 # 2) any opening brace { on end of the line
1448 # 3) any do (...) {
1449 my $continuation = 0;
1450 my $check = 0;
1451 $s =~ s/^.*\bdo\b//;
1452 $s =~ s/^\s*{//;
1453 if ($s =~ s/^\s*\\//) {
1454 $continuation = 1;
1456 if ($s =~ s/^\s*?\n//) {
1457 $check = 1;
1458 $cond_lines++;
1461 # Also ignore a loop construct at the end of a
1462 # preprocessor statement.
1463 if (($prevline =~ /^.\s*#\s*define\s/ ||
1464 $prevline =~ /\\\s*$/) && $continuation == 0) {
1465 $check = 0;
1468 my $cond_ptr = -1;
1469 $continuation = 0;
1470 while ($cond_ptr != $cond_lines) {
1471 $cond_ptr = $cond_lines;
1473 # If we see an #else/#elif then the code
1474 # is not linear.
1475 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
1476 $check = 0;
1479 # Ignore:
1480 # 1) blank lines, they should be at 0,
1481 # 2) preprocessor lines, and
1482 # 3) labels.
1483 if ($continuation ||
1484 $s =~ /^\s*?\n/ ||
1485 $s =~ /^\s*#\s*?/ ||
1486 $s =~ /^\s*$Ident\s*:/) {
1487 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
1488 $s =~ s/^.*?\n//;
1489 $cond_lines++;
1493 my (undef, $sindent) = line_stats("+" . $s);
1494 my $stat_real = raw_line($linenr, $cond_lines);
1496 # Check if either of these lines are modified, else
1497 # this is not this patch's fault.
1498 if (!defined($stat_real) ||
1499 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
1500 $check = 0;
1502 if (defined($stat_real) && $cond_lines > 1) {
1503 $stat_real = "[...]\n$stat_real";
1506 #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";
1508 if ($check && (($sindent % 8) != 0 ||
1509 ($sindent <= $indent && $s ne ''))) {
1510 WARN("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
1514 # Track the 'values' across context and added lines.
1515 my $opline = $line; $opline =~ s/^./ /;
1516 my ($curr_values, $curr_vars) =
1517 annotate_values($opline . "\n", $prev_values);
1518 $curr_values = $prev_values . $curr_values;
1519 if ($dbg_values) {
1520 my $outline = $opline; $outline =~ s/\t/ /g;
1521 print "$linenr > .$outline\n";
1522 print "$linenr > $curr_values\n";
1523 print "$linenr > $curr_vars\n";
1525 $prev_values = substr($curr_values, -1);
1527 #ignore lines not being added
1528 if ($line=~/^[^\+]/) {next;}
1530 # TEST: allow direct testing of the type matcher.
1531 if ($dbg_type) {
1532 if ($line =~ /^.\s*$Declare\s*$/) {
1533 ERROR("TEST: is type\n" . $herecurr);
1534 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
1535 ERROR("TEST: is not type ($1 is)\n". $herecurr);
1537 next;
1539 # TEST: allow direct testing of the attribute matcher.
1540 if ($dbg_attr) {
1541 if ($line =~ /^.\s*$Attribute\s*$/) {
1542 ERROR("TEST: is attr\n" . $herecurr);
1543 } elsif ($dbg_attr > 1 && $line =~ /^.+($Attribute)/) {
1544 ERROR("TEST: is not attr ($1 is)\n". $herecurr);
1546 next;
1549 # check for initialisation to aggregates open brace on the next line
1550 if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ &&
1551 $line =~ /^.\s*{/) {
1552 ERROR("that open brace { should be on the previous line\n" . $hereprev);
1556 # Checks which are anchored on the added line.
1559 # check for malformed paths in #include statements (uses RAW line)
1560 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
1561 my $path = $1;
1562 if ($path =~ m{//}) {
1563 ERROR("malformed #include filename\n" .
1564 $herecurr);
1568 # no C99 // comments
1569 if ($line =~ m{//}) {
1570 ERROR("do not use C99 // comments\n" . $herecurr);
1572 # Remove C99 comments.
1573 $line =~ s@//.*@@;
1574 $opline =~ s@//.*@@;
1576 #EXPORT_SYMBOL should immediately follow its function closing }.
1577 if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) ||
1578 ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1579 my $name = $1;
1580 if ($prevline !~ /(?:
1581 ^.}|
1582 ^.DEFINE_$Ident\(\Q$name\E\)|
1583 ^.DECLARE_$Ident\(\Q$name\E\)|
1584 ^.LIST_HEAD\(\Q$name\E\)|
1585 ^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
1586 \b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[)
1587 )/x) {
1588 WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
1592 # check for external initialisers.
1593 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
1594 ERROR("do not initialise externals to 0 or NULL\n" .
1595 $herecurr);
1597 # check for static initialisers.
1598 if ($line =~ /\s*static\s.*=\s*(0|NULL|false)\s*;/) {
1599 ERROR("do not initialise statics to 0 or NULL\n" .
1600 $herecurr);
1603 # check for new typedefs, only function parameters and sparse annotations
1604 # make sense.
1605 if ($line =~ /\btypedef\s/ &&
1606 $line !~ /\btypedef\s+$Type\s+\(\s*\*?$Ident\s*\)\s*\(/ &&
1607 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
1608 $line !~ /\b$typeTypedefs\b/ &&
1609 $line !~ /\b__bitwise(?:__|)\b/) {
1610 WARN("do not add new typedefs\n" . $herecurr);
1613 # * goes on variable not on type
1614 if ($line =~ m{\($NonptrType(\*+)(?:\s+const)?\)}) {
1615 ERROR("\"(foo$1)\" should be \"(foo $1)\"\n" .
1616 $herecurr);
1618 } elsif ($line =~ m{\($NonptrType\s+(\*+)(?!\s+const)\s+\)}) {
1619 ERROR("\"(foo $1 )\" should be \"(foo $1)\"\n" .
1620 $herecurr);
1622 } elsif ($line =~ m{\b$NonptrType(\*+)(?:\s+(?:$Attribute|$Sparse))?\s+[A-Za-z\d_]+}) {
1623 ERROR("\"foo$1 bar\" should be \"foo $1bar\"\n" .
1624 $herecurr);
1626 } elsif ($line =~ m{\b$NonptrType\s+(\*+)(?!\s+(?:$Attribute|$Sparse))\s+[A-Za-z\d_]+}) {
1627 ERROR("\"foo $1 bar\" should be \"foo $1bar\"\n" .
1628 $herecurr);
1631 # # no BUG() or BUG_ON()
1632 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
1633 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
1634 # print "$herecurr";
1635 # $clean = 0;
1638 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
1639 WARN("LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
1642 # printk should use KERN_* levels. Note that follow on printk's on the
1643 # same line do not need a level, so we use the current block context
1644 # to try and find and validate the current printk. In summary the current
1645 # printk includes all preceeding printk's which have no newline on the end.
1646 # we assume the first bad printk is the one to report.
1647 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
1648 my $ok = 0;
1649 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
1650 #print "CHECK<$lines[$ln - 1]\n";
1651 # we have a preceeding printk if it ends
1652 # with "\n" ignore it, else it is to blame
1653 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
1654 if ($rawlines[$ln - 1] !~ m{\\n"}) {
1655 $ok = 1;
1657 last;
1660 if ($ok == 0) {
1661 WARN("printk() should include KERN_ facility level\n" . $herecurr);
1665 # function brace can't be on same line, except for #defines of do while,
1666 # or if closed on same line
1667 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
1668 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
1669 ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
1672 # open braces for enum, union and struct go on the same line.
1673 if ($line =~ /^.\s*{/ &&
1674 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1675 ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
1678 # check for spacing round square brackets; allowed:
1679 # 1. with a type on the left -- int [] a;
1680 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
1681 # 3. inside a curly brace -- = { [0...10] = 5 }
1682 while ($line =~ /(.*?\s)\[/g) {
1683 my ($where, $prefix) = ($-[1], $1);
1684 if ($prefix !~ /$Type\s+$/ &&
1685 ($where != 0 || $prefix !~ /^.\s+$/) &&
1686 $prefix !~ /{\s+$/) {
1687 ERROR("space prohibited before open square bracket '['\n" . $herecurr);
1691 # check for spaces between functions and their parentheses.
1692 while ($line =~ /($Ident)\s+\(/g) {
1693 my $name = $1;
1694 my $ctx_before = substr($line, 0, $-[1]);
1695 my $ctx = "$ctx_before$name";
1697 # Ignore those directives where spaces _are_ permitted.
1698 if ($name =~ /^(?:
1699 if|for|while|switch|return|case|
1700 volatile|__volatile__|
1701 __attribute__|format|__extension__|
1702 asm|__asm__)$/x)
1705 # cpp #define statements have non-optional spaces, ie
1706 # if there is a space between the name and the open
1707 # parenthesis it is simply not a parameter group.
1708 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
1710 # cpp #elif statement condition may start with a (
1711 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
1713 # If this whole things ends with a type its most
1714 # likely a typedef for a function.
1715 } elsif ($ctx =~ /$Type$/) {
1717 } else {
1718 WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
1721 # Check operator spacing.
1722 if (!($line=~/\#\s*include/)) {
1723 my $ops = qr{
1724 <<=|>>=|<=|>=|==|!=|
1725 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
1726 =>|->|<<|>>|<|>|=|!|~|
1727 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
1728 \?|:
1730 my @elements = split(/($ops|;)/, $opline);
1731 my $off = 0;
1733 my $blank = copy_spacing($opline);
1735 for (my $n = 0; $n < $#elements; $n += 2) {
1736 $off += length($elements[$n]);
1738 # Pick up the preceeding and succeeding characters.
1739 my $ca = substr($opline, 0, $off);
1740 my $cc = '';
1741 if (length($opline) >= ($off + length($elements[$n + 1]))) {
1742 $cc = substr($opline, $off + length($elements[$n + 1]));
1744 my $cb = "$ca$;$cc";
1746 my $a = '';
1747 $a = 'V' if ($elements[$n] ne '');
1748 $a = 'W' if ($elements[$n] =~ /\s$/);
1749 $a = 'C' if ($elements[$n] =~ /$;$/);
1750 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
1751 $a = 'O' if ($elements[$n] eq '');
1752 $a = 'E' if ($ca =~ /^\s*$/);
1754 my $op = $elements[$n + 1];
1756 my $c = '';
1757 if (defined $elements[$n + 2]) {
1758 $c = 'V' if ($elements[$n + 2] ne '');
1759 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
1760 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
1761 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
1762 $c = 'O' if ($elements[$n + 2] eq '');
1763 $c = 'E' if ($elements[$n + 2] =~ /\s*\\$/);
1764 } else {
1765 $c = 'E';
1768 my $ctx = "${a}x${c}";
1770 my $at = "(ctx:$ctx)";
1772 my $ptr = substr($blank, 0, $off) . "^";
1773 my $hereptr = "$hereline$ptr\n";
1775 # Pull out the value of this operator.
1776 my $op_type = substr($curr_values, $off + 1, 1);
1778 # Get the full operator variant.
1779 my $opv = $op . substr($curr_vars, $off, 1);
1781 # Ignore operators passed as parameters.
1782 if ($op_type ne 'V' &&
1783 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
1785 # # Ignore comments
1786 # } elsif ($op =~ /^$;+$/) {
1788 # ; should have either the end of line or a space or \ after it
1789 } elsif ($op eq ';') {
1790 if ($ctx !~ /.x[WEBC]/ &&
1791 $cc !~ /^\\/ && $cc !~ /^;/) {
1792 ERROR("space required after that '$op' $at\n" . $hereptr);
1795 # // is a comment
1796 } elsif ($op eq '//') {
1798 # No spaces for:
1799 # ->
1800 # : when part of a bitfield
1801 } elsif ($op eq '->' || $opv eq ':B') {
1802 if ($ctx =~ /Wx.|.xW/) {
1803 ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
1806 # , must have a space on the right.
1807 } elsif ($op eq ',') {
1808 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
1809 ERROR("space required after that '$op' $at\n" . $hereptr);
1812 # '*' as part of a type definition -- reported already.
1813 } elsif ($opv eq '*_') {
1814 #warn "'*' is part of type\n";
1816 # unary operators should have a space before and
1817 # none after. May be left adjacent to another
1818 # unary operator, or a cast
1819 } elsif ($op eq '!' || $op eq '~' ||
1820 $opv eq '*U' || $opv eq '-U' ||
1821 $opv eq '&U' || $opv eq '&&U') {
1822 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
1823 ERROR("space required before that '$op' $at\n" . $hereptr);
1825 if ($op eq '*' && $cc =~/\s*const\b/) {
1826 # A unary '*' may be const
1828 } elsif ($ctx =~ /.xW/) {
1829 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1832 # unary ++ and unary -- are allowed no space on one side.
1833 } elsif ($op eq '++' or $op eq '--') {
1834 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
1835 ERROR("space required one side of that '$op' $at\n" . $hereptr);
1837 if ($ctx =~ /Wx[BE]/ ||
1838 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
1839 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
1841 if ($ctx =~ /ExW/) {
1842 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1846 # << and >> may either have or not have spaces both sides
1847 } elsif ($op eq '<<' or $op eq '>>' or
1848 $op eq '&' or $op eq '^' or $op eq '|' or
1849 $op eq '+' or $op eq '-' or
1850 $op eq '*' or $op eq '/' or
1851 $op eq '%')
1853 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
1854 ERROR("need consistent spacing around '$op' $at\n" .
1855 $hereptr);
1858 # A colon needs no spaces before when it is
1859 # terminating a case value or a label.
1860 } elsif ($opv eq ':C' || $opv eq ':L') {
1861 if ($ctx =~ /Wx./) {
1862 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
1865 # All the others need spaces both sides.
1866 } elsif ($ctx !~ /[EWC]x[CWE]/) {
1867 my $ok = 0;
1869 # Ignore email addresses <foo@bar>
1870 if (($op eq '<' &&
1871 $cc =~ /^\S+\@\S+>/) ||
1872 ($op eq '>' &&
1873 $ca =~ /<\S+\@\S+$/))
1875 $ok = 1;
1878 # Ignore ?:
1879 if (($opv eq ':O' && $ca =~ /\?$/) ||
1880 ($op eq '?' && $cc =~ /^:/)) {
1881 $ok = 1;
1884 if ($ok == 0) {
1885 ERROR("spaces required around that '$op' $at\n" . $hereptr);
1888 $off += length($elements[$n + 1]);
1892 # check for multiple assignments
1893 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
1894 CHK("multiple assignments should be avoided\n" . $herecurr);
1897 ## # check for multiple declarations, allowing for a function declaration
1898 ## # continuation.
1899 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
1900 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
1902 ## # Remove any bracketed sections to ensure we do not
1903 ## # falsly report the parameters of functions.
1904 ## my $ln = $line;
1905 ## while ($ln =~ s/\([^\(\)]*\)//g) {
1906 ## }
1907 ## if ($ln =~ /,/) {
1908 ## WARN("declaring multiple variables together should be avoided\n" . $herecurr);
1909 ## }
1910 ## }
1912 #need space before brace following if, while, etc
1913 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
1914 $line =~ /do{/) {
1915 ERROR("space required before the open brace '{'\n" . $herecurr);
1918 # closing brace should have a space following it when it has anything
1919 # on the line
1920 if ($line =~ /}(?!(?:,|;|\)))\S/) {
1921 ERROR("space required after that close brace '}'\n" . $herecurr);
1924 # check spacing on square brackets
1925 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
1926 ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
1928 if ($line =~ /\s\]/) {
1929 ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
1932 # check spacing on parentheses
1933 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
1934 $line !~ /for\s*\(\s+;/) {
1935 ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
1937 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
1938 $line !~ /for\s*\(.*;\s+\)/ &&
1939 $line !~ /:\s+\)/) {
1940 ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
1943 #goto labels aren't indented, allow a single space however
1944 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
1945 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
1946 WARN("labels should not be indented\n" . $herecurr);
1949 # Return is not a function.
1950 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
1951 my $spacing = $1;
1952 my $value = $2;
1954 # Flatten any parentheses and braces
1955 $value =~ s/\)\(/\) \(/g;
1956 while ($value =~ s/\([^\(\)]*\)/1/) {
1959 if ($value =~ /^(?:$Ident|-?$Constant)$/) {
1960 ERROR("return is not a function, parentheses are not required\n" . $herecurr);
1962 } elsif ($spacing !~ /\s+/) {
1963 ERROR("space required before the open parenthesis '('\n" . $herecurr);
1967 # Need a space before open parenthesis after if, while etc
1968 if ($line=~/\b(if|while|for|switch)\(/) {
1969 ERROR("space required before the open parenthesis '('\n" . $herecurr);
1972 # Check for illegal assignment in if conditional -- and check for trailing
1973 # statements after the conditional.
1974 if ($line =~ /do\s*(?!{)/) {
1975 my ($stat_next) = ctx_statement_block($line_nr_next,
1976 $remain_next, $off_next);
1977 $stat_next =~ s/\n./\n /g;
1978 ##print "stat<$stat> stat_next<$stat_next>\n";
1980 if ($stat_next =~ /^\s*while\b/) {
1981 # If the statement carries leading newlines,
1982 # then count those as offsets.
1983 my ($whitespace) =
1984 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
1985 my $offset =
1986 statement_rawlines($whitespace) - 1;
1988 $suppress_whiletrailers{$line_nr_next +
1989 $offset} = 1;
1992 if (!defined $suppress_whiletrailers{$linenr} &&
1993 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
1994 my ($s, $c) = ($stat, $cond);
1996 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/) {
1997 ERROR("do not use assignment in if condition\n" . $herecurr);
2000 # Find out what is on the end of the line after the
2001 # conditional.
2002 substr($s, 0, length($c), '');
2003 $s =~ s/\n.*//g;
2004 $s =~ s/$;//g; # Remove any comments
2005 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2006 $c !~ /}\s*while\s*/)
2008 # Find out how long the conditional actually is.
2009 my @newlines = ($c =~ /\n/gs);
2010 my $cond_lines = 1 + $#newlines;
2012 my $stat_real = raw_line($linenr, $cond_lines);
2013 if (defined($stat_real) && $cond_lines > 1) {
2014 $stat_real = "[...]\n$stat_real";
2017 ERROR("trailing statements should be on next line\n" . $herecurr . $stat_real);
2021 # Check for bitwise tests written as boolean
2022 if ($line =~ /
2024 (?:\[|\(|\&\&|\|\|)
2025 \s*0[xX][0-9]+\s*
2026 (?:\&\&|\|\|)
2028 (?:\&\&|\|\|)
2029 \s*0[xX][0-9]+\s*
2030 (?:\&\&|\|\||\)|\])
2031 )/x)
2033 WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2036 # if and else should not have general statements after it
2037 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2038 my $s = $1;
2039 $s =~ s/$;//g; # Remove any comments
2040 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2041 ERROR("trailing statements should be on next line\n" . $herecurr);
2044 # case and default should not have general statements after them
2045 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2046 $line !~ /\G(?:
2047 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
2048 \s*return\s+
2049 )/xg)
2051 ERROR("trailing statements should be on next line\n" . $herecurr);
2054 # Check for }<nl>else {, these must be at the same
2055 # indent level to be relevant to each other.
2056 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2057 $previndent == $indent) {
2058 ERROR("else should follow close brace '}'\n" . $hereprev);
2061 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2062 $previndent == $indent) {
2063 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2065 # Find out what is on the end of the line after the
2066 # conditional.
2067 substr($s, 0, length($c), '');
2068 $s =~ s/\n.*//g;
2070 if ($s =~ /^\s*;/) {
2071 ERROR("while should follow close brace '}'\n" . $hereprev);
2075 #studly caps, commented out until figure out how to distinguish between use of existing and adding new
2076 # if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2077 # print "No studly caps, use _\n";
2078 # print "$herecurr";
2079 # $clean = 0;
2082 #no spaces allowed after \ in define
2083 if ($line=~/\#\s*define.*\\\s$/) {
2084 WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
2087 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
2088 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
2089 my $file = "$1.h";
2090 my $checkfile = "include/linux/$file";
2091 if (-f "$root/$checkfile" &&
2092 $realfile ne $checkfile &&
2093 $1 ne 'irq')
2095 if ($realfile =~ m{^arch/}) {
2096 CHK("Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2097 } else {
2098 WARN("Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2103 # multi-statement macros should be enclosed in a do while loop, grab the
2104 # first statement and ensure its the whole macro if its not enclosed
2105 # in a known good container
2106 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2107 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
2108 my $ln = $linenr;
2109 my $cnt = $realcnt;
2110 my ($off, $dstat, $dcond, $rest);
2111 my $ctx = '';
2113 my $args = defined($1);
2115 # Find the end of the macro and limit our statement
2116 # search to that.
2117 while ($cnt > 0 && defined $lines[$ln - 1] &&
2118 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
2120 $ctx .= $rawlines[$ln - 1] . "\n";
2121 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2122 $ln++;
2124 $ctx .= $rawlines[$ln - 1];
2126 ($dstat, $dcond, $ln, $cnt, $off) =
2127 ctx_statement_block($linenr, $ln - $linenr + 1, 0);
2128 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
2129 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
2131 # Extract the remainder of the define (if any) and
2132 # rip off surrounding spaces, and trailing \'s.
2133 $rest = '';
2134 while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
2135 #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
2136 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
2137 $rest .= substr($lines[$ln - 1], $off) . "\n";
2138 $cnt--;
2140 $ln++;
2141 $off = 0;
2143 $rest =~ s/\\\n.//g;
2144 $rest =~ s/^\s*//s;
2145 $rest =~ s/\s*$//s;
2147 # Clean up the original statement.
2148 if ($args) {
2149 substr($dstat, 0, length($dcond), '');
2150 } else {
2151 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
2153 $dstat =~ s/$;//g;
2154 $dstat =~ s/\\\n.//g;
2155 $dstat =~ s/^\s*//s;
2156 $dstat =~ s/\s*$//s;
2158 # Flatten any parentheses and braces
2159 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2160 $dstat =~ s/\{[^\{\}]*\}/1/ ||
2161 $dstat =~ s/\[[^\{\}]*\]/1/)
2165 my $exceptions = qr{
2166 $Declare|
2167 module_param_named|
2168 MODULE_PARAM_DESC|
2169 DECLARE_PER_CPU|
2170 DEFINE_PER_CPU|
2171 __typeof__\(|
2172 \.$Ident\s*=\s*
2174 #print "REST<$rest> dstat<$dstat>\n";
2175 if ($rest ne '') {
2176 if ($rest !~ /while\s*\(/ &&
2177 $dstat !~ /$exceptions/)
2179 ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
2182 } elsif ($ctx !~ /;/) {
2183 if ($dstat ne '' &&
2184 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2185 $dstat !~ /$exceptions/ &&
2186 $dstat !~ /^\.$Ident\s*=/ &&
2187 $dstat =~ /$Operators/)
2189 ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
2194 # check for redundant bracing round if etc
2195 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2196 my ($level, $endln, @chunks) =
2197 ctx_statement_full($linenr, $realcnt, 1);
2198 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
2199 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2200 if ($#chunks > 0 && $level == 0) {
2201 my $allowed = 0;
2202 my $seen = 0;
2203 my $herectx = $here . "\n";
2204 my $ln = $linenr - 1;
2205 for my $chunk (@chunks) {
2206 my ($cond, $block) = @{$chunk};
2208 # If the condition carries leading newlines, then count those as offsets.
2209 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2210 my $offset = statement_rawlines($whitespace) - 1;
2212 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2214 # We have looked at and allowed this specific line.
2215 $suppress_ifbraces{$ln + $offset} = 1;
2217 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
2218 $ln += statement_rawlines($block) - 1;
2220 substr($block, 0, length($cond), '');
2222 $seen++ if ($block =~ /^\s*{/);
2224 #print "cond<$cond> block<$block> allowed<$allowed>\n";
2225 if (statement_lines($cond) > 1) {
2226 #print "APW: ALLOWED: cond<$cond>\n";
2227 $allowed = 1;
2229 if ($block =~/\b(?:if|for|while)\b/) {
2230 #print "APW: ALLOWED: block<$block>\n";
2231 $allowed = 1;
2233 if (statement_block_size($block) > 1) {
2234 #print "APW: ALLOWED: lines block<$block>\n";
2235 $allowed = 1;
2238 if ($seen && !$allowed) {
2239 WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
2243 if (!defined $suppress_ifbraces{$linenr - 1} &&
2244 $line =~ /\b(if|while|for|else)\b/) {
2245 my $allowed = 0;
2247 # Check the pre-context.
2248 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2249 #print "APW: ALLOWED: pre<$1>\n";
2250 $allowed = 1;
2253 my ($level, $endln, @chunks) =
2254 ctx_statement_full($linenr, $realcnt, $-[0]);
2256 # Check the condition.
2257 my ($cond, $block) = @{$chunks[0]};
2258 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
2259 if (defined $cond) {
2260 substr($block, 0, length($cond), '');
2262 if (statement_lines($cond) > 1) {
2263 #print "APW: ALLOWED: cond<$cond>\n";
2264 $allowed = 1;
2266 if ($block =~/\b(?:if|for|while)\b/) {
2267 #print "APW: ALLOWED: block<$block>\n";
2268 $allowed = 1;
2270 if (statement_block_size($block) > 1) {
2271 #print "APW: ALLOWED: lines block<$block>\n";
2272 $allowed = 1;
2274 # Check the post-context.
2275 if (defined $chunks[1]) {
2276 my ($cond, $block) = @{$chunks[1]};
2277 if (defined $cond) {
2278 substr($block, 0, length($cond), '');
2280 if ($block =~ /^\s*\{/) {
2281 #print "APW: ALLOWED: chunk-1 block<$block>\n";
2282 $allowed = 1;
2285 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
2286 my $herectx = $here . "\n";;
2287 my $cnt = statement_rawlines($block);
2289 for (my $n = 0; $n < $cnt; $n++) {
2290 $herectx .= raw_line($linenr, $n) . "\n";;
2293 WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
2297 # don't include deprecated include files (uses RAW line)
2298 for my $inc (@dep_includes) {
2299 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
2300 ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2304 # don't use deprecated functions
2305 for my $func (@dep_functions) {
2306 if ($line =~ /\b$func\b/) {
2307 ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2311 # no volatiles please
2312 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2313 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
2314 WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
2317 # SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
2318 if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
2319 ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
2322 # warn about #if 0
2323 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
2324 CHK("if this code is redundant consider removing it\n" .
2325 $herecurr);
2328 # check for needless kfree() checks
2329 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2330 my $expr = $1;
2331 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
2332 WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
2335 # check for needless usb_free_urb() checks
2336 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2337 my $expr = $1;
2338 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
2339 WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
2343 # warn about #ifdefs in C files
2344 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
2345 # print "#ifdef in C files should be avoided\n";
2346 # print "$herecurr";
2347 # $clean = 0;
2350 # warn about spacing in #ifdefs
2351 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
2352 ERROR("exactly one space required after that #$1\n" . $herecurr);
2355 # check for spinlock_t definitions without a comment.
2356 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
2357 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
2358 my $which = $1;
2359 if (!ctx_has_comment($first_line, $linenr)) {
2360 CHK("$1 definition without comment\n" . $herecurr);
2363 # check for memory barriers without a comment.
2364 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2365 if (!ctx_has_comment($first_line, $linenr)) {
2366 CHK("memory barrier without comment\n" . $herecurr);
2369 # check of hardware specific defines
2370 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
2371 CHK("architecture specific defines should be avoided\n" . $herecurr);
2374 # check the location of the inline attribute, that it is between
2375 # storage class and type.
2376 if ($line =~ /\b$Type\s+$Inline\b/ ||
2377 $line =~ /\b$Inline\s+$Storage\b/) {
2378 ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
2381 # Check for __inline__ and __inline, prefer inline
2382 if ($line =~ /\b(__inline__|__inline)\b/) {
2383 WARN("plain inline is preferred over $1\n" . $herecurr);
2386 # check for new externs in .c files.
2387 if ($realfile =~ /\.c$/ && defined $stat &&
2388 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
2390 my $function_name = $1;
2391 my $paren_space = $2;
2393 my $s = $stat;
2394 if (defined $cond) {
2395 substr($s, 0, length($cond), '');
2397 if ($s =~ /^\s*;/ &&
2398 $function_name ne 'uninitialized_var')
2400 WARN("externs should be avoided in .c files\n" . $herecurr);
2403 if ($paren_space =~ /\n/) {
2404 WARN("arguments for function declarations should follow identifier\n" . $herecurr);
2407 } elsif ($realfile =~ /\.c$/ && defined $stat &&
2408 $stat =~ /^.\s*extern\s+/)
2410 WARN("externs should be avoided in .c files\n" . $herecurr);
2413 # checks for new __setup's
2414 if ($rawline =~ /\b__setup\("([^"]*)"/) {
2415 my $name = $1;
2417 if (!grep(/$name/, @setup_docs)) {
2418 CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
2422 # check for pointless casting of kmalloc return
2423 if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
2424 WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
2427 # check for gcc specific __FUNCTION__
2428 if ($line =~ /__FUNCTION__/) {
2429 WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
2432 # check for semaphores used as mutexes
2433 if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
2434 WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
2436 # check for semaphores used as mutexes
2437 if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
2438 WARN("consider using a completion\n" . $herecurr);
2440 # recommend strict_strto* over simple_strto*
2441 if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2442 WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
2444 # check for __initcall(), use device_initcall() explicitly please
2445 if ($line =~ /^.\s*__initcall\s*\(/) {
2446 WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
2449 # use of NR_CPUS is usually wrong
2450 # ignore definitions of NR_CPUS and usage to define arrays as likely right
2451 if ($line =~ /\bNR_CPUS\b/ &&
2452 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
2453 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
2454 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
2455 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
2456 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
2458 WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
2461 # check for %L{u,d,i} in strings
2462 my $string;
2463 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2464 $string = substr($rawline, $-[1], $+[1] - $-[1]);
2465 $string =~ s/%%/__/g;
2466 if ($string =~ /(?<!%)%L[udi]/) {
2467 WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2468 last;
2472 # whine mightly about in_atomic
2473 if ($line =~ /\bin_atomic\s*\(/) {
2474 if ($realfile =~ m@^drivers/@) {
2475 ERROR("do not use in_atomic in drivers\n" . $herecurr);
2476 } else {
2477 WARN("use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
2482 # If we have no input at all, then there is nothing to report on
2483 # so just keep quiet.
2484 if ($#rawlines == -1) {
2485 exit(0);
2488 # In mailback mode only produce a report in the negative, for
2489 # things that appear to be patches.
2490 if ($mailback && ($clean == 1 || !$is_patch)) {
2491 exit(0);
2494 # This is not a patch, and we are are in 'no-patch' mode so
2495 # just keep quiet.
2496 if (!$chk_patch && !$is_patch) {
2497 exit(0);
2500 if (!$is_patch) {
2501 ERROR("Does not appear to be a unified-diff format patch\n");
2503 if ($is_patch && $chk_signoff && $signoff == 0) {
2504 ERROR("Missing Signed-off-by: line(s)\n");
2507 print report_dump();
2508 if ($summary && !($clean == 1 && $quiet == 1)) {
2509 print "$filename " if ($summary_file);
2510 print "total: $cnt_error errors, $cnt_warn warnings, " .
2511 (($check)? "$cnt_chk checks, " : "") .
2512 "$cnt_lines lines checked\n";
2513 print "\n" if ($quiet == 0);
2516 if ($clean == 1 && $quiet == 0) {
2517 print "$vname has no obvious style problems and is ready for submission.\n"
2519 if ($clean == 0 && $quiet == 0) {
2520 print "$vname has style problems, please review. If any of these errors\n";
2521 print "are false positives report them to the maintainer, see\n";
2522 print "CHECKPATCH in MAINTAINERS.\n";
2525 return $clean;