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