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