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