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