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