checkpatch: comment ends inside strings is most likely not an open comment
[deliverable/linux.git] / scripts / checkpatch.pl
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
6
7 use strict;
8
9 my $P = $0;
10 $P =~ s@.*/@@g;
11
12 my $V = '0.24';
13
14 use Getopt::Long qw(:config no_auto_abbrev);
15
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,
44
45 'debug=s' => \%debug,
46 'test-only=s' => \$tst_only,
47 ) or exit;
48
49 my $exit = 0;
50
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);
64 }
65
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}';"
72 }
73
74 if ($terse) {
75 $emacs = 1;
76 $quiet++;
77 }
78
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";
83 }
84 } else {
85 if (top_of_kernel_tree('.')) {
86 $root = '.';
87 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
88 top_of_kernel_tree($1)) {
89 $root = $1;
90 }
91 }
92
93 if (!defined $root) {
94 print "Must be run from the top-level dir. of a kernel tree\n";
95 exit(2);
96 }
97 }
98
99 my $emitted_corrupt = 0;
100
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
111 }x;
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
121 }x;
122 our $Modifier;
123 our $Inline = qr{inline|__always_inline|noinline};
124 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
125 our $Lval = qr{$Ident(?:$Member)*};
126
127 our $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
128 our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
129 our $Operators = qr{
130 <=|>=|==|!=|
131 =>|->|<<|>>|<|>|!|~|
132 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
133 }x;
134
135 our $NonptrType;
136 our $Type;
137 our $Declare;
138
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
148 }x;
149
150 our $typeTypedefs = qr{(?x:
151 (?:__)?(?:u|s|be|le)(?:\d|\d\d)|
152 atomic_t
153 )};
154
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},
174 );
175 our @modifierList = (
176 qr{fastcall},
177 );
178
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+)*
185 (?:
186 (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
187 (?:$typeTypedefs\b)|
188 (?:${all}\b)
189 )
190 (?:\s+$Modifier|\s+const)*
191 }x;
192 $Type = qr{
193 $NonptrType
194 (?:\s*\*+\s*const|\s*\*+|(?:\s*\[\s*\])+)?
195 (?:\s+$Inline|\s+$Modifier)*
196 }x;
197 $Declare = qr{(?:$Storage\s+)?$Type};
198 }
199 build_types();
200
201 $chk_signoff = 0 if ($file);
202
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);
214
215 } elsif ($entry !~ m@/@) {
216 push(@dep_functions, $entry);
217 }
218 }
219 }
220 }
221 }
222
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";
233 }
234 if ($filename eq '-') {
235 $vname = 'Your patch';
236 } else {
237 $vname = $filename;
238 }
239 while (<FILE>) {
240 chomp;
241 push(@rawlines, $_);
242 }
243 close(FILE);
244 if (!process($filename)) {
245 $exit = 1;
246 }
247 @rawlines = ();
248 @lines = ();
249 }
250
251 exit($exit);
252
253 sub top_of_kernel_tree {
254 my ($root) = @_;
255
256 my @tree_check = (
257 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
258 "README", "Documentation", "arch", "include", "drivers",
259 "fs", "init", "ipc", "kernel", "lib", "scripts",
260 );
261
262 foreach my $check (@tree_check) {
263 if (! -e $root . '/' . $check) {
264 return 0;
265 }
266 }
267 return 1;
268 }
269
270 sub expand_tabs {
271 my ($str) = @_;
272
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 .= ' ';
281 }
282 next;
283 }
284 $res .= $c;
285 $n++;
286 }
287
288 return $res;
289 }
290 sub copy_spacing {
291 (my $res = shift) =~ tr/\t/ /c;
292 return $res;
293 }
294
295 sub line_stats {
296 my ($line) = @_;
297
298 # Drop the diff line leader and expand tabs
299 $line =~ s/^.//;
300 $line = expand_tabs($line);
301
302 # Pick the indent from the front of the line.
303 my ($white) = ($line =~ /^(\s*)/);
304
305 return (length($line), length($white));
306 }
307
308 my $sanitise_quote = '';
309
310 sub sanitise_line_reset {
311 my ($in_comment) = @_;
312
313 if ($in_comment) {
314 $sanitise_quote = '*/';
315 } else {
316 $sanitise_quote = '';
317 }
318 }
319 sub sanitise_line {
320 my ($line) = @_;
321
322 my $res = '';
323 my $l = '';
324
325 my $qlen = 0;
326 my $off = 0;
327 my $c;
328
329 # Always copy over the diff marker.
330 $res = substr($line, 0, 1);
331
332 for ($off = 1; $off < length($line); $off++) {
333 $c = substr($line, $off, 1);
334
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 = '*/';
339
340 substr($res, $off, 2, "$;$;");
341 $off++;
342 next;
343 }
344 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
345 $sanitise_quote = '';
346 substr($res, $off, 2, "$;$;");
347 $off++;
348 next;
349 }
350
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;
357 }
358 # Regular quotes.
359 if ($c eq "'" || $c eq '"') {
360 if ($sanitise_quote eq '') {
361 $sanitise_quote = $c;
362
363 substr($res, $off, 1, $c);
364 next;
365 } elsif ($sanitise_quote eq $c) {
366 $sanitise_quote = '';
367 }
368 }
369
370 #print "c<$c> 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);
377 }
378 }
379
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>@;
384
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@;
389 }
390
391 return $res;
392 }
393
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;
401
402 my $loff = 0;
403
404 my $type = '';
405 my $level = 0;
406 my $p;
407 my $c;
408 my $len = 0;
409
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;
425 }
426 # Bail if there is no further context.
427 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
428 if ($off >= $len) {
429 last;
430 }
431 }
432 $p = $c;
433 $c = substr($blk, $off, 1);
434 $remainder = substr($blk, $off);
435
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;
441 }
442
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";
452 }
453
454 if (($type eq '' || $type eq '(') && $c eq '(') {
455 $level++;
456 $type = '(';
457 }
458 if ($type eq '(' && $c eq ')') {
459 $level--;
460 $type = ($level != 0)? '(' : '';
461
462 if ($level == 0 && $coff < $soff) {
463 $coff = $off;
464 $coff_set = 1;
465 #warn "CSB: mark coff<$coff>\n";
466 }
467 }
468 if (($type eq '' || $type eq '{') && $c eq '{') {
469 $level++;
470 $type = '{';
471 }
472 if ($type eq '{' && $c eq '}') {
473 $level--;
474 $type = ($level != 0)? '{' : '';
475
476 if ($level == 0) {
477 last;
478 }
479 }
480 $off++;
481 }
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--;
487 }
488
489 my $statement = substr($blk, $soff, $off - $soff + 1);
490 my $condition = substr($blk, $soff, $coff - $soff + 1);
491
492 #warn "STATEMENT<$statement>\n";
493 #warn "CONDITION<$condition>\n";
494
495 #print "coff<$coff> soff<$off> loff<$loff>\n";
496
497 return ($statement, $condition,
498 $line, $remain + 1, $off - $loff + 1, $level);
499 }
500
501 sub statement_lines {
502 my ($stmt) = @_;
503
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*$//;
508
509 my @stmt_lines = ($stmt =~ /\n/g);
510
511 return $#stmt_lines + 2;
512 }
513
514 sub statement_rawlines {
515 my ($stmt) = @_;
516
517 my @stmt_lines = ($stmt =~ /\n/g);
518
519 return $#stmt_lines + 2;
520 }
521
522 sub statement_block_size {
523 my ($stmt) = @_;
524
525 $stmt =~ s/(^|\n)./$1/g;
526 $stmt =~ s/^\s*{//;
527 $stmt =~ s/}\s*$//;
528 $stmt =~ s/^\s*//;
529 $stmt =~ s/\s*$//;
530
531 my @stmt_lines = ($stmt =~ /\n/g);
532 my @stmt_statements = ($stmt =~ /;/g);
533
534 my $stmt_lines = $#stmt_lines + 2;
535 my $stmt_statements = $#stmt_statements + 1;
536
537 if ($stmt_lines > $stmt_statements) {
538 return $stmt_lines;
539 } else {
540 return $stmt_statements;
541 }
542 }
543
544 sub ctx_statement_full {
545 my ($linenr, $remain, $off) = @_;
546 my ($statement, $condition, $level);
547
548 my (@chunks);
549
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);
557 }
558
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 ]);
568 }
569
570 return ($level, $linenr, @chunks);
571 }
572
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 = ();
581
582 my $level = 0;
583 for ($line = $start; $remain > 0; $line++) {
584 next if ($rawlines[$line] =~ /^-/);
585 $remain--;
586
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;
593 }
594
595 if ($c eq $close && $level > 0) {
596 $level--;
597 last if ($level == 0);
598 } elsif ($c eq $open) {
599 $level++;
600 }
601 }
602
603 if (!$outer || $level <= 1) {
604 push(@res, $rawlines[$line]);
605 }
606
607 last if ($level == 0);
608 }
609
610 return ($level, @res);
611 }
612 sub ctx_block_outer {
613 my ($linenr, $remain) = @_;
614
615 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
616 return @r;
617 }
618 sub ctx_block {
619 my ($linenr, $remain) = @_;
620
621 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
622 return @r;
623 }
624 sub ctx_statement {
625 my ($linenr, $remain, $off) = @_;
626
627 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
628 return @r;
629 }
630 sub ctx_block_level {
631 my ($linenr, $remain) = @_;
632
633 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
634 }
635 sub ctx_statement_level {
636 my ($linenr, $remain, $off) = @_;
637
638 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
639 }
640
641 sub ctx_locate_comment {
642 my ($first_line, $end_line) = @_;
643
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);
647
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;
657 }
658 if ($line =~ m@/\*@) {
659 $in_comment = 1;
660 }
661 if (!$in_comment && $current_comment ne '') {
662 $current_comment = '';
663 }
664 $current_comment .= $line . "\n" if ($in_comment);
665 if ($line =~ m@\*/@) {
666 $in_comment = 0;
667 }
668 }
669
670 chomp($current_comment);
671 return($current_comment);
672 }
673 sub ctx_has_comment {
674 my ($first_line, $end_line) = @_;
675 my $cmt = ctx_locate_comment($first_line, $end_line);
676
677 ##print "LINE: $rawlines[$end_line - 1 ]\n";
678 ##print "CMMT: $cmt\n";
679
680 return ($cmt ne '');
681 }
682
683 sub raw_line {
684 my ($linenr, $cnt) = @_;
685
686 my $offset = $linenr - 1;
687 $cnt++;
688
689 my $line;
690 while ($cnt) {
691 $line = $rawlines[$offset++];
692 next if (defined($line) && $line =~ /^-/);
693 $cnt--;
694 }
695
696 return $line;
697 }
698
699 sub cat_vet {
700 my ($vet) = @_;
701 my ($res, $coded);
702
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;
709 }
710 }
711 $res =~ s/$/\$/;
712
713 return $res;
714 }
715
716 my $av_preprocessor = 0;
717 my $av_pending;
718 my @av_paren_type;
719 my $av_pend_colon;
720
721 sub annotate_reset {
722 $av_preprocessor = 0;
723 $av_pending = '_';
724 @av_paren_type = ('E');
725 $av_pend_colon = 'O';
726 }
727
728 sub annotate_values {
729 my ($stream, $type) = @_;
730
731 my $res;
732 my $var = '_' x length($stream);
733 my $cur = $stream;
734
735 print "$stream\n" if ($dbg_values > 1);
736
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;
746 }
747
748 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\()/) {
749 print "DECLARE($1)\n" if ($dbg_values > 1);
750 $type = 'T';
751
752 } elsif ($cur =~ /^($Modifier)\s*/) {
753 print "MODIFIER($1)\n" if ($dbg_values > 1);
754 $type = 'T';
755
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';
762 }
763 $type = 'E';
764
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);
769
770 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
771 print "PRE_START($1)\n" if ($dbg_values > 1);
772 $av_preprocessor = 1;
773
774 push(@av_paren_type, $type);
775 push(@av_paren_type, $type);
776 $type = 'E';
777
778 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
779 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
780 $av_preprocessor = 1;
781
782 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
783
784 $type = 'E';
785
786 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
787 print "PRE_END($1)\n" if ($dbg_values > 1);
788
789 $av_preprocessor = 1;
790
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';
796
797 } elsif ($cur =~ /^(\\\n)/o) {
798 print "PRECONT($1)\n" if ($dbg_values > 1);
799
800 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
801 print "ATTR($1)\n" if ($dbg_values > 1);
802 $av_pending = $type;
803 $type = 'N';
804
805 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
806 print "SIZEOF($1)\n" if ($dbg_values > 1);
807 if (defined $2) {
808 $av_pending = 'V';
809 }
810 $type = 'N';
811
812 } elsif ($cur =~ /^(if|while|for)\b/o) {
813 print "COND($1)\n" if ($dbg_values > 1);
814 $av_pending = 'E';
815 $type = 'N';
816
817 } elsif ($cur =~/^(case)/o) {
818 print "CASE($1)\n" if ($dbg_values > 1);
819 $av_pend_colon = 'C';
820 $type = 'N';
821
822 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
823 print "KEYWORD($1)\n" if ($dbg_values > 1);
824 $type = 'N';
825
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';
831
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);
840 }
841
842 } elsif ($cur =~ /^($Ident)\s*\(/o) {
843 print "FUNC($1)\n" if ($dbg_values > 1);
844 $type = 'V';
845 $av_pending = 'V';
846
847 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
848 if (defined $2 && $type eq 'C' || $type eq 'T') {
849 $av_pend_colon = 'B';
850 } elsif ($type eq 'E') {
851 $av_pend_colon = 'L';
852 }
853 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
854 $type = 'V';
855
856 } elsif ($cur =~ /^($Ident|$Constant)/o) {
857 print "IDENT($1)\n" if ($dbg_values > 1);
858 $type = 'V';
859
860 } elsif ($cur =~ /^($Assignment)/o) {
861 print "ASSIGN($1)\n" if ($dbg_values > 1);
862 $type = 'N';
863
864 } elsif ($cur =~/^(;|{|})/) {
865 print "END($1)\n" if ($dbg_values > 1);
866 $type = 'E';
867 $av_pend_colon = 'O';
868
869 } elsif ($cur =~/^(,)/) {
870 print "COMMA($1)\n" if ($dbg_values > 1);
871 $type = 'C';
872
873 } elsif ($cur =~ /^(\?)/o) {
874 print "QUESTION($1)\n" if ($dbg_values > 1);
875 $type = 'N';
876
877 } elsif ($cur =~ /^(:)/o) {
878 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
879
880 substr($var, length($res), 1, $av_pend_colon);
881 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
882 $type = 'E';
883 } else {
884 $type = 'N';
885 }
886 $av_pend_colon = 'O';
887
888 } elsif ($cur =~ /^(\[)/o) {
889 print "CLOSE($1)\n" if ($dbg_values > 1);
890 $type = 'N';
891
892 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
893 my $variant;
894
895 print "OPV($1)\n" if ($dbg_values > 1);
896 if ($type eq 'V') {
897 $variant = 'B';
898 } else {
899 $variant = 'U';
900 }
901
902 substr($var, length($res), 1, $variant);
903 $type = 'N';
904
905 } elsif ($cur =~ /^($Operators)/o) {
906 print "OP($1)\n" if ($dbg_values > 1);
907 if ($1 ne '++' && $1 ne '--') {
908 $type = 'N';
909 }
910
911 } elsif ($cur =~ /(^.)/o) {
912 print "C($1)\n" if ($dbg_values > 1);
913 }
914 if (defined $1) {
915 $cur = substr($cur, length($1));
916 $res .= $type x length($1);
917 }
918 }
919
920 return ($res, $var);
921 }
922
923 sub possible {
924 my ($possible, $line) = @_;
925
926 print "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
927 if ($possible !~ /(?:
928 ^(?:
929 $Modifier|
930 $Storage|
931 $Type|
932 DEFINE_\S+|
933 goto|
934 return|
935 case|
936 else|
937 asm|__asm__|
938 do
939 )$|
940 ^(?:typedef|struct|enum)\b
941 )/x) {
942 # Check for modifiers.
943 $possible =~ s/\s*$Storage\s*//g;
944 $possible =~ s/\s*$Sparse\s*//g;
945 if ($possible =~ /^\s*$/) {
946
947 } elsif ($possible =~ /\s/) {
948 $possible =~ s/\s*$Type\s*//g;
949 for my $modifier (split(' ', $possible)) {
950 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
951 push(@modifierList, $modifier);
952 }
953
954 } else {
955 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
956 push(@typeList, $possible);
957 }
958 build_types();
959 } else {
960 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
961 }
962 }
963
964 my $prefix = '';
965
966 sub report {
967 if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
968 return 0;
969 }
970 my $line = $prefix . $_[0];
971
972 $line = (split('\n', $line))[0] . "\n" if ($terse);
973
974 push(our @report, $line);
975
976 return 1;
977 }
978 sub report_dump {
979 our @report;
980 }
981 sub ERROR {
982 if (report("ERROR: $_[0]\n")) {
983 our $clean = 0;
984 our $cnt_error++;
985 }
986 }
987 sub WARN {
988 if (report("WARNING: $_[0]\n")) {
989 our $clean = 0;
990 our $cnt_warn++;
991 }
992 }
993 sub CHK {
994 if ($check && report("CHECK: $_[0]\n")) {
995 our $clean = 0;
996 our $cnt_chk++;
997 }
998 }
999
1000 sub check_absolute_file {
1001 my ($absolute, $herecurr) = @_;
1002 my $file = $absolute;
1003
1004 ##print "absolute<$absolute>\n";
1005
1006 # See if any suffix of this path is a path within the tree.
1007 while ($file =~ s@^[^/]*/@@) {
1008 if (-f "$root/$file") {
1009 ##print "file<$file>\n";
1010 last;
1011 }
1012 }
1013 if (! -f _) {
1014 return 0;
1015 }
1016
1017 # It is, so see if the prefix is acceptable.
1018 my $prefix = $absolute;
1019 substr($prefix, -length($file)) = '';
1020
1021 ##print "prefix<$prefix>\n";
1022 if ($prefix ne ".../") {
1023 WARN("use relative pathname instead of absolute in changelog text\n" . $herecurr);
1024 }
1025 }
1026
1027 sub process {
1028 my $filename = shift;
1029
1030 my $linenr=0;
1031 my $prevline="";
1032 my $prevrawline="";
1033 my $stashline="";
1034 my $stashrawline="";
1035
1036 my $length;
1037 my $indent;
1038 my $previndent=0;
1039 my $stashindent=0;
1040
1041 our $clean = 1;
1042 my $signoff = 0;
1043 my $is_patch = 0;
1044
1045 our @report = ();
1046 our $cnt_lines = 0;
1047 our $cnt_error = 0;
1048 our $cnt_warn = 0;
1049 our $cnt_chk = 0;
1050
1051 # Trace the real file/line as we go.
1052 my $realfile = '';
1053 my $realline = 0;
1054 my $realcnt = 0;
1055 my $here = '';
1056 my $in_comment = 0;
1057 my $comment_edge = 0;
1058 my $first_line = 0;
1059
1060 my $prev_values = 'E';
1061
1062 # suppression flags
1063 my %suppress_ifbraces;
1064 my %suppress_whiletrailers;
1065
1066 # Pre-scan the patch sanitizing the lines.
1067 # Pre-scan the patch looking for any __setup documentation.
1068 #
1069 my @setup_docs = ();
1070 my $setup_docs = 0;
1071
1072 sanitise_line_reset();
1073 my $line;
1074 foreach my $rawline (@rawlines) {
1075 $linenr++;
1076 $line = $rawline;
1077
1078 if ($rawline=~/^\+\+\+\s+(\S+)/) {
1079 $setup_docs = 0;
1080 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1081 $setup_docs = 1;
1082 }
1083 #next;
1084 }
1085 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1086 $realline=$1-1;
1087 if (defined $2) {
1088 $realcnt=$3+1;
1089 } else {
1090 $realcnt=1+1;
1091 }
1092 $in_comment = 0;
1093
1094 # Guestimate if this is a continuing comment. Run
1095 # the context looking for a comment "edge". If this
1096 # edge is a close comment then we must be in a comment
1097 # at context start.
1098 my $edge;
1099 my $cnt = $realcnt;
1100 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1101 next if (defined $rawlines[$ln - 1] &&
1102 $rawlines[$ln - 1] =~ /^-/);
1103 $cnt--;
1104 #print "RAW<$rawlines[$ln - 1]>\n";
1105 last if (!defined $rawlines[$ln - 1]);
1106 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1107 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1108 ($edge) = $1;
1109 last;
1110 }
1111 }
1112 if (defined $edge && $edge eq '*/') {
1113 $in_comment = 1;
1114 }
1115
1116 # Guestimate if this is a continuing comment. If this
1117 # is the start of a diff block and this line starts
1118 # ' *' then it is very likely a comment.
1119 if (!defined $edge &&
1120 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1121 {
1122 $in_comment = 1;
1123 }
1124
1125 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1126 sanitise_line_reset($in_comment);
1127
1128 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1129 # Standardise the strings and chars within the input to
1130 # simplify matching -- only bother with positive lines.
1131 $line = sanitise_line($rawline);
1132 }
1133 push(@lines, $line);
1134
1135 if ($realcnt > 1) {
1136 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1137 } else {
1138 $realcnt = 0;
1139 }
1140
1141 #print "==>$rawline\n";
1142 #print "-->$line\n";
1143
1144 if ($setup_docs && $line =~ /^\+/) {
1145 push(@setup_docs, $line);
1146 }
1147 }
1148
1149 $prefix = '';
1150
1151 $realcnt = 0;
1152 $linenr = 0;
1153 foreach my $line (@lines) {
1154 $linenr++;
1155
1156 my $rawline = $rawlines[$linenr - 1];
1157 my $hunk_line = ($realcnt != 0);
1158
1159 #extract the line range in the file after the patch is applied
1160 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1161 $is_patch = 1;
1162 $first_line = $linenr + 1;
1163 $realline=$1-1;
1164 if (defined $2) {
1165 $realcnt=$3+1;
1166 } else {
1167 $realcnt=1+1;
1168 }
1169 annotate_reset();
1170 $prev_values = 'E';
1171
1172 %suppress_ifbraces = ();
1173 %suppress_whiletrailers = ();
1174 next;
1175
1176 # track the line number as we move through the hunk, note that
1177 # new versions of GNU diff omit the leading space on completely
1178 # blank context lines so we need to count that too.
1179 } elsif ($line =~ /^( |\+|$)/) {
1180 $realline++;
1181 $realcnt-- if ($realcnt != 0);
1182
1183 # Measure the line length and indent.
1184 ($length, $indent) = line_stats($rawline);
1185
1186 # Track the previous line.
1187 ($prevline, $stashline) = ($stashline, $line);
1188 ($previndent, $stashindent) = ($stashindent, $indent);
1189 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1190
1191 #warn "line<$line>\n";
1192
1193 } elsif ($realcnt == 1) {
1194 $realcnt--;
1195 }
1196
1197 #make up the handle for any error we report on this line
1198 $prefix = "$filename:$realline: " if ($emacs && $file);
1199 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1200
1201 $here = "#$linenr: " if (!$file);
1202 $here = "#$realline: " if ($file);
1203
1204 # extract the filename as it passes
1205 if ($line=~/^\+\+\+\s+(\S+)/) {
1206 $realfile = $1;
1207 $realfile =~ s@^[^/]*/@@;
1208
1209 if ($realfile =~ m@^include/asm/@) {
1210 ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1211 }
1212 next;
1213 }
1214
1215 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
1216
1217 my $hereline = "$here\n$rawline\n";
1218 my $herecurr = "$here\n$rawline\n";
1219 my $hereprev = "$here\n$prevrawline\n$rawline\n";
1220
1221 $cnt_lines++ if ($realcnt != 0);
1222
1223 #check the patch for a signoff:
1224 if ($line =~ /^\s*signed-off-by:/i) {
1225 # This is a signoff, if ugly, so do not double report.
1226 $signoff++;
1227 if (!($line =~ /^\s*Signed-off-by:/)) {
1228 WARN("Signed-off-by: is the preferred form\n" .
1229 $herecurr);
1230 }
1231 if ($line =~ /^\s*signed-off-by:\S/i) {
1232 WARN("space required after Signed-off-by:\n" .
1233 $herecurr);
1234 }
1235 }
1236
1237 # Check for wrappage within a valid hunk of the file
1238 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1239 ERROR("patch seems to be corrupt (line wrapped?)\n" .
1240 $herecurr) if (!$emitted_corrupt++);
1241 }
1242
1243 # Check for absolute kernel paths.
1244 if ($tree) {
1245 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1246 my $file = $1;
1247
1248 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1249 check_absolute_file($1, $herecurr)) {
1250 #
1251 } else {
1252 check_absolute_file($file, $herecurr);
1253 }
1254 }
1255 }
1256
1257 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1258 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1259 $rawline !~ m/^$UTF8*$/) {
1260 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1261
1262 my $blank = copy_spacing($rawline);
1263 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1264 my $hereptr = "$hereline$ptr\n";
1265
1266 ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1267 }
1268
1269 # ignore non-hunk lines and lines being removed
1270 next if (!$hunk_line || $line =~ /^-/);
1271
1272 #trailing whitespace
1273 if ($line =~ /^\+.*\015/) {
1274 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1275 ERROR("DOS line endings\n" . $herevet);
1276
1277 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1278 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1279 ERROR("trailing whitespace\n" . $herevet);
1280 }
1281
1282 # check we are in a valid source file if not then ignore this hunk
1283 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1284
1285 #80 column limit
1286 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
1287 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1288 $line !~ /^\+\s*printk\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ &&
1289 $length > 80)
1290 {
1291 WARN("line over 80 characters\n" . $herecurr);
1292 }
1293
1294 # check for adding lines without a newline.
1295 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1296 WARN("adding a line without newline at end of file\n" . $herecurr);
1297 }
1298
1299 # check we are in a valid source file C or perl if not then ignore this hunk
1300 next if ($realfile !~ /\.(h|c|pl)$/);
1301
1302 # at the beginning of a line any tabs must come first and anything
1303 # more than 8 must use tabs.
1304 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1305 $rawline =~ /^\+\s* \s*/) {
1306 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1307 ERROR("code indent should use tabs where possible\n" . $herevet);
1308 }
1309
1310 # check we are in a valid C source file if not then ignore this hunk
1311 next if ($realfile !~ /\.(h|c)$/);
1312
1313 # check for RCS/CVS revision markers
1314 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
1315 WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1316 }
1317
1318 # Check for potential 'bare' types
1319 my ($stat, $cond, $line_nr_next, $remain_next, $off_next);
1320 if ($realcnt && $line =~ /.\s*\S/) {
1321 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
1322 ctx_statement_block($linenr, $realcnt, 0);
1323 $stat =~ s/\n./\n /g;
1324 $cond =~ s/\n./\n /g;
1325
1326 my $s = $stat;
1327 $s =~ s/{.*$//s;
1328
1329 # Ignore goto labels.
1330 if ($s =~ /$Ident:\*$/s) {
1331
1332 # Ignore functions being called
1333 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
1334
1335 # declarations always start with types
1336 } 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) {
1337 my $type = $1;
1338 $type =~ s/\s+/ /g;
1339 possible($type, "A:" . $s);
1340
1341 # definitions in global scope can only start with types
1342 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
1343 possible($1, "B:" . $s);
1344 }
1345
1346 # any (foo ... *) is a pointer cast, and foo is a type
1347 while ($s =~ /\(($Ident)(?:\s+$Sparse)*\s*\*+\s*\)/sg) {
1348 possible($1, "C:" . $s);
1349 }
1350
1351 # Check for any sort of function declaration.
1352 # int foo(something bar, other baz);
1353 # void (*store_gdt)(x86_descr_ptr *);
1354 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
1355 my ($name_len) = length($1);
1356
1357 my $ctx = $s;
1358 substr($ctx, 0, $name_len + 1, '');
1359 $ctx =~ s/\)[^\)]*$//;
1360
1361 for my $arg (split(/\s*,\s*/, $ctx)) {
1362 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
1363
1364 possible($1, "D:" . $s);
1365 }
1366 }
1367 }
1368
1369 }
1370
1371 #
1372 # Checks which may be anchored in the context.
1373 #
1374
1375 # Check for switch () and associated case and default
1376 # statements should be at the same indent.
1377 if ($line=~/\bswitch\s*\(.*\)/) {
1378 my $err = '';
1379 my $sep = '';
1380 my @ctx = ctx_block_outer($linenr, $realcnt);
1381 shift(@ctx);
1382 for my $ctx (@ctx) {
1383 my ($clen, $cindent) = line_stats($ctx);
1384 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1385 $indent != $cindent) {
1386 $err .= "$sep$ctx\n";
1387 $sep = '';
1388 } else {
1389 $sep = "[...]\n";
1390 }
1391 }
1392 if ($err ne '') {
1393 ERROR("switch and case should be at the same indent\n$hereline$err");
1394 }
1395 }
1396
1397 # if/while/etc brace do not go on next line, unless defining a do while loop,
1398 # or if that brace on the next line is for something else
1399 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
1400 my $pre_ctx = "$1$2";
1401
1402 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
1403 my $ctx_cnt = $realcnt - $#ctx - 1;
1404 my $ctx = join("\n", @ctx);
1405
1406 my $ctx_ln = $linenr;
1407 my $ctx_skip = $realcnt;
1408
1409 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1410 defined $lines[$ctx_ln - 1] &&
1411 $lines[$ctx_ln - 1] =~ /^-/)) {
1412 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1413 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
1414 $ctx_ln++;
1415 }
1416
1417 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1418 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
1419
1420 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1421 ERROR("that open brace { should be on the previous line\n" .
1422 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1423 }
1424 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1425 $ctx =~ /\)\s*\;\s*$/ &&
1426 defined $lines[$ctx_ln - 1])
1427 {
1428 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1429 if ($nindent > $indent) {
1430 WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
1431 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1432 }
1433 }
1434 }
1435
1436 # Check relative indent for conditionals and blocks.
1437 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1438 my ($s, $c) = ($stat, $cond);
1439
1440 substr($s, 0, length($c), '');
1441
1442 # Make sure we remove the line prefixes as we have
1443 # none on the first line, and are going to readd them
1444 # where necessary.
1445 $s =~ s/\n./\n/gs;
1446
1447 # Find out how long the conditional actually is.
1448 my @newlines = ($c =~ /\n/gs);
1449 my $cond_lines = 1 + $#newlines;
1450
1451 # We want to check the first line inside the block
1452 # starting at the end of the conditional, so remove:
1453 # 1) any blank line termination
1454 # 2) any opening brace { on end of the line
1455 # 3) any do (...) {
1456 my $continuation = 0;
1457 my $check = 0;
1458 $s =~ s/^.*\bdo\b//;
1459 $s =~ s/^\s*{//;
1460 if ($s =~ s/^\s*\\//) {
1461 $continuation = 1;
1462 }
1463 if ($s =~ s/^\s*?\n//) {
1464 $check = 1;
1465 $cond_lines++;
1466 }
1467
1468 # Also ignore a loop construct at the end of a
1469 # preprocessor statement.
1470 if (($prevline =~ /^.\s*#\s*define\s/ ||
1471 $prevline =~ /\\\s*$/) && $continuation == 0) {
1472 $check = 0;
1473 }
1474
1475 my $cond_ptr = -1;
1476 $continuation = 0;
1477 while ($cond_ptr != $cond_lines) {
1478 $cond_ptr = $cond_lines;
1479
1480 # If we see an #else/#elif then the code
1481 # is not linear.
1482 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
1483 $check = 0;
1484 }
1485
1486 # Ignore:
1487 # 1) blank lines, they should be at 0,
1488 # 2) preprocessor lines, and
1489 # 3) labels.
1490 if ($continuation ||
1491 $s =~ /^\s*?\n/ ||
1492 $s =~ /^\s*#\s*?/ ||
1493 $s =~ /^\s*$Ident\s*:/) {
1494 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
1495 $s =~ s/^.*?\n//;
1496 $cond_lines++;
1497 }
1498 }
1499
1500 my (undef, $sindent) = line_stats("+" . $s);
1501 my $stat_real = raw_line($linenr, $cond_lines);
1502
1503 # Check if either of these lines are modified, else
1504 # this is not this patch's fault.
1505 if (!defined($stat_real) ||
1506 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
1507 $check = 0;
1508 }
1509 if (defined($stat_real) && $cond_lines > 1) {
1510 $stat_real = "[...]\n$stat_real";
1511 }
1512
1513 #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";
1514
1515 if ($check && (($sindent % 8) != 0 ||
1516 ($sindent <= $indent && $s ne ''))) {
1517 WARN("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
1518 }
1519 }
1520
1521 # Track the 'values' across context and added lines.
1522 my $opline = $line; $opline =~ s/^./ /;
1523 my ($curr_values, $curr_vars) =
1524 annotate_values($opline . "\n", $prev_values);
1525 $curr_values = $prev_values . $curr_values;
1526 if ($dbg_values) {
1527 my $outline = $opline; $outline =~ s/\t/ /g;
1528 print "$linenr > .$outline\n";
1529 print "$linenr > $curr_values\n";
1530 print "$linenr > $curr_vars\n";
1531 }
1532 $prev_values = substr($curr_values, -1);
1533
1534 #ignore lines not being added
1535 if ($line=~/^[^\+]/) {next;}
1536
1537 # TEST: allow direct testing of the type matcher.
1538 if ($dbg_type) {
1539 if ($line =~ /^.\s*$Declare\s*$/) {
1540 ERROR("TEST: is type\n" . $herecurr);
1541 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
1542 ERROR("TEST: is not type ($1 is)\n". $herecurr);
1543 }
1544 next;
1545 }
1546 # TEST: allow direct testing of the attribute matcher.
1547 if ($dbg_attr) {
1548 if ($line =~ /^.\s*$Attribute\s*$/) {
1549 ERROR("TEST: is attr\n" . $herecurr);
1550 } elsif ($dbg_attr > 1 && $line =~ /^.+($Attribute)/) {
1551 ERROR("TEST: is not attr ($1 is)\n". $herecurr);
1552 }
1553 next;
1554 }
1555
1556 # check for initialisation to aggregates open brace on the next line
1557 if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ &&
1558 $line =~ /^.\s*{/) {
1559 ERROR("that open brace { should be on the previous line\n" . $hereprev);
1560 }
1561
1562 #
1563 # Checks which are anchored on the added line.
1564 #
1565
1566 # check for malformed paths in #include statements (uses RAW line)
1567 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
1568 my $path = $1;
1569 if ($path =~ m{//}) {
1570 ERROR("malformed #include filename\n" .
1571 $herecurr);
1572 }
1573 }
1574
1575 # no C99 // comments
1576 if ($line =~ m{//}) {
1577 ERROR("do not use C99 // comments\n" . $herecurr);
1578 }
1579 # Remove C99 comments.
1580 $line =~ s@//.*@@;
1581 $opline =~ s@//.*@@;
1582
1583 #EXPORT_SYMBOL should immediately follow its function closing }.
1584 if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) ||
1585 ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1586 my $name = $1;
1587 if ($prevline !~ /(?:
1588 ^.}|
1589 ^.DEFINE_$Ident\(\Q$name\E\)|
1590 ^.DECLARE_$Ident\(\Q$name\E\)|
1591 ^.LIST_HEAD\(\Q$name\E\)|
1592 ^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
1593 \b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[)
1594 )/x) {
1595 WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
1596 }
1597 }
1598
1599 # check for external initialisers.
1600 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
1601 ERROR("do not initialise externals to 0 or NULL\n" .
1602 $herecurr);
1603 }
1604 # check for static initialisers.
1605 if ($line =~ /\s*static\s.*=\s*(0|NULL|false)\s*;/) {
1606 ERROR("do not initialise statics to 0 or NULL\n" .
1607 $herecurr);
1608 }
1609
1610 # check for new typedefs, only function parameters and sparse annotations
1611 # make sense.
1612 if ($line =~ /\btypedef\s/ &&
1613 $line !~ /\btypedef\s+$Type\s+\(\s*\*?$Ident\s*\)\s*\(/ &&
1614 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
1615 $line !~ /\b$typeTypedefs\b/ &&
1616 $line !~ /\b__bitwise(?:__|)\b/) {
1617 WARN("do not add new typedefs\n" . $herecurr);
1618 }
1619
1620 # * goes on variable not on type
1621 if ($line =~ m{\($NonptrType(\*+)(?:\s+const)?\)}) {
1622 ERROR("\"(foo$1)\" should be \"(foo $1)\"\n" .
1623 $herecurr);
1624
1625 } elsif ($line =~ m{\($NonptrType\s+(\*+)(?!\s+const)\s+\)}) {
1626 ERROR("\"(foo $1 )\" should be \"(foo $1)\"\n" .
1627 $herecurr);
1628
1629 } elsif ($line =~ m{\b$NonptrType(\*+)(?:\s+(?:$Attribute|$Sparse))?\s+[A-Za-z\d_]+}) {
1630 ERROR("\"foo$1 bar\" should be \"foo $1bar\"\n" .
1631 $herecurr);
1632
1633 } elsif ($line =~ m{\b$NonptrType\s+(\*+)(?!\s+(?:$Attribute|$Sparse))\s+[A-Za-z\d_]+}) {
1634 ERROR("\"foo $1 bar\" should be \"foo $1bar\"\n" .
1635 $herecurr);
1636 }
1637
1638 # # no BUG() or BUG_ON()
1639 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
1640 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
1641 # print "$herecurr";
1642 # $clean = 0;
1643 # }
1644
1645 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
1646 WARN("LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
1647 }
1648
1649 # printk should use KERN_* levels. Note that follow on printk's on the
1650 # same line do not need a level, so we use the current block context
1651 # to try and find and validate the current printk. In summary the current
1652 # printk includes all preceeding printk's which have no newline on the end.
1653 # we assume the first bad printk is the one to report.
1654 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
1655 my $ok = 0;
1656 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
1657 #print "CHECK<$lines[$ln - 1]\n";
1658 # we have a preceeding printk if it ends
1659 # with "\n" ignore it, else it is to blame
1660 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
1661 if ($rawlines[$ln - 1] !~ m{\\n"}) {
1662 $ok = 1;
1663 }
1664 last;
1665 }
1666 }
1667 if ($ok == 0) {
1668 WARN("printk() should include KERN_ facility level\n" . $herecurr);
1669 }
1670 }
1671
1672 # function brace can't be on same line, except for #defines of do while,
1673 # or if closed on same line
1674 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
1675 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
1676 ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
1677 }
1678
1679 # open braces for enum, union and struct go on the same line.
1680 if ($line =~ /^.\s*{/ &&
1681 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1682 ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
1683 }
1684
1685 # check for spacing round square brackets; allowed:
1686 # 1. with a type on the left -- int [] a;
1687 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
1688 # 3. inside a curly brace -- = { [0...10] = 5 }
1689 while ($line =~ /(.*?\s)\[/g) {
1690 my ($where, $prefix) = ($-[1], $1);
1691 if ($prefix !~ /$Type\s+$/ &&
1692 ($where != 0 || $prefix !~ /^.\s+$/) &&
1693 $prefix !~ /{\s+$/) {
1694 ERROR("space prohibited before open square bracket '['\n" . $herecurr);
1695 }
1696 }
1697
1698 # check for spaces between functions and their parentheses.
1699 while ($line =~ /($Ident)\s+\(/g) {
1700 my $name = $1;
1701 my $ctx_before = substr($line, 0, $-[1]);
1702 my $ctx = "$ctx_before$name";
1703
1704 # Ignore those directives where spaces _are_ permitted.
1705 if ($name =~ /^(?:
1706 if|for|while|switch|return|case|
1707 volatile|__volatile__|
1708 __attribute__|format|__extension__|
1709 asm|__asm__)$/x)
1710 {
1711
1712 # cpp #define statements have non-optional spaces, ie
1713 # if there is a space between the name and the open
1714 # parenthesis it is simply not a parameter group.
1715 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
1716
1717 # cpp #elif statement condition may start with a (
1718 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
1719
1720 # If this whole things ends with a type its most
1721 # likely a typedef for a function.
1722 } elsif ($ctx =~ /$Type$/) {
1723
1724 } else {
1725 WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
1726 }
1727 }
1728 # Check operator spacing.
1729 if (!($line=~/\#\s*include/)) {
1730 my $ops = qr{
1731 <<=|>>=|<=|>=|==|!=|
1732 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
1733 =>|->|<<|>>|<|>|=|!|~|
1734 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
1735 \?|:
1736 }x;
1737 my @elements = split(/($ops|;)/, $opline);
1738 my $off = 0;
1739
1740 my $blank = copy_spacing($opline);
1741
1742 for (my $n = 0; $n < $#elements; $n += 2) {
1743 $off += length($elements[$n]);
1744
1745 # Pick up the preceeding and succeeding characters.
1746 my $ca = substr($opline, 0, $off);
1747 my $cc = '';
1748 if (length($opline) >= ($off + length($elements[$n + 1]))) {
1749 $cc = substr($opline, $off + length($elements[$n + 1]));
1750 }
1751 my $cb = "$ca$;$cc";
1752
1753 my $a = '';
1754 $a = 'V' if ($elements[$n] ne '');
1755 $a = 'W' if ($elements[$n] =~ /\s$/);
1756 $a = 'C' if ($elements[$n] =~ /$;$/);
1757 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
1758 $a = 'O' if ($elements[$n] eq '');
1759 $a = 'E' if ($ca =~ /^\s*$/);
1760
1761 my $op = $elements[$n + 1];
1762
1763 my $c = '';
1764 if (defined $elements[$n + 2]) {
1765 $c = 'V' if ($elements[$n + 2] ne '');
1766 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
1767 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
1768 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
1769 $c = 'O' if ($elements[$n + 2] eq '');
1770 $c = 'E' if ($elements[$n + 2] =~ /\s*\\$/);
1771 } else {
1772 $c = 'E';
1773 }
1774
1775 my $ctx = "${a}x${c}";
1776
1777 my $at = "(ctx:$ctx)";
1778
1779 my $ptr = substr($blank, 0, $off) . "^";
1780 my $hereptr = "$hereline$ptr\n";
1781
1782 # Pull out the value of this operator.
1783 my $op_type = substr($curr_values, $off + 1, 1);
1784
1785 # Get the full operator variant.
1786 my $opv = $op . substr($curr_vars, $off, 1);
1787
1788 # Ignore operators passed as parameters.
1789 if ($op_type ne 'V' &&
1790 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
1791
1792 # # Ignore comments
1793 # } elsif ($op =~ /^$;+$/) {
1794
1795 # ; should have either the end of line or a space or \ after it
1796 } elsif ($op eq ';') {
1797 if ($ctx !~ /.x[WEBC]/ &&
1798 $cc !~ /^\\/ && $cc !~ /^;/) {
1799 ERROR("space required after that '$op' $at\n" . $hereptr);
1800 }
1801
1802 # // is a comment
1803 } elsif ($op eq '//') {
1804
1805 # No spaces for:
1806 # ->
1807 # : when part of a bitfield
1808 } elsif ($op eq '->' || $opv eq ':B') {
1809 if ($ctx =~ /Wx.|.xW/) {
1810 ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
1811 }
1812
1813 # , must have a space on the right.
1814 } elsif ($op eq ',') {
1815 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
1816 ERROR("space required after that '$op' $at\n" . $hereptr);
1817 }
1818
1819 # '*' as part of a type definition -- reported already.
1820 } elsif ($opv eq '*_') {
1821 #warn "'*' is part of type\n";
1822
1823 # unary operators should have a space before and
1824 # none after. May be left adjacent to another
1825 # unary operator, or a cast
1826 } elsif ($op eq '!' || $op eq '~' ||
1827 $opv eq '*U' || $opv eq '-U' ||
1828 $opv eq '&U' || $opv eq '&&U') {
1829 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
1830 ERROR("space required before that '$op' $at\n" . $hereptr);
1831 }
1832 if ($op eq '*' && $cc =~/\s*const\b/) {
1833 # A unary '*' may be const
1834
1835 } elsif ($ctx =~ /.xW/) {
1836 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1837 }
1838
1839 # unary ++ and unary -- are allowed no space on one side.
1840 } elsif ($op eq '++' or $op eq '--') {
1841 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
1842 ERROR("space required one side of that '$op' $at\n" . $hereptr);
1843 }
1844 if ($ctx =~ /Wx[BE]/ ||
1845 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
1846 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
1847 }
1848 if ($ctx =~ /ExW/) {
1849 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1850 }
1851
1852
1853 # << and >> may either have or not have spaces both sides
1854 } elsif ($op eq '<<' or $op eq '>>' or
1855 $op eq '&' or $op eq '^' or $op eq '|' or
1856 $op eq '+' or $op eq '-' or
1857 $op eq '*' or $op eq '/' or
1858 $op eq '%')
1859 {
1860 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
1861 ERROR("need consistent spacing around '$op' $at\n" .
1862 $hereptr);
1863 }
1864
1865 # A colon needs no spaces before when it is
1866 # terminating a case value or a label.
1867 } elsif ($opv eq ':C' || $opv eq ':L') {
1868 if ($ctx =~ /Wx./) {
1869 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
1870 }
1871
1872 # All the others need spaces both sides.
1873 } elsif ($ctx !~ /[EWC]x[CWE]/) {
1874 my $ok = 0;
1875
1876 # Ignore email addresses <foo@bar>
1877 if (($op eq '<' &&
1878 $cc =~ /^\S+\@\S+>/) ||
1879 ($op eq '>' &&
1880 $ca =~ /<\S+\@\S+$/))
1881 {
1882 $ok = 1;
1883 }
1884
1885 # Ignore ?:
1886 if (($opv eq ':O' && $ca =~ /\?$/) ||
1887 ($op eq '?' && $cc =~ /^:/)) {
1888 $ok = 1;
1889 }
1890
1891 if ($ok == 0) {
1892 ERROR("spaces required around that '$op' $at\n" . $hereptr);
1893 }
1894 }
1895 $off += length($elements[$n + 1]);
1896 }
1897 }
1898
1899 # check for multiple assignments
1900 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
1901 CHK("multiple assignments should be avoided\n" . $herecurr);
1902 }
1903
1904 ## # check for multiple declarations, allowing for a function declaration
1905 ## # continuation.
1906 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
1907 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
1908 ##
1909 ## # Remove any bracketed sections to ensure we do not
1910 ## # falsly report the parameters of functions.
1911 ## my $ln = $line;
1912 ## while ($ln =~ s/\([^\(\)]*\)//g) {
1913 ## }
1914 ## if ($ln =~ /,/) {
1915 ## WARN("declaring multiple variables together should be avoided\n" . $herecurr);
1916 ## }
1917 ## }
1918
1919 #need space before brace following if, while, etc
1920 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
1921 $line =~ /do{/) {
1922 ERROR("space required before the open brace '{'\n" . $herecurr);
1923 }
1924
1925 # closing brace should have a space following it when it has anything
1926 # on the line
1927 if ($line =~ /}(?!(?:,|;|\)))\S/) {
1928 ERROR("space required after that close brace '}'\n" . $herecurr);
1929 }
1930
1931 # check spacing on square brackets
1932 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
1933 ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
1934 }
1935 if ($line =~ /\s\]/) {
1936 ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
1937 }
1938
1939 # check spacing on parentheses
1940 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
1941 $line !~ /for\s*\(\s+;/) {
1942 ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
1943 }
1944 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
1945 $line !~ /for\s*\(.*;\s+\)/ &&
1946 $line !~ /:\s+\)/) {
1947 ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
1948 }
1949
1950 #goto labels aren't indented, allow a single space however
1951 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
1952 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
1953 WARN("labels should not be indented\n" . $herecurr);
1954 }
1955
1956 # Return is not a function.
1957 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
1958 my $spacing = $1;
1959 my $value = $2;
1960
1961 # Flatten any parentheses and braces
1962 $value =~ s/\)\(/\) \(/g;
1963 while ($value =~ s/\([^\(\)]*\)/1/) {
1964 }
1965
1966 if ($value =~ /^(?:$Ident|-?$Constant)$/) {
1967 ERROR("return is not a function, parentheses are not required\n" . $herecurr);
1968
1969 } elsif ($spacing !~ /\s+/) {
1970 ERROR("space required before the open parenthesis '('\n" . $herecurr);
1971 }
1972 }
1973
1974 # Need a space before open parenthesis after if, while etc
1975 if ($line=~/\b(if|while|for|switch)\(/) {
1976 ERROR("space required before the open parenthesis '('\n" . $herecurr);
1977 }
1978
1979 # Check for illegal assignment in if conditional -- and check for trailing
1980 # statements after the conditional.
1981 if ($line =~ /do\s*(?!{)/) {
1982 my ($stat_next) = ctx_statement_block($line_nr_next,
1983 $remain_next, $off_next);
1984 $stat_next =~ s/\n./\n /g;
1985 ##print "stat<$stat> stat_next<$stat_next>\n";
1986
1987 if ($stat_next =~ /^\s*while\b/) {
1988 # If the statement carries leading newlines,
1989 # then count those as offsets.
1990 my ($whitespace) =
1991 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
1992 my $offset =
1993 statement_rawlines($whitespace) - 1;
1994
1995 $suppress_whiletrailers{$line_nr_next +
1996 $offset} = 1;
1997 }
1998 }
1999 if (!defined $suppress_whiletrailers{$linenr} &&
2000 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
2001 my ($s, $c) = ($stat, $cond);
2002
2003 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/) {
2004 ERROR("do not use assignment in if condition\n" . $herecurr);
2005 }
2006
2007 # Find out what is on the end of the line after the
2008 # conditional.
2009 substr($s, 0, length($c), '');
2010 $s =~ s/\n.*//g;
2011 $s =~ s/$;//g; # Remove any comments
2012 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2013 $c !~ /}\s*while\s*/)
2014 {
2015 # Find out how long the conditional actually is.
2016 my @newlines = ($c =~ /\n/gs);
2017 my $cond_lines = 1 + $#newlines;
2018
2019 my $stat_real = raw_line($linenr, $cond_lines);
2020 if (defined($stat_real) && $cond_lines > 1) {
2021 $stat_real = "[...]\n$stat_real";
2022 }
2023
2024 ERROR("trailing statements should be on next line\n" . $herecurr . $stat_real);
2025 }
2026 }
2027
2028 # Check for bitwise tests written as boolean
2029 if ($line =~ /
2030 (?:
2031 (?:\[|\(|\&\&|\|\|)
2032 \s*0[xX][0-9]+\s*
2033 (?:\&\&|\|\|)
2034 |
2035 (?:\&\&|\|\|)
2036 \s*0[xX][0-9]+\s*
2037 (?:\&\&|\|\||\)|\])
2038 )/x)
2039 {
2040 WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2041 }
2042
2043 # if and else should not have general statements after it
2044 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2045 my $s = $1;
2046 $s =~ s/$;//g; # Remove any comments
2047 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2048 ERROR("trailing statements should be on next line\n" . $herecurr);
2049 }
2050 }
2051 # case and default should not have general statements after them
2052 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2053 $line !~ /\G(?:
2054 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
2055 \s*return\s+
2056 )/xg)
2057 {
2058 ERROR("trailing statements should be on next line\n" . $herecurr);
2059 }
2060
2061 # Check for }<nl>else {, these must be at the same
2062 # indent level to be relevant to each other.
2063 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2064 $previndent == $indent) {
2065 ERROR("else should follow close brace '}'\n" . $hereprev);
2066 }
2067
2068 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2069 $previndent == $indent) {
2070 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2071
2072 # Find out what is on the end of the line after the
2073 # conditional.
2074 substr($s, 0, length($c), '');
2075 $s =~ s/\n.*//g;
2076
2077 if ($s =~ /^\s*;/) {
2078 ERROR("while should follow close brace '}'\n" . $hereprev);
2079 }
2080 }
2081
2082 #studly caps, commented out until figure out how to distinguish between use of existing and adding new
2083 # if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2084 # print "No studly caps, use _\n";
2085 # print "$herecurr";
2086 # $clean = 0;
2087 # }
2088
2089 #no spaces allowed after \ in define
2090 if ($line=~/\#\s*define.*\\\s$/) {
2091 WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
2092 }
2093
2094 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
2095 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
2096 my $file = "$1.h";
2097 my $checkfile = "include/linux/$file";
2098 if (-f "$root/$checkfile" &&
2099 $realfile ne $checkfile &&
2100 $1 ne 'irq')
2101 {
2102 if ($realfile =~ m{^arch/}) {
2103 CHK("Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2104 } else {
2105 WARN("Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2106 }
2107 }
2108 }
2109
2110 # multi-statement macros should be enclosed in a do while loop, grab the
2111 # first statement and ensure its the whole macro if its not enclosed
2112 # in a known good container
2113 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2114 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
2115 my $ln = $linenr;
2116 my $cnt = $realcnt;
2117 my ($off, $dstat, $dcond, $rest);
2118 my $ctx = '';
2119
2120 my $args = defined($1);
2121
2122 # Find the end of the macro and limit our statement
2123 # search to that.
2124 while ($cnt > 0 && defined $lines[$ln - 1] &&
2125 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
2126 {
2127 $ctx .= $rawlines[$ln - 1] . "\n";
2128 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2129 $ln++;
2130 }
2131 $ctx .= $rawlines[$ln - 1];
2132
2133 ($dstat, $dcond, $ln, $cnt, $off) =
2134 ctx_statement_block($linenr, $ln - $linenr + 1, 0);
2135 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
2136 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
2137
2138 # Extract the remainder of the define (if any) and
2139 # rip off surrounding spaces, and trailing \'s.
2140 $rest = '';
2141 while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
2142 #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
2143 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
2144 $rest .= substr($lines[$ln - 1], $off) . "\n";
2145 $cnt--;
2146 }
2147 $ln++;
2148 $off = 0;
2149 }
2150 $rest =~ s/\\\n.//g;
2151 $rest =~ s/^\s*//s;
2152 $rest =~ s/\s*$//s;
2153
2154 # Clean up the original statement.
2155 if ($args) {
2156 substr($dstat, 0, length($dcond), '');
2157 } else {
2158 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
2159 }
2160 $dstat =~ s/$;//g;
2161 $dstat =~ s/\\\n.//g;
2162 $dstat =~ s/^\s*//s;
2163 $dstat =~ s/\s*$//s;
2164
2165 # Flatten any parentheses and braces
2166 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2167 $dstat =~ s/\{[^\{\}]*\}/1/ ||
2168 $dstat =~ s/\[[^\{\}]*\]/1/)
2169 {
2170 }
2171
2172 my $exceptions = qr{
2173 $Declare|
2174 module_param_named|
2175 MODULE_PARAM_DESC|
2176 DECLARE_PER_CPU|
2177 DEFINE_PER_CPU|
2178 __typeof__\(|
2179 \.$Ident\s*=\s*
2180 }x;
2181 #print "REST<$rest> dstat<$dstat>\n";
2182 if ($rest ne '') {
2183 if ($rest !~ /while\s*\(/ &&
2184 $dstat !~ /$exceptions/)
2185 {
2186 ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
2187 }
2188
2189 } elsif ($ctx !~ /;/) {
2190 if ($dstat ne '' &&
2191 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2192 $dstat !~ /$exceptions/ &&
2193 $dstat !~ /^\.$Ident\s*=/ &&
2194 $dstat =~ /$Operators/)
2195 {
2196 ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
2197 }
2198 }
2199 }
2200
2201 # check for redundant bracing round if etc
2202 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2203 my ($level, $endln, @chunks) =
2204 ctx_statement_full($linenr, $realcnt, 1);
2205 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
2206 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2207 if ($#chunks > 0 && $level == 0) {
2208 my $allowed = 0;
2209 my $seen = 0;
2210 my $herectx = $here . "\n";
2211 my $ln = $linenr - 1;
2212 for my $chunk (@chunks) {
2213 my ($cond, $block) = @{$chunk};
2214
2215 # If the condition carries leading newlines, then count those as offsets.
2216 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2217 my $offset = statement_rawlines($whitespace) - 1;
2218
2219 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2220
2221 # We have looked at and allowed this specific line.
2222 $suppress_ifbraces{$ln + $offset} = 1;
2223
2224 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
2225 $ln += statement_rawlines($block) - 1;
2226
2227 substr($block, 0, length($cond), '');
2228
2229 $seen++ if ($block =~ /^\s*{/);
2230
2231 #print "cond<$cond> block<$block> allowed<$allowed>\n";
2232 if (statement_lines($cond) > 1) {
2233 #print "APW: ALLOWED: cond<$cond>\n";
2234 $allowed = 1;
2235 }
2236 if ($block =~/\b(?:if|for|while)\b/) {
2237 #print "APW: ALLOWED: block<$block>\n";
2238 $allowed = 1;
2239 }
2240 if (statement_block_size($block) > 1) {
2241 #print "APW: ALLOWED: lines block<$block>\n";
2242 $allowed = 1;
2243 }
2244 }
2245 if ($seen && !$allowed) {
2246 WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
2247 }
2248 }
2249 }
2250 if (!defined $suppress_ifbraces{$linenr - 1} &&
2251 $line =~ /\b(if|while|for|else)\b/) {
2252 my $allowed = 0;
2253
2254 # Check the pre-context.
2255 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2256 #print "APW: ALLOWED: pre<$1>\n";
2257 $allowed = 1;
2258 }
2259
2260 my ($level, $endln, @chunks) =
2261 ctx_statement_full($linenr, $realcnt, $-[0]);
2262
2263 # Check the condition.
2264 my ($cond, $block) = @{$chunks[0]};
2265 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
2266 if (defined $cond) {
2267 substr($block, 0, length($cond), '');
2268 }
2269 if (statement_lines($cond) > 1) {
2270 #print "APW: ALLOWED: cond<$cond>\n";
2271 $allowed = 1;
2272 }
2273 if ($block =~/\b(?:if|for|while)\b/) {
2274 #print "APW: ALLOWED: block<$block>\n";
2275 $allowed = 1;
2276 }
2277 if (statement_block_size($block) > 1) {
2278 #print "APW: ALLOWED: lines block<$block>\n";
2279 $allowed = 1;
2280 }
2281 # Check the post-context.
2282 if (defined $chunks[1]) {
2283 my ($cond, $block) = @{$chunks[1]};
2284 if (defined $cond) {
2285 substr($block, 0, length($cond), '');
2286 }
2287 if ($block =~ /^\s*\{/) {
2288 #print "APW: ALLOWED: chunk-1 block<$block>\n";
2289 $allowed = 1;
2290 }
2291 }
2292 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
2293 my $herectx = $here . "\n";;
2294 my $cnt = statement_rawlines($block);
2295
2296 for (my $n = 0; $n < $cnt; $n++) {
2297 $herectx .= raw_line($linenr, $n) . "\n";;
2298 }
2299
2300 WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
2301 }
2302 }
2303
2304 # don't include deprecated include files (uses RAW line)
2305 for my $inc (@dep_includes) {
2306 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
2307 ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2308 }
2309 }
2310
2311 # don't use deprecated functions
2312 for my $func (@dep_functions) {
2313 if ($line =~ /\b$func\b/) {
2314 ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2315 }
2316 }
2317
2318 # no volatiles please
2319 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2320 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
2321 WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
2322 }
2323
2324 # SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
2325 if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
2326 ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
2327 }
2328
2329 # warn about #if 0
2330 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
2331 CHK("if this code is redundant consider removing it\n" .
2332 $herecurr);
2333 }
2334
2335 # check for needless kfree() checks
2336 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2337 my $expr = $1;
2338 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
2339 WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
2340 }
2341 }
2342 # check for needless usb_free_urb() checks
2343 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2344 my $expr = $1;
2345 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
2346 WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
2347 }
2348 }
2349
2350 # warn about #ifdefs in C files
2351 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
2352 # print "#ifdef in C files should be avoided\n";
2353 # print "$herecurr";
2354 # $clean = 0;
2355 # }
2356
2357 # warn about spacing in #ifdefs
2358 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
2359 ERROR("exactly one space required after that #$1\n" . $herecurr);
2360 }
2361
2362 # check for spinlock_t definitions without a comment.
2363 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
2364 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
2365 my $which = $1;
2366 if (!ctx_has_comment($first_line, $linenr)) {
2367 CHK("$1 definition without comment\n" . $herecurr);
2368 }
2369 }
2370 # check for memory barriers without a comment.
2371 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2372 if (!ctx_has_comment($first_line, $linenr)) {
2373 CHK("memory barrier without comment\n" . $herecurr);
2374 }
2375 }
2376 # check of hardware specific defines
2377 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
2378 CHK("architecture specific defines should be avoided\n" . $herecurr);
2379 }
2380
2381 # check the location of the inline attribute, that it is between
2382 # storage class and type.
2383 if ($line =~ /\b$Type\s+$Inline\b/ ||
2384 $line =~ /\b$Inline\s+$Storage\b/) {
2385 ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
2386 }
2387
2388 # Check for __inline__ and __inline, prefer inline
2389 if ($line =~ /\b(__inline__|__inline)\b/) {
2390 WARN("plain inline is preferred over $1\n" . $herecurr);
2391 }
2392
2393 # check for new externs in .c files.
2394 if ($realfile =~ /\.c$/ && defined $stat &&
2395 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
2396 {
2397 my $function_name = $1;
2398 my $paren_space = $2;
2399
2400 my $s = $stat;
2401 if (defined $cond) {
2402 substr($s, 0, length($cond), '');
2403 }
2404 if ($s =~ /^\s*;/ &&
2405 $function_name ne 'uninitialized_var')
2406 {
2407 WARN("externs should be avoided in .c files\n" . $herecurr);
2408 }
2409
2410 if ($paren_space =~ /\n/) {
2411 WARN("arguments for function declarations should follow identifier\n" . $herecurr);
2412 }
2413
2414 } elsif ($realfile =~ /\.c$/ && defined $stat &&
2415 $stat =~ /^.\s*extern\s+/)
2416 {
2417 WARN("externs should be avoided in .c files\n" . $herecurr);
2418 }
2419
2420 # checks for new __setup's
2421 if ($rawline =~ /\b__setup\("([^"]*)"/) {
2422 my $name = $1;
2423
2424 if (!grep(/$name/, @setup_docs)) {
2425 CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
2426 }
2427 }
2428
2429 # check for pointless casting of kmalloc return
2430 if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
2431 WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
2432 }
2433
2434 # check for gcc specific __FUNCTION__
2435 if ($line =~ /__FUNCTION__/) {
2436 WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
2437 }
2438
2439 # check for semaphores used as mutexes
2440 if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
2441 WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
2442 }
2443 # check for semaphores used as mutexes
2444 if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
2445 WARN("consider using a completion\n" . $herecurr);
2446 }
2447 # recommend strict_strto* over simple_strto*
2448 if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2449 WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
2450 }
2451 # check for __initcall(), use device_initcall() explicitly please
2452 if ($line =~ /^.\s*__initcall\s*\(/) {
2453 WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
2454 }
2455
2456 # use of NR_CPUS is usually wrong
2457 # ignore definitions of NR_CPUS and usage to define arrays as likely right
2458 if ($line =~ /\bNR_CPUS\b/ &&
2459 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
2460 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
2461 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
2462 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
2463 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
2464 {
2465 WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
2466 }
2467
2468 # check for %L{u,d,i} in strings
2469 my $string;
2470 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2471 $string = substr($rawline, $-[1], $+[1] - $-[1]);
2472 $string =~ s/%%/__/g;
2473 if ($string =~ /(?<!%)%L[udi]/) {
2474 WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2475 last;
2476 }
2477 }
2478
2479 # whine mightly about in_atomic
2480 if ($line =~ /\bin_atomic\s*\(/) {
2481 if ($realfile =~ m@^drivers/@) {
2482 ERROR("do not use in_atomic in drivers\n" . $herecurr);
2483 } else {
2484 WARN("use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
2485 }
2486 }
2487 }
2488
2489 # If we have no input at all, then there is nothing to report on
2490 # so just keep quiet.
2491 if ($#rawlines == -1) {
2492 exit(0);
2493 }
2494
2495 # In mailback mode only produce a report in the negative, for
2496 # things that appear to be patches.
2497 if ($mailback && ($clean == 1 || !$is_patch)) {
2498 exit(0);
2499 }
2500
2501 # This is not a patch, and we are are in 'no-patch' mode so
2502 # just keep quiet.
2503 if (!$chk_patch && !$is_patch) {
2504 exit(0);
2505 }
2506
2507 if (!$is_patch) {
2508 ERROR("Does not appear to be a unified-diff format patch\n");
2509 }
2510 if ($is_patch && $chk_signoff && $signoff == 0) {
2511 ERROR("Missing Signed-off-by: line(s)\n");
2512 }
2513
2514 print report_dump();
2515 if ($summary && !($clean == 1 && $quiet == 1)) {
2516 print "$filename " if ($summary_file);
2517 print "total: $cnt_error errors, $cnt_warn warnings, " .
2518 (($check)? "$cnt_chk checks, " : "") .
2519 "$cnt_lines lines checked\n";
2520 print "\n" if ($quiet == 0);
2521 }
2522
2523 if ($clean == 1 && $quiet == 0) {
2524 print "$vname has no obvious style problems and is ready for submission.\n"
2525 }
2526 if ($clean == 0 && $quiet == 0) {
2527 print "$vname has style problems, please review. If any of these errors\n";
2528 print "are false positives report them to the maintainer, see\n";
2529 print "CHECKPATCH in MAINTAINERS.\n";
2530 }
2531
2532 return $clean;
2533 }
This page took 0.159892 seconds and 5 git commands to generate.