1 #!/usr/bin/env perl 2 # 3 # The LLVM Compiler Infrastructure 4 # 5 # This file is distributed under the University of Illinois Open Source 6 # License. See LICENSE.TXT for details. 7 # 8 ##===----------------------------------------------------------------------===## 9 # 10 # A script designed to interpose between the build system and gcc. It invokes 11 # both gcc and the static analyzer. 12 # 13 ##===----------------------------------------------------------------------===## 14 15 use strict; 16 use warnings; 17 use FindBin; 18 use Cwd qw/ getcwd abs_path /; 19 use File::Temp qw/ tempfile /; 20 use File::Path qw / mkpath /; 21 use File::Basename; 22 use Text::ParseWords; 23 24 ##===----------------------------------------------------------------------===## 25 # Compiler command setup. 26 ##===----------------------------------------------------------------------===## 27 28 my $Compiler; 29 my $Clang; 30 my $DefaultCCompiler; 31 my $DefaultCXXCompiler; 32 33 if (`uname -a` =~ m/Darwin/) { 34 $DefaultCCompiler = 'clang'; 35 $DefaultCXXCompiler = 'clang++'; 36 } else { 37 $DefaultCCompiler = 'gcc'; 38 $DefaultCXXCompiler = 'g++'; 39 } 40 41 if ($FindBin::Script =~ /c\+\+-analyzer/) { 42 $Compiler = $ENV{'CCC_CXX'}; 43 if (!defined $Compiler) { $Compiler = $DefaultCXXCompiler; } 44 45 $Clang = $ENV{'CLANG_CXX'}; 46 if (!defined $Clang) { $Clang = 'clang++'; } 47 } 48 else { 49 $Compiler = $ENV{'CCC_CC'}; 50 if (!defined $Compiler) { $Compiler = $DefaultCCompiler; } 51 52 $Clang = $ENV{'CLANG'}; 53 if (!defined $Clang) { $Clang = 'clang'; } 54 } 55 56 ##===----------------------------------------------------------------------===## 57 # Cleanup. 58 ##===----------------------------------------------------------------------===## 59 60 my $ReportFailures = $ENV{'CCC_REPORT_FAILURES'}; 61 if (!defined $ReportFailures) { $ReportFailures = 1; } 62 63 my $CleanupFile; 64 my $ResultFile; 65 66 # Remove any stale files at exit. 67 END { 68 if (defined $ResultFile && -z $ResultFile) { 69 `rm -f $ResultFile`; 70 } 71 if (defined $CleanupFile) { 72 `rm -f $CleanupFile`; 73 } 74 } 75 76 ##----------------------------------------------------------------------------## 77 # Process Clang Crashes. 78 ##----------------------------------------------------------------------------## 79 80 sub GetPPExt { 81 my $Lang = shift; 82 if ($Lang =~ /objective-c\+\+/) { return ".mii" }; 83 if ($Lang =~ /objective-c/) { return ".mi"; } 84 if ($Lang =~ /c\+\+/) { return ".ii"; } 85 return ".i"; 86 } 87 88 # Set this to 1 if we want to include 'parser rejects' files. 89 my $IncludeParserRejects = 0; 90 my $ParserRejects = "Parser Rejects"; 91 my $AttributeIgnored = "Attribute Ignored"; 92 my $OtherError = "Other Error"; 93 94 sub ProcessClangFailure { 95 my ($Clang, $Lang, $file, $Args, $HtmlDir, $ErrorType, $ofile) = @_; 96 my $Dir = "$HtmlDir/failures"; 97 mkpath $Dir; 98 99 my $prefix = "clang_crash"; 100 if ($ErrorType eq $ParserRejects) { 101 $prefix = "clang_parser_rejects"; 102 } 103 elsif ($ErrorType eq $AttributeIgnored) { 104 $prefix = "clang_attribute_ignored"; 105 } 106 elsif ($ErrorType eq $OtherError) { 107 $prefix = "clang_other_error"; 108 } 109 110 # Generate the preprocessed file with Clang. 111 my ($PPH, $PPFile) = tempfile( $prefix . "_XXXXXX", 112 SUFFIX => GetPPExt($Lang), 113 DIR => $Dir); 114 system $Clang, @$Args, "-E", "-o", $PPFile; 115 close ($PPH); 116 117 # Create the info file. 118 open (OUT, ">", "$PPFile.info.txt") or die "Cannot open $PPFile.info.txt\n"; 119 print OUT abs_path($file), "\n"; 120 print OUT "$ErrorType\n"; 121 print OUT "@$Args\n"; 122 close OUT; 123 `uname -a >> $PPFile.info.txt 2>&1`; 124 `$Compiler -v >> $PPFile.info.txt 2>&1`; 125 system 'mv',$ofile,"$PPFile.stderr.txt"; 126 return (basename $PPFile); 127 } 128 129 ##----------------------------------------------------------------------------## 130 # Running the analyzer. 131 ##----------------------------------------------------------------------------## 132 133 sub GetCCArgs { 134 my $mode = shift; 135 my $Args = shift; 136 137 pipe (FROM_CHILD, TO_PARENT); 138 my $pid = fork(); 139 if ($pid == 0) { 140 close FROM_CHILD; 141 open(STDOUT,">&", \*TO_PARENT); 142 open(STDERR,">&", \*TO_PARENT); 143 exec $Clang, "-###", $mode, @$Args; 144 } 145 close(TO_PARENT); 146 my $line; 147 while (<FROM_CHILD>) { 148 next if (!/-cc1/); 149 $line = $_; 150 } 151 152 waitpid($pid,0); 153 close(FROM_CHILD); 154 155 die "could not find clang line\n" if (!defined $line); 156 # Strip the newline and initial whitspace 157 chomp $line; 158 $line =~ s/^\s+//; 159 my @items = quotewords('\s+', 0, $line); 160 my $cmd = shift @items; 161 die "cannot find 'clang' in 'clang' command\n" if (!($cmd =~ /clang/)); 162 return \@items; 163 } 164 165 sub Analyze { 166 my ($Clang, $OriginalArgs, $AnalyzeArgs, $Lang, $Output, $Verbose, $HtmlDir, 167 $file) = @_; 168 169 my @Args = @$OriginalArgs; 170 my $Cmd; 171 my @CmdArgs; 172 my @CmdArgsSansAnalyses; 173 174 if ($Lang =~ /header/) { 175 exit 0 if (!defined ($Output)); 176 $Cmd = 'cp'; 177 push @CmdArgs, $file; 178 # Remove the PCH extension. 179 $Output =~ s/[.]gch$//; 180 push @CmdArgs, $Output; 181 @CmdArgsSansAnalyses = @CmdArgs; 182 } 183 else { 184 $Cmd = $Clang; 185 186 # Create arguments for doing regular parsing. 187 my $SyntaxArgs = GetCCArgs("-fsyntax-only", \@Args); 188 @CmdArgsSansAnalyses = @$SyntaxArgs; 189 190 # Create arguments for doing static analysis. 191 if (defined $ResultFile) { 192 push @Args, '-o', $ResultFile; 193 } 194 elsif (defined $HtmlDir) { 195 push @Args, '-o', $HtmlDir; 196 } 197 if ($Verbose) { 198 push @Args, "-Xclang", "-analyzer-display-progress"; 199 } 200 201 foreach my $arg (@$AnalyzeArgs) { 202 push @Args, "-Xclang", $arg; 203 } 204 205 # Display Ubiviz graph? 206 if (defined $ENV{'CCC_UBI'}) { 207 push @Args, "-Xclang", "-analyzer-viz-egraph-ubigraph"; 208 } 209 210 my $AnalysisArgs = GetCCArgs("--analyze", \@Args); 211 @CmdArgs = @$AnalysisArgs; 212 } 213 214 my @PrintArgs; 215 my $dir; 216 217 if ($Verbose) { 218 $dir = getcwd(); 219 print STDERR "\n[LOCATION]: $dir\n"; 220 push @PrintArgs,"'$Cmd'"; 221 foreach my $arg (@CmdArgs) { 222 push @PrintArgs,"\'$arg\'"; 223 } 224 } 225 if ($Verbose == 1) { 226 # We MUST print to stderr. Some clients use the stdout output of 227 # gcc for various purposes. 228 print STDERR join(' ', @PrintArgs); 229 print STDERR "\n"; 230 } 231 elsif ($Verbose == 2) { 232 print STDERR "#SHELL (cd '$dir' && @PrintArgs)\n"; 233 } 234 235 # Capture the STDERR of clang and send it to a temporary file. 236 # Capture the STDOUT of clang and reroute it to ccc-analyzer's STDERR. 237 # We save the output file in the 'crashes' directory if clang encounters 238 # any problems with the file. 239 pipe (FROM_CHILD, TO_PARENT); 240 my $pid = fork(); 241 if ($pid == 0) { 242 close FROM_CHILD; 243 open(STDOUT,">&", \*TO_PARENT); 244 open(STDERR,">&", \*TO_PARENT); 245 exec $Cmd, @CmdArgs; 246 } 247 248 close TO_PARENT; 249 my ($ofh, $ofile) = tempfile("clang_output_XXXXXX", DIR => $HtmlDir); 250 251 while (<FROM_CHILD>) { 252 print $ofh $_; 253 print STDERR $_; 254 } 255 close $ofh; 256 257 waitpid($pid,0); 258 close(FROM_CHILD); 259 my $Result = $?; 260 261 # Did the command die because of a signal? 262 if ($ReportFailures) { 263 if ($Result & 127 and $Cmd eq $Clang and defined $HtmlDir) { 264 ProcessClangFailure($Clang, $Lang, $file, \@CmdArgsSansAnalyses, 265 $HtmlDir, "Crash", $ofile); 266 } 267 elsif ($Result) { 268 if ($IncludeParserRejects && !($file =~/conftest/)) { 269 ProcessClangFailure($Clang, $Lang, $file, \@CmdArgsSansAnalyses, 270 $HtmlDir, $ParserRejects, $ofile); 271 } else { 272 ProcessClangFailure($Clang, $Lang, $file, \@CmdArgsSansAnalyses, 273 $HtmlDir, $OtherError, $ofile); 274 } 275 } 276 else { 277 # Check if there were any unhandled attributes. 278 if (open(CHILD, $ofile)) { 279 my %attributes_not_handled; 280 281 # Don't flag warnings about the following attributes that we 282 # know are currently not supported by Clang. 283 $attributes_not_handled{"cdecl"} = 1; 284 285 my $ppfile; 286 while (<CHILD>) { 287 next if (! /warning: '([^\']+)' attribute ignored/); 288 289 # Have we already spotted this unhandled attribute? 290 next if (defined $attributes_not_handled{$1}); 291 $attributes_not_handled{$1} = 1; 292 293 # Get the name of the attribute file. 294 my $dir = "$HtmlDir/failures"; 295 my $afile = "$dir/attribute_ignored_$1.txt"; 296 297 # Only create another preprocessed file if the attribute file 298 # doesn't exist yet. 299 next if (-e $afile); 300 301 # Add this file to the list of files that contained this attribute. 302 # Generate a preprocessed file if we haven't already. 303 if (!(defined $ppfile)) { 304 $ppfile = ProcessClangFailure($Clang, $Lang, $file, 305 \@CmdArgsSansAnalyses, 306 $HtmlDir, $AttributeIgnored, $ofile); 307 } 308 309 mkpath $dir; 310 open(AFILE, ">$afile"); 311 print AFILE "$ppfile\n"; 312 close(AFILE); 313 } 314 close CHILD; 315 } 316 } 317 } 318 319 unlink($ofile); 320 } 321 322 ##----------------------------------------------------------------------------## 323 # Lookup tables. 324 ##----------------------------------------------------------------------------## 325 326 my %CompileOptionMap = ( 327 '-nostdinc' => 0, 328 '-include' => 1, 329 '-idirafter' => 1, 330 '-imacros' => 1, 331 '-iprefix' => 1, 332 '-iquote' => 1, 333 '-isystem' => 1, 334 '-iwithprefix' => 1, 335 '-iwithprefixbefore' => 1 336 ); 337 338 my %LinkerOptionMap = ( 339 '-framework' => 1, 340 '-fobjc-link-runtime' => 0 341 ); 342 343 my %CompilerLinkerOptionMap = ( 344 '-Wwrite-strings' => 0, 345 '-ftrapv-handler' => 1, # specifically call out separated -f flag 346 '-mios-simulator-version-min' => 0, # This really has 1 argument, but always has '=' 347 '-isysroot' => 1, 348 '-arch' => 1, 349 '-m32' => 0, 350 '-m64' => 0, 351 '-stdlib' => 0, # This is really a 1 argument, but always has '=' 352 '-v' => 0, 353 '-mmacosx-version-min' => 0, # This is really a 1 argument, but always has '=' 354 '-miphoneos-version-min' => 0 # This is really a 1 argument, but always has '=' 355 ); 356 357 my %IgnoredOptionMap = ( 358 '-MT' => 1, # Ignore these preprocessor options. 359 '-MF' => 1, 360 361 '-fsyntax-only' => 0, 362 '-save-temps' => 0, 363 '-install_name' => 1, 364 '-exported_symbols_list' => 1, 365 '-current_version' => 1, 366 '-compatibility_version' => 1, 367 '-init' => 1, 368 '-e' => 1, 369 '-seg1addr' => 1, 370 '-bundle_loader' => 1, 371 '-multiply_defined' => 1, 372 '-sectorder' => 3, 373 '--param' => 1, 374 '-u' => 1, 375 '--serialize-diagnostics' => 1 376 ); 377 378 my %LangMap = ( 379 'c' => 'c', 380 'cp' => 'c++', 381 'cpp' => 'c++', 382 'cxx' => 'c++', 383 'txx' => 'c++', 384 'cc' => 'c++', 385 'C' => 'c++', 386 'ii' => 'c++', 387 'i' => 'c-cpp-output', 388 'm' => 'objective-c', 389 'mi' => 'objective-c-cpp-output', 390 'mm' => 'objective-c++' 391 ); 392 393 my %UniqueOptions = ( 394 '-isysroot' => 0 395 ); 396 397 ##----------------------------------------------------------------------------## 398 # Languages accepted. 399 ##----------------------------------------------------------------------------## 400 401 my %LangsAccepted = ( 402 "objective-c" => 1, 403 "c" => 1, 404 "c++" => 1, 405 "objective-c++" => 1 406 ); 407 408 ##----------------------------------------------------------------------------## 409 # Main Logic. 410 ##----------------------------------------------------------------------------## 411 412 my $Action = 'link'; 413 my @CompileOpts; 414 my @LinkOpts; 415 my @Files; 416 my $Lang; 417 my $Output; 418 my %Uniqued; 419 420 # Forward arguments to gcc. 421 my $Status = system($Compiler,@ARGV); 422 if (defined $ENV{'CCC_ANALYZER_LOG'}) { 423 print STDERR "$Compiler @ARGV\n"; 424 } 425 if ($Status) { exit($Status >> 8); } 426 427 # Get the analysis options. 428 my $Analyses = $ENV{'CCC_ANALYZER_ANALYSIS'}; 429 430 # Get the plugins to load. 431 my $Plugins = $ENV{'CCC_ANALYZER_PLUGINS'}; 432 433 # Get the store model. 434 my $StoreModel = $ENV{'CCC_ANALYZER_STORE_MODEL'}; 435 436 # Get the constraints engine. 437 my $ConstraintsModel = $ENV{'CCC_ANALYZER_CONSTRAINTS_MODEL'}; 438 439 #Get the internal stats setting. 440 my $InternalStats = $ENV{'CCC_ANALYZER_INTERNAL_STATS'}; 441 442 # Get the output format. 443 my $OutputFormat = $ENV{'CCC_ANALYZER_OUTPUT_FORMAT'}; 444 if (!defined $OutputFormat) { $OutputFormat = "html"; } 445 446 # Determine the level of verbosity. 447 my $Verbose = 0; 448 if (defined $ENV{'CCC_ANALYZER_VERBOSE'}) { $Verbose = 1; } 449 if (defined $ENV{'CCC_ANALYZER_LOG'}) { $Verbose = 2; } 450 451 # Get the HTML output directory. 452 my $HtmlDir = $ENV{'CCC_ANALYZER_HTML'}; 453 454 my %DisabledArchs = ('ppc' => 1, 'ppc64' => 1); 455 my %ArchsSeen; 456 my $HadArch = 0; 457 458 # Process the arguments. 459 foreach (my $i = 0; $i < scalar(@ARGV); ++$i) { 460 my $Arg = $ARGV[$i]; 461 my ($ArgKey) = split /=/,$Arg,2; 462 463 # Modes ccc-analyzer supports 464 if ($Arg =~ /^-(E|MM?)$/) { $Action = 'preprocess'; } 465 elsif ($Arg eq '-c') { $Action = 'compile'; } 466 elsif ($Arg =~ /^-print-prog-name/) { exit 0; } 467 468 # Specially handle duplicate cases of -arch 469 if ($Arg eq "-arch") { 470 my $arch = $ARGV[$i+1]; 471 # We don't want to process 'ppc' because of Clang's lack of support 472 # for Altivec (also some #defines won't likely be defined correctly, etc.) 473 if (!(defined $DisabledArchs{$arch})) { $ArchsSeen{$arch} = 1; } 474 $HadArch = 1; 475 ++$i; 476 next; 477 } 478 479 # Options with possible arguments that should pass through to compiler. 480 if (defined $CompileOptionMap{$ArgKey}) { 481 my $Cnt = $CompileOptionMap{$ArgKey}; 482 push @CompileOpts,$Arg; 483 while ($Cnt > 0) { ++$i; --$Cnt; push @CompileOpts, $ARGV[$i]; } 484 next; 485 } 486 if ($Arg =~ /-m.*/) { 487 push @CompileOpts,$Arg; 488 next; 489 } 490 # Handle the case where there isn't a space after -iquote 491 if ($Arg =~ /-iquote.*/) { 492 push @CompileOpts,$Arg; 493 next; 494 } 495 496 # Options with possible arguments that should pass through to linker. 497 if (defined $LinkerOptionMap{$ArgKey}) { 498 my $Cnt = $LinkerOptionMap{$ArgKey}; 499 push @LinkOpts,$Arg; 500 while ($Cnt > 0) { ++$i; --$Cnt; push @LinkOpts, $ARGV[$i]; } 501 next; 502 } 503 504 # Options with possible arguments that should pass through to both compiler 505 # and the linker. 506 if (defined $CompilerLinkerOptionMap{$ArgKey}) { 507 my $Cnt = $CompilerLinkerOptionMap{$ArgKey}; 508 509 # Check if this is an option that should have a unique value, and if so 510 # determine if the value was checked before. 511 if ($UniqueOptions{$Arg}) { 512 if (defined $Uniqued{$Arg}) { 513 $i += $Cnt; 514 next; 515 } 516 $Uniqued{$Arg} = 1; 517 } 518 519 push @CompileOpts,$Arg; 520 push @LinkOpts,$Arg; 521 522 while ($Cnt > 0) { 523 ++$i; --$Cnt; 524 push @CompileOpts, $ARGV[$i]; 525 push @LinkOpts, $ARGV[$i]; 526 } 527 next; 528 } 529 530 # Ignored options. 531 if (defined $IgnoredOptionMap{$ArgKey}) { 532 my $Cnt = $IgnoredOptionMap{$ArgKey}; 533 while ($Cnt > 0) { 534 ++$i; --$Cnt; 535 } 536 next; 537 } 538 539 # Compile mode flags. 540 if ($Arg =~ /^-[D,I,U](.*)$/) { 541 my $Tmp = $Arg; 542 if ($1 eq '') { 543 # FIXME: Check if we are going off the end. 544 ++$i; 545 $Tmp = $Arg . $ARGV[$i]; 546 } 547 push @CompileOpts,$Tmp; 548 next; 549 } 550 551 # Language. 552 if ($Arg eq '-x') { 553 $Lang = $ARGV[$i+1]; 554 ++$i; next; 555 } 556 557 # Output file. 558 if ($Arg eq '-o') { 559 ++$i; 560 $Output = $ARGV[$i]; 561 next; 562 } 563 564 # Get the link mode. 565 if ($Arg =~ /^-[l,L,O]/) { 566 if ($Arg eq '-O') { push @LinkOpts,'-O1'; } 567 elsif ($Arg eq '-Os') { push @LinkOpts,'-O2'; } 568 else { push @LinkOpts,$Arg; } 569 570 # Must pass this along for the __OPTIMIZE__ macro 571 if ($Arg =~ /^-O/) { push @CompileOpts,$Arg; } 572 next; 573 } 574 575 if ($Arg =~ /^-std=/) { 576 push @CompileOpts,$Arg; 577 next; 578 } 579 580 # Get the compiler/link mode. 581 if ($Arg =~ /^-F(.+)$/) { 582 my $Tmp = $Arg; 583 if ($1 eq '') { 584 # FIXME: Check if we are going off the end. 585 ++$i; 586 $Tmp = $Arg . $ARGV[$i]; 587 } 588 push @CompileOpts,$Tmp; 589 push @LinkOpts,$Tmp; 590 next; 591 } 592 593 # Input files. 594 if ($Arg eq '-filelist') { 595 # FIXME: Make sure we aren't walking off the end. 596 open(IN, $ARGV[$i+1]); 597 while (<IN>) { s/\015?\012//; push @Files,$_; } 598 close(IN); 599 ++$i; 600 next; 601 } 602 603 if ($Arg =~ /^-f/) { 604 push @CompileOpts,$Arg; 605 push @LinkOpts,$Arg; 606 next; 607 } 608 609 # Handle -Wno-. We don't care about extra warnings, but 610 # we should suppress ones that we don't want to see. 611 if ($Arg =~ /^-Wno-/) { 612 push @CompileOpts, $Arg; 613 next; 614 } 615 616 if (!($Arg =~ /^-/)) { 617 push @Files, $Arg; 618 next; 619 } 620 } 621 622 if ($Action eq 'compile' or $Action eq 'link') { 623 my @Archs = keys %ArchsSeen; 624 # Skip the file if we don't support the architectures specified. 625 exit 0 if ($HadArch && scalar(@Archs) == 0); 626 627 foreach my $file (@Files) { 628 # Determine the language for the file. 629 my $FileLang = $Lang; 630 631 if (!defined($FileLang)) { 632 # Infer the language from the extension. 633 if ($file =~ /[.]([^.]+)$/) { 634 $FileLang = $LangMap{$1}; 635 } 636 } 637 638 # FileLang still not defined? Skip the file. 639 next if (!defined $FileLang); 640 641 # Language not accepted? 642 next if (!defined $LangsAccepted{$FileLang}); 643 644 my @CmdArgs; 645 my @AnalyzeArgs; 646 647 if ($FileLang ne 'unknown') { 648 push @CmdArgs, '-x', $FileLang; 649 } 650 651 if (defined $StoreModel) { 652 push @AnalyzeArgs, "-analyzer-store=$StoreModel"; 653 } 654 655 if (defined $ConstraintsModel) { 656 push @AnalyzeArgs, "-analyzer-constraints=$ConstraintsModel"; 657 } 658 659 if (defined $InternalStats) { 660 push @AnalyzeArgs, "-analyzer-stats"; 661 } 662 663 if (defined $Analyses) { 664 push @AnalyzeArgs, split '\s+', $Analyses; 665 } 666 667 if (defined $Plugins) { 668 push @AnalyzeArgs, split '\s+', $Plugins; 669 } 670 671 if (defined $OutputFormat) { 672 push @AnalyzeArgs, "-analyzer-output=" . $OutputFormat; 673 if ($OutputFormat =~ /plist/) { 674 # Change "Output" to be a file. 675 my ($h, $f) = tempfile("report-XXXXXX", SUFFIX => ".plist", 676 DIR => $HtmlDir); 677 $ResultFile = $f; 678 # If the HtmlDir is not set, we sould clean up the plist files. 679 if (!defined $HtmlDir || -z $HtmlDir) { 680 $CleanupFile = $f; 681 } 682 } 683 } 684 685 push @CmdArgs, @CompileOpts; 686 push @CmdArgs, $file; 687 688 if (scalar @Archs) { 689 foreach my $arch (@Archs) { 690 my @NewArgs; 691 push @NewArgs, '-arch', $arch; 692 push @NewArgs, @CmdArgs; 693 Analyze($Clang, \@NewArgs, \@AnalyzeArgs, $FileLang, $Output, 694 $Verbose, $HtmlDir, $file); 695 } 696 } 697 else { 698 Analyze($Clang, \@CmdArgs, \@AnalyzeArgs, $FileLang, $Output, 699 $Verbose, $HtmlDir, $file); 700 } 701 } 702 } 703 704 exit($Status >> 8); 705 706