Blame view
scripts/checkpatch.pl
41.8 KB
0a920b5b6
|
1 2 |
#!/usr/bin/perl -w # (c) 2001, Dave Jones. <davej@codemonkey.org.uk> (the file handling bit) |
00df344fd
|
3 |
# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit) |
0a920b5b6
|
4 5 6 7 8 9 |
# (c) 2007, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite, etc) # Licensed under the terms of the GNU GPL License version 2 use strict; my $P = $0; |
00df344fd
|
10 |
$P =~ s@.*/@@g; |
0a920b5b6
|
11 |
|
8905a67c6
|
12 |
my $V = '0.12'; |
0a920b5b6
|
13 14 15 16 17 18 19 |
use Getopt::Long qw(:config no_auto_abbrev); my $quiet = 0; my $tree = 1; my $chk_signoff = 1; my $chk_patch = 1; |
653d4876b
|
20 |
my $tst_type = 0; |
6c72ffaab
|
21 |
my $emacs = 0; |
8905a67c6
|
22 |
my $terse = 0; |
6c72ffaab
|
23 24 |
my $file = 0; my $check = 0; |
8905a67c6
|
25 26 |
my $summary = 1; my $mailback = 0; |
6c72ffaab
|
27 |
my $root; |
0a920b5b6
|
28 |
GetOptions( |
6c72ffaab
|
29 |
'q|quiet+' => \$quiet, |
0a920b5b6
|
30 31 32 |
'tree!' => \$tree, 'signoff!' => \$chk_signoff, 'patch!' => \$chk_patch, |
653d4876b
|
33 |
'test-type!' => \$tst_type, |
6c72ffaab
|
34 |
'emacs!' => \$emacs, |
8905a67c6
|
35 |
'terse!' => \$terse, |
6c72ffaab
|
36 37 38 39 |
'file!' => \$file, 'subjective!' => \$check, 'strict!' => \$check, 'root=s' => \$root, |
8905a67c6
|
40 41 |
'summary!' => \$summary, 'mailback!' => \$mailback, |
0a920b5b6
|
42 43 44 45 46 |
) or exit; my $exit = 0; if ($#ARGV < 0) { |
00df344fd
|
47 48 |
print "usage: $P [options] patchfile "; |
0a920b5b6
|
49 50 51 52 53 54 |
print "version: $V "; print "options: -q => quiet "; print " --no-tree => run without a kernel tree "; |
8905a67c6
|
55 56 |
print " --terse => one line per report "; |
6c72ffaab
|
57 58 59 60 61 62 63 64 |
print " --emacs => emacs compile window format "; print " --file => check a source file "; print " --strict => enable more subjective tests "; print " --root => path to the kernel tree root "; |
0a920b5b6
|
65 66 |
exit(1); } |
8905a67c6
|
67 68 69 70 |
if ($terse) { $emacs = 1; $quiet++; } |
6c72ffaab
|
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 |
if ($tree) { if (defined $root) { if (!top_of_kernel_tree($root)) { die "$P: $root: --root does not point at a valid tree "; } } else { if (top_of_kernel_tree('.')) { $root = '.'; } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && top_of_kernel_tree($1)) { $root = $1; } } if (!defined $root) { print "Must be run from the top-level dir. of a kernel tree "; exit(2); } |
0a920b5b6
|
91 |
} |
6c72ffaab
|
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 |
my $emitted_corrupt = 0; our $Ident = qr{[A-Za-z_][A-Za-z\d_]*}; our $Storage = qr{extern|static|asmlinkage}; our $Sparse = qr{ __user| __kernel| __force| __iomem| __must_check| __init_refok| __kprobes| fastcall }x; our $Attribute = qr{ const| __read_mostly| __kprobes| __(?:mem|cpu|dev|)(?:initdata|init) }x; our $Inline = qr{inline|__always_inline|noinline}; |
6c72ffaab
|
113 114 115 116 117 118 119 120 121 122 |
our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; our $Lval = qr{$Ident(?:$Member)*}; our $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*}; our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)}; our $Operators = qr{ <=|>=|==|!=| =>|->|<<|>>|<|>|!|~| &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/ }x; |
8905a67c6
|
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 |
our $NonptrType; our $Type; our $Declare; our @typeList = ( qr{void}, qr{char}, qr{short}, qr{int}, qr{long}, qr{unsigned}, qr{float}, qr{double}, qr{bool}, qr{long\s+int}, qr{long\s+long}, qr{long\s+long\s+int}, qr{(?:__)?(?:u|s|be|le)(?:8|16|32|64)}, qr{struct\s+$Ident}, qr{union\s+$Ident}, qr{enum\s+$Ident}, qr{${Ident}_t}, qr{${Ident}_handler}, qr{${Ident}_handler_fn}, ); sub build_types { my $all = "(?: " . join("| ", @typeList) . " )"; $NonptrType = qr{ \b (?:const\s+)? (?:unsigned\s+)? $all (?:\s+$Sparse|\s+const)* \b }x; $Type = qr{ \b$NonptrType\b (?:\s*\*+\s*const|\s*\*+|(?:\s*\[\s*\])+)? (?:\s+$Sparse|\s+$Attribute)* }x; $Declare = qr{(?:$Storage\s+)?$Type}; } build_types(); |
6c72ffaab
|
170 171 |
$chk_signoff = 0 if ($file); |
4a0df2ef4
|
172 173 |
my @dep_includes = (); my @dep_functions = (); |
6c72ffaab
|
174 175 176 177 178 |
my $removal = "Documentation/feature-removal-schedule.txt"; if ($tree && -f "$root/$removal") { open(REMOVE, "<$root/$removal") || die "$P: $removal: open failed - $! "; |
0a920b5b6
|
179 |
while (<REMOVE>) { |
f0a594c1c
|
180 181 182 |
if (/^Check:\s+(.*\S)/) { for my $entry (split(/[, ]+/, $1)) { if ($entry =~ m@include/(.*)@) { |
4a0df2ef4
|
183 |
push(@dep_includes, $1); |
4a0df2ef4
|
184 |
|
f0a594c1c
|
185 186 187 |
} elsif ($entry !~ m@/@) { push(@dep_functions, $entry); } |
4a0df2ef4
|
188 |
} |
0a920b5b6
|
189 190 191 |
} } } |
00df344fd
|
192 |
my @rawlines = (); |
6c72ffaab
|
193 194 195 196 197 198 199 200 201 |
for my $filename (@ARGV) { if ($file) { open(FILE, "diff -u /dev/null $filename|") || die "$P: $filename: diff failed - $! "; } else { open(FILE, "<$filename") || die "$P: $filename: open failed - $! "; |
0a920b5b6
|
202 |
} |
6c72ffaab
|
203 204 205 206 207 208 209 210 211 |
while (<FILE>) { chomp; push(@rawlines, $_); } close(FILE); if (!process($filename, @rawlines)) { $exit = 1; } @rawlines = (); |
0a920b5b6
|
212 213 214 215 216 |
} exit($exit); sub top_of_kernel_tree { |
6c72ffaab
|
217 218 219 220 221 222 223 224 225 226 227 228 |
my ($root) = @_; my @tree_check = ( "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", "README", "Documentation", "arch", "include", "drivers", "fs", "init", "ipc", "kernel", "lib", "scripts", ); foreach my $check (@tree_check) { if (! -e $root . '/' . $check) { return 0; } |
0a920b5b6
|
229 |
} |
6c72ffaab
|
230 |
return 1; |
0a920b5b6
|
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 |
} sub expand_tabs { my ($str) = @_; my $res = ''; my $n = 0; for my $c (split(//, $str)) { if ($c eq "\t") { $res .= ' '; $n++; for (; ($n % 8) != 0; $n++) { $res .= ' '; } next; } $res .= $c; $n++; } return $res; } |
6c72ffaab
|
253 254 255 256 257 258 259 260 261 262 263 264 265 266 |
sub copy_spacing { my ($str) = @_; my $res = ''; for my $c (split(//, $str)) { if ($c eq "\t") { $res .= $c; } else { $res .= ' '; } } return $res; } |
0a920b5b6
|
267 |
|
4a0df2ef4
|
268 269 270 271 272 273 274 275 276 277 278 279 |
sub line_stats { my ($line) = @_; # Drop the diff line leader and expand tabs $line =~ s/^.//; $line = expand_tabs($line); # Pick the indent from the front of the line. my ($white) = ($line =~ /^(\s*)/); return (length($line), length($white)); } |
00df344fd
|
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 |
sub sanitise_line { my ($line) = @_; my $res = ''; my $l = ''; my $quote = ''; foreach my $c (split(//, $line)) { if ($l ne "\\" && ($c eq "'" || $c eq '"')) { if ($quote eq '') { $quote = $c; $res .= $c; $l = $c; next; } elsif ($quote eq $c) { $quote = ''; } } if ($quote && $c ne "\t") { $res .= "X"; } else { $res .= $c; } $l = $c; } return $res; } |
8905a67c6
|
310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 |
sub ctx_statement_block { my ($linenr, $remain, $off) = @_; my $line = $linenr - 1; my $blk = ''; my $soff = $off; my $coff = $off - 1; my $type = ''; my $level = 0; my $c; my $len = 0; while (1) { #warn "CSB: blk<$blk> "; # If we are about to drop off the end, pull in more # context. if ($off >= $len) { for (; $remain > 0; $line++) { next if ($rawlines[$line] =~ /^-/); $remain--; $blk .= sanitise_line($rawlines[$line]) . " "; $len = length($blk); $line++; last; } # Bail if there is no further context. #warn "CSB: blk<$blk> off<$off> len<$len> "; if ($off == $len) { last; } } $c = substr($blk, $off, 1); #warn "CSB: c<$c> type<$type> level<$level> "; # Statement ends at the ';' or a close '}' at the # outermost level. if ($level == 0 && $c eq ';') { last; } if (($type eq '' || $type eq '(') && $c eq '(') { $level++; $type = '('; } if ($type eq '(' && $c eq ')') { $level--; $type = ($level != 0)? '(' : ''; if ($level == 0 && $coff < $soff) { $coff = $off; } } if (($type eq '' || $type eq '{') && $c eq '{') { $level++; $type = '{'; } if ($type eq '{' && $c eq '}') { $level--; $type = ($level != 0)? '{' : ''; if ($level == 0) { last; } } $off++; } my $statement = substr($blk, $soff, $off - $soff + 1); my $condition = substr($blk, $soff, $coff - $soff + 1); #warn "STATEMENT<$statement> "; #warn "CONDITION<$condition> "; return ($statement, $condition); } |
4a0df2ef4
|
390 |
sub ctx_block_get { |
f0a594c1c
|
391 |
my ($linenr, $remain, $outer, $open, $close, $off) = @_; |
4a0df2ef4
|
392 393 |
my $line; my $start = $linenr - 1; |
4a0df2ef4
|
394 395 396 397 |
my $blk = ''; my @o; my @c; my @res = (); |
f0a594c1c
|
398 |
my $level = 0; |
00df344fd
|
399 400 401 402 403 |
for ($line = $start; $remain > 0; $line++) { next if ($rawlines[$line] =~ /^-/); $remain--; $blk .= $rawlines[$line]; |
f0a594c1c
|
404 405 406 407 408 409 410 |
foreach my $c (split(//, $rawlines[$line])) { ##print "C<$c>L<$level><$open$close>O<$off> "; if ($off > 0) { $off--; next; } |
4a0df2ef4
|
411 |
|
f0a594c1c
|
412 413 414 415 416 417 418 |
if ($c eq $close && $level > 0) { $level--; last if ($level == 0); } elsif ($c eq $open) { $level++; } } |
4a0df2ef4
|
419 |
|
f0a594c1c
|
420 |
if (!$outer || $level <= 1) { |
00df344fd
|
421 |
push(@res, $rawlines[$line]); |
4a0df2ef4
|
422 |
} |
f0a594c1c
|
423 |
last if ($level == 0); |
4a0df2ef4
|
424 |
} |
f0a594c1c
|
425 |
return ($level, @res); |
4a0df2ef4
|
426 427 428 |
} sub ctx_block_outer { my ($linenr, $remain) = @_; |
f0a594c1c
|
429 430 |
my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); return @r; |
4a0df2ef4
|
431 432 433 |
} sub ctx_block { my ($linenr, $remain) = @_; |
f0a594c1c
|
434 435 |
my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); return @r; |
653d4876b
|
436 437 |
} sub ctx_statement { |
f0a594c1c
|
438 439 440 441 442 443 |
my ($linenr, $remain, $off) = @_; my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); return @r; } sub ctx_block_level { |
653d4876b
|
444 |
my ($linenr, $remain) = @_; |
f0a594c1c
|
445 |
return ctx_block_get($linenr, $remain, 0, '{', '}', 0); |
4a0df2ef4
|
446 |
} |
9c0ca6f9a
|
447 448 449 450 451 |
sub ctx_statement_level { my ($linenr, $remain, $off) = @_; return ctx_block_get($linenr, $remain, 0, '(', ')', $off); } |
4a0df2ef4
|
452 453 454 455 456 |
sub ctx_locate_comment { my ($first_line, $end_line) = @_; # Catch a comment on the end of the line itself. |
00df344fd
|
457 |
my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*$@); |
4a0df2ef4
|
458 459 460 461 462 463 464 |
return $current_comment if (defined $current_comment); # Look through the context and try and figure out if there is a # comment. my $in_comment = 0; $current_comment = ''; for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { |
00df344fd
|
465 466 467 |
my $line = $rawlines[$linenr - 1]; #warn " $line "; |
4a0df2ef4
|
468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 |
if ($linenr == $first_line and $line =~ m@^.\s*\*@) { $in_comment = 1; } if ($line =~ m@/\*@) { $in_comment = 1; } if (!$in_comment && $current_comment ne '') { $current_comment = ''; } $current_comment .= $line . " " if ($in_comment); if ($line =~ m@\*/@) { $in_comment = 0; } } chomp($current_comment); return($current_comment); } sub ctx_has_comment { my ($first_line, $end_line) = @_; my $cmt = ctx_locate_comment($first_line, $end_line); |
00df344fd
|
490 491 |
##print "LINE: $rawlines[$end_line - 1 ] "; |
4a0df2ef4
|
492 493 494 495 496 |
##print "CMMT: $cmt "; return ($cmt ne ''); } |
6c72ffaab
|
497 498 499 |
sub cat_vet { my ($vet) = @_; my ($res, $coded); |
9c0ca6f9a
|
500 |
|
6c72ffaab
|
501 502 503 504 505 506 |
$res = ''; while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { $res .= $1; if ($2 ne '') { $coded = sprintf("^%c", unpack('C', $2) + 64); $res .= $coded; |
9c0ca6f9a
|
507 508 |
} } |
6c72ffaab
|
509 |
$res =~ s/$/\$/; |
9c0ca6f9a
|
510 |
|
6c72ffaab
|
511 |
return $res; |
9c0ca6f9a
|
512 |
} |
6c72ffaab
|
513 514 |
sub annotate_values { my ($stream, $type) = @_; |
0a920b5b6
|
515 |
|
6c72ffaab
|
516 517 518 519 520 521 522 523 524 525 526 527 528 |
my $res; my $cur = $stream; my $debug = 0; print "$stream " if ($debug); ##my $type = 'N'; my $pos = 0; my $preprocessor = 0; my $paren = 0; my @paren_type; |
6c72ffaab
|
529 530 531 532 533 534 535 536 537 538 |
while (length($cur)) { print " <$type> " if ($debug); if ($cur =~ /^(\s+)/o) { print "WS($1) " if ($debug); if ($1 =~ / / && $preprocessor) { $preprocessor = 0; $type = 'N'; } |
8905a67c6
|
539 |
} elsif ($cur =~ /^($Type)/) { |
6c72ffaab
|
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 |
print "DECLARE($1) " if ($debug); $type = 'T'; } elsif ($cur =~ /^(#\s*define\s*$Ident)(\(?)/o) { print "DEFINE($1) " if ($debug); $preprocessor = 1; $paren_type[$paren] = 'N'; } elsif ($cur =~ /^(#\s*(?:ifdef|ifndef|if|else|endif))/o) { print "PRE($1) " if ($debug); $preprocessor = 1; $type = 'N'; } elsif ($cur =~ /^(\\ )/o) { print "PRECONT($1) " if ($debug); } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { print "SIZEOF($1) " if ($debug); if (defined $2) { $paren_type[$paren] = 'V'; } $type = 'N'; |
8905a67c6
|
568 |
} elsif ($cur =~ /^(if|while|typeof|for)\b/o) { |
6c72ffaab
|
569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 |
print "COND($1) " if ($debug); $paren_type[$paren] = 'N'; $type = 'N'; } elsif ($cur =~/^(return|case|else)/o) { print "KEYWORD($1) " if ($debug); $type = 'N'; } elsif ($cur =~ /^(\()/o) { print "PAREN('$1') " if ($debug); $paren++; $type = 'N'; } elsif ($cur =~ /^(\))/o) { $paren-- if ($paren > 0); if (defined $paren_type[$paren]) { $type = $paren_type[$paren]; undef $paren_type[$paren]; print "PAREN('$1') -> $type " if ($debug); } else { print "PAREN('$1') " if ($debug); } } elsif ($cur =~ /^($Ident)\(/o) { print "FUNC($1) " if ($debug); $paren_type[$paren] = 'V'; } elsif ($cur =~ /^($Ident|$Constant)/o) { print "IDENT($1) " if ($debug); $type = 'V'; } elsif ($cur =~ /^($Assignment)/o) { print "ASSIGN($1) " if ($debug); $type = 'N'; } elsif ($cur =~ /^(;|{|}|\?|:|\[)/o) { print "END($1) " if ($debug); $type = 'N'; } elsif ($cur =~ /^($Operators)/o) { print "OP($1) " if ($debug); if ($1 ne '++' && $1 ne '--') { $type = 'N'; } } elsif ($cur =~ /(^.)/o) { print "C($1) " if ($debug); } if (defined $1) { $cur = substr($cur, length($1)); $res .= $type x length($1); } |
9c0ca6f9a
|
632 |
} |
0a920b5b6
|
633 |
|
9c0ca6f9a
|
634 |
return $res; |
0a920b5b6
|
635 |
} |
8905a67c6
|
636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 |
sub possible { my ($possible) = @_; #print "CHECK<$possible> "; if ($possible !~ /^(?:$Storage|$Type|DEFINE_\S+)$/ && $possible ne 'goto' && $possible ne 'return' && $possible ne 'struct' && $possible ne 'enum' && $possible ne 'case' && $possible ne 'else' && $possible ne 'typedef') { #print "POSSIBLE<$possible> "; push(@typeList, $possible); build_types(); } } |
6c72ffaab
|
652 |
my $prefix = ''; |
f0a594c1c
|
653 654 |
my @report = (); sub report { |
8905a67c6
|
655 656 657 658 659 660 661 |
my $line = $prefix . $_[0]; $line = (split(' ', $line))[0] . " " if ($terse); push(@report, $line); |
f0a594c1c
|
662 663 664 665 |
} sub report_dump { @report; } |
de7d4f0e1
|
666 |
sub ERROR { |
f0a594c1c
|
667 668 |
report("ERROR: $_[0] "); |
de7d4f0e1
|
669 |
our $clean = 0; |
6c72ffaab
|
670 |
our $cnt_error++; |
de7d4f0e1
|
671 672 |
} sub WARN { |
f0a594c1c
|
673 674 |
report("WARNING: $_[0] "); |
de7d4f0e1
|
675 |
our $clean = 0; |
6c72ffaab
|
676 |
our $cnt_warn++; |
de7d4f0e1
|
677 678 |
} sub CHK { |
6c72ffaab
|
679 680 681 682 683 684 |
if ($check) { report("CHECK: $_[0] "); our $clean = 0; our $cnt_chk++; } |
de7d4f0e1
|
685 |
} |
0a920b5b6
|
686 687 688 689 690 691 692 |
sub process { my $filename = shift; my @lines = @_; my $linenr=0; my $prevline=""; my $stashline=""; |
4a0df2ef4
|
693 |
my $length; |
0a920b5b6
|
694 695 696 |
my $indent; my $previndent=0; my $stashindent=0; |
de7d4f0e1
|
697 |
our $clean = 1; |
0a920b5b6
|
698 699 |
my $signoff = 0; my $is_patch = 0; |
6c72ffaab
|
700 701 702 703 |
our $cnt_lines = 0; our $cnt_error = 0; our $cnt_warn = 0; our $cnt_chk = 0; |
0a920b5b6
|
704 705 706 707 708 709 710 |
# Trace the real file/line as we go. my $realfile = ''; my $realline = 0; my $realcnt = 0; my $here = ''; my $in_comment = 0; my $first_line = 0; |
6c72ffaab
|
711 |
my $prev_values = 'N'; |
653d4876b
|
712 |
|
de7d4f0e1
|
713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 |
# Pre-scan the patch looking for any __setup documentation. my @setup_docs = (); my $setup_docs = 0; foreach my $line (@lines) { if ($line=~/^\+\+\+\s+(\S+)/) { $setup_docs = 0; if ($1 =~ m@Documentation/kernel-parameters.txt$@) { $setup_docs = 1; } next; } if ($setup_docs && $line =~ /^\+/) { push(@setup_docs, $line); } } |
6c72ffaab
|
729 |
$prefix = ''; |
0a920b5b6
|
730 731 |
foreach my $line (@lines) { $linenr++; |
653d4876b
|
732 |
my $rawline = $line; |
6c72ffaab
|
733 |
|
0a920b5b6
|
734 735 736 |
#extract the filename as it passes if ($line=~/^\+\+\+\s+(\S+)/) { $realfile=$1; |
00df344fd
|
737 |
$realfile =~ s@^[^/]*/@@; |
0a920b5b6
|
738 739 740 741 |
$in_comment = 0; next; } #extract the line range in the file after the patch is applied |
6c72ffaab
|
742 |
if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { |
0a920b5b6
|
743 |
$is_patch = 1; |
4a0df2ef4
|
744 |
$first_line = $linenr + 1; |
0a920b5b6
|
745 746 747 748 749 750 751 |
$in_comment = 0; $realline=$1-1; if (defined $2) { $realcnt=$3+1; } else { $realcnt=1+1; } |
6c72ffaab
|
752 |
$prev_values = 'N'; |
0a920b5b6
|
753 754 |
next; } |
4a0df2ef4
|
755 756 757 758 |
# track the line number as we move through the hunk, note that # new versions of GNU diff omit the leading space on completely # blank context lines so we need to count that too. if ($line =~ /^( |\+|$)/) { |
0a920b5b6
|
759 |
$realline++; |
d8aaf1214
|
760 |
$realcnt-- if ($realcnt != 0); |
0a920b5b6
|
761 |
|
8905a67c6
|
762 763 764 765 766 767 768 769 770 771 772 773 774 775 |
# Guestimate if this is a continuing comment. Run # the context looking for a comment "edge". If this # edge is a close comment then we must be in a comment # at context start. if ($linenr == $first_line) { my $edge; for (my $ln = $first_line; $ln < ($linenr + $realcnt); $ln++) { ($edge) = ($lines[$ln - 1] =~ m@(/\*|\*/)@); last if (defined $edge); } if (defined $edge && $edge eq '*/') { $in_comment = 1; } } |
0a920b5b6
|
776 777 778 |
# Guestimate if this is a continuing comment. If this # is the start of a diff block and this line starts # ' *' then it is very likely a comment. |
4a0df2ef4
|
779 |
if ($linenr == $first_line and $line =~ m@^.\s*\*@) { |
0a920b5b6
|
780 781 |
$in_comment = 1; } |
8905a67c6
|
782 783 784 785 786 787 788 789 |
# Find the last comment edge on _this_ line. while (($line =~ m@(/\*|\*/)@g)) { if ($1 eq '/*') { $in_comment = 1; } else { $in_comment = 0; } |
0a920b5b6
|
790 |
} |
4a0df2ef4
|
791 792 |
# Measure the line length and indent. ($length, $indent) = line_stats($line); |
0a920b5b6
|
793 794 795 796 |
# Track the previous line. ($prevline, $stashline) = ($stashline, $line); ($previndent, $stashindent) = ($stashindent, $indent); |
6c72ffaab
|
797 |
|
d8aaf1214
|
798 799 |
} elsif ($realcnt == 1) { $realcnt--; |
0a920b5b6
|
800 801 802 |
} #make up the handle for any error we report on this line |
6c72ffaab
|
803 804 |
$here = "#$linenr: " if (!$file); $here = "#$realline: " if ($file); |
389834b68
|
805 |
$here .= "FILE: $realfile:$realline:" if ($realcnt != 0); |
0a920b5b6
|
806 |
|
00df344fd
|
807 808 809 |
my $hereline = "$here $line "; |
de7d4f0e1
|
810 811 812 813 814 815 816 |
my $herecurr = "$here $line "; my $hereprev = "$here $prevline $line "; |
0a920b5b6
|
817 |
|
6c72ffaab
|
818 819 820 |
$prefix = "$filename:$realline: " if ($emacs && $file); $prefix = "$filename:$linenr: " if ($emacs && !$file); $cnt_lines++ if ($realcnt != 0); |
0a920b5b6
|
821 |
#check the patch for a signoff: |
d8aaf1214
|
822 |
if ($line =~ /^\s*signed-off-by:/i) { |
4a0df2ef4
|
823 824 |
# This is a signoff, if ugly, so do not double report. $signoff++; |
0a920b5b6
|
825 |
if (!($line =~ /^\s*Signed-off-by:/)) { |
de7d4f0e1
|
826 827 828 |
WARN("Signed-off-by: is the preferred form " . $herecurr); |
0a920b5b6
|
829 830 |
} if ($line =~ /^\s*signed-off-by:\S/i) { |
de7d4f0e1
|
831 832 833 |
WARN("need space after Signed-off-by: " . $herecurr); |
0a920b5b6
|
834 835 |
} } |
00df344fd
|
836 |
# Check for wrappage within a valid hunk of the file |
8905a67c6
|
837 |
if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { |
de7d4f0e1
|
838 839 |
ERROR("patch seems to be corrupt (line wrapped?) " . |
6c72ffaab
|
840 |
$herecurr) if (!$emitted_corrupt++); |
de7d4f0e1
|
841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 |
} # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php if (($realfile =~ /^$/ || $line =~ /^\+/) && !($line =~ m/^( [\x09\x0A\x0D\x20-\x7E] # ASCII | [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 )*$/x )) { ERROR("Invalid UTF-8 " . $herecurr); |
00df344fd
|
857 858 859 860 |
} #ignore lines being removed if ($line=~/^-/) {next;} |
0a920b5b6
|
861 |
|
00df344fd
|
862 863 |
# check we are in a valid source file if not then ignore this hunk next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/); |
0a920b5b6
|
864 865 |
#trailing whitespace |
9c0ca6f9a
|
866 867 868 869 870 871 872 873 |
if ($line =~ /^\+.*\015/) { my $herevet = "$here " . cat_vet($line) . " "; ERROR("DOS line endings " . $herevet); } elsif ($line =~ /^\+.*\S\s+$/ || $line =~ /^\+\s+$/) { |
de7d4f0e1
|
874 875 876 877 878 |
my $herevet = "$here " . cat_vet($line) . " "; ERROR("trailing whitespace " . $herevet); |
0a920b5b6
|
879 880 |
} #80 column limit |
00df344fd
|
881 |
if ($line =~ /^\+/ && !($prevline=~/\/\*\*/) && $length > 80) { |
de7d4f0e1
|
882 883 |
WARN("line over 80 characters " . $herecurr); |
0a920b5b6
|
884 |
} |
8905a67c6
|
885 886 887 888 889 |
# check for adding lines without a newline. if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { WARN("adding a line without newline at end of file " . $herecurr); } |
0a920b5b6
|
890 891 892 893 894 895 |
# check we are in a valid source file *.[hc] if not then ignore this hunk next if ($realfile !~ /\.[hc]$/); # at the beginning of a line any tabs must come first and anything # more than 8 must use tabs. if ($line=~/^\+\s* \t\s*\S/ or $line=~/^\+\s* \s*/) { |
de7d4f0e1
|
896 897 898 899 900 |
my $herevet = "$here " . cat_vet($line) . " "; ERROR("use tabs not spaces " . $herevet); |
0a920b5b6
|
901 |
} |
653d4876b
|
902 |
# Remove comments from the line before processing. |
22f2a2ef9
|
903 904 905 906 907 908 909 910 |
my $comment_edge = ($line =~ s@/\*.*\*/@@g) + ($line =~ s@/\*.*@@) + ($line =~ s@^(.).*\*/@$1@); # The rest of our checks refer specifically to C style # only apply those _outside_ comments. Only skip # lines in the middle of comments. next if (!$comment_edge && $in_comment); |
00df344fd
|
911 |
|
653d4876b
|
912 913 |
# Standardise the strings and chars within the input to simplify matching. $line = sanitise_line($line); |
9c0ca6f9a
|
914 915 |
# Check for potential 'bare' types if ($realcnt && |
9c0ca6f9a
|
916 |
$line !~ /$Ident:\s*$/ && |
8905a67c6
|
917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 |
($line =~ /^.\s*$Ident\s*\(\*+\s*$Ident\)\s*\(/ || $line !~ /^.\s*$Ident\s*\(/)) { # definitions in global scope can only start with types if ($line =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b/) { possible($1); # declarations always start with types } elsif ($prev_values eq 'N' && $line =~ /^.\s*(?:$Storage\s+)?($Ident)\b\s*\**\s*$Ident\s*(?:;|=)/) { possible($1); # any (foo ... *) is a pointer cast, and foo is a type } elsif ($line =~ /\(($Ident)(?:\s+$Sparse)*\s*\*+\s*\)/) { possible($1); } # Check for any sort of function declaration. # int foo(something bar, other baz); # void (*store_gdt)(x86_descr_ptr *); if ($prev_values eq 'N' && $line =~ /^(.(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/) { my ($name_len) = length($1); my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, $name_len); my $ctx = join(" ", @ctx); $ctx =~ s/ .//; substr($ctx, 0, $name_len + 1) = ''; $ctx =~ s/\)[^\)]*$//; for my $arg (split(/\s*,\s*/, $ctx)) { if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/ || $arg =~ /^($Ident)$/) { possible($1); } } |
9c0ca6f9a
|
951 |
} |
8905a67c6
|
952 |
|
9c0ca6f9a
|
953 |
} |
653d4876b
|
954 955 956 |
# # Checks which may be anchored in the context. # |
00df344fd
|
957 |
|
653d4876b
|
958 959 |
# Check for switch () and associated case and default # statements should be at the same indent. |
00df344fd
|
960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 |
if ($line=~/\bswitch\s*\(.*\)/) { my $err = ''; my $sep = ''; my @ctx = ctx_block_outer($linenr, $realcnt); shift(@ctx); for my $ctx (@ctx) { my ($clen, $cindent) = line_stats($ctx); if ($ctx =~ /^\+\s*(case\s+|default:)/ && $indent != $cindent) { $err .= "$sep$ctx "; $sep = ''; } else { $sep = "[...] "; } } if ($err ne '') { |
9c0ca6f9a
|
978 979 |
ERROR("switch and case should be at the same indent $hereline$err"); |
de7d4f0e1
|
980 981 982 983 984 985 |
} } # if/while/etc brace do not go on next line, unless defining a do while loop, # or if that brace on the next line is for something else if ($line =~ /\b(?:(if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.#/) { |
9c0ca6f9a
|
986 |
my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); |
de7d4f0e1
|
987 988 989 990 |
my $ctx_ln = $linenr + $#ctx + 1; my $ctx_cnt = $realcnt - $#ctx - 1; my $ctx = join(" ", @ctx); |
9c0ca6f9a
|
991 |
# Skip over any removed lines in the context following statement. |
de7d4f0e1
|
992 993 994 995 996 997 998 999 1000 |
while ($ctx_cnt > 0 && $lines[$ctx_ln - 1] =~ /^-/) { $ctx_ln++; $ctx_cnt--; } ##warn "line<$line> ctx<$ctx> next<$lines[$ctx_ln - 1]>"; if ($ctx !~ /{\s*/ && $ctx_cnt > 0 && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { |
f0a594c1c
|
1001 1002 |
ERROR("That open brace { should be on the previous line " . |
de7d4f0e1
|
1003 1004 1005 |
"$here $ctx $lines[$ctx_ln - 1]"); |
00df344fd
|
1006 |
} |
9c0ca6f9a
|
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 |
if ($level == 0 && $ctx =~ /\)\s*\;\s*$/ && defined $lines[$ctx_ln - 1]) { my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); if ($nindent > $indent) { WARN("Trailing semicolon indicates no statements, indent implies otherwise " . "$here $ctx $lines[$ctx_ln - 1]"); } } |
00df344fd
|
1017 |
} |
6c72ffaab
|
1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 |
# Track the 'values' across context and added lines. my $opline = $line; $opline =~ s/^./ /; my $curr_values = annotate_values($opline . " ", $prev_values); $curr_values = $prev_values . $curr_values; #warn "--> $opline "; #warn "--> $curr_values ($prev_values) "; $prev_values = substr($curr_values, -1); |
00df344fd
|
1028 1029 |
#ignore lines not being added if ($line=~/^[^\+]/) {next;} |
653d4876b
|
1030 1031 |
# TEST: allow direct testing of the type matcher. if ($tst_type && $line =~ /^.$Declare$/) { |
de7d4f0e1
|
1032 1033 |
ERROR("TEST: is type $Declare " . $herecurr); |
653d4876b
|
1034 1035 |
next; } |
f0a594c1c
|
1036 1037 1038 1039 1040 1041 |
# check for initialisation to aggregates open brace on the next line if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ && $line =~ /^.\s*{/) { ERROR("That open brace { should be on the previous line " . $hereprev); } |
653d4876b
|
1042 1043 1044 1045 1046 1047 1048 1049 |
# # Checks which are anchored on the added line. # # check for malformed paths in #include statements (uses RAW line) if ($rawline =~ m{^.#\s*include\s+[<"](.*)[">]}) { my $path = $1; if ($path =~ m{//}) { |
de7d4f0e1
|
1050 1051 1052 |
ERROR("malformed #include filename " . $herecurr); |
653d4876b
|
1053 1054 1055 1056 1057 |
} # Sanitise this special form of string. $path = 'X' x length($path); $line =~ s{\<.*\>}{<$path>}; } |
00df344fd
|
1058 |
|
0a920b5b6
|
1059 |
# no C99 // comments |
00df344fd
|
1060 |
if ($line =~ m{//}) { |
de7d4f0e1
|
1061 1062 |
ERROR("do not use C99 // comments " . $herecurr); |
0a920b5b6
|
1063 |
} |
00df344fd
|
1064 |
# Remove C99 comments. |
0a920b5b6
|
1065 |
$line =~ s@//.*@@; |
6c72ffaab
|
1066 |
$opline =~ s@//.*@@; |
0a920b5b6
|
1067 1068 |
#EXPORT_SYMBOL should immediately follow its function closing }. |
653d4876b
|
1069 1070 1071 |
if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) || ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { my $name = $1; |
0a920b5b6
|
1072 1073 |
if (($prevline !~ /^}/) && ($prevline !~ /^\+}/) && |
653d4876b
|
1074 |
($prevline !~ /^ }/) && |
22f2a2ef9
|
1075 |
($prevline !~ /\b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=)/)) { |
de7d4f0e1
|
1076 1077 |
WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable " . $herecurr); |
0a920b5b6
|
1078 1079 |
} } |
f0a594c1c
|
1080 1081 1082 1083 1084 1085 |
# check for external initialisers. if ($line =~ /^.$Type\s*$Ident\s*=\s*(0|NULL);/) { ERROR("do not initialise externals to 0 or NULL " . $herecurr); } |
653d4876b
|
1086 |
# check for static initialisers. |
f0a594c1c
|
1087 |
if ($line =~ /\s*static\s.*=\s*(0|NULL);/) { |
de7d4f0e1
|
1088 1089 1090 |
ERROR("do not initialise statics to 0 or NULL " . $herecurr); |
0a920b5b6
|
1091 |
} |
653d4876b
|
1092 1093 1094 |
# check for new typedefs, only function parameters and sparse annotations # make sense. if ($line =~ /\btypedef\s/ && |
9c0ca6f9a
|
1095 |
$line !~ /\btypedef\s+$Type\s+\(\s*\*?$Ident\s*\)\s*\(/ && |
653d4876b
|
1096 |
$line !~ /\b__bitwise(?:__|)\b/) { |
de7d4f0e1
|
1097 1098 |
WARN("do not add new typedefs " . $herecurr); |
0a920b5b6
|
1099 1100 1101 |
} # * goes on variable not on type |
d8aaf1214
|
1102 |
if ($line =~ m{\($NonptrType(\*+)(?:\s+const)?\)}) { |
de7d4f0e1
|
1103 1104 1105 |
ERROR("\"(foo$1)\" should be \"(foo $1)\" " . $herecurr); |
d8aaf1214
|
1106 1107 |
} elsif ($line =~ m{\($NonptrType\s+(\*+)(?!\s+const)\s+\)}) { |
de7d4f0e1
|
1108 1109 1110 |
ERROR("\"(foo $1 )\" should be \"(foo $1)\" " . $herecurr); |
d8aaf1214
|
1111 |
|
9c0ca6f9a
|
1112 |
} elsif ($line =~ m{$NonptrType(\*+)(?:\s+(?:$Attribute|$Sparse))?\s+[A-Za-z\d_]+}) { |
de7d4f0e1
|
1113 1114 1115 |
ERROR("\"foo$1 bar\" should be \"foo $1bar\" " . $herecurr); |
d8aaf1214
|
1116 |
|
9c0ca6f9a
|
1117 |
} elsif ($line =~ m{$NonptrType\s+(\*+)(?!\s+(?:$Attribute|$Sparse))\s+[A-Za-z\d_]+}) { |
de7d4f0e1
|
1118 1119 1120 |
ERROR("\"foo $1 bar\" should be \"foo $1bar\" " . $herecurr); |
0a920b5b6
|
1121 1122 1123 1124 1125 1126 1127 1128 1129 |
} # # no BUG() or BUG_ON() # if ($line =~ /\b(BUG|BUG_ON)\b/) { # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON() "; # print "$herecurr"; # $clean = 0; # } |
8905a67c6
|
1130 1131 1132 |
if ($line =~ /\bLINUX_VERSION_CODE\b/) { WARN("LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged" . $herecurr); } |
00df344fd
|
1133 1134 1135 1136 1137 |
# printk should use KERN_* levels. Note that follow on printk's on the # same line do not need a level, so we use the current block context # to try and find and validate the current printk. In summary the current # printk includes all preceeding printk's which have no newline on the end. # we assume the first bad printk is the one to report. |
f0a594c1c
|
1138 |
if ($line =~ /\bprintk\((?!KERN_)\s*"/) { |
00df344fd
|
1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 |
my $ok = 0; for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { #print "CHECK<$lines[$ln - 1] "; # we have a preceeding printk if it ends # with " " ignore it, else it is to blame if ($lines[$ln - 1] =~ m{\bprintk\(}) { if ($rawlines[$ln - 1] !~ m{\ "}) { $ok = 1; } last; } } if ($ok == 0) { |
de7d4f0e1
|
1155 1156 |
WARN("printk() should include KERN_ facility level " . $herecurr); |
00df344fd
|
1157 |
} |
0a920b5b6
|
1158 |
} |
653d4876b
|
1159 1160 |
# function brace can't be on same line, except for #defines of do while, # or if closed on same line |
d8aaf1214
|
1161 |
if (($line=~/$Type\s*[A-Za-z\d_]+\(.*\).* {/) and |
0a920b5b6
|
1162 |
!($line=~/\#define.*do\s{/) and !($line=~/}/)) { |
de7d4f0e1
|
1163 1164 |
ERROR("open brace '{' following function declarations go on the next line " . $herecurr); |
0a920b5b6
|
1165 |
} |
653d4876b
|
1166 |
|
8905a67c6
|
1167 1168 1169 1170 1171 1172 |
# open braces for enum, union and struct go on the same line. if ($line =~ /^.\s*{/ && $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { ERROR("open brace '{' following $1 go on the same line " . $hereprev); } |
f0a594c1c
|
1173 |
# check for spaces between functions and their parentheses. |
6c72ffaab
|
1174 1175 1176 1177 1178 1179 |
while ($line =~ /($Ident)\s+\(/g) { if ($1 !~ /^(?:if|for|while|switch|return|volatile|__volatile__|__attribute__|format|__extension__|Copyright|case)$/ && $line !~ /$Type\s+\(/ && $line !~ /^.\#\s*define\b/) { WARN("no space between function name and open parenthesis '(' " . $herecurr); } |
f0a594c1c
|
1180 |
} |
653d4876b
|
1181 |
# Check operator spacing. |
0a920b5b6
|
1182 |
if (!($line=~/\#\s*include/)) { |
9c0ca6f9a
|
1183 1184 1185 1186 1187 1188 1189 |
my $ops = qr{ <<=|>>=|<=|>=|==|!=| \+=|-=|\*=|\/=|%=|\^=|\|=|&=| =>|->|<<|>>|<|>|=|!|~| &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/ }x; my @elements = split(/($ops|;)/, $opline); |
00df344fd
|
1190 |
my $off = 0; |
6c72ffaab
|
1191 1192 |
my $blank = copy_spacing($opline); |
0a920b5b6
|
1193 |
for (my $n = 0; $n < $#elements; $n += 2) { |
4a0df2ef4
|
1194 1195 1196 1197 1198 1199 1200 1201 |
$off += length($elements[$n]); my $a = ''; $a = 'V' if ($elements[$n] ne ''); $a = 'W' if ($elements[$n] =~ /\s$/); $a = 'B' if ($elements[$n] =~ /(\[|\()$/); $a = 'O' if ($elements[$n] eq ''); $a = 'E' if ($elements[$n] eq '' && $n == 0); |
0a920b5b6
|
1202 |
my $op = $elements[$n + 1]; |
4a0df2ef4
|
1203 1204 |
my $c = ''; |
0a920b5b6
|
1205 |
if (defined $elements[$n + 2]) { |
4a0df2ef4
|
1206 1207 1208 1209 |
$c = 'V' if ($elements[$n + 2] ne ''); $c = 'W' if ($elements[$n + 2] =~ /^\s/); $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); $c = 'O' if ($elements[$n + 2] eq ''); |
22f2a2ef9
|
1210 |
$c = 'E' if ($elements[$n + 2] =~ /\s*\\$/); |
4a0df2ef4
|
1211 1212 |
} else { $c = 'E'; |
0a920b5b6
|
1213 |
} |
00df344fd
|
1214 |
# Pick up the preceeding and succeeding characters. |
de7d4f0e1
|
1215 |
my $ca = substr($opline, 0, $off); |
00df344fd
|
1216 |
my $cc = ''; |
653d4876b
|
1217 |
if (length($opline) >= ($off + length($elements[$n + 1]))) { |
d8aaf1214
|
1218 |
$cc = substr($opline, $off + length($elements[$n + 1])); |
00df344fd
|
1219 |
} |
de7d4f0e1
|
1220 |
my $cb = "$ca$;$cc"; |
00df344fd
|
1221 |
|
4a0df2ef4
|
1222 1223 1224 |
my $ctx = "${a}x${c}"; my $at = "(ctx:$ctx)"; |
6c72ffaab
|
1225 |
my $ptr = substr($blank, 0, $off) . "^"; |
de7d4f0e1
|
1226 1227 |
my $hereptr = "$hereline$ptr "; |
0a920b5b6
|
1228 |
|
9c0ca6f9a
|
1229 1230 1231 |
# Classify operators into binary, unary, or # definitions (* only) where they have more # than one mode. |
6c72ffaab
|
1232 1233 1234 1235 1236 1237 1238 1239 1240 |
my $op_type = substr($curr_values, $off + 1, 1); my $op_left = substr($curr_values, $off, 1); my $is_unary; if ($op_type eq 'T') { $is_unary = 2; } elsif ($op_left eq 'V') { $is_unary = 0; } else { $is_unary = 1; |
9c0ca6f9a
|
1241 |
} |
9c0ca6f9a
|
1242 |
#if ($op eq '-' || $op eq '&' || $op eq '*') { |
6c72ffaab
|
1243 1244 |
# print "UNARY: <$op_left$op_type $is_unary $a:$op:$c> <$ca:$op:$cc> <$unary_ctx> "; |
9c0ca6f9a
|
1245 |
#} |
0a920b5b6
|
1246 |
|
d8aaf1214
|
1247 1248 |
# ; should have either the end of line or a space or \ after it if ($op eq ';') { |
de7d4f0e1
|
1249 1250 1251 1252 |
if ($ctx !~ /.x[WEB]/ && $cc !~ /^\\/ && $cc !~ /^;/) { ERROR("need space after that '$op' $at " . $hereptr); |
d8aaf1214
|
1253 1254 1255 1256 |
} # // is a comment } elsif ($op eq '//') { |
0a920b5b6
|
1257 1258 1259 |
# -> should have no spaces } elsif ($op eq '->') { |
4a0df2ef4
|
1260 |
if ($ctx =~ /Wx.|.xW/) { |
de7d4f0e1
|
1261 1262 |
ERROR("no spaces around that '$op' $at " . $hereptr); |
0a920b5b6
|
1263 1264 1265 1266 |
} # , must have a space on the right. } elsif ($op eq ',') { |
d8aaf1214
|
1267 |
if ($ctx !~ /.xW|.xE/ && $cc !~ /^}/) { |
de7d4f0e1
|
1268 1269 |
ERROR("need space after that '$op' $at " . $hereptr); |
0a920b5b6
|
1270 |
} |
9c0ca6f9a
|
1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 |
# '*' as part of a type definition -- reported already. } elsif ($op eq '*' && $is_unary == 2) { #warn "'*' is part of type "; # unary operators should have a space before and # none after. May be left adjacent to another # unary operator, or a cast } elsif ($op eq '!' || $op eq '~' || ($is_unary && ($op eq '*' || $op eq '-' || $op eq '&'))) { if ($ctx !~ /[WEB]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { |
de7d4f0e1
|
1282 1283 |
ERROR("need space before that '$op' $at " . $hereptr); |
0a920b5b6
|
1284 |
} |
4a0df2ef4
|
1285 |
if ($ctx =~ /.xW/) { |
de7d4f0e1
|
1286 1287 |
ERROR("no space after that '$op' $at " . $hereptr); |
0a920b5b6
|
1288 1289 1290 1291 |
} # unary ++ and unary -- are allowed no space on one side. } elsif ($op eq '++' or $op eq '--') { |
d8aaf1214
|
1292 |
if ($ctx !~ /[WOB]x[^W]/ && $ctx !~ /[^W]x[WOBE]/) { |
de7d4f0e1
|
1293 1294 |
ERROR("need space one side of that '$op' $at " . $hereptr); |
0a920b5b6
|
1295 |
} |
d8aaf1214
|
1296 |
if ($ctx =~ /Wx./ && $cc =~ /^;/) { |
de7d4f0e1
|
1297 1298 |
ERROR("no space before that '$op' $at " . $hereptr); |
653d4876b
|
1299 |
} |
0a920b5b6
|
1300 |
|
0a920b5b6
|
1301 |
# << and >> may either have or not have spaces both sides |
9c0ca6f9a
|
1302 1303 1304 1305 |
} elsif ($op eq '<<' or $op eq '>>' or $op eq '&' or $op eq '^' or $op eq '|' or $op eq '+' or $op eq '-' or $op eq '*' or $op eq '/') |
0a920b5b6
|
1306 |
{ |
9c0ca6f9a
|
1307 |
if ($ctx !~ /VxV|WxW|VxE|WxE|VxO/) { |
de7d4f0e1
|
1308 1309 1310 |
ERROR("need consistent spacing around '$op' $at " . $hereptr); |
0a920b5b6
|
1311 1312 1313 |
} # All the others need spaces both sides. |
4a0df2ef4
|
1314 |
} elsif ($ctx !~ /[EW]x[WE]/) { |
22f2a2ef9
|
1315 1316 1317 1318 1319 1320 |
# Ignore email addresses <foo@bar> if (!($op eq '<' && $cb =~ /$;\S+\@\S+>/) && !($op eq '>' && $cb =~ /<\S+\@\S+$;/)) { ERROR("need spaces around that '$op' $at " . $hereptr); } |
0a920b5b6
|
1321 |
} |
4a0df2ef4
|
1322 |
$off += length($elements[$n + 1]); |
0a920b5b6
|
1323 1324 |
} } |
f0a594c1c
|
1325 1326 |
# check for multiple assignments if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { |
6c72ffaab
|
1327 1328 |
CHK("multiple assignments should be avoided " . $herecurr); |
f0a594c1c
|
1329 |
} |
22f2a2ef9
|
1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 |
## # check for multiple declarations, allowing for a function declaration ## # continuation. ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { ## ## # Remove any bracketed sections to ensure we do not ## # falsly report the parameters of functions. ## my $ln = $line; ## while ($ln =~ s/\([^\(\)]*\)//g) { ## } ## if ($ln =~ /,/) { ## WARN("declaring multiple variables together should be avoided " . $herecurr); ## } ## } |
f0a594c1c
|
1345 |
|
0a920b5b6
|
1346 |
#need space before brace following if, while, etc |
22f2a2ef9
|
1347 1348 |
if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || $line =~ /do{/) { |
de7d4f0e1
|
1349 1350 1351 1352 1353 1354 1355 1356 1357 |
ERROR("need a space before the open brace '{' " . $herecurr); } # closing brace should have a space following it when it has anything # on the line if ($line =~ /}(?!(?:,|;|\)))\S/) { ERROR("need a space after that close brace '}' " . $herecurr); |
0a920b5b6
|
1358 |
} |
22f2a2ef9
|
1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 |
# check spacing on square brackets if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { ERROR("no space after that open square bracket '[' " . $herecurr); } if ($line =~ /\s\]/) { ERROR("no space before that close square bracket ']' " . $herecurr); } # check spacing on paretheses |
9c0ca6f9a
|
1370 1371 |
if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && $line !~ /for\s*\(\s+;/) { |
22f2a2ef9
|
1372 1373 1374 |
ERROR("no space after that open parenthesis '(' " . $herecurr); } |
9c0ca6f9a
|
1375 1376 |
if ($line =~ /\s\)/ && $line !~ /^.\s*\)/ && $line !~ /for\s*\(.*;\s+\)/) { |
22f2a2ef9
|
1377 1378 1379 |
ERROR("no space before that close parenthesis ')' " . $herecurr); } |
0a920b5b6
|
1380 |
#goto labels aren't indented, allow a single space however |
4a0df2ef4
|
1381 |
if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and |
0a920b5b6
|
1382 |
!($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { |
de7d4f0e1
|
1383 1384 |
WARN("labels should not be indented " . $herecurr); |
0a920b5b6
|
1385 1386 1387 |
} # Need a space before open parenthesis after if, while etc |
4a0df2ef4
|
1388 |
if ($line=~/\b(if|while|for|switch)\(/) { |
de7d4f0e1
|
1389 1390 |
ERROR("need a space before the open parenthesis '(' " . $herecurr); |
0a920b5b6
|
1391 1392 1393 |
} # Check for illegal assignment in if conditional. |
8905a67c6
|
1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 |
if ($line =~ /\bif\s*\(/) { my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/) { ERROR("do not use assignment in if condition ($c) " . $herecurr); } # Find out what is on the end of the line after the # conditional. substr($s, 0, length($c)) = ''; $s =~ s/ .*//g; if (length($c) && $s !~ /^\s*({|;|\/\*.*\*\/)?\s*\\*\s*$/) { ERROR("trailing statements should be on next line " . $herecurr); } } # if and else should not have general statements after it if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/ && $1 !~ /^\s*(?:\sif|{|\\|$)/) { ERROR("trailing statements should be on next line " . $herecurr); |
0a920b5b6
|
1419 1420 1421 1422 1423 1424 |
} # Check for }<nl>else {, these must be at the same # indent level to be relevant to each other. if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and $previndent == $indent) { |
de7d4f0e1
|
1425 1426 |
ERROR("else should follow close brace '}' " . $hereprev); |
0a920b5b6
|
1427 |
} |
0a920b5b6
|
1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 |
#studly caps, commented out until figure out how to distinguish between use of existing and adding new # if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) { # print "No studly caps, use _ "; # print "$herecurr"; # $clean = 0; # } #no spaces allowed after \ in define if ($line=~/\#define.*\\\s$/) { |
de7d4f0e1
|
1438 1439 |
WARN("Whitepspace after \\ makes next lines useless " . $herecurr); |
0a920b5b6
|
1440 |
} |
653d4876b
|
1441 1442 |
#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line) if ($tree && $rawline =~ m{^.\#\s*include\s*\<asm\/(.*)\.h\>}) { |
6c72ffaab
|
1443 1444 |
my $checkfile = "$root/include/linux/$1.h"; if (-f $checkfile && $1 ne 'irq.h') { |
de7d4f0e1
|
1445 1446 1447 |
CHK("Use #include <linux/$1.h> instead of <asm/$1.h> " . $herecurr); |
0a920b5b6
|
1448 1449 |
} } |
653d4876b
|
1450 1451 1452 |
# multi-statement macros should be enclosed in a do while loop, grab the # first statement and ensure its the whole macro if its not enclosed # in a known goot container |
9c0ca6f9a
|
1453 1454 1455 1456 |
if ($prevline =~ /\#define.*\\/ && $prevline !~/(?:do\s+{|\(\{|\{)/ && $line !~ /(?:do\s+{|\(\{|\{)/ && $line !~ /^.\s*$Declare\s/) { |
653d4876b
|
1457 1458 1459 |
# Grab the first statement, if that is the entire macro # its ok. This may start either on the #define line # or the one below. |
d8aaf1214
|
1460 1461 |
my $ln = $linenr; my $cnt = $realcnt; |
f0a594c1c
|
1462 |
my $off = 0; |
653d4876b
|
1463 |
|
f0a594c1c
|
1464 1465 1466 1467 1468 |
# If the macro starts on the define line start # grabbing the statement after the identifier $prevline =~ m{^(.#\s*define\s*$Ident(?:\([^\)]*\))?\s*)(.*)\\\s*$}; ##print "1<$1> 2<$2> "; |
22f2a2ef9
|
1469 |
if (defined $2 && $2 ne '') { |
f0a594c1c
|
1470 |
$off = length($1); |
d8aaf1214
|
1471 1472 |
$ln--; $cnt++; |
8905a67c6
|
1473 1474 1475 1476 |
while ($lines[$ln - 1] =~ /^-/) { $ln--; $cnt++; } |
d8aaf1214
|
1477 |
} |
f0a594c1c
|
1478 |
my @ctx = ctx_statement($ln, $cnt, $off); |
de7d4f0e1
|
1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 |
my $ctx_ln = $ln + $#ctx + 1; my $ctx = join(" ", @ctx); # Pull in any empty extension lines. while ($ctx =~ /\\$/ && $lines[$ctx_ln - 1] =~ /^.\s*(?:\\)?$/) { $ctx .= $lines[$ctx_ln - 1]; $ctx_ln++; } |
d8aaf1214
|
1489 1490 1491 |
if ($ctx =~ /\\$/) { if ($ctx =~ /;/) { |
de7d4f0e1
|
1492 1493 1494 1495 |
ERROR("Macros with multiple statements should be enclosed in a do - while loop " . "$here $ctx "); |
d8aaf1214
|
1496 |
} else { |
de7d4f0e1
|
1497 1498 1499 1500 |
ERROR("Macros with complex values should be enclosed in parenthesis " . "$here $ctx "); |
d8aaf1214
|
1501 |
} |
653d4876b
|
1502 |
} |
0a920b5b6
|
1503 |
} |
f0a594c1c
|
1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 |
# check for redundant bracing round if etc if ($line =~ /\b(if|while|for|else)\b/) { # Locate the end of the opening statement. my @control = ctx_statement($linenr, $realcnt, 0); my $nr = $linenr + (scalar(@control) - 1); my $cnt = $realcnt - (scalar(@control) - 1); my $off = $realcnt - $cnt; #print "$off: line<$line>end<" . $lines[$nr - 1] . "> "; # If this is is a braced statement group check it if ($lines[$nr - 1] =~ /{\s*$/) { my ($lvl, @block) = ctx_block_level($nr, $cnt); |
8905a67c6
|
1518 1519 1520 1521 1522 1523 1524 1525 |
my $stmt = join(" ", @block); # Drop the diff line leader. $stmt =~ s/ ./ /g; # Drop the code outside the block. $stmt =~ s/(^[^{]*){\s*//; |
22f2a2ef9
|
1526 |
my $before = $1; |
8905a67c6
|
1527 |
$stmt =~ s/\s*}([^}]*$)//; |
22f2a2ef9
|
1528 |
my $after = $1; |
f0a594c1c
|
1529 1530 1531 1532 1533 1534 |
#print "block<" . join(' ', @block) . "><" . scalar(@block) . "> "; #print "stmt<$stmt> "; |
8905a67c6
|
1535 1536 1537 1538 1539 1540 1541 |
# Count the newlines, if there is only one # then the block should not have {}'s. my @lines = ($stmt =~ / /g); #print "lines<" . scalar(@lines) . "> "; if ($lvl == 0 && scalar(@lines) == 0 && |
22f2a2ef9
|
1542 1543 |
$stmt !~ /{/ && $stmt !~ /\bif\b/ && $before !~ /}/ && $after !~ /{/) { |
f0a594c1c
|
1544 1545 1546 1547 1548 |
my $herectx = "$here " . join(" ", @control, @block[1 .. $#block]) . " "; shift(@block); |
22f2a2ef9
|
1549 1550 |
WARN("braces {} are not necessary for single statement blocks " . $herectx); |
f0a594c1c
|
1551 1552 1553 |
} } } |
653d4876b
|
1554 |
# don't include deprecated include files (uses RAW line) |
4a0df2ef4
|
1555 |
for my $inc (@dep_includes) { |
653d4876b
|
1556 |
if ($rawline =~ m@\#\s*include\s*\<$inc>@) { |
de7d4f0e1
|
1557 1558 |
ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt " . $herecurr); |
0a920b5b6
|
1559 1560 |
} } |
4a0df2ef4
|
1561 1562 |
# don't use deprecated functions for my $func (@dep_functions) { |
00df344fd
|
1563 |
if ($line =~ /\b$func\b/) { |
de7d4f0e1
|
1564 1565 |
ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt " . $herecurr); |
4a0df2ef4
|
1566 1567 1568 1569 |
} } # no volatiles please |
6c72ffaab
|
1570 1571 |
my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { |
de7d4f0e1
|
1572 1573 |
WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt " . $herecurr); |
4a0df2ef4
|
1574 |
} |
9c0ca6f9a
|
1575 1576 1577 1578 1579 |
# SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) { ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt " . $herecurr); } |
00df344fd
|
1580 1581 |
# warn about #if 0 if ($line =~ /^.#\s*if\s+0\b/) { |
de7d4f0e1
|
1582 1583 1584 |
CHK("if this code is redundant consider removing it " . $herecurr); |
4a0df2ef4
|
1585 |
} |
f0a594c1c
|
1586 1587 1588 1589 1590 1591 1592 1593 |
# check for needless kfree() checks if ($prevline =~ /\bif\s*\(([^\)]*)\)/) { my $expr = $1; if ($line =~ /\bkfree\(\Q$expr\E\);/) { WARN("kfree(NULL) is safe this check is probabally not required " . $hereprev); } } |
00df344fd
|
1594 1595 1596 1597 1598 1599 1600 |
# warn about #ifdefs in C files # if ($line =~ /^.#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { # print "#ifdef in C files should be avoided "; # print "$herecurr"; # $clean = 0; # } |
22f2a2ef9
|
1601 1602 1603 1604 1605 |
# warn about spacing in #ifdefs if ($line =~ /^.#\s*(ifdef|ifndef|elif)\s\s+/) { ERROR("exactly one space required after that #$1 " . $herecurr); } |
4a0df2ef4
|
1606 1607 1608 1609 |
# check for spinlock_t definitions without a comment. if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/) { my $which = $1; if (!ctx_has_comment($first_line, $linenr)) { |
de7d4f0e1
|
1610 1611 |
CHK("$1 definition without comment " . $herecurr); |
4a0df2ef4
|
1612 1613 1614 1615 1616 |
} } # check for memory barriers without a comment. if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { if (!ctx_has_comment($first_line, $linenr)) { |
de7d4f0e1
|
1617 1618 |
CHK("memory barrier without comment " . $herecurr); |
4a0df2ef4
|
1619 1620 1621 |
} } # check of hardware specific defines |
22f2a2ef9
|
1622 |
if ($line =~ m@^.#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { |
de7d4f0e1
|
1623 1624 |
CHK("architecture specific defines should be avoided " . $herecurr); |
0a920b5b6
|
1625 |
} |
653d4876b
|
1626 |
|
de7d4f0e1
|
1627 1628 |
# check the location of the inline attribute, that it is between # storage class and type. |
9c0ca6f9a
|
1629 1630 |
if ($line =~ /\b$Type\s+$Inline\b/ || $line =~ /\b$Inline\s+$Storage\b/) { |
de7d4f0e1
|
1631 1632 1633 |
ERROR("inline keyword should sit between storage class and type " . $herecurr); } |
8905a67c6
|
1634 1635 1636 1637 1638 |
# Check for __inline__ and __inline, prefer inline if ($line =~ /\b(__inline__|__inline)\b/) { WARN("plain inline is preferred over $1 " . $herecurr); } |
de7d4f0e1
|
1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 |
# check for new externs in .c files. if ($line =~ /^.\s*extern\s/ && ($realfile =~ /\.c$/)) { WARN("externs should be avoided in .c files " . $herecurr); } # checks for new __setup's if ($rawline =~ /\b__setup\("([^"]*)"/) { my $name = $1; if (!grep(/$name/, @setup_docs)) { CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt " . $herecurr); } |
653d4876b
|
1653 |
} |
9c0ca6f9a
|
1654 1655 1656 1657 1658 1659 |
# check for pointless casting of kmalloc return if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) { WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html " . $herecurr); } |
0a920b5b6
|
1660 |
} |
8905a67c6
|
1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 |
# In mailback mode only produce a report in the negative, for # things that appear to be patches. if ($mailback && ($clean == 1 || !$is_patch)) { exit(0); } # This is not a patch, and we are are in 'no-patch' mode so # just keep quiet. if (!$chk_patch && !$is_patch) { exit(0); } if (!$is_patch) { |
de7d4f0e1
|
1674 1675 |
ERROR("Does not appear to be a unified-diff format patch "); |
0a920b5b6
|
1676 1677 |
} if ($is_patch && $chk_signoff && $signoff == 0) { |
de7d4f0e1
|
1678 1679 |
ERROR("Missing Signed-off-by: line(s) "); |
0a920b5b6
|
1680 |
} |
8905a67c6
|
1681 1682 1683 1684 1685 1686 1687 1688 |
print report_dump(); if ($summary) { print "total: $cnt_error errors, $cnt_warn warnings, " . (($check)? "$cnt_chk checks, " : "") . "$cnt_lines lines checked "; print " " if ($quiet == 0); |
f0a594c1c
|
1689 |
} |
8905a67c6
|
1690 |
|
0a920b5b6
|
1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 |
if ($clean == 1 && $quiet == 0) { print "Your patch has no obvious style problems and is ready for submission. " } if ($clean == 0 && $quiet == 0) { print "Your patch has style problems, please review. If any of these errors "; print "are false positives report them to the maintainer, see "; print "CHECKPATCH in MAINTAINERS. "; } return $clean; } |