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 my $non_utf8_charset = 0; 1390 1391 our @report = (); 1392 our $cnt_lines = 0; 1393 our $cnt_error = 0; 1394 our $cnt_warn = 0; 1395 our $cnt_chk = 0; 1396 1397 # Trace the real file/line as we go. 1398 my $realfile = ''; 1399 my $realline = 0; 1400 my $realcnt = 0; 1401 my $here = ''; 1402 my $in_comment = 0; 1403 my $comment_edge = 0; 1404 my $first_line = 0; 1405 my $p1_prefix = ''; 1406 1407 my $prev_values = 'E'; 1408 1409 # suppression flags 1410 my %suppress_ifbraces; 1411 my %suppress_whiletrailers; 1412 my %suppress_export; 1413 my $suppress_statement = 0; 1414 1415 # Pre-scan the patch sanitizing the lines. 1416 # Pre-scan the patch looking for any __setup documentation. 1417 # 1418 my @setup_docs = (); 1419 my $setup_docs = 0; 1420 1421 sanitise_line_reset(); 1422 my $line; 1423 foreach my $rawline (@rawlines) { 1424 $linenr++; 1425 $line = $rawline; 1426 1427 if ($rawline=~/^\+\+\+\s+(\S+)/) { 1428 $setup_docs = 0; 1429 if ($1 =~ m@Documentation/kernel-parameters.txt$@) { 1430 $setup_docs = 1; 1431 } 1432 #next; 1433 } 1434 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 1435 $realline=$1-1; 1436 if (defined $2) { 1437 $realcnt=$3+1; 1438 } else { 1439 $realcnt=1+1; 1440 } 1441 $in_comment = 0; 1442 1443 # Guestimate if this is a continuing comment. Run 1444 # the context looking for a comment "edge". If this 1445 # edge is a close comment then we must be in a comment 1446 # at context start. 1447 my $edge; 1448 my $cnt = $realcnt; 1449 for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 1450 next if (defined $rawlines[$ln - 1] && 1451 $rawlines[$ln - 1] =~ /^-/); 1452 $cnt--; 1453 #print "RAW<$rawlines[$ln - 1]>\n"; 1454 last if (!defined $rawlines[$ln - 1]); 1455 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 1456 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 1457 ($edge) = $1; 1458 last; 1459 } 1460 } 1461 if (defined $edge && $edge eq '*/') { 1462 $in_comment = 1; 1463 } 1464 1465 # Guestimate if this is a continuing comment. If this 1466 # is the start of a diff block and this line starts 1467 # ' *' then it is very likely a comment. 1468 if (!defined $edge && 1469 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 1470 { 1471 $in_comment = 1; 1472 } 1473 1474 ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 1475 sanitise_line_reset($in_comment); 1476 1477 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 1478 # Standardise the strings and chars within the input to 1479 # simplify matching -- only bother with positive lines. 1480 $line = sanitise_line($rawline); 1481 } 1482 push(@lines, $line); 1483 1484 if ($realcnt > 1) { 1485 $realcnt-- if ($line =~ /^(?:\+| |$)/); 1486 } else { 1487 $realcnt = 0; 1488 } 1489 1490 #print "==>$rawline\n"; 1491 #print "-->$line\n"; 1492 1493 if ($setup_docs && $line =~ /^\+/) { 1494 push(@setup_docs, $line); 1495 } 1496 } 1497 1498 $prefix = ''; 1499 1500 $realcnt = 0; 1501 $linenr = 0; 1502 foreach my $line (@lines) { 1503 $linenr++; 1504 1505 my $rawline = $rawlines[$linenr - 1]; 1506 1507#extract the line range in the file after the patch is applied 1508 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 1509 $is_patch = 1; 1510 $first_line = $linenr + 1; 1511 $realline=$1-1; 1512 if (defined $2) { 1513 $realcnt=$3+1; 1514 } else { 1515 $realcnt=1+1; 1516 } 1517 annotate_reset(); 1518 $prev_values = 'E'; 1519 1520 %suppress_ifbraces = (); 1521 %suppress_whiletrailers = (); 1522 %suppress_export = (); 1523 $suppress_statement = 0; 1524 next; 1525 1526# track the line number as we move through the hunk, note that 1527# new versions of GNU diff omit the leading space on completely 1528# blank context lines so we need to count that too. 1529 } elsif ($line =~ /^( |\+|$)/) { 1530 $realline++; 1531 $realcnt-- if ($realcnt != 0); 1532 1533 # Measure the line length and indent. 1534 ($length, $indent) = line_stats($rawline); 1535 1536 # Track the previous line. 1537 ($prevline, $stashline) = ($stashline, $line); 1538 ($previndent, $stashindent) = ($stashindent, $indent); 1539 ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 1540 1541 #warn "line<$line>\n"; 1542 1543 } elsif ($realcnt == 1) { 1544 $realcnt--; 1545 } 1546 1547 my $hunk_line = ($realcnt != 0); 1548 1549#make up the handle for any error we report on this line 1550 $prefix = "$filename:$realline: " if ($emacs && $file); 1551 $prefix = "$filename:$linenr: " if ($emacs && !$file); 1552 1553 $here = "#$linenr: " if (!$file); 1554 $here = "#$realline: " if ($file); 1555 1556 # extract the filename as it passes 1557 if ($line =~ /^diff --git.*?(\S+)$/) { 1558 $realfile = $1; 1559 $realfile =~ s@^([^/]*)/@@; 1560 $in_commit_log = 0; 1561 } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 1562 $realfile = $1; 1563 $realfile =~ s@^([^/]*)/@@; 1564 $in_commit_log = 0; 1565 1566 $p1_prefix = $1; 1567 if (!$file && $tree && $p1_prefix ne '' && 1568 -e "$root/$p1_prefix") { 1569 WARN("PATCH_PREFIX", 1570 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 1571 } 1572 1573 if ($realfile =~ m@^include/asm/@) { 1574 ERROR("MODIFIED_INCLUDE_ASM", 1575 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 1576 } 1577 next; 1578 } 1579 1580 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 1581 1582 my $hereline = "$here\n$rawline\n"; 1583 my $herecurr = "$here\n$rawline\n"; 1584 my $hereprev = "$here\n$prevrawline\n$rawline\n"; 1585 1586 $cnt_lines++ if ($realcnt != 0); 1587 1588# Check for incorrect file permissions 1589 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 1590 my $permhere = $here . "FILE: $realfile\n"; 1591 if ($realfile =~ /(Makefile|Kconfig|\.c|\.h|\.S|\.tmpl)$/) { 1592 ERROR("EXECUTE_PERMISSIONS", 1593 "do not set execute permissions for source files\n" . $permhere); 1594 } 1595 } 1596 1597# Check the patch for a signoff: 1598 if ($line =~ /^\s*signed-off-by:/i) { 1599 $signoff++; 1600 $in_commit_log = 0; 1601 } 1602 1603# Check signature styles 1604 if (!$in_header_lines && 1605 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 1606 my $space_before = $1; 1607 my $sign_off = $2; 1608 my $space_after = $3; 1609 my $email = $4; 1610 my $ucfirst_sign_off = ucfirst(lc($sign_off)); 1611 1612 if ($sign_off !~ /$signature_tags/) { 1613 WARN("BAD_SIGN_OFF", 1614 "Non-standard signature: $sign_off\n" . $herecurr); 1615 } 1616 if (defined $space_before && $space_before ne "") { 1617 WARN("BAD_SIGN_OFF", 1618 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr); 1619 } 1620 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 1621 WARN("BAD_SIGN_OFF", 1622 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr); 1623 } 1624 if (!defined $space_after || $space_after ne " ") { 1625 WARN("BAD_SIGN_OFF", 1626 "Use a single space after $ucfirst_sign_off\n" . $herecurr); 1627 } 1628 1629 my ($email_name, $email_address, $comment) = parse_email($email); 1630 my $suggested_email = format_email(($email_name, $email_address)); 1631 if ($suggested_email eq "") { 1632 ERROR("BAD_SIGN_OFF", 1633 "Unrecognized email address: '$email'\n" . $herecurr); 1634 } else { 1635 my $dequoted = $suggested_email; 1636 $dequoted =~ s/^"//; 1637 $dequoted =~ s/" </ </; 1638 # Don't force email to have quotes 1639 # Allow just an angle bracketed address 1640 if ("$dequoted$comment" ne $email && 1641 "<$email_address>$comment" ne $email && 1642 "$suggested_email$comment" ne $email) { 1643 WARN("BAD_SIGN_OFF", 1644 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 1645 } 1646 } 1647 } 1648 1649# Check for wrappage within a valid hunk of the file 1650 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 1651 ERROR("CORRUPTED_PATCH", 1652 "patch seems to be corrupt (line wrapped?)\n" . 1653 $herecurr) if (!$emitted_corrupt++); 1654 } 1655 1656# Check for absolute kernel paths. 1657 if ($tree) { 1658 while ($line =~ m{(?:^|\s)(/\S*)}g) { 1659 my $file = $1; 1660 1661 if ($file =~ m{^(.*?)(?::\d+)+:?$} && 1662 check_absolute_file($1, $herecurr)) { 1663 # 1664 } else { 1665 check_absolute_file($file, $herecurr); 1666 } 1667 } 1668 } 1669 1670# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 1671 if (($realfile =~ /^$/ || $line =~ /^\+/) && 1672 $rawline !~ m/^$UTF8*$/) { 1673 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 1674 1675 my $blank = copy_spacing($rawline); 1676 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 1677 my $hereptr = "$hereline$ptr\n"; 1678 1679 CHK("INVALID_UTF8", 1680 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 1681 } 1682 1683# Check if it's the start of a commit log 1684# (not a header line and we haven't seen the patch filename) 1685 if ($in_header_lines && $realfile =~ /^$/ && 1686 $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) { 1687 $in_header_lines = 0; 1688 $in_commit_log = 1; 1689 } 1690 1691# Check if there is UTF-8 in a commit log when a mail header has explicitly 1692# declined it, i.e defined some charset where it is missing. 1693 if ($in_header_lines && 1694 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 1695 $1 !~ /utf-8/i) { 1696 $non_utf8_charset = 1; 1697 } 1698 1699 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 1700 $rawline =~ /$NON_ASCII_UTF8/) { 1701 WARN("UTF8_BEFORE_PATCH", 1702 "8-bit UTF-8 used in possible commit log\n" . $herecurr); 1703 } 1704 1705# ignore non-hunk lines and lines being removed 1706 next if (!$hunk_line || $line =~ /^-/); 1707 1708#trailing whitespace 1709 if ($line =~ /^\+.*\015/) { 1710 my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1711 ERROR("DOS_LINE_ENDINGS", 1712 "DOS line endings\n" . $herevet); 1713 1714 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 1715 my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1716 ERROR("TRAILING_WHITESPACE", 1717 "trailing whitespace\n" . $herevet); 1718 $rpt_cleaners = 1; 1719 } 1720 1721# check for Kconfig help text having a real description 1722# Only applies when adding the entry originally, after that we do not have 1723# sufficient context to determine whether it is indeed long enough. 1724 if ($realfile =~ /Kconfig/ && 1725 $line =~ /.\s*config\s+/) { 1726 my $length = 0; 1727 my $cnt = $realcnt; 1728 my $ln = $linenr + 1; 1729 my $f; 1730 my $is_start = 0; 1731 my $is_end = 0; 1732 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 1733 $f = $lines[$ln - 1]; 1734 $cnt-- if ($lines[$ln - 1] !~ /^-/); 1735 $is_end = $lines[$ln - 1] =~ /^\+/; 1736 1737 next if ($f =~ /^-/); 1738 1739 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) { 1740 $is_start = 1; 1741 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) { 1742 $length = -1; 1743 } 1744 1745 $f =~ s/^.//; 1746 $f =~ s/#.*//; 1747 $f =~ s/^\s+//; 1748 next if ($f =~ /^$/); 1749 if ($f =~ /^\s*config\s/) { 1750 $is_end = 1; 1751 last; 1752 } 1753 $length++; 1754 } 1755 WARN("CONFIG_DESCRIPTION", 1756 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4); 1757 #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 1758 } 1759 1760 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 1761 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 1762 my $flag = $1; 1763 my $replacement = { 1764 'EXTRA_AFLAGS' => 'asflags-y', 1765 'EXTRA_CFLAGS' => 'ccflags-y', 1766 'EXTRA_CPPFLAGS' => 'cppflags-y', 1767 'EXTRA_LDFLAGS' => 'ldflags-y', 1768 }; 1769 1770 WARN("DEPRECATED_VARIABLE", 1771 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 1772 } 1773 1774# check we are in a valid source file if not then ignore this hunk 1775 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/); 1776 1777#80 column limit 1778 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ && 1779 $rawline !~ /^.\s*\*\s*\@$Ident\s/ && 1780 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ || 1781 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) && 1782 $length > 80) 1783 { 1784 WARN("LONG_LINE", 1785 "line over 80 characters\n" . $herecurr); 1786 } 1787 1788# Check for user-visible strings broken across lines, which breaks the ability 1789# to grep for the string. Limited to strings used as parameters (those 1790# following an open parenthesis), which almost completely eliminates false 1791# positives, as well as warning only once per parameter rather than once per 1792# line of the string. Make an exception when the previous string ends in a 1793# newline (multiple lines in one string constant) or \n\t (common in inline 1794# assembly to indent the instruction on the following line). 1795 if ($line =~ /^\+\s*"/ && 1796 $prevline =~ /"\s*$/ && 1797 $prevline =~ /\(/ && 1798 $prevrawline !~ /\\n(?:\\t)*"\s*$/) { 1799 WARN("SPLIT_STRING", 1800 "quoted string split across lines\n" . $hereprev); 1801 } 1802 1803# check for spaces before a quoted newline 1804 if ($rawline =~ /^.*\".*\s\\n/) { 1805 WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 1806 "unnecessary whitespace before a quoted newline\n" . $herecurr); 1807 } 1808 1809# check for adding lines without a newline. 1810 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 1811 WARN("MISSING_EOF_NEWLINE", 1812 "adding a line without newline at end of file\n" . $herecurr); 1813 } 1814 1815# Blackfin: use hi/lo macros 1816 if ($realfile =~ m@arch/blackfin/.*\.S$@) { 1817 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { 1818 my $herevet = "$here\n" . cat_vet($line) . "\n"; 1819 ERROR("LO_MACRO", 1820 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); 1821 } 1822 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { 1823 my $herevet = "$here\n" . cat_vet($line) . "\n"; 1824 ERROR("HI_MACRO", 1825 "use the HI() macro, not (... >> 16)\n" . $herevet); 1826 } 1827 } 1828 1829# check we are in a valid source file C or perl if not then ignore this hunk 1830 next if ($realfile !~ /\.(h|c|pl)$/); 1831 1832# at the beginning of a line any tabs must come first and anything 1833# more than 8 must use tabs. 1834 if ($rawline =~ /^\+\s* \t\s*\S/ || 1835 $rawline =~ /^\+\s* \s*/) { 1836 my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1837 ERROR("CODE_INDENT", 1838 "code indent should use tabs where possible\n" . $herevet); 1839 $rpt_cleaners = 1; 1840 } 1841 1842# check for space before tabs. 1843 if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 1844 my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1845 WARN("SPACE_BEFORE_TAB", 1846 "please, no space before tabs\n" . $herevet); 1847 } 1848 1849# check for && or || at the start of a line 1850 if ($rawline =~ /^\+\s*(&&|\|\|)/) { 1851 CHK("LOGICAL_CONTINUATIONS", 1852 "Logical continuations should be on the previous line\n" . $hereprev); 1853 } 1854 1855# check multi-line statement indentation matches previous line 1856 if ($^V && $^V ge 5.10.0 && 1857 $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) { 1858 $prevline =~ /^\+(\t*)(.*)$/; 1859 my $oldindent = $1; 1860 my $rest = $2; 1861 1862 my $pos = pos_last_openparen($rest); 1863 if ($pos >= 0) { 1864 $line =~ /^(\+| )([ \t]*)/; 1865 my $newindent = $2; 1866 1867 my $goodtabindent = $oldindent . 1868 "\t" x ($pos / 8) . 1869 " " x ($pos % 8); 1870 my $goodspaceindent = $oldindent . " " x $pos; 1871 1872 if ($newindent ne $goodtabindent && 1873 $newindent ne $goodspaceindent) { 1874 CHK("PARENTHESIS_ALIGNMENT", 1875 "Alignment should match open parenthesis\n" . $hereprev); 1876 } 1877 } 1878 } 1879 1880 if ($line =~ /^\+.*\*[ \t]*\)[ \t]+/) { 1881 CHK("SPACING", 1882 "No space is necessary after a cast\n" . $hereprev); 1883 } 1884 1885 if ($realfile =~ m@^(drivers/net/|net/)@ && 1886 $rawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 1887 $prevrawline =~ /^\+[ \t]*$/) { 1888 WARN("NETWORKING_BLOCK_COMMENT_STYLE", 1889 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 1890 } 1891 1892 if ($realfile =~ m@^(drivers/net/|net/)@ && 1893 $rawline !~ m@^\+[ \t]*(\/\*|\*\/)@ && 1894 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { 1895 WARN("NETWORKING_BLOCK_COMMENT_STYLE", 1896 "networking block comments put the trailing */ on a separate line\n" . $herecurr); 1897 } 1898 1899# check for spaces at the beginning of a line. 1900# Exceptions: 1901# 1) within comments 1902# 2) indented preprocessor commands 1903# 3) hanging labels 1904 if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/) { 1905 my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1906 WARN("LEADING_SPACE", 1907 "please, no spaces at the start of a line\n" . $herevet); 1908 } 1909 1910# check we are in a valid C source file if not then ignore this hunk 1911 next if ($realfile !~ /\.(h|c)$/); 1912 1913# check for RCS/CVS revision markers 1914 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 1915 WARN("CVS_KEYWORD", 1916 "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 1917 } 1918 1919# Blackfin: don't use __builtin_bfin_[cs]sync 1920 if ($line =~ /__builtin_bfin_csync/) { 1921 my $herevet = "$here\n" . cat_vet($line) . "\n"; 1922 ERROR("CSYNC", 1923 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 1924 } 1925 if ($line =~ /__builtin_bfin_ssync/) { 1926 my $herevet = "$here\n" . cat_vet($line) . "\n"; 1927 ERROR("SSYNC", 1928 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 1929 } 1930 1931# Check for potential 'bare' types 1932 my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 1933 $realline_next); 1934#print "LINE<$line>\n"; 1935 if ($linenr >= $suppress_statement && 1936 $realcnt && $line =~ /.\s*\S/) { 1937 ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 1938 ctx_statement_block($linenr, $realcnt, 0); 1939 $stat =~ s/\n./\n /g; 1940 $cond =~ s/\n./\n /g; 1941 1942#print "linenr<$linenr> <$stat>\n"; 1943 # If this statement has no statement boundaries within 1944 # it there is no point in retrying a statement scan 1945 # until we hit end of it. 1946 my $frag = $stat; $frag =~ s/;+\s*$//; 1947 if ($frag !~ /(?:{|;)/) { 1948#print "skip<$line_nr_next>\n"; 1949 $suppress_statement = $line_nr_next; 1950 } 1951 1952 # Find the real next line. 1953 $realline_next = $line_nr_next; 1954 if (defined $realline_next && 1955 (!defined $lines[$realline_next - 1] || 1956 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 1957 $realline_next++; 1958 } 1959 1960 my $s = $stat; 1961 $s =~ s/{.*$//s; 1962 1963 # Ignore goto labels. 1964 if ($s =~ /$Ident:\*$/s) { 1965 1966 # Ignore functions being called 1967 } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 1968 1969 } elsif ($s =~ /^.\s*else\b/s) { 1970 1971 # declarations always start with types 1972 } 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) { 1973 my $type = $1; 1974 $type =~ s/\s+/ /g; 1975 possible($type, "A:" . $s); 1976 1977 # definitions in global scope can only start with types 1978 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 1979 possible($1, "B:" . $s); 1980 } 1981 1982 # any (foo ... *) is a pointer cast, and foo is a type 1983 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 1984 possible($1, "C:" . $s); 1985 } 1986 1987 # Check for any sort of function declaration. 1988 # int foo(something bar, other baz); 1989 # void (*store_gdt)(x86_descr_ptr *); 1990 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 1991 my ($name_len) = length($1); 1992 1993 my $ctx = $s; 1994 substr($ctx, 0, $name_len + 1, ''); 1995 $ctx =~ s/\)[^\)]*$//; 1996 1997 for my $arg (split(/\s*,\s*/, $ctx)) { 1998 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 1999 2000 possible($1, "D:" . $s); 2001 } 2002 } 2003 } 2004 2005 } 2006 2007# 2008# Checks which may be anchored in the context. 2009# 2010 2011# Check for switch () and associated case and default 2012# statements should be at the same indent. 2013 if ($line=~/\bswitch\s*\(.*\)/) { 2014 my $err = ''; 2015 my $sep = ''; 2016 my @ctx = ctx_block_outer($linenr, $realcnt); 2017 shift(@ctx); 2018 for my $ctx (@ctx) { 2019 my ($clen, $cindent) = line_stats($ctx); 2020 if ($ctx =~ /^\+\s*(case\s+|default:)/ && 2021 $indent != $cindent) { 2022 $err .= "$sep$ctx\n"; 2023 $sep = ''; 2024 } else { 2025 $sep = "[...]\n"; 2026 } 2027 } 2028 if ($err ne '') { 2029 ERROR("SWITCH_CASE_INDENT_LEVEL", 2030 "switch and case should be at the same indent\n$hereline$err"); 2031 } 2032 } 2033 2034# if/while/etc brace do not go on next line, unless defining a do while loop, 2035# or if that brace on the next line is for something else 2036 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 2037 my $pre_ctx = "$1$2"; 2038 2039 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 2040 2041 if ($line =~ /^\+\t{6,}/) { 2042 WARN("DEEP_INDENTATION", 2043 "Too many leading tabs - consider code refactoring\n" . $herecurr); 2044 } 2045 2046 my $ctx_cnt = $realcnt - $#ctx - 1; 2047 my $ctx = join("\n", @ctx); 2048 2049 my $ctx_ln = $linenr; 2050 my $ctx_skip = $realcnt; 2051 2052 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 2053 defined $lines[$ctx_ln - 1] && 2054 $lines[$ctx_ln - 1] =~ /^-/)) { 2055 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 2056 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 2057 $ctx_ln++; 2058 } 2059 2060 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 2061 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 2062 2063 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 2064 ERROR("OPEN_BRACE", 2065 "that open brace { should be on the previous line\n" . 2066 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 2067 } 2068 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 2069 $ctx =~ /\)\s*\;\s*$/ && 2070 defined $lines[$ctx_ln - 1]) 2071 { 2072 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 2073 if ($nindent > $indent) { 2074 WARN("TRAILING_SEMICOLON", 2075 "trailing semicolon indicates no statements, indent implies otherwise\n" . 2076 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 2077 } 2078 } 2079 } 2080 2081# Check relative indent for conditionals and blocks. 2082 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 2083 ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 2084 ctx_statement_block($linenr, $realcnt, 0) 2085 if (!defined $stat); 2086 my ($s, $c) = ($stat, $cond); 2087 2088 substr($s, 0, length($c), ''); 2089 2090 # Make sure we remove the line prefixes as we have 2091 # none on the first line, and are going to readd them 2092 # where necessary. 2093 $s =~ s/\n./\n/gs; 2094 2095 # Find out how long the conditional actually is. 2096 my @newlines = ($c =~ /\n/gs); 2097 my $cond_lines = 1 + $#newlines; 2098 2099 # We want to check the first line inside the block 2100 # starting at the end of the conditional, so remove: 2101 # 1) any blank line termination 2102 # 2) any opening brace { on end of the line 2103 # 3) any do (...) { 2104 my $continuation = 0; 2105 my $check = 0; 2106 $s =~ s/^.*\bdo\b//; 2107 $s =~ s/^\s*{//; 2108 if ($s =~ s/^\s*\\//) { 2109 $continuation = 1; 2110 } 2111 if ($s =~ s/^\s*?\n//) { 2112 $check = 1; 2113 $cond_lines++; 2114 } 2115 2116 # Also ignore a loop construct at the end of a 2117 # preprocessor statement. 2118 if (($prevline =~ /^.\s*#\s*define\s/ || 2119 $prevline =~ /\\\s*$/) && $continuation == 0) { 2120 $check = 0; 2121 } 2122 2123 my $cond_ptr = -1; 2124 $continuation = 0; 2125 while ($cond_ptr != $cond_lines) { 2126 $cond_ptr = $cond_lines; 2127 2128 # If we see an #else/#elif then the code 2129 # is not linear. 2130 if ($s =~ /^\s*\#\s*(?:else|elif)/) { 2131 $check = 0; 2132 } 2133 2134 # Ignore: 2135 # 1) blank lines, they should be at 0, 2136 # 2) preprocessor lines, and 2137 # 3) labels. 2138 if ($continuation || 2139 $s =~ /^\s*?\n/ || 2140 $s =~ /^\s*#\s*?/ || 2141 $s =~ /^\s*$Ident\s*:/) { 2142 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 2143 if ($s =~ s/^.*?\n//) { 2144 $cond_lines++; 2145 } 2146 } 2147 } 2148 2149 my (undef, $sindent) = line_stats("+" . $s); 2150 my $stat_real = raw_line($linenr, $cond_lines); 2151 2152 # Check if either of these lines are modified, else 2153 # this is not this patch's fault. 2154 if (!defined($stat_real) || 2155 $stat !~ /^\+/ && $stat_real !~ /^\+/) { 2156 $check = 0; 2157 } 2158 if (defined($stat_real) && $cond_lines > 1) { 2159 $stat_real = "[...]\n$stat_real"; 2160 } 2161 2162 #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"; 2163 2164 if ($check && (($sindent % 8) != 0 || 2165 ($sindent <= $indent && $s ne ''))) { 2166 WARN("SUSPECT_CODE_INDENT", 2167 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 2168 } 2169 } 2170 2171 # Track the 'values' across context and added lines. 2172 my $opline = $line; $opline =~ s/^./ /; 2173 my ($curr_values, $curr_vars) = 2174 annotate_values($opline . "\n", $prev_values); 2175 $curr_values = $prev_values . $curr_values; 2176 if ($dbg_values) { 2177 my $outline = $opline; $outline =~ s/\t/ /g; 2178 print "$linenr > .$outline\n"; 2179 print "$linenr > $curr_values\n"; 2180 print "$linenr > $curr_vars\n"; 2181 } 2182 $prev_values = substr($curr_values, -1); 2183 2184#ignore lines not being added 2185 if ($line=~/^[^\+]/) {next;} 2186 2187# TEST: allow direct testing of the type matcher. 2188 if ($dbg_type) { 2189 if ($line =~ /^.\s*$Declare\s*$/) { 2190 ERROR("TEST_TYPE", 2191 "TEST: is type\n" . $herecurr); 2192 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 2193 ERROR("TEST_NOT_TYPE", 2194 "TEST: is not type ($1 is)\n". $herecurr); 2195 } 2196 next; 2197 } 2198# TEST: allow direct testing of the attribute matcher. 2199 if ($dbg_attr) { 2200 if ($line =~ /^.\s*$Modifier\s*$/) { 2201 ERROR("TEST_ATTR", 2202 "TEST: is attr\n" . $herecurr); 2203 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 2204 ERROR("TEST_NOT_ATTR", 2205 "TEST: is not attr ($1 is)\n". $herecurr); 2206 } 2207 next; 2208 } 2209 2210# check for initialisation to aggregates open brace on the next line 2211 if ($line =~ /^.\s*{/ && 2212 $prevline =~ /(?:^|[^=])=\s*$/) { 2213 ERROR("OPEN_BRACE", 2214 "that open brace { should be on the previous line\n" . $hereprev); 2215 } 2216 2217# 2218# Checks which are anchored on the added line. 2219# 2220 2221# check for malformed paths in #include statements (uses RAW line) 2222 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 2223 my $path = $1; 2224 if ($path =~ m{//}) { 2225 ERROR("MALFORMED_INCLUDE", 2226 "malformed #include filename\n" . 2227 $herecurr); 2228 } 2229 } 2230 2231# no C99 // comments 2232 if ($line =~ m{//}) { 2233 ERROR("C99_COMMENTS", 2234 "do not use C99 // comments\n" . $herecurr); 2235 } 2236 # Remove C99 comments. 2237 $line =~ s@//.*@@; 2238 $opline =~ s@//.*@@; 2239 2240# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 2241# the whole statement. 2242#print "APW <$lines[$realline_next - 1]>\n"; 2243 if (defined $realline_next && 2244 exists $lines[$realline_next - 1] && 2245 !defined $suppress_export{$realline_next} && 2246 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 2247 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 2248 # Handle definitions which produce identifiers with 2249 # a prefix: 2250 # XXX(foo); 2251 # EXPORT_SYMBOL(something_foo); 2252 my $name = $1; 2253 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 2254 $name =~ /^${Ident}_$2/) { 2255#print "FOO C name<$name>\n"; 2256 $suppress_export{$realline_next} = 1; 2257 2258 } elsif ($stat !~ /(?: 2259 \n.}\s*$| 2260 ^.DEFINE_$Ident\(\Q$name\E\)| 2261 ^.DECLARE_$Ident\(\Q$name\E\)| 2262 ^.LIST_HEAD\(\Q$name\E\)| 2263 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 2264 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 2265 )/x) { 2266#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 2267 $suppress_export{$realline_next} = 2; 2268 } else { 2269 $suppress_export{$realline_next} = 1; 2270 } 2271 } 2272 if (!defined $suppress_export{$linenr} && 2273 $prevline =~ /^.\s*$/ && 2274 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 2275 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 2276#print "FOO B <$lines[$linenr - 1]>\n"; 2277 $suppress_export{$linenr} = 2; 2278 } 2279 if (defined $suppress_export{$linenr} && 2280 $suppress_export{$linenr} == 2) { 2281 WARN("EXPORT_SYMBOL", 2282 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 2283 } 2284 2285# check for global initialisers. 2286 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) { 2287 ERROR("GLOBAL_INITIALISERS", 2288 "do not initialise globals to 0 or NULL\n" . 2289 $herecurr); 2290 } 2291# check for static initialisers. 2292 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) { 2293 ERROR("INITIALISED_STATIC", 2294 "do not initialise statics to 0 or NULL\n" . 2295 $herecurr); 2296 } 2297 2298# check for static const char * arrays. 2299 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 2300 WARN("STATIC_CONST_CHAR_ARRAY", 2301 "static const char * array should probably be static const char * const\n" . 2302 $herecurr); 2303 } 2304 2305# check for static char foo[] = "bar" declarations. 2306 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 2307 WARN("STATIC_CONST_CHAR_ARRAY", 2308 "static char array declaration should probably be static const char\n" . 2309 $herecurr); 2310 } 2311 2312# check for declarations of struct pci_device_id 2313 if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) { 2314 WARN("DEFINE_PCI_DEVICE_TABLE", 2315 "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr); 2316 } 2317 2318# check for new typedefs, only function parameters and sparse annotations 2319# make sense. 2320 if ($line =~ /\btypedef\s/ && 2321 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 2322 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 2323 $line !~ /\b$typeTypedefs\b/ && 2324 $line !~ /\b__bitwise(?:__|)\b/) { 2325 WARN("NEW_TYPEDEFS", 2326 "do not add new typedefs\n" . $herecurr); 2327 } 2328 2329# * goes on variable not on type 2330 # (char*[ const]) 2331 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 2332 #print "AA<$1>\n"; 2333 my ($from, $to) = ($2, $2); 2334 2335 # Should start with a space. 2336 $to =~ s/^(\S)/ $1/; 2337 # Should not end with a space. 2338 $to =~ s/\s+$//; 2339 # '*'s should not have spaces between. 2340 while ($to =~ s/\*\s+\*/\*\*/) { 2341 } 2342 2343 #print "from<$from> to<$to>\n"; 2344 if ($from ne $to) { 2345 ERROR("POINTER_LOCATION", 2346 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr); 2347 } 2348 } 2349 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 2350 #print "BB<$1>\n"; 2351 my ($from, $to, $ident) = ($2, $2, $3); 2352 2353 # Should start with a space. 2354 $to =~ s/^(\S)/ $1/; 2355 # Should not end with a space. 2356 $to =~ s/\s+$//; 2357 # '*'s should not have spaces between. 2358 while ($to =~ s/\*\s+\*/\*\*/) { 2359 } 2360 # Modifiers should have spaces. 2361 $to =~ s/(\b$Modifier$)/$1 /; 2362 2363 #print "from<$from> to<$to> ident<$ident>\n"; 2364 if ($from ne $to && $ident !~ /^$Modifier$/) { 2365 ERROR("POINTER_LOCATION", 2366 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr); 2367 } 2368 } 2369 2370# # no BUG() or BUG_ON() 2371# if ($line =~ /\b(BUG|BUG_ON)\b/) { 2372# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; 2373# print "$herecurr"; 2374# $clean = 0; 2375# } 2376 2377 if ($line =~ /\bLINUX_VERSION_CODE\b/) { 2378 WARN("LINUX_VERSION_CODE", 2379 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 2380 } 2381 2382# check for uses of printk_ratelimit 2383 if ($line =~ /\bprintk_ratelimit\s*\(/) { 2384 WARN("PRINTK_RATELIMITED", 2385"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 2386 } 2387 2388# printk should use KERN_* levels. Note that follow on printk's on the 2389# same line do not need a level, so we use the current block context 2390# to try and find and validate the current printk. In summary the current 2391# printk includes all preceding printk's which have no newline on the end. 2392# we assume the first bad printk is the one to report. 2393 if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 2394 my $ok = 0; 2395 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 2396 #print "CHECK<$lines[$ln - 1]\n"; 2397 # we have a preceding printk if it ends 2398 # with "\n" ignore it, else it is to blame 2399 if ($lines[$ln - 1] =~ m{\bprintk\(}) { 2400 if ($rawlines[$ln - 1] !~ m{\\n"}) { 2401 $ok = 1; 2402 } 2403 last; 2404 } 2405 } 2406 if ($ok == 0) { 2407 WARN("PRINTK_WITHOUT_KERN_LEVEL", 2408 "printk() should include KERN_ facility level\n" . $herecurr); 2409 } 2410 } 2411 2412 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 2413 my $orig = $1; 2414 my $level = lc($orig); 2415 $level = "warn" if ($level eq "warning"); 2416 my $level2 = $level; 2417 $level2 = "dbg" if ($level eq "debug"); 2418 WARN("PREFER_PR_LEVEL", 2419 "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 2420 } 2421 2422 if ($line =~ /\bpr_warning\s*\(/) { 2423 WARN("PREFER_PR_LEVEL", 2424 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr); 2425 } 2426 2427# function brace can't be on same line, except for #defines of do while, 2428# or if closed on same line 2429 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and 2430 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { 2431 ERROR("OPEN_BRACE", 2432 "open brace '{' following function declarations go on the next line\n" . $herecurr); 2433 } 2434 2435# open braces for enum, union and struct go on the same line. 2436 if ($line =~ /^.\s*{/ && 2437 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 2438 ERROR("OPEN_BRACE", 2439 "open brace '{' following $1 go on the same line\n" . $hereprev); 2440 } 2441 2442# missing space after union, struct or enum definition 2443 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) { 2444 WARN("SPACING", 2445 "missing space after $1 definition\n" . $herecurr); 2446 } 2447 2448# check for spacing round square brackets; allowed: 2449# 1. with a type on the left -- int [] a; 2450# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 2451# 3. inside a curly brace -- = { [0...10] = 5 } 2452 while ($line =~ /(.*?\s)\[/g) { 2453 my ($where, $prefix) = ($-[1], $1); 2454 if ($prefix !~ /$Type\s+$/ && 2455 ($where != 0 || $prefix !~ /^.\s+$/) && 2456 $prefix !~ /[{,]\s+$/) { 2457 ERROR("BRACKET_SPACE", 2458 "space prohibited before open square bracket '['\n" . $herecurr); 2459 } 2460 } 2461 2462# check for spaces between functions and their parentheses. 2463 while ($line =~ /($Ident)\s+\(/g) { 2464 my $name = $1; 2465 my $ctx_before = substr($line, 0, $-[1]); 2466 my $ctx = "$ctx_before$name"; 2467 2468 # Ignore those directives where spaces _are_ permitted. 2469 if ($name =~ /^(?: 2470 if|for|while|switch|return|case| 2471 volatile|__volatile__| 2472 __attribute__|format|__extension__| 2473 asm|__asm__)$/x) 2474 { 2475 2476 # cpp #define statements have non-optional spaces, ie 2477 # if there is a space between the name and the open 2478 # parenthesis it is simply not a parameter group. 2479 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 2480 2481 # cpp #elif statement condition may start with a ( 2482 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 2483 2484 # If this whole things ends with a type its most 2485 # likely a typedef for a function. 2486 } elsif ($ctx =~ /$Type$/) { 2487 2488 } else { 2489 WARN("SPACING", 2490 "space prohibited between function name and open parenthesis '('\n" . $herecurr); 2491 } 2492 } 2493 2494# check for whitespace before a non-naked semicolon 2495 if ($line =~ /^\+.*\S\s+;/) { 2496 CHK("SPACING", 2497 "space prohibited before semicolon\n" . $herecurr); 2498 } 2499 2500# Check operator spacing. 2501 if (!($line=~/\#\s*include/)) { 2502 my $ops = qr{ 2503 <<=|>>=|<=|>=|==|!=| 2504 \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 2505 =>|->|<<|>>|<|>|=|!|~| 2506 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 2507 \?|: 2508 }x; 2509 my @elements = split(/($ops|;)/, $opline); 2510 my $off = 0; 2511 2512 my $blank = copy_spacing($opline); 2513 2514 for (my $n = 0; $n < $#elements; $n += 2) { 2515 $off += length($elements[$n]); 2516 2517 # Pick up the preceding and succeeding characters. 2518 my $ca = substr($opline, 0, $off); 2519 my $cc = ''; 2520 if (length($opline) >= ($off + length($elements[$n + 1]))) { 2521 $cc = substr($opline, $off + length($elements[$n + 1])); 2522 } 2523 my $cb = "$ca$;$cc"; 2524 2525 my $a = ''; 2526 $a = 'V' if ($elements[$n] ne ''); 2527 $a = 'W' if ($elements[$n] =~ /\s$/); 2528 $a = 'C' if ($elements[$n] =~ /$;$/); 2529 $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 2530 $a = 'O' if ($elements[$n] eq ''); 2531 $a = 'E' if ($ca =~ /^\s*$/); 2532 2533 my $op = $elements[$n + 1]; 2534 2535 my $c = ''; 2536 if (defined $elements[$n + 2]) { 2537 $c = 'V' if ($elements[$n + 2] ne ''); 2538 $c = 'W' if ($elements[$n + 2] =~ /^\s/); 2539 $c = 'C' if ($elements[$n + 2] =~ /^$;/); 2540 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 2541 $c = 'O' if ($elements[$n + 2] eq ''); 2542 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 2543 } else { 2544 $c = 'E'; 2545 } 2546 2547 my $ctx = "${a}x${c}"; 2548 2549 my $at = "(ctx:$ctx)"; 2550 2551 my $ptr = substr($blank, 0, $off) . "^"; 2552 my $hereptr = "$hereline$ptr\n"; 2553 2554 # Pull out the value of this operator. 2555 my $op_type = substr($curr_values, $off + 1, 1); 2556 2557 # Get the full operator variant. 2558 my $opv = $op . substr($curr_vars, $off, 1); 2559 2560 # Ignore operators passed as parameters. 2561 if ($op_type ne 'V' && 2562 $ca =~ /\s$/ && $cc =~ /^\s*,/) { 2563 2564# # Ignore comments 2565# } elsif ($op =~ /^$;+$/) { 2566 2567 # ; should have either the end of line or a space or \ after it 2568 } elsif ($op eq ';') { 2569 if ($ctx !~ /.x[WEBC]/ && 2570 $cc !~ /^\\/ && $cc !~ /^;/) { 2571 ERROR("SPACING", 2572 "space required after that '$op' $at\n" . $hereptr); 2573 } 2574 2575 # // is a comment 2576 } elsif ($op eq '//') { 2577 2578 # No spaces for: 2579 # -> 2580 # : when part of a bitfield 2581 } elsif ($op eq '->' || $opv eq ':B') { 2582 if ($ctx =~ /Wx.|.xW/) { 2583 ERROR("SPACING", 2584 "spaces prohibited around that '$op' $at\n" . $hereptr); 2585 } 2586 2587 # , must have a space on the right. 2588 } elsif ($op eq ',') { 2589 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 2590 ERROR("SPACING", 2591 "space required after that '$op' $at\n" . $hereptr); 2592 } 2593 2594 # '*' as part of a type definition -- reported already. 2595 } elsif ($opv eq '*_') { 2596 #warn "'*' is part of type\n"; 2597 2598 # unary operators should have a space before and 2599 # none after. May be left adjacent to another 2600 # unary operator, or a cast 2601 } elsif ($op eq '!' || $op eq '~' || 2602 $opv eq '*U' || $opv eq '-U' || 2603 $opv eq '&U' || $opv eq '&&U') { 2604 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 2605 ERROR("SPACING", 2606 "space required before that '$op' $at\n" . $hereptr); 2607 } 2608 if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 2609 # A unary '*' may be const 2610 2611 } elsif ($ctx =~ /.xW/) { 2612 ERROR("SPACING", 2613 "space prohibited after that '$op' $at\n" . $hereptr); 2614 } 2615 2616 # unary ++ and unary -- are allowed no space on one side. 2617 } elsif ($op eq '++' or $op eq '--') { 2618 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 2619 ERROR("SPACING", 2620 "space required one side of that '$op' $at\n" . $hereptr); 2621 } 2622 if ($ctx =~ /Wx[BE]/ || 2623 ($ctx =~ /Wx./ && $cc =~ /^;/)) { 2624 ERROR("SPACING", 2625 "space prohibited before that '$op' $at\n" . $hereptr); 2626 } 2627 if ($ctx =~ /ExW/) { 2628 ERROR("SPACING", 2629 "space prohibited after that '$op' $at\n" . $hereptr); 2630 } 2631 2632 2633 # << and >> may either have or not have spaces both sides 2634 } elsif ($op eq '<<' or $op eq '>>' or 2635 $op eq '&' or $op eq '^' or $op eq '|' or 2636 $op eq '+' or $op eq '-' or 2637 $op eq '*' or $op eq '/' or 2638 $op eq '%') 2639 { 2640 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 2641 ERROR("SPACING", 2642 "need consistent spacing around '$op' $at\n" . 2643 $hereptr); 2644 } 2645 2646 # A colon needs no spaces before when it is 2647 # terminating a case value or a label. 2648 } elsif ($opv eq ':C' || $opv eq ':L') { 2649 if ($ctx =~ /Wx./) { 2650 ERROR("SPACING", 2651 "space prohibited before that '$op' $at\n" . $hereptr); 2652 } 2653 2654 # All the others need spaces both sides. 2655 } elsif ($ctx !~ /[EWC]x[CWE]/) { 2656 my $ok = 0; 2657 2658 # Ignore email addresses <foo@bar> 2659 if (($op eq '<' && 2660 $cc =~ /^\S+\@\S+>/) || 2661 ($op eq '>' && 2662 $ca =~ /<\S+\@\S+$/)) 2663 { 2664 $ok = 1; 2665 } 2666 2667 # Ignore ?: 2668 if (($opv eq ':O' && $ca =~ /\?$/) || 2669 ($op eq '?' && $cc =~ /^:/)) { 2670 $ok = 1; 2671 } 2672 2673 if ($ok == 0) { 2674 ERROR("SPACING", 2675 "spaces required around that '$op' $at\n" . $hereptr); 2676 } 2677 } 2678 $off += length($elements[$n + 1]); 2679 } 2680 } 2681 2682# check for multiple assignments 2683 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 2684 CHK("MULTIPLE_ASSIGNMENTS", 2685 "multiple assignments should be avoided\n" . $herecurr); 2686 } 2687 2688## # check for multiple declarations, allowing for a function declaration 2689## # continuation. 2690## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 2691## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 2692## 2693## # Remove any bracketed sections to ensure we do not 2694## # falsly report the parameters of functions. 2695## my $ln = $line; 2696## while ($ln =~ s/\([^\(\)]*\)//g) { 2697## } 2698## if ($ln =~ /,/) { 2699## WARN("MULTIPLE_DECLARATION", 2700## "declaring multiple variables together should be avoided\n" . $herecurr); 2701## } 2702## } 2703 2704#need space before brace following if, while, etc 2705 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || 2706 $line =~ /do{/) { 2707 ERROR("SPACING", 2708 "space required before the open brace '{'\n" . $herecurr); 2709 } 2710 2711# closing brace should have a space following it when it has anything 2712# on the line 2713 if ($line =~ /}(?!(?:,|;|\)))\S/) { 2714 ERROR("SPACING", 2715 "space required after that close brace '}'\n" . $herecurr); 2716 } 2717 2718# check spacing on square brackets 2719 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 2720 ERROR("SPACING", 2721 "space prohibited after that open square bracket '['\n" . $herecurr); 2722 } 2723 if ($line =~ /\s\]/) { 2724 ERROR("SPACING", 2725 "space prohibited before that close square bracket ']'\n" . $herecurr); 2726 } 2727 2728# check spacing on parentheses 2729 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 2730 $line !~ /for\s*\(\s+;/) { 2731 ERROR("SPACING", 2732 "space prohibited after that open parenthesis '('\n" . $herecurr); 2733 } 2734 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 2735 $line !~ /for\s*\(.*;\s+\)/ && 2736 $line !~ /:\s+\)/) { 2737 ERROR("SPACING", 2738 "space prohibited before that close parenthesis ')'\n" . $herecurr); 2739 } 2740 2741#goto labels aren't indented, allow a single space however 2742 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 2743 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 2744 WARN("INDENTED_LABEL", 2745 "labels should not be indented\n" . $herecurr); 2746 } 2747 2748# Return is not a function. 2749 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) { 2750 my $spacing = $1; 2751 my $value = $2; 2752 2753 # Flatten any parentheses 2754 $value =~ s/\(/ \(/g; 2755 $value =~ s/\)/\) /g; 2756 while ($value =~ s/\[[^\[\]]*\]/1/ || 2757 $value !~ /(?:$Ident|-?$Constant)\s* 2758 $Compare\s* 2759 (?:$Ident|-?$Constant)/x && 2760 $value =~ s/\([^\(\)]*\)/1/) { 2761 } 2762#print "value<$value>\n"; 2763 if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) { 2764 ERROR("RETURN_PARENTHESES", 2765 "return is not a function, parentheses are not required\n" . $herecurr); 2766 2767 } elsif ($spacing !~ /\s+/) { 2768 ERROR("SPACING", 2769 "space required before the open parenthesis '('\n" . $herecurr); 2770 } 2771 } 2772# Return of what appears to be an errno should normally be -'ve 2773 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) { 2774 my $name = $1; 2775 if ($name ne 'EOF' && $name ne 'ERROR') { 2776 WARN("USE_NEGATIVE_ERRNO", 2777 "return of an errno should typically be -ve (return -$1)\n" . $herecurr); 2778 } 2779 } 2780 2781# Need a space before open parenthesis after if, while etc 2782 if ($line=~/\b(if|while|for|switch)\(/) { 2783 ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr); 2784 } 2785 2786# Check for illegal assignment in if conditional -- and check for trailing 2787# statements after the conditional. 2788 if ($line =~ /do\s*(?!{)/) { 2789 ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 2790 ctx_statement_block($linenr, $realcnt, 0) 2791 if (!defined $stat); 2792 my ($stat_next) = ctx_statement_block($line_nr_next, 2793 $remain_next, $off_next); 2794 $stat_next =~ s/\n./\n /g; 2795 ##print "stat<$stat> stat_next<$stat_next>\n"; 2796 2797 if ($stat_next =~ /^\s*while\b/) { 2798 # If the statement carries leading newlines, 2799 # then count those as offsets. 2800 my ($whitespace) = 2801 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 2802 my $offset = 2803 statement_rawlines($whitespace) - 1; 2804 2805 $suppress_whiletrailers{$line_nr_next + 2806 $offset} = 1; 2807 } 2808 } 2809 if (!defined $suppress_whiletrailers{$linenr} && 2810 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 2811 my ($s, $c) = ($stat, $cond); 2812 2813 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 2814 ERROR("ASSIGN_IN_IF", 2815 "do not use assignment in if condition\n" . $herecurr); 2816 } 2817 2818 # Find out what is on the end of the line after the 2819 # conditional. 2820 substr($s, 0, length($c), ''); 2821 $s =~ s/\n.*//g; 2822 $s =~ s/$;//g; # Remove any comments 2823 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 2824 $c !~ /}\s*while\s*/) 2825 { 2826 # Find out how long the conditional actually is. 2827 my @newlines = ($c =~ /\n/gs); 2828 my $cond_lines = 1 + $#newlines; 2829 my $stat_real = ''; 2830 2831 $stat_real = raw_line($linenr, $cond_lines) 2832 . "\n" if ($cond_lines); 2833 if (defined($stat_real) && $cond_lines > 1) { 2834 $stat_real = "[...]\n$stat_real"; 2835 } 2836 2837 ERROR("TRAILING_STATEMENTS", 2838 "trailing statements should be on next line\n" . $herecurr . $stat_real); 2839 } 2840 } 2841 2842# Check for bitwise tests written as boolean 2843 if ($line =~ / 2844 (?: 2845 (?:\[|\(|\&\&|\|\|) 2846 \s*0[xX][0-9]+\s* 2847 (?:\&\&|\|\|) 2848 | 2849 (?:\&\&|\|\|) 2850 \s*0[xX][0-9]+\s* 2851 (?:\&\&|\|\||\)|\]) 2852 )/x) 2853 { 2854 WARN("HEXADECIMAL_BOOLEAN_TEST", 2855 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 2856 } 2857 2858# if and else should not have general statements after it 2859 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 2860 my $s = $1; 2861 $s =~ s/$;//g; # Remove any comments 2862 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 2863 ERROR("TRAILING_STATEMENTS", 2864 "trailing statements should be on next line\n" . $herecurr); 2865 } 2866 } 2867# if should not continue a brace 2868 if ($line =~ /}\s*if\b/) { 2869 ERROR("TRAILING_STATEMENTS", 2870 "trailing statements should be on next line\n" . 2871 $herecurr); 2872 } 2873# case and default should not have general statements after them 2874 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 2875 $line !~ /\G(?: 2876 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 2877 \s*return\s+ 2878 )/xg) 2879 { 2880 ERROR("TRAILING_STATEMENTS", 2881 "trailing statements should be on next line\n" . $herecurr); 2882 } 2883 2884 # Check for }<nl>else {, these must be at the same 2885 # indent level to be relevant to each other. 2886 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and 2887 $previndent == $indent) { 2888 ERROR("ELSE_AFTER_BRACE", 2889 "else should follow close brace '}'\n" . $hereprev); 2890 } 2891 2892 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and 2893 $previndent == $indent) { 2894 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 2895 2896 # Find out what is on the end of the line after the 2897 # conditional. 2898 substr($s, 0, length($c), ''); 2899 $s =~ s/\n.*//g; 2900 2901 if ($s =~ /^\s*;/) { 2902 ERROR("WHILE_AFTER_BRACE", 2903 "while should follow close brace '}'\n" . $hereprev); 2904 } 2905 } 2906 2907#studly caps, commented out until figure out how to distinguish between use of existing and adding new 2908# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) { 2909# print "No studly caps, use _\n"; 2910# print "$herecurr"; 2911# $clean = 0; 2912# } 2913 2914#no spaces allowed after \ in define 2915 if ($line=~/\#\s*define.*\\\s$/) { 2916 WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 2917 "Whitepspace after \\ makes next lines useless\n" . $herecurr); 2918 } 2919 2920#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line) 2921 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 2922 my $file = "$1.h"; 2923 my $checkfile = "include/linux/$file"; 2924 if (-f "$root/$checkfile" && 2925 $realfile ne $checkfile && 2926 $1 !~ /$allowed_asm_includes/) 2927 { 2928 if ($realfile =~ m{^arch/}) { 2929 CHK("ARCH_INCLUDE_LINUX", 2930 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 2931 } else { 2932 WARN("INCLUDE_LINUX", 2933 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 2934 } 2935 } 2936 } 2937 2938# multi-statement macros should be enclosed in a do while loop, grab the 2939# first statement and ensure its the whole macro if its not enclosed 2940# in a known good container 2941 if ($realfile !~ m@/vmlinux.lds.h$@ && 2942 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 2943 my $ln = $linenr; 2944 my $cnt = $realcnt; 2945 my ($off, $dstat, $dcond, $rest); 2946 my $ctx = ''; 2947 ($dstat, $dcond, $ln, $cnt, $off) = 2948 ctx_statement_block($linenr, $realcnt, 0); 2949 $ctx = $dstat; 2950 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 2951 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 2952 2953 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; 2954 $dstat =~ s/$;//g; 2955 $dstat =~ s/\\\n.//g; 2956 $dstat =~ s/^\s*//s; 2957 $dstat =~ s/\s*$//s; 2958 2959 # Flatten any parentheses and braces 2960 while ($dstat =~ s/\([^\(\)]*\)/1/ || 2961 $dstat =~ s/\{[^\{\}]*\}/1/ || 2962 $dstat =~ s/\[[^\[\]]*\]/1/) 2963 { 2964 } 2965 2966 # Flatten any obvious string concatentation. 2967 while ($dstat =~ s/("X*")\s*$Ident/$1/ || 2968 $dstat =~ s/$Ident\s*("X*")/$1/) 2969 { 2970 } 2971 2972 my $exceptions = qr{ 2973 $Declare| 2974 module_param_named| 2975 MODULE_PARM_DESC| 2976 DECLARE_PER_CPU| 2977 DEFINE_PER_CPU| 2978 __typeof__\(| 2979 union| 2980 struct| 2981 \.$Ident\s*=\s*| 2982 ^\"|\"$ 2983 }x; 2984 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 2985 if ($dstat ne '' && 2986 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 2987 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 2988 $dstat !~ /^[!~-]?(?:$Ident|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo 2989 $dstat !~ /^'X'$/ && # character constants 2990 $dstat !~ /$exceptions/ && 2991 $dstat !~ /^\.$Ident\s*=/ && # .foo = 2992 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 2993 $dstat !~ /^for\s*$Constant$/ && # for (...) 2994 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 2995 $dstat !~ /^do\s*{/ && # do {... 2996 $dstat !~ /^\({/) # ({... 2997 { 2998 $ctx =~ s/\n*$//; 2999 my $herectx = $here . "\n"; 3000 my $cnt = statement_rawlines($ctx); 3001 3002 for (my $n = 0; $n < $cnt; $n++) { 3003 $herectx .= raw_line($linenr, $n) . "\n"; 3004 } 3005 3006 if ($dstat =~ /;/) { 3007 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 3008 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 3009 } else { 3010 ERROR("COMPLEX_MACRO", 3011 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx"); 3012 } 3013 } 3014 } 3015 3016# do {} while (0) macro tests: 3017# single-statement macros do not need to be enclosed in do while (0) loop, 3018# macro should not end with a semicolon 3019 if ($^V && $^V ge 5.10.0 && 3020 $realfile !~ m@/vmlinux.lds.h$@ && 3021 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 3022 my $ln = $linenr; 3023 my $cnt = $realcnt; 3024 my ($off, $dstat, $dcond, $rest); 3025 my $ctx = ''; 3026 ($dstat, $dcond, $ln, $cnt, $off) = 3027 ctx_statement_block($linenr, $realcnt, 0); 3028 $ctx = $dstat; 3029 3030 $dstat =~ s/\\\n.//g; 3031 3032 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 3033 my $stmts = $2; 3034 my $semis = $3; 3035 3036 $ctx =~ s/\n*$//; 3037 my $cnt = statement_rawlines($ctx); 3038 my $herectx = $here . "\n"; 3039 3040 for (my $n = 0; $n < $cnt; $n++) { 3041 $herectx .= raw_line($linenr, $n) . "\n"; 3042 } 3043 3044 if (($stmts =~ tr/;/;/) == 1 && 3045 $stmts !~ /^\s*(if|while|for|switch)\b/) { 3046 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 3047 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 3048 } 3049 if (defined $semis && $semis ne "") { 3050 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 3051 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 3052 } 3053 } 3054 } 3055 3056# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 3057# all assignments may have only one of the following with an assignment: 3058# . 3059# ALIGN(...) 3060# VMLINUX_SYMBOL(...) 3061 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 3062 WARN("MISSING_VMLINUX_SYMBOL", 3063 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 3064 } 3065 3066# check for redundant bracing round if etc 3067 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 3068 my ($level, $endln, @chunks) = 3069 ctx_statement_full($linenr, $realcnt, 1); 3070 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 3071 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 3072 if ($#chunks > 0 && $level == 0) { 3073 my @allowed = (); 3074 my $allow = 0; 3075 my $seen = 0; 3076 my $herectx = $here . "\n"; 3077 my $ln = $linenr - 1; 3078 for my $chunk (@chunks) { 3079 my ($cond, $block) = @{$chunk}; 3080 3081 # If the condition carries leading newlines, then count those as offsets. 3082 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 3083 my $offset = statement_rawlines($whitespace) - 1; 3084 3085 $allowed[$allow] = 0; 3086 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 3087 3088 # We have looked at and allowed this specific line. 3089 $suppress_ifbraces{$ln + $offset} = 1; 3090 3091 $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 3092 $ln += statement_rawlines($block) - 1; 3093 3094 substr($block, 0, length($cond), ''); 3095 3096 $seen++ if ($block =~ /^\s*{/); 3097 3098 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 3099 if (statement_lines($cond) > 1) { 3100 #print "APW: ALLOWED: cond<$cond>\n"; 3101 $allowed[$allow] = 1; 3102 } 3103 if ($block =~/\b(?:if|for|while)\b/) { 3104 #print "APW: ALLOWED: block<$block>\n"; 3105 $allowed[$allow] = 1; 3106 } 3107 if (statement_block_size($block) > 1) { 3108 #print "APW: ALLOWED: lines block<$block>\n"; 3109 $allowed[$allow] = 1; 3110 } 3111 $allow++; 3112 } 3113 if ($seen) { 3114 my $sum_allowed = 0; 3115 foreach (@allowed) { 3116 $sum_allowed += $_; 3117 } 3118 if ($sum_allowed == 0) { 3119 WARN("BRACES", 3120 "braces {} are not necessary for any arm of this statement\n" . $herectx); 3121 } elsif ($sum_allowed != $allow && 3122 $seen != $allow) { 3123 CHK("BRACES", 3124 "braces {} should be used on all arms of this statement\n" . $herectx); 3125 } 3126 } 3127 } 3128 } 3129 if (!defined $suppress_ifbraces{$linenr - 1} && 3130 $line =~ /\b(if|while|for|else)\b/) { 3131 my $allowed = 0; 3132 3133 # Check the pre-context. 3134 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 3135 #print "APW: ALLOWED: pre<$1>\n"; 3136 $allowed = 1; 3137 } 3138 3139 my ($level, $endln, @chunks) = 3140 ctx_statement_full($linenr, $realcnt, $-[0]); 3141 3142 # Check the condition. 3143 my ($cond, $block) = @{$chunks[0]}; 3144 #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 3145 if (defined $cond) { 3146 substr($block, 0, length($cond), ''); 3147 } 3148 if (statement_lines($cond) > 1) { 3149 #print "APW: ALLOWED: cond<$cond>\n"; 3150 $allowed = 1; 3151 } 3152 if ($block =~/\b(?:if|for|while)\b/) { 3153 #print "APW: ALLOWED: block<$block>\n"; 3154 $allowed = 1; 3155 } 3156 if (statement_block_size($block) > 1) { 3157 #print "APW: ALLOWED: lines block<$block>\n"; 3158 $allowed = 1; 3159 } 3160 # Check the post-context. 3161 if (defined $chunks[1]) { 3162 my ($cond, $block) = @{$chunks[1]}; 3163 if (defined $cond) { 3164 substr($block, 0, length($cond), ''); 3165 } 3166 if ($block =~ /^\s*\{/) { 3167 #print "APW: ALLOWED: chunk-1 block<$block>\n"; 3168 $allowed = 1; 3169 } 3170 } 3171 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 3172 my $herectx = $here . "\n"; 3173 my $cnt = statement_rawlines($block); 3174 3175 for (my $n = 0; $n < $cnt; $n++) { 3176 $herectx .= raw_line($linenr, $n) . "\n"; 3177 } 3178 3179 WARN("BRACES", 3180 "braces {} are not necessary for single statement blocks\n" . $herectx); 3181 } 3182 } 3183 3184# don't include deprecated include files (uses RAW line) 3185 for my $inc (@dep_includes) { 3186 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) { 3187 ERROR("DEPRECATED_INCLUDE", 3188 "Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr); 3189 } 3190 } 3191 3192# don't use deprecated functions 3193 for my $func (@dep_functions) { 3194 if ($line =~ /\b$func\b/) { 3195 ERROR("DEPRECATED_FUNCTION", 3196 "Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr); 3197 } 3198 } 3199 3200# no volatiles please 3201 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 3202 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 3203 WARN("VOLATILE", 3204 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 3205 } 3206 3207# warn about #if 0 3208 if ($line =~ /^.\s*\#\s*if\s+0\b/) { 3209 CHK("REDUNDANT_CODE", 3210 "if this code is redundant consider removing it\n" . 3211 $herecurr); 3212 } 3213 3214# check for needless kfree() checks 3215 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) { 3216 my $expr = $1; 3217 if ($line =~ /\bkfree\(\Q$expr\E\);/) { 3218 WARN("NEEDLESS_KFREE", 3219 "kfree(NULL) is safe this check is probably not required\n" . $hereprev); 3220 } 3221 } 3222# check for needless usb_free_urb() checks 3223 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) { 3224 my $expr = $1; 3225 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) { 3226 WARN("NEEDLESS_USB_FREE_URB", 3227 "usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev); 3228 } 3229 } 3230 3231# prefer usleep_range over udelay 3232 if ($line =~ /\budelay\s*\(\s*(\w+)\s*\)/) { 3233 # ignore udelay's < 10, however 3234 if (! (($1 =~ /(\d+)/) && ($1 < 10)) ) { 3235 CHK("USLEEP_RANGE", 3236 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line); 3237 } 3238 } 3239 3240# warn about unexpectedly long msleep's 3241 if ($line =~ /\bmsleep\s*\((\d+)\);/) { 3242 if ($1 < 20) { 3243 WARN("MSLEEP", 3244 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line); 3245 } 3246 } 3247 3248# warn about #ifdefs in C files 3249# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 3250# print "#ifdef in C files should be avoided\n"; 3251# print "$herecurr"; 3252# $clean = 0; 3253# } 3254 3255# warn about spacing in #ifdefs 3256 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 3257 ERROR("SPACING", 3258 "exactly one space required after that #$1\n" . $herecurr); 3259 } 3260 3261# check for spinlock_t definitions without a comment. 3262 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 3263 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 3264 my $which = $1; 3265 if (!ctx_has_comment($first_line, $linenr)) { 3266 CHK("UNCOMMENTED_DEFINITION", 3267 "$1 definition without comment\n" . $herecurr); 3268 } 3269 } 3270# check for memory barriers without a comment. 3271 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 3272 if (!ctx_has_comment($first_line, $linenr)) { 3273 CHK("MEMORY_BARRIER", 3274 "memory barrier without comment\n" . $herecurr); 3275 } 3276 } 3277# check of hardware specific defines 3278 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 3279 CHK("ARCH_DEFINES", 3280 "architecture specific defines should be avoided\n" . $herecurr); 3281 } 3282 3283# Check that the storage class is at the beginning of a declaration 3284 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 3285 WARN("STORAGE_CLASS", 3286 "storage class should be at the beginning of the declaration\n" . $herecurr) 3287 } 3288 3289# check the location of the inline attribute, that it is between 3290# storage class and type. 3291 if ($line =~ /\b$Type\s+$Inline\b/ || 3292 $line =~ /\b$Inline\s+$Storage\b/) { 3293 ERROR("INLINE_LOCATION", 3294 "inline keyword should sit between storage class and type\n" . $herecurr); 3295 } 3296 3297# Check for __inline__ and __inline, prefer inline 3298 if ($line =~ /\b(__inline__|__inline)\b/) { 3299 WARN("INLINE", 3300 "plain inline is preferred over $1\n" . $herecurr); 3301 } 3302 3303# Check for __attribute__ packed, prefer __packed 3304 if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 3305 WARN("PREFER_PACKED", 3306 "__packed is preferred over __attribute__((packed))\n" . $herecurr); 3307 } 3308 3309# Check for __attribute__ aligned, prefer __aligned 3310 if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 3311 WARN("PREFER_ALIGNED", 3312 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 3313 } 3314 3315# Check for __attribute__ format(printf, prefer __printf 3316 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 3317 WARN("PREFER_PRINTF", 3318 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr); 3319 } 3320 3321# Check for __attribute__ format(scanf, prefer __scanf 3322 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 3323 WARN("PREFER_SCANF", 3324 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr); 3325 } 3326 3327# check for sizeof(&) 3328 if ($line =~ /\bsizeof\s*\(\s*\&/) { 3329 WARN("SIZEOF_ADDRESS", 3330 "sizeof(& should be avoided\n" . $herecurr); 3331 } 3332 3333# check for sizeof without parenthesis 3334 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 3335 WARN("SIZEOF_PARENTHESIS", 3336 "sizeof $1 should be sizeof($1)\n" . $herecurr); 3337 } 3338 3339# check for line continuations in quoted strings with odd counts of " 3340 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 3341 WARN("LINE_CONTINUATIONS", 3342 "Avoid line continuations in quoted strings\n" . $herecurr); 3343 } 3344 3345# Check for misused memsets 3346 if ($^V && $^V ge 5.10.0 && 3347 defined $stat && 3348 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) { 3349 3350 my $ms_addr = $2; 3351 my $ms_val = $7; 3352 my $ms_size = $12; 3353 3354 if ($ms_size =~ /^(0x|)0$/i) { 3355 ERROR("MEMSET", 3356 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 3357 } elsif ($ms_size =~ /^(0x|)1$/i) { 3358 WARN("MEMSET", 3359 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 3360 } 3361 } 3362 3363# typecasts on min/max could be min_t/max_t 3364 if ($^V && $^V ge 5.10.0 && 3365 defined $stat && 3366 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 3367 if (defined $2 || defined $7) { 3368 my $call = $1; 3369 my $cast1 = deparenthesize($2); 3370 my $arg1 = $3; 3371 my $cast2 = deparenthesize($7); 3372 my $arg2 = $8; 3373 my $cast; 3374 3375 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 3376 $cast = "$cast1 or $cast2"; 3377 } elsif ($cast1 ne "") { 3378 $cast = $cast1; 3379 } else { 3380 $cast = $cast2; 3381 } 3382 WARN("MINMAX", 3383 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 3384 } 3385 } 3386 3387# check usleep_range arguments 3388 if ($^V && $^V ge 5.10.0 && 3389 defined $stat && 3390 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 3391 my $min = $1; 3392 my $max = $7; 3393 if ($min eq $max) { 3394 WARN("USLEEP_RANGE", 3395 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 3396 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 3397 $min > $max) { 3398 WARN("USLEEP_RANGE", 3399 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 3400 } 3401 } 3402 3403# check for new externs in .c files. 3404 if ($realfile =~ /\.c$/ && defined $stat && 3405 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 3406 { 3407 my $function_name = $1; 3408 my $paren_space = $2; 3409 3410 my $s = $stat; 3411 if (defined $cond) { 3412 substr($s, 0, length($cond), ''); 3413 } 3414 if ($s =~ /^\s*;/ && 3415 $function_name ne 'uninitialized_var') 3416 { 3417 WARN("AVOID_EXTERNS", 3418 "externs should be avoided in .c files\n" . $herecurr); 3419 } 3420 3421 if ($paren_space =~ /\n/) { 3422 WARN("FUNCTION_ARGUMENTS", 3423 "arguments for function declarations should follow identifier\n" . $herecurr); 3424 } 3425 3426 } elsif ($realfile =~ /\.c$/ && defined $stat && 3427 $stat =~ /^.\s*extern\s+/) 3428 { 3429 WARN("AVOID_EXTERNS", 3430 "externs should be avoided in .c files\n" . $herecurr); 3431 } 3432 3433# checks for new __setup's 3434 if ($rawline =~ /\b__setup\("([^"]*)"/) { 3435 my $name = $1; 3436 3437 if (!grep(/$name/, @setup_docs)) { 3438 CHK("UNDOCUMENTED_SETUP", 3439 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 3440 } 3441 } 3442 3443# check for pointless casting of kmalloc return 3444 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 3445 WARN("UNNECESSARY_CASTS", 3446 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 3447 } 3448 3449# check for multiple semicolons 3450 if ($line =~ /;\s*;\s*$/) { 3451 WARN("ONE_SEMICOLON", 3452 "Statements terminations use 1 semicolon\n" . $herecurr); 3453 } 3454 3455# check for gcc specific __FUNCTION__ 3456 if ($line =~ /__FUNCTION__/) { 3457 WARN("USE_FUNC", 3458 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr); 3459 } 3460 3461# check for use of yield() 3462 if ($line =~ /\byield\s*\(\s*\)/) { 3463 WARN("YIELD", 3464 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 3465 } 3466 3467# check for semaphores initialized locked 3468 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 3469 WARN("CONSIDER_COMPLETION", 3470 "consider using a completion\n" . $herecurr); 3471 } 3472 3473# recommend kstrto* over simple_strto* and strict_strto* 3474 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 3475 WARN("CONSIDER_KSTRTO", 3476 "$1 is obsolete, use k$3 instead\n" . $herecurr); 3477 } 3478 3479# check for __initcall(), use device_initcall() explicitly please 3480 if ($line =~ /^.\s*__initcall\s*\(/) { 3481 WARN("USE_DEVICE_INITCALL", 3482 "please use device_initcall() instead of __initcall()\n" . $herecurr); 3483 } 3484 3485# check for various ops structs, ensure they are const. 3486 my $struct_ops = qr{acpi_dock_ops| 3487 address_space_operations| 3488 backlight_ops| 3489 block_device_operations| 3490 dentry_operations| 3491 dev_pm_ops| 3492 dma_map_ops| 3493 extent_io_ops| 3494 file_lock_operations| 3495 file_operations| 3496 hv_ops| 3497 ide_dma_ops| 3498 intel_dvo_dev_ops| 3499 item_operations| 3500 iwl_ops| 3501 kgdb_arch| 3502 kgdb_io| 3503 kset_uevent_ops| 3504 lock_manager_operations| 3505 microcode_ops| 3506 mtrr_ops| 3507 neigh_ops| 3508 nlmsvc_binding| 3509 pci_raw_ops| 3510 pipe_buf_operations| 3511 platform_hibernation_ops| 3512 platform_suspend_ops| 3513 proto_ops| 3514 rpc_pipe_ops| 3515 seq_operations| 3516 snd_ac97_build_ops| 3517 soc_pcmcia_socket_ops| 3518 stacktrace_ops| 3519 sysfs_ops| 3520 tty_operations| 3521 usb_mon_operations| 3522 wd_ops}x; 3523 if ($line !~ /\bconst\b/ && 3524 $line =~ /\bstruct\s+($struct_ops)\b/) { 3525 WARN("CONST_STRUCT", 3526 "struct $1 should normally be const\n" . 3527 $herecurr); 3528 } 3529 3530# use of NR_CPUS is usually wrong 3531# ignore definitions of NR_CPUS and usage to define arrays as likely right 3532 if ($line =~ /\bNR_CPUS\b/ && 3533 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 3534 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 3535 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 3536 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 3537 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 3538 { 3539 WARN("NR_CPUS", 3540 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 3541 } 3542 3543# check for %L{u,d,i} in strings 3544 my $string; 3545 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 3546 $string = substr($rawline, $-[1], $+[1] - $-[1]); 3547 $string =~ s/%%/__/g; 3548 if ($string =~ /(?<!%)%L[udi]/) { 3549 WARN("PRINTF_L", 3550 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 3551 last; 3552 } 3553 } 3554 3555# whine mightly about in_atomic 3556 if ($line =~ /\bin_atomic\s*\(/) { 3557 if ($realfile =~ m@^drivers/@) { 3558 ERROR("IN_ATOMIC", 3559 "do not use in_atomic in drivers\n" . $herecurr); 3560 } elsif ($realfile !~ m@^kernel/@) { 3561 WARN("IN_ATOMIC", 3562 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 3563 } 3564 } 3565 3566# check for lockdep_set_novalidate_class 3567 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 3568 $line =~ /__lockdep_no_validate__\s*\)/ ) { 3569 if ($realfile !~ m@^kernel/lockdep@ && 3570 $realfile !~ m@^include/linux/lockdep@ && 3571 $realfile !~ m@^drivers/base/core@) { 3572 ERROR("LOCKDEP", 3573 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 3574 } 3575 } 3576 3577 if ($line =~ /debugfs_create_file.*S_IWUGO/ || 3578 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) { 3579 WARN("EXPORTED_WORLD_WRITABLE", 3580 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 3581 } 3582 } 3583 3584 # If we have no input at all, then there is nothing to report on 3585 # so just keep quiet. 3586 if ($#rawlines == -1) { 3587 exit(0); 3588 } 3589 3590 # In mailback mode only produce a report in the negative, for 3591 # things that appear to be patches. 3592 if ($mailback && ($clean == 1 || !$is_patch)) { 3593 exit(0); 3594 } 3595 3596 # This is not a patch, and we are are in 'no-patch' mode so 3597 # just keep quiet. 3598 if (!$chk_patch && !$is_patch) { 3599 exit(0); 3600 } 3601 3602 if (!$is_patch) { 3603 ERROR("NOT_UNIFIED_DIFF", 3604 "Does not appear to be a unified-diff format patch\n"); 3605 } 3606 if ($is_patch && $chk_signoff && $signoff == 0) { 3607 ERROR("MISSING_SIGN_OFF", 3608 "Missing Signed-off-by: line(s)\n"); 3609 } 3610 3611 print report_dump(); 3612 if ($summary && !($clean == 1 && $quiet == 1)) { 3613 print "$filename " if ($summary_file); 3614 print "total: $cnt_error errors, $cnt_warn warnings, " . 3615 (($check)? "$cnt_chk checks, " : "") . 3616 "$cnt_lines lines checked\n"; 3617 print "\n" if ($quiet == 0); 3618 } 3619 3620 if ($quiet == 0) { 3621 3622 if ($^V lt 5.10.0) { 3623 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n"); 3624 print("An upgrade to at least perl v5.10.0 is suggested.\n\n"); 3625 } 3626 3627 # If there were whitespace errors which cleanpatch can fix 3628 # then suggest that. 3629 if ($rpt_cleaners) { 3630 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n"; 3631 print " scripts/cleanfile\n\n"; 3632 $rpt_cleaners = 0; 3633 } 3634 } 3635 3636 if ($quiet == 0 && keys %ignore_type) { 3637 print "NOTE: Ignored message types:"; 3638 foreach my $ignore (sort keys %ignore_type) { 3639 print " $ignore"; 3640 } 3641 print "\n\n"; 3642 } 3643 3644 if ($clean == 1 && $quiet == 0) { 3645 print "$vname has no obvious style problems and is ready for submission.\n" 3646 } 3647 if ($clean == 0 && $quiet == 0) { 3648 print << "EOM"; 3649$vname has style problems, please review. 3650 3651If any of these errors are false positives, please report 3652them to the maintainer, see CHECKPATCH in MAINTAINERS. 3653EOM 3654 } 3655 3656 return $clean; 3657} 3658